iDMS iUpdate

The iDMS iUpdate action will execute a stored iUpdate task. Optionally, wait for the task to complete before continuing on to the next action in the workflow.

Input Output
None
  • Any (JSON) (Passthrough)
  • iDMS iUpdate Job Status (string)

Passing Data

Staff can pass parameters from iWorkflow into iUpdate, where they are treated as IQA parameters. Data cannot be passed directly from iUpdate back into iWorkflow; however, iUpdate can be used to stage data in a panel, which can then be retrieved using the Fetch IQA Data action.

Output Data Schema

When an output property is specified, the iUpdate task information is stored under the defined property name. For example, if the output property is named iUpdateResult, the workflow data pipeline will reflect this structure:

Copy 
{
  /* ... other pipeline properties here... */
  
  "iUpdateResults": {
    "ExecuteId": "c0bac7f3-0000-4806-0000-f41a109e5c12",
    "ImportId": 12345678,
    "Status": "D",
    "StatusDescription": "Success",
    "PercentComplete": 100,
    "RowCount": 1,
    "LastUpdatRow": 0,
    "CreatedOn": "2024-06-25T16:56:38.95",
    "UpdatedOn": "2024-06-25T16:56:45.457",
    "ExecutionCount": 1,
    "CurrentErrorCount": 0,
    "TotalErrorCount": 0,
    "PollingUrl": null,
    "RetryAfter": "00:00:00"
  }
}

Note: The output data varies based on whether Wait for Completion is enabled. When this option is disabled, the RowCount value is always 0, as the row count cannot be determined without waiting for the task to complete.

Properties

These properties control the behavior and structure of the iDMS iUpdate action:

Name Type Templatable Notes
iUpdate Job Choice No Select an iUpdate Task from the drop-down. iUpdate Tasks can be viewed and managed by going to the top menu and clicking iUpdate > Tasks.
Parameters List Yes (Optional) Specify the parameters to pass to the iUpdate job. Similar to the parameter settings on iUpdate webhooks, the correct IQA filter or property name must be provided.
Output Property String No (Optional) To store the resulting value that was parsed from the Activation Expression field, specify a property name. The parsed value (for example, true or false) is written to this property.
Wait for Completion Checkbox No If checked, this action will wait until the iUpdate task is completed before moving on to the next action in the workflow.
Fail on No Records Checkbox No Only available when Wait for Completion is enabled. If enabled, will cause this step to fail if no records were processed. Use Sequencing and Flow Control settings to perform different actions if no records were processed.
Fail on iUpdate Error Checkbox No If enabled, this action will fail if the iUpdate job encounters an error or otherwise fails. View the task status on the iDMS dashboard by going to iUpdate > Dashboard in the top navigation.