Trigger Macro Categories

The following tables list macros in categories. These categories are referenced later for each trigger supported event. Standard macros are available to programs used for all trigger events.

Trigger programs have access to Intrinsic Macros, as well as others that are applicable to the specific event.

Macro (and RPE variable) values remain the same between activation of the check program, the override program, and the action program. You need to take care when interpreting the meaning of macros. For example, there are macros called OWNER and NEWOWNER for the changeowner event, which makes clear sense for the check program and override program, but by the time the action program executes, the owner may have changed. No additional macro called OLDOWNER is necessary, but the action program must use OWNER to mean "old owner" and NEWOWNER to mean "current owner."

Standard Macros
Macros	Meaning
`TIMESTAMP`	The current date/time
`EVENT`	Most recent transaction performed. `EVENT` for triggers will equal any of the Supported Trigger Events.

Context/Access Macros
Macro	Meaning
`USER`	Current user
`ACCESSFLAG`	Access flag (`True` if `USER` will be allowed to perform event)
`CHECKACCESSFLAG`	Check access flag (`False` when access is not checked, such as during import)
ACCESS	The current access being checked
RULEUSER	The user for which a rule is defined
CHECKEDUSER	The current user being checked (This macro can only be evaluated in the context of an access filter.)
CHECKEDUSER_PRJ	The projects of `CHECKEDUSER`
CHECKEDUSER_ORG	The organizations of `CHECKEDUSER`
CHECKEDUSER_ROLE	The roles of `CHECKEDUSER`

Business Object Macros
Macro	Meaning
Business Object Identification Macros	Object Identifiers
`OWNER`	Object Settings and descriptions
`DESCRIPTION`
`CURRENTSTATE`
`ENFORCEDLOCKINGFLAG`
`LOCKFLAG`
`LOCKER`
`POLICY`

State Macros
Macro	Meaning
`ISENABLED`	Boolean State Flags
`ISDISABLED`
`ISOVERRIDDEN`
`ISCURRENT`
`ISREVISIONABLE`
`ISVERSIONABLE`
`HASSCHEDULEDATE`
`HASACTUALDATE`
`AUTOPROMOTE`

Signature Macros
Macro	Meaning
`SIGNATURE`	Current Signature Name
`ISSIGNED`	Boolean Signature Flags
`ISAPPROVED`
`ISREJECTED`
`ISIGNORED`
`EXISTINGSIGNER`	If signed, the signer's Name.
`EXISTINGCOMMENT`	Associated comment.

Relationship Macros
Macro	Meaning
`RELTYPE`	Relationship Name
`RELID`	Relationship ID, available for all relationship trigger events.
`FROMMEANING`	From side meaning
`FROMTYPES`	From business Types allowed (excluding child Types)
`FROMALLFLAG`	Boolean flag - `True` if all business Types allowed
`FROMREVACTION`	Revision action of Object at From end. Value=`Float`, `Replicate`, or `None`.
`FROMCARD`	Cardinality of From connection. Value=`One` or `N`
`TOMEANING`	To side meaning
`TOTYPES`	To business Types allowed (excluding child Types)
`TOALLFLAG`	Boolean flag -`True` if all business Types allowed
`TOREVACTION`	Revision action of Object at To end. Value=`Float`, `Replicate`, or `None`.
`TOCARD`	Cardinality of To connection. Value=`One` or `N`

Attribute Macros
Macro	Meaning
`ATTRNAME`	Name of attribute
`ATTRVALUE`	Current value
`ATTRTYPE`	Type (`Integer`, `Real`, `String`, `Boolean`, or `Date`)
`ATTRDEFAULT`	Default value
`ATTRCHOICES`	List of value choices

Process Macros
Macro	Meaning
`PROCESS`	Name of the process definition defined in Business Modeler
`WORKFLOW`	Name of workflow defined in Matrix Navigator
`WORKFLOWOWNER`	Name of workflow owner defined in Matrix Navigator
`WORKFLOWID`	System generated workflow ID of this workflow instance. This ID can be used in place of processname workflowname in commands like print workflow or modify workflow. It is NOT a businessobject ID.

Interactive Activity Macros
Macro	Meaning
`ACTIVITYTYPE`	Name of activity definition defined in Business Modeler
`ASSIGNEE`	Name of user that process has assigned to the activity in Business Modeler
`ACTIVITY`	Name of activity instance created in ENOVIA Live Collaboration
`ACTIVITYID`	System generated activity ID
`ACTIVITYOWNER`	Name of activity owner

Auto Activity Macros
Macro	Meaning
`AUTOACTIVITYTYPE`	Name of automated activity definition defined in Business Modeler
`AUTOASSIGNEE`	Name of automated activity assignee
`AUTOPROGRAMNAME`	Name of automated activity program
`INPUTARGS`	Input arguments for the program object
`AUTOACTIVITY`	Name of automated activity instance
`AUTOACTIVITYID`	System generated activity ID
`AUTOACTIVITYOWNER`	Name of activity owner

Query Variables/Macros
Variable	Meaning
TYPE_PATTERN*	The value entered in the Type field of the Find or Find Like windows, or the TYPE_PATTERN specified in MQL/ENOVIA Studio Customization Toolkit programs.
NAME_PATTERN*	The value entered in the Name field of the Find or Find Like windows, or the NAME_PATTERN specified in MQL/ENOVIA Studio Customization Toolkit programs.
REVISION_PATTERN*	The value entered in the Revision field of the Find or Find Like windows, or the REVISION_PATTERN specified in MQL/ENOVIA Studio Customization Toolkit programs.
VAULT_PATTERN*	The value entered in the Vault field of the Find or Find Like windows, or the VAULT_PATTERN specified in MQL/ENOVIA Studio Customization Toolkit programs.
OWNER_PATTERN	The value entered in the Owner field of the Find or Find like windows, or the OWNER_PATTERN specified in MQL/ENOVIA Studio Customization Toolkit programs.
WHERE_PATTERN	The value entered in the Where field of the Find or Find like windows, or the WHERE_PATTERN specified in MQL/ENOVIA Studio Customization Toolkit programs.
EXPANDTYPE	Boolean value specified in the query.
LIMIT	Integer value specified in the query. May be set as environment variable. The setting in the query trigger will overwrite the setting in the environment.
When resetting these as RPE variables in a ValidateQuery program, you must make them global.