This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.Workflow.ActionDefinition


persistent class EnsLib.Workflow.ActionDefinition extends %Library.Persistent, %XML.Adaptor

SQL Table Name: EnsLib_Workflow.ActionDefinition

Defines the set of available actions that a user can make within a Workflow application. Users can extend this list.

Property Inventory

Method Inventory


property Caption as %String (MAXLEN = 100);
Used to display the button caption for this action within the workflow application.
Property methods: CaptionDisplayToLogical(), CaptionGet(), CaptionGetStored(), CaptionIsValid(), CaptionLogicalToDisplay(), CaptionLogicalToOdbc(), CaptionNormalize(), CaptionSet()
property Name as %String (MAXLEN = 50) [ Required ];
Identifying name used for this action. This must be a unique value.
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Prompt as %String (MAXLEN = 100);
If defined, this action prompts the user before performing the action.
Property methods: PromptDisplayToLogical(), PromptGet(), PromptGetStored(), PromptIsValid(), PromptLogicalToDisplay(), PromptLogicalToOdbc(), PromptNormalize(), PromptSet()
property Title as %String (MAXLEN = 100);
Used to display popup help for this action within the workflow application.
Property methods: TitleDisplayToLogical(), TitleGet(), TitleGetStored(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()


classmethod CreateDefaultActions(pForce As %Boolean = 0) as %Status
Create the set of default Workflow actions This will clear out the existing actions


query ActionList()
SQL Query:
SELECT Name,Caption,Title FROM ActionDefinition ORDER BY Name
Return a list of available Workflow actions.


index (ID on Name) [IdKey, Type = key];
Index methods: IDCheck(), IDDelete(), IDExists(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: CacheStorage (EnsLib.Workflow.ActionDefinition)