ProjectWise Document Actions Manager - Startsida - … Document Actions Manager Deployment Guide Bentley Professional Services - GSST Version: 1.2 Date: January 21, 2011 Page 4 of

ProjectWise Document Actions Manager

Bentley Professional Services - GSST

Deployment Guide

Version: 1.2


Deployment Guide


Version: 1.2 Date: January 21, 2011 Page 2 of 13

CONFIDENTIALITY STATEMENT

The contents of this document, including system ideas and concepts, are confidential and proprietary in nature and

are not to be distributed in any form without the prior written consent of Bentley Systems Inc.

Document Version History

Version Owner Date Description

1.0 Visvaldas Seskus 23 July, 2010 Initial version

1.1 Visvaldas Seskus 3 September, 2010 Updated with new action descriptions.

1.2 Visvaldas Seskus 21 January, 2011 Updated customization title. Reviewed content.


Deployment Guide






Table of Contents

1 Overview ........................................................................................................................................... 4

1.1 Purpose of this document .......................................................................................................... 4

1.2 Business Case ............................................................................................................................ 4

2 Installing ProjectWise Document Actions Manager customization ..................................................... 5

2.1 Preparing for installation ........................................................................................................... 5

2.2 Preparing ProjectWise database ................................................................................................ 5

2.2.1 Creating database objects .................................................................................................. 5

2.3 ProjectWise client customization setup ..................................................................................... 6

3 Configuring ProjectWise Document Actions Manager customization ................................................. 7

3.1 Overview ................................................................................................................................... 7

3.2 ProjectWise Document Actions Manager configuration objects and settings ............................. 7

3.3 Document Actions Manager rules configuration ...................................................................... 13


Deployment Guide






1 Overview

1.1 Purpose of this document

The purpose of ProjectWise Document Actions Manager deployment guide is to provide detailed

instructions how to prepare and deploy a ProjectWise Document Actions Manager customization.

1.2 Business Case

ProjectWise Document Actions Manager is a ProjectWise explorer extension which allows customizing

document processing actions for each workflow state and allows implementing non linear workflow. In

addition it customizes the versioning of drawing references and maintains the history of its versions in

the title block of the drawing.


Deployment Guide






2 Installing ProjectWise Document Actions Manager customization

2.1 Preparing for installation

On a computer where ProjectWise Document Actions Manager shall be installed:

1. Log in to Windows as a user, which belongs to the local Administrators group or at least has sufficient permissions to run setup packages and install new programs.

2. Extract the contents of DocActionsManager_08.117.xx.yy.zip into folder DocActionsManager_08.117.xx.yy

2.2 Preparing ProjectWise database

ProjectWise Document Actions Manager customization requires custom tables to be created in the ProjectWise datasource. Please ensure that you have necessary credentials to access database server and sufficient permissions to execute SQL scripts and create/alter database objects. The steps below need to be repeated for each datasource where the ProjectWise Document Actions Manager will be used. Note: when upgrading the ProjectWise Document Actions Manager to higher version do not run the

scripts in database where ProjectWise Document Actions Manager customization was previously installed

unless explicitly advised. Existing settings and data may be lost during the process.

2.2.1 Creating database objects

Please refer to database server specific installation instructions below.

SQL Server based deployment

Using SQL Server Management Studio open and run the following SQL script files in given order:

Important: Make sure the database in which you want to enable ProjectWise Document Actions Manager is active in the Management Studio before running the scripts!

1. DocActionsManager_08.117.xx.yy\SQLScripts\MSSQL\BNT_SETTINGS.sql The script creates database objects for storing ProjectWise Document Actions Manager specific settings

2. DocActionsManager_08.117.xx.yy\SQLScripts\MSSQL\CreateTables.sql The script creates database tables for storing ProjectWise Document Actions Manager menu configuration and rules and actions records.

3. DocActionsManager_08.117.xx.yy\SQLScripts\MSSQL\spIncrementVersionNumber.sql The script creates stored procedure which implements revisions manipulation.

Oracle based deployment

Run the following SQL script files in given order:


Deployment Guide






Important: Please make sure you use the correct database and user before running the scripts below.

1. DocActionsManager_08.117.xx.yy\SQLScripts\Oracle\BNT_SETTINGS.sql The script creates database objects for storing ProjectWise Document Actions Manager specific settings

2. DocActionsManager_08.117.xx.yy\SQLScripts\Oracle\CreateTables.sql The script creates database tables for storing ProjectWise Document Actions Manager menu configuration and rules and actions records.

3. DocActionsManager_08.117.xx.yy\SQLScripts\Oracle\SPINCREMENTVERSIONNUMBER.sql The script creates function which implements revisions manipulation.

2.3 ProjectWise client customization setup

ProjectWise Windows client customisation for ProjectWise Document Actions Manager needs to be

installed in all end-user workstations. The client customisation adds ProjectWise Document Actions

Manager customisation specific items to ProjectWise document context menu.

Installation steps

Execute DocActManager.msi from DocActionsManager_08.117.xx.yy directory.


Deployment Guide






3 Configuring ProjectWise Document Actions Manager customization

3.1 Overview

The ProjectWise Document Actions Manager customization operates with documents in ProjectWise and

gets enabled for specific datasources only (having the required configuration tables). It disables the

standard ProjectWise workflow commands and displays custom items in the ProjectWise document

Change State menu for datasources having the customization configuration. It will execute a chain of

document and its attributes modification actions when the custom document action command gets

clicked. The list of custom document commands, their order as well as the rules for document and its

attributes modifications are configurable and stored in the ProjectWise Document Actions Manager

customization tables.

3.2 ProjectWise Document Actions Manager configuration objects and

settings

1. Settings stored in BNT_OPERATION_TYPES table are used to define the menu items visible for

the document -> Change State command in the ProjectWise client

Column name Description

ID Unique operation identifier, which maps to document action command

in the rules matrix spreadsheet.

Possible values: APPROVE, ISSUE, REVISE, OBSOLETE (and other if they

are defined in the rules matrix)

NAME Menu item name visible in the ProjectWise client.

PROMPT Prompt message

MODULE Dynamically linked library which implements actions manager

functionality and exposes callback methods to handle menu item

actions. The default value is ‘DocActionsManagerEngine.dll'

CALLBACK_EXEC Callback method to be executed. The default value is 'Exec_DefaultCmd'

CALLBACK_STATE Callback state to be passed when the menu item event is initiated. The

default value is 'State_DefaultCmd'

MENU_ORDER Menu item position in the Change State menu.


Deployment Guide






* The default menu items configuration table records will be created when the database objects

creation script is executed.

2. Settings stored in BNT_SETTINGS table:

Name Description Sample

BNT_CRS_REVISION_ATTRIBUTES Attribute names which should be

affected by revision attribute

shifting. Separated by “;”. Attribute

names are case sensitive.*

ATTR_1;ATT

R_2;ATTR_3

BNT_CRS_REVISION_HISTORY_CO

UNT Number indicating how much

revisions are used in revision

attributes shifting. Must be greater

than 0.*

8

ROLLBACK_USER_NAME Login name for super user. Super

user must belong to ProjectWise

”Administrator” user group.

Super_admi

n

ROLLBACK_USER_ENC_PASSWORD Password for super user login. Passw00

SUPER_USER_NAME ProjectWise user name which

should be used for actions marked

as “USE_SUPER_USER”

Pwadmin

SUPER_USER_PASSWORD ProjectWise user password which

should be used for actions marked

as “USE_SUPER_USER”

aaa

* Corresponding attributes must be already created. Customization will complain about the

missing attributes and illegal values.

3. Custom tables used in ProjectWise Document Actions Manager:

BNT_ST_CHG_RULE table will be used to define which rule should be executed for a selected

document that is stored in a particular workflow and workflow state.


Deployment Guide







RULE_ID Unique ID of the rule defining, which rule shall be executed for

the selected document depending on its current workflow

(WORKFLOW), state (STATE) and performed operation

(OPERATION_TYPE)

WORKFLOW Name of the ProjectWise workflow that should be assigned to

the current document

STATE Name of the ProjectWise state that should be assigned to the

current document

OPERATION_TYPE Examples of possible (but not limited to) operation types:

‘APPROVE’ – this operation shall be used to filter our actions

that should be performed if document is approved (menu

command “Approve” is invoked)

‘ISSUE’ – this operation shall be used to filter our actions that

should be performed if document is issued (menu command

“Issue” is invoked)

‘REVISE’ – this operation shall be used to filter our actions

that should be performed if document is revised (menu

command “Revise” is invoked)

‘OBSOLETE’ – this operation shall be used to filter our actions

that should be performed if document is set as obsolete

(menu command “Obsolete” is invoked)

PROMPT_MSG A text that will be displayed as a message box before moving any

of the selected document to the target state. The message will

contain Yes/No buttons allowing the user to cancel whole

operation for all selected documents. If this column is empty, the

message is not displayed


Deployment Guide






BNT_ST_CHG_ACTION table will be used to define actions (eg. update attribute, clear attribute,

etc.)


ACTION_ ID Unique action ID

ACTION_TYPE One of the following supported action types:

CHANGE_STATE – this action shall be used to change

workflow state for the selected document. Target state shall

be defined in the PARAM1 column. This action shall invoke

ProjectWise Messaging agent rules if they are defined. In

addition the actions shall display a dialog to input user

comment that will be stored in Audit Trail.

CLEAR_ATTR – this action shall be used to clear value of the

attribute, which name is stored in the PARAM1 column

SET_ATTR – this action shall be used to set value of the

attribute, which name is stored in the PARAM1 column.

CREATE_VER – this action shall be used to create a new

ProjectWise version for the selected document.

UPDATE_TB – this action shall be used to check-out and

check-in a document. This is required in order to update title

blocks

CHANGE_REV_NO – this action changes revision number,

which is stored in the attribute specified in PARAM1.

PARAM2 should contain one of the following options allowing

to control how revision number is increased:

o INC_MIN – this options means that the customisation

shall increase just a minor version of the revision number

which consists of three parts:

<major version>.<minor version>, eg. 1.1, 2.1

o INC_MAJ – this option means that the customisation shall

reset minor version to ‘1’ and increase a major part of the


Deployment Guide






revision number.

o REMOVE_MIN – this options means that the

customisation shall reset just a minor version of the

revision number to ‘0’

SHIFT_REV_HIST – this action shifts revision history records.

Shall be used in conjunction with CREATE_VER or

CHANGE_REV_NO.

LOCK_UNLOCK_XREF – this action locks/unlocks references

of current document (sets/resets Final status). The action is

stored in PARAM1 (LOCK or UNLOCK). References

locks/unlocks information is maintained in a custom table

BNT_XREF_LOCKED.

PARAM1 1st parameter for the action. It usually stores attribute name

PARAM2 2nd parameter for the action. It usually stores fixed text that must

be used as a value for the attribute while executing the

‘SET_ATTR’ actions.

USE_SUPER_USER Flag indicating if this action shall be executed with super user

account. Can be empty. Action will be executed with active user

account if value is empty or FALSE

BNT_ST_CHG_RULE_ACTION table will be used to define actions that must be performed while

executing a rule, which is triggered once the user invokes the “Approve”, “Reject” or “Revise”

commands.


RULE_ID A foreign key to the BNT_ST_CHG_RULE table

ACTION_ID A foreign key to the BNT_ST_CHG_ACTION table

ORDER_NO Number that is used to order a sequence of actions to be

executed


Deployment Guide






BNT_ST_CHG_CONDITION table will be used to define conditions that will be checked on a

selected document(s) before executing actions defined in a rule.


CONDITION_ID Unique condition ID

CONDITION_TYPE One of the following supported condition types:

EMPTY – the attribute defined in PARAM1 column must

be empty

NOT_EMPTY – the attribute defined in PARAM1 must

contain some value

REFS_VALID – this condition checks whether all

references attached to the document are not rejected

(see PARAM1 and PARAM2 for more details).

PARAM1 1st parameter for the condition. For the “REFS_VALID” condition

it must contain a name of the attribute that stores a mark

whether the document is rejected or not. The customisation will

check a value of this attribute for all references that are attached

to the current document. If any of the values (defined in

PARAM2) is detected on any reference, the customisation will not

allow to move the document to other workflow state.

PARAM2 2nd parameter for the condition. For the “REFS_VALID” condition

it must contain a semi-colon separated list of values (eg.

‘REJECTED; REVISED’) that should be checked in referenced

documents.

BNT_ST_CHG_RULE_CONDITION table will be used to define condition that must be checked

before actions defined in a rule will be executed on document. If any condition check fails the

customization will display an error and will skip execution actions on this document.


RULE_ID A foreign key to the BNT_ST_CHG_RULE table


Deployment Guide






CONDITION_ID A foreign key to the BNT_ST_CHG_CONDITION table

ORDER_NO Number that is used to order a sequence of conditions to be

checked

BNT_XREF_LOCKED table will be used to maintain references locks/unlocks


MASTER_PROJID Master document ProjectWise project/folder id

MASTER_DOCID Master document ProjectWise document id

REF_DOCGUID Unique identifier of the referenced document

REF_STATE Workflow state of the referenced document

REF_FINAL_STATUS Referenced document status before it was locked.

3.3 Document Actions Manager rules configuration

MS Excel based Document Actions Manager rules configuration matrix application should be used to

configure and populate the workflow customization configuration data tables with the corresponding

values.

Perform the following actions in order to achieve this:

1. Navigate to database provider specific directory in

DocActionsManager_08.117.xx.yy\Templates and run the Rules Matrix Template

spreadsheet.

2. Do the necessary data modifications and set rule flows in the Rules Matrix sheet

3. Go to Parameters sheet and click the “Create SQL File” button.

4. Run the SQL statements contained within the created file against your database and the

ProjectWise Document Actions Manager configuration tables will be populated with the

necessary data.

Documents

ProjectWise Document Actions Manager - Startsida - … Document Actions Manager Deployment Guide Bentley Professional Services - GSST Version: 1.2 Date: January 21, 2011 Page 4 of