Oracle® Agile Engineering Data Management · customizing requests can be solved using the script language Tcl. Tcl is also available on different platforms. The architecture of the

Oracle® Agile Engineering Data Management

MCAD Connector for Catia V4 – Version 5.3.2Installation and Administration M

.0 anual

Part No. E14327-01

January 2009

Copyright and Trademarks Copyright © 1992, 2009, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third party content, products or services.

Oracle® Agile Engineering Data Management Page iii

CONTENTS Copyright and Trademarks.................................................................................................................. iii Preface .................................................................................................................................................v

Introduction...................................................................................................................... 1 Overview...............................................................................................................................................1 Architecture ..........................................................................................................................................1

Installation........................................................................................................................ 3 Prerequisites.........................................................................................................................................3 Checking the Prerequisites ..................................................................................................................3 Installing the Software ..........................................................................................................................3 Adapting the Startup Script ..................................................................................................................4 Customizing Vault Options ...................................................................................................................4

Define the CATIA Model Areas............................................................................................................................................5

Configuration .................................................................................................................... 7 Agile e6.1..............................................................................................................................................7 Customizing Masks ..............................................................................................................................8 Connector Environment......................................................................................................................10

Master Configuration File EdbInitialize.ini ........................................................................................................................10 Internal Structure of Mapping Files ....................................................................................................12 Customer Configuration File Edb.ini...................................................................................................14

Frame Mapping and Customizing.................................................................................... 15

Additional Functions ....................................................................................................... 17 Batch Functions..................................................................................................................................17 Security Functions..............................................................................................................................17

Catia-File Areas................................................................................................................................................................17

Debugging....................................................................................................................... 19

iv Oracle® Agile Engineering Data Management

MCAD Connector for Catia V4 - Version 5.3.2.0 Installation and Administration Manual

Preface The Oracle documentation set includes Adobe® Acrobat™ PDF files. The Oracle Technology Network (OTN) Web site (http://www.oracle.com/technology/documentation/agile.html) contains the latest versions of the Oracle Agile EDM PDF files. You can view or download these manuals from the Web site, or you can ask your Agile administrator if there is an Oracle Documentation folder available on your network from which you can access the documentation (PDF) files.

Note To read the PDF files, you must use the free Adobe Acrobat Reader™ version 7.0 or later. This program can be downloaded from the Adobe Web site (http://www.adobe.com).

Note Before calling Agile Support about a problem with an Oracle Agile EDM manual, please have the full part number, which is located on the title page.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, 7 days a week. For TTY support, call 800.446.2398. Outside the United States, call +1.407.458.2479.

Readme

Any last-minute information about Oracle Agile EDM can be found in the Release Notes file on the Oracle Technology Network (OTN) Web site (http://www.oracle.com/technology/documentation/agile_eseries.html)

Agile Training Aids

Go to the Oracle University Web page (http://www.oracle.com/education/chooser/selectcountry_new.html) for more information on Agile Training offerings.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Oracle® Agile Engineering Data Management Page - v

http://www.oracle.com/technology/documentation/agile.html

http://www.adobe.com/

http://www.oracle.com/technology/documentation/agile_eseries.html

http://www.oracle.com/education/chooser/selectcountry_new.html

Chapter 1

Introduction

Overview The information in this document is based on a standard installation and the actual appearance of a specific installation may vary depending on the local environment and custom configuration realized for the individual requirements of the customer.

The connector functions are provided with additional and expanded menus in Agile e6.1 and CATIA.

Architecture The Agile e6.1 - CATIA connector was created using the development tools delivered by Dassault Systèmes. It represents an enhancement to the operations of CATIA. The Agile e6.1 - CATIA connector (ECC) is an add-on module to Agile e6.1.

Agile offers a uniform GUI which operates with different operating systems throughout the company. This facilitates the operation of the connector despite the use of different operating systems. Many customizing requests can be solved using the script language Tcl. Tcl is also available on different platforms.

The architecture of the connector between Agile e6.1 and CATIA is illustrated in the following graphic:

Oracle® Agile Engineering Data Management Page 1


Page - 2 Oracle® Agile Engineering Data Management


Chapter 2

Installation The installation of the Agile e6.1 - CATIA connector (ECC) is divided into several steps. Performing the steps in the proper order is important for correct operation.

The following steps have to be carried out:

1. Prerequisites

2. Checking the Prerequisites

3. Installing the software

4. Adapting the Startup Script

5. Customizing Vault Options

6. Define the Catia Model Areas

Prerequisites The Agile e6.1 - CATIA connector is currently available for several hardware platforms and operating systems. For an overview of platforms refer to the Release Notes for Catia V4 – Version 5.3.2.0.

Checking the Prerequisites ORACLE is installed and running.

Agile e6.1 is installed and running.

A designated user environment is already set up in Agile e6.1.

In Agile e6.1 a test user with a valid password exists and is authorized to start the Agile e6.1 session.

If the Agile e6.1 File Server should be used check whether it is working.

CATIA is installed and can be launched by the test user in the home directory.

The latest version of the connector that is compatible with the operating system and the CAD system should be available.

Installing the Software To install the ECC connector, extract the delivered zip file (e.g. ecc5320.zip) to any path on your hard drive (e.g. …/opt/ecc532)

The installation creates the following directory structure:

Oracle® Agile Engineering Data Management Page - 3


Main Di rectory

Sub-d i rectory Sub-d i rectory

Sub-d i rectory

Descr ipt ion

/bin Program libraries

/aix_a ECC libraries for AIX

/hpux_b ECC libraries for HP-UX

/solaris_a ECC libraries for SUN

/plm60 Agile e6 EDB system

/com Configuration files

/ini Initialization files and info text

/install Post-install routines

/dec CATIA declaration files

/tcl TCL start procedures

/tclib TCL library files

Adapting the Startup Script To set the customer specific variables the respective startup file needs to be adapted.

dec/ ECC.env

Var iable Descr ipt ion Val id Content (defau l t set t ing)

EccRoot Root directory of integration ~plm60/ecc

EccCustom Mapping file CustomInitialize.ini

EccMainTclScript Main script of the integration EccMain

EccEciTopic Socket number for communication 4444

EccCadim Agile start script $EccRoot/com/plm6Start

CaxTclScripts Directory of TCL scripts $EccRoot/tcl/

TCL_LIBRARY Directory of TCL libraries $EccRoot/tcllib/

CaxConfigDir Directory of configuration files $EccRoot/ini/

Customizing Vault Options The CAD files are stored in a central vault when using the Agile e6.1 FMS (FMS = File Management Server). In the FMS the filenames are created in an encoded form when the data are transferred to the FMS. Working with the file server permits central, and protected data storage.

The default name of the used vault is “CAX” (capitalized). If you want to use another name, you need to change it in Agile e6.1.



Note How to set up a vault can be found in the Agile e6.1 documentation.

Define the CATIA Model Areas To be able to use the model area “WORK_ECC” this area has to be defined in the Catia Declaration file: catia.MODEL = '"/tmp/edb/eccwork", "WORK_ECC"';

The values “WORK_ECC” and “/tmp/edb/eccwork” also have to be defined in the vault definition table in Agile e6.1 as shown in the following screenshot:





Chapter 3

Configuration

Agile e6.1 The following data models are required for running the connector. It is already implemented in the standard dump and is only reported here for comparing it with older customized dumps:

Document types for drawings and 3D models: DRAWING and 3D_MODEL

Structure table T_DOC_STR

Masks for document types: EDB-DOC-DRW-TFR / TLI

EDB-DOC-3DM-TFR / TLI

Document loading list (master list): EDB-DOC-SLI

The following fields have to be verified and added irrespective from the standard data model fields:

The table T_DOC_DAT has to contain:

Field Type Descr ipt ion

CAX_LOCAL L Local

CAX_FIL_DISC S32 Catia model area

CAX_FIL_NAME S80 Model name

CAX_FIL_OLD_NAME S80 Original name

ECC_NAM_FMT S16 Name format

ECC_PROJECT S16 Catia Project

CAX_CRE_SYSTEM S14 Creation system

CAX_FRAME_ID S20 Format

ECC_MODIFY_DATE D Modified at

ECC_FILE_SIZE S10 Model size

The table T_DOC_DRW has to contain:


SHT_CNT S10 Sheet count

SCALE S10 Scale

ECC_VIEW_NAME S16 View

ECC_DRAFT_NAME S16 Draft



ECC_HAS_FILE L external

The table T_DOC_STR has to contain:


ECC_XMAT S200 Transformation matrix

ECC_COL S5 Color

ECC_PICK S5 Pick/No Pick

UG2_IDENT S40 Structure ident

ECC_SHOW S5 Show/No Show

Customizing Masks The masks EDB-DOC-3DM-TFR and EDB-DOC-3DM-TLI are used to manage the Catia model data. They have to contain the following fields:

Mask F ie ld A Menu Pre-F ie ld-Userexi t

EDB-DOC-3DM-TFR/TLI T_DOC_DAT.ECC_PROJECT r

T_DOC_DAT.CAX_CRE_SYSTEM r

T_DOC_DAT.ECC_NAM_FMT r

T_DOC_DAT. CAX_FIL_NAME r

T_DOC_DAT.CAX_FIL_OLD_NAME r

T_DOC_DAT. CAX_FIL_DISC m ECC-ANY-MEN CATEDB5/EccSelectModelArea T_DOC_DAT.CAX_LOCAL w

T_DOC_DAT.ECC_MODIFY_DATE r

T_DOC_DAT.ECC_ FILE_SIZE r



Sample of 3D_Model-Mask EDB-DOC-3DM-TFR

The masks EDB-DOC-DRW-TFR and EDB-DOC-DRW-TLI are used to manage the Catia drawing data. They have to contain the following fields:

Mask F ie ld A Menu Pre-F ie ld-Userexi t

ECC-DOC-DRW-TFR/TLI T_DOC_DAT.CAX_FRAME_ID m ECC-FRAME-

ID

T_DOC_DRW.ECC_VIEW_NAME r

T_DOC_DRW.ECC_DRAFT_NAME r

T_DOC_DAT.CAX_LOCAL r

T_DOC_DAT. CAX_FIL_DISC r

T_DOC_DAT. CAX_FIL_NAME r

T_DOC_DAT.CAX_FIL_OLD_NAME r

T_DOC_DAT.ECC_NAM_FMT r

T_DOC_DAT.ECC_PROJECT r

T_DOC_DAT.CAX_CRE_SYSTEM r

T_DOC_DAT.ECC_MODIFY_DATE r

T_DOC_DAT.ECC_ FILE_SIZE r

T_DOC_DRW.ECC_HAS_FILE r



Sample of Drawing-Mask EDB-DOC-DRW-TFR

Connector Environment Check the correct settings of environment variables described below. These variables must be adapted to the present installation environment.

Master Configuration File EdbInitialize.ini

After the integration is set up correctly, the behavior can be configured.

Configuration settings as well as customization are carried out in the mapping files located in the directory …EccRoot\ini.

Note Generally, mapping files must not contain empty rows!!!

The most important settings for the functioning of the Agile e6.1 - CATIA connector are given in the master configuration file, EdbInitialize.ini:

Sect ion Key Possib le /Defau l t Va lues Descr ipt ion

[ Initialize ] Basic values

EccLanguage English, German Language setting

EccMappingFile Edb.ini Name of the configuration file





EccMessages Ecc6Messages.ini Name of the message file

EccDefaultModelReleaseScheme CATIA Default release scheme of new models

EccDefaultArea WORK_ECC Default Catia model area

EccCheckProject Yes

Enable project check. If set to “Yes”, only the documents can be loaded which belong to the current Catia project.

EccModelType 3D_MODEL Document type of 3D models

EccDrawingType DRAWING Document type of 2D models

EccFrameLibrary ECC_RAHMEN Name of the Catia library which contains the frame details.

EccFrameIdent RAHMEN_ Prefix of the frame detail name.

EccReplaceSpace 0, 1

1 = Replaces spaces in file names with the sign for the value of the key "EccReplaceCharacter". 0 = Does not replace spaces.

EccReplaceInch 0, 1

1 = Replaces spaces in file names with the sign for the value of the key "EccReplaceCharacter". 0 = Does not replace spaces.

EccCharactersToReplace ° § $ % & / , @

Replaces the mentioned special characters in file names with the sign for the value of the key "EccReplaceCharacter".

EccReplaceCharacter _ This character is entered as replace character.

Fields

EccFileNameForDrawings

DEF: T_DOC_DAT.CAX_FIL_NAME

Field name for the drawing file name.

EccFileNameForModels

DEF: T_DOC_DAT.CAX_FIL_NAME

Field name for the part file name.

FieldOfFileSize T_DOC_DAT.ECC_FILE_SIZE Field name of the file size.

FieldOfModifyDate T_DOC_DAT.ECC_MODIFY_DATE Field name of the modification date.

Options

EccCheckFileNameDuringCheckout

0, 1 1 = Renames the file name when changing the document id. 0 = No rename of the file name.

EccUpdateFrameDuringSave

0, 1 1 = Updates frame before check-in. 0 = No update of frame




EccForceReplaceFrame

0, 1 For internal use only.

EccDevelopMode 0, 1 1 = Detailed error output. 0 = No error output.

UsePermanentConnect

0, 1 For internal use only.

EccUseAuthentication 0, 1 1 = Used for log in when using a "Secured ECI connect". 0 = Not used for log in.

EccDisableErrorOnGlobalView

0, 1 1 = EdbLoad disables error in global view. 0 = EdbLoad generates error in global view.

EccAllowCheckinOfNewDrawings

0, 1 1 = Creation of CATIA-drawings without start model is enabled. 0 = Creation of CATIA- drawings without start model is disabled.

EccAllowCheckinOfNewModels

0, 1 1 = Creation of CATIA-models without start model is enabled. 0 = Creation of CATIA- models without start model is disabled.

EccWriteHistoryAfterCheckin

0, 1 0 = Writes no history information into metadata set after check-in. 1 = Writes history information into metadata set after check-in.

Internal Structure of Mapping Files A mapping file describes any number of “quasi-static” parameters in a text file, i.e. these parameters can be determined during the project introduction phase.

The structure of a mapping file is as follows: [ SectionName ] Attribute = Value ... # : Comment symbol

The syntax of the attributes is: <key_value>:<attribute_value>

The <key_value> identifies the row, i.e. any sequence of attribute/value rows can be selected within a section in the mapping file. A particular row is ignored if invalid values are selected for <key_value>. The first entry of a <key_value> in the segment of a section is always valid unless otherwise specified. The following <key_values> can be used:


Accessing the Object Entity:

Key Value Descr ipt ion

DEF Default values for fields (multiple entries allowed).

DLM Flag for deleting the trash after the <on|off> operation.

ENT Name of the entity

MAS Name of the mask.

RES Reservation identifier <on|off>.

RET Return value (multiple entries allowed).

RMN An <on|off> switch to indicate if the widget should be closed after use.

SEL Selection criteria (multiple entries allowed).

SYS An <on|off> switch to access system fields.

TYP Type name of an entity.

WDG Type of the widget <list|form>.

Accessing the Object Relations:

Key Value Descr ipt ion

ENT1 Name of the parent entity.

ENT2 Name of the child entity.

MAS1 Name of the parent mask.

MAS2 Name of the child mask.

RDEF Default values for fields in the relation mask (multiple entries allowed).

RDEL Flag for deleting the trash after the <on|off> operation.

RES1 Reservation identifier for the parent widget <on|off>.

RMAS Name of the relation mask.

RRET Return value of the relation mask (multiple entries allowed).

RSYS An <on|off> switch to access system fields in the relation mask.

RWDG Type of the relation widget <list|form>.

SEL1 Selection criteria in the parent widget (multiple entries allowed).

SEL2 Selection criteria in the child widget (multiple entries allowed).

SYS1 An <on|off> switch to access system fields in the parent mask.

TYPE Type of the relation.

VIEW View name of the relation.

WDG1 Type of the parent widget <list|form>.



Customer Configuration File Edb.ini The name of the actual configuration file Edb.ini has been defined in the master configuration file EdbInitialize.ini. It contains customer specific values for creating the Agile e6.1 objects and definitions for the drawing frames. It is recommended to determine default settings in this file.



Chapter 4

Frame Mapping and Customizing For both, the 2D frame geometry and the titleblock, a CATIA draw detail is used as a template. These details are loaded out of a CATIA detail library which is defined in the mapping file “EdbInitialize.ini”: EccFrameLibrary = RAHMEN

”RAHMEN” must be a valid, accessible CATIA library which has to be defined in the CATIA declaration definitions, e.g: catia.LIBRARY = ´“/home/DB/ALL/rahmen“, „RAHMEN“´;

During the load and save process, this information is updated with the current values from Agile e6.1.

Allocation of the Agile e6.1 information and the placeholders are implemented in the Edb.ini and EdbInitialize.ini mapping files using the following definitions:

EdbInitialize.ini, definition of the prefix and the name scheme of the placeholders: EccFrameIdent = RAHMEN_ EccSchemeOfFrameIdent = RAHMEN_%-2.2s EccSchemeOfText = TEXT_%-2.2s

In Agile e6.1 the frame table contains the possible frames:

Here the user can choose the drawing form ECC-A0 – ECC-A4. These values are mapped via the Frame table to the CATIA library details RAHMEN_A0 – RAHMEN_A4, respectively TEXT_A0 – TEXT_A4.

The text details must contain placeholders. In the mapping file Edb.ini in the section ‘EccReadTitleBoxData’ the following syntax exists: RET:<placeholder> = <agile field name>

e.g: RET:DocId = T_DOC_DAT.DOCUMENT_ID RET:Draft = T_DOC_DRW.ECC_DRAFT_NAME RET:View = T_DOC_DRW.ECC_VIEW_NAME RET:SheetNo = T_DOC_DAT.SHEET_NO



Note If the titleblock update is initiated by the connector, the placeholder with the contents “DocId” will be overwritten with the contents of the Agile field T_DOC_DAT.DOCUMENT_ID.



Chapter 5

Additional Functions

Batch Functions Batch functions are functions for handling Catia models which can be started directly from the Agile front-end. These functions can be started either from Agile menus or by using LogiView procedures.

Batch functionality varies from customer to customer. Usually, it is possible to incorporate many of the interactive connector functions into Agile as batch functions. The menus for accessing these batch functions can then be customized.

It is not necessary to use Catia to access these functions. Catia runs on a special configured computer within the batch without starting a Catia display. All user requests for Catia files use this computer. After the job is processed, the result is sent back to the user. It is important to make sure the data security is not violated under this condition and that the process takes place in a connector conforming Catia environment.

Security Functions If Catia models are saved to the Agile fileserver (Cax Local: On), Agile takes care of the file management. If they are saved locally (Cax Local: On), the module Catctr controls the access.

Catia-File Areas

When the Catia environment is set up, the Agile managed areas are marked as such. Within a Catia session, these model areas are visible like every other model area. If necessary, any interactive access with Catia functions to these directories can be blocked. This is realized by using Catctr. The models in these areas can only be accessed by using connector functions. Other areas can be accessed using the Catia function File.





Chapter 6

Debugging The most profound view into the integration’s functioning enables tracing the ECI-calls which are sent from the local Agile client to the connected Agile server including the responds. A file is created on the Agile server machine which can be viewed by user using the client.

It is possible to start and to stop the ECI-trace at any time during the session.

The trace function is activated in Agile e6.1:

7. Click Tools > Trace > Select Module

8. Select the checkbox for ECI-Module E 9.

9. Click OK.

10. To start the trace log any time during the session, click Tools > Trace > Trace New.

The name of the new trace file is displayed in the message bar (e.g. Test output on …\tmp\tst173.trc).

Note The file location is on the Agile server machine!

11. Execute the process you want to test/trace.

12. To end tracing, click Tools > Trace > Trace Off.

13. To display the contents of the trace file in a list, click Tools > Trace > Show trace.

You can copy and paste the trace contents into an Excel file and save it locally.

Note The information in the trace file can be extended by e.g. adding SQL statements.




Documents

Oracle® Agile Engineering Data Management · customizing requests can be solved using the script language Tcl. Tcl is also available on different platforms. The architecture of the