Q-PLM DX / PLM Integration

Transcription

1 Q-PLM DX / PLM RELEASE MODULES REFERENCE

2 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 Dassault Systèmes CATIA, ENOVIA, Q-Checker are registered trademarks of Dassault Systèmes or its subsidiaries in the US and/or other countries.

3 TABLE OF CONTENTS 3 Table of Contents 1 Prequisites 4 2 Licenses 5 3 Modules Modules Overview Module Q-PLM Dispatcher Q-CHECKER Batch Module Data Exchange Shared Directory Workflow Data exchange PDM/PLM General Q-PLM without direct CATIA PDM access to the model Q-PLM with direct CATIA PDM access to the model Q-PLM PDM Save with direct CATIA PDM access to the model Q-PLM Launch General Q-PLM DX Q-PLM PDM Q-PLM SMARTEAM/MatrixOne/ENOVIA V

4 PREQUISITES 4 1 Prequisites To install and run Q-PLM, the following software must be installed: Java Runtime 1.5 or later WINDOWS XP/7, UNIX or LINUX for Q-PLM DISPATCHER For Q-PLM DX, PDM, SMARTEAM or MatrixOne integration: any Q-CHECKER release for CATIA V5 or V4 For ENOVIA V6 integration: suitable Q-CHECKER release for CATIA V6 Available license for Q-PLM Q-CHECKER CATIA PDM/PLM system (ENOVIA MatrixOne, SMARTEAM, ) LUM client for Q-PLM DISPATCHER LUM license server

5 LICENSES 5 2 Licenses The following licenses for the products are required: Tab. 1: Required Product licenses Module License Platform Description Q-PLM DX TC-QPLM-DX WINDOWS / UNIX Q-PLM for Data exchange PDM TC-QPLM-PDM WINDOWS / UNIX Q-PLM for general PDM/PLM SMARTEAM TC-QPLM-SmarTeam WINDOWS Q-PLM for ENOVIA SMARTEAM MatrixOne TC-QPLM-MatrixOne WINDOWS / UNIX Q-PLM for ENOVIA MatrixOne Q-PLM for ENOVIA V6 with CATIA V5 ENOVIA V6 TC-QPLM-V6 WINDOWS / UNIX Q-PLM for ENOVIA V6 with CATIA V6 Q-CHECKER XML output TC-qcheckerV5-DB WINDOWS / UNIX Only required for Q-CHECKER TC-qchecker-all- UNIX prior to DB Q-CHECKER V5 TC-qcheckerV5 WINDOWS / UNIX Q-CHECKER for CATIA V5 Q-CHECKER V4 TC-qcheckerV4 UNIX Q-CHECKER for CATIA V4 NOTE For Q-PLM, only a server license is available.

6 MODULES 6 3 Modules 3.1 Modules Overview Q-PLM consists of the following modules: 0. INTEGRATION MODULE a. Data Exchange System for Q-PLM DX b. PDM INTEGRATION for Q-PLM PDM c. ENOVIA INTEGRATION for Q-PLM SMARTEAM / MatrixOne / ENOVIA V6 0. Q-PLM DISPATCHER 0. Q-CHECKER V5 / Q-CHECKER V4 0. Batch Module a. (not available for Q-PLM DX) b. PDM batch for Q-PLM PDM c. ENOVIA Batch for Q-PLM SMARTEAM / MatrixOne / ENOVIA V6 These modules can be allocated to different computers with different operating systems. For standard configurations it is also possible to install and launch all modules on the client system (except Q-CHECKER V4, which is only available for UNIX). The figure below shows the modules of ENOVIA SMARTEAM as an example. There are analogous modules for other systems (ENOVIA SMARTEAM, ENOVIA MATRIXONE, ENOVIA V6 or other PDM systems).

7 MODULES 7 Fig. 2: Modules of Q-PLM ENOVIA SMARTEAM 3.2 Module INTEGRATION MODULE (e.g. ENOVIA SMARTEAM ) is the module integrating Q-CHECKER into the DX/PDM/PLM system. Q-PLM DX is the solution for integrating Q-CHECKER into a data exchange system. The INTEGRATION MODULE for DX has the following functionality: Called with runtime arguments Return a defined return code Write an overall report for the whole job Q-PLM PDM is the solution for integrating Q-CHECKER into PDM/PLM systems. The INTEGRATION MODULE for PDM/PLM systems has the following functionality: Trigger lifecycle operations Enable manual check Update the ENOVIA PLM system with Q-CHECKER results Attach Q-CHECKER report files to the ENOVIA PLM system.

8 MODULES 8 INFO In case of Q-PLM PDM software without standard integration into an ENOVIA PLM system, the customer or an implementation partner has to develop this module. 3.3 Q-PLM Dispatcher The Q-PLM DISPATCHER module processes the requests from the DX/PLM integration and calls the different Q-CHECKER and CATIA installations. It interprets Q-CHECKER results and triggers the PLM (e.g. ENOVIA SMARTEAM) update. 3.4 Q-CHECKER Q-CHECKER is the tool checking CATIA models (parts, products, ). The Q-CHECKER version to be used depends on the PLM system and user requirements. It is possible to integrate Q-CHECKER for CATIA V4, V5 or V Batch Module Generally, there are two modes of execution: waitfor mode Wait until the Q-CHECKER check run has finished. In the meantime, the DX/PDM/PLM system is blocked. batch mode Trigger a Q-CHECKER check run, but do not wait for the check run to finish. You can immediately continue to work with the DX/PDM/PLM system. The PDM/PLM update is performed by the batch module after the Q-CHECKER check run has finished. When using batch mode, the Batch Module calls the PLM update (e.g. ENOVIA SMARTEAM ). When using waitfor mode, the INTEGRATION MODULE updates the PDM/PLM system.

9 DATA EXCHANGE 9 4 Data Exchange 4.1 Shared Directory This section characterizes the concept and use of the shared directory. The different modules of the Q PLM DX/PDM INTEGRATION can be spread on different computers that may have different operating systems. In this case a shared file system is required. Files stored on the shared file system are: Files for data exchange between the modules (e.g. *inf.xml, *bat.xml) Input and output files for Q-CHECKER Batch CATIA files Q-CHECKER reports NOTE Files used by more than one module must be located on the shared file system. The read/write access to files and directories in the shared file system depends on the different modules. In general, all users and modules require the following permissions: Full read/write access to all temporary files and directories Read access to the software installation directories When using CATIA V4, note the following limitations: Maximum path length is 44 characters Maximum file name length is 72 characters. Only file names readable by CATIA and the operating system are allowed. For example, a colon : is allowed on UNIX but not allowed in CATIA. For each module running on the same operating system, the same path must be used. For example, on every WINDOWS computer the directory d:\users\qcplm_work and d:\program\q-plm must exist. On Windows UNC path names are possible too. This rule applies to all shared data, temporary files and the PLM work data. Possible path definitions for WINDOWS: Mapped network drive, e.g. d:\users\qcplm_work

10 DATA EXCHANGE 10 UNC path, e.g. \\fserver\d$\users\qcplm_work Possible path definitions for UNIX: Mounted directory, e.g. /users/qcplm_work The paths for shared directories and the mapping between WINDOWS and UNIX file systems must be defined in the Q-PLM_DSP.xml file. Client only Server only Q-PLM DISPATCHER PDM SYSTEM PDM CATIA V5 Env Q-CHECKER Client / Server PDM SYSTEM PDM SMARTEAM PDM Batch Shared file system Same physical file system for every module but with different path names CATIA V4 Env Q-CHECKER Fig. 3: Shared directories NOTE For access to the shared file system from UNIX, SAMBA or similar software is needed. Example This example explains how to spread modules on different computers. The example does not apply to standard installation, because in this case the modules will be situated on one only computer. In this example, PDM / PLM SYSTEM is running on the WINDOWS client machine, Q-PLM DISPATCHER on a UNIX server, CATIA V5 on a WINDOWS server and CATIA V4 on a UNIX server.

11 DATA EXCHANGE 11 Client only Server only Q-PLM DISPATCHER PDM SYSTEM PDM Client / Server PDM SYSTEM PDM B1 B2 A C Shared file system Same physical file system for every module but with different path names D1 D2 CATIA CATIA V5 Environment V5 Q-CHECKER CATIA CATIA V4 Environment V4 Q-CHECKER PDM SYSTEM PDM Batch Fig. 4: Shared directories example Tab. 5: Shared directories with sample mounts Ref. Machine / modules Data directory Module (software) directory A File / application server d:\users\qcst_share d:\program\q-plm B1, B2, D1 C, D2 WINDOWS modules \\fserver\users\qcst_share$ \\fserver\program\q-plm UNIX modules /users/qcst_share /program/q-plm

12 Data exchange System INTEGRATION WORKFLOW 12 5 Workflow 5.1 Data exchange File System CATIA Model Arguments Model location Attributes (opt.) System attributes (opt.) Q-PLM Q-PLM Dispatcher o Q-CHECKER processing o Interprets Results o OS independent o Unique Returncode Returncode QCheckerBat.xml Defined return code Attribute values Report location Fig. 6: interfaces The DX INTEGRATION MODULE is called with arguments which define the input parameters (e.g. model name,...). These arguments are stored in an internal XML file named QCheckerInf.xml used as input file for the Q-PLM (Q-PLM DISPATCHER) software. The result of the Q-PLM (Q-PLM DISPATCHER) software is a return code and a XML file, QCheckerBat.xml. This file can be read by the data exchange system and is written with a unique prefix (time stamp). File name example: V5_QCheckerBat.xml CATIA files which have to be checked must be located on or copied to a shared file system to which both Q-PLM and Q-CHECKER software have access. All Q-CHECKER result files are stored there, too.

13 INTEGRATION WORKFLOW 13 The behavior of the Q-PLM software is defined in an XML configuration file (one only file, namely Q-PLM_Dsp.xml). For more information please refer to the Q PLM_Dsp.xml reference manual. 5.2 PDM/PLM General copy out File System CATIA Model Q-CHECKER report attach (optional) PDM XML (*Inf.xml ) Q-PLM Dispatcher XML (*Bat.xml) PDM QCheckerInf.xml Model location PDM attributes (optional) System attributes (optional) Q-PLM DISPATCHER Q-CHECKER processing Interprets Results PLM and OS independent QCheckerBat.xml Defined return code Attribute values Report location Fig. 7: interfaces Form the PDM / PLM INTEGRATION MODULE an XML file, QCheckerInf.xml must be written. This file will be taken as an input for the Q-PLM (Q-PLM DISPATCHER) software. The result of the Q-PLM (Q-PLM DISPATCHER) software is an XML file, QCheckerBat.xml. This file has to be read by the PDM / PLM INTEGRATION MODULE. We recommend naming these files with a unique prefix (for instance, this could be a time stamp).

14 INTEGRATION WORKFLOW 14 File name example: V5_QCheckerInf.xml NOTE The file name must end with _QCheckerInf.xml. Otherwise the corresponding QCheckerBat.xml is not created with a proper filename. The CATIA files which have to be checked must be stored on (or copied to) a shared file system to which Q-PLM and Q-CHECKER software have access. The QCheckerInf.xml and QCheckerBat.xml are on this directory as well. All Q-CHECKER result files are stored there, too. The behavior of the Q-PLM software is defined in a single XML configuration file named Q-PLM_Dsp.xml. For more information please refer to the Q PLM_Dsp.xml reference manual Q-PLM without direct CATIA PDM access to the model The figure below describes Q-PLM modules and file sharing for the following scenario: No direct access from CATIA to the model on the PDM database; this applies to ENOVIA SMARTEAM, ENOVIA MATRIXONE, or custom integration into other PDM / PLM systems Shared file system Q-CHECKER batch call

15 INTEGRATION WORKFLOW 15 PDM read attributes copyout model (if model is checked in) DB Tmp directory Trace 1 *Inf.xml Tmp directory Q-PLM Dispatcher Trace 3 2 Q-Monitor DB Report directory QC.in 4 CATIA / Q-CHECKER Batch load CATIA model model directory CATIA file Reports QC.out Tmp directory 2 PDM / Batch set attributes attach QC-Reports Checkin / update model (if required) DB *Bat.xml Trace Fig. 8: workflow without direct CATIA PDM access to the model Q-PLM with direct CATIA PDM access to the model The figure below describes Q-PLM modules and file sharing for the following scenario:

16 INTEGRATION WORKFLOW 16 Direct access from CATIA to the model on the PDM database; this applies to ENOVIA V6 Shared file system Q-CHECKER batch call ENOVIA Q-PLM read attributes ENOVIA DB Tmp directory Trace *Inf.xml Tmp directory Q-PLM Dispatcher Trace 1 2 Q-Monitor DB Report directory QC.in CATIA / Q-CHECKER Batch Reports QC.out load CATIA model ENOVIA DB 1 ENOVIA Q-PLM Batch set attributes attach QC-Reports 2 ENOVIA DB Tmp directory *Bat.xml Trace Fig. 9: workflow with direct CATIA PDM access to the model

17 INTEGRATION WORKFLOW Q-PLM PDM Save with direct CATIA PDM access to the model The figure below describes modules and file sharing for the following scenario: Q-CHECKER with PDM Save Shared file system CATIA / Q-CHECKER Interactive PDM Save ENOVIA Q-PLM read attributes ENOVIA DB Q-Monitor DB Tmp directory Trace *Inf.xml Tmp directory Q-PLM Dispatcher Trace Report directory 1 Reports 1 Tmp directory ENOVIA Q-PLM set attributes attach QC-Reports ENOVIA DB *Bat.xml Trace Fig. 10: workflow with PDM Save

18 Q-PLM LAUNCH 18 6 Q-PLM Launch 6.1 General Q-PLM DISPATCHER is based on Java. For calling Q-PLM DX or Q-PLM PDM, run Java with the suitable Q PLM DISPATCHER class and input parameter. Q PLM SMARTEAM / Q-PLM MatrixOne / Q-PLM ENOVIA V6 are called by the different integration modules; this is configured in the Q-PLM_DSP.xml file. To run Java, use the following command: java [-options] class [arguments] For more information about running Java, type the following command at the command line: java h To launch Q-PLM DX / PDM, use the following command: java <JAVAENV> -classpath %INSTALLPATH%\bin\Q-PLM_DSP jar; %INSTALLPATH%\bin\LUMClient.jar <class> <Arguments> Q-PLM_Dsp.xml Tab. 11: Arguments for Q-PLM DX / PDM Argument Description/Parameters Examples Java <JAVAENV> Name of the Java executable. If the Java directory is not in the system path environment variable, the full qualified path (including file name) must be used. Java environment variables. -DCTRACEON true/false Enable/disable trace output files -DCTRACEON=true

19 Q-PLM LAUNCH 19 Argument Description/Parameters Examples INSTALLPATH Q-PLM_DSP.jar System attributes: -DSys:name=value Document attributes: -DDoc:name=value Project attributes: -DPrj:name=value Internal attributes: -DInt:name=value Batch attributes: -DBat:name=value Path where the Q-PLM software is installed Name of the current Q-PLM jar file for the current version. This filename can be different in other Q-PLM releases. -DSys:tmp=C:\TEMP -DDoc:Customer=Nobody c:\program Files\Q-Checker\qplm Q-PLM_DSP jar <class> Name of the Java main class Q-PLM DX: qplm/qplm_dx Q-PLM PDM: qplm/qplm_pdm_tb Q-PLM SMARTEAM: qplm/qplm_pdm_st Q-PLM MatrixOne: qplm/qplm_pdm_m1 Q-PLM ENOVIA V6: qplm/qplm_pdm_v6 <Arguments> Arguments for processing Refer to the specific Q-PLM description refer to the following sections: Q-PLM DX: 6.2 Q-PLM DX Arguments Q-PLM PDM: 6.3 Q-PLM PDM Arguments Following environment variables have to be added in addition: Variable Description Value (Example) TCAQPLM_LIC Defines the license mechanism Default: DSLS license DSLS: DSLS license DSLUM: Dassault LUM license TC: Transcat LUM license Q-PLM DISPATCHER returns one of the following return codes: Tab. 12: List of return codes for Q-PLM DISPATCHER

20 Q-PLM LAUNCH 20 Return code Description/Parameter 0 No failure -4 Java class not found -8 General failure -16 License failure -32 Unknown exception failure -64 Socket error, connection to server failed 6.2 Q-PLM DX For general information about Q-PLM see chapter General. Tab. 13: Arguments for Q-PLM DX Argument Description/Parameters Required/Default Value -m <modeldir> Directory for models Required -f <modelfile> Model name with wildcards (*,?) Required -t <tracedir> For compatibility issues only. Directory for protocol files. Is used if parameter p is not set. "." -a <action> Action node name Required -p <protdir> Directory for protocol files "." -r Scan directory for models recursively No recursion Q-PLM_Dsp.xml Example Full qualified path of the Q-PLM_Dsp.xml file. This is the name of the general configuration file. This must be the last parameter. Required java DTCTRACE=true classpath c:\program Files\Q-Checker\qplm\bin\Q-PLM_DSP jar; c:\program Files\Q-Checker \qplm\lumclient.jar qplm/qplm_dx m C:\CATIAV5\models -f test.catpart -a OEM1 c:\program Files\Q-Checker\qplm\adm\QPLM_Dsp_DX.xml 6.3 Q-PLM PDM For general information about Q-PLM see chapter General.

21 Q-PLM LAUNCH 21 Tab. 14: Arguments for Q-PLM PDM Argument Description/Parameters Required/Default Value Q-PLM_Dsp.xml Full qualified path of the Q-PLM_Dsp.xml file. This is the name of the general configuration file. This must be the first parameter. Required QCheckerInf.xml Full qualified path of the Q-PLM_Dsp.xml file. This is the name of the general configuration file. This must be the last parameter. Required Example java DTCTRACEON=true classpath c:\program Files\Q-Checker\qplm\bin\Q-PLM_DSP jar; c:\program Files\Q-Checker\qplm\LUMClient.jar qplm/qplm_pdm_tb t:\qplm_share\ _qplminf.xml c:\program Files\Q-Checker\qplm\adm\QPLM_Dsp_DX.xml 6.4 Q-PLM SMARTEAM/MatrixOne/ENOVIA V6 Starting Q-PLM for the specific standard integrations is described in the Q-PLM documentation for the PDM system.

22 LEGAL NOTICES 22 7 Legal Notices CATIA, ENOVIA, Q-Checker are registered trademarks of Dassault Systèmes or its subsidiaries in the US, other countries or both. U.S. Government Users Restricted Right Commercial Computer Software. Use, duplication or disclosure restricted by GSA Schedule Contract or, under DFARS Subpart only: subject to Restricted Rights at (c)(l)(ii) All other company names and product names mentioned are the property of their respective owners. The software may include the following open source components licensed under the following licenses. Apache license: Axis2/C Axis2/Java Axis1/Java Apache Tomcat OpenSSL license: OpenSSL

23 23