System / Add-in Manager / Define Workflow Rules
Archibus SaaS / System / SaaS Partner Administrator / Define Workflow Rules
Create and Edit Message Workflow Rules
A message workflow rule is run in response from a user action (such as a view command or a JS event handler, which sends an action to the server). It is triggered by an Event Handler method.
You can add a new message rule, or edit an existing message rule. A
typical edit is changing the Event Handler that is called by a message
rule. For example, you can change the "Submit Request" rule
to call the SubmitAndApproveRequest Event Handler method,
instead of the SubmitRequest method.
To edit or create a message workflow rule:
- Access the Workflow Rule Manager at one of the above locations.
- To create a new rule,
choose the primary application in which this rule will be used and click
Add New.
To edit an existing rule, in the left frame select the application and the message workflow rule that you want to edit. - The Workflow Rules Manager displays the following
options for defining the message workflow rule:
Option Value Primary Application
The primary application to which this rule will pertain. This field is validated by the Archibus Applications table.
Rule Name
This field, together with Primary Application, define the unique key that can be used to call this rule, either from the Archibus Web Central interface using a <command type="workflowRule"> element or a JS event handler, or from another workflow rule.
Description
Enter a description of the workflow rule.
Security Group
Enter the security group of the user allowed to execute this rule. For instance, if you are currently logged in as SMITH, SALLY, SMITH, SALLY must be a member of a security group specified by this option in order to execute the rule.
Rule Type
Set this to Message. This means that this rule can be invoked from the Web Central interface
Active?
If you want this workflow rule to take place now, set to yes. If you want to retain its definition to be used later, set to No. See Activate Workflow Rules.
Event Handler Class
Display this and the next option in the console by clicking on "Event." Defines the full Java class name that implements the workflow rule. Typically you will use one of the pre-defined Java classes that is provided by Web Central, but you can also create your own Java class and enter it here.
Event Handler Method
Specifies which method of the Event Handler Java class should be called. Usually you leave this field empty, so that any public method of the Event Handler Java class can be called as a message rule.
Message Inputs
For information on message inputs, see Archibus System Management Help.
- Click Save to save your edits to the database.
- If you change any workflow rule properties on this form, you will need to restart the application server in order to reload workflow rules with updated properties. For Archibus SaaS deployments, you must contact Customer Support and request a restart of the cloud environment.