General workflow template structure
The following example shows the basic JSON structure used by all workflow templates. Starting from this base template, you can construct simple or complex workflows in a modular fashion by adding the activities that accomplish the tasks that you would like to perform. Examples and configuration details are provided for each supported workflow activity in the following sections.
Note: This example shows only the JSON components that are common to all workflow templates. Additional details are required within the activity object to create a functioning workflow.
{
"templateMetadata" : {
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "Workflow Template Name",
"description" : "Description of the template.",
"lastEditedOn" : null,
"lastEditedBy" : null,
"productVersion" : null
},
"workflowDefinition" : [
{
"activity" : {
"activityType" : "Type of Activity to Perform",
"activityContext" : {
"requireNewNuixLicence" : null,
"nuixLicenceType" : null,
"numberOfWorkers" : null
},
"activityGroup" : "TAGGING"
},
"id" : "unique-ID",
"continueOnFailure" : false,
"nextSteps" : [ "List ID's of any descendant nodes"],
"customArguments" : {
"name" : "Visible name of node",
"metadataProfile" : null
}
},
{
"Additional activities as needed"
} ]
}
JSON property | Value | Description | |
templateMetadata | id | string | The UUID associated with the workflow template. A UUID is generated automatically during import if a null value is defined. |
string | A unique name associated with the workflow template that is visible to users in the application. Name must be less than 100 characters. | ||
description | string | A description of the workflow template that is visible to uses of the application. | |
lastEditedOn | string | Date when the template was last modified. | |
lastEditedBy | string | The user who last modified the template. | |
productVersion | string | The version of the product the template is intended to be used with. | |
workflowDefinition | activity | object | An object that specifies the activity to be performed. |
id | string | A unique ID associated with a specific workflow activity. | |
continueOnFailure | boolean | Allow workflow to progress to the next activity if the current activity fails. | |
nextSteps | array | An array that specifies the ID’s of any activities that are considered descendants of the current activity. | |
customArguments | object | An object used to define custom arguments for the node. | |
activity | activityType | string | Type of activity to be performed by the node. Accepted values: [bulkSearchAndTag | bulkExclusion | bulkInclusion | itemSecurity | bulkItemCustomMetadataAdd | bulkRunUserScript] |
activityContext | object | An object used to define the parameters associated with an activity. | |
activityGroup | string | The group type associated with an activity. Accepted values: [TAGGING | ITEM_ANNOTATION | ITEM_SECURITY | CUSTOM] | |
requireNewNuixLicense | boolean | Activity requires the use of a Nuix License to run. If defined as true, specify the nuixLicenseType to consume and the numberOfWorkers that should be used. | |
nuixLicenseType | string | The short name of the Nuix license to consume while the activity is being performed. The defined license must be available from NMS at the time of consumption. | |
numberOfWorkers | integer | The maximum number of workers to utilize for the activity. | |
customArguments | name | string | Name of the node to be displayed in the Workflows tab. |
metadataProfile | string | The metadata profile to associate with an activities query. The default metadata profile is applied if this value does not match an existing metadata profile exactly or is marked as null | |