fileUploadWidgetTemplate.json

{
    "eula": "",
    "vendor": "SAP",
    "license": "",
    "id": "com.sap.fileUploadWidget",
    "version": "changeme",
    "name": "File Upload Widget",
    "newInstancePrefix": "FileUploadWidget",
    "description": "A widget that allows users to upload a file and import data into a model",
    "imports": [],
    "webcomponents": [
      {
        "kind": "main",
        "tag": "com-sap-file-upload-widget",
        "url": "changeme",
        "integrity": ""
      },
      {
        "kind": "builder",
        "tag": "com-sap-file-upload-widget-builder",
        "url": "changeme",
        "integrity": ""
      }
    ],
    "properties": {
      "modelId": {
        "type": "string",
        "description": "The targeted model ID",
        "default": ""
      },
      "importType": {
        "type": "string",
        "description": "The data import type",
        "default": "Update"
      },
      "mappings": {
        "type": "Selection",
        "description": "Mapping selection from SAC identifiers to end user's file column names"
      },
      "defaultValues": {
        "type": "Selection",
        "description": "Default values to be used when import data into a model and the data is missing a column"
      },
      "jobSettings": {
        "type": "Selection",
        "description": "Data Import Service API job settings"
      }
    },
    "events": {
      "onSuccess": {
        "description": "Triggered upon successful import of all records by the import job."
      },
      "onPartialSuccess": {
        "description": "Triggered when at least one record has failed but the import job has completed."
      },
      "onFailure": {
        "description": "Triggered when no records are imported due to a failure in the import job. Note here that getJobFailedRowCount may not be accurate if jobs are never rejected by the service / an error occurs beforehand."
      }
    },
    "methods": {
      "open": {
        "description": "Open the Dialog for the DIS Custom Widget"
      },
      "getTotalJobRowCount": {
        "description": "Get the total number of rows attempted to upload to the job in the last run of the widget based on the user's uploaded file. Returns -1 if a job has not ran.",
        "returnType": "integer"
      },
      "getJobFailedRowCount": {
        "description": "Get the number of failed rows in the last run of the widget. Note if a user uploads data to a pivoted job this could exceed getTotalJobRowCount since data is unpivoted and that number of rows are returned.",
        "returnType": "integer"
      }
    }
  }