ENOVIA SmarTeam Configuration Release 5transcat-plm.com/pub/tcsoft/.../Q-PLM_SmarTeam_XML...•...

Q-PLM Dispatcher Configuration

(Q-PLM_Dsp.xml)

Configuration Guide

ENOVIA SmarTeam Configuration

Release 5.7

2019-03-13 / Last changes in document for release 5.7.0

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–2019 Dassault Systèmes

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

subsidiaries in the US and/or other countries.

CONTENTS

Copyright Dassault Systèmes Q-PLM_Dsp.xml ENOVIA SmarTeam 5.7

2

Contents

1 General introduction 5

2 XML Editing with Xerlin 9

3 Quick Start for Standard Installation 11

3.1 Q-PLM SmarTeam with SMDemo.............................................................................................11

4 node 13

4.1 sub node ..........................................................................................................13

4.2 sub node ............................................................................................................14

4.3 sub node .............................................................................................................16

4.4 Protocol Directory ......................................................................................................................17

5 PLMSystem SmarTeam 19

5.1 General setting nodes ...............................................................................................................19

5.1.1 General .....................................................................................................19

5.1.1.1 TmpDir .....................................................................................19

5.2 Action settings ...........................................................................................................................19

5.2.1 ActionExtentions .......................................................................................19

5.3 PDM/PLM system settings ........................................................................................................21

5.3.1 ClassName ...............................................................................................21

5.3.2 AttributeName ..........................................................................................22

5.3.3 CATIAFileTypes .......................................................................................23

5.4 Copy CATIA files out of PDM/PLM database ...........................................................................24

5.4.1 CopyOut ...................................................................................................24

5.4.1.1 General ..........................................................................................................24

5.4.1.2 nodes ............................................................................................25

5.4.1.3 Further CopyOut settings ..............................................................................26

5.4.2 AddCopyOutFileTypes .............................................................................28

5.4.3 CopiedFileDeletion ...................................................................................29

5.5 Dialog settings ...........................................................................................................................30

5.5.1 MessageBox ..............................................................................................30

5.5.2 NoResultMsgIntAttr ....................................................................................31

5.6 Report ...................................................................................................................32

5.7 PDM/PLM attribute value settings .............................................................................................33

5.7.1 EmptyQCTabActions ................................................................................33

5.7.1.1 nodes definition ..............................................................................34

5.7.1.2 Unlink report ..................................................................................................34

5.7.2 EmptyQCTabAttrValues ...........................................................................34

5.7.3 AttributeDefFailure ...................................................................................35

5.7.4 AttributeDefTimeout .................................................................................35

5.7.5 CheckTimeStamp .....................................................................................35

CONTENTS


3

5.8 PLM/PDM attribute conversion and mapping ...........................................................................38

5.8.1 LookupAttrReplExclude ............................................................................38

5.8.2 LookupTNPrj ............................................................................................39

5.8.3 LookupTNDoc ..........................................................................................39

5.8.4 TypeConvert .............................................................................................39

5.8.5 UserIdMapDoc .........................................................................................40

5.9 Check stage and query settings ................................................................................................41

5.9.1 ManualCheck ...........................................................................................41

5.9.2 CheckinCheck ..........................................................................................43

5.9.3 JobCheck..................................................................................................44

5.9.3.1 Enabling / disabling file states .......................................................................44

5.9.3.2 Enable file types for query .............................................................................45

5.9.4 AddJobWhereQuery .................................................................................45

5.9.4.1 General ..........................................................................................................45

5.9.4.2 Multiple AddJobWhereQuery definitions .......................................................47

5.10 Login and authorization settings ...............................................................................................48

5.10.1 CheckAuthorization ..................................................................................48

5.10.2 InvokeScripts ............................................................................................49

5.10.3 Password crypt program ...............................................................................................50

5.11 Maturity change, lifecycle operation and workflow settings ......................................................51

5.11.1 AdminRelease ..........................................................................................51

5.11.2 WorkFlow..................................................................................................52

5.12 Batch attributes settings ............................................................................................................53

5.12.1 BatAttrsDoc ..............................................................................................53

5.12.2 BatAttrsPrj ................................................................................................53

5.12.3 BatAttrsCN................................................................................................54

5.12.4 BatAttrsCL ................................................................................................54

6 SmarTeam specific settings 55

6.1 General ......................................................................................................................................55

6.2 Actions .......................................................................................................................................55

6.2.1 Vault Attribute ...............................................................................................................55

6.2.2 Attaching Q-Checker Report .........................................................................................56

7 nodes 59

7.1 NativeLibs ..................................................................................................................................59

7.1.1 License type ..................................................................................................................59

7.1.2 node ...............................................................................................................60

7.1.2.1 nodes.........................................................................................61

7.2 nodes .................................................................................................................62

7.2.1 CATIA Q-Checker default sub node .............................................................................62

7.2.2 Result judging and validation ........................................................................................63

7.2.2.1 / node .....................................................63

7.2.2.2 / node .....................................................64

7.2.2.3 / node ......................................................................64

CONTENTS


4

7.2.2.4 / and / node .................66

7.3 Actions .......................................................................................................................................68

7.3.1 General .........................................................................................................................68

7.3.2 Default Action nodes .....................................................................................................69

7.3.2.1 ENOVIA V6 / 3DExperience + CATIA V6 ......................................................69

7.3.2.2 ENOVIA V6 / 3DExperience + CATIA V5 ......................................................70

7.3.2.3 SmarTeam .....................................................................................................70

7.3.2.4 ENOVIA VPM V5 ...........................................................................................70

7.3.2.5 ENOVIA VMP V4 ...........................................................................................71

7.3.3 Action attributes ............................................................................................................71

7.3.3.1 Attributes for ProfileData and Q-Checker Profile ..........................................71

7.3.3.2 Condition Attribute .........................................................................................72

7.3.3.3 Vault Attribute ................................................................................................74

7.3.4 Q-Checker Time Out .....................................................................................................74

7.3.5 Attaching Q-CHECKER Report .......................................................................................75

7.3.6 Defining Result Attributes .............................................................................................75

7.3.6.1 Standard attribute definition ..........................................................................75

7.3.6.2 Date / time attribute definition ........................................................................76

7.3.7 Defining Q-CHECKER Report File Names ......................................................................78

7.3.8 Enable Q-CHECKER model save ....................................................................................79

7.3.9 Show Message Boxes ..................................................................................................80

8 Legal Notices 81

GENERAL INTRODUCTION


5

1 General introduction

Q-PLM_Dsp.xml is the configuration file for the Q-PLM products.

ATTENTION

• If paths contain whitespaces, the whole path has to be enclosed in quotation

marks.

• In the XML file, the quotation marks must be written in HTML syntax: "

The following examples are for ENOVIA V6 with CATIA V6. But they are similar to the other

ENOVIA and CATIA versions. This chapter should only give an overview. The specific nodes

and settings for the ENOVIA and CATIA version are described in the other chapters of this

document.

The root node of the Q-PLM_Dsp.xml is . This node contains three main

XML nodes:

• : global settings

• : PLM-system-specific settings

• : Settings for check execution

Globals: global settings

These settings can be used in most of the other XML nodes.



6

Example of global settings for ENOVIA V6 with CATIA V6:

Fig. 1: node

PLMSystems: PLM system-specific settings

The sub node contains the special settings for the PDM systems or DX. This

node contains different entries for the different PLM systems. The name of the node is the

name of the system.



7

Example of PLM Settings for ENOVIA V6 with CATIA V6:

Fig. 2: node for ENOVIA V6



8

QCheckerPLM: Settings for check execution

ProfileDatas: Settings for check execution used be QCheckerPLM node.

This node defines CATIA / Q-CHECKER definition and execution, result judging, attribute

settings, Q-CHECKER report attachment, …

Example of QCheckerPLM and ProfileDatas for CATIA V6:

Fig. 3: node

Please refer to refer to the following documentation for more information about the

Q-PLM_Dsp.xml:

Q-PLM_XML-DspReference_5.x.x.pdf

XML EDITING WITH XERLIN


9

2 XML Editing with Xerlin

We suggest editing the XML file with Xerlin 1.3. This is an Open Source tool which can be

downloaded from:

http://www.xerlin.org/

XERLIN takes care of the DTD definitions. It allows to add only sub nodes, which are available

for the parent node. Only the defined number of sub nodes can be added. Only attributes,

which are defined in the node, are displayed. In case that it is not allowed to leave a node or

attribute empty, an error message will be displayed. If nodes collide with the DTD definition,

they are displayed in a different colour. XERLIN helps to avoid failures and corrupt XML files.

However, note that XERLIN validates only the structure, but does not check if the content and

values are suitable.

Example of the use of Xerlin for the node:

///

Steps:

Example, using XERLIN:

(1) In Xerlin, open the QCheckerDsp.xml file (File > Open f i le)

(2) Select the node:

////

/

(3) Right-click the node and

select

"Add" > "OKAssessment".

XML EDITING WITH XERLIN


10

A new sub node has been added.

Fig. 4: node created

(4) Enter the name value.

Fig. 5: Enter the value

QUICK START FOR STANDARD INSTALLATION


11

3 Quick Start for Standard Installation

3.1 Q-PLM SmarTeam with SMDemo

Standard installation:

• SmarTeam client and all other modules are installed only on Windows platform.

• The execution of all the SmarTeam integration modules (Q-PLM Dispatcher, Q-Checker

V5) is on the Windows machine where the PDM client is running.

• Only Catia V5 CATParts / CATDrawings / CATProducts can be checked (and no Catia V4

model).

• SmarTeam class names are not customized (names of the demo database).

• Q-Checker is launched in "waitfor” mode. The SmarTeam integration will wait until the

Q-Checker run is finished.

• Only one Q-Checker profile can be used.

Quick start for standard installation

(1) Open the Xerlin XML editor.

(2) Choose the node /.

(3) Customize the following nodes:

CATEnv Name of the CATIA V5 environment

CATEnvDir Path to the CATIA V5 environment, this environment must

contain the settings for Q-Checker.

TmpDir Path for temporary files (standard: installation directory,

subdirectory tmp)

DspJar Path and name of the QCheckerDSP.5.x.jar file

(installation directory, subdirectory bin)

CATStartV5 Path and name of CATIA V5 CATSTART.exe

(4) Select the default profile data node for CATIA V5 checks:

///

(5) Customize the following nodes according to your Q-Checker profile:

QUICK START FOR STANDARD INSTALLATION


12

Name of the Q-Checker environment

NAme of the Q-Checker profile

/ Valid assessments. Any assessments

not defined here are not OK (check

failed).

/ Valid return codes. Any return codes not

defined here are not OK (check failed).

/ Set the sub node

to "QCReport" if you work with

Q-CHECKER 1.14.1 or higher, otherwise

choose "DBReport"

NODE


13

4 node

The global settings are in the / node.

Figure 6: node (Xerlin editor)

4.1 sub node

With sub nodes, a string value can be set for general use, i. e. it can be

used in most of the XML nodes, having a node.

The node has 2 attributes:

• name: Unique identifier (it must be unique for GlobalString, GlobalPath

and GlobalMap)

• value: String value

The node has only one attribute, which refers to the unique name of the

:

• name: Reference to the unique ID of the global string

NODE


14

Example, using the for the CATIA environment name CATEnv

Definition of CATEnv:

Figure 7: node (Xerlin editor). In this node, a string value is defined which can be used in nodes

Usage of :

Figure 8: node, in which is used (Xerlin editor)

4.2 sub node

With sub nodes, a path can be set for general use, i. e. it can be used in

most of the XML nodes with, having a node.

If the modules are installed on a mixed system (WINDOWS and UNIX), a has

to be used for defining the directories for both systems. Keep attention to the path string do

not end the path with “\” or “/”.

NOTE

The path string must not end with slash “\” or backslash “/”.

NODE


15

The has 3 attributes:

• name: Unique identifier (it must be unique for GlobalString and

GlobalPath)

• valuewin Path for WINDOWS

• valueunix Path for UNIX

The node has only one attribute that refers to the unique name of the

or :

• name Reference to the unique ID of the global string

Example, using the for the tmp path

• Definition of TmpPath:

Figure 9: node for TmpDir (Xerlin editor)

With this node a path value is defined, which can be used in any

nodes.

• Usage of

Figure 10: node, usage in (Xerlin editor)

NODE


16

This shows the usage of a node in the node.

Example, using the for the JavaExe

• Definition of JavaExe:

Figure 11: node for JavaExe (Xerlin editor)

This shows the usage of a node in the node.

TIP:

We recommend using an UNC path for Windows if possible. This will avoid path

problems on the client computers.

4.3 sub node

Some path mappings can not be done by defining a (e. g. for the CATIA

models the directories are defined with an node as default, not with a

). To enable the path mapping for these cases, the node

has to be used.

The has 2 attributes:

valuewin Path for WINDOWS

valueunix Path for UNIX

Paths for which a global map must be defined:

• Directories for CATIA models if they are not defined with a node.

• Path for the Q-PLM_Dsp.xml in case if the Q-PLM DISPATCHER module is run on UNIX.

• Any other directories which are used for both WINDOWS and UNIX systems and which are

not defined by a .

The replacement of the string to be replaced is done by scanning this string, beginning with

the first character. If in a sub node a matching value is found, the beginning

NODE


17

of this string is replaced. The slashes of the not replaced part are converted in the platform-

dependent ones. If in the Q-PLM_Dsp.xml file more than one sub node is

defined, the order of these sub nodes in this file is relevant for the

replacement result (see example below).

Replacement example:

The path to be replaced is: "c:\aaa\bbb\ccc"

(1)

(2)

If in the XML file in top position is the map sub node (1), the replacement result will be as

follows:

/aaa/xxx

If in the XML file in top position is the map sub node (2), the replacement result will be as

follows:

/aaa/yyy/ccc

Example, using the sub node for the installation directory

• Definition of the sub node:

Figure 12: node definition (Xerlin editor)

4.4 Protocol Directory

All trace and protocol files are written in the protocol directory. This directory is defined under

(Refer to Figure 6: node on page

13.)

NODE


18

The protglobalname attribute must point to a . (Refer to section

" sub node" on page 14.)

PLMSYSTEM SMARTEAM


19

5 PLMSystem SmarTeam

5.1 General setting nodes

5.1.1 General

The general settings are sub nodes of

///

5.1.1.1 TmpDir

The node defines the directory for temporary files (except protocol and trace files).

For the trace files refer to section 4.4 „Protocol Directory“.

For customizing the temporary directory choose the node:

///

/

NOTE

Other modules of the PLM integration also need access to some of these files.

Modify this value only if it is assured that all the shared files are accessible.

For the standard installation, we advise to use the TmpDir node of the global settings.

5.2 Action settings

5.2.1 ActionExtentions

The action extension settings are under the following sub node:

///

From the different PDM/PLM systems different Actions, depending to the operation type, are

called.

PLMSYSTEM SMARTEAM


20

Table 1: Default Action

PLM system Default Action Description

ENOVIA

SmarTeam

Manual SmarTeam interface

CheckIn Check in operation

Release Release operation

DBTrigger Batch job (QCheckerSTJobV5.exe)

WorkFlow SmarTeam work flow

The default name of the different nodes can be enlarged with a special action

extension.

Table 2: Action extensions

PLM system Action extension Description

ENOVIA

SmarTeam

Based on SmarTeam class names

The relation between to the class names are defined

in the sub nodes "ClassName"

PartClassName CATIA V5 part class

ProductClassName CATIA V5 product class

DrawingClassName CATIA V5 drawing class

IntComponentClassName CATIA V5 internal component (product) class

ModelClassName CATIA V4 model class

The node contains the CATIA start command. There can be a need for a

different command due to the different types to the table above.

Example for ENOVIA SMARTEAM, ActionExtentions="V5" for CATIA Products.

Fig. 13: node with "ActionExtensions”, for SmarTeam and CATIA Products (Xerlin editor)

The name of the result Action for check in is "CheckInV5".

PLMSYSTEM SMARTEAM


21

5.3 PDM/PLM system settings

5.3.1 ClassName

The SMARTEAM class names are under the following sub node:

///

For each relevant SMARTEAM class name, there is a "Attribute" sub node. For some

classes multiple definitions can be made, e.g. two classes for parts should be enabled

"CATIA Part " and "CATIA Standard Part". In this case, two "PartClassName "

nodes can be defined.

Table 3: SmarTeam class names

Name Default value Multiple

DrawingClassName CATIA Drawing Yes

DrawingLinkClassName CATIA Downstream Application No

PartClassName CATIA Part Yes

ProductClassName CATIA Product Yes

ModelClassName CATIA Model Yes

IntComponentClassName CATIA internal component No

CatiaClassName General CATIA class No

ProjectClassName Project No

DocsDocsRelClassName Documents Documents Relation No

UsersClassName Users No

ReportClassName Document No

Fig. 14: Xerlin node of "ClassName”

PLMSYSTEM SMARTEAM


22

These values have to be modified only if the class names of SMARTEAM do not match the

default ones.

Choose the attribute sub node for the class and adjust the value, but leave the name like it is.

Example:

The class name for "Catia Part" is changed to "Part".

• Choose the node

• Change to

5.3.2 AttributeName

The important SMARTEAM attribute names are under the following sub node:

///

For each relevant SmarTeam class name, there is a "Attribute" sub node.

Table 4: SMARTEAM attribute names

Name Default value Multiple

TdmId TDM_ID No

TdmName TDM_NAME No

TdmComponentName TDM_COMPONENT_NAME No

FileType FILE_TYPE No

FileTypeKey FILE_TYPE_KEY No

Directory DIRECTORY No

CatRefDirectory CAD_REF_DIRECTORY No

FileName FILE_NAME No

CatRefFileName CAD_REF_FILE_NAME No

OperationId OPERATION_ID No

State STATE No

ModificationDate MODIFICATION_DATE No

UserIdMod USER_ID_MOD No

UserEmail USER_EMAIL No

LastName LAST_NAME No

FirstName FIRST_NAME No

UserObjectId USER_OBJECT_ID No

TdmDescription TDM_DESCRIPTION No

Login LOGIN No

These values have to be modified only if the class names of SmarTeam do not match the

default ones. Please look on these XML nodes and modify the class names if it is necessary.

PLMSYSTEM SMARTEAM


23

Example:

Previous version of SmarTeam database with CN_ID instead of TDM_ID

Change the Attribute sub node "TdmId":

From

PLMSYSTEM SMARTEAM


24

Fig. 16: SmarTeam File Type Lookup Table

5.4 Copy CATIA files out of PDM/PLM database

5.4.1 CopyOut

5.4.1.1 General

The general copy out behavior is defined with the vault attribute of the Action node.

///

In here the behavior how the CATIA models should be copied out of SmarTeam vault is

defined. The definition in the chapters below are configuring the behavior in case if the

CATIA models are copied out of SmarTeam.

PLMSYSTEM SMARTEAM


25

Please refer to the related chapter of “SmarTeam specific settings”.

5.4.1.2 nodes

For the copy out directories any combination of "Discrete” and "Global” nodes can be used.

System environment variables can be used with UNIX and WINDOWS syntax.

In case of SmarTeam the SmarTeam Work Directory of the user can be used by setting the

value of a "Discrete” to @{STWorkDir}.

Fig. 17: Example nodes for copy out directories (Xerlin editor)

NOTE

The system environment variables are taken from and resolved on the system

where the PLM Integration is executed. If other modules are executed on other

systems this full resolved path is passed to these modules. For this path the

general roles of the shared file system have to be considered.

Table 6: copydir nodes

Sub node name Purpose Details

copydir Defines the general

copy out destination

Parameter name="copydir"

Default value: TmpDir

copydir_v4 Defines the copy out

destination for CATIA

V4 models

Parameter name="copydir_v4"

Default: Node is not set

copydir_v5 Defines the copy out

destination for CATIA

V5 models

Parameter name="copydir_v5"

Default: Node is not set

Order of determining the copy directory:

copydir_v4 copydir_v5

copydir TmpDir Not defined Dir not found

Not defined Dir not found

PLMSYSTEM SMARTEAM


26

5.4.1.3 Further CopyOut settings

CATIA links in SmarTeam

In SmarTeam are two main types of links which are defining the relation of the CATIA objects

to each other.

1) Composed of

These links are basically reflecting the hierarchical structure of CATIA products and parts.

Fig. 18: SmarTeam Links “Composed of”

2) CATIA Links

These links are links between parts, products and drawings with cannot be depicted by a

CATIA hierarchical structure. This are links between CATIA objects like the relation between

drawings and the referenced parts and products, or inter part links by using the duplicated

objects in other parts, and others.

Fig. 19: SmarTeam Links “CATIA Links”

CopyOut sub nodes

Fig. 20: Example nodes for further copy out settings (Xerlin editor)

PLMSYSTEM SMARTEAM


27

Table 7: SmarTeam Integration, copy out sub nodes


overwrite Defines if the root part / product /

drawing / model should be

overwritten on the destination file

system. The root is the one that is

selected in SmarTeam for

performing the Q-Checker

operation.

XML sub node:

Possible values: YES | NO

Default value: NO

ATTENTION:

If it is set to NO and the model already exists

on the file system the application is terminated.

The models will not be checked by Q-Checker

drawinglinks Copy out linked CATIA files that

are referenced by CATDrawings.

This enables all types of links for

copy out.

XML sub node:


Default value: NO

productlinks Copy out linked CATIA files that

are referenced by CATProducts

This enables all types of links for

copy out.

XML sub node:


Default value: NO

partcontextlinks If drawing or product links are

enabled with this option, it can be

defined if the “CATIA Links”

should be resolved for CATPart

or not. The “Composed of” links

are resolved any way.

XML sub node:


Default value: YES

productcontextlinks Same as partcontextlinks

but for CATProduct

XML sub node:


Default value: YES

drawingcontextlinks Same as partcontextlinks

but for CATDrawing

NOTE:

If this is not enabled, the linked

documents for CATDrawings will

not be found.

XML sub node:


Default value: YES

overwritelink

Defines if files that are referenced

by CATDrawings or CATProducts

are to be overwritten (according

to drawinglinks and

productlinks).

XML sub node:


Default value: NO

NOTE:

If the value for the attribute is set to NO and

the model already exists on the file system, the

file is not overwritten and will be used.

PLMSYSTEM SMARTEAM


28


copyoutlevel Defines the level of parts and

subassemblies which should be

copied out (if productlinks,

drawinglinks are enabled).

XML sub node:

Possible values: 0 – n

0: all parts and subassemblies are copied out,

regardless the level

1: all parts and subassemblies directly below

the assembly root, no parts which are in

subassemblies are copied out

n: defined level of parts and subassemblies

are copied out

Default value: 0

UniqueSubDir For each CATIA model including all its linked model one unique sub directory will be created. The name of the sub directory includes a time stamp of the time when the copy out started.

5.4.2 AddCopyOutFileTypes

By default, only the following CATIA file types will be copied out of SmarTeam:

• CATPart

• CATProduct

• CATDrawing

In some cases, other file types might be needed (e.g. CGR.) The copy out of these file types

can be defined under the following sub nodes:

///

NOTE

The file types which are defined under this sub node cannot be used for starting

Q-PLM.

They are only copied out in case if product or drawing links as well as part,

product or drawing context links are enabled.

For each desired additional file type for copy out, a sub node must be created.

The Name attribute of this node must be a unique identifier for the file type and the Value

attribute must be the description of the related SmarTeam file type. This description value is

defined in the SmarTeam “File Type” lookup table. Refer to picture below.

PLMSYSTEM SMARTEAM


29

Table 8: Example CGR File Type for SmarTeam

Name (Key) Example Value (SmarTeam Description) Example

CGR CATIA cgr

The CATIA file types are defined in SmarTeam by the Lookup Table “File Type”. The File

Type Lookup Table can be accessed by:

SmarTeam Menu: Admin -> Lookup Tables … -> File Type

Fig. 21: SmarTeam File Type Lookup Table for CATIA cgr

5.4.3 CopiedFileDeletion

The copied file deletion settings are under the following sub node:

PLMSYSTEM SMARTEAM


30

///

Fig. 22: Example sub node of "CopiedFileDeletion” (Xerlin editor)

With this setting all files which were copied out of SmarTeam can be deleted.

Table 9: SmarTeam Integration, file deletion settings

Sub node name Value Description

UniqueSubDir yes / no If it is set to yes, the unique sub directory will be removed.

The creation of the unique sub directory must be enabled with

the node CopyOut

If the unique sub directory is used and if it will be deleted with

this setting, no additional setting for the file deletion is needed.

CatiaFiles yes / no If it is set to yes, all the CATIA files which were copied out by

Q-PLM will be deleted.

DerivedFormat cgr

png

drw

pdf

By default, SmarTeam copies the derived formats in addition

to the CATIA files into the copy out directory. All these files

can be deleted with created a node with the desired file

extension.

Example for deleting cgr files:

5.5 Dialog settings

5.5.1 MessageBox

All message boxes from the Q-PLM SMARTEAM INTEGRATION can be suppressed.

For customizing the message box behavior choose the node:

///

For each module, there is an "Attribute" sub node.

PLMSYSTEM SMARTEAM


31

Table 10: SmarTeam Integration, message box behavior

Name Default value Description

QCIntegration true Main Q-PLM SmarTeam Integration module.

QCWorkFlow true Q-PLM SmarTeam Integration module for SmarTeam

Workflow

EmptyQCTab true Q-PLM Module for Clearing Q-Checker Attribute Profile

Card.

ResultMsgType - Type of the result message window. By default, this is

a simple message box.

If it is set to the value: TextWindow

a window with a text box appears, this text can be

copied to the windows clip board.

These settings are for the modules which are directly integrated into SMARTEAM

INTEGRATION. For the successive processes these settings have no influence. For

suppressing the message boxes of the successive processes refer to section “Show

Message Boxes”.

5.5.2 NoResultMsgIntAttr

The message boxes from the Q-PLM SMARTEAM INTEGRATION can be suppressed due to

Q-PLM internal attributes.

For customizing the message box behavior choose the node:

///

node with the name of and internal Q-PLM attribute and value. If the Q-PLM

result value of this internal Q-PLM attribute will match to the value which is defined in this

node the message box will be suppressed.

Example:

Suppress result message box if it was checked with a defined profile data, like "NO_CHECK"

for this example:

actProfData="NO_CHECK"

PLMSYSTEM SMARTEAM


32

Fig. 23: Example sub node of "NoResultMsgIntAttr” (Xerlin editor)

Suppress result message box if the full check run was OK:

actRCProcJudge="0"

5.6 Report

By configuring buttons for SmarTeam Toolbar or in the Profile Card, Q-Checker reports can

be viewed with an external viewer outside SmarTeam. For creating the SmarTeam buttons

please refer to the related chapter of Q-PLM_SmarTeam_Customization_5.7.x.pdf. In

addition, some configuration must be done in the node:

///

Fig. 24: Xerlin, Example node and sub node of "Report”

Table 11: SmarTeam Integration, report sub nodes


name Value of document name

attribute

Default value: Q-Checker HTML Report

PLMSYSTEM SMARTEAM


33


HTMLViewer Command for HTML viewer Example calling QPLMShowReportClient.bat of

Q-PLM installation:

/Parameter>

copydir Defines the copy out destination

for report files

If this is no defined the directory of the general

CopyOut setting is used.

5.7 PDM/PLM attribute value settings

In general, the attribute values are set by the sub nodes of

////

For some defined behaviors of the PDM/PLM system the quality attributes can be overwritten

by some special settings.

5.7.1 EmptyQCTabActions

For clearing the Attribute Profile Card and unlink the attached Q-Checker reports the settings

of the nodes are read. In these nodes the attribute names for cleaning, the report

and other settings are defined. By default, all nodes for lifecycle and manual check

are read. For default actions refer to chapter 5.2 “Action settings”.

The nodes for clearing the Attribute Profile Card can be defined different from the

standard, using this node:

///

Possible sub nodes names:

• IgnoreDefault

• Action

• UnlinkReport

PLMSYSTEM SMARTEAM


34

5.7.1.1 nodes definition

The default nodes can be ignored by setting the following sub node:

This node can contain sub nodes for additional actions. The name of the

attribute must be "Action”, the value of the attribute is the name of the action.

Example:

Let’s assume an additional action "DBTrigger” is to be defined. For this action an

sub node has to be defined:

Fig. 25: Xerlin sub node of "EmptyQCTabActions”

5.7.1.2 Unlink report

All the links to the Q-Checker reports are kept by default. With the Empty Tab call the reports

can be unlinked with the following setting:

5.7.2 EmptyQCTabAttrValues

By clearing the Attr ibute Profi le Card with Q-PLM the values of the attributes are set to

empty value. If these attributes should not be set to empty, this can be defined by using this

node:

PLMSYSTEM SMARTEAM


35

///

This node can contain sub nodes which defines the SmarTeam attribute name

and the value which should be set when the Attribute Profile Card will be cleared. Any

attribute can be set to a defined value, not only Q-PLM attributes.

Fig. 26: Xerlin, Example sub node of "EmptyQCTabAttrValues”

5.7.3 AttributeDefFailure

Attributes and their values which should be set in case of Q-PLM Failures. This can be done

by customizing the following node:

//

The attributes can be defined in the same way as EmptyQCTabAttrValues,

please refer to the related chapter for more information.

5.7.4 AttributeDefTimeout

Attributes and their values which should be set in case of Q-PLM Timeout. This can be done

by customizing the following node:

//

The attributes can be defined in the same way as EmptyQCTabAttrValues,

please refer to the related chapter for more information.

5.7.5 CheckTimeStamp

For identifying if a model is already check or if the check is out of date one or more

timestamp attributes are used. The sub nodes of CheckTimeStamp are defining these

attributes and the behavior of timestamp validations.

Customize the sub nodes of:

///

PLMSYSTEM SMARTEAM


36

With Q-PLM SmarTeam different timestamps have to be checked or used for SmarTeam

query, especially for the JobCheck.

The attribute(s) which should be used for the timestamp check, these are the Q-Checker

check time and date attributes are defined in the sub node(s) with the name

"PLMAttrbute”. This has to be set to the name of the desired SmarTeam attribute(s). If these

are string attributes the conversion to date/time has to be defined in the sub nodes for type

conversion, refer to chapter 5.8.4 TypeConvert.

Fig. 27: Xerlin sub node of "CheckTimeStamp”

There can be a time gap between the Q-Checker check time and the time of the SmarTeam

update. For taking care of this time gap can be configured in the

UTCTimeGapValue node. The time which is defined in this node is in seconds.

Fig. 28: sub node of "CheckTimeStamp” (Xerlin editor)

With the timestamps it must be differed between the local time and the UTC time. In general,

the time and dates which are stored in the data base are in UTC. The time which is provided

to the user is the local time.

The time gap between the current local time and UTC is defined in the

UTCTimeGapFrom node.

PLMSYSTEM SMARTEAM


37

Fig. 29: sub node of "CheckTimeStamp” (Xerlin editor)

For this node the following values can be defined:

Table 12: UTCTimeGapFrom values

value Description

system Time gap between local and UTC time is calculated be the

operating system where the application (client) is running.

Attention: The database might be running on another time zone

than the client application. In this case the calculation of the time

gap can be wrong.

db Time gap between local and UTC time is calculated from the

SmarTeam data base.

Attention: It might be that the SmarTeam function for this returns

the wrong time gap. It is possible that the difference to the summer

time is not calculated. In this case the calculation of the time gap

can be wrong.

none No time gap between UTC and local time

"integer value”

e.g: 60

Defined time gap in minutes

Depending to the setup of the database and SmarTeam the time gap between UTC and local

time must be considered. The time gap can be set for different operations. This is defined in

separate nodes:

Fig. 30: node for using time gap (Xerlin editor)

Table 13: Time gap settings


UseTimeGapFile yes Use the time gap calculation for the file modification time

of files which are stored in SmarTeam data base. The file

modification time is usually in UTC.

PLMSYSTEM SMARTEAM


38


UseTimeGapQueryServer yes Use the time gap calculation for query for SmarTeam data

base, if SmarTeam is launched in server mode, e.g.

modification date. The Q-PLM BatchJob is running in

server mode by default, if no other SmarTeam session is

already open. In server mode the values of the time

attributes are usually returned.

UseTimeGapQueryClient no Use the time gap calculation for query for SmarTeam data

base, if SmarTeam is launched in client mode, e.g.

modification date. In client mode the values of the time

attributes are usually returned in local time in. But with

some multi site configurations it can be returned in UTC.

5.8 PLM/PDM attribute conversion and mapping

5.8.1 LookupAttrReplExclude

Attributes which are defined by SMARTEAM Lookup Tables have integer values instead the

string values which are defined in the Lookup Tables. Q-PLM is replacing all integer values

by the corresponding string values for Q-PLM configuration issues. This replacement is only

Q-PLM internal and does not affect SMARTEAM in general. Due to some configuration or

processing reason it might be necessary to bypass this replacement. This can be done by

customizing the following node:

//

Add a sub nodes for each attribute which should be bypassed.

The XML attribute name is identifying if it is a document or project attribute:

name=”Doc”: document attribute name=”Prj”: project attribute

The XML attribute value defines the name of the document or project attribute for which

the replacement should be bypassed.

Example:

The value of project attribute TDM_SF_SECURE_LVL should not be replaced.

Value of TDM_SF_SECURE_LVL:

• with replacement: NotLimited

• without replacement: 0

Configuration for bypassing the replacement:

PLMSYSTEM SMARTEAM


39

Fig. 31. sub node of "LookupAttrReplExclude” (Xerlin editor)

5.8.2 LookupTNPrj

Obsolete

5.8.3 LookupTNDoc

Obsolete

5.8.4 TypeConvert

The sub nodes of TypeConvert defines which attributes should be converted into a other

format than string for Q-PLM internal use.


///

For each attribute which should be converted an node must be created. The

name of the node is the name of the attribute and the value is the format type. The following

format types are possible:

datetime for formats which combines date and time in one attribute

date for date formats (until Q-PLM 3.3.1 combined date and time format, in later

Q-PLM releases date format only)

time for time formats

int for integer

PLMSYSTEM SMARTEAM


40

Fig. 32: sub nodes of "TypeConvert” (Xerlin editor)

5.8.5 UserIdMapDoc

The sub nodes of UserIdMapDoc defines which id attribute of a document should be

mapped into a other document attribute. Both the id attribute and the attribute to which this

should be mapped have to be defined in a AttributeName sub node.


///

Example:

The attribute USER_ID_MOD should be converted to the attribute USER_EMAIL. This can be

useful for external e-mail programs.

XML structure:

…

…

PLMSYSTEM SMARTEAM


41

Fig. 33: sub nodes of "UserIdMod” (Xerlin editor)

These mapped attributes can be used in the sub nodes. For this the

names of source and destination attributes have to be jointed with a slash. The real

SmarTeam attribute names have to be used for that. E.g.:

USER_ID_MOD/USER_EMAIL

This can be used for example to store the email address of the user which have modified the

CATIA model into Q-Monitor database.

Fig. 34: mapped user id attribute (Xerlin editor)

5.9 Check stage and query settings

5.9.1 ManualCheck

Enabling / Disabling / ByPass Manual Check

PLMSYSTEM SMARTEAM


42

As prerequisite for the manual Q-CHECKER run, SMARTEAM has to be configured for it. Refer

to Q-PLM_SmarTeamIntegration_x.pdf.


///

The manual check can be enabled / disabled for items which are in the following state:

Table 14: SmarTeam Integration, ManualCheck State name table

State name attribute

New new

Checked out checkedout

Checked in checkedin

Released released

Possible values are:

Table 15: SmarTeam Integration, ManualCheck State value table

value Description

YES Check can be executed

NO Check cannot be executed and a warning message will occur

BYPASS Check will not be executed no warning message

For the lifecycle states "checked in” and "released”, the check of the models are also

dependent on the vault setting (for the vault setting refer to section 0 “

Table 35: maxmodels Attribute

Attribute name Value Constraint

maxmodels Number of models Number of models which should be checked in one

Q-Checker session. Q-PLM is preparing and

launching multiple Q-Checker sessions. Each session

has (maximum) this defined numbers of models.

Only possible if condition=multi

Example:

36 model to check, maxmodels=10

=> 3 x Q-Checker session with 10 models, 1 x Q-

Checker session with 6 models

Vault Attribute”.

PLMSYSTEM SMARTEAM


43

Example

• Disable the manual check for released items:

• Choose the node

• Change to

Fig. 35: node of "ManualCheck" (Xerlin editor)

5.9.2 CheckinCheck

Enabling / Disabling / ByPass Checkin Check

As prerequisite for the Q-CHECKER run during check in has to be configured for it. Refer to

Q-PLM_SmarTeamIntegration_x.pdf.

The check during check in can be configured due to the state. With this setting it is possible

for example to perform a Q-PLM / Q-Checker run only for models which are in the state new,

the other models are not checked during check in.


///

The check in check can be enabled / disabled for items which are in the following state:

Table 16: SmarTeam Integration, CheckinCheck State name table


New new


Possible values are:

Table 17: SmarTeam Integration, CheckinCheck State value table

value Description

YES Check will be executed

PLMSYSTEM SMARTEAM


44

value Description

NO Check cannot be executed, a warning message will occur and it is not possible to

perform a check in operation

BYPASS Check will not be executed check in operation is possible

Example

• Enable check in check for new items only:

• Choose the node

• Change to

Fig. 36: node of "CheckinCheck" (Xerlin editor)

5.9.3 JobCheck

Enabling / Disabling Batch Job Check


///

5.9.3.1 Enabling / disabling file states

The Batch Job Check can be enabled / disabled for items which are in the following state:

Table 18: SmarTeam Integration, JobCheck State name table



Checked in checkedin

Released released

The configuration of these attributes are the same as the once for Manual Check, refer to

chapter 5.9.1 " ManualCheck”.

PLMSYSTEM SMARTEAM


45

5.9.3.2 Enable file types for query

name attribute value attribute

CATIAFileTypeWhereQuery YES / NO

Adds the CATIA file types for the specific SmarTeam class to the WhereQuery of the Batch

Job Check. The file types must be defined in the “CATIAFileTypes” node.

Example of Dsp.xml defintion:

//

…

Example of a where query section with CATIA Part file type:

(F.CLASS_ID=100).and(F.STATE=3orF.STATE=1).and(F.MODIFICATION_DATE>=

2018/12/31|23:00:00.000andF.MODIFICATION_DATE=

2009/09/25andF.MODIFICATION_DATE

PLMSYSTEM SMARTEAM


46

For the SmarTeam BatchJob the Where Query can be enhanced with the following node:

///

Fig. 37: Xerlin node

The additional Where Query can be defined with following attribute nodes:

Table 19: AddJobWhereQuery sub nodes

Attribute Mandatory Description

Separator YES Logic operation like:

AND, OR, … bracket etc.

No default

Name NO Name of the object. In general, this is the attribute respectively the

column name of the database table.

Default: empty

Operator NO Operator like:

=, =, …

Default: empty

Object NO Object / value

Default: empty

CaseSensitivity NO Case sensitivity

false / true

Default: false

Role NO Role (SmarTeam standard is "F")

Default: empty

If more than one Where Query extension in the same query definition is needed, they can be

defined one after the other. The Separator node defines a new query extension.

PLMSYSTEM SMARTEAM


47

Example: The Q-Checker run, in a multisite environment should only be executed for 2

defined sites (TDM_SITE_ID=1 or TDM_SITE_ID=2).

The configuration for this additional query is:

Example of the resulting where query (Black: Standard Query, Blue: Query Extension)

(F.CLASS_ID=684).and(F.STATE=1).and(F.MODIFICATION_DATE>=2009/09/25andF.MOD

IFICATION_DATE

PLMSYSTEM SMARTEAM


48

The configuration for this two additional query is:

Batch Job call with AddJobWhereQuery as input parameter (AddJobWhereQuery_1):

Fig. 39: Windows command line Call of Batch Job executable with AddJobWhereQuery

Example of the resulting where query 1 (Black: Standard Query, Blue: Query Extension)

(F.CLASS_ID=684).and(F.STATE=1).and(F.MODIFICATION_DATE>=2009/09/25andF.MOD

IFICATION_DATE=2009/09/25andF.MOD

IFICATION_DATE

PLMSYSTEM SMARTEAM


49

To bypass the user authorization, choose the node:

///

To bypass the authorization, the sub nodes for the operation can be set to

"no". If the authorization should be checked to have to be set to "yes".

Name of attribute sub nodes:

• Add

• Update

• Delete

• Link

• Unlink

Possible values of attribute sub nodes:

• yes

• no

Fig. 40: sub nodes of "CheckAutorization” (Xerlin editor)

5.10.2 InvokeScripts

With SmarTeam, scripts can be launched for different operations. The launch of the different

SmarTeam scripts can be configured.

To bypass the user authorization, choose the node:

///

PLMSYSTEM SMARTEAM


50

To bypass the SMARTEAM scripts execution, the sub nodes for the operation

can be set to "no”. If the authorization should be checked to have to be set to "yes”.

Name of attribute sub nodes:

• Add

• Update

• Delete

• Link

• Unlink

• CheckIn

• Approve

• NewRelease

Possible values of attribute sub nodes:

• yes

• no (default)

Fig. 41: sub nodes of "InvokeScripts" (Xerlin editor)

CAUTION: All SMARTEAM Scripts for the enabled operation will be invoked.

This can cause some unexpected behaviors like recursions, endless loops, and

other strange behavior. Look to the SMARTEAM Scripts which will be called by the

operation carefully to avoid these side-effects

5.10.3 Password crypt program

The password crypt program ciphers a string into a cryptic string which can be use by Q-PLM

for the login information.

PLMSYSTEM SMARTEAM


51

For more information about the crypt program refer to the Q-PLM documentation for the

specific PDM system (Q-PLM_SmarTeam_Customization_x.pdf).

5.11 Maturity change, lifecycle operation and workflow settings

5.11.1 AdminRelease

The sub nodes under the node define the settings for Maturity Change with

admin release option. If this option is enabled and the value of the attribute matches to the

value that is defined in this XLM sub node, it is possible to promote the object with an NOT

valid data quality. It is highly recommended that a restricted group of people like design

manager or project manager can modify this attribute. In addition, several SmarTeam

settings and scripts must be customized please refer Q-PLM SmarTeam installation and

customization documentation (Q-PLM_SmarTeam_Customization_x.pdf).

For admin release settings, choose the node:

///

Fig. 42: sub nodes of "AdminRelease" (Xerlin editor)

Settings of the nodes

Table 20: SmarTeam Integration, AdminRelease sub nodes

Name value

enable Enables / disable Admin Release

Yes: enabled

No: disabled

AttributeName Attribute name of the attribute which controles the Admin

Relase

Default: CN_QPLM_ADMIN_RELEASE

PLMSYSTEM SMARTEAM


52

Name value

AttributeValue Attribute value of the attribute which enables the maturity

change for NONE proper data quality

true

5.11.2 WorkFlow

The SMARTEAM workflow settings are sub node under the following node:

///

With the SMARTEAM workflow every document has its own return value for the workflow.

Regarding to this return values, the step of the workflow can be accepted or rejected.

Possible return values:

• Operation not appropriate

• Operation not performed

• Operation executed successfuly

• Operation executed NOT successfuly

If a document of the workflow i s no t a CATIA model, part, assembly or drawing, the

operation for the document can be configured with the sub node

Table 21: Possible values of ResultForNoCatia

Value Description

notAppropriate The return of the workflow for this document is set to:

Operation not appropriate

(default behaviour)

notPerformed The return of the workflow for this document is set to:

Operation not performed

executedSuccessfuly The return of the workflow for this document is set to:

Operation executed successfuly

executedNotSuccessfuly The return of the workflow for this document is set to:

Operation executed NOT successfuly

If the document of the workflow IS a CATIA model, part, assembly or drawing the result value

can be configured by the node

PLMSYSTEM SMARTEAM


53

Table 22: Possible values of ResultForCatia

Value Description

Success The return of the workflow for this document is depending to the

process result.

Q-PLM was not executed:


Q-PLM was executed and the Q-Checker result was OK


Q-PLM was executed and the Q-Checker result was KO


(default behaviour)

Execute The return of the workflow for this document is depending to the

process result:

Q-PLM was not executed:


Q-PLM was executed, regardless to the Q-Checker result


notAppropriate The return of the workflow for this document is set to:

Operation not appropriate

notPerformed The return of the workflow for this document is set to:


executedSuccessfuly The return of the workflow for this document is set to:


executedNotSuccessfuly The return of the workflow for this document is set to:


5.12 Batch attributes settings

Settings which are pass to the *Bat.xml file.

5.12.1 BatAttrsDoc

Document attributes which are pass to the *Bat.xml file.

CAUTION: Do not customize these values

5.12.2 BatAttrsPrj

Project attributes which are pass to the *Bat.xml file.

PLMSYSTEM SMARTEAM


54


5.12.3 BatAttrsCN

Attribute header names which are pass to the *Bat.xml file.


5.12.4 BatAttrsCL

Class names which are pass to the *Bat.xml file.


SMARTEAM SPECIFIC SETTINGS


55

6 SmarTeam specific settings

6.1 General

In general, the sub nodes of are independent from the PLM System

(SmarTeam). In some special cases SmarTeam specific settings might be necessary. These

specific customizations are described in this chapter. All the general and independent

settings are defined in the main chapter “ nodes”.

6.2 Actions

6.2.1 Vault Attribute

In this chapter only the SmarTeam specific customizations of the CopyOut attribute is

described.

The copy-out settings are under the following sub node:

///

The sub nodes are defining the behavior how the CATIA models should be copied out of

SmarTeam vault. The CATIA models must be copied out of the SmarTeam vault for having

them available on a file system which can be used for the Q-Checker check run.

The definition, if the files must be copied out of the SmarTeam vault or not is defined in the

related node.

The vault attribute of the Action node defines if the copy out settings are used for the action

or not. Please refer to the chapter “Default Action nodes” for the list of Actions which used for

the different operations.

The settings for the copy-out operation are needed only in case that the vault attribute is

set to "copy_out”, "copy_out_update” or "new_revision”:

///

(Refer to section 0 "



56

Table 35: maxmodels Attribute

Attribute name Value Constraint

maxmodels Number of models Number of models which should be checked in one

Q-Checker session. Q-PLM is preparing and

launching multiple Q-Checker sessions. Each session

has (maximum) this defined numbers of models.

Only possible if condition=multi

Example:

36 model to check, maxmodels=10

=> 3 x Q-Checker session with 10 models, 1 x Q-

Checker session with 6 models

Vault Attribute”).

If the vault attribute is set to "none” no copy out will be done and the settings of

CopyOut is not used.

6.2.2 Attaching Q-Checker Report

In this chapter only the SmarTeam specific sub node customizations of the HTML report

node is described.

HTML report settings are sub nodes of:

/////

Please refer to the related main chapter of “ nodes” in addition.



57

Fig. 43: Xerlin, HTMLReport node

Table 23: SmarTeam Integration, HTMLReport sub nodes

Name value

name Q-Checker HTML Report

This is a fixed name and should not be modified.

classname Name of the SmarTeam class which the HTML report document belongs to.

Default: Document

linkname Name of the SmarTeam link table between the HTML report document and the

CATIA files

Default: Documents Documents Relation

filetype SmarTeam File Type of the HTML report document. The value is the Description

attribute of the corresponding File Type from SmarTeam Lookup Table. Refer to

chapter “ CATIAFileType” for File Type Lookup Tables.

Default: HTML

revision Defines the revision and link behavior for the new created HTML Reports.

Possible values

• -

Creates a new HTML Report with a new ID. The preview HTML reports are still

linked to the CATIA object.

• new

Creates a new Report with the same ID but with the next Revision. The preview

HTML reports are still linked to the CATIA object.

• replace

Creates a new HTML Report with a new ID. The links to the preview HTML

reports will be deleted.

Old HTML Report

New HTML Report

Note: The name attribute must be set to Q-Checker HTML Report

otherwise the replace (remove existing links) will not work.

Default: -



58

Name value

lifecycle Defines the SmarTeam lifecycle operation (State) for the created HTML Report.

Possible values

• checkin

Should not be used in combination with revision=new, because the object

must be released before a new release can be created. Otherwise the HTML

Report object cannot be created and the following message will occur:

• approve

Default: approve

savesequence Increment sequence for report revision.

Queries the next Revision for the report and increments it.

Possible values

• no

No incrementation

• yes

Incrementation of the revision

prjlink Identifies if the report should be linked to the project to which the related CATIA

object is assigned.

Possible values

• no

No project link

• yes

Link to the project of the related CATIA object

NODES


59

7 nodes

This is the main node for process description (Q-Checker processing).

Figure 44: element in Xerlin editor

7.1 NativeLibs

Use the sub nodes of to configure the license behavior and system native

libraries for license. These nodes are needed if the license settings cannot be configured by

system or Java settings / variables. They are only needed for Q-PLM modules which are

based on Java.

For Q-PLM modules which are based on CAA (for example PDM Save), these nodes are not

needed and the license settings must be configured inside the related CATIA Environment

file, please refer to the related documentation.

7.1.1 License type

The license type can be set with the attribute licmode.

Figure 45: element with attribute "licmode" in Xerlin

NODES


60

Possible values:

Value Description

(Empty) System license setting are used. If no license mode is set via system or

java variable, DSLS is used.

DSLS DSLS license

If this attribute is set, it is overwriting the license settings. Refer to picture below:

Figure 46: Overwriting license settings

7.1.2 node

With the node, system native libraries which should be loaded can be configured

for the different operating systems. These nodes are only needed if the libraries cannot be

loaded by java, because the path for loading native libraries is not configured by system or

java settings / environment.

The attribute "name" defines the operating system for which the sub nodes are configured.

Figure 47: element with attribute "name" in Xerlin

Possible values of the name attribute:

NODES


61

Value Description

intel_a Windows 32 bit

win_b64 Windows 64 bit

aix_a AIX 32 bit

aix_a64 AIX 64 bit

hpux_a HP-UX

linux_32 LINUX 32 bit

linux_64 LINUX 64 bit

macos_32 MAC 32 bit

macos_64 MAC 64 bit

Not for all of the operating systems above the native libraries might be available with the

installation package. In general, only the needed once are delivered.

7.1.2.1 nodes

These nodes are defining the full qualified name (full path + file name + extension) of the

system native library which should be loaded.

Figure 48: element for Windows 64 bit in Xerlin

System native library which is needed for the license handling:

TCAJLMLibMng.dll

In some cases, the system doesn’t load the dependent libraries. Therefore, it is necessary to

add all needed libraries in the order of loading to the node.

NODES


62

Figure 49: all elements for Windows 64 bit with DSLSV5 in Xerlin

7.2 nodes

With the nodes it can be configured which Q-Checker version is to be started

with which CATIA version and with which settings. It is possible to define several

nodes for different combinations of Q-Checker and CATIA versions. For the

standard installation the default node is to be configured.

For most of these nodes, different sub node types and multiple sub nodes can be used. This

is depending on the node. For more information refer to the detailed Q-PLM_Dsp.xml

documentation.

It is possible to define different nodes and employ them depending on the

lifecycle operation or PDM/PLM document/project attributes.

7.2.1 CATIA Q-Checker default sub node

The default nodes for the different CATIA versions are:

Node Description

DEFAULTV4 Default ProfileData for CATIA V4 settings



Example of a node:

///

Table 24: nodes

Node Description

CATEnvDir Directory for the CATIA environment

NODES


63

CATEnv CATIA environment file

QCheckerStart Command for Q-Checker start

QCBatchStart Command for program after Q-Checker execution

was performed, this is used for PDM update

ENVIRONMENT Q-Checker environment

PROFILE Q-Checker profile

QCTmpDir Directory for temporary files

ResultJudge/OKAssessments OK assessments definition, see section below

ResultJudge/OKReturnCodes OK return code definition, see section below

ResultJudge/ResultFileData Q-Checker output file result processing

Figure 50: element with name "DEFAULTV6" in Xerlin

7.2.2 Result judging and validation

The evaluation if the results of the operation are OK or not can be done in two different

nodes: or .

7.2.2.1 / node

The sub nodes of the / node specify which assessments

should be considered to be a successful Q-Checker check result. The assessments, which

are not defined in this node, will be considered NOT OK.

Customize in relation to the Q-Checker environment which is used with

this node. For this create or change sub nodes of .

NODES


64

Figure 51: node in Xerlin

7.2.2.2 / node

The sub nodes of / specify which Q-Checker return codes

are to be considered successful results. The assessments which are not defined in this node

will be considered NOT OK.

Customize the in relation to the Q-Checker return codes which

should be acceptable. For this create new sub nodes of or modify the

existing ones.


7.2.2.3 / node

The node of / and its sub nodes specify which conditions are to be

considered with results. The conditions which are not defined in this node will be considered

NOT OK.

The / defines the source attribute for the comparison.

NODES


65

Table 25: node attributes

Attributes Value Description

name Attribute

name

Name of the attribute for validation. This must match to

an attribute name of the type which is defined with the

"source" attribute.

type STR | INT Type of the attribute, string or integer

source ReportAttr |

SystemAttr |

DocAttr |

…

Source of the attribute for validation. The attribute which

can be used can be from different sources. This can be

for example an attribute of the Q-Checker result file or

one document attribute of the PDM system.

Example: MODEL_ASSESSMENT attribute of the Q-Checker Report


The sub node of // specifies the values for the

comparison. The values of the attribute which is defined in the /

node will be compared to the values which are defined in the

// sub nodes .

Table 26: node attributes

Attributes Value Description

name Attribute

name

Name of the attribute for validation. This must match to

an attribute name of the type which is defined with the

"source" attribute.

retvalue integer Value which should be returned if the comparison

matches. In general this should be 0

cond EQ | NE |

GT | LT | …

Condition which should be used for the comparison like

equal, not equal, greater, less, …

NODES


66

source Discrete |

ReportAttr |

SystemAttr |

DocAttr |

…

Source of the attribute for validation. The attribute which

can be used can be from different sources. This can be

for example an attribute of the Q-Checker result file or

one document attribute of the PDM system.

Example, MODEL_ASSESSMENT attribute of the Q-Checker Report should be equal to OK.

In this case the value 0 should be returned which means that this condition will pass the

check.


7.2.2.4 / and / node

The sub node node defines which Q-Checker output file is to be used for the

result processing.

Select in the desired profile the following node:

////

//


The following settings are available:

• DBReport

NODES


67

• QCReport

• QcExSeal

• none

With Q-CHECKER version less than V1.14.1, the DBReport setting must be used. In this case

a special license is required. In addition, the writing of this output file must be enabled by a

Q-Checker setting.

For Q-CHECKER version V1.14.1 or higher we advise to use the QCReport setting.

Interpreting external seal file the QcExSeal setting must be used.

Out of this report files, the report attributes are taken for the further processing. The

Q-Checker assessment is taken out of these files. In addition, they can be used by a

node for some Q-PLM_Dsp.xml nodes. For example, in order to set PDM/PLM

system attributes to the values of report attributes.

Figure 56: Using report attributes of result files in Xerlin

For the different report files, the following report attributes are available.

Table 27: Report attributes of result files

ReportAttr DBReport QCReport QCExtSeal

CHECK_ID Yes No Yes

MODEL_DIRECTORY Yes Yes Yes

MODEL_NAME Yes Yes Yes

MODEL_CAD_VERSION Yes Yes Yes

MODEL_USER Yes No Yes

NODES


68

ReportAttr DBReport QCReport QCExtSeal

MODEL_DIMENSION Yes No Yes

MODEL_SIZE Yes Yes Yes

CHECK_SEAL Yes Yes Yes

RETURN_CODE Yes Yes Yes

MODEL_ASSESSMENT Yes Yes Yes

TOTAL_WEIGHT_SUM Yes No Yes

CHECKING_DATE Yes Yes Yes

CHECKING_TIME Yes Yes Yes

PROFILE_NAME Yes Yes Yes

CHECK_USER Yes Yes Yes

CHECK_GROUP Yes Yes Yes

CHECKING_TOOL Yes Yes Yes

HEALING_STATUS Yes Yes Yes

Additional customer

defined collumns

e.g.:

CHECKING_MODE

CUSTOMER_NUMBER

Yes No No

7.3 Actions

7.3.1 General

The different actions are sub nodes of:

//

For different PDM/PLM systems standard actions are defined.

NODES


69

For certain PDM/PLM systems additional actions can be defined. This depends to the Q-PLM

API for the different systems. E.g. Q-PLM launched by a DB trigger or Manual check inside

the PDM system.

Figure 57: Example Action in Xerlin

This action names can be modified by node definition.

7.3.2 Default Action nodes

7.3.2.1 ENOVIA V6 / 3DExperience + CATIA V6

Table 28: Default nodes for ENOVIA V6 / 3DExperience + CATIA V6

Action node Description

ManualV6 This Action used if Q-PLM is called in case of manual check (Q-PLM

button in ENOVIA V6 / 3DExperience).

EDMSaveV6 Action which is used if Q-PLM is executed with the PDM Save

function inside Q-Checker.

MaturityChangeV6 This Action is executed during ENOVIA V6 / 3DExperience maturity

change, if Q-PLM is hooked to a maturity change trigger.

NODES


70

7.3.2.2 ENOVIA V6 / 3DExperience + CATIA V5

Table 29: Default nodes for ENOVIA V6 / 3DExperience + CATIA V5


ManualMx This Action used if Q-PLM is called in case of manual check (Q-PLM

button in ENOVIA V6 / 3DExperience).

EDMSaveMx Action which is used if Q-PLM is executed with the PDM Save


CheckInMx This Action is triggered in case of ENOVIA V6 / 3DExperience check

in operation for CATIA V5 models.

DBTriggerMx Default Action which is used for Q-PLM batch executions

MaturityChangeMX This Action is executed during ENOVIA V6 / 3DExperience maturity

change, if Q-PLM is hooked to a maturity change trigger.

7.3.2.3 SmarTeam

Table 30: Default nodes for SmarTeam



button in SmarTeam).

CheckInV5 This Action is triggered in case of SmarTeam check in operation for

CATIA V5 models.

ReleaseV5 This Action is triggered in case of SmarTeam release operation for

CATIA V5 models.

WorkFlowV5 Action which is used if Q-PLM is integrated into SmarTeam workflow.

DBTriggerV5 Default Action which is used for Q-PLM batch executions

7.3.2.4 ENOVIA VPM V5

Table 31: Default nodes for VPM V5



NODES


71


button in ENOVIA V5).




7.3.2.5 ENOVIA VMP V4

Table 32: Default nodes for VPM V4



button in ENOVIA V4).




7.3.3 Action attributes

7.3.3.1 Attributes for ProfileData and Q-Checker Profile

The node contains several attributes for defining which and which

Q-Checker profile are to be used.

Table 33: Attributes for and Q-Checker profiles

Attribute name Values Description

profdatadef string Default ProfileData. It is used for all

references of a node.

profdatattr string PLM attribute which contains the

Q-CHECKER profile name.

profdataloc none | document |

project | internal

Defines the if the ProfileData should be

defined by an attribute or if the default

setting should be used.

none: Default ProfileData

NODES


72

Attribute name Values Description

document: PDM document attribute

project: PDM project attribute

internal: internal attribute from Inf.xml

getattrprof true | false The *Inf.xml can contain the information

about the used Q-CHECKER profile:

/

This attribute triggers if it should be used or

not.

getmodelprof true | false The CATIA model can contain the

information about the last Q-CHECKER

profile. This attribute triggers if it should be

used or not.

The Q-Checker profile is calculated in several steps. If a Q-Checker profile is found in the

first step, this profile will be used. If not found, a next step will be executed to search the

profile. Order of the Q-Checker profile calculation:

1. Get profile with profdatattr and profdataloc

2. Get profile getattrprof from *Inf.xml, only if profdataloc="none"

3. Get profile from model (getmodelprof="true")

4. Get profile from profdatadef

NOTE: If a Q-Checker profile is found, it will be used in every case, regardless if it is valid or

not.

An invalid profile will cause a Q-Checker error.

7.3.3.2 Condition Attribute

The "condition" attribute of the node defines the constraint of the Q-Checker check

run. This is dependent to other Q-PLM settings as well as the integration and check process.

The following values have to be set for the described constraint:

NODES


73

Table 34: Conditio

Date post:	31-Jan-2021
Category:	Documents
Upload:	others
View:	7 times
Download:	1 times