47
SAP Engineering Control Center Interface to CATIA V5 User Documentation CENIT AG Software Product / Components: ECTRV5 Product Version: 1.1.11 Creation Date: 28.08.2015 15:27 Document Version: 14 Last Changed: 04.02.2020 12:39

ECTRV5 SAP Engineering Control Center Interface to CATIA V5

  • Upload
    others

  • View
    7

  • Download
    0

Embed Size (px)

Citation preview

Page 1: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 1 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

SAP Engineering Control Center Interface to CATIA V5 User Documentation CENIT AG

Software Product / Components: ECTRV5

Product Version: 1.1.11

Creation Date: 28.08.2015 15:27

Document Version: 14

Last Changed: 04.02.2020 12:39

Page 2: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 2 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Content

1 Preface 5

2 Terms and Abbreviations 6

3 Overview of the Integration Functions 7

3.1 Starting the Integration 7

3.2 Logon in SAP 8

3.3 Starting CATIA V5 8

3.4 General overview over the available interface commands 8

3.4.1 General information on selection of CATIA documents for commands 8

3.4.2 Open ECTR 9

3.4.3 New master document 9

3.4.4 Create a Dependent Document 9

3.4.5 Edit document 9

3.4.6 Save document 9

3.4.7 Save and Display 9

3.4.8 Cancel 10

3.4.9 Refresh: Refresh attributes 10

3.4.10 Open original of dependent document 10

3.4.11 Refresh: Refresh originals 10

3.4.12 Replace original 10

3.4.13 Import into SAP PLM 10

3.4.14 Save as a New Document 11

3.4.15 Save as new version in SAP PLM 11

3.4.16 Display Document 11

3.4.17 Add to object list 11

3.4.18 Add component 11

3.4.19 Extras-Menu 11

3.4.20 Show application structure 12

3.4.21 About ECTRV5 12

4 Integration Functions 13

4.1 Prerequisites in case of new documents in the CAD session 13

4.1.1 Technical limits of automatic storage 14

4.1.2 Selecting the correct save strategy for new documents in the CATIA session 15

4.2 Creating CATIA Documents for the first time in SAP 16

4.2.1 New master document 17

4.2.2 Create Dependent Document 17

4.2.3 Command “Import into SAP PLM” 19

4.2.3.1 Assembly Groups already in SAP 21

Page 3: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 3 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.2.3.2 Importing a CATDrawing 21

4.2.3.3 Handling of stand-alone CGR files and V4 Models 21

4.2.3.4 Behavior on Messages of document creation in SAP 21

4.3 Loading CATIA Documents from SAP 23

4.3.1 Display a Document to View 23

4.3.2 Viewing Documents for Editing 24

4.4 Editing CATIA Documents and Saving in SAP 24

4.4.1 Command “Edit document” 24

4.4.2 Command “Save document” 25

4.4.3 Save and display 25

4.4.4 Cancel 26

4.4.5 Cancel Edit 26

4.5 Creating Copies and New Versions of CATIA Documents 26

4.5.1 Save as New Version on a single selected document 26

4.5.2 Command “Save as new version in SAP PLM” on multiple selected documents 27

4.5.3 Save as New Document 29

4.5.4 SAP Engineering Control Center ++clone Module 30

4.6 Add / replace components 30

4.6.1 Add existing component to current document 30

4.6.2 Command “Replace 31

4.6.3 Replace component in current document (extra menu command) 31

4.7 Refresh of documents and attributes 32

4.7.1 Refresh: Refresh attributes 32

4.7.2 Refresh: Refresh originals 32

4.8 Structural View in the Application Structure View 32

4.8.1 Scan level of the application structure view 33

4.8.2 Display drawings for a 3D 33

4.8.3 Switch documents loaded as CGR into work mode during structure analysis 35

4.8.4 Update all nodes of an assembly 35

4.9 Load document as selected 36

4.9.1 Configuration and prerequisites 36

4.9.2 Working with this command 36

4.9.3 Working with drawings 37

4.10 Maintenance of BOM properties 38

4.10.1 Changing the properties 38

4.10.2 Saving the properties 40

5 Demarcations and preconditions 41

5.1 Supported link types 41

Page 4: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 4 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

5.1.1 Instance link 41

5.1.2 View link 41

5.1.3 Link to design tables 41

5.1.4 CCP link 41

5.1.5 Link from a process to a document in CATIA 42

5.1.6 Link from an analysis document to a document in CATIA 43

5.1.7 Form links 43

5.2 Unsupported link types 43

5.2.1 KWE links 43

5.3 Annotation of using the version number in filenames 43

5.4 Working with the Customizing CheckForReadOnlyDocuments 44

6 Appendix 46

6.1 Copyright 46

6.2 Open Source Software 46

6.3 Original Apache 2.0 License 46

7 Illustrations 47

Page 5: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 5 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

1 Preface

This document describes the available commands for the SAP Engineering Control Center Interface to CATIA V5 and simple applications for the user.

This document assumes that the user is familiar with SAP Engineering Control Center and describes only the specific amendments for the SAP Engineering Control Center to CATIA V5 Integration.

Page 6: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 6 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

2 Terms and Abbreviations

Term/Abbreviation Description

CATIA CAD system from Dassault Systèmes

CCP Cut-Copy-Paste, a special CATIA link

DIR Document Info Record

Logging The placement of flow information during command execution for improving subsequent reproduction in case of error

Page 7: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 7 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

3 Overview of the Integration Functions

3.1 Starting the Integration

The SAP Engineering Control Center Interface to CATIA V5 is available, after installation, from the Windows start menu. The application is stored in the SAP PLM Integration folder as SAP Engineering Control Center Interface to CATIA V5.

Starting the application opens the following window:

Illustration 1: Main window SAP Engineering Control Centers Interface to CATIA V5

If an error occurs during the start of the application an error message will be displayed with an appropriate explanation of the problem. Depending on the problem it is sometimes possible to solve the problem by adjusting the configuration. Refer to the Installation and Setup documentation for further details.

Note:

The integration will only start, if the SAP Engineering Control Center is already running. If this is not the case, an error message will be displayed.

Note:

It is possible to configure a license check of the SAP Engineering Control Center to CATIA V5 on start-up. This can either be a warning or an error.

In case of a warning the following error dialog is displayed:

Illustration 2: Error dialog with a license warning.

After acknowledging the error, the SAP Engineering Control Center to CATIA V5 can be used as usual.

In case of an error the whole application start is aborted with the following message.

Page 8: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 8 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 3: Error dialog on application termination

3.2 Logon in SAP

SAP Engineering Control Center Interface to CATIA V5 uses the SAP logon data from the SAP Engineering Control Center. No further connection detail is necessary.

For this reason before the first start of Integration (after the installation) it is necessary to logon to the SAP system via the Engineering Control Center at least once.

After this first logon then the Engineering Control Center can be started via SAP Engineering Control Center Interface to CATIA V5.

3.3 Starting CATIA V5

CATIA V5 must be running before integration is started.

Should either more than one copy or CATIA or no copy of CATIA be running then, when a command is executed, an error message will be returned.

3.4 General overview over the available interface commands

3.4.1 General information on selection of CATIA documents for commands

The available commands within SAP Engineering Control Center for CATIA V5, will be performed for all the selected items in the assembly tree (orange colored selection).

The functions of SAP Engineering Control Center Interface to CATIA V5 apply to all available commands: the user selected commands are always executed together in the CATIA structure tree selected positions (orange colored selection). If no positions are selected from the structure tree then the commands are run from the head document of the active window. If there are no documents open in CATIA V5 then the command processing will terminate and an error message will be generated.

If the selected element in the assembly tree is of type CATIA component, automatically the parent element of this component is considered selected.

Page 9: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 9 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

3.4.2 Open ECTR

This command opens the main view of SAP Engineering Control Center.

3.4.3 New master document

This command creates a new DIR (Document Info Record) based on a template which is available in ECTR. For this, a new file, based on the template, is created and then opened in CATIA. To create a new document based on the active window and to retain no copy then use the Import command.

3.4.4 Create a Dependent Document

This command creates a depending document for the selected documentin CATIA V5 based on a template, which is available in ECTR.

Further details on this concept can be found in the Integration Functions chapter.

3.4.5 Edit document

This command switches for the selected documents in CATIA V5 into edit mode- that means the related SAP DIR are locked by the user (“lock open”) and taken in-work.

3.4.6 Save document

This command saves the selected document in SAP, as long there is a related DIR in SAP and the DIR is in edit mode for the current user.

After completion of the command the documents return to edit mode thus this command is in fact save intermediate state.

3.4.7 Save and Display

This command saves all selected documents including all child elements to SAP.

For this the CAD structure will be analyzed recursively up to a level, which is neither loaded for editing by the current user, nor locally modified on a file level. Every document below will be skipped.

Page 10: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 10 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

After the completion of the command, the documents are in display mode, the existing lock of the user is discarded automatically.

This command corresponds to a classic Checkin.

3.4.8 Cancel

This command cancels the editing mode of the selected documents and switches the documents into display mode. Please also refer to the notes in the Integration Functions chapter.

3.4.9 Refresh: Refresh attributes

This command starts the comparison of CATIA properties and parameters with the DIR information stored in SAP (characteristic values etc.). Here the attribute transfer rules, stored in the SAP Engineering Control Center, are applied.

3.4.10 Open original of dependent document

This command tries to open depending documents for a selected document. If the document has multiple depending documents a dialog will be displayed in ECTR allowing to select which document to open.

This command can be useful e.g. when trying to open an already existing drawing to a selected document, which is already available in SAP.

3.4.11 Refresh: Refresh originals

Retrieve originals modified by other users from SAP PLM and replace in CAD session.

3.4.12 Replace original

Replace original in CAD with original of a different document version from SAP PLM.

3.4.13 Import into SAP PLM

This command imports the selected document, and all its child elements, into CATIA V5 if there are no existing documents for this already in SAP. After the DIR system the new document(s) are automatically saved in SAP.

Page 11: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 11 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

3.4.14 Save as a New Document

This command saves a copy of the selected CATIA document that is already stored in SAP. This creates a new SAP document using the selected document as a template. The CATIA document will be renamed following the defined rules.

Please refer to the notes in the Integration Functions chapter.

3.4.15 Save as new version in SAP PLM

This command saves, for the selected CATIA document, a new version of the document in SAP. After versioning the document is automatically backed up in SAP.

Under certain conditions it is also possible to create a new version of multiple documents at once. Please refer to chapter 4.5 for further details.

3.4.16 Display Document

This command calls, for the selected CATIA document, the SAP ECTR Object browser to display the corresponding DIR data.

3.4.17 Add to object list

This command adds the document of the current original to an object list in SAP Engineering Control Center

3.4.18 Add component

This command adds a new child component to the current selection.

3.4.19 Extras-Menu

This drop-down-button offers two more commands:

Page 12: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 12 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Replace original

This command replaces all instances of the current selection in the current document. The replacement component has to be of the same type than the replaced one.

Cancel Edit

Release exclusive lock without discarding local changes of the original.

Change material BOM

This command opens a dialog for changing properties of the material BOM

3.4.20 Show application structure

This command sends the document structure of the current original to the Application structure window in SAP Engineering Control Center.

Remark: If the application structure window shows up a node „Generic Application Object“

beneath the CATIA node, you should adjust the layout using the button in the upper right corner of the application structure window:

1. Select „Generic Application Object“

2. Click and select „Change tree layout“

3. Select „ID“ and click 4. Press „OK“ or „Apply“

3.4.21 About ECTRV5

This command opens a window that gives information, e.g. version details, for the SAP Engineering Control Center and CATIA Integration. Additionally information relating to changes between the different software releases of CATIA Integration is also displayed.

Page 13: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 13 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4 Integration Functions

4.1 Prerequisites in case of new documents in the CAD session

For some commands it is necessary to save the affected documents before or after the actual execution of the command. Due to a technical limitation by CATIA, the state of new

documents in the CATIA Save Management may change from New to Open, though they are

not actually saved. This could lead to data loss on any subsequent commands.

To prevent this, the default behavior is, that without any explicit customizing, some commands will always abort execution in case new documents exist in the CATIA session. No selection dialog will be displayed, just an error message.

Illustration 4: Message about new documents in session

The following commands are affected by this behavior:

New master document

Ecit document

Save document

Save and Display

Refresh: Refresh attributes

Import dosumen

Save as a New Document

Save as new version in SAP PLM

Display Document

Show application structure

Opening of documents from SAP ECTR ( due to Refresh Attributes )

If you do not want this behavior, it is possible to customize a different strategy for handling new documents to keep the data in a valid state and minimize the disruption of the work flow. Unfortunately this may lead a drastic increase in the runtime of a command. The runtime then depends on the structure of the assembly and the selected strategy for saving.

It is not possible for the integration to detect if a new document belongs to the document on which a command is executed. Due to this the save process is also executed on other documents in the session, which may not belong to the active one.

A possible strategy for saving these document is configured by an administrator. Possible options are:

Abort directly and do not save.

Beginning from the current selection, save all new documents below into the windows temporary directory

Only save all new documents

Page 14: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 14 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

In case the automatic saving is aborted, an error message like Illustration 5 is displayed. The user himself will then have to deal with the new documents manually, so that the new message will not be displayed again.

Illustration 5: Error message when aborting automatic save

It is furthermore possible to customize an additional dialog like in Illustration 6, to allow the user to select a save strategy himself. If this dialog is cancelled the whole command is aborted and the selected command not executed.

Illustration 6: Selection of the save strategy to be used

4.1.1 Technical limits of automatic storage

In some cases, technical limits can be reached in the collaboration between CATIA V5 and ECTRV5. This can happen especially when storing documents, which can lead to unwanted behavior. This occurs especially with new documents in the CAD session that are not yet saved in the file system. This is briefly explained below.

Context-links between documents

Context-links must be avoided, since they can lead to unexpected behavior in the programmatic processing of documents in the CAD session. This is especially true between unsaved (new) documents and documents already saved in the file system. If there are context-links in an assembly with a mix of new documents and documents in SAP, the integrity of documents and assemblies cannot be guaranteed in all cases. This applies to documents that are temporarily stored and do not yet exist in SAP. An example.

A CATProduct-document and two CATPart-documents are added to an existing assembly from SAP ECTR. The structure is shown in Illustration 7. Manipulations to the documents are made out from this structure. None of the documents are opened separately. A 3D body is added to Part 1. This is copied and added to Part 2 as a result with link. In Part 2, instead of the expected CCP-link, an import and a context-link will be added. The import-link points to Part 1 and the context-link points to the root of the assembly. This can be seen in Illustration 8.

Page 15: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 15 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 7: Structure of the assembly (context-link)

Illustration 8: View of CATPart 2 shortcuts

This context-link results in the behavior, that CATIA automatically saves the Product-Document when Part 2 is saved programmatically. The behavior of CATIA is beyond the control of the integration ECTRV5. This is problematic because when automatically saving the new documents in the CAD session, existing files may be overwritten. This can violate the integrity of assemblies and documents.

In the example from above, the temporary directory already contains a file called Product1.CATProduct, which is another assembly than the currently loaded one. The root of the current assembly will be checked out with the integration. The automatic saving of all new documents in the CAD session is set as the storage strategy for new documents. The expectation would now be that after the automatic saving of the documents a file with the name Product1_1.CATProduct, which belongs to the document in the current CAD session, would be beside the file Product1.CATProduct. A look at the result shows, that no other file has been created in the temporary directory. Instead, the Product1.CATProduct file has been overwritten by CATIA. During the saving process, the integration also resulted in an error message, that the document was loaded from another directory in the CAD session. This is due to the new CATProduct document and cannot be prevented.

4.1.2 Selecting the correct save strategy for new documents in the CATIA session

It is not possible to give a recommendation for the correct save strategy. Depending on the structure of the assembly the time for saving the document may vary a lot.

This section will give some hints and boundary conditions to which strategy may be the most suitable. For this example, the configuration may be in such a way that the user gets to see Illustration 6 and no automatic cancellation is configured.

The save strategies:

1. from the selected documents

2. all new documents in the current CAD session

differ mostly in the number of documents which are evaluated for an automatic saving.

When selecting strategy #2 a partial scan starting from the selected document is performed and the result is checked for new documents, which will then be automatically saved.

For strategy #2 the complete CATIA session is checked for new documents. The result will then be automatically saved.

Page 16: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 16 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

For better understanding the differences and result sets please look at Illustration 9. This complex assembly has a high number of documents per node. Furthermore the assembly is already completely stored in SAP. To the highlighted node – a CATProduct-document deep in the assembly structure - a new CATProduct and CATPart document have been added. The command Editing is performed on the first highlighted node.

In this case save strategy #1 is the better strategy, since the scan is started beginning with this document which is already quite deep. The CATProduct and CATPart document are detected quite fast and used for saving. Other documents in the CATIA session are irrelevant.

Illustration 9: Example for a complex assembly in regards of a save strategy

For strategy #2 let us also use Illustration 9, but now we want to perform the command Editing on the root node of the assembly. In this case strategy #2 is the better choice as strategy #1 would start scanning the complete assembly only to detect the same amount of documents. A scan of a complete and complex assembly has a very large runtime. The disadvantage of strategy #2 is, that the whole CATIA session is checked for new document and then saved, some of which may have nothing to do with the current assembly.

4.2 Creating CATIA Documents for the first time in SAP

There are several approaches available to create a document in SAP Engineering Control Center to CATIA V5.

DIR creation in this context means the creation of a DIR and assigning a CATIA document as the primary original to that DIR.

Page 17: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 17 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.2.1 New master document

Selecting this command prompts a dialog box from which the document type to be created can be selected. In this dialog box certain fields can (and, depending on server settings, must) be populated with values.

Illustration 10: Create Document Dialog

A click on OK creates the document in SAP and opens it in CATIA V5.

The document displayed in CATIA V5 is based on a copy of the selected template.

The newly created document is in edit mode and is locked by the current user.

4.2.2 Create Dependent Document

A depending document is a document that can be assigned to an already existing leading document in SAP.

Page 18: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 18 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Example: A CATPart or a CATProduct can be have one or more CATDrawings (depending documents).

Such a DIR is referred to as Depending Document in the SAP Engineering Control Center:

Illustration 11: Associated Depending Documents Display

In SAP Engineering Control Center Interface to CATIA V5 it is possible to directly create a dependent document. Select Create depending document. This displays a selection dialog for the document type to be created. In this dialog box certain fields can (and, depending on server settings, must) be populated with values and a template document must be chosen.

Page 19: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 19 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 12: Create depending Document

A click on OK creates the document in SAP and opens it in CATIA V5.

The newly created document is in edit mode and is locked by the current user.

4.2.3 Command “Import into SAP PLM”

This command allows you to import individual documents, complete assemblies or just elements from an assembly, using the SAP Engineering Control Center, to SAP.

The execution of this command may take some time depending on the size and the complexity of the assembly.

It is performed on the actual document selected in CATIA V5. If no document is selected then the active document will be treated as the selected document.

Multiple selections are not possible and will generate an error message.

The structure of the selected document is analysed. Here, child elements, loaded in the CATIA view mode, are switched into design mode. This can lead to significant performance degradation.

Page 20: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 20 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

After the completion of the assembly group examination SAP Engineering Control Center the actual transfer of the document to SAP is executed. Depending on the configuration an import dialog is displayed from which the documents to be imported to SAP can be selected:

Illustration 13: Import Dialog

In this dialog it is possible to directly input information such as, e.g., relationship description, dependent documents etc.1.

After selecting the documents to be imported and confirming the selection with OK the actual import process proceeds producing the new DIR, updating the information to the originals in the CATIA session and appending the originals to the DIR.

Further details regarding the customization of the Import process can be found in the file Customizing.pdf.

During the execution the following progress window is displayed:

Illustration 14: Progress Window during Import

1 This applies only if the documents that are related to each other are imported together.

Page 21: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 21 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.2.3.1 Assembly Groups already in SAP

If the Import command is run on an assembly group that has already been created in SAP or whose documents have already been created in SAP then the import will only be performed for the documents for which no DIR exists in SAP.

Example:

A CATProduct with 2 built-in CATParts is loaded into CATIA V5 from SAP Engineering Control Center. An additional CATPart is built into the CATProduct. The additional CATPart is stored locally.

Now the CATProduct is selected and the Import command invoked. The import dialog will display the newly created CATPart in CATIA V5.

4.2.3.2 Importing a CATDrawing

If a CATDrawing refers to other CATIA documents which are not already created in SAP then this relationship is automatically detected at import and the other CATIA documents are added to the list of files to be imported.

4.2.3.3 Handling of stand-alone CGR files and V4 Models

For importing V4 models and stand-alone CGR files, files of these types have to be manually copied to the ECTR session directory before importing.

Furthermore, the DTypes of SAP ECTR have to be configured in such a way, that no renaming of those files is performed2. If this not the case, an error message will be displayed by the SAP Engineering Control Center Interface to CATIA V5 and the import will be incomplete.

The reason for these prerequisites is a technical limitation by CATIA.

4.2.3.4 Behavior on Messages of document creation in SAP

In case of problems during the creation of documents, these are reported back. Then a dialog as shown in Illustration 15 is displayed, which provides more detailed information on the aberrations that have occurred.

The dialog can be configured in dependence on the severity of the error. If an error occurs, it is displayed always. In this case, the import will be cancelled.

If less critical messages occur, such as for ignored documents, the dialog can be set administratively to not appear. In this case, the import is performed as before. When the administrative setting requires it, a dialog as shown in Illustration 16 appears for less critical messages. Here, the messages from the SAP system have to be checked in order to make a decision. After all, the import can be terminated or continued at this point. If the import is canceled, the documents are not renamed in CATIA, regardless of whether they were successfully created in SAP or not. In addition, no primary originals are stored for successfully created documents. If the import is continued, there is a potential risk that incomplete part lists may be created in SAP or subsequent operations may cancel with errors. In a case decision, it must be checked whether this is a problem for the continuation.

2 This is customized in the default configuration.

Page 22: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 22 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 15: Message dialog for errors that occurred during the creation of documents

Illustration 16: Dialog for less critical messages during document creation

Page 23: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 23 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.3 Loading CATIA Documents from SAP

To load CATIA documents with a DIR in SAP back into CATIA V5 the open ECTR command in SAP Engineering Control Center must be run.

Illustration 17: Work view of the SAP Engineering Control Center

There are two ways to view a document from SAP Engineering Control Center:

4.3.1 Display a Document to View

Illustration 18: Load a Document for Viewing

Page 24: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 24 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Here, the primary original from the selected SAP document with all its components from the working directory of SAP Engineering Control Center Interface to CATIA V5 are downloaded and opened in CATIA V5. During this action the SAP document remains checked-in to SAP.

4.3.2 Viewing Documents for Editing

Illustration 19: Load Document for Editing

Here, the primary original SAP document selected from the desktop window is downloaded with all its components in the working directory of SAP Engineering Control Center and opened in CATIA V5. The SAP document will be in edit mode (the lock is set by the user).

Warning: If the files already exist in the local working directory they will not be downloaded again from SAP!

4.4 Editing CATIA Documents and Saving in SAP

4.4.1 Command “Edit document”

If CATIA documents are loaded for viewing via SAP Engineering Control Center in CATIA V5 and are in display mode using the edit command switches the selected document into edit mode and the lock is set by the actual user.

The following applies:

- The documents in question cannot be used by other users in edit mode. - The documents in question must not have been modified by another user in the

meantime. - The documents in question must not have a status in the SAP status network where a

lock is not possible (e.g. release status)

If any of the situations described above occur the SAP Engineering Control Center will display an error message and abort the switch to edit mode.

Page 25: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 25 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.4.2 Command “Save document”

This command is used to save an intermediate state of one or more processed documents in SAP.

Selected documents in SAP must each have a DIR and must be locked by the current user (checked-out).

After this command is executed the saved documents remain in edit mode for the current user.

Using these commands it is irrespective of whether the assembly is itself in edit mode. If no element of the selection can be checked-in, a warn message will be displayed.

4.4.3 Save and display

This command is also used to save one or more documents in SAP. After execution the documents are returned to the view mode, this means that locks set by the current users are unset.

The document structure of the selected documents is only analysed for other documents, which need to be saved, up to a level, which is neither loaded for editing nor modified locally on a file level.

If it is necessary to have a command available, which always analyses the whole structure for documents to be saved below the selection and is not be bound to the aforementioned conditions, it can be integrated into the extras menu. To do so, please look into the customizing documentation. Using this command however you may experience a bad performance, since the document structure needs to be completely switched into the CATIA design mode to be able to analyze the structure correctly. In rare cases this could even lead to an unexpected shutdown of CATIA, if some technical limits of CATIA are reached.

Using these commands it is irrespective of whether the assembly is itself in edit mode. If no element of the selection can be checked-in, a warn message will be displayed.

Depending on the customization of the option CheckForReadOnlyDocuments it is possible to get an overview of the documents to be saved, prior the save operation in SAP ECTR. This overview contains local modified and/or checked out documents.

With this overview it is possible, to set checked in documents, which are not in a conflicted mode, into edit mode before the actual check in into the SAP system. It is also possible to cancel the whole save process, if documents are in a conflicted state e.g. if they are out-dated compared to their current state in SAP.

Illustration 20: Overview of modified read-only documents

Page 26: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 26 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.4.4 Cancel

This command exits the edit mode of the selected CATIA documents and removes the rules set by the user.

When selecting this command a dialog appears. This dialog contains options about what to do with the selected originals. For this command it is necessary, that at least one document needs to be in edit mode, otherwise an error message will be displayed.

Illustration 21: Options for the selected originals

Currently there are two options:

a) Close original in CAD: Clear the complete CATIA session, discard all changed originals and unlock the originals in the SAP system.

b) Reload original from SAP system: Discard the local changes, unlock the originals in the SAP system and reload the originals in CATIA

Warning: The automatic closing and reopening of loaded documents can, for large assemblies, take a long time. If the automatic closing and reopening of loaded documents is discarded and no interactively reopen is done by the user, an inconsistency occurs between the loaded documents in the current CATIA session and their files in the session directory!

4.4.5 Cancel Edit

Unlock originals in the SAP system, but keep the locally changed originals.

4.5 Creating Copies and New Versions of CATIA Documents

4.5.1 Save as New Version on a single selected document

This command creates a new version of the DIR, from the selected CATIA document in SAP,

which is assigned to the selected CATIA document.

Selecting this command prompts a window in SAP Engineering Control Center allowing you

to confirm the creation of a new version:

Page 27: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 27 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 22: Create New Document Version Dialog

If confirmed a new version of the DIR is stored and the selected CATIA document updated

with the information from the new version and then saved, with the new version number, in

SAP.

Warning: If the versioned document is part of a loaded CATIA V5 assembly then the parent

assembly will be modified according to the versioning in the CAD session – i.e. the parent

module must be switched to edit mode and stored in SAP!

4.5.2 Command “Save as new version in SAP PLM” on multiple selected documents

This functionality has to be enabled by the administrator.

Note:

Using this command on may lead inconsistencies in assemblies in case no new version could not be created for one or more documents when executing this command.

If the administrator enabled this functionality, it is possible to create a new version for a large number of documents.

If only one document is selected in CATIA, the behavior of this command is equal to the behavior explained in section 4.5.1.

If more than one documents are selected in CATIA and if the SAP state permits the creation of a new version for the documents, no feedback will be given. After the transfer of the documents to SAP, the information of all selected documents in CATIA will be refreshed.

If in dependency to the SAP state the creation of a new version for one or for several documents is not allowed, an error response will be provided. First a SAP ECTR message will be displayed as shown in Illustration 23. This message will be displayed for every failed document. It is not possible for the integration to suppress this message. It is a SAP ECTR failure message.

Page 28: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 28 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 23: Error Message on failure from SAP ECTR

After closing the error message from SAP ECTR, the integration asks how to continue with the process of creating a new version for multiple documents. A selection dialog as shown in Illustration 24 will be displayed. The user has to decide on how to continue.

In the selection dialog the last processed document will be displayed, on which the error occurred. The user has the choice to continue the process (confirmation with “yes”) or to abort the process (confirmation with “no”).

On abort the creation of new versions will be stopped. For any document, which has already received a new version number in SAP, the process will be completed. This is necessary to keep the documents consistent. For all other remaining documents of this process, a creation of a new version will be prevented whether a creation is possible or not.

Illustration 24: Request how to handle the failure

When the decision to continue is made, the process will be continued until the end or to the next failure. On every failure the choice dialog in Illustration 24 will be shown. To suppress this dialog until the end, the checkbox “Proceed on error without asking again” has to be checked combined with pressing the button “yes”.

On the end of the process for the creation of a new version with failures or on abort, a list like the one in Illustration 25 will be shown. The content of the list are the documents, for which an error response was be received. Displaying this list has only an informal character.

The amount of displayed entries is limited to 50 elements at first. By pressing the button “Show all...” all will be displayed. This is shown in Illustration 26.

Page 29: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 29 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 25: List of failed documents

Illustration 26: List of all failed documents

Attention: For all documents, where the creation of a new version has succeeded, the

parent assemblies and documents in the CAD session will be marked as modified. These

documents have to be switched into the edit mode and have to be saved in SAP to prevent

inconsistencies!

4.5.3 Save as New Document

This command is used to create copies of CATIA documents already created in SAP. New document info records are created in SAP for the copies.

If the template document was checked out before running the command “Save as new document”, the user will asked if he wanted to cancel checkout this document. The appearance of the dialog depends on the customizing of SAP ECTR.

Page 30: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 30 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Warning: If the new document is part of a loaded CATIA V5 assembly then the parent

assembly will be modified according to the renaming in the CAD session – i.e. the parent

module must be switched to edit mode and stored in SAP!

4.5.4 SAP Engineering Control Center ++clone Module

In addition to the described methods for copy or new version of documents, it is possible within SAP Engineering Control Center to copy entire assemblies with all dependent documents using the clone context of ECTR. For further information about the clone context please refer to the SAP Engineering Control Center documentation.

4.6 Add / replace components

4.6.1 Add existing component to current document

Using this command a single component in SAP Engineering Control Center can be inserted to the current document. It is added as a child of the current selection. Multiple selections are impossible in ECTR as well as in CAD. Repeated use of this command should be used instead.

Illustration 27: Part – selection – dialog

This dialogue is used to select a component to insert. Selection may be done by part number, ECTR window, SAP-GUI and some more possibilities.

Page 31: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 31 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.6.2 Command “Replace

The selected document in CAD will be replaced by a different version form PLM.

Note: All documents in CATIA session will closed and reopened.

Illustration 28: Version – replacement – dialog

Attention: This functionality is only available for CATParts and CATProducts. Furthermore the parent document needs to be a CATProduct. All other types of documents are not supported.

4.6.3 Replace component in current document (extra menu command)

Using this command all instances of a component can be replaced in a document. The new component is selected via an ECTR-dialogue. The selected component needs to be of the same type than the one to be replaced.

Illustration 29: Replace – component – dialog

This dialog is used to select a component for replacement. Selection may be done by part number, ECTR window, SAP-GUI and some more possibilities.

Page 32: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 32 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Attention: This functionality is only available for CATParts and CATProducts. Furthermore the parent document needs to be a CATProduct. All other types of documents are not supported.

4.7 Refresh of documents and attributes

4.7.1 Refresh: Refresh attributes

Refreshes CATIA properties and – parameters of a document by DIR information stored in SAP PLM.

4.7.2 Refresh: Refresh originals

This command refreshes local copies of PLM documents in the current CATIA session.

4.8 Structural View in the Application Structure View

With the command Show application structure (see section 3.4.20 – Show application

structure), it is possible to display structure information of a document selected in CATIA

within the Application Structure View (ASV).

There are options available for the command that affect the presentation in the ASV. These

can be found in the preferences menu of the SAP ECTR, which can be accessed via the

gear icon in the upper right corner of the SAP ECTR main window, as shown in Illustration

30.

Illustration 30: Location to open the preferences menu in the SAP ECTR main window

In general, the options for the CATIA V5 integration can be accessed at

Application → CATIA V5. The options especially for the ASV can be accessed via the

node Application Structure.

Within this node, there are settings for the scan depth and for managing the representation of

2D documents to 3D documents.

Page 33: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 33 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 31: Preferences menu from the SAP ECTR

4.8.1 Scan level of the application structure view

With this option you can define how many levels in the active CATIA document are analyzed

and passed to the application structure view.

Any positive number can be entered to change the number of levels to be scanned. If you

enter ALL, the active document will be completely analyzed and passed to the application

structure view.

The default value for this option is 1 which is also the default value in case of an invalid input.

4.8.2 Display drawings for a 3D

Using the setting Load Drawings as part of the node Application Structure it is possible to

display drawings for a given 3D document in the application structure, if theses drawings are loaded in the CATIA session. An automated resolving of drawings from SAP PLM is not

possible. By default this is set to No.

To get an easier overview it is possible to display an additional top node called Drawings above the drawings by setting the option Display ‘Drawings’ container to Yes.

Illustration 32 shows the effect this option has on the ASV. For example, below the

component Assembly_R24_DL_Analysis_1_49.CATProduct, its child and the associated 2D

are shown here.

Page 34: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 34 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 32: View in the ASV with the enabled option Load Drawings

To improve the overview, the option Display container ‘Drawings’ can be set. If this

option is set to Yes, a node called Drawings will be inserted over existing child drawings, as

shown as an example in Illustration 33.

Illustration 33: ASV with the enabled option Show container 'Drawings'

Page 35: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 35 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.8.3 Switch documents loaded as CGR into work mode during structure analysis

Using the setting Switch documents loaded as CGR into work mode during

structure analysis it is possible to alter the behavior of the structure analysis used for the

application structure view. Setting this option to no, CATParts, which are loaded as CGR, are

not switched into design mode. This may lead to an incomplete display of the structure, as Design tables and CCP links cannot be analyzed for CATParts which are loaded as CGR. By

default this setting is set to yes.

The following specialties in behavior need to be considered when setting this option to no:

If a CATPart is expanded using the +-symbol in the application structure, it will be put into design mode. If no +-symbol for the CATPart is available, due to using the scan depth ALL, the structure analysis of the CATPart can be triggered anyway using the command “Update structure”. For this the CATPart has to be selected in the Application Structure first.

Illustration 34: Update a CATPart loaded as CGR in the ASV with Scan depth ALL

4.8.4 Update all nodes of an assembly

As of ECTR version 5.2.2, the ASV supports the reloading of all nodes of an assembly. To do this, there is a menu item under the "Tree Manager" button: "Expand all nodes from CAD". Here a complete scan (scan depth=ALL) of the active window is carried out. This can take some time.

Illustration 35: Expand all nodes of an assembly in ASV

Page 36: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 36 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.9 Load document as selected

4.9.1 Configuration and prerequisites

You find the configuration of this command as well as some prerequisites in the customizing documentation within the chapter of the same name.

The command Load document as selected allows you to partially load an assembly from a SAP system into CATIA using the assembly window of SAP ECTR. Use this functionality carefully, so you do not experience some unexpected side effects.

When executing this command only the documents selected in the assembly window are copied into the SAP ECTR session directory. Therefore the session directory needs to be in a conflict free state prior executing this command, e.g. by deleting it completely. You need to avoid having any preliminary results of parts or assemblies in your session directory, when executing partial load in which these documents have been deselected.

After the load is complete the missing components of the loaded assembly are displayed as broken links within CATIA V5.

It is strongly recommended to perform this command only on documents which are checked-in and to disallow setting any documents to work mode so that no inconsistent bill of materials are created during checkin.

4.9.2 Working with this command

This command is available as a right-click command within the assembly window.

When executing this command, all selected positions will be loaded into the ECTR session directory.

Illustration 36: Load document as selected

The missing position are displayed as a broken link within CATIA V5.

Page 37: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 37 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 37: An assembly with missing positions

In should not be possible to set such an assembly in edit mode. It is not recommended to do this in any other way or disable the customizing, which would allow this.

Due to technical reasons it is not possible to directly download missing position in such an assembly with the CATIA V5 integration as it is not possible, to get the file behind such a broken link. It is however possible to call “Refresh originals” on the parent of such a missing position. This will then download all missing components and reload the document, so that they are displayed.

It is also possible to set the checked position in the assembly window using the Visual Enterprise Viewer with a customized command. This also allows the end user to set a selection and load the corresponding documents according to a given bounding box.

4.9.3 Working with drawings

Loading a document as selected is not limited to working with 3D documents. It can also be done with drawings. However you must keep one thing in mind: Never update the drawing using any commands available for this within CATIA V5. When updating a drawing the currently loaded 3D is used for displaying all the lines. As this 3D contains missing components, those missing components are not drawn in the drawing. Hence the drawing is wrong.

Illustration 38: Valid selection of a drawing

If all components of the first level of the drawing are available in the ECTR session directory, this drawing can be set into edit mode without any problems. You can alter this drawing, e.g.

Page 38: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 38 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

modifying the title block, and then store it back in SAP using the integration. However it is not recommended to work in such a way, as a single misstep may lead to the loss of any temporary results so far.

4.10 Maintenance of BOM properties

4.10.1 Changing the properties

Open the dialog for changing certain properties by clicking on “Change material BOM” in the extras menu.

This command only supports single selection. Furthermore this command only works for documents which are already in SAP. The dialog will only display the child documents of the first level. Children which are not in SAP e.g. because they are new, will not be displayed.

Illustration 39: Dialog for changing the material BOM

For every instance of a child document an entry is created in the table. The first columns contain the identificator of a child document, consisting of the file name at the first position and its instance identifier at the second position.

By clicking on a cell in the column “Relevance for BOM” the relevancy of this entry for the creation of a BOM can be altered.

Page 39: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 39 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 40: Options for the material BOM

Currently the following options are available:

Option Meaning

Include The selected position is relevant for the material BOM and will be taken for generation. Child documents for this position are handled separately.

This is the default.

Exclude with its children The selected position and all its children are not relevant for the material BOM and will be ignored for generation.

Exclude The selected position is not relevant for the material BOM and will be ignored for generation. All associated child documents are handled separately and can be part of the material BOM.

For saving these changes the document needs to be stored in SAP. It does not matter whether the command “Save” or “Save and Display” is used. Furthermore the following rules do apply:

Modifying the material BOM properties will not set the corresponding document modified. Hence the document will not be displayed as modified in the application structure view, the check read-only dialog or the CATIA save management.

When the parent document is renamed, e.g. when calling the command “Save as a New Document”, the changes made to the material BOM are not copied to the new document and need to be configured again.

Page 40: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 40 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

4.10.2 Saving the properties

All alterations to the material BOM will be transferred to SAP only on save operations which are SAP relevant, e.g. “Save” or “Save and Display”. The following option needs to be configured in the mwconfig.xml as well

<boolelement name="SetComponentIDForComponents" value="true"/>

If the document already has a release indicator in SAP, the material BOM cannot by altered by the CAD integration anymore. You the need to directly use the capabilities of Advanced BOM, e.g. via SAP GUI.

Page 41: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 41 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

5 Demarcations and preconditions

5.1 Supported link types

In CATIA V5 exist several link types between 3D models. Furthermore, there are links between drawings or processing data depending on 3D geometry. The following link types

are supported by the SAP Engineering Control Center Interface to CATIA V5:

Instance-links

View-links

Designtable-links

CCP-links

Links between CATProcess and CATAnalysis to CATProduct or CATPart.

5.1.1 Instance link

Instance links are links of the product to the components of its structure. These links are the structure information of the product. The structure of the product will be analyzed in CATIA while importing to or saving in ECTR. The corresponding bill of documents is built upon check in of the documents into SAP system. By building the bill of documents, all necessary parts of the products will be taken into consideration at all further loadings of the product.

5.1.2 View link

A view link is a link from a CATIA V5 drawing to a document of CATIA. Each view of a drawing has its own link to the respective object. This link is automatically created when a drawing with a reference to a CATIA document is created. The links of the drawings will be analyzed in CATIA upon importing to or saving in ECTR. The corresponding bill of documents is built when checking in the documents into SAP system. By building the bill of documents, all necessary parts will be taken into consideration at all further loadings of the drawing.

5.1.3 Link to design tables

It is possible to use parameters with different values to generate a model. For this the so called design tables exist. Design tables are EXCEL tables or textual files separated from the CATIA document. CATIA creates an external link from the CATIA document to the design table. Upon importing to or saving in ECTR will be scanned for links to design tables. These linked design tables are automatically analyzed and sent to the CAD view as child of their respective CATIA documents. The corresponding bill of documents is built when checking in the documents into the SAP system. By building the bill of documents, all necessary design tables will be taken into consideration at all further loadings of the CATIA documents.

If a design table is linked with several parts or products, it is important to import the superordinate product completely during the import. Otherwise, the linking of all affected parts or products to the renamed construction table cannot be guaranteed.

5.1.4 CCP link

Upon copying a body and pasting it into another part out of its original environment with “Paste Special … -> As Result with Link” a CCP link (CCP – Cut Copy Paste) is created by CATIA V5. In the new part a volume will be inserted (a body, which contains only geometry without any additional data). This body is depending on its original. Any changes in the original produce changes in the volume.

Page 42: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 42 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

In addition, a body inserted by Insert -> Body can be created with the "Assemble ...", "Add ...", "Remove ...", "Intersect ..." and "Union Trim ..." functions under "Insert -> Boolean Operations" be added to the main body of the part.

Furthermore, the body can be published in the original part and with the resulting publication a CCP link can be created in one of the ways described above.

Hints:

• In SAP ECTR for CATIA V5, only copying of bodies is supported, not copying sketches, planes, axis systems, parameters, surfaces, lines and points.

• If a body is copied from a part to a new part via "Paste Special ... -> As Result With Link" in the context of a product, no CCP link is created. This creates an import link and a context link.

CCP links with loaded original part in CATIA

When importing the complete document containing the link, make sure that the source part is loaded. Only under this condition can the link be analyzed.

In this case, the structure of the document will be analyzed with the link in CATIA, and the corresponding document parts list for this document will be created in SAP during the subsequent check-in.

Due to the structure of the document bill list, all necessary dependent documents for the relevant document are taken into account during subsequent loading operations.

CCP links without loaded original part in CATIA

If only the new part is loaded in CATIA and the source part is not, the link cannot be resolved. In this case, a warning message is issued to the user. The link will be lost on import.

If the document is created and checked in in SAP anyway, it can lead to inconsistencies because the linked part does not exist when it is loaded on other computers or the work directory has been emptied in the meantime.

How SAP documents are created with CCP links

If a document with a supported CCP link has already been created in SAP, it is important that the linked part is loaded in CATIA for each check-in process to analyze the structure. Otherwise the assignment of the link will be lost.

Treatment of irreversibly broken links

There are problems with irreversibly separated links (if there is no connection between the volume and the original and cannot be restored). CATIA V5 introduces this information to the parts as so-called "irreversibly broken links".

CATIA, for example, creates irreversibly broken links when a body is copied and inserted into a new part via "Paste Special ... -> As Result". These links are also created when importing STEP files.

In these cases, SAP ECTR Interface to CATIA V5 recognizes a link that cannot be resolved. However, this link is not distinguishable from links whose original part is not loaded in CATIA. For this reason, a warning is displayed to the user.

5.1.5 Link from a process to a document in CATIA

A link from a process to a document in CATIA is created when creating a process from a document in CATIA or when a document is added to the process within the process context. This link is a document link. The links of the process will be analyzed in CATIA upon

Page 43: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 43 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

importing to or saving in ECTR .The corresponding bill of documents is built when checking in the documents into SAP system. By building the bill of documents, all necessary parts will be taken into consideration at all further loadings of the process.

5.1.6 Link from an analysis document to a document in CATIA

When creating an analysis document from a document in CATIA an external link from the analysis document to the document in CATIA is created. This link is a document link. The links of the analysis document will be analyzed in CATIA upon importing to or saving in ECTR. The corresponding bill of documents is built when checking in the documents into the SAP system. By building the bill of documents, all necessary parts will be taken into consideration at all further loadings of the analysis document.

5.1.7 Form links

This is an alternative representation of an instance in a product. This link type is needed to build V4 models and CGR files in a product.

A form link can be created as follows:

Insert a V4 model or a CGR file into a product with “Insert -> Existing Component …”. This creates a new component in the product that contains the V4 model or the CGR file as an alternative representation.

Selection of “Representations -> Manage Representations …” in the context menu of an instance in a product and associate a V4 model or a CGR file in appearing dialog.

These links will be analyzed in CATIA for V4 models and CGR files while importing to or saving in ECTR. The corresponding bill of documents is built when checking in the documents into the SAP system. By building the bill of documents, all necessary parts will be taken into consideration at all further loadings of the product or part document.

5.2 Unsupported link types

5.2.1 KWE links

When copying and pasting a parameter via "Paste Special ... -> As Result With Link" from a part or product into a new one, a Knowledge-ware-expert link ("KWE link") is created.

This type of link is not supported in the SAP ECTR Interface to CATIA V5.

5.3 Annotation of using the version number in filenames

In SAP ECTR it is possible to append the version number from a document in its filename. When the configuration of SAP ECTR is set to do so, some attention has to be payed to different things.

It is strongly recommended to not use the version number in the filename. CATIA V5 is a file based CAD-System, which partly builds up the assembly structure upon the filenames. The use of the version number in the filename can lead to some unresolvable or complex solvable problems.

If the version number should be used in the filename and all is well configured from the administrator, the user has to set the load rule in SAP ECTR to “AsSaved”. If this does not happen, SAP ECTR provides documents according to the loading rule. This can lead to the lack of providing documents, which are assembled in an assembly. These missing documents will be damage the structure of the assembly in CATIA V5, which leads

Page 44: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 44 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

to broken link warnings for the assembly. This may lead to an inconsistence assembly in SAP, if the broken structure is saved in SAP.

The replacement of a document with another version will be done in the whole CAD Session. In this replace process, ECTRV5 has a technical limitation on linked documents. As an example, a CATPart-document P is used (multiple times) in an assembly A. At the same time, the CATPart-document X contains the document P as MML. Document X is also used (multiple times) in assembly A. On one of the documents P in the assembly A, the command “Replace with other version” is executed. The user chooses, that P should be replaced from version 03 to 05. While processing the command, all occurrences of P are replaced in assembly A. Occurrences of P in document X will be ignored by this command, they will stay at version 03. This is due a technical limitation, where a replace is not possible of documents used in MMLs by ECTRV5.

Some more attention has to be given to CATAnalysis-, CATDrawing- and CATProcess-documents. The update of this documents will not be done automatically. If there has to be some replacement, it has to be done manually to obtain consistency.

5.4 Working with the Customizing CheckForReadOnlyDocuments

Depending on how CheckForReadOnlyDocuments has been customized, the connected overview dialog is displayed for some command.

With this overview it is possible, to set checked in documents, which are not in a conflicted mode, into edit mode before the actual check in into the SAP system. It is also possible to cancel the whole save process, if documents are in a conflicted state e.g. if they are out-dated compared to their current state in SAP.

Illustration 41 Overview of modified read-only documents

By default, this option is not activated and no dialog is displayed.

If this option has the value OnDemand, the dialog is only displayed, if the command affects documents, which are not checked out, but modified locally and the command to save will make the documents read-only again.

Using the value Always, the dialog is displayed on the same conditions as OnDemand. Additionally the dialog is displayed even if no action is necessary.

Page 45: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 45 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

Illustration 42 Dialog without conflicting documents

In addition to the Save and Display command, this dialog is also used for the commands

Import

Save as new version

Save as new document

because these operations store the affected documents directly in SAP.

Note that when using this feature, mapped CATIA parameters are updated after they have been saved in SAP. This can lead to the assumption that values of CATIA parameters that have been modified by the user are synchronized incorrectly from the SAP system. This is a technical limitation. The values modified by the user are properly stored in the SAP system.

The limitation is due to the fact that before a document is saved in SAP, its SAP attributes are retrieved and buffered. During storage in SAP, the current values of the CATIA parameters are read from a document and stored in SAP at the corresponding DIS. After this has been successfully performed, the CATIA parameters are updated with the buffered values from the SAP attributes and the corresponding document is saved locally on the file system.

To prevent later failures when saving a document in relation to the attributes, the attributes have to be refreshed after each document has been saved. This refreshes the CATIA parameters of a document with the current values from SAP and synchronizes them accordingly when they are saved later in SAP.

Page 46: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 46 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

6 Appendix

6.1 Copyright

© 2014-2019 Cenit AG. All rights reserved.

This publication or parts of this publication may not be reproduced or transmitted in any form or for any purpose without the express permission of Cenit AG.

SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or a SAP affiliated company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.

For additional trademark information and notices refer to

https://www.sap.com/corporate/de/legal/copyright.html.

6.2 Open Source Software

This product contains software, developed by the Apache Software Foundation (http://www.apache.org/).

Parts of this software were developed by the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This software contains source code, derived from the RSA Data Security Inc. MD5 Message-Digest-algorithm, among different modifications from Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

For processing of regular expression this software is using the PCRE library package, an Open Source Software, developed by Philip Hazel and is under the copyright of the University of Cambridge England. The original software is available at:

ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

6.3 Original Apache 2.0 License

The original text of the used Apache licenses (Version 2.0 from January 2004) for this product can be found:

http://www.apache.org/licenses/.

Page 47: ECTRV5 SAP Engineering Control Center Interface to CATIA V5

SAP Engineering Control Center Interface to CATIA V5

ECTRV5

Page 47 SAP Engineering Control Center Interface to CATIA V5

Customizing Dokumentation

7 Illustrations

Illustration 1: Main window SAP Engineering Control Centers Interface to CATIA V5 ............ 7 Illustration 2: Error dialog with a license warning. .................................................................. 7 Illustration 3: Error dialog on application termination ............................................................. 8 Illustration 4: Message about new documents in session .....................................................13 Illustration 5: Error message when aborting automatic save .................................................14 Illustration 6: Selection of the save strategy to be used ........................................................14 Illustration 7: Structure of the assembly (context-link) ...........................................................15 Illustration 8: View of CATPart 2 shortcuts............................................................................15 Illustration 9: Example for a complex assembly in regards of a save strategy .......................16 Illustration 10: Create Document Dialog ...............................................................................17 Illustration 11: Associated Depending Documents Display ...................................................18 Illustration 12: Create depending Document .........................................................................19 Illustration 13: Import Dialog .................................................................................................20 Illustration 14: Progress Window during Import ....................................................................20 Illustration 15: Message dialog for errors that occurred during the creation of documents ....22 Illustration 16: Dialog for less critical messages during document creation ...........................22 Illustration 17: Work view of the SAP Engineering Control Center ........................................23 Illustration 18: Load a Document for Viewing ........................................................................23 Illustration 19: Load Document for Editing ............................................................................24 Illustration 20: Overview of modified read-only documents ...................................................25 Illustration 21: Options for the selected originals...................................................................26 Illustration 22: Create New Document Version Dialog ..........................................................27 Illustration 23: Error Message on failure from SAP ECTR .....................................................28 Illustration 24: Request how to handle the failure .................................................................28 Illustration 25: List of failed documents .................................................................................29 Illustration 26: List of all failed documents ............................................................................29 Illustration 27: Part – selection – dialog ................................................................................30 Illustration 28: Version – replacement – dialog .....................................................................31 Illustration 29: Replace – component – dialog ......................................................................31 Illustration 30: Location to open the preferences menu in the SAP ECTR main window .......32 Illustration 31: Preferences menu from the SAP ECTR.........................................................33 Illustration 32: View in the ASV with the enabled option Load Drawings ...........................34 Illustration 33: ASV with the enabled option Show container 'Drawings' ....................34 Illustration 34: Update a CATPart loaded as CGR in the ASV with Scan depth ALL .............35 Illustration 35: Expand all nodes of an assembly in ASV ......................................................35 Illustration 36: Load document as selected ...........................................................................36 Illustration 37: An assembly with missing positions ...............................................................37 Illustration 38: Valid selection of a drawing ...........................................................................37 Illustration 39: Dialog for changing the material BOM ...........................................................38 Illustration 40: Options for the material BOM ........................................................................39 Illustration 41 Overview of modified read-only documents ....................................................44 Illustration 42 Dialog without conflicting documents ..............................................................45