Bell Promote Component Guide · 20/09/2011 Simon Heath 1.2 Updated for new installer 24/05/2012...

Bell Promote Component Guide

Nassim BOUAYAD-AGHA [email protected]

This document contains confidential information and may not be disclosed without written permission of Wincom Consulting S.L.

WComBellPromoteGuide 1.1 of 12

Document Properties

File Name Status

WComBellPromoteGuide.docx Released

Change History

Date Author Version Description

14/09/2011 Nassim BOUAYAD-AGHA 1.0 First Draft

19/09/2011 Simon Heath 1.1 Added workflow robots and slight modification to property behaviour

20/09/2011 Simon Heath 1.2 Updated for new installer

24/05/2012 Simon Heath 1.3 Added new workflow robots

14/06/2012 Simon Heath 1.4 Added new promote approval groups and reformatted documation

Approvers

Approver Approval Date Comments

Simon Heath 20/09/2011



Table of Content

1. Keywords ------------------------------------------------------------------ 4

2. License agreement ------------------------------------------------------ 4

3. Description ---------------------------------------------------------------- 4

4. Installation ---------------------------------------------------------------- 4

4.1. Un-installation ------------------------------------------------------------------------- 5

5. Properties files ----------------------------------------------------------- 5

6. Modification to OOTB Promotion Behaviour ----------------------- 5

6.1. Configuration -------------------------------------------------------------------------- 5

6.1.1. Workflow configuration ------------------------------------------------------------------- 5

6.1.2. Property configuration -------------------------------------------------------------------- 6

7. General Workflow Robots ---------------------------------------------- 6

7.1. Setting the correct states ------------------------------------------------------------ 6

7.2. Checking invalid previous revisions ---------------------------------------------- 7

8. Group Approval Selection --------------------------------------------- 8

8.1. Introduction ---------------------------------------------------------------------------- 8

8.2. Example workflow -------------------------------------------------------------------- 8

8.2.1. Create a new assign task to set the selection ---------------------------------------- 8

8.2.2. Execution ----------------------------------------------------------------------------------- 9

8.3. Properties ------------------------------------------------------------------------------ 10

9. OOTB behavior of promotion request behavior ------------------ 11



1. Keywords

Keyword Description

${WT_INSTALL} The Windchill’s install directory, where Java is installed (ie. W:\ptc)

${WT_HOME} The Windchill`s base directory (ie. ${WT_INSTALL}\Windchill)

OOTB Out Of The Box

2. License agreement

Before proceeding with install, please read carefully the license agreement which is located here

http://www.wincom-consulting.com/public/WincomSoftwareLicense.1.0.pdf

3. Description

This component has various features affecting the promotion processes.

4. Installation

This installation step may be done each time that a BellPromote version is installed.

1. Stop the servers

2. Place the jar file into the Windchill installation directory ($WT_HOME), and using a Windchill Shell, execute the following command :

jar xvf WComBellPromoteX.jar

Where X is the component version.

3. Install the component, by executing in a Windchill shell:

ant -f wcom\bellpromote\scripts\install.xml

4. Restart the servers

http://www.wincom-consulting.com/public/WincomSoftwareLicense.1.0.pdf



4.1. Un-installation

1. Stop the servers, including Apache

2. Execute in a Windchill shell :

ant -f wcom\bellpromote\scripts\uninstall.xml

5. Properties files

Any site specific property must be defined in the file :

${WT_HOME}\wcom\ bellpromote \properties\ bellpromote_custom.properties

Note that this file must be created; any redefined property in this file will override the default.

6. Modification to OOTB Promotion Behaviour

The component changes the OOTB behaviour of promotion request behaviour

• Promoted object list contains one or more parts with common target states: In this case, the user will be able to select states that are common to the parts only. Non part objects target states will be determined from the parts’ target state.

• Promoted object list contains parts without common target states : In this case, the user will not be able to promote objects (No common state)

• Promoted object list does not contain any part: In this case, the behavior does not change form OOTB.

6.1. Configuration

6.1.1. Workflow configuration

As the administrator edit the Promotion Request Approval workflow to replace the following call, ensure the workflow is checked in after the edit.

Replace

wt.maturity.MaturityServerHelper.service.promoteTargets(pn);

with



com.bellequipment.wincom.promote.workflow.BellPromoteHelper.service.promoteTargets(pn);

and check the syntax

6.1.2. Property configuration

Properties are used to define a type target state depending on the part’s target state, using the following pattern

bellpromote.promote.TYPE_NAME.PART_TARGET_STATE=TYPE_TARGET_STATE

Note: Internal values must be used, any spaces must be replaced with underscore

For example, to define that a wt.doc.WTDocument target state must be set to CLOSED when a part target state is set to VALIDATED, the following property must be defined :

bellpromote.promote.wt.doc.WTDocument.VALIDATED=CLOSED

Note that the TYPE_NAME can be also a soft type name.

In addition a default may be used

bellpromote.promote.VALIDATED=CLOSED

Means that all types that are not parts will be set to CLOSED.

Please note if no property is defined it will assumed that the target state will be the same as the Promotion Request’s target state.

7. General Workflow Robots

The component provides a helper class to be called in the workflow,

7.1. Setting the correct states

In order to correctly set the PromoteNotice target states:

com.bellequipment.wincom.promote.workflow.BellPromoteHelper.service. promoteTargets(pn);



7.2. Checking invalid previous revisions

This robot will check all previous revision states and if any match the target state of the promotion is will return true.

checkLastVersionOnly is by default false, if it is set to true it will only check the previsor revision otherwise all revisions will be checked

com.bellequipment.wincom.promote.workflow.BellPromoteHelper.service. isPreviousRevisionStateInvalid(PromotionNotice pn, boolean checkLastVersionOnly);

An example workflow is included here

wcom\bellpromote\resources\workflows\invalidpn.jar



8. Group Approval Selection

8.1. Introduction The concept of this process change is to allow the users of a promotion request to select from a restricted list the approves they wish to nominate. They must select at least one from a predetermined list.

8.2. Example workflow An example workflow can be setup as follows.

8.2.1. Create a new assign task to set the selection

The user must select a one or more groups, which are defined in the activity as variables

The select group activity can be place any where before the approval step and must be defined as follows. (this example uses three groups variable GroupA, GroupB, GroupC)



The code to add is as follows and must not be wrapped in an exception

com.bellequipment.wincom.promote.workflow.BellPromoteHelper.service.checkValidGroupSelected(self);

com.bellequipment.wincom.promote.workflow.BellPromoteHelper.service.processApproverRole(self);

8.2.2. Execution

The system administrator must create the groups associated with the variables



The user is presented with the following task

Note the following error is due to a missing group

Note the groupvarprefix.[name] property can be used to map attribute names to group names

8.3. Properties

All properties must be placed in a _custom file and prefixed with bellpromote.promote



Property Description Type Default

groupvarprefix The attributes must begin with this B

String Group

groupvarprefix.[name] A mapping between the workflow variable name and the actual group name

String None

9. OOTB behavior of promotion request behavior

Considering the following objects to promote.P1 and P2 are parts and D1 is a document

P1 and P2 have the same lifecycle state, D1 has a different one

The state “State for Promotion” are the states common to P1 and P2 only



The target state of D1 will be determined according the State of Promotion of the parts (Using the property file, described in 5.3.2).

External References

Reference Description

Bell Promote Component Guide · 20/09/2011 Simon Heath 1.2 Updated for new installer 24/05/2012...

Documents

Transcript of Bell Promote Component Guide · 20/09/2011 Simon Heath 1.2 Updated for new installer 24/05/2012...