Skip to main content


persistent class EnsLib.Workflow.UserDefinition extends %Library.Persistent, %XML.Adaptor, %CSP.Util.AutoForm

SQL Table Name: EnsLib_Workflow.UserDefinition

Defines a workflow user.
Typically the user name matches a system user name but this is not required.
Workflow users that are not registered system users will not be able to log into the Workflow portal and check the status of their worklist.

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
Use our own domain for localization


property FullName as %String (CAPTION = "@EnsColumns:FullName@Full Name", MAXLEN = 128, XMLNAME = "fullname", XMLPROJECTION = "attribute");
(Optional) Full name (i.e., "Presley,Elvis") for User.
Property methods: FullNameDisplayToLogical(), FullNameGet(), FullNameGetStored(), FullNameIsValid(), FullNameLogicalToDisplay(), FullNameLogicalToOdbc(), FullNameNormalize(), FullNameSet()
property IsActive as %Boolean (CAPTION = "@EnsColumns:IsActive@Is Active", XMLNAME = "isActive", XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Indicates if this user is currently active.
Property methods: IsActiveDisplayToLogical(), IsActiveGet(), IsActiveGetStored(), IsActiveIsValid(), IsActiveLogicalToDisplay(), IsActiveLogicalToXSD(), IsActiveNormalize(), IsActiveSet(), IsActiveXSDToLogical()
property Name as %String (CAPTION = "@Ensemble:Name@Name", MAXLEN = 128, XMLNAME = "name", XMLPROJECTION = "attribute") [ Required ];
The user name of this Workflow user.
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()


classmethod %OnDelete(oid As %ObjectIdentity) as %Status
Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted.

classmethod CreateUser(pUserName As %String, pFullName As %String = "") as %Status
Create a Workflow user
classmethod DeleteUser(pUserName As %String) as %Status
Delete a Workflow user
classmethod DrawHTMLFormFields(pObj As %RegisteredObject) as %Status
method GetRoleSet() as %ResultSet
Returns a %ResultSet of all roles for this user. The returned result set is executed and ready to be read from.
method OnSubmit(ByRef pID As %String, pSubmit As %String) as %Status
This callback is called when this form is submitted. pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).


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


trigger SQLDelete (BEFORE event DELETE);
SQL Delete Trigger
trigger SQLUpdate (BEFORE event UPDATE);
SQL Update Trigger

Inherited Members

Inherited Methods


Storage Model: Storage (EnsLib.Workflow.UserDefinition)

FeedbackOpens in a new tab