Provisioning Workflows are a combination of one or more operations on entities, scripts and other workflows in a sequence according to a condition. Entity operations can be to add, delete or update if a specified condition holds. A Configuration Template can also be associated with this operation on the entity. This association with a template can for example provide default values or calculated values (from macros) to the entity during the Provisioning Workflow execution. An operation can also specify the inclusion of another workflow under a specified condition. For delete and update operations, the operation can be refined by specifying Advanced find options for the selected entity so that the operation can be applied to a specific instance of the entity. Scripts can also be executed on a device as part of a workflow. Provisioning Workflow operations can also loop through List Macros, assigning list items to an Assigned Variable for reference in other macros or Configuration Templates. List Macros in Provisioning Workflows enable batch operations and nested looping. Refer to the Macro Syntax section in the General Help.

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Name *

The name that is given to the Provisioning Workflow.

Field Name: name
Type: String
Pattern: ^((?!\.).)*$

Description

A description for the Provisioning Workflow instance.

Field Name: description
Type: String

Parameters

Additional execution parameters that are applied to the Provisioning Workflow.

Field Name: parameters
Type: Object

Parallel *

An indication if the operation can run in parallel. Default: false

Field Name: parameters.parallel
Type: String
Default: false

Maximum Workers *

A specification of the maximum number of workflow workers allowed for the operation. Default: 1

Field Name: parameters.max_workers
Type: String
Default: 1

Conditions

The list of conditions that should resolve to True in order for the selected operation to be carried out.

Field Name: condition.[n]
Type: Array

Condition *

A condition in Macro language that should resolve to True for the operation to be carried out. If the condition resolves to False, the operation is not carried out and will be excluded from the list of operations of the workflow.

Field Name: condition.[n].condition
Type: String

Action to perform on failure.

Action to perform on failure. Default: skip

Field Name: condition.[n].action
Type: String
Default: skip
Choices: ["Skip", "Error"]

Error Message

The custom message that would be displayed

Field Name: condition.[n].error_message
Type: String

Disable Rollback on Error

If selected, the Provisioning Workflow will not rollback it's transaction(s) on failure.

Field Name: rollback_disabled
Type: Boolean

Workflow

The list of individual workflow operations that are part of the Provisioning Workflow.

Field Name: workflow.[n]
Type: Array
Cardinality: [1..n]

Operation *

A list of operation types in the workflow. The type can be Add, Update, Remove, Execute and Include Workflow.

Field Name: workflow.[n].method
Type: String
Choices: ["Add", "Update", "Remove", "Bulk Update", "Bulk Delete", "Move", "Refresh", "Sync", "Purge", "Set", "Execute", "Include Workflow", "Exit Local", "Exit Global"]

Step Type

A selection to indicate whether the workflow step applies to an Entity such as a model or includes another Provisioning Workflow. Default: model

Field Name: workflow.[n].entity_type
Type: String
Default: model
Choices: ["Model", "Provisioning Workflow"]

Entity or Workflow *

The selected model or workflow that applies to the workflow step.

Field Name: workflow.[n].entity
Type: String
Choices: [""]

Input Data Identifier

DESCRIPTION

Field Name: workflow.[n].data_id
Type: String

Context Hierarchy

The Context Hierarchy from which the workflow should be carried out. Specifying a value here makes it possible to override the context hierarchy to which the provisioning workflow belongs when it is created and used in a domain model.

Field Name: workflow.[n].hierarchy
Type: String

Map Data

Specify a macro to map data from a Relation/Wizard to the work flow step.

Field Name: workflow.[n].map_data
Type: String

Description

Description for this workflow step

Field Name: workflow.[n].description
Type: String

Execute Asynchronously

If selected the step will be executed asynchronously, otherwise it will be executed synchronously(default). Workflows do not wait for asynchronous steps to complete before proceeding with the next step nor do they account for any failures occuring as part of the execution of such steps.

Field Name: workflow.[n].asynchronous
Type: Boolean

Network Device Filter

Field Name: network_device_filter
Type: Object

Device type

The type of the device, for example CallManager, CUC

Field Name: workflow.[n].network_device_filter.device_type
Type: String
Choices: ["CTX", "CUCM", "CUC", "LDAP", "Lync", "ServiceNow", "TMS", "IOS", "PGW", "WebEx", "CUCCE", "CUCCX", "HCMF"]

Device Instance

Network Device instance for search limitations

Field Name: workflow.[n].network_device_filter.device_instance
Type: String
Choices: [" "]

Ignored Errors

The workflow will continue if this steps encounters the following error codes

Field Name: ignored_error_codes.[n]
Type: Array

Configuration Templates

The Configuration Template to apply if the Entity of the operation is a model.

Field Name: templates.[n]
Type: Array

Template *

Configuration Template

Field Name: workflow.[n].templates.[n].template
Type: String
Target: data/ConfigurationTemplate
Target attr: name
Format: uri

conditions

Field Name: conditions.[n]
Type: Array
Format: uri

Condition *

Field Name: workflow.[n].templates.[n].conditions.[n].condition
Type: String

Foreach List Macro

A list of values in Macro List Lookup can be obtained and stored in an Assigned Variable that will be looped through. If one or more of Condition is specified for the operation, then the evaluated condition is tested before each loop of the Foreach List Macro.

Field Name: foreach.[n]
Type: Array

Macro List Lookup *

The macro to return a list. For the macro syntax to return a list, see the General Help.

Field Name: workflow.[n].foreach.[n].macro_list
Type: String

Assigned Variable *

The variable used to store the list returned by the macro.

Field Name: workflow.[n].foreach.[n].context_var
Type: String

Set Context Variables

A list of variables that enriches the context. Macros can be used to obtain objects and enrich the workflow context.

Field Name: set_list.[n]
Type: Array

Variable Name *

The name of the variable. This can be a macro or static name.

Field Name: workflow.[n].set_list.[n].set_var_name
Type: String

Value *

The value of the variable. This can be a macro or static value.

Field Name: workflow.[n].set_list.[n].set_var_value
Type: String

Conditions

The list of conditions that should resolve to True in order for the selected operation to be carried out.

Field Name: condition.[n]
Type: Array

Condition *

Field Name: workflow.[n].condition.[n].condition
Type: String

Action to perform on failure

Action to perform on failure. Default: skip

Field Name: workflow.[n].condition.[n].action
Type: String
Default: skip
Choices: ["Skip", "Error"]

Error Message

The custom message that would be displayed

Field Name: workflow.[n].condition.[n].error_message
Type: String

Advanced find options

The specification to find a specific value of an attribute of a model for the workflow operation to be carried out.

Field Name: advanced_find_options.[n]
Type: Array

Model attribute

The selected of the attribute of the model.

Field Name: workflow.[n].advanced_find_options.[n].model_attribute
Type: String
Choices: [""]

Mapped Value

The specified value of the attribute. Macros can be evaluated here to provide the value.

Field Name: workflow.[n].advanced_find_options.[n].mapped_value
Type: String

Advanced Find Search Direction

Specifies which direction to search along the hierarchy tree. Default: full_tree

Field Name: workflow.[n].advanced_find_search_direction
Type: String
Default: full_tree
Choices: ["Full Tree", "Up", "Down", "Local"]

Model: data/ProvisioningWorkflow

Model Details