WorkflowConfiguration Class [AX 2012]
The WorkflowConfiguration class is used to create and maintain workflow configurations.
| Method | Description | |
|---|---|---|
| addElement | Adds an instance of the WorkflowElement class to the workflow configuration. |
| addNotificationText | Adds a localized notification message text to the workflow configuration. |
| addSubmitInstruction | Adds a localized submission message text to the workflow configuration. |
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| elementCnt | Returns the number of WorkflowElement classes added to the workflow configuration. |
| elementExists | Checks if a workflow element has been added to the workflow configuration. |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| getElement | Gets an instance of a WorkflowElement class. |
| getElements | Gets an array of instances of the WorkflowElement class. |
| getNotificationText | Gets a localized notification message text from the workflow configuration. |
| getNotificationTexts | Gets a list of localized notification message texts from the workflow configuration. |
| getSequenceNumber | Gets a workflow sequence number. |
| getSubmitInstruction | Gets a localized submission message text from the workflow configuration. |
| getSubmitInstructions | Gets a list of localized submission message texts from the workflow configuration. |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| init | |
| initFromConfigurationId | Sets the workflow configuration default data based on a workflow configuration record. |
| initFromTemplateName | Sets the workflow configuration default data based on a workflow template defined in the Application Object Tree (AOT). |
| load | Adds workflow elements to the workflow configuration. |
| moveelement | Reorders an instance of the WorkflowElement class in the workflow configuration. |
| new | Initializes a new instance of the WorkflowConfiguration class. |
| notificationKeySplit | Converts a notification key string into a language ID and event name. |
| notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
| notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
| objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| pack | Serializes the current instance of the WorkflowConfiguration class. |
| parmActivationCondition | |
| parmConfiguration | Gets or sets the Configuration parameter. |
| parmConfigurationConditions | Gets or sets the ConfigurationConditions parameter. |
| parmConfigurationId | Gets or sets the ConfigurationId parameter. |
| parmConfigurationNotes | Gets or sets the ConfigurationNotes parameter. |
| parmConfigurationType | Gets or sets the ConfigurationType parameter. |
| parmNotificationList | Gets or sets the NotificationList parameter. |
| parmTemplateName | Gets or sets the TemplateName parameter. |
| parmUpdateConfiguration | Gets or sets the UpdateConfiguration parameter. |
| parmVersionType | Gets or sets the VersionType parameter. |
| parmWorkflow | Gets or sets the Workflow parameter. |
| removeElement | Removes an instance of the WorkflowElement class from the workflow configuration. |
| removeNotificationText | Removes a localized notification message text from the workflow configuration. |
| removeSubmitInstruction | Removes a localized submission message text from the workflow configuration. |
| resetNotificationTexts | Removes all localized notification message texts from the workflow configuration. |
| resetSubmitInstructions | Removes all localized submission message texts from the workflow configuration. |
| save | |
| saveConfigurationCondition | |
| saveDefinition | Saves a new workflow configuration to the workflow tables. |
| saveDefinitionVersion | Saves a new version of an existing workflow configuration to the workflow tables. |
| saveExpressionTable | |
| saveMessageText | |
| saveNewElement | |
| saveNotificationText | |
| saveSteps | |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| unpack | Deserializes the _packedClass parameter value to an instance of the WorkflowConfiguration class. |
| updateConfiguration | Checks and updates workflow configuration if any dependant data or metadata has changed. |
| updateDefinition | Updates an existing workflow configuration to the workflow tables. |
| usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
| validate | Validates the header configuration data in the workflow configuration. |
| validateConfiguration | Validates the complete workflow configuration including elements and steps. |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
| ::construct | Initializes a new instance of the WorkflowConfiguration class. |
| ::create | Initializes a new instance of the WorkflowConfiguration class. |
| ::createLink | |
| ::createOutcome | |
| ::importConfiguration | Imports a workflow configuration from a file. |
| ::newConfiguration_ConfigurationId | Initializes a new instance of the WorkflowConfiguration class. |
| ::newConfiguration_TemplateName | Initializes a new instance of the WorkflowConfiguration class. |
| ::updateSubWorkflow |
This class encapsulates all tasks associated with creating or maintaining workflow configurations.
The tasks include the following:
-
Create the configuration based on an existing workflow configuration or workflow template defined in the AOT.
-
Add, get and remove message text information for notification, submission, and step instruction.
-
Add, get, and remove elements and steps.
-
Save a workflow configuration when it has been changed.
-
Handle workflow configuration versions.
-
Set workflow configuration as active and default configuration.
-
Export and import workflow configuration.