SAP Engineering Control

Transcription

1 SAP Engineering Control Center Interface to CATIA V5 User Documentation CENIT AG Software Product / Components: Product Version: Creation Date: :27 Document Version: 5 Last Changed: :22 Page 1

2 Content 1 Preface 4 2 Terms and Abbreviations 5 3 Overview of the Integration Functions Starting the Integration Logon in SAP Starting CATIA V General overview over the available interface commands General information on selection of CATIA documents for commands Open ECTR New Create a Dependent Document Editing Save Save and Display Cancel Refresh: Refresh attributes Reload Refresh: Refresh originals Replace Import Save as a New Document Save As New Version Display Document Add to object list Add component Extras-Menu Show application structure Info 10 4 Integration Functions Creating CATIA Documents for the first time in SAP New Create Dependent Document Import Command Assembly Groups already in SAP Importing a CATDrawing Handling of stand-alone CGR files and V4 Models Loading CATIA Documents from SAP 15 Page 2

3 4.2.1 Display a Document to View Viewing Documents for Editing Editing CATIA Documents and Saving in SAP Editing Save Save and display Cancel Cancel Edit Creating Copies and New Versions of CATIA Documents Save as New Version Save as New Document SAP Engineering Control Center ++clone Module Add / replace components Add existing component to current document Replace Replace component in current document (extra menu command) Refresh of documents and attributes Refresh: Refresh attributes Refresh: Refresh originals 22 5 Demarcations and preconditions Supported link types Instance link View link Link to design tables CCP link Link from a process to a document in CATIA Link from an analysis document to a document in CATIA Unsupported link types KWE links 25 6 Appendix Copyright Open Source Software Original Apache 2.0 License 26 7 Illustrations 27 Page 3

4 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 4

5 2 Terms and Abbreviations Term/Abbreviation CATIA CCP DIR Logging Description CAD system from Dassault Systèmes Cut-Copy-Paste, a special CATIA link Document Info Record The placement of flow information during command execution for improving subsequent reproduction in case of error Page 5

6 3 Overview of the Integration Functions 3.1 Starting the Integration The is available, after installation, from the Windows start menu. The application is stored in the SAP PLM Integration folder as. 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. 3.2 Logon in SAP 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 V 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 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 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 Page 6

7 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 Open ECTR This command opens the main view of SAP Engineering Control Center New 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 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 Editing 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 Save 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. Page 7

8 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. 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 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 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 Reload 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 Refresh: Refresh originals Retrieve originals modified by other users from SAP PLM and replace in CAD session Replace Page 8

9 Replace original in CAD with original of a different document version from SAP PLM Import 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 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 Save As New Version 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 Display Document This command calls, for the selected CATIA document, the SAP ECTR Object browser to display the corresponding DIR data Add to object list This command adds the document of the current original to an object list in SAP Engineering Control Center Add component This command adds a new child component to the current selection. Page 9

10 Extras-Menu This drop-down-button offers two more commands: 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 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 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 in the upper right Info 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 10

11 4 Integration Functions 4.1 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 New 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 2: 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. Page 11

12 The newly created document is in edit mode and is locked by the current user Create Dependent Document A depending document is a document that can be assigned to an already existing leading document in SAP. 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 3: Associated Depending Documents Display In 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 12

13 Illustration 4: 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 Import Command 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 13

14 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 5: 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 6: Progress Window during Import 1 This applies only if the documents that are related to each other are imported together. Page 14

15 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 V 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 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 performed 2. If this not the case, an error message will be displayed by the and the import will be incomplete. The reason for these prerequisites is a technical limitation by CATIA. 4.2 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. 2 This is customized in the default configuration. Page 15

16 Illustration 7: Work view of the SAP Engineering Control Center There are two ways to view a document from SAP Engineering Control Center: Display a Document to View Illustration 8: Load a Document for Viewing Here, the primary original from the selected SAP document with all its components from the working directory of are downloaded and opened in CATIA V5. During this action the SAP document remains checked-in to SAP. Page 16

17 4.2.2 Viewing Documents for Editing Illustration 9: 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.3 Editing CATIA Documents and Saving in SAP Editing 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 Save This command is used to save an intermediate state of one or more processed documents in SAP. Page 17

18 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 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 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 10: Options for the selected originals Currently there are two options: Page 18

19 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! Cancel Edit Unlock originals in the SAP system, but keep the locally changed originals. 4.4 Creating Copies and New Versions of CATIA Documents Save as New Version 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: Illustration 11: 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! Save as New Document This command is used to create copies of CATIA documents already created in SAP. New DIR are created in SAP for the copies. Page 19

20 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! 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.5 Add / replace components 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 12: 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 20

21 4.5.2 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 13: Version replacement dialog 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 14: Replace component dialog Page 21

22 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. 4.6 Refresh of documents and attributes Refresh: Refresh attributes Refreshes CATIA properties and parameters of a document by DIR information stored in SAP PLM Refresh: Refresh originals This command refreshes local copies of PLM documents in the current CATIA session. Page 22

23 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 : Instance-links View-links Designtable-links CCP-links Links between CATProcess and CATAnalysis to CATProduct or CATPart 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 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 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 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 23

24 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. Hints: In SAP ECTR for CATIA V5, only copying of bodies is supported, not copying sketches. 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 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 importing to or saving in ECTR.The corresponding bill of documents is built when checking Page 24

25 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 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.2 Unsupported link types 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. Page 25

26 6 Appendix 6.1 Copyright 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 Open Source Software This product contains software, developed by the Apache Software Foundation ( 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: Page 26

27 7 Illustrations Illustration 1: Main window SAP Engineering Control Centers Interface to CATIA V Illustration 2: Create Document Dialog...11 Illustration 3: Associated Depending Documents Display...12 Illustration 4: Create depending Document...13 Illustration 5: Import Dialog...14 Illustration 6: Progress Window during Import...14 Illustration 7: Work view of the SAP Engineering Control Center...16 Illustration 8: Load a Document for Viewing...16 Illustration 9: Load Document for Editing...17 Illustration 10: Options for the selected originals...18 Illustration 11: Create New Document Version Dialog...19 Illustration 12: Part selection dialog...20 Illustration 13: Version replacement dialog...21 Illustration 14: Replace component dialog...21 Page 27