Q-Checker for V5 Release 5.1 Migration Guide V2 to Release 5transcat-plm.com/pub/tcsoft/qplmV5_510/doc/migration.pdf · the CATIA specification tree. If the document type does not

Erst

ellt

am 2

8.06

.201

3

Q-Checker for V5 Release 5.1

Migration Guide V2 to Release 5

Dassault Systèmes 2 Q-Checker for V5 Release 5.1

1 Introduction ...................................................................................................................................... 1

2 Changes ............................................................................................................................................ 2

3 Compatibility with previous releases ............................................................................................... 4

3.1 Check environments ........................................................................................................................ 4

3.2 Check seals ...................................................................................................................................... 4

4 Migration .......................................................................................................................................... 5

4.1 Overview .......................................................................................................................................... 5

For system administrators ..................................................................................................... 5

For Q-Checker profile administrators ................................................................................... 5

4.2 Q-Checker settings in the CATIA environment .............................................................................. 6

4.3 Q-Monitor database ...................................................................................................................... 12

4.4 Q-PLM Dispatcher configuration ................................................................................................. 13

4.5 Preparations for importing a check environment ........................................................................ 16

4.6 Importing a check environment from Q-Checker Version 2 ........................................................ 17

4.7 Examining the imported environment ......................................................................................... 19

4.8 Criteria requiring special attention .............................................................................................. 24

4.8.1 Solid Feature with Child Elements ........................................................................................... 24

4.8.2 Product/Part Update and Perform Product/Part Update ........................................................ 26

4.8.3 Associative Elements (Parent/Children) in Specific Bodies .................................................... 28

4.8.4 Construction Order of Solid Features in Bodies ...................................................................... 31

4.9 Cleaning up the imported environment ....................................................................................... 33

4.10 Validation of internal check seals created in V2 .......................................................................... 33

4.11 Custom report templates .............................................................................................................. 35

4.12 Custom help pages ....................................................................................................................... 35

4.13 List of files ..................................................................................................................................... 36

IntroductionM

igra

tio

n G

uid

e
1 Introduction
This guide helps you to migrate from Q-Checker for V5 Version 2.x.x to Q-Checker forV5 Release 5.1.

Who should read this document?

• System administrators responsible for the installation of the Q-Checker application

• Profile administrators responsible for creating and maintaining Q-Checker environments and profiles

Section 1, 2 and 3 contain information for both audiences about changes in R5 andcompatibility with previous releases.

Section 4 starts with an overview of migration tasks specific to system and profile ad-ministrators, respectively.

Abbreviations in this document

The following abbreviations are used in this document:

• “V2” means Q-Checker for V5, versions 2.1.x to 2.19.x

• “R5” means Q-Checker for V5, release 5.1


ChangesM

igra

tio

n G

uid

e
2 Changes
This section outlines changes in Q-Checker for V5 Release 5.1 which are important toknow before you migrate from a previous release.

Note that this is no complete list of changes in release 5.1.

Creation of check environments

Check environments and profiles are created using the Q-Checker environment editor.The Q-Checker environment editor is only available on Windows.

Environment structure

The structure of check environments has changed.

In V2, environments contain admin profiles (“ADMIN”) and user profiles (“USR”).User profiles are located in the user directory and rely on other parts of the environmentlocated in the admin directory, which can be write-protected.

In R5, this structure has been changed. Now there are two types of environments, ad-min environments and user environments. Environments of both types are self-contained.This means:

• Users can create their own user environments and have access to all settings in these environments.

• Admin environments can be write-protected, which is useful for compliance with company standards.

Settings with a different scope

Some settings have changed their scope in R5:

Setting V2 R5

Element selection Profile setting, can be applied to criteria in this profile

Check environment setting, can be applied to criteria in any pro-file of this environment

Check conditions Criterion setting Check environment setting, can be applied to criteria in any pro-file of this environment

Check seal creation Default settings defined in the en-vironment, can be overridden by profile settings

Check environment setting, can be applied to any profile of this environment

Validation of internal check seals Profile setting CATIA environment setting


ChangesM

igra

tio

n G

uid

e

Q-Doctor Geometrical Healing

Q-Doctor Geometrical healing requires the installation of additional files. Q-Doctor isno longer included in the Q-Checker installation package. As before, a separate licenseis required to enable Q-Doctor geometrical healing.

Model type definitions Defined separately for every lan-guage (consistency not guaran-teed)

Same definitions for all languages (localized names are supported)

Model assessments and criterion weights

Defined separately for every lan-guage (consistency not guaran-teed)

Same definitions for all languages (localized names are supported)

Model assessment mode Profile setting Check environment setting

Setting V2 R5


Compatibility with previous releasesCheck environments

Mig

rati

on

Gu

ide
3 Compatibility with previous releases
3.1 Check environments

Starting with R5, check environments have a new format. Check environments from ear-lier releases can be imported into R5.

The import function creates a new check environment, which is independent from theoriginal V2 check environment. The import function does not change the V2 environ-ment.

It is not possible to convert a R5 environment into a V2 environment.

4 Migration, page 5

3.2 Check seals

External check seals

R5 can validate external check seals created with V2. For validation, the original V2check profile must be available.

In general, the check sum of environments imported from V2 differs from the checksum of the original V2 profile. R5 environments are therefore not valid with respect toexternal check seals created with V2, regardless of their settings.

Internal check seals

R5 can validate internal check seals created with V2. For this purpose, you need to spec-ify valid V2 profile checksums in the R5 environment.

4.10 Validation of internal check seals created in V2, page 33


MigrationOverview

Mig

rati

on

Gu

ide
4 Migration
4.1 Overview

Migration from V2 to R5 comprises these major steps:

For system administrators

1 Install Q-Checker for V5 Release 5.1.

For help with installation, please refer to the Q-Checker Installation Guide.

Installation Guide, Installing on Windows using the installer

2 Define additional settings for Q-Checker in the CATIA environment.

4.2 Q-Checker settings in the CATIA environment, page 6

3 When using Q-Monitor, update the database definition.

4.3 Q-Monitor database, page 12

For Q-Checker profile administrators

These steps require that Q-Checker for V5 Release is installed already.

1 Prepare check environments for import.

4.5 Preparations for importing a check environment, page 16

2 Import the check environment into R5.

4.6 Importing a check environment from Q-Checker Version 2, page 17

3 Examine the imported environment and review settings, if necessary.

4.7 Examining the imported environment, page 19

4 Clean up the imported environment (optional).

4.9 Cleaning up the imported environment, page 33

5 When using internal check seals, you can enable the validation of internal check seals created in V2.

4.10 Validation of internal check seals created in V2, page 33

6 When using custom report templates and criterion help in V2, you can include these in the imported R5 environment.

4.11 Custom report templates, page 35

4.12 Custom help pages, page 35

Imported environments are stored as user environments. To change a user environ-ment into an admin environment, move the environment directory into the admin path.


MigrationQ-Checker settings in the CATIA environment

Mig

rati

on

Gu

ide
Admin environment cannot be overwritten using the environment editor. After chang-
ing an admin environment, you need to move it to the admin path again.

4.2 Q-Checker settings in the CATIA environment

During installation of R5, the installer has created or modified a CATIA environment.This CATIA environment contains Q-Checker settings which are independent fromcheck environments and read at CATIA startup.

The following tables list all Q-Checker settings defined by environment variables. Lookfor these environment variables in the CATIA environment for V2, and define corre-sponding variables in the new CATIA environment for R5.

Certain environment variables have changed their name and values. Therefore it is notsufficient to copy variable definitions.

Environment variables for installation paths of the Q-Checker application and its components

V2 variable R5 variable Description/Values

QCPATH TCAQC_PATH Path where Q-Checker is installed.

QCLOAD TCAQC_LOAD Path to the Q-Checker load module.

QCADMIN TCAQC_ADMIN Path where Q-Checker admin environments are stored.

In R5, one or more paths can be defined.

When more than one path is specified, the names of environ-ments and other subdirectories must be unique across all specified paths.

QCUSER TCAQC_USER Path where Q-Checker user settings and user-defined check en-vironments are stored, for example in the home directory of the respective user.

(not available) TCAQC_RESOURCES Path where Q-Checker resource files are stored.

Resource files includes translation files for the environment ed-itor GUI and report templates.

If more than one path is specified, Q-Checker will use the first path or file where the required information is available. All sub-sequent paths and files are ignored.

QCDOC TCAQC_DOC Path to the Q-Checker manuals.

QCHTML TCAQC_HTML Path to the Q-Checker HTML online help.

QCREPORT TCAQC_REPORT Path where Q-Checker check reports are stored.



Mig

rati

on

Gu

ide

Environment variables for Q-Checker application settings

R5 variable name V2 variable name Description/Values

QCLIC TCAQC_LIC License system for Q-Checker

DSLS: DSLS license (default)

DSLUM: LUM license provided by Dassault Systèmes

TC: LUM license provided by Transcat PLM

QCLANGCAT TCAQC_LANG_CAT This setting controls the dependency of the Q-Checker lan-guage setting from the CATIA session language.

YES: Use the CATIA session language (only English, German or French). For other CATIA session languages, use English in Q-Checker.

NO: Users can select the Q-Checker language setting in the Q-Checker user settings.

(not available) TCAQC_SHOW_TOOLS Show buttons on the Q-Checker toolbars that are hidden by de-fault. Specify the keywords for the buttons to be shown, sepa-rated by comma.

PLUGINSTOQCENV: “Install current plugin set to a Q-Checker environment” button. This is a new setting in R5.

SPECTREETOXML: “Convert spec tree to XML” button

QCHIDETOOLS TCAQC_HIDE_TOOLS Hide buttons on the Q-Checker toolbars that are shown by de-fault. Specify the keywords for the buttons to be hidden, sepa-rated by comma.

InternalReport: “Display browser for internal check reports” button

AnalysisViewer: “Start analysis viewer” button

SealViewer: “Start check seal viewer” button

DeleteQCElements: “Delete all permanent marking elements” button

ModelTypeConfigurator: “Start model-type configurator” button

Example To hide the “Start analysis viewer” button and the “Start model-type configurator” button, define the variable:

QCHIDETOOLS=AnalysisViewer,ModelTypeConfigurator



Mig

rati

on

Gu

ide

(not available) TCAQC_CALL_

BROWSER_FOR_

OUTPUT

In V2, this setting is defined in QCHECKER.par, keyword qchecker.CALL_BROWSER_FOR_BATCH_OUTPUT.

YES: After a batch check, open the batch check survey in HTML format in a browser.

NO (default): After a batch check, open the batch check survey in plain text format.

QC_REPORTS_IN_

SPECTREE

TCAQC_REPORTS_

IN_SPECTREE

YES: The internal check report is available in the CATIA specification tree (for certain document types only) and in the browser for internal check reports.

NO (default): The internal check report is not available in the CATIA specification tree, only in the browser for internal check reports.

SPECTREE_ONLY: The internal check report is only available in the CATIA specification tree. If the document type does not allow to display the check report in the CATIA specification tree, the check protocol is displayed in the browser for internal check reports.

QCLICEXPIRYALERT TCAQC_LIC_

EXPIRY_ALERT

Set this variable to display an alert when the Q-Checker license will expire soon. The value specifies the number of days before expiry when the alert will be displayed. To disable the alert, set the value to 0.

QC_CATSTART TCAQC_CATSTART For AIX only: Run CATDUA utilities without the CATSTART command. This is required when using extended memory sup-port for CATIA on AIX.

QC_USE_DISPLAY_

NAME

TCAQC_USE_

DISPLAY_NAME

YES: Setting for connection to VPM V4. Display the CATIA model name instead of the internal name from VPM V4.

NO (default): Setting for connection to Smarteam. Display the CATIA model name instead of the internal name from Smarteam. For connections to VPM 4, the internal name from VPM V4 is displayed.

TCTRACE TCTRACE Set this variable to activate the Q-Checker trace mode. The val-ue specifies path and filename of the trace file.

When TCTRACE is set, significant processing steps executed during Q-Checker checks are written to the trace file. The trace file can help to identify problems occurring while a Q-Checker check is performed.

Environment variables for Q-Checker application settings (continued)




Mig

rati

on

Gu

ide

(not available) TCAQC_SEAL_VAL In V2, the corresponding settings are profile-dependent. See the V2 profile editor, “Options” tab, “Check seal validation”.

This variable controls in which modes of operation an internal check seal is validated, and which action is performed if a mod-el contains no check seal or an invalid check seal. Set no more than one value for each mode of operation.

Validation when starting an interactive check

• INTERACTIVE+RECHECK: If no valid check seal exists, the model is checked again.

• INTERACTIVE+INTERRUPT: If no valid check seal exists, the validation result is displayed.

• None of these values: No validation in this mode of operation.

Validation when starting a batch check with the Q-Checker user interface:

• INTERACTIVE_BATCH+RECHECK: If no valid check seal exists, the model is checked again.

• INTERACTIVE_BATCH+INTERRUPT: If no valid check seal exists, the validation result is displayed.


Validation when starting a batch check at the command line:

• COMMAND_LINE_BATCH+RECHECK: If no valid check seal exists, the model is checked again.

• COMMAND_LINE_BATCH+INTERRUPT: If no valid check seal exists, the validation result is displayed.


QCGUI (not available) This variable is no longer used.

QCBATCH (not available) This variable is no longer used.

QCRESETSEMAPHORE (not available) This variable is no longer used.

QCRESETSEMAPHORE

_batch

(not available) This variable is no longer used.

Environment variables for Q-Checker application settings (continued)




Mig

rati

on

Gu

ide

Environment variables for database connection

V2 variable name R5 variable name Description/Values

(not available) TCAQC_DB_CONNECT In V2, the corresponding setting is defined in QCHECKER.par, keywords qchecker.DB_CONNECT_BATCH and qchecker.DB_CONNECT_INTERACTIVE.

INTERACTIVE: Connect to database for checks in interactive mode.

INTERACTIVE_BATCH: Connect to database for batch checks started from the Q-Checker user interface.

COMMAND_LINE_BATCH: Connect to database for batch checks started at the command line.

Database connection requires a special license.

TCAQC_DBFILE_

PATH

TCAQC_DBFILE_

PATH

Path to the QCHECKER.db database definition file.

Environment variables for PDM Save

V2 variable name R5 variable name Description

QCHECKER_EDM_

SAVE (until 2.11.x)

TCAQC_PDM_SAVE_

ACTIVATE (2.12.1 or later)

TCAQC_PDM_SAVE_

ACTIVATE

YES: Display a list of all checked models. The user can confirm to save all checked models to the PDM database, or cancel.

If a path has been set with TCAQC_PDM_SAVE_ACTIVE_FOR_PATH keyword, the prompt is displayed only if the model was taken from the specified path.

If no path has been set with TCAQC_PDM_SAVE_ACTIVE_FOR_PATH, the prompt is displayed in any case.

NO (default): Do not display the prompt and do not save the models.

SUPPRESS_DIALOG_AND_SAVE: Save all checked models to the PDM database without confirmation.

QCHECKER_EDM_

PATH (until 2.11.x)

TCAQC_PDM_SAVE_

ACTIVE_FOR_PATH (2.12.1 or later)

TCAQC_PDM_SAVE_

ACTIVE_FOR_PATH

Path used by TCAQC_PDM_SAVE_ACTIVATE



Mig

rati

on

Gu

ide

QCHECKER_EDM_

NOSAVE (until 2.11.x)

TCAQC_PDM_SAVE_

ACTIVE_AFTER_

HEALING (2.12.1 or later)

TCAQC_PDM_SAVE_

ACTIVE_AFTER_

MODIFICATION

YES (default): Display a list of all checked models. The user can confirm to save all checked models to the PDM database, or cancel.

NO: Display a list of models for which a healing has been performed, which will not be saved.

The user can confirm to save the other models, for which no healing has been performed, or cancel.

TCAQC_PDM_TMP_

SAVE_PATH

TCAQC_PDM_TMP_

SAVE_PATH

Set this variable to save unsaved models as temporary files be-fore the check. The value specifies the path for temporary files.

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

Environment variables for PDM Save (continued)

V2 variable name R5 variable name Description


MigrationQ-Monitor database

Mig

rati

on

Gu

ide
4.3 Q-Monitor database
When migrating to R5, changes to the Q-Monitor database are required.

If you are using Q-Checker without database connection, you can skip this section.

Changes

Prior to R5, MODEL_DIMENSION is a required field in the Q-Monitor database. The fieldvalue must not be null.

Starting with R5, this field is no longer required and not filled in.

Adaption

In the database definition, change the MODEL_DIMENSION column of the CHECK_SESSIONtable to permit the value null.

Fig. 1: The MODEL_DIMENSION column must permit the value null


MigrationQ-PLM Dispatcher configuration

Mig

rati

on

Gu

ide
4.4 Q-PLM Dispatcher configuration
When migrating to R5, changes to the Q-PLM configuration are required.

If you are using Q-Checker without Q-PLM, you can skip this section.

Changes

Q-PLM for V5 Release 5 requires the strict use of correct quotation marks in commandline input.

The Q-PLM Dispatcher configuration file Q-PLM_Dsp.xml must be changed accordingly.

Adaption

Command line parameters containing blank space must be set in double quotationmarks.

cmd /c "%CATDLLPath%\CATSTART.exe"

Double quotation marks must be escaped when used inside another pair of double quo-tation marks. To escape double quotation marks, add a prefix of two more double quo-tation marks per nested level.

This means, nested parameters on the first level must be enclosed in pairs of three dou-ble quotation marks:

cmd /c " """%CATDLLPath%\CATSTART.exe""" -env """%EnvPath%""" "

Nested parameters on the second level must be enclosed in pairs of five double quota-tion marks:

cmd /c " """%CATStartV5%""" -env """%CATEnv%""" -direnv """%CATEnvDir%""" -run """TCAQCheckerServerBatch.exe -i """""%ActQCFileInp%""""" -o """""%ActQCFileOut%""""" """ "

In the XML configuration file, double quotation marks in text nodes are represented bythe character entity ".

Affected XML nodes

Make sure the number of double quotation marks in command line input is correct.Command line input usually contains the string “cmd /c” and is specified in the follow-ing XML nodes and their subnodes:

Subnodes of /TranscatPLM/QCheckerPLM/ProfileDatas/ProfileData:

• QCheckerStart

• QCBatchStart



Mig

rati

on

Gu

ide
Subnodes of /TranscatPLM/QCheckerPLM/Actions/Action/System:
• SysQCheckerStart

• SysQCBatchStart

• SysQCExitBegin

• SysQCExitStart

• SysQCExitDoc

• SysQCExitEnd

Examples

Example Previously, nested parameters on the first level were enclosed in doublequotes; nested parameters on the second level were enclosed in three double quotes.

Previous command line inputcmd /c " "%CATStartV5%" -env "%CATEnv%" -direnv "%CATEnvDir%" -run "TCAQCheckerServerBatch.exe -i """%ActQCFileInp%""" -o """%ActQCFileOut%""" " "

Previous specification of the command line input in the Q-PLM configuration file <QCheckerStart parseparator="false" unix="false"> <Discrete value="cmd /c ""/> <Discrete value=" ""/> <Global name="CATStartV5"/> <Discrete value="" -env ""/> <ProfDataVal content="CATEnv"/> <Discrete value="" -direnv ""/> <ProfDataVal content="CATEnvDir"/> <Discrete value="" -run "/> <Discrete value=""TCAQCheckerServerBatch.exe"/> <Discrete value=" -i """"/> <InternalAttr intattr="ActQCFileInp"/> <Discrete value="""" -o """"/> <InternalAttr intattr="ActQCFileOut"/> <Discrete value="""" " ""/></QCheckerStart>

Example In R5, nested parameters on the first level must be enclosed in three doublequotes; nested parameters on the second level must be enclosed in five double quotes.



Mig

rati

on

Gu

ide

New (R5) command line inputcmd /c " """%CATStartV5%""" -env """%CATEnv%""" -direnv """%CATEnvDir%""" -run """TCAQCheckerServerBatch.exe -i """""%ActQCFileInp%""""" -o """""%ActQCFileOut%""""" """ "

New (R5) specification of the command line input in the Q-PLM configuration file <QCheckerStart parseparator="false" unix="false"> <Discrete value="cmd /c ""/> <Discrete value=" """"/> <Global name="CATStartV5"/> <Discrete value="""" -env """"/> <ProfDataVal content="CATEnv"/> <Discrete value="""" -direnv """"/> <ProfDataVal content="CATEnvDir"/> <Discrete value="""" -run "/> <Discrete value=""""TCAQCheckerServerBatch.exe"/> <Discrete value=" -i """"""/> <InternalAttr intattr="ActQCFileInp"/> <Discrete value=""""""

-o """"""/> <InternalAttr intattr="ActQCFileOut"/> <Discrete value=""""""

""" ""/></QCheckerStart>


MigrationPreparations for importing a check environment

Mig

rati

on

Gu

ide
4.5 Preparations for importing a check environment
User profiles

Only admin profiles are imported. To include user profiles, move the correspondingfiles (.qcprofile) to the environment directory in the admin path before importing.

Default language

Before importing, make sure the correct default language is set.

The default language of a V2 environment is defined in QCHECKER.par by parameterqchecker.DEFAULT_LANGUAGE. In the imported R5 environment, this language is usedas the standard language.

The standard language will be used instead to display the results if the active Q-Checkeruser interface language is not included in the check environment.

During import, the standard language is important in case of inconsistent language-specific settings, see below.

Language-specific settings

Before importing, make sure that language-specific files are mutually consistent.

In V2, model assessment definitions (PROFILE.par) and model type definitions(MODEL.type) are language-specific. It may happen that definitions are not consistentbetween languages, for example if not all language-specific files have been updated atsome point.

If settings are inconsistent between languages, preference is given to the definition forthe default language. Inconsistent settings will be listed in the load log.

Example The following criterion weight definitions in language-specific PROFILE.parfiles use different symbol colors, YELLOW and BLUE. If the default language is English, theEnglish definition is imported. Names are imported in the respective languages.

# English PROFILE.parqchecker.CRITERIA_WEIGHT "Warning" 0 YELLOW "In Order" 0

# German PROFILE.parqchecker.CRITERIA_WEIGHT "Warnung" 0 BLUE "In Ordnung" 0


MigrationImporting a check environment from Q-Checker Version 2

Mig

rati

on

Gu

ide
4.6 Importing a check environment from Q-Checker Version 2
Overview

There are various ways to import environments from Q-Checker Version 2. For ease ofuse, we recommend to use the “Import with plugin/reference models” function.

• Import with plugin/reference models (recommended): This import function of the environment editor imports the environment, including plugin criteria and reference models for criteria “Structure of Part Specification Tree” and “Structure of Product Specification Tree”. CATIA must be available to use this import function. CATIA will be run in the background during import.

Importing an environment with plugin/reference models, page 17

• Import without plugin/reference models: This import function of the environment editor does not import plugin criteria and reference models for criteria “Structure of Part Specification Tree” and “Structure of Product Specification Tree”.

Importing an environment without plugin/reference models, page 18

• Batch import (command line utility): With batch import, you can import a single environment or all environments in a common directory. Plugin criteria are imported, if there are any. Batch import must be run in a valid CATIA environment.

Batch import, page 18

Importing an environment with plugin/reference models

This import function of the environment editor also imports plugin criteria and refer-ence models for criteria “Structure of Part Specification Tree” and “Structure of ProductSpecification Tree”, if present in the original environment. CATIA must be available touse this import function. CATIA will be run in the background during import.

1 In the environment editor, select “Environment” > “Import...” > “Import with plugin/reference models”.

2 In the “Import an environment with plugin/reference models” dialog, click the file selection button. In the folder tree, select the desired environment. V2 environments are marked with a special icon in the folder tree.

Fig. 1: “Automotive” and “DEFAULT” are environments from Q-Checker V2; “Untitled folder” is an ordi-nary folder.

3 Click “OK”.

4 You can specify a different environment name in the “Environment name” text box.

5 To start the import, click “OK”.


MigrationImporting a check environment from Q-Checker Version 2

Mig

rati

on

Gu

ide
The environment has been imported and saved.
Importing an environment without plugin/reference models

This import function imports the entire environment, except plugin criteria and refer-ence models used in criteria “Structure of Part Specification Tree” and “Structure ofProduct Specification Tree”.

1 In the environment editor, select “Environment” > “Import...” > “Import without plugin/reference models”.

2 In the folder tree, select the desired environment. V2 environments are marked with a special icon in the folder tree.

Fig. 2: “Automotive” and “DEFAULT” are environments from Q-Checker V2; “Untitled folder” is an ordi-nary folder.

3 To import the selected environment, click “OK”.

The environment has been imported, but has not been saved yet. Before you exit the environment editor, remember to save the environment.

TIP: If you have imported an environment without plugin and reference models, youcan add a plugin and Part/Product reference models afterwards:

Administration manual, 10.3 Adding a plugin to an environment

Criteria Manual, Deriving the reference structure from a CATPart

Criteria Manual, Deriving the reference structure from a CATProduct

Batch import

With the TCAQcConvertEnv command line utility, you can import one or more environ-ments from V2. CATIA must be available to use this import function. TCAQcConvertEnvmust be run in a valid CATIA environment.

To import a specific environment from V2, enter the following command at the com-mand line:

CATIA_Install_Path\code\bin\CATStart.exe -env Environment_Name -direnv Environment_Path -run "QC_Install_Path\TCAQcConvertEnv.exe [--force] Environment_2xx New_environment"

CATIA_Install_Path Path of the CATIA V5 installation

Environment_Name Name of the CATIA V5 environment with Q-Checker integration (without the .txt filename extension)


MigrationExamining the imported environment

Mig

rati

on

Gu

ide
Environment_Path Path to the CATIA environment file with Q-Checker integration
QC_Install_Path Path of the Q-Checker installation

--force Include this parameter to overwrite an existing environment of the same name.

Environment_2xx Path of the environment to import

New_Environment File path of the new environment. The lowest directory in the path will become the name of the environment.

To import all environments from a directory (for example from a Q-Checker V2 admindirectory), enter the following command at the command line:

CATIA_Install_Path\code\bin\CATStart.exe -envEnvironment_Name direnvEnvironment_Path run "QC_Install_Path\TCAQcConvertEnv.exe [force] Parent_Dir"

CATIA_Install_Path Path of the CATIA V5 installation

Environment_Name Name of the CATIA V5 environment with Q-Checker integration (without the .txt filename extension)

Environment_Path Path to the CATIA environment file with Q-Checker integration

QC_Install_Path Path of the Q-Checker installation

--force Include this parameter to overwrite an existing environment of the same name.

Parent_Dir File path containing the environments to import. The new environments are created in the same directory and have the same names, but with a suffix _imported.

4.7 Examining the imported environment

During import, a load log is created. The load log can contain important informationabout inconsistent settings and other issues affecting the imported check environment.

The tables below explain messages that may appear in the load log. If there are errors orwarnings, inspect the respective setting in the imported environment. If you double-click certain entries in the load log, the environment editor brings the corresponding di-alog into view.

To resolve problems, you can either correct the V2 environment and import it again, orcorrect the imported R5 environment.



Mig

rati

on

Gu

ide
Messages in the load log
Message Description

Non-reference priority definition The priority has not been defined in all languages.

Suggested solutions:

• In the imported environment, review the affected priorities.

• In the V2 environment, define the priority in all languages (PROFILE.par, keyword qchecker.CRITERIA_WEIGHT). Discard the imported environment, then import again.

Inconsistent data in priority The priority definition is not consistent across all languages.


• In the imported environment, review the affected priorities.

• In the V2 environment, define priorities consistently (PROFILE.par, keyword qchecker.CRITERIA_WEIGHT). Discard the imported environment, then import again.

Non-reference assessment definition The model assessment has not been defined in all languages.


• In the imported environment, review the affected model assessments.

• In the V2 environment, define the model assessment in all languages (PROFILE.par, keyword qchecker.MODEL_ASSESSMENT). Discard the imported environment, then import again.

Inconsistent data in assessment The model assessment definition is not consistent across all languages.


• In the imported environment, review the affected model assessments.

• In the V2 environment, define model assessments consistently settings in PROFILE.par, keyword qchecker.MODEL_ASSESSMENT. Discard the imported environment, then import again.



Mig

rati

on

Gu

ide

Different model assessment modes The original check environment contains profiles with different model assessment modes. This is no longer supported in R5.


• In the imported environment, set the required model assessment mode. This implies that all profiles use the same model assessment mode.

• To use different model assessment modes in R5, you need to create separate check environments for the respective profiles.

Non-reference model-type definition The model type has not been defined in all languages.


• In the imported environment, review the definitions and names of model types.

• In the V2 environment, define model types consistently in MODEL.type. Discard the imported environment, then import again.

Inconsistent model-type data The model type definition is not consistent across all languag-es (MODEL.type).


• In the imported environment, review the model type definitions.

• In the V2 environment, define model types consistently in MODEL.type. Discard the imported environment, then import again.

Different definition for Q-Monitor prop-erty

Data types of database parameters defined in CRITERIA.par are inconsistent.

Suggested solution:

Correct the database custom attribute definitions in the im-ported environment, if necessary.

Missing sample file The check definition file referenced by a criterion is missing.

Suggested solution:

• In the imported environment, add the check definition.

• In the V2 environment, make the required check definition file available. Discard the imported environment, then import again.

Messages in the load log (continued)

Message Description



Mig

rati

on

Gu

ide

No sample file specified In the V2 profile, no check definition file has been specified for this criterion.

Suggested solution:

In the imported environment, add the check definition to the affected criterion.

Unknown criterion ID The criterion is unknown and could not be imported. It may have been removed or replaced.

Invalid healing key The healing function is invalid. It may have been removed or replaced.

Correct the imported criterion definition, if necessary.

Invalid healing parameter key The healing parameter is invalid. It may have been removed or replaced.


Invalid parameter key: StdSolidFeatWhitChildElemException

In criterion “Solid Feature with Child Elements”, parameter “List of excepted bodies” has been removed.

Solid Feature with Child Elements, page 24

Invalid parameter key: StdCATProductUpdatedDeactivatedFeatures

Invalid parameter key: PreForceCATProductUpdatedDeactivatedFeatures

In criteria “Product/Part Update” and “Perform Product/Part Update”, parameters “Ignore deactivated features” and “Check also measure features” have been removed.

Product/Part Update and Perform Product/Part Update, page 26

Invalid parameter key: StdAssociativeElementsSets

In criterion “Associative Elements (Parent/Children) in Specific Bodies”, parameters “List of Body types to check”, “List of types of child elements to check” and “List of bodies to be checked for child elements” have been removed.

Associative Elements (Parent/Children) in Specific Bodies, page 28

Invalid parameter key: StdConstructionOrderOfSolidFeatBooleanBodies

In criterion “Construction Order of Solid Features in Bodies”, parameters “Check also Boolean Bodies” has been removed.

Construction Order of Solid Features in Bodies, page 31

Invalid parameter key:... The parameter is invalid. It may have been removed or re-placed.



Message Description



Mig

rati

on

Gu

ide

Invalid parameter value ignored The parameter value is invalid.

Correct the parameter value in the imported criterion defini-tion, if necessary.

Parameter type has changed fundamen-tally

The parameter value is invalid because the parameter type has changed.

Correct the parameter value in the imported criterion defini-tion, if necessary.

Plugin is enabled in QCHECKER.par Plugin criteria have not been imported.

Discard the imported environment, and import again using “Import with plugin/reference models” or batch import.

Inconsistent plugin settings in QCHECKER.par

Plugin settings in QCHECKER.par are inconsistent.

Suggested solution:

• In QCHECKER.par, specify both qchecker.PLUGIN_IDENTIFICATIONSET and qchecker.PLUGIN_LOAD_PACKAGE. Discard the imported environment and import again.

• Install the plugin separately in the imported environment.

Administration manual, 10.3 Adding a plugin to an environment

Criterion refers to a CATProduct/CATPart

Criteria “Structure of Product Specification Tree”/“Structure of Part Specification Tree” have been imported, but without the reference structure definition.

Suggested solution:

Discard the imported environment, and import again using “Import with plugin/reference models” or batch import.


Message Description


MigrationCriteria requiring special attention – Solid Feature with Child Elements

Mig

rati

on

Gu

ide
4.8 Criteria requiring special attention
The following criteria need special attention after being imported into R5. If these crite-ria have been used in the Q-Checker V2 environment, please check whether they mustbe modified or replaced in R5.

Solid Feature with Child Elements, page 24

Product/Part Update and Perform Product/Part Update, page 26

Associative Elements (Parent/Children) in Specific Bodies, page 28

Construction Order of Solid Features in Bodies, page 31

4.8.1 Solid Feature with Child Elements

Fig. 1: Criterion definition in the Q-Checker V2 profile editor. The parameter marked in red has been re-moved in R5.

Changes

• Check parameter “List of excepted bodies” has been removed.

When do you need to change these criteria?

• If the “List of excepted bodies” value list is empty in V2, you can use this criterion in R5 without changes.

• If the “List of excepted bodies” value list did contain values in V2, you need to change the criterion in R5 (see Replacement for parameter “List of excepted bodies”, page 25). Otherwise check results in V2 and R5 will be different from one another.


MigrationCriteria requiring special attention – Solid Feature with Child Elements

Mig

rati

on

Gu

ide
Replacement for parameter “List of excepted bodies”
1 In the R5 environment editor, switch to the “Element selections” dialog.

2 Identify whether the element selection of this criterion is used also by other criteria.

To do this, select the entry in the “Element selections” list. Then click the “Show/Hidelist of criteria with the selected element selection” button. If more than one criterion islisted in the panel, the element selection is used by more than one criterion.

Fig. 2: Element selection “Bodies” is used by two criteria

3 Do one of the following:

If the element selection is used by more than one criterion, create a new element selection with identical settings. Assign the new element selection to the criterion.

If the element selection is only used by the current criterion, proceed with the next step.

4 In the element selection settings, specify the bodies to be ignored in the “Paths of bodies to be ignored” value list.

Insert the values previously applied to parameter “List of excepted bodies” in V2. Notethat in the “Paths of bodies to be ignored” value list, Regular Expressions must be putin double quotation marks.

All other element selection settings can remain unchanged.

5 Click the “Apply changes” button in the element selection dialog.

6 In the criterion definition, assign the new element selection to the criterion.


MigrationCriteria requiring special attention – Product/Part Update and Perform Product/Part Update

Mig

rati

on

Gu

ide

Example Corresponding values in the previous criterion definition (V2, upper image)and in the element selection (R5, lower image). The Regular Expression must be put indouble quotation marks.

4.8.2 Product/Part Update and Perform Product/Part Update

Fig. 1: Criterion definition in the Q-Checker V2 Profile Editor. The parameters marked in red are no longer available in R5. The same applies to criterion “Product/Part Update”.

Changes

• Element selection is now available for criteria “Perform Product/Part Update” and “Product/Part Update”. In imported instances of this criterion, the “Element Selection” parameter is not available.

• Check parameter “Ignore deactivated features” has been removed.

• Check parameter “Check also measure features” has been removed. Measure features are now checked by default. It is not possible to exclude measure features from the check.


If the “Ignore deactivated features” option was not selected in V2, you can use this crite-rion in R5 without changes.


MigrationCriteria requiring special attention – Product/Part Update and Perform Product/Part Update

Mig

rati

on

Gu

ide
If the “Ignore deactivated features” option was selected in V2, you need to change the
criterion in R5 (see Replacement for parameter “Ignore deactivated features”, page 27).Otherwise check results in V2 and R5 will be different from one another.

Replacement for parameter “Ignore deactivated features”

To ignore deactivated features, you need to replace the criterion and assign a corre-sponding element selection. Follow these steps:

1 In the V2 profile editor, note down the parameter values for this criterion. You may want to take a screenshot.

2 Remove the imported criterion.

3 Add a new criterion instance from the criteria pool to the same profile and model type.

4 Configure the new criterion instance according to the criterion in V2.

5 In the “Element selections” dialog, add a new element selection.

6 In the element selection settings, select the “Ignore deactivated elements” option. In the related list box, select “Including child elements in specification tree”.

7 Click the “Apply changes” button in the element selection dialog.



MigrationCriteria requiring special attention – Associative Elements (Parent/Children) in Specific Bodies

Mig

rati

on

Gu

ide
4.8.3 Associative Elements (Parent/Children) in Specific Bodies
Fig. 1: Criterion definition in the Q-Checker V2 profile editor. The parameters marked in red have been re-moved in R5.

Changes

• Element selection is now available for this criterion. In imported instances of this criterion, the “Element Selection” parameter is not available.

• Check parameter “List of body types to be checked” has been removed. All types of bodies are now checked by default.



Mig

rati

on

Gu

ide
• Check parameter “List of types of child elements to be checked” has been removed.
All types of child elements are now checked by default.

• Check parameter “List of bodies to be checked for child elements” has been removed. Child elements in all bodies are now checked by default.


You can use this criterion without adjustments only if its parameters are configured likethis:

• “List of body types to be checked” – all types selected

• “List of types of child elements to be checked” – all types selected

• “List of bodies to be checked for child elements” – check all bodies (value *)

If at least one parameter is configured differently, you need to change the criterion asshown below

Replacement for removed parameters

To replace the removed parameters, you need to replace the criterion and assign a cor-responding element selection. Follow these steps:






6 In the “Multi Select” text box of the element selection setting, define the types of bodies to be checked, and the types of child elements to be checked.

Define bodies to be checked with TREE_PARENT ( TYPE = identifier ), whereidentifier is the Q-Checker element type of the body.

Define child elements to be checked with TYPE = identifier, where identifier is theQ-Checker element type of the child element.

Combine these expressions where needed. See also the examples below.

7 In the “Paths of bodies to be checked” value list, insert the values previously applied to parameter “List of excepted bodies” in V2.

8 All other element selection settings can remain unchanged. To confirm, click the “Apply changes” button in the element selection dialog.


Examples

• Multi Select expression for types of bodies to be checked



Mig

rati

on

Gu

ide

TREE_PARENT ( TYPE = OpenBody OR TYPE = OrderedGeometricalSet )

• Multi Select expression for types of child elements to be checked

TYPE = Curve OR TYPE = Point

• Combine Multi Select expressions with Boolean AND (no line break):

TREE_PARENT ( TYPE = OpenBody OR TYPE = OrderedGeometricalSet ) AND ( TYPE = Curve OR TYPE = Point )

Example Same colors indicate corresponding values in the previous criterion definition(V2, upper image) and in the element selection (R5, lower image)


MigrationCriteria requiring special attention – Construction Order of Solid Features in Bodies

Mig

rati

on

Gu

ide

4.8.4 Construction Order of Solid Features in Bodies

Fig. 1: Criterion definition in the Q-Checker V2 profile editor. The parameter marked in red has been re-moved in R5.

Changes

• Element selection is now available for this criterion. In imported instances of this criterion, the “Element Selection” parameter is not available.

• Check parameter “Check also Boolean Bodies” has been removed. All types of bodies are now checked by default.


• If the “Check also Boolean Bodies” option is selected in V2, you can use this criterion in R5 without changes.

• If the “Check also Boolean Bodies” option was not selected in V2, you need to change the criterion in R5 (see Replacement for parameter “Check also Boolean Bodies”, page 32). Otherwise check results in V2 and R5 will be different from one another.


MigrationCriteria requiring special attention – Construction Order of Solid Features in Bodies

Mig

rati

on

Gu

ide
Replacement for parameter “Check also Boolean Bodies”
To replace parameter “Check also Boolean Bodies”, you need to replace the criterionand assign a corresponding element selection. Follow these steps:






6 In the “Multi Select” text box of the element selection setting, insert the following expression:

NOT ( TYPE = BooleanBody )

7 All other element selection settings can remain unchanged. To confirm, click the “Apply changes” button in the element selection dialog.



MigrationCleaning up the imported environment

Mig

rati

on

Gu

ide
4.9 Cleaning up the imported environment
After importing a check environment into R5, you can consolidate identical settings inthe check environment.

The environment may contain the same element selections, check conditions, check seals settings, profiles, or criteria several times.

If certain parameters are strictly identical except for their name, you can use the respective “Merge” functions in the environment editor to replace identical settings with one common setting.

Administration manual, “Merge: Identical profiles” dialog

Administration manual, “Merge: Identical criteria” dialog

Administration manual, “Merge: Identical check seal settings” dialog

Administration manual, “Merge: Identical element selections” dialog

Administration manual, “Merge conditions” dialog

To consolidate settings which are not strictly identical, you can manually replace certain settings with one single setting, and then delete settings which are no longer used.

Administration manual, 8.6 Replacing and deactivating check conditions

Administration manual, 9.4 Replacing an element selection

Administration manual, 6.5 Replacing a check seal setting

Imported check definition files often contain comments describing the syntax. You may want to remove the comments from the check definition text boxes. In R5, the syntax is described in the documentation.

4.10 Validation of internal check seals created in V2

To enable the validation of internal check seals created with V2, follow these steps:

1 Start a CATIA session with R5 integration.

2 Open a model whose internal check seal is valid with respect to the V2 profile.

3 In CATIA, click the “Start check seal viewer” button on the Q-Checker toolbar.

4 In the check seal viewer, click the “Check seal details” button.

5 In the dialog, the profile checksum is marked with CHKSUM_PROFILE. Copy the entire check sum value.

Example The profile check sum is 1035921843.

<CHKSUM_PROFILE> 1035921843 </CHKSUM_PROFILE>


MigrationValidation of internal check seals created in V2

Mig

rati

on

Gu

ide
6 In the Q-Checker environment editor, open the R5 check environment.
7 Switch to the “Check seals” dialog.

8 In the upper part of the dialog, select the check seal setting, the validation of which you want to configure.

9 In the lower part of the dialog, select the “Validate profile”. (If this option is not selected, profiles will not be validated.)

10 Click the “+” button to the right of the “Other allowed profiles” list.

11 Insert the copied check sum value into the “Check sum” column. In the “Description” column, you can add a description.

12 To apply the changes to the environment, click the “Apply changes” button, and save the check environment.

(8)

(9)

(11)(10)


MigrationCustom report templates

Mig

rati

on

Gu

ide
4.11 Custom report templates
R5 comes with optimized report templates. If you have been using the templates sup-plied with V2, we recommend using the new templates.

If you want to use existing report templates, copy the template files from the V2 envi-ronment, and rename them as specified in the table below. Note that in R5, report tem-plates are no longer language-specific. The same templates are used in all languages.

The paths in the table above apply to a set of templates in English. You can copy thetemplates in any language, according to your requirements.

4.12 Custom help pages

Custom criterion help pages in HTML format can be included in the environment. In V2environments, custom help pages are located in the htmlV5 subdirectory of the environ-ment directory.

Note that certain functions such as context help for check parameters may no longerwork when using custom help pages.

To migrate custom help pages, do the following:

1 Copy the htmlV5 subdirectory of the V2 environment to the directory of the R5 environment.

2 Rename the copied subdirectory from htmlV5 to html.

Template file (V2) Copy and rename to (R5) Description

%QCADMIN%\lang_EN\

TEMPLATE.txt

%TCAQC_Resources%\templates\

TemplateReport.txt

Template for check reports in plain text format

%QCADMIN%\lang_EN\

TEMPLATE.html %TCAQC_Resources%\templates\

TemplateReport.html

Template for check reports in HTML format

%QCADMIN%\lang_EN\TEMPLATE_

BATCH.html %TCAQC_Resources%\templates\

TemplateBatch.html

Template for batch check surveys in HTML format.

%QCADMIN%\lang_EN\TEMPLATE_

BATCH.html

%TCAQC_Resources%\templates\

TemplateSession.html

Template for product component check surveys in HTML format.

%QCADMIN%\TEMPLATE_

CheckSeal.html %TCAQC_Resources%\templates\

TemplateCheckSeal.html

Template for check seal reports in HTML format

*.css, *.gif, *.jpg *.css, *.gif, *.jpg Stylesheet and graphics


MigrationList of files

Mig

rati

on

Gu

ide
4.13 List of files
The following list shows which files are imported or copied from a V2 check environ-ment during import.

List of files

V2 R5

Admin profiles (*.qcprofile in %QCUSER% path) Imported into qchecker.qcenv

User profiles (*.qcprofile in %QCUSER% path) Not imported. To import user profiles, move the corresponding files to the environment directory in the admin path before importing.

QCHECKER.par Settings imported into qchecker.qcenv.

Some parameters are not imported and must be defined as environment variables:

qchecker.DB_CONNECT_INTERACTIVE

qchecker.DB_CONNECT_BATCH

qchecker.CALL_BROWSER_FOR_BATCH_OUTPUT

PROFILE.par Imported into qchecker.qcenv

DepartmentModelType.xml File copied into the environment

*.CATMaterial files for criterion “User-Defined Property Must Match Material in Catalog”

Files copied into the environment

*.catdua.xml definition files for criterion “DataLife-cycle CATDUA”

Imported into qchecker.qcenv

Check report templates Not copied. You can copy the files manually, if re-quired.

4.11 Custom report templates, page 35

Custom help pages Not copied. You can copy the files manually, if re-quired.

4.12 Custom help pages, page 35

QCHECKER.db database definition file File copied into the environment

Check definition files (*.axisname, *.comment, *.conditional, …)

Imported imported into qchecker.qcenv

*.draftingstd.xml definition file for criterion “Drafting Standard Corresponds to Reference Docu-ment Standard”

Imported into qchecker.qcenv


MigrationList of files

Mig

rati

on

Gu

ide

KWE Check plugin Imported when using import with plugin/reference models. The plugin model must be referenced in QCHECKER.par.

Reference models for criteria “Structure of Part Specification Tree”/“Structure of Product Specifica-tion Tree”

Imported when using import with plugin/reference models.

User settings (QCHECKER.usr, TCAQChecker.usr) Not imported

List of files (continued) (continued)

V2 R5


Documents

Q-Checker for V5 Release 5.1 Migration Guide V2 to Release 5transcat-plm.com/pub/tcsoft/qplmV5_510/doc/migration.pdf · the CATIA specification tree. If the document type does not