Q-PLM EV6CT5 Customization 5.1.0

Q-PLM ENOVIA V6 + CT5

Q-Checker ENOVIA V6 with CATIA V5 Integration

Installation on ENOVIA V6 Client and Server

Release 5.1.0

INSTALLATION GUIDE

Markings in this document

CAUTION marks important information. If you ignore such information, you risk a loss of

data or other undesirable consequences.

NOTE marks important information, e. g. dependencies of a function or requirements

thereof.

INFO marks additional information.

TIP marks information for the practical use of the software.

This symbol marks step-by-step instructions.

Copyright 2000–2013 Dassault Systèmes

CATIA, ENOVIA, Q-Checker are registered trademarks of Dassault Systèmes or its

subsidiaries in the US and/or other countries.

TABLE OF CONTENTS

DASSAULT SYSTEMES Q-PLM ENOVIA V6 + CT5 Release 5.1.0

3

Table of Contents

1 General 6

1.1 Documentation ............................................................................................................................ 6

1.2 Platforms ..................................................................................................................................... 6

1.3 Prerequisites ............................................................................................................................... 6

2 Q-PLM functional overview 7

2.1 General workflow with Q-PLM ..................................................................................................... 7

2.2 Q-PLM execution ........................................................................................................................ 7

2.2.1 Q-PLM BATCH CHECK ...................................................................................................... 7

2.2.2 Q-PLM Check In Trigger ................................................................................................. 8

2.2.3 PDM Save ....................................................................................................................... 9

2.2.4 Q-PLM Manual Launch (Q-PLM TOOLBAR) ..................................................................... 9

2.2.5 Change Maturity (Life Cycle Graph) .............................................................................11

2.3 Display Q-CHECKER / Q-PLM Results ........................................................................................12

3 Q-PLM Architecture 16

3.1 Architecture - Client /Server ......................................................................................................16

3.1.1 Simple Architecture .......................................................................................................16

3.1.2 Distributed Architecture.................................................................................................16

3.2 Module Overview ......................................................................................................................17

3.2.1 ENOVIA V6 Q-PLM Integration Module........................................................................18

3.2.2 Q-PLM Dispatcher ........................................................................................................18

3.2.3 Q-Checker .....................................................................................................................19

3.3 Integration module flow .............................................................................................................19

3.3.1 Q-PLM call from ENOVIA V6 Web Interface / Batch Check .........................................19

3.3.2 Q-PLM call with "PDM Save" ........................................................................................22

4 System Settings 24

4.1 Windows Settings ......................................................................................................................24

5 Installing Q-PLM Software 26

5.1 Copying Program Files ..............................................................................................................26

5.2 Central JRE Installation .............................................................................................................26

5.3 Central LUM CLIENT Installation ................................................................................................27

6 ENOVIA V6 CBP customization 28

6.1 General ......................................................................................................................................28

6.1.1 ENOVIA distribution and WAR depoyment...................................................................28

6.1.2 Model types ...................................................................................................................28

6.1.3 ENOVIA V6 Result Attributes ........................................................................................29

6.2 ENOVIA V6 Q-PLM Server Libs................................................................................................29

6.2.1 Q-PLM V6 Integration Libs ...........................................................................................30

TABLE OF CONTENTS


4

6.2.1.1 ENOVIA V6 Business + Matrix ......................................................................30

6.2.1.2 ENOVIA V6 Server ........................................................................................31

6.3 ENOVIA V6 Q-PLM Server Configuration Files ........................................................................32

6.3.1 Properties Files .............................................................................................................32

6.3.1.1 ENOVIA V6 Server ........................................................................................32

6.3.1.2 Adjust Properties Files ..................................................................................33

6.3.2 Integrations files ............................................................................................................36

6.3.2.1 ENOVIA V6 Server ........................................................................................36

6.3.2.2 Adjust Integrations files .................................................................................37

6.4 ENOVIA V6 Business ................................................................................................................39

6.4.1 ENOVIA DB modification via MQL / TCL Script ...........................................................39

6.4.2 Manual ENOVIA DB modification .................................................................................45

6.4.2.1 Attributes .......................................................................................................45

6.4.2.2 Format ...........................................................................................................54

6.4.2.3 Programs .......................................................................................................56

6.4.2.4 Web Form ......................................................................................................63

6.4.2.5 Table ..............................................................................................................72

6.4.2.6 Command ......................................................................................................82

6.4.2.7 Type ...............................................................................................................85

6.4.2.8 Policy .............................................................................................................88

6.4.2.9 Menu ..............................................................................................................90

6.4.2.10 Channel .........................................................................................................92

6.5 ENOVIA V6 Matrix .....................................................................................................................95

6.5.1 ENOVIA DB modification via MQL Script .....................................................................95

6.5.2 Manual ENOVIA DB modification .................................................................................95

6.5.2.1 Trigger ...........................................................................................................95

7 Installing Distributed Architecture 102

7.1 General ....................................................................................................................................102

7.2 ENOVIA V6 CBP and Q-Service Client ..................................................................................102

7.2.1 General .......................................................................................................................102

7.2.2 Q-Service Client Libs ..................................................................................................103

7.2.3 Q-Service Client Properties Files ................................................................................104

7.3 Satellite installation .................................................................................................................105

7.3.1 General .......................................................................................................................105

7.3.2 Q-Service Installation ..................................................................................................105

7.3.3 Q-PLM Installation ......................................................................................................107

7.3.4 Q-Checker / CATIA Installation ...................................................................................107

8 Client customization 108

8.1 General customization ............................................................................................................108

8.2 Q-PLM installation / customization ..........................................................................................108

8.2.1 Q-PLM installation .......................................................................................................108

8.2.2 Q-PLM configuration ...................................................................................................109

8.2.2.1 PDM Save script ..........................................................................................109

TABLE OF CONTENTS


5

8.2.2.2 Q-PLM Batch Check ....................................................................................109

8.2.2.3 Q-PLM_DSP.xml .........................................................................................110

8.3 Q-Checker / CATIA V5 ............................................................................................................111

8.3.1 CATIA Environment customization .............................................................................111

8.3.2 Configure Q-Checker for PDM Save ..........................................................................114

8.3.2.1 Q-Checker V2.x ...........................................................................................114

8.3.2.2 Q-Checker V5.x ...........................................................................................115

9 Legal Notices 117

GENERAL


6

1 General

1.1 Documentation

This documentation describes only the ENOVIA V6 CBP specific installation and

configuration.

For further information about Q-PLM refer to the documentation:

Q-PLM_Modules_3.x.pdf, general module architecture

Q-PLM_XML-DspReference_3.x.pdf, Dsp.xml file reference

Q-PLM_XML-Customization_3.x.pdf, Dsp.xml customization

Q-CHECKER documentation

Additional user documentation

1.2 Platforms

The Q-PLM Software can be installed on WINDOWS / UNIX systems.

1.3 Prerequisites

Java runtime min. 1.6:

Windows 2000/XP or Unix for Q-PLM ENOVIA V6 on Application Server

Any Q-Checker V5 release (min. 2.15.1 for PDM Save)

ENOVIA V6 release min. R2010x (Q-PLM release dependent)

Q-Checker / Q-PLM / ENOVIA V6 / CATIA V5 license

Q-PLM requires a LUM or DSLS license server, depending on the type of license key

you are using:

IBM LUM4 (License Use Management). The latest certified LUM license server is

LUM 4.6.8 Fix Pack 13.

DSLS (Dassault Systèmes License Server) V6R2013x or higher

Q-PLM FUNCTIONAL OVERVIEW


7

2 Q-PLM functional overview

2.1 General workflow with Q-PLM

Fig. 1: General workflow with Q-PLM

2.2 Q-PLM execution

2.2.1 Q-PLM BATCH CHECK

Q-PLM Batch Check is searching for CATIA Models in ENOVIA V6, with specific

input like start date, end date, and additional options. ENOVIA V6 Query is executed

on the ENOVIA V6 Database, it finds the related documents in ENOVIA V6 Database

and then starts the Q-PLM Process.

Maturity change to Release

Preliminary

Review

Approved

Q-PLM execution with

Q-Checker check run

Q-PLM Validation

Reject

Q-PLM Batch Check every night

on changed models

Checkin of CATIA models

Q-PLM Toolbar from web interface

PDM Save from Q-Checker

interactive

Q-PLM execution without

Q-Checker check run

Check of PDM attri-butes only

Q-PLM Result

OK

KO

Release



8

Fig. 2:: Q-PLM Night Batch Job Execution

The output of the TCAQPLMNightBatchJob.bat as follows

"C:\Program Files\Q-Checker\Q-PLM\bin\Command\TCAQPLMNightBatchJobCmd.bat"

"Test Everything" "passwd" "http://servername:8080/enovia" "09/09/2010

08:00:00 AM" "10/09/2010 12:00:00 AM"

2.2.2 Q-PLM Check In Trigger

The Q-PLM launch is triggered during the Check in process of CATIA Models (i.e.

MCAD Versioned Components, Assembly and Drawings) by the ENOVIA V6 Check

In trigger object, which will create the background jobs for each check in CAD models

and starts the Q-PLM Process.

Fig. 3: Q-PLM Background Jobs



9

2.2.3 PDM Save

After QCV5 interactive launch, the user is asked if the results should be stored in

ENOVIA V6. If the user confirms it with yes, the data will be stored in ENOVIA V6.

After the check in is performed, ENOVIA V6 will be updated with the results of the

interactive QCV5 execution, also updating the Q-PLM attribute and attaching the Q-

Checker HTML report.

Fig. 4: Q-PLM PDM Save

2.2.4 Q-PLM Manual Launch (Q-PLM TOOLBAR)

The Q-PLM launch is triggered by the “Perform Q-Checker Quality Check” Menu bar

from the ENOVIA V6 “Power view” for MCAD Versioned Components, Assembly and

Drawings.



10

Fig. 1: Q-PLM Interactive Manual Check for ENOVIA V6 Power view

The Q-PLM launch is triggered by the “Q-PLM Toolbar” from the ENOVIA V6

“Versions Table view” of MCAD Components, Assembly and Drawings

Fig. 5: Q-PLM Interactive from ENOVIA V6 Version Table view

There is no special profile selection configured. The standard Customer profile will be

used for each check.



11

Fig. 6: Q-Checker Profile Selection during Manual Check from Menu / Toolbar

2.2.5 Change Maturity (Life Cycle Graph)

The Q-PLM check trigger will block the Life Cycle promotion of MCAD Versioned

Components, Assembly, and Drawings. If the Quality Assessment of the model is not

“OK”,”In Order” or “Warning” , but these Assessment values can be customized later

as per customer specification



12

Fig. 7: Change Maturity Trigger Blocked the Promotion of the CAD Model

2.3 Display Q-CHECKER / Q-PLM Results

The Q-CHECKER / Q-PLM Results are displayed in the ENOVIA V6 view of the CAT

document.



13

Fig. 8: Q-Checker Attributes viewing in ENOVIA V6

In addition the Q-CHECKER HTML report can be attached to the CATIA document in

ENOVIA V6.

Fig. 9: Q-Checker Report Attachment view from power view



14

Standard CAT Version and Revision tables of the CAT document are enhanced with

a Q-PLM traffic light status.

Fig. 10: Q-PLM Interactive from ENOVIA V6 Version Table view

The “Engineering Bill of Materials” tables are enhanced with a Q-PLM traffic light.

The “Q-Checker Status” for this traffic light is taken from the corresponding CATIA

data of the related Specification.

Fig. 11: Q-PLM Interactive from ENOVIA V6 “Engineering Bill of Material” view



15

Fig. 12: Q-PLM Interactive from ENOVIA V6 “Specification” view

The Q-PLM attributes can be displayed in customized Table Views al well, like

Collection, Search window, etc.

Fig. 13: V6 Search Window, customized Table View with QC Assessment

Q-PLM ARCHITECTURE


16

3 Q-PLM Architecture

3.1 Architecture - Client /Server

3.1.1 Simple Architecture

The Q-PLM Integration is basically configured on “Server only“. This means all Q-

PLM modules are executed on the server machine. Q-PLM Integration, Q-PLM

Dispatcher and Q-Checker incl. CATIA is executed on the ENOVIA V6 Application

server.

Fig. 14: Simple Architecture: Centralized Database and File Server

3.1.2 Distributed Architecture

The Q-PLM Integration needs to be configured on ENOVIA V6 Application Server

and in ENOVIA V6 Filer Server (ENOVIA V6 “STORE”). This means some of the Q-

PLM modules Q-PLM Integration, Q-PLM Dispatcher is executed on the ENOVIA V6

Application server machine and in ENOVIA V6 File server Machine. Q-Checker incl.

CATIA will be executed on the ENOVIA V6 File server (or in a separate Q-Checker

machine), CAD Models will be copied out in to working directory in ENOVIA V6 file

server itself.

Q-PLM ARCHITECTURE


17

Fig. 15: Distributed Architecture: Distributed File Server

3.2 Module Overview

Q-PLM consists of the following main modules:

(1) ENOVIA V6 Q-PLM Integration

Server component

Integration DLL

Batch EXE

PDM Save

(2) Q-PLM Dispatcher

Q-PLM PDM

Q-PLM DSP

(3) Q-Checker V5 (separate product, mandatory for Q-PLM)

Q-PLM ARCHITECTURE


18

Fig. 16: Q-PLM shell model

3.2.1 ENOVIA V6 Q-PLM Integration Module

ENOVIA V6 Q-PLM Integration Module is the module which is integrated into ENOVIA

V6 and CATIA V5 client. This is responsible for functionalities like:

Display Q-PLM menu bar

Execute Q-PLM check from ENOVIA V6 Web Interface

Execute Q-PLM check from command line / cron job for e.g. Night Batch

Execute Q-PLM from Q-Checker interactive

Display Q-Checker Reports

Call Q-PLM Dispatcher

Set / reset ENOVIA V6 attributes

Store / remove Q-Checker Reports

…

3.2.2 Q-PLM Dispatcher

The Q-PLM Dispatcher module processes the requests from the ENOVIA V6

integration and calls Q-Checker and CATIA. It interprets Q-Checker results and

triggers the ENOVIA V6 update.

Q-PLM ARCHITECTURE


19

3.2.3 Q-Checker

Q-Checker is the tool checking CATIA V5 models. The Q-Checker version to be used

depends on the ENOVIA V6 system and user requirements. For more information

about Q-Checker please refer to the Q-Checker documentation.

With the PDM Save module of Q-PLM the Q-Checker check results can be stored

directly into ENOVIA V6.

3.3 Integration module flow

3.3.1 Q-PLM call from ENOVIA V6 Web Interface / Batch Check

General module flow for Simple Architecture, scope on the client and server

computer:

Fig. 17: Simple Architecture: Check on Application Server

Q-PLM ARCHITECTURE


20

General module flow for Distributed Architecture, scope on the client and server

computer:

Fig. 18: Distributed Architecture: Check on local File Server

Q-PLM ARCHITECTURE


21

General module flow, scope on Q-PLM base modules and files:

Fig. 19: Integration flow with direct CATIA PDM access to the model

ENOVIA V6 Q-PLM Server Integration

*Inf.xml

Tmp directory

Q-PLM

Dispatcher

CATIA / Q-CHECKER Batch

ENOVIA V6 Q-PLM Server Integration

Trace 1)

Tmp directory

Trace 1)

QC.in

Report directory

Reports

*Bat.xml

Tmp directory

Trace 1)

QC.out

2

2

3

3

ENOVIA V6

ENOVIA v6

set attributes attach QC-Reports

load CATIA model

Q-Monitor DB

CATIA file

model directory

read attributes

copyout model

1

1

4

4

Checkin / update model (if required)

1) Trace files are optional, the writing of the trace files can be disabled

Q-PLM ARCHITECTURE


22

3.3.2 Q-PLM call with "PDM Save"

General module flow for Simple Architecture and Distributed Architecture, scope on

the client and server computer:

Fig. 20: PDM Save

Q-PLM ARCHITECTURE


23

General module flow, scope on Q-PLM base modules and files:

Fig. 21: Integration workflow with “PDM Save”, Client workflow

ENOVIA V6 Q-PLM Client Integration

*Inf.xml

Tmp directory

Q-PLM Dispatcher

Trace 1)

Tmp directory

Trace 1)

Report directory

Reports

*Bat.xml

Tmp directory

Trace 1)

1

1

ENOVIA DB read attributes

CATIA / Q-CHECKER Interactive

Q-Monitor DB

PDM Save

ENOVIA V6 Checkin Dlg

ENOVIA V6 Q-PLM Client Integration

save model

CATIA file

2

2

1) Trace files are optional, the writing of the trace files can be disabled

*PDMSave.xml

Q-PLM ENOVIA V6 Update

3

3

4

4

ENOVIA DB

set attributes save model

SYSTEM SETTINGS


24

4 System Settings

4.1 Windows Settings

For some WINDOWS systems (e.g. WINDOWS 2003 Server, WINDOWS 64-bit), the

system setting “Data Execution Prevention” must have a specific value. Configure

this setting as follows. Otherwise Q-CHECKER cannot be run.

1. “Settings” > “System Properties” > “System” > “Advanced” tab

Fig. 1: “System Properties” – “Advanced” tab

SYSTEM SETTINGS


25

2. Performance > Settings > “Data Execution Prevention” tab

Fig. 2: “Performance Options” – “Data Execution Prevention” tab

INSTALLING Q-PLM SOFTWARE


26

5 Installing Q-PLM Software

Q-PLM software does not have an installer application. Only a copy of the Q-PLM

files into the desired installation directory is necessary. We recommend Central JRE,

i.e. to add JRE (Java Runtime Environment) to the Q-PLM directory.

5.1 Copying Program Files

Copy all Q-PLM files and directories into the desired installation directory.

Fig. 1: Q-PLM directory of a sample installation

5.2 Central JRE Installation

We recommend copying a valid JRE (Java Runtime Environment) into the Q-PLM

installation directory for use with Q-PLM. This will avoid problems with different Java

installations on client systems.

1. Copy the JRE directory into Q-PLM installation directory.

INSTALLING Q-PLM SOFTWARE


27

Fig. 2: Q-PLM directory of a sample installation with central JRE

2. To configure Q-PLM for this central JRE installation, refer to the Q-PLM_Dsp.xml

configuration manual.

5.3 Central LUM CLIENT Installation

The Q-PLM DISPATCHER module is checking the Q-PLM licenses. For this a LUM

CLIENT installation is needed. If LUM CLIENT is not installed, on all computers on

which the Q-PLM DISPATCHER module should be executed, a central LUM CLIENT can

be used.

1. Copy the LUM CLIENT directory into Q-PLM installation directory.

2. To configure Q-PLM for this central LUM CLIENT installation, refer to the

Q-PLM_Dsp.xml configuration manual.

ENOVIA V6 CBP CUSTOMIZATION


28

6 ENOVIA V6 CBP customization

6.1 General

6.1.1 ENOVIA distribution and WAR depoyment

The execution location of ENOVIA is a subdirectoy of Web Application directory of

the application server. This directory is recreated, overwritten if the ENOVIA war file

is depoyed to Tomcat.

Example:

C:\Enovia_Tomcat\webapps\enovia

The Stating directoy is the source directory of ENOVIA. The files of this derectory are

used for the ENOVIA War file creation.

Example:

C:\enoviaV6R2013x\server\STAGING

The Deployment directory is the location where the sources are copied for the WAR

file creation. This directory has the same file and directory structure as the Web

Application directory of ENOVIA. This directory is recreated when ENOVIA War Utility

is executed.

Example:

C:\enoviaV6R2013x\server\distrib

For more inforamtion please refer to the ENOVIA documentation.

6.1.2 Model types

The following model types are supported and can be checked:

MCAD Versioned Component

MCAD Versioned Assembly

MCAD Version Drawing.



29

6.1.3 ENOVIA V6 Result Attributes

The following attributes are customized in the ENOVIA V6 database on all desired

model types. Possible values are:

Attribute Possible values Description

TCAQCAssessment e.g.:

OK, In Order, KO, etc...

Q-PLM string result

QC Assessment

TCAQPLMResult

0

>0

<0

Q-PLM integer result

Check OK, Assessment OK

Check OK, Assessment NOT OK

System / Q-Checker / failure

TCAQCCheckTimeStamp Date Date / time when the check was

performed

TCAQCProfile Q-Checker Profile name Name of the Q-Checker profile which

was used for the last Q-Checker run

TCAQPLMActAction e.g.:

ManualMx

CheckInMx

DBTriggerMx

Q-PLM Check performed by

-Q-PLM Manual check (Menu /

Toolbar)

-Q-PLM Check In Trigger

-Q-PLM Night trigger batch

TCAQCCheckUser e.g. : Test Everything User who performed the quality check.

TCAQPLMComputerName ComputerName Computer name where the check was

performed

6.2 ENOVIA V6 Q-PLM Server Libs

Some files have to be copied to the ENOVIA V6 Server.

In case of Distributed Architecture, refer to chapter 7.2 “ENOVIA V6 CBP” in addition.

NOTE: WAR deployment and Web Server restart

After the all the installation steps are done the ENOVIA WAR deployment

has to be executed.

After the WAR deployment the Web Server (Apache Tomcat) has to be

restarted.



30

6.2.1 Q-PLM V6 Integration Libs

For Q-PLM there have to be some Java library files added to the ENOVIA V6 Server

installation. This is needed for the Q-PLM program execution.

6.2.1.1 ENOVIA V6 Business + Matrix

The following libraries have to be copied the EV6 Modelling Studio directory.

${EV6_INSTALL_DIR} is the root directory where ENOVIA V6 is installed.

Until EV6 2011:

${EV6_INSTALL_DIR}\ModelingStudio\java\lib

e.g.:

c:\enoviav6r2010x\ModelingStudio\java\lib

EV6 2011x and higher:

${EV6_INSTALL_DIR}\studio\{platform}\docs\custom

e.g.:

c:\enoviav6r2012x\studio\intel_a\docs\custom

NOTE: CLASSPATH

The CLASSPATH for ENOVIA V6 Business + Matrix is defined in the

enovia.ini file. With the variable:

MX_CLASSPATH=C:\Program Files\Java\jdk1.6.0_34\lib;…

The java libraries which should be used must be in a directory of this

MX_CLASSPATH. The directories above are the default directories; they

might be different in a customized installation.

It might be necessary to enhance the MX_CLASSPATH to some EVOVIA V6

server directories or copy some jar files from EVOVIA V6 server to a

directory of the MX_CLASSPATH. Otherwise some configurations /

adjustments like the compilation of JPO’s might fail.

Q-PLM Libraries:

Library Name Source directory

Q-PLM Base Libraries:

Q-PLM_DSP.5.1.0.jar $(QPLMPATH)\bin



31


LUMClient.jar e.g.:

c:\Q-Checker\Q-PLM_V5.1.0\bin

Q-PLM ENOVIA MX Libraries

Q-PLM_ENOVIA.5.1.0.jar $(QPLMPATH)\bin\EV6_CBPServer

e.g.:

c:\Q-Checker\Q-PLM_V5.1.0\bin\EV6_CBPServer

Q-PLM_ENOVIAUtil.5.1.0.jar

Q-PLM_ENOVIAV6PLUGIN2010X.5.1.0.jar

${QPLMPATH} is the directory to which the Q-PLM files where installed (copied).

6.2.1.2 ENOVIA V6 Server

The following libraries have to be copied into a defined subfolder of the EVOVIA V6

web service STAGING directory ${EV6_STAGING_DIR}

${EV6_STAGING_DIR}\WEB-INF\lib

e.g.:

c:\enoviav6r2012x\server\STAGING\ematrix\WEB-INF\lib

For the execution of the Q-PLM Process, we have to add the following library’s in to

ENOVIA V6.



Q-PLM_DSP.5.1.0.jar $(QPLMPATH)\bin

e.g.:

c:\Q-Checker\Q-PLM_V5.1.0\bin

LUMClient.jar

Q-PLM ENOVIA V6 Libraries

Q-PLM_ENOVIA.5.1.0.jar $(QPLMPATH)\bin\EV6_CBPServer

e.g.:

c:\Q-Checker\Q-PLM_V5.1.0\bin\EV6_CBPServer




NOTE: Distributed Architecture

In case of distributed architecture refer to 7.2.2 “Q-Service Client Libs” in

addition.



32

In case of Q-PLM PDM Save functionality the Q-Services have to be installed on the

machine where ENOVIA V6 CBP is running. This can be done either on the Apache

Tomcat ENOVIA V6 CBP or on a separate Apache Tomcat.

6.3 ENOVIA V6 Q-PLM Server Configuration Files

Some files have to be copied to the ENOVIA V6 Server.

NOTE: WAR deployment and Web Server restart

After the all the installation steps are done the ENOVIA WAR deployment

has to be executed.

After the WAR deployment the Web Server (Apache Tomcat) has to be

restarted.

6.3.1 Properties Files

New Q-PLM Properties file needs to be copied in to the ENOVIA V6 Installed

location, the properties file are mainly used for NLS Complaint, and to read Q-PLM

System properties.


The following libraries should be copied into a defined subfolder of the EVOVIA V6

Staging directory ${EV6_STAGING_DIR}

${EV6_STAGING_DIR}\properties

e.g.:

c:\enoviav6r2012x\server\STAGING\ematrix\properties

Properties Files

File Name Source directory

TCAQSCBase.properties $(QPLMPATH)\bin\EV6_CBPServer\

EV6CT5\setup\properties

e.g.: emxQPLMStringResource.properties

emxQPLM.Properties



33


emxSystem.properties

!!! Modify only !!!

c:\Q-Checker\Q-PLM_V5.1.0\bin\EV6_CBPServer\

EV6CT5\setup\properties

emxFrameworkStringResource.properties

!!! Modify only !!!

NOTE: Distributed Architecture

In case of distributed architecture refer to 7.2.3 “Q-Service Client Properties

Files” in addition.

6.3.1.2 Adjust Properties Files

The properties files for Q-PLM are in the following folder:

$(QPLMPATH)\bin\EV6_CBPServer\EV6CT5\setup\properties


NOTE

Statements which must be modified in the following files are highlighted in

blue.

emxSystem.properties

CAUTION: emxSystem.properties exists

emxSystem.properties is an existing properties file in ENOVIA V6, it is not

recommended to replace the existing file with the properties file from Source

directory.

The existing emxSystem.properties of the current ENOVIA V6 installation has

to be modified. The emxSystem.properties in the Q-PLM directory is only a

sample.

Add the additional Q-PLM entries:

…

eServiceSuites.DisplayedSuites = eServiceSuiteEngineeringCentral, \

…

eServiceSuiteServiceManagement, \



34

eServiceSuiteVPLMProductEditor, \

eServiceSuiteQPLM

…

emxFramework.ApplicationList = Common, \

…

ServiceManagement, \

VPLMProductEditor, \

QPLM

…

#

# TCA QPLM ENOVIA MatrixOne integration

#

eServiceSuiteQPLM.Directory = integrations/QPLM

eServiceSuiteQPLM.StringResourceFileId = emxQPLMStringResource

emxFramework.UISuite.QPLM = eServiceSuiteQPLM

eServiceSuiteQPLM.ApplicationPropertyFile = emxQPLM.properties

eServiceSuiteQPLM.PropertyFileAlias = emxQPLMproperties

emxFrameworkStringResource.properties

CAUTION: emxFrameworkStringResource.properties exists

emxFrameworkStringResource.properties is an existing properties file in

ENOVIA V6, it is not recommended to replace the existing file with the

properties file from Source directory.

The existing emxFrameworkStringResource.properties of the current

ENOVIA V6 installation has to be modified. The

emxFrameworkStringResource.properties in the Q-PLM directory is only a

sample.

Add the additional Q-PLM entries:

…

#

# TCA QPLM ENOVIA MatrixOne integration

#

emxFramework.Attribute.TCAQPLMPreSelProf = Q-PLM Profile Selection

emxFramework.Attribute.TCAQCProfile = Profile Name

emxFramework.Attribute.TCAQPLMActAction = Q-PLM Action

emxFramework.Attribute.TCAQPLMResult = Q-PLM Result

emxFramework.Attribute.TCAQCAssessment = Assessment

emxFramework.Attribute.TCAQCUser = Check User

emxFramework.Attribute.TCAQCCheckTimeStamp = Check Time



35

emxQPLM.properties

Customize the DspXmlFile, to the Q-PLM central configuration file (Q-PLM_Dsp.xml)

file which should be used. Full file name incl. Path is required.

###############################################################

# QPLM ENOVIA MatrixOne Integration Properties #

# emxQPLM.properties #

###############################################################

emxQPLM.DspXmlFile=C:/Q-Checker/QPLM_5.1.0/adm/Q-PLM_ENOVIA_MX_Dsp.xml

emxQPLM.Encoding=UTF-8

…

The icons which are shown for the Q-Checker Status can be set.

Fig. 22: Example of Q-Checker status icon customization

…

############################################################

# Change web form image icons to show status of Q-Checker #

############################################################

emxQPLM.QCIconBlack=../../integrations/QPLM/Images/TCAQPLM_BLACK.gif

emxQPLM.QCIconGreen=../integrations/QPLM/Images/TCAQPLM_GREEN.gif

emxQPLM.QCIconRed=../integrations/QPLM/Images/TCAQPLM_RED.gif

emxQPLM.QCIconWhite=../integrations/QPLM/Images/TCAQPLM_WHITE.gif



36

6.3.2 Integrations files


ATTENTION: WAR deployment

After ENOVIA WAR deployment, the Q-PLM Server Files which are copied to

the ENOVIA V6 distribution directory are lost. They have to be copied again.

NOTE: Web Server restart

After all Q-PLM Server Files are installed the Web Server (Apache Tomcat)

has to be restarted.

The following jsp files have to be copied into the EV6 Modelling Studio directory

Create this folder structure below, if it doesn’t exist.

The following libraries should be copied and or modified in the EVOVIA V6 stating

directory:

${EV6_STAGING_DIR}\integrations\QPLM

e.g.:

c:\enoviav6r2012x\server\STAGING\ematrix\integrations\QPLM

Integration Files


TCAQPLM_EV6CT5_HTMLDisplay.jsp $(QPLMPATH)\bin\EV6_CBPServer\setup\integrations\QPLM

e.g.:

c:\Q-Checker\Q-PLM_V5.1.0\bin\EV6_CBPServer\setup\

integrations\QPLM

TCAQPLMManualCheck.jsp

TCAQPLMManualCheckExcute.jsp

TCAQPLMManualCheckFooter.jsp

TCAQPLMManualCheckHeader.jsp

TCAQPLMManualCheckTopAction.jsp

TCAQPLM_EV6CT5_HelpAbout.jsp



37


*.gif

Several image files

$(QPLMPATH)\bin\EV6_CBPServer\setup\integrations\QPLM\

images

e.g.:


integrations\QPLM\images

Location of common ENOVIA integration files like emxHelpAbout.jsp

STAGING directory:

${EV6_STAGING_DIR} is the sub directory of the ENOVIA V6 server.

${EV6_STAGING_DIR}\common

e.g.:

c:\enoviav6r2012x\server\STAGING\ematrix\common


emxHelpAbout.jsp

!!! Modify only !!!

$(QPLMPATH)\bin\EV6_CBPServer\setup\integrations\QPLM

e.g.:


integrations\QPLM

6.3.2.2 Adjust Integrations files

New Q-PLM Integration file needs to be copied in to the ENOVIA V6 Installed

location, the properties file are mainly used for NLS Complaint, and to read Q-PLM

System properties.

The properties files for Q-PLM are in the following folder:

${QPLMPATH}\bin\EV6_CBPServer\setup\integrations




38

NOTE

Statements which must be modified in the following files are highlighted in

blue.

emxHelpAbout.jsp

CAUTION: emxHelpAbout.jsp exists

emxHelpAbout.jsp is an existing properties file in ENOVIA V6, it is not

recommended to replace the existing file with the properties file from Source

directory.

The existing emxHelpAbout.jsp of the current ENOVIA V6 installation has to

be modified. The emxHelpAbout.jsp in the Q-PLM directory is only a sample.

…

}else{%>

<TR>

<TD class="inputField">

<emxUtil:i18n localize="i18nId">

emxFramework.AdvancedHelp.NoConversionsRun

</emxUtil:i18n>

</TD>

</TR>

<%}%>

</TABLE> 

<%}%>





<%if(filterValue.equalsIgnoreCase("ProductVersion") ||

filterValue.equalsIgnoreCase("All")){%>

<%@include file = "../../integrations/QPLM/

TCAQPLM_EV6CT5_HelpAbout.jsp"%>



</FORM>

</BODY>

</HTML>



39

6.4 ENOVIA V6 Business

6.4.1 ENOVIA DB modification via MQL / TCL Script

ATTENTION: Customization with TCL Script

The customization via launching the TCL script is only recommended for

ENOVIA V6 installations which are not already fully customized. The TCL

script is using the ENOVIA V6 standard objects, names, and settings.

If the ENOVIA V6 installation is already customized, the TCL script has to be

modified and adapted to the customer installation.

NOTE

The following steps have to be done before otherwise the script may fail:

6.2 ENOVIA V6 Q-PLM Server Libs

6.3 ENOVIA V6 Q-PLM Server Configuration Files

The creation / setting of the attributes, programs, commands, format, triggers,

modification on policy, modification of web form, modification of Type etc have to be

performed in V6 application server using MQL interface with the mql script, provided

with Q-PLM.

NOTE

The script execution might take some time.

Especially adding Q-PLM MCAD attributes can be time consuming. Because

each and every related MCAD object will be modified by adding the attribute.



40

MQL Scripts and files for business objects creation

File Description Source directory

Q-PLM_InstallScript.tcl TCL script for database

modification

For Windows:

$(QPLMPATH)\bin\EV6_CBPServer\

EV6CT5\setup\${EV6_VERSION}\scripts\

Windows

e.g.:

c:\Q-Checker\Q-PLM_V5.1.0\bin\

EV6_CBPServer\EV6CT5\setup\

EV62012x\scripts\Windows

For Unix :

$(QPLMPATH)/bin/EV6_CBPServer/

EV6CT5/setup/${EV6_VERSION}/scripts/

Unix

e.g.:

/Q-Checker/Q-PLM_V5.1.0/bin/

EV6_CBPServer/EV6CT5/setup/

EV62012x/scripts/Unix

${QPLMPATH} is the directory to which the Q-PLM files where copied.

Steps: Modify scripts, files and launch the TCL script

1. Open the scripts in a suitable Text editor

2. Adjust the following lines in the script file Q-PLM_InstallScript.mql due to

your installation / settings.

NOTE

In this section, statements which must be modified are highlighted in blue.

a) Set jpofilepath:

Set the variable jpofilepath

b) Set context user:

set context user "creator";

#set context user "creator" passwd "";

verbose on;

start transaction;

…

c) Adjust attribute names and additional settings:

Make all the necessary modification due to your environment



41

…

set jpoFilePath "C:/Program Files/Q-Checker/Q-PLM_EV6CT5_5.1.1/bin/

EV6_CBPServer/EV6CT5/setup/JPOsrc"

#####################################################################

###########

# set checkinCheckEnable

# set if eighter the system should be configured for Q-Checker run

during checkin or not

# checkinCheckEnable: 0 -> no Q-Checker run during checkin operation,

in this case the existing Q-PLM atrributes will be reset to NOT

CHECKED

# checkinCheckEnable: 1 -> Q-Checker run during checkin operation

# default value = 0

set checkinCheckEnable 0

#####################################################################

###########

# set ENCIntegartionEnable

# set if the Engeneering Central should be configuted for Q-PLM or

not

# ENCIntegartionEnable: 0 -> Q-PLM will NOT be configured for

Engeneering Central

# ENCIntegartionEnable: 1 -> Q-PLM will be configured for Engeneering

Central

# default value = 1

set ENCIntegartionEnable 1

#####################################################################

###########

# set attribute names

# set empty string for the once which are not needed

set TCAQCAssessment "TCAQCAssessment"

set TCAQCCheckTimeStamp "TCAQCCheckTimeStamp"

set TCAQPLMResult "TCAQPLMResult"

set TCAQCCheckUser "TCAQCCheckUser"

set TCAQCProfile "TCAQCProfile"

set TCAQPLMActAction "TCAQPLMActAction"

set TCAQPLMComputerName "TCAQPLMComputerName"

set TCAQPLMAdminRelease "TCAQPLMAdminRelease"

set TCAQPLMPreSelProf "TCAQPLMPreSelProf"

set ListTCAQPLMPreSelProf [list "Default Profile" "Profile Supplier

A" "Profile Supplier B"]

#set ListReportFormat [list QC-DB QC-HTML QC-Report QC-TXT QC-XML]

set ListReportFormat [list QC-HTML]

set ReportPolicyDesign "CATIA V5 Design Policy"

set ReportPolicyVersionedDesign "Versioned CATIA V5 Design Policy"



42

#####################################################################

###########

# set MCAD types

# set empty string for the once which are not needed

set MCADVersionedComponentType "MCAD Versioned Component"

set MCADVersionedAssemblyType "MCAD Versioned Assembly"

set MCADVersionedDrawingType "MCAD Versioned Drawing"

set MCADComponentType "MCAD Component"

set MCADAssemblyType "MCAD Assembly"

set MCADDrawingType "MCAD Drawing"

#####################################################################

###########

# set trigger options for maturity change

set MaturityPolicy "CATIA V5 Design Policy"

#set MaturityPolicy "Design Policy"

set MaturityFromState "Approved"

…

d) Default Profile setting (optional)

Alias for default Q-Checker profiles are set in the TCL script.

This is only an alias for the Q-Checker profile not the real name of it. But this

can be adjusted.

Example:

Replace the string “Default Profile” with the desired sting e.g. “Company Name

Standard”.

…

set TCAQPLMPreSelProf "TCAQPLMPreSelProf"

set ListTCAQPLMPreSelProf [list "Default Profile" "Profile Supplier

A" "Profile Supplier B"]



43

…

This new defined alias for the Q-Checker profile must be configured as a

ProfileData node in Q-PLM_DSP.xml. Please refer to the related

documentation.

Refer to chapter 6.4.2.1.1 “MCAD Attributes” section “Set Ranges for

TCAQPLMPreSelProf” in addition.

3. Check if all settings in the TCL script and in the other files which are used by this

script are matching to your ENOVIA V6 installation.

It is highly recommended to check the TCL Script before launching it.

The TCL Script must be read and understand. The changes this TCL script makes

in the ENOVIA V6 system has to be checked before launching it. If the customer

has some additional customization in the ENOVIA V6 system, for the objects which

will be modified through this TCL Script, it is recommended to modify the TCL script

and make it fit enough to work without affecting their existing customization.

4. Run MQL Command:

run “$(QPLMPATH)\bin\EV6_CBPServer\setup\EV6CT5\EV62012x\scripts\

\Q-PLM_InstallScript.tcl”;



44

Fig. 23: MQL Interface

5. Check if any error occurs during the script execution.

The script was successfully executed it ends with the following two messages:

Fig. 24: MQL Interface, script successfully launched



45

If an error happens, the script execution will be aborted.

The ENOVIA objects will not be created when the script aborts.

If the script terminates with a failure carry on with following steps:

a. close the MQL window

b. correct the error in the script

c. launch the MQL window once more

d. rerun the modified MQL script again

6. Check if the objects which are described in the following chapter are created

correctly and visible in ENOVIA V6 Business and Matrix.

7. Restart ENOVIA V6 Web Service if necessary.

6.4.2 Manual ENOVIA DB modification

6.4.2.1 Attributes

6.4.2.1.1 MCAD Attributes

NOTE

Adding the Q-PLM MCAD Component attributes can be time consuming.

Because each and every existing related MCAD object will be modified by

adding the attribute.

The following attributes are added to the ENOVIA V6 Business and assigned to the

Types which are mentioned below.

Attributes

Name type Default value

TCAQCAssessment string Not Checked

TCAQCCheckTimeStamp date\time

TCAQCProfile string

TCAQPLMActAction string

TCAQPLMResult integer 1000

TCAQCCheckUser string



46


TCAQPLMPreSelProf string Default Profile

This default value might be different due to the

company need.

Refer to section “Set Ranges for

TCAQPLMPreSelProf” below.

TCAQPLMComputerName string

Reset attributes:

We recommend to configure the attributes with “Reset On”

- Clone

- Revision

In general the derived data model instances of the following ENOVIA V6 instances

have to be customized:

Types

CATIA Model Types Related MX Types for Q-PLM Attributes

CATIA Parts MCAD Versioned Component

MCAD Component

CATIA Assembly / Products MCAD Versioned Assembly

MCAD Assembly

CATIA Drawings MCAD Versioned Drawing

MCAD Drawing

Following are the steps to create the attributes in ENOVIA Business without using

MQL script

Steps: Create Attribute

1. Open the ENOVIA Business Modeler

Start -> Programs -> “ENOVIA Platform Modeling Studio” -> “Business”



47

2. Object -> New -> Attribute …

3. Enter the necessary fields

Refer to the table “Attributes”

above

a) Name

b) Description

c) Type

d) Default

e) Select “Reset On”

- Clone

- Revision

4. Confirm with “Create”

Fig. 25: EV6 New Attribute Dialog (CATIA attribute)

5. Repeat step 2 – 4 for all

Q-PLM Attributes which

should be created.

Fig. 26: EV6 Business, all CATIA Q-PLM Attributes

6. Search for the Types to

which the Q-PLM CATIA

Attributes should be added.

Refer to table “Types” above

7. Open the Type for Edit

Fig. 27: EV6 Business, CATIA Types



48

8. Choose tab “Attributes”

9. Press “Add” button

Fig. 28: EV6 Business, Edit Type, Attribute tab (CATIA)

10. Search for Q-PLM CATIA

attributes and add them


Q-PLM CATIA Attributes

which should be added

12. Confirm the “Edit Type” Dialog

with “Edit”

Fig. 29: EV6 Business, Attribute Chooser (CATIA)

13. Repeat step 7 – 12 for all types to which the Q-PLM CATIA Attributes should be

attached.

Set Ranges for TCAQPLMPreSelProf

The default value of TCAQPLMPreSelProf sets the default Q-Checker profile with

which the Q-Checker execution will be performed. This is only an alias for the Q-

Checker profile not the real name of the Q-Checker Profile.

Example, “Company Name Standard” is used as default value of

TCAQPLMPreSelProf. This will occur in the ENOVIA V6, “Q-Checker Manual

Execution” dialog as the default value:



49

In addition ranges can be set for TCAQPLMPreSelProf. This enables the selection

of different Q-Checker Profiles for the check execution.

Example, two available profiles “Default Profile” and “Company Standard”:

NOTE

All defined alias for the Q-Checker Profiles must be configured as a

ProfileData node in Q-PLM_DSP.xml. Please refer to the related

documentation.

Steps: Add Ranges to TCAQPLMPreSelProf



50



2. Search for the attribute

TCAQPLMPreSelProf

3. Open the Attribute for Edit

Fig. 30: EV6 Business, Attribute TCAQPLMPreSelProf

4. Choose tab “Ranges”


Fig. 31: EV6 Business, Attribute Ranges

6. Select “Equal”

7. Enter the name of the alias for

the Q-Checker Profile

The string for the default

profile should be added as

well.

Hint: The alias has to be

configured in

Q-PLM_DSP.xml in addition

8. Confirm with “OK” button

Fig. 32: EV6 Business, Add Ranges



51


desired Q-Checker Profiles

10. Confirm with “Edit” button

Fig. 33: EV6 Business, Attribute Ranges samples

6.4.2.1.2 Job Attributes

The following attributes are added to the ENOVIA V6 Business and assigned to the

Types which are mentioned below.

Attributes


TCAQPLMJobAdmin String

Types

Type

Job

Following are the steps to create the attributes in ENOVIA Business without using

MQL script

Steps: Create Attribute





52

2. Object -> New -> Attribute …


Refer to the table “Attributes”

above

a) Name

b) Description

c) Type

d) Default

e) Set the “Hidden” checkbox


Fig. 34: EV6 New Attribute Dialog (Job attribute)

5. Search for the Types to which the Q-PLM Attributes should be added.

Refer to table “Types” above

6. Open the Type for Edit

7. Choose tab “Attributes”


9. Search for Q-PLM Job

attribute and add it

10. Confirm the “Edit Type” Dialog

with “Edit”

Fig. 35: EV6 Business, Edit Type, Attribute tab (Job)

6.4.2.1.3 Register attribute property and symbolic name

The attributes must be registered. This can either be done by a MQL command or with the Web Client.



53

Example of MQL command:

add property attribute_TCAQCAssessment on program

"eServiceSchemaVariableMapping.tcl" to attribute TCAQCAssessment;

Example registration via Web Client:

1. Choose: Tools -> Property Registration -> Admin Type ...

Fig. 36: EV6 Web Client, Tools -> Property Registration -> Admin Type ...



54

2. Register Attribute

Fig. 37: EV6 Web Client, Admin Type Property Registration

6.4.2.2 Format

A new format (QC-HTML) is added to the ENOVIA V6 for the Q-Checker Report

Attachment, and the format attached to policy

Formats

Name

QC-HTML

Policy

Until ENOVIA V6 2009x:

Name

Versioned Design Policy

Design Policy

ENOVIA 2010 and higher:



55

Name

Versioned CATIA V5 Design Policy

CATIA V5 Design Policy

Following are the steps to create the format in ENOVIA Business without using MQL

script

Steps: Create Format



2. Object -> New -> Format …


Refer to the table above

a) Name


Fig. 38: EV6 New Format Dialog

Fig. 39: EV6 Business QC-HTML Format



56

5. Search the Policy to which the

formats should be added.

Refer to table “Policy” above

6. Open Policy for Edit

Fig. 40: EV6 Business “Versioned Design Policy”

7. Choose tab “Allowed

Formats”

8. Attach the “QC-HTML” Format

with “Add”

9. Confirm with “Edit”

Fig. 41: EV6 Policy Dialog – Allowed Format

10. Repeat step 6 – 9 for all Policy for which the Format should be added

6.4.2.3 Programs

New JPO program objects are added to the ENOVIA V6 for Q-PLM execution. The

following programs are used during the Check in of CATIA models, Manual Check

using Q-PLM Menu /Toolbar, and during Night Batch Job.

Programs

Name Program file Purpose

TCAQPLM_Batch TCAQPLM_Batch.java Executes the Q-PLM Process

TCAQPLM_Update TCAQPLM_Update.java Updates the Q.PLM Attributes

and attach report in ENOVIA V6

TCAQPLM_BatchJob TCAQPLM_BatchJob.java Creates the background jobs in

ENOVIA V6 during Check In

Process



57

Name Program file Purpose

TCAQPLM_UpdateBatchJob TCAQPLM_UpdateBatchJob.java Updates the background jobs in

ENOVIA V6 during Check In

Process

TCAQPLM_MaturityChange TCAQPLM_MaturityChange.java Checks the Quality of model

during the Life Cycle Graph

promotion

TCAQPLM_ShowQChecker

Status

TCAQPLM_ShowQCheckerStatus

.java

Displays the Q-PLM Status traffic

light in ENOVIA V6 Web

Interface

TCAQPLM_SubComponent

Report

TCAQPLM_SubComponentReport

.java

For Q-PLM Interactive manual

check (Menu / Toolbar) dialog

TCAQPLM_MXReset

Attributes

TCAQPLM_MXResetAttributes

.java

Reset Q-PLM attribute in

EONVIA V6

6.4.2.3.1 Create Q-PLM JPO Programs

Following are the steps to create the Programs in ENOVIA Business without using

MQL script

Steps: Create programs



2. Object -> New -> Program …

3. Choose “Basic” tab


Refer to the table above

a) Name

5. Choose “Type Java”

6. Choose “Execute Immediate”

for following programs:

a) TCAQPLM_Batch

b) TCAQPLM_Update

c) TCAQPLM_UpdateBatch

Job

Fig. 42: EV6 Business New Program, Basic tab



58

d) TCAQPLM_Maturity

Change

e) TCAQPLM_Show

QCheckerStatus

f) TCAQPLM_SubComponent

Report

g) TCAQPLM_MXReset

Attributes

Choose “Execute Deferred”

for following programs:

a) TCAQPLM_BatchJob

7. Choose “Code” tab

8. Copy the Java Program from

the source directory and paste

it in the code window.

9. Modify JPO if necessary

Refer to chapter:

6.4.2.3.2 Q-PLM JPO

Modification


Fig. 43: EV6 Business New Program, Code tab



59

11. Repeat step 2 – 7 for all Q

PLM JPO Programs which

should be created.

Fig. 44: EV6 all Q-PLM Programs

6.4.2.3.2 Q-PLM JPO Modification

Getting Server URL

NOTE

Modification for Apache Tomcat only!

Getting server URL from application server. Might be useful in case of Application

Server Load Balancing or similar.

JPO Programs for modification:

TCAQPLM_Batch

TCAQPLM_MaturityChange

The modifications for Tomcat 5.5 and 6.0 are different. The class

Http11NioProtocol exists only for Tomcat 6.0 or higher.

For enabling server URL from application server comment out must be removed for

following sections, example for Tomcat 5.5:

…



60

import org.apache.catalina.Server;

import org.apache.catalina.ServerFactory;

import org.apache.catalina.Service;

import org.apache.catalina.connector.Connector;

import org.apache.coyote.ProtocolHandler;

import org.apache.coyote.http11.Http11Protocol;

import org.apache.coyote.http11.Http11AprProtocol;

/* Tomcat 6.0 or higher

import org.apache.coyote.http11.Http11NioProtocol;

*/

…

String sServerURL = "";

// start - get the Server URL

String sHostname = InetAddress.getLocalHost().getHostName();

int serverPort = 8080;

String sContextPath = "/enovia";

Server server = ServerFactory.getServer();

Service[] services = server.findServices();

for (Service service : services)

{

for (Connector connector : service.findConnectors())

{

ProtocolHandler protocolHandler =

connector.getProtocolHandler();

// Tomcat 5.5

if (protocolHandler instanceof Http11Protocol

|| protocolHandler instanceof Http11AprProtocol)

/* Tomcat 6.0 or higher

/*

if (protocolHandler instanceof Http11Protocol

|| protocolHandler instanceof Http11AprProtocol

|| protocolHandler instanceof Http11NioProtocol)

*/

{

serverPort = connector.getPort();

}

*/

}

}

sServerURL = "http://" + sHostname + ":" + serverPort +

sContextPath;

qplm.traceInfo("execQPLMBatch.jpo", "ServerURL",sServerURL);

// end - get the Server URL

…

Additional import for Tomcat 6.0 or higher

Import for Tomcat 5.5 or higher

Additional functionality for Tomcat 5.5 or higher

Tomcat 6.0 or higher



61

NOTE

MX_CLASSPATH must be extended with the directory of catalina.jar when

server URL from application server is enabled, refer below.

catalina.jar file:

Directory until Tomcat 6:

${TOMCAT_INSTALL_DIR}\server\lib\catalina.jar

e.g.:

C:\Program Files (x86)\Apache Software Foundation\

Tomcat 5.5\server\lib\catalina.jar

Tomcat 6 and higher:

${TOMCAT_INSTALL_DIR}\lib\catalina.jar

e.g.:

C:\Program Files (x86)\Apache Software Foundation\

Tomcat 6.0\lib\catalina.jar

The MX_CLASSPATH must be enhanced in the following file:

EV6 2011x and higher:

${EV6_INSTALL_DIR}\studio\{platform}\code\bin\enovia.ini

e.g.:

c:\enoviav6r2012x\studio\intel_a\code\bin\enovia.ini

…

MX_JAVA_OPTIONS=-Xmx128m

user=creator

MX_CLASSPATH=C:\enoviaV6R2011x\server\distrib\enovia\WEB-INF\lib;

C:\Program Files\Java\jdk1.6.0_21\lib;C:\enoviaV6R2011x\studio\managed\

properties;C:\enoviaV6R2011x\server\distrib\enovia\WEB-INF\classes;

C:\enoviaV6R2011x\studio\win_b64\docs\javacommon;C:\enoviaV6R2011x\studio\w

in_b64\docs\javaserver;C:\enoviaV6R2011x\studio\win_b64\docs\custom;

C:\Program Files (x86)\Apache Software Foundation\Tomcat 5.5\lib

…

6.4.2.3.3 Compile Q-PLM JPO Programs

Steps: Compile programs



62

1. The Q-PLM Server Files have to be copied before the JPO programs can be

compiled. Refer to chapter 6.2 ENOVIA V6 Q-PLM Server Libs.



3. Search and open the created

Q PLM JPO Programs for edit

4. Press the “Compile” button

5. Ensure that the program is

compiled without errors.


Fig. 45: EV6 Business New Program, Code tab for

compile

Fig. 46: EV6 Business compilation succeeded



63

7. Repeat step 3 – 6 for all Q

PLM JPO Programs.

Fig. 47: EV6 all Q-PLM Programs


After compiling all programs the Web Server (Apache Tomcat) has to be

restarted.

6.4.2.4 Web Form

To display the Q-PLM attributes in the ENOVIA V6 web client, the existing web forms

have to be modified. By default MQL Script takes the backup of the default MCAD

web forms and rename it with a suffix (*_orig). If web forms are modified manual, we

recommend you to take the backup of the existing web forms before modifying it.

Web From

Name Purpose

type_MCADComponent for CATIA Parts

type_MCADAssembly for CATIA Assembly / Products

type_MCADDrawing for CATIA Drawings

Web Forms for modification and backup copy:



64

Fig. 48: Web forms for modification



65

Customized Web Form:

Fig. 49: Web Form displayed in ENOVIA V6 with Q-PLM enhancements

Steps: Customize Web Form



2. Search the desired Web Form and open it for edit

3. Add all Q-PLM Elements.

Refer to the example pictures below. The values for the additional Web Form

elements can be taken out of the MQL script of Q-PLM installation.



66

Fig. 50: Web form of type_MCADComponent with additional Q-PLM attributes

Fig. 51: Web form Field – Expression for QCheckerStatus



67

Fig. 52: Web form Field – Settings for QCheckerStatus

Example of MQL script.

Settings for QCheckerStatus from Web form of type_MCADComponent. These

settings correspond to the pictures above:

…

# type_MCADComponent

mod form type_MCADComponent web

field select ''

label "emxQPLM.Information"

setting Editable false

setting "Field Type" "programHTMLOutput"

setting "Registered Suite" "QPLM"

setting function getStatusIconWebform

setting program TCAQPLM_ShowQCheckerStatus;


field select $<attribute[attribute_TCAQPLMPreSelProf]>

label emxQPLM.TCAQPLMPreSelProf

setting "Access Expression" 'type ~~ "*CAT*"'

setting Editable true

setting "Field Type" attribute

setting "Input Type" "combobox"

setting "Registered Suite" "QPLM";


field select $<attribute[attribute_TCAQCAssessment]>

label emxQPLM.TCAQCAssessment





68




field select $<attribute[attribute_TCAQCProfile]>

label emxQPLM.TCAQCProfile





…

4. After all fields are attached confirm with “Edit”

5. Repeat the steps for all Web Forms

Create Web Form for Q-PLM details:

Fig. 53: Web Form displayed in ENOVIA V6 with Q-PLM details

Table for Webform settings.

Column Command tab Name type

1 Expression Applies to: set checkbox “Business Object“

Label emxQPLM.Information

Settings Editable false

Field Type programHTMLOutput



69


Registered Suite QPLM

function getStatusIcon

program TCAQPLM_ShowQCheckerStatus

2 Expression Expression $<attribute[attribute_TCAQPLMPreSelProf]>

Applies to: set checkbox “Business Object“

Label emxQPLM.TCAQPLMPreSelProf

Settings Access Expression type ~~ "*CAT*"

Editable true

Field Type attribute

Input Type Combobox


3 Expression Expression $<attribute[attribute_TCAQPLMAdminRelease

].value>]>


Label emxQPLM.TCAQPLMAdminRelease


Editable true



4 Expression Expression $<attribute[attribute_TCAQCAssessment].valu

e>]>


Label emxQPLM.TCAQCAssessment


Editable false



5 Expression Expression $<attribute[attribute_TCAQCProfile].value>]>


Label emxQPLM.TCAQCProfile




70


Editable false



6 Expression Expression $<attribute[attribute_TCAQCCheckTimeStamp

].value>]>


Label emxQPLM.TCAQCCheckTimeStamp


Editable false



7 Expression Expression $<attribute[attribute_TCAQCCheckUser].value

>]>


Label emxQPLM.TCAQCCheckUser


Editable False



8 Expression Expression $<attribute[attribute_TCAQPLMResult].value>]

>


Label emxQPLM.TCAQPLMResult


Editable false



9 Expression Expression $<attribute[attribute_TCAQPLMComputerNam

e].value>]>


Label emxQPLM.TCAQPLMComputerName




71


Editable false



Steps: Customize Web Form



2. Object -> New -> Web Form …

3. Add all Q-PLM Elements.

Refer to the example pictures below. The values for the additional Web Form

elements are in the table above.

Fig. 54: Web form Field – Settings for Q-PLM details

4. Confirm with create.



72

Fig. 55: New QPLMInfo Web Form

6.4.2.5 Table

6.4.2.5.1 ENOVIA V6 tables modification

To display the Q-PLM customisations in the ENOVIA V6 tables like “CAT Part

Versions” and “CAT Part Revisions”, the existing tables have to be modified. By

default MQL Script takes the backup of the default tables and rename it with a suffix

(* _orig). If tables are modified manual, we recommend you to take the backup of the

existing web forms before modifying it.

Table

Name Purpose

DSCVersions Versioned Part table

IEFRevisions Revision table

ENCEBOMIndentedSummary Engineering Central BOM Power View table

APPDocumentSummary Document summary table

Tables for modification and backup copy:



73

Fig. 56: Tables

Customized Table:

Fig. 57: CATPart Version table displayed in ENOVIA V6 with Q-PLM enhancements



74

Fig. 58: EBOM displayed in ENOVIA V6 with Q-PLM enhancements

Settings for DSCVersions, IEFRevisions


8 Basics Name QCheckerStatus

Expression Heading emxQPLM.QCheckerStatusShortName

Settings Column Type programHTMLOutput




Width 25

11 Basics Name QPLMToolbar

Expression Heading (unset checkbox “Custom Heading”)

Link Href ${COMMON_DIR}/emxIndentedTable.jsp?tabl

e=TCAQPLM_SubComponentReport&expand

Program=TCAQPLM_SubComponentReport:g

etRelatedChildItems&postProcessJPO=TCAQ

PLM_SubComponentReport:setQCProfile&he

ader=emxQPLM.QualityCheck&subHeader=e

mxQPLM.ManualTitle&selection=multiple&edit

Link=true&multiColumnSort=false&objectCom

pare=false&showClipboard=false&HelpMarker

=false&cancelLabel=emxFramework.Button.C

ancel&submitURL=${SUITE_DIR}/TCAQPLM

ManualCheckTopAction.jsp&findMxLink=false

&showPageURLIcon=false&expandMultiLevel

sJPO=true



75


Settings Registered Suite QPLM

Column Type icon

Column Icon ${SUITE_DIR}/images/

TCAQPlmManualCheck.gif

Popup Size MediumQPLM

Width 25

Settings for ENCEBOMIndentedSummary



Expression Heading emxQPLM.QCheckerStatusShortName

Settings Access Expression $<from[relationship_PartSpecification].to.

type ~~ *CAT*

Column Type programHTMLOutput


Sortable false



Width 25

Steps: Edit Tables





76

2. Search the desired Table

Object -> Find …

Refer to table “Table” above

Fig. 59: EV6 Business Find “Table”

3. Open the t for edit

Fig. 60: EV6 Business Table, Open for Edit

Fig. 61: EV6 Edit – Table DSCVersions

4. Press “Add” button and add all properties, described in the tables above



77

5. Choose “Basics” tab

Enter the necessary fields

Refer to the tables above,

Command tab “Basics”

a) Name

Fig. 62: EV6 Business Table Add, Basics tab

6. Choose “Link” tab



Command tab “Expression”

a) Heading

Fig. 63: EV6 Business Table Add, Expression tab

7. Choose “Settings” tab



Command tab “Expression”

a) Column Type

b) …

Fig. 64: EV6 Business Table Add, Settings tab

8. Repeat steps 4 – 7 for all Table columns

9. Confirm table modification with “Edit”



78

10. Repeat steps 3 – 9 for all Tables

6.4.2.5.2 New Q-PLM tables

New tables are added in ENOVIA V6 Business for display Q-PLM Interactive manual

check dialog.

Table

Name

TCAQPLM_SubComponentReport

Settings for TCAQPLM_SubComponentReport


1 Basics Name name

Expression Expression name

Applies to Business Objects

Custom Heading checked

Heading emxIEFDesignCenter.Common.Name

Link Href ${SUITE_DIR}/

emxInfoManagedMenuEmxTree.jsp?

mode=insert

Settings Freeze Pane true

Registered Suite DesignerCentral

Show Type Icon true

Target Location Popup

Access User [All]

2 Basics Name type

Expression Expression type



Heading emxIEFDesignCenter.Common.Type

Settings Registered Suite DesignerCentral

Access User [All]

3 Basics Name Rev

Expression Expression revision



79




Heading emxIEFDesignCenter.Common.Revision

Settings Registered Suite DesignerCentral

Access User [All]


Expression Applies to Business Objects


Heading emxQPLM.QCheckerStatusShortName

Settings Column Type programHTMLOutput


Sortable false



Access User [All]

5 Basics Name QCProfileSelection

Expression Expression $<attribute[attribute_TCAQPLMPreSelProf].

value>



Heading emxQPLM.SelectProfile

Settings Editable true


Input Type combobox


Remove Range

Blank

true

Access User [All]

6 Basics Name QCAssessmentVersionedComponent

Expression Expression $<attribute[attribute_TCAQCAssessment].

value>




80



Heading emxQPLM.Assessment

Settings Access Expression $<attribute[attribute_MoveFilesToVersion].

value> == False && type ~~ "*CAT*"


Editable false


Access User [All]

7 Basics Name QCAssessmentNonVersionedComponent

Expression Expression $<from[relationship_ActiveVersion].to.attribute

[attribute_TCAQCAssessment].value>



Heading emxQPLM.Assessment

Settings Access Expression $<attribute[attribute_MoveFilesToVersion].

value> == True && type ~~ "*CAT*"

Editable false

Input Type attribute


Access User [All]

Steps: Create Tables



2. Object -> New -> Table …



81

3. Create new table column with

“Add”

Fig. 65: EV6 Business “New Table”

4. Enter all necessary fields in

the all needed tabs.

Refer to settings table above.

5. Confirm with “OK”


needed columns.

Fig. 66: EV6 Business “Add Column”

7. Confirm “New Table” dialog

with “Create”.

Fig. 67: EV6 Business “New Table”, adding columns finished



82

Fig. 68: EV6 Business new created tables

6.4.2.6 Command

New commands are added in ENOVIA V6 Business for display of Q-Checker Report

files and to perform Q-PLM Interactive manual check (Menu / Toolbar)

Commands

Name Purpose

TCAQPLMHTMLDisplay To display the Q-Checker Report file in ENOVIA V6 web

(thin) client

TCAQPLMManualCheckTopAction Q-PLM Interactive Manual check from the Menu / Toolbar.

TCAQPLMManualCheckTopActionENC Q-PLM Interactive Manual check from the Menu / Toolbar

from Specification window

Settings for TCAQPLMHTMLDisplay

Command tab Name type

Basic Name TCAQPLMHTMLDisplay

Label emxQPLM.HTMLReport

Link Href ${SUITE_DIR}/TCAQPLM_EV6CT5_HTMLDisplay.jsp

Settings Access Expression format[QC-HTML].hasfile==TRUE ||

$<from[relationship_ActiveVersion].to.Format[QC-HTML].hasfile

==TRUE

Image ${SUITE_DIR}/images/TCAQPlmHTMLReport.gif


Submit true

Target Location hiddenFrame



83

Settings for TCAQPLMManualCheckTopAction


Basic Name TCAQPLMManualCheckTopAction

Label emxQPLM.ManualQualityCheck

Link Href ${COMMON_DIR}/emxIndentedTable.jsp?table=TCAQPLM_Su

bComponentReport&expandProgram=TCAQPLM_SubCompone

ntReport:getRelatedChildItems&postProcessJPO=TCAQPLM_S

ubComponentReport:setQCProfile&header=emxQPLM.QualityC

heck&subHeader=emxQPLM.ManualTitle&selection=multiple&e

ditLink=true&multiColumnSort=false&objectCompare=false&sho

wClipboard=false&HelpMarker=false&cancelLabel=emxFramew

ork.Button.Cancel&submitURL=${SUITE_DIR}/TCAQPLMManu

alCheckTopAction.jsp

Settings Access Expression type ~~ *CAT*

Image ${SUITE_DIR}/images/TCAQPlmManualCheck.gif


Submit true

popup Target Location

Window Height 500

Window Width 550

Settings for TCAQPLMManualCheckTopActionENC


Basic Name TCAQPLMManualCheckTopActionENC

Label emxQPLM.ManualQualityCheck

Link Href ${COMMON_DIR}/emxIndentedTable.jsp?table=TCAQPLM_Su

bComponentReport&program=TCAQPLM_SubComponentRepo

rt:getSelectedObjects&expandProgram=TCAQPLM_SubCompo

nentReport:getRelatedChildItems&postProcessJPO=TCAQPLM

_SubComponentReport:setQCProfile&header=emxQPLM.Qualit

yCheck&subHeader=emxQPLM.ManualTitle&selection=multiple

&editLink=true&multiColumnSort=false&objectCompare=false&s

howClipboard=false&HelpMarker=false&cancelLabel=emxFram

ework.Button.Cancel&submitURL=${SUITE_DIR}/TCAQPLMMa

nualCheckExecute.jsp

Settings Access Expression $<from[relationship_PartSpecification].to.type ~~ *CAT*

Image ${SUITE_DIR}/images//TCAQPlmManualCheck.gif



84



Row Select multi

Submit true

Target Location popup

Window Height 500

Window Width 550

Following are the steps to create the commands in ENOVIA Business without using

MQL script

Steps: New Command



2. Object -> New -> Command …

3. Choose “Basics” tab



Command tab “Basics”

column

a) Name

b) Label

Fig. 69: EV6 Business New Command, Basic tab

4. Choose “Link” tab



Command tab “Link”

a) Href



85

Fig. 70: EV6 Business New Command, Link tab

5. Choose “Settings” tab



Command tab “Settings”

a) Access Expression

b) …

Fig. 71: EV6 Business New Command, Settings tab

6. Choose “Object Access” tab

Add “Role” “Integration User”

Fig. 72: EV6 Business New Command, Object Access tab


8. Repeat step 2 – 7 for all Q-PLM commands which should be created.

6.4.2.7 Type

Check in Triggers on MCAD Versioned Component, Assembly, Drawings needs to

modified with an additional entry on Action Input for e. g In case of assembly

“MCADVersionedTypeAssemblyResetAction” or

”MCADVersionedTypeAssemblyCheckInAction” needs to added in the trigger,

Please refer to chapter 6.5.2.1 Trigger for more information on Q-PLM Triggers.

Reset Trigger

Type for reset Q-PLM attributes in ENOVIA V6 during checkin.

Type Condition Trigger Name



86




MCAD Versioned Drawing

Action TCAMCADVersionedComponentResetAction

Check Trigger

Launch Q-Checker after checkin.




MCAD Versioned Drawing

Action TCAMCADVersionedComponentCheckinAction

Steps: New Command



2. Search the desired type

Object -> Find …

Fig. 73: EV6 Business Find Objects, Type



87

3. Open the type for edit

Fig. 74: EV6 Business Type, Open for Edit

4. Choose the tab “Triggers”

5. Select the “Checkin” Trigger

and double click

Attention:

There might be an

“Inherited Trigger Checkin” as

well, this is not editable!

Fig. 75: Check In trigger in MCAD Versioned component

6. Add the “Action” and “Input” for the Action, refer to table above.

Use either the Reset or Check trigger; do not use both triggers together!

Fig. 76: Check In trigger with additional Q-PLM Trigger Object on Action Input

7. Repeat step 2 – 6 for all Types which should be modified.



88

6.4.2.8 Policy

For Change maturity, i.e. the life cycle graph promotion, add a trigger object to check

the Quality status of the model before promotion.

“Design policy” has to be modified, where the customer can select the life cycle state,

where they want to check the Quality Status of the CAD Model, and modify the

“Promote” trigger, by adding a check condition with Input as

“PolicyDesignPolicyStateApprovedPromoteCheck”

By default through MQL Script, the Life Cycle graph check trigger is added to

Approved state.

Trigger

Policy Condition Trigger Name

CATIA V5 Design Policy Check PolicyDesignPolicyStateApprovedPromoteCheck

Steps: Edit Policy



2. Search

“CATIA V5 Design Policy”

Object -> Find …

Fig. 77: EV6 Business Find “Design Policy”



89

3. Open the policy for edit

Fig. 78: EV6 Business Policy, Open for Edit

4. Choose the tab “States”

5. Select the “Approved” State

and press “Edit …”

Fig. 79: Lifecycle states in Design policy

6. Choose the tab “Triggers”

7. Select the “Promote” Trigger

and double click

Fig. 80: Edit State

8. Append to “Check” - “Input” the additional check, refer to table above.



90

Fig. 81: Check In trigger with additional Q-PLM Trigger Object on Action Input

6.4.2.9 Menu

For adding Q-PLM Interactive manual check to the menus.

Table

Menu Name Command Name

type_MCADComponent TCAQPLMHTMLDisplay

type_MCADVersionedComponent TCAQPLMHTMLDisplay

type_MCADDrawing TCAQPLMHTMLDisplay

type_MCADVersionedDrawing TCAQPLMHTMLDisplay

type_MCADAssembly TCAQPLMHTMLDisplay

type_MCADVersionedAssembly TCAQPLMHTMLDisplay

DSCObjectSummaryDetailsActionsToolBar TCAQPLMManualCheckTopAction

ENCpartSpecificationSummaryActionToolBar TCAQPLMManualCheckTopActionENC

Steps: Modify Menus





91

2. Search desired menus

Object -> Find …

Fig. 82: EV6 Business Find Menu

3. Open the menu for edit

Fig. 83: EV6 Business Menu, Open for Edit

4. Choose the tab “Items”


Fig. 84: Items in Menu



92

6. Menu Item Chooser, select

the command described in the

table above


Fig. 85: Menu Item Chooser


9. Repeat step 2 - 8 for all

menus from the table above.

Fig. 86: Items in Menu with added Q-PLM command

6.4.2.10 Channel

Add the HTML display to the channel.

This is is for displaying the Q-Checker HTML Report in tab of component and

versioned component like CATPart and Versioned CATPart.



93

Fig. 87: Display report in tab of component

Table

Channel Name Command Name

DSCWhereUsed TCAQPLMHTMLDisplay

Steps: Modify Channels





94

2. Search desired channel

Object -> Find …

Fig. 88: EV6 Business Find channel

3. Open the Channel for edit

Fig. 89: EV6 Business Channel, Open for Edit

4. Choose the tab “Items”


Fig. 90: Items in Menu



95

6. Menu Item Chooser, select

the command described in the

table above


Fig. 91: Menu Item Chooser


9. Repeat step 2 - 8 for all

menus from the table above.

Fig. 92: Items in Menu with added Q-PLM command

6.5 ENOVIA V6 Matrix

6.5.1 ENOVIA DB modification via MQL Script

The ENOVIA V6 objects of Matrix are created with the MQL script as well.

Please check if the objects which are described in the following chapter are created

correctly and visible in ENOVIA V6 Matrix.

6.5.2 Manual ENOVIA DB modification

6.5.2.1 Trigger

Trigger Objects are created in ENOVIA V6 for the use of Q-PLM execution during the

check in process of CAD models in to ENOVIA V6 Database, and during the

Lifecycle Graph Promotion.



96

Triggers

Name Revision Description

MCADVersionedType

AssemblyResetAction

TCAQPLM_MXResetAttributes Q-PLM Trigger for products checkin.

Reset of Q-PLM attributes.

Either TCAQPLM_MXResetAttributes or

TCAQPLM_BatchJob can be used; do

not use both triggers together.

MCADVersionedType

ComponentResetAction


MCADVersionedType

DrawingResetAction


MCADVersionedType

AssemblyCheckinAction

TCAQPLM_BatchJob Q-PLM Trigger for products checkin.

Executes Q-PLM / Q-Checker launch.

Either TCAQPLM_MXResetAttributes or

TCAQPLM_BatchJob can be used; do

not use both triggers together.

MCADVersionedType

ComponentCheckinAction

TCAQPLM_BatchJob

MCADVersionedType

DrawingCheckinAction

TCAQPLM_BatchJob

PolicyDesignPolicyState

ApprovedPromoteCheck

TCAQPLM_MaturityChange Q-PLM Trigger for maturity change

Executes Q-PLM for attribute check

MCADVersionedTypeComponentResetAction TCAQPLM_MXResetAttributes

MCADVersionedTypeAssemblyResetAction TCAQPLM_MXResetAttributes

MCADVersionedTypeDrawingResetAction TCAQPLM_MXResetAttributes

"eService Program Name" TCAQPLM_MXResetAttributes"" 0

"eService Method Name"ResetAttributes"" 0

"eService Error Type" Error "" 0

"eService Sequence Number" 1 "" 0

"eService Program Argument 7" ${NAME} "" 0

"eService Program Argument 6" MatrixOne "" 0

"eService Program Argument 5" ResetCheckinMx"" 0

"eService Program Argument 4" ${FORMAT} "" 0

"eService Program Argument 3" ${TYPE} "" 0

"eService Program Argument 2" ${OBJECTID} "" 0

"eService Program Argument 1" TRUE "" 0



97

MCADVersionedTypeComponentCheckinAction TCAQPLM_BatchJob

MCADVersionedTypeAssemblyCheckinAction TCAQPLM_BatchJob

MCADVersionedTypeDrawingCheckinAction TCAQPLM_BatchJob

"eService Program Name" TCAQPLM_BatchJob "" 0

"eService Method Name" CreateQPLMBatchJob "" 0



"eService Program Argument 7" ${NAME} "" 0

"eService Program Argument 6" MatrixOne "" 0

"eService Program Argument 5" CheckInMx "" 0

"eService Program Argument 4" ${FORMAT} "" 0

"eService Program Argument 3" ${TYPE} "" 0



PolicyDesignPolicyStateApprovedPromoteCheck TCAQPLM_MaturityChange

"eService Program Name" TCAQPLM_MaturityChange "" 0

"eService Method Name" validateDataMX "" 0



"eService Program Argument 3" MaturityChangeMx "" 0



…

public int validateDataMX(Context context, String[] args) throws

Exception

{



98

int result = 1;

// AttributeCheck

// This defines the type of execution for maturity change.

// true: Validation of attributes only, no Q-Checker run

// false: Q-Checker check run should be executed

boolean AttributeCheck = true;

// checkSimple

// This defines the type of execution if attribute check only

// This is only needed when AttributeCheck = true

// true: Validation is done inside this JPO

// The necessary settings like valide attribute values must

be done in this file

// Please refer to "Simple Check Code" below

// false: Q-PLM Dispatcher is executed for attribute validation

// The settings can be done via Q-PLM_DSP.xml

boolean checkSimple = false;

…

…

if (AttributeCheck)

{

if (!checkSimple)

{

result = qplm.checkMaturityChange(context,

sObjectID, sAction);

} else

{

/* --------------------------------------- */

/* "Simple Check Code" */

/* --------------------------------------- */

AttributeList attrList = null;

attrList = qplm.getMaturityChangeAttrList(context,

domainObject);

Iterator<matrix.db.Attribute> attrListItr =

attrList.iterator();

while (attrListItr.hasNext())

{

Attribute attribute = (Attribute)

attrListItr.next();

String attrName = attribute.getName();

String attrValue = attribute.getValue();

if (attrName.equals("TCAQCAssessment"))

{

if (attrValue.equals("OK"))

result = 0;

else if (attrValue.equals("Warning"))

result = 0;

else if (attrValue.equals("In Order"))



99

result = 0;

}

}// end of while loop

}

} // end of ..if(AttributeCheck)

…

Following are the steps to create the commands in ENOVIA Business without using

MQL script

Steps: New Trigger

1. Open the Matrix thick client

Start -> Programs -> “ENOVIA Platform Modelling Studio” -> “Matrix”

2. Object -> New -> Original …


Get the values out of the Q-

PLM installation script

triggers_qplm.exp

a) Type

b) Name

c) Revision

d) Vault

e) Policy


Fig. 93: EV6 Matrix New Original

Values from triggers_qplm.exp script:

!MTRX!BO! "eService Trigger Program Parameters"

MCADVersionedTypeComponentCheckinAction TCAQPLM_BatchJob "eService

Administration" V6R2009x(13.0.0.0)

"eService Trigger Program Policy" creator

""

……

"eService Program Argument Desc 9" "" ""






100






"eService Program Argument 9" "" ""



"eService Program Argument 6" MatrixOne ""

"eService Program Argument 5" CheckInMx ""

"eService Program Argument 4" ${FORMAT} ""

"eService Program Argument 3" ${TYPE} ""

"eService Program Argument 2" ${OBJECTID} ""

"eService Program Argument 1" TRUE ""

"eService Sequence Number" 1 ""

"eService Program Name" TCAQPLM_BatchJob ""













"eService Method Name" CreateQPLMBatchJob ""

"eService Constructor Arguments" "" ""

"eService Target States" "" ""

"eService Error Type" Error ""

…

5. Select the created trigger and

set the state

Properties -> States …

Fig. 94: EV6 Matrix Trigger -> Properties -> States …



101

6. Promote the Trigger to

“Active” state

Fig. 95: EV6 Matrix States

7. Repeat step 2 – 8 for all Q-

PLM triggers which should be

created.

Fig. 96: EV6 Matrix Q-PLM Triggers

INSTALLING DISTRIBUTED ARCHITECTURE


102

7 Installing Distributed Architecture

7.1 General

In case of Distributed Architecture some part of the software has to be installed on a

computer on the Satellite Location.

The communication between the Application Server and the Satellite Locations will

be done via HTTP(S) Web Service. On each Satellite Location a Web Service,

Q-Service Server, must be installed. On the Application Server the Q-Service Client

has to be setup.

7.2 ENOVIA V6 CBP and Q-Service Client

7.2.1 General

The libraries for Q-Services Client are only needed case of Distributed Architecture.

For communication between the Q-Service Client (e.g. Q-PLM module on the

Application Server) and the Q-Service Server (e.g. Q-PLM module on the Satellite,

File Server) a HTTP or a HTTPS (SSL) connection can be used. If HTTPS (SSL)

connection should be used the sections for the SSL security has to be customized on

client and server site.



103

7.2.2 Q-Service Client Libs

The following libraries have to be copied into a defined subfolder of the EVOVIA V6

web service deployment directory ${EV6_DEPLOY_DIR}

${EV6_DEPLOY_DIR}\WEB-INF\lib

e.g.:

c:\enoviav6r2012x\server\STAGING\ematrix\WEB-INF\lib

ATTENTION: WAR deployment

After ENOVIA WAR deployment, the Q-PLM Server Files which are copied to

the ENOVIA V6 distribution directory are lost. They have to be copied again.


After all Q-PLM Server Files are installed the Web Server (Apache Tomcat)

has to be restarted.

The AXIS2 libraries are third party files. They are from Apache AXIS2. Minimum

AXIS2 V1.5 is needed. For convenience we provide the necessary AXIS2 libraries.

From more information refer to the AXIS2 homepage:

http://ws.apache.org/axis2/

Following libraries are needed for the basic Q-Service Client


Q-Service Client Libraries:


Q-PLM_DSP.5.1.0.jar $(QPLM_INSTALL_DIR)\bin

e.g.:

c:\ Q-Checker\QPLM_ EV6CT5_5.1.0\bin

LUMClient.jar

Q-PLM ENOVIAV6 Libraries

Q-PLM_ENOVIAUtil.5.1.0.jar $(QPLM_INSTALL_DIR)\bin\EV6_CBPServer

e.g.:

c:\Q-Checker\QPLM_EV6CT5_5.1.0\bin\EV6_CBPServer

Q-PLM_ENOVIAV6Plugin2010x.5.1.0.jar

http://ws.apache.org/axis2/



104


Q-PLM ENOVIAV6 CT5 Libraries

Q-PLM_MxCheckIn.jar $(QPLM_INSTALL_DIR)\bin\EV6_CBPServer\EV6CT5

e.g.:

c:\Q-Checker\QPLM_EV6CT5_5.1.0\bin\

EV6_CBPServer\EV6CT5

Q-PLM_MxSatelliteTools.jar

Q-PLM_MxCheckOut.jar

Q-PLM_DSP_Start.jar


7.2.3 Q-Service Client Properties Files

TCAQSCBase.properties

Adjust the following entries

Log file settings

…

# create logfile ( 1 OR 0 )

TCAQSCBase.log = 1

# where to store logfile

TCAQSCBase.logfile = C:/Q-Checker/QPLM_3/tmp/TCAQSCBase.log

# logfilename prefix ( 0 = no prefix (default),

# 1 = with generated timestamp prefix,

# 2 = own defined prefix from TCAQSCBase.logfilePrefixValue,

# 3 = from other program or no prefix )

TCAQSCBase.logfilePrefix = 3

…

Time out setting

…

#Time Out in Milliseconds

TCAQSCBase.AXIS2TimeOut = 3600000

…

For SSL security:

…

# use SSL ( 0 = no ssl, 1 = one way, 2 = two way )

TCAQSCBase.SSL = 2

# server keystore (java keystore *.jks)

#TCAQSCBase.ServerCert = {Q_DIR}/Q-Services/ssl_sample/signed/caKeystore.jks



105

TCAQSCBase.ServerCert = server.jks

# client keystore (java keystore *.jks) containing the client certificate and

private key

#TCAQSCBase.KeyFile = {Q_DIR}/Q-Services/ssl_sample/signed/client.jks

TCAQSCBase.KeyFile = client.jks

# passphrase according to server keystore

TCAQSCBase.ServerPass = password

# passphrase according to client keystore

TCAQSCBase.ClientPass = password

# debug output for ssl ( 1 OR 0 )

TCAQSCBase.debugSSL = 0

…

7.3 Satellite installation

7.3.1 General

The installation of Q-Services Server is only needed if the Distributed Architecture.

Each Satellite Location on which the Q-Checker run should be performed should

have a Q-Services Server installation. If no Q-Services Server is installed and

configured on the Satellite location the Q-Checker check will be performed on the

default check computer of Application Server.

For communication between the Q-Service Client (e.g. Q-PLM module on the

Application Server) and the Q-Service Server (e.g. Q-PLM module on the Satellite,

File Server) a HTTP or a HTTPS (SSL) connection can be used. If HTTPS (SSL)

connection should be used the sections for the SSL security has to be customized on

client and server site.

7.3.2 Q-Service Installation

Q-Service Server must be installed on the Satellite Location.

Refer to documentation Q-Services_x.x.x.pdf.

The following libraries have to be copied to the Apache Tomcat Library directory In

addition to the Q-Service libraries.

${SERVICE_INSTALL_DIR} is the root directory where web service is installed.

${SERVICE_INSTALL_DIR}\lib

e.g.:



106

c:\program Files\Apache Software Foundation\Tomcat6.0\lib

For the execution of Q-PLM process we have to add the following libraries in the

Apache tomcat server.



Q-PLM_DSP.5.1.0.jar $(QPLM_INSTALL_DIR)\bin

e.g.:

c:\Q-Checker\QPLM_EV6CT5_5.1.0\bin

LUMClient.jar

Q-PLM ENOVIA V6 Libraries

Q-PLM_ENOVIA.5.1.0.jar $( QPLM_INSTALL_DIR)\bin\EV6_CBPServer

e.g.:

c:\Q-Checker\Q-PLM_EV6CT5_V5.1.0\bin\

EV6_CBPServer



Q-PLM ENOVIA CV6CT5 Libraries

Q-PLM_MxCheckIn.jar $(QPLM_INSTALL_DIR)\bin\EV6_CBPServer\EV6CT5

e.g.:


EV6_CBPServer\EV6CT5

Q-PLM_MxSatelliteTools.jar

Q-PLM_MxCheckOut.jar


ENOVIA V6 Libraries

activation.jar The needed libraries are delivered with the Q-PLM

installation files in the sub directory:

$(QPLM_INSTALL_DIR)\bin\EV6_CBPServer\EV6CT5\

${ENOVIA_VERSION_DIR}\lib\fileserver

e.g.:


EV6_CBPServer\EV6CT5\EV6R2013x\lib\fileserver

eMatrixServletRMI.jar

FcsClient.jar

framework.jar

M1jsystem.jar

mx_axis.jar

mx_jdom_1.0.jar



107


servlet-api.jar

ATTENTION:

We highly recommend replacing the jar files in

the Q-PLM directory with the original one of

your ENOVIA installation.

The delivered files of Q-PLM are based on the

ENOVIA GA version. In case of Service Packs,

Hot Fixes, … these might not work anymore.

Replace the file of the Q-PLM directory with the once you

can find for example in the following ENOVIA folders.

${MX_INSTALL_DIR}\ModelingStudio\java\lib

${MX_STAGING_DIR}\WEB-INF\lib

e.g.:

c:\matrixone\ModelingStudio\java\lib

c:\matrixone\server\STAGING\ematrix\WEB-INF\lib

NOTE: Apache Tomcat Restart

After Q-PLM & Matrix One libraries are installed in the Web Server (Apache

Tomcat) has to be restarted.

7.3.3 Q-PLM Installation

Q-PLM must be installed and configured on the Satellite Location.

Refer to Q-Checker documentation and chapter 8 “Client customization”.

7.3.4 Q-Checker / CATIA Installation

Q-Checker / CATIA must be installed on the Satellite Location.

Refer to Q-Checker documentation and chapter 8 “Client customization”.

CLIENT CUSTOMIZATION


108

8 Client customization

8.1 General customization

Needed for

- PDM Save on each client

- Satellite installation on check computer

- Batch Check (Night Batch) on check computer

8.2 Q-PLM installation / customization

8.2.1 Q-PLM installation

For PDM Save Q-PLM has to be installed on the client machine as well.

Refer to chapter Fehler! Verweisquelle konnte nicht gefunden werden. “Fehler!

Verweisquelle konnte nicht gefunden werden.”.

ATTENTION:

We highly recommend replacing the ENOVIA jar files in the Q-PLM directory

with the original one of your ENOVIA installation.

The delivered files of Q-PLM are based on the ENOVIA GA version. In case

of Service Packs, Hot Fixes, … these might not work anymore.

The needed libraries are delivered with the Q-PLM installation files in the sub

directory:

$(QPLM_INSTALL_DIR)\bin\EV6_CBPServer\EV6CT5\

${ENOVIA_VERSION_DIR}\lib\fileserver

e.g.:

c:\Q-Checker\QPLM_EV6CT5_5.1.0\bin\EV6_CBPServer\EV6CT5\

EV6R2013x\lib\fileserver

Replace the file of the Q-PLM directory with the once you can find for

example in the following ENOVIA folders.

${MX_INSTALL_DIR}\ModelingStudio\java\lib



109

${MX_STAGING_DIR}\WEB-INF\lib

e.g.:

c:\matrixone\ModelingStudio\java\lib

c:\matrixone\server\STAGING\ematrix\WEB-INF\lib

8.2.2 Q-PLM configuration

8.2.2.1 PDM Save script

The PDM Save script does the Q-PLM update of the ENOVIA object after it was

saved by the ENOVIA Save Dialog. This is setting the attributes and attaches the

report.

${QPLM_ISTALL_DIR}\bin\EV6_Client\EV6CT5\QPLMPDMSaveCmd.bat

Check and adjust the lines which are marked in blue.

…

set QPLMPATH=%QPLMPATH%

set QPLMVERS=5.1.0

set EV6VERS=R2011x

set JAVAPATH=java

…

8.2.2.2 Q-PLM Batch Check

Q-PLM Batch Check can be called from a command line or a script. This call can be

triggered from a system cron job. The CATIA models for the batch check are

searched in the ENOVIA V6 database.

Fig. 97:: Q-PLM Night Batch Job Execution



110

Input parameter for Batch Check execution:

Name Value

User Name ENOVIA V6 Login Name

User Password ENOVIA V6 Login password

Server URL ENOVIA V6 Server URL with port number

Start Date to search CAD Models Date e.g. 08/23/2010 08:00:00 AM

End Date to search CAD Models Date e.g. 09/23/2010 08:00:00 AM

Q-PLM Action DBTriggerMx

Dispatcher XML file $(Q-PLM_INSTALL_DIR)\adm\

Q-PLM_ENOVIA_MX_Dsp.xml

Q-PLM Trace Activation E.g. True or False.

JAVAPATH Java installed path in the system.

Night Job user should have sufficient access to ENOVIA V6 Database (e. g: Admin

user) to access all the ENOVIA V6 documents, to modify its attributes and attach Q-

Checker Report files

Example of Q-PLM Batch Check:

"C:\Program Files\TrancatPLM\Q-PLM\bin\Command\

TCAQPLMNightBatchJobCmd.bat" "Test Everything" "passwd"

"http://servername:8080/enovia" "09/09/2010 08:00:00 AM" "10/09/2010

12:00:00 AM"

In addition optional “Where” Query can be configured in the Q-PLM Dispatcher xml

file. Refer to Q-PLM_DSP.xml customization documentation for more information.

8.2.2.3 Q-PLM_DSP.xml

This chapter describes only the ENOVIA V6 with CATIA V5 specific settings. For the

general Q-PLM Dispatcher customization refer to:

Q-PLM_XML-DspReference_3.x.pdf, Dsp.xml file reference

Q-PLM_XML-Customization_3.x.pdf, Dsp.xml customization



111

8.3 Q-Checker / CATIA V5

8.3.1 CATIA Environment customization

Add the Q-PLM path to the CATIA Environment file.

(1) Open the ENOVIA Business Modeler Start -> Programs ->ENOVIA -> Tools -> “Environment Editor”

(2) Choose the Q-Checker environment file

(3) Environment -> New From …

Fig. 98: Environment Editor -> New from …



112

(4) Select the checkbox “Add a new path to this environment”

(5) Enter the Q-PLM client library installation directory into the “New path” text field. e.g.: C:\Q-

Checker\Q-PLM_EV6\bin\EV

6_Client\EV6CT5\

V5R19GA

(6) Confirm with OK

Fig. 99: CATIA Environment Editor -> „New Path“

After the Q-PLM path is added to the CATIA Environment file the following environment

variables have to be added in addition:

Variable Description Value (Example)

QPLMPATH Root path of Q-PLM installation

C:\Q-Checker\QPLM_V5.1.0

QPLMDSPXML Full qualified name (incl. path) of Dsp.xml file

C:\Q-Checker\QPLM_V5.1.0\

Q-PLM_DSP.xml TCAQC_PDM_SAVE_ACTIVATE Enables / disables PDM

Save function NO: disabled YES: enabled

TCAQC_PDM_SAVE_ACTIVE_

AFTER_HEALING

Enables / Disables PDM Save dialog with Q-Checker Healing disabled

NO: disabled YES: enabled

TCAQC_QPLM_LIB Q-PLM module which is called from Q-Checker PDM Save

TCAQPlmEDMSaveMxMd

TCTRACEON Enables / disables trace files for Q-PLM EV6 integration

NO: disabled YES: enabled

TCAQPLM_LIC Defines the license mechanism

Default: DSLS license DSLS: DSLS license DSLUM: Dassault LUM license TC: Transcat LUM license

Sample of customized CATIA Environment with mandatory Q-PLM variables …

QPLMPATH = c:\Q-Checker\QPLM_V5.1.0

QPLMDSPXML = c:\Q-Checker\QPLM_V5.1.0\adm\Q-PLM_DSP.xml

…



113

ATTENTION:

Take care that the CATIA Environment file which is used for Q-PLM contains the Q-Checker modifications as well.

If CATIA / Q-Checker is launched from Web Server (e.g. Apache Tomcat) the CSIDL

variables might not be processed.

Replace all CSIDL variable with fill path names.

…

CATUserSettingPath=CSIDL_APPDATA\DassaultSystemes\CATSettings

CATCollectionStandard=

CATTemp=CSIDL_LOCAL_APPDATA\DassaultSystemes\CATTemp

CATMetasearchPath=DSKEY_TMPDIR

CATW3PublishPath=DSKEY_TMPDIR

CATSharedWorkbookPath=DSKEY_TMPDIR

CATErrorLog=CSIDL_LOCAL_APPDATA\DassaultSystemes\CATTemp\error.log

CATReport=CSIDL_LOCAL_APPDATA\DassaultSystemes\CATReport

CATDisciplinePath=

USER_HOME=CSIDL_PERSONAL

…

%QPLMPATH%\bin\GetCSIDL2.exe

Fig. 100: CSIDL output from GetCSIDL2.exe



114

…

CATUserSettingPath=C:\Users\Administrator\AppData\Roaming\

DassaultSystemes\CATSettings

CATCollectionStandard=

CATTemp=C:\Users\Administrator\AppData\Local\DassaultSystemes\

CATTemp

CATMetasearchPath=C:\Users\ADMINI~1\AppData\Local\Temp\2

CATW3PublishPath= C:\Users\ADMINI~1\AppData\Local\Temp\2

CATSharedWorkbookPath= C:\Users\ADMINI~1\AppData\Local\Temp\2

CATErrorLog=C:\Users\Administrator\AppData\Local\DassaultSystemes\

CATTemp\error.log

CATReport=C:\Users\Administrator\AppData\Local\DassaultSystemes\

CATReport

CATDisciplinePath=

USER_HOME=C:\Users\Administrator\Documents

…

8.3.2 Configure Q-Checker for PDM Save

Needed for “PDM Save” only

8.3.2.1 Q-Checker V2.x

QCHECKER.par

Ensure that the PDM Save action is not disabled in QCHECKER.par. The QCHECKER.par

file is in the Q-Checker Environment directory, refer to Q-Checker documentation.

The entry qchecker.PDM_SAVE_ACTIVATE has to be commented out with # character or

it has to be set to ALLOW.

Sample of QCHECKER.par file with commented out qchecker.PDM_SAVE_ACTIVATE

entry …

# Trigger to suppress or allow PDM-SAVE.

# (allowed values: ALLOW,SUPPRESS; default: ALLOW)

#qchecker.PDM_SAVE_ACTIVATE SUPPRESS

…

Note: Environment variable QCHECKER_PDM_SAVE must be set otherwise this setting is ignored



115

PROFILE.par

After pressing the close button of Q-Checker with PDM Save enabled, a dialog occurs. With this dialog the user can perform the PDM Save or not. The message of this dialog can be customized in PROFILE.par. Sample of PROFILE.par file with customized PDM Save dialog message. ...

# title and the msg of the pdm save option

qchecker.PDM_SAVE_ACTIVATE_TITLE PDM SAVE OPTION

qchecker.PDM_SAVE_ACTIVATE_MSG <qt>PDM Save 

qchecker.PDM_SAVE_ACTIVATE_MSG Save the checked model/models. 

qchecker.PDM_SAVE_ACTIVATE_MSG The stored model/models will be

overwritten! </qt>

# title and the msg of the pdm save option after healing

qchecker.PDM_SAVE_ACTIVE_AFTER_HEALING_TITLE PDM SUPRESS SAVE OPTION

qchecker.PDM_SAVE_ACTIVE_AFTER_HEALING_MSG

<qt>Warning: 

qchecker.PDM_SAVE_ACTIVE_AFTER_HEALING_MSG Healed model/models will

not be saved. 

qchecker.PDM_SAVE_ACTIVE_AFTER_HEALING_MSG \p0 model/models were

healed! 

qchecker.PDM_SAVE_ACTIVE_AFTER_HEALING_MSG The healed model/models

are: 

qchecker.PDM_SAVE_ACTIVE_AFTER_HEALING_MSG \p1 </qt>

...

8.3.2.2 Q-Checker V5.x

Activate PDM Save in the Q-Checker check environment.



116

Fig. 101: Q-Checker V5 Environment Editor for PDM Save

Note: Environment variable QCHECKER_PDM_SAVE must be set otherwise this setting is ignored

LEGAL NOTICES


117

9 Legal Notices

CATIA, ENOVIA, Q-Checker are registered trademarks of Dassault Systèmes or its subsidiaries in the US, other countries or both. U.S. Government Users Restricted Right Commercial Computer Software. Use, duplication or disclosure restricted by GSA Schedule Contract or, under DFARS Subpart 227.4 only: subject to “Restricted Rights” at 252.227-7013(c)(l)(ii)

All other company names and product names mentioned are the property of their respective owners. The software may include the following open source components licensed under the following licenses. Apache license:

Axis2/C

Axis2/Java

Axis1/Java

Apache Tomcat OpenSSL license:

OpenSSL

Date post:	11-Feb-2016
Category:	Documents
Upload:	simon20001
View:	41 times
Download:	1 times