Basic Rules for Administrators

The Basic Rule Wizard suits these purposes, as it is a step-by-step wizard that lets you define scripted actions. The Basic Rule Wizard creates workflow rules within the Web Central environment that you can invoke from form actions, or from the Navigator as a regular Workflow Rule. You can also copy the rule file to deploy it as a script, or define new rules with no knowledge of Java. You only need familiarity with some form of scripting.

Advanced Features for Extension Managers

Basic rules may not handle complex use cases, or cases where partners or customer sites wish to alter the deeper logic of off-the-shelf applications. To do so, launch Eclipse; this is the same integrated development environment that we use to develop extensions. Here you can reuse basic rules, rely on a complete toolset for scripting logic, and accomplish these aims:

• Add your own personalized handlers for user-interface events.
• Use your own set of nested routines or classes or use third-party classes.
• Alter the deeper logic for existing Archibus applications.
• Write high-performance actions that do not need repeat compilation.
• Use an IDE for logic development.

Step one: Select New or Existing Rule tab

If you choose to create a new rule, the program opens new rule dialog.

If you select to alter an existing rule, the program lists all rules currently in the schema\ab-products\common\resources\basic-rules\ folder.

Step two: Select Rule Template

For new rules, supply a rule name, such as MyRule . Optionally, add a template that inserts boiler plate for typical actions, such as executing a field formula or an SQL query.

Step three: Configure Script tab

Configure Script tab has two panels. The upper panel cointains your script, to modify as you like. For instance, if you add a template to execute an SQL query, you can alter the SQL statement as required. If you invoke a Field Formula, you can change both the calculation and the field that holds the result.

Click Test to compile and run your script. Errors, if any, appear in a pop-up dialog.

Click Save and Next to save the script to the basic-rules folder as a Java file, such as BasicRules_MyRule.java .

When you save the rule, the program adds the class declaration and the #import statements you need to run the rule. If you inspect the resulting file, you see your script is a standard Java file.

Step four: Add Rule to Process Navigator tab

Open the Process Navigator tab to add the rule to the Navigator as a task. The rule appears as a workflow rule or job, with a Start button.

Logging Progress

Use log.debug() to insert progress messages in your script. These messages appear in the logging panel at the bottom of the Configure Script tab. For example:

String message = "My first rule called";

log.debug(message);

These messages also appear in the WEB-INF\config\archibus.log file.

Showing Job Status

When you or your users run the rule from the Navigator or a form interface, no debug messages appear. If a job requires more than a few seconds, use the job status object to set the messages and percent complete on the thermometer-style progress bar that appears when you start the job.

Note: Progress bar appears when you run the rule from the Navigator, but not when you run the rule in the Configure Scripts tab.

Code below contains sample statements that update the status bar:

status.setResult("Hello World"); status.setTotalNumber(100); status.setCurrentNumber(0); status.setMessage("Starting"); // do some operation that takes time status.setCurrentNumber(50); status.setMessage("Halfway"); // do another operation that takes time status.setCurrentNumber(100); status.setMessage("Finished"); status.setCode(JobStatus.JOB_COMPLETE);

Comments

You can use Java comments in basic rule scripts. Do not use the "class" keyword in comments.

Executing Basic Rules from the URL

To execute Basic Rules manually, copy a .java file that contains the rule to the schema\ab-site\common\resources\basic-rules folder. Then invoke the rule from the URL. For instance, if the .java file were named BasicRules_myRule.java , invoke the rule from the URL as follows:

ab-single-job.axvw?ruleId=AbCommonResources-BasicRules_myRule

The single-job view loads, then invokes the rule specified after ruleId when you click Start Job .

Adding Basic Rules to the Navigator

To add Basic Rules to the Navigator, create a Process Tasks table (afm_ptasks) record, then enter a URL like that immediately above as the Task File parameter.

Executing Basic Rules from a Form

To invoke a Basic Rule as a form action, include the ruleId in an <action /> tag in the relevant form. Add-in managers need not never need to worry about compiling Basic Rules, since the program compiles them automatically at each invocation.