WorkflowConfiguration Class [AX 2012]

The WorkflowConfiguration class is used to create and maintain workflow configurations.

class WorkflowConfiguration implements SysPackable

Run On

Called

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

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.

Object Class
  WorkflowConfiguration Class

Community Additions

ADD
Show: