ProjectWise Administrator Help

Action Types

The Rules Engine comes with a predefined list of actions which can be used to make user-defined rules.

Standard ProjectWise Actions

The following are the standard ProjectWise actions to choose from.

Change State

This action is used to change the workflow state of the selected document. The target state is defined in Parameter 1. This action will invoke the ProjectWise messaging agent rules if defined. Non-linear state changes are supported so that states may be skipped. Skipping states does not record audit trail entries for those skipped states and any messaging agents configured for those states are not initiated.

Action Type Param1 Param2
CHANGE_STATE <Target State> not used

Set Attribute

This action is used to set the value of an attribute of the selected document. The target attribute name is stored in Parameter 1, and the required value in Parameter 2.

Action Type Param1 Param2
SET_ATTR <Target Attribute Name> <Required Attribute Value>

Clear Attribute

This action is used to clear the value of an attribute of the selected document. The target attribute name is stored in Parameter 1.

Action Type Param1 Param2
CLEAR_ATTR <Target Attribute Name> not used

Create Version

This action is used to create a new version of the selected document. The default Document > New > Version command is disabled for any documents that are in a workflow that is configured to use the Rules Engine. A user must have their Create Version user setting turned on to run a rule with the CREATE_VER action enabled, otherwise they will receive the error that they have insufficient privileges to finish the operation.

Action Type Param1 Param2
CREATE_VER not used not used

Update Title Block

This action is used to silently check out and check in a CAD document in order to update the title block. The user needs to have File Write access to the document, otherwise the update will fail.

Action Type Param1 Param2
UPDATE_TB not used not used

Set Final Status

This locks the selected document(s) down with Final Status. There is no action to remove Final Status as all standard ProjectWise commands are disabled for a Final Status document, including Change State which is required for Rules Engine operations. Documents locked with Final Status must have Final Status removed as with any other ProjectWise document.

Action Type Param1 Param2
SET_FINAL_STATUS not used not used

Enhanced ProjectWise Actions

The following is a list of action types which automate non-standard ProjectWise actions.

Audit Trail Comment

This action opens the Audit Trail Comments dialog so that the user can enter change comments. The target state is defined in Parameter 1.

Action Type Param1 Param2
AUDIT_COMMENT <Target State> not used

Message Box

This action opens a message box with the text specified in Parameter 1.

Action Type Param1 Param2
MSG_BOX <message to be shown> not used

Change Revision Number

ProjectWise has the ability to automatically handle version strings in the form of A, B, C, etc or 1, 2, 3, etc. Manual manipulation of the version strings was also supported.

With the Rules Engine, it is possible to handle automatic version string control. The default supported format when using the Rules Engine is XYY.ZZ where:

X = prefix letter

YY - Numerical Revision (Major)

ZZ - Numerical Version (Minor)

This action is used to change the Revision string of the selected document. The target attribute is defined in Parameter 1. The change action is defined in Parameter 2.

The ProjectWise native Version property may be synchronized with the custom revision attribute if required for any document that is in a workflow that is configured to use the Rules Engine.

Action Type Param1 Param2
CHANGE_REV_NO <Target Revision Attribute>

INC_MIN - This increases the Minor (ZZ) part of the string by 1 e.g. P01.1 > P01.2

INC_MAJ - This increases the Major (YY) part of the revision string by 1, and resets the Minor part to 1, e.g. P01.2 > P02.1

REMOVE_MIN - Used to remove the Minor version from the Attribute.

Shift Revision History

In addition to the ability to manage automated revisioning, the Rules Engine offers the ability to manage revision history attributes in the document environment. As each new version is created, the current revision attributes such as Revision, revision Note, Created By, Created Date, Approved By, etc can by archived by moving them to Read Only attributes on the same interface.

These archived attributes can be synchronized to a revision title block using ProjectWise attribute exchange.

Action Type Param1 Param2
SHIFT_REV_HISTORY not used not used