User Guide - help.sap.com

User Guide

SAP Engineering Control Center Interface to ECADFor: Cadence OrCAD CIS

Product version: 1.0.4.0Publishing date: 29.10.2019 | Build number: 1.0.4.0.9

XPLM Solution GmbH

Altmarkt-Galerie

Dresden Altmarkt 25

01067 Dresden

Office: +49 351 82658-0

Fax: +49 351 82658-88

Web: www.xplm.com

Legal informationCopyrights and trademarks

This document contains information protected by copyright. All rights, including those of the translation, arereserved. No part of this documentation may be reproduced in any form (print, photocopy, microfilm or in anyother form) or processed, copied or distributed using electronic systems without the written permission ofXPLM Solution GmbH. The information contained in this documentation does not represent a legal obligationfor XPLM Solution GmbH. The described software is delivered under a license agreement that regulates itsuse. All trademarks are the property of their respective owners.

Disclaimer

XPLM Solution GmbH is not liable for errors in this documentation. This documentation may contain linksto web sites of other companies or organizations that XPLM Solution GmbH does not own or control.XPLM Solution GmbH neither checks the accessibility of these websites nor makes any representations.The information in this document is based on a standard installation. The actual appearance of a specificinstallation may vary depending on the local environment and configuration realized for the individualcustomer requirements.

Support

If you encounter problems with the integration, please check the knowledge base at https://support.sap.com,or create a ticket.

Privacy policy

Compliance with applicable privacy laws is very important to XPLM Solution GmbH. In the light of the EUGeneral Data Protection Regulation (GDPR), XPLM Solution GmbH informs about the handling of personaldata when using the integration.

The integration itself does not "store" personal data in a general sense, but merely exchanges informationbetween ECAD and PLM in attributes. Whatever is defined in these attributes is left to the definition of thecustomer. For example, if the integration is configured accordingly, user data like first and last name aretransferred from PLM to ECAD in order to be used in the drawing frame and generated outputs.

External log files are saved by the integration on the user’s computer to record actions and progress ofintegration functions. Depending on the selected log level, these log files also contain information fromWindows environment variables, for example the Windows user name.

■ Attribute information exchanged between ECAD and PLM is represented in the file metadata.xml. Thisfile is saved in the configured project directory or, depending on the ECAD tool used, directly in the projectfiles.

■ Log files are saved by default in the directory %TEMP%\integrate. This directory can be deleted, but newlog files are created when the integration is used again.

XPLM Solution GmbH also refers to the privacy policies of the ECAD vendors and SAP's Security Guide forDocument Management (DMS) for information about how personal information is handled in their systems.

User Guide www.xplm.com ii

https://support.sap.com

https://launchpad.support.sap.com/#/notes/2627073

https://launchpad.support.sap.com/#/notes/2627073

Table of ContentsGlossary.......................................................................................................... 5

1 Introduction........................................................................................ 71.1 About this document........................................................................................... 71.2 Abbreviations........................................................................................................71.3 Overview of the integration.................................................................................7

2 Functional description...................................................................... 82.1 Datamodel..............................................................................................................82.2 Module dialogs..................................................................................................... 92.2.1 Menu bar.............................................................................................................. 10

2.2.2 New ECAD Project...............................................................................................11

2.2.3 Save......................................................................................................................122.2.3.1 BOM Comparison dialog................................................................................................................ 15

2.2.4 Edit........................................................................................................................17

2.2.5 Synchronize Parts................................................................................................ 19

2.2.6 Event log...............................................................................................................21

2.2.7 Integration Visualization Server............................................................................22

2.2.8 Working with module dialogs............................................................................... 24

3 Using the integration.......................................................................253.1 Creating new design.......................................................................................... 253.1.1 Creating new design from template in the file system......................................... 25

3.1.2 Creating new design from design in the file system............................................ 25

3.1.3 Creating new design from design in ECTR......................................................... 26

3.1.4 Creating new design from template in ECTR...................................................... 26

3.2 Saving design in ECTR......................................................................................273.2.1 Saving design.......................................................................................................27

3.2.2 Manually linking design........................................................................................ 28

3.2.3 Controlling the reservation................................................................................... 29

3.2.4 Saving PCB information....................................................................................... 29

3.2.5 Saving assembly information and BOM...............................................................30

3.2.6 Working with change numbers in ECTR..............................................................31

3.3 Opening design from ECTR.............................................................................. 31

User Guide www.xplm.com iii

3.3.1 Opening non-reserved design for editing.............................................................31

3.3.2 Opening reserved or released design..................................................................32

3.4 Synchronizing components and materials......................................................323.4.1 Creating missing materials...................................................................................33

3.4.2 Synchronizing a new component......................................................................... 33

3.4.3 Linking component to material............................................................................. 34

3.4.4 Synchronizing attribute changes.......................................................................... 34

3.5 Releasing and revising design......................................................................... 35

4 Troubleshooting............................................................................... 364.1 Enabling debug logging.................................................................................... 364.2 Reporting a problem.......................................................................................... 36

User Guide www.xplm.com iv

GlossaryAssembly data

Defines an output file with the assembly data of the PCB. Saved by default as original to Assemblydocument.

Assembly document

Defines a datamodel object in ECTR that saves the assembly information of the PCB.

Assembly material

Defines an SAP material master with the BOM items of the assembly variant.

Assembly PDF

Defines an output file with the variant-specific assembly drawing as a PDF file. Saved by default asoriginal to Assembly document.

Attribute

Defines an object property in the design and datamodel.

BOM

Bill Of Material – Defines the list of components/materials.

BOM item

Defines a position in the BOM with unique ID, quantity and other attributes.

Component

Defines a component in the OrCAD CIS library.

Datamodel

Defines objects and the relationship between these objects for a certain design in ECTR. The datamodelobjects are visible in ECTR and managed by the integration.

ECAD

Electronic Computer Aided Design – Defines the software-supported development in electricalengineering and electronic design.

Fabrication data

Defines an output file with the fabrication data (Gerber- and drill files, etc.) of the PCB. Saved by defaultas original to PCB document.

Fabrication PDF

Defines an output file with the fabrication drawing (drill plot) for the PCB as a PDF file. Saved by defaultas original to PCB document.

IDF data

Defines an output file with the proprietary design and fabrication data of the PCB. The IDF format is usedto enable data exchange between ECAD and MCAD. Saved by default as original to PCB document.

Innovation container

Defines an output file with the native design files. Saved by default as original to Innovation document.

Innovation document

Defines a datamodel object in ECTR that saves the design.

Innovation PDF

Defines an output file with the basic schematic as a PDF file. Saved by default as original to Innovationdocument.

User Guide www.xplm.com 5 / 36

IPC-2581 data

Defines an output file with the proprietary design and fabrication data of the PCB. Saved by default asoriginal to PCB document.

Material

Defines an SAP material master that is either produced or purchased.

ODB++ data

Defines an output file with the proprietary design and fabrication data of the PCB. Saved by default asoriginal to PCB document.

PCB

Printed Circuit Board – Defines a bare board for the electrical connection of electronic components.

PCB document

Defines a datamodel object in ECTR that saves the fabrication information of the PCB.

PCB material

Defines an SAP material master with the bare board as the first BOM item.

Project

Defines a design file in OrCAD CIS containing schematics and PCB layouts, including related files.

Schematic

Defines a diagram with electrical or electronic circuits and connections.

Schematic PDF

Defines an output file with the variant-specific schematic as a PDF file. Saved by default as original toAssembly document.

STEP data

Defines an output file with the proprietary design and fabrication data of the PCB. The STEP formatis used to enable data exchange between ECAD and MCAD. Saved by default as original to PCBdocument.


1 Introduction1.1 About this document

1 Introduction

1.1 About this documentThis document describes the functions and use of the integration platform SAP EngineeringControl Center Interface to ECAD.

The document provides a basic understanding of the user interface and shows how engineeringinformation from Cadence OrCAD CIS can be managed in SAP Engineering Control Center.

This document is intended for end users of SAP Engineering Control Center Interface to ECADwho use it to exchange data between Cadence OrCAD CIS and SAP Engineering Control Centeron a daily basis.

1.2 AbbreviationsTo facilitate reading and access to information, longer or more complicated names areabbreviated in this document.

Name Abbreviation Notes

SAP Engineering Control CenterInterface to ECAD

Integration

SAP Engineering Control Center ECTR This abbreviation is also used todescribe actions for storing andreading data in SAP.

Cadence OrCAD CIS OrCAD CIS

1.3 Overview of the integrationThe integration manages the design and the related components centrally in ECTR.

The integration was designed for seamless data exchange between OrCAD CIS and ECTR. Theuser starts the integration functions directly from OrCAD CIS and executes actions in specialdialogs that are optimized for engineering tasks.

Examples of typical integration functions:■ Create a new design from templates saved in the file system or in ECTR.■ Save the design files in ECTR, create and upload output files, compare and upload BOM

information, and control the reservation.■ Load a design from ECTR, open it in OrCAD CIS, and reserve it for the current user in ECTR.■ Create missing materials in ECTR to complete the BOM, and synchronize attributes in both

systems.

How the design is represented in ECTR, is defined in a datamodel. The datamodel objects, theirrelationships and attributes are configured in the integration. The integration thus guarantees aconsistent data exchange between OrCAD CIS and ECTR.

For example, when saving, the integration reads the design, creates or updates the datamodelobjects, relationships and attributes in ECTR, uploads output files, and links the information backto the design.


2 Functional description2.1 Datamodel

2 Functional description

2.1 DatamodelThe datamodel describes the objects in ECTR used by the integration to save the designinformation.

BOM item n

Assembly PDFfile_assy_pdf

Fabrication datafile_gerber

IPC-2581 datafile_ipc2581

Innovation document

doc_inno

Assembly document

doc_group

Assembly datafile_assy_data

Assembly material

part_group

PCB document

doc_pcb

Fabrication PDFfile_fabrication

ODB++ datafile_odbpp

Schematic PDFfile_sch_pdf

part_in_bom

BOM

IDF datafile_idf

STEP datafile_step

Custom extra filefile_pcb_extra_1

Custom extra filefile_pcb_extra_2

Custom extra filefile_assy_extra_1

Custom extra filefile_assy_extra_2

Innovation containerfile_inno

Innovation PDFfile_pdf

Custom extra filefile_inno_extra_1

Custom extra filefile_inno_extra_2

PCB material(BOM item 1)

part_pcb

BOM item 2

part_in_bom

BOM item 3

part_in_bom

Legend■ Blue boxes: ECTR documents■ Orange boxes: ECTR materials■ Grey boxes: ECTR originals

Note: For each document, an additional .system file is saved in ECTR. This file is used tosupport ECTR system requirements, but is not relevant for the user.


2 Functional description2.2 Module dialogs

2.2 Module dialogsThe integration functions are started as separate modules with their own dialogs from the menuSAP ECTR in OrCAD CIS.

Menu: SAP ECTR

■ New ECAD Project: Creates a new design.■ Save: Manages all relevant design information in ECTR, for example the native design files,

generated output files and the BOM(s).■ Edit: Loads the design files from ECTR and opens the design in OrCAD CIS read-only or for

editing.■ Synchronize Parts: Manages components, materials and attributes bidirectionally between

the library and ECTR.

All module dialogs have the same structure and are divided into the following sections:

■ Menu bar■ Main functions■ Event log



2.2.1 Menu barThe menu bar is part of all module dialogs and contains the entries Module and Help.

Menu item: Module

■ Show Log: Opens the log file of the current module.■ Open Log Folder: Opens the default log directory %TEMP%\integrate where all log files are

saved.■ Log level: Sets the log level for the current module. You can define the log level for future

module runs in the IVS settings.■ Exit: Closes the module dialog.

Menu item: Help

■ About: Shows the application and connector version.■ Report Problem: Opens a dialog to create a problem report. Options include making a

screenshot of the current module, selecting log files and additional configuration files, andfinally saving of the files to the hard drive.

See alsoIntegration Visualization Server on page 22



2.2.2 New ECAD ProjectUse this integration module to create new designs based on templates or existing designs.

Section: Project Settings

In this section, you can define the project name and the project directory.

■ Input fields□ ECAD Project Name: Defines the name of the design.□ Target Directory: Defines the directory where the design is saved.

Section: Project Source

In this section, you can select a template or an existing design.

■ Tabs□ Template: Shows a selection list for templates saved in the templates directory.□ Design: Opens a selection dialog for designs saved in the file system.□ PLM: Opens a search dialog for designs saved in ECTR.□ PLM Template: Shows a selection list for templates saved in ECTR.

Section: Lower dialog part

■ Buttons□ OK: Creates the design from the selected source, opens it in OrCAD CIS and closes the

user dialog.□ Cancel: Closes the module dialog without any further actions.

See alsoCreating new design on page 25



2.2.3 SaveUse this integration module to manage OrCAD CIS engineering information in ECTR.

Section: Design

In this section, you can manage the design, the related schematic, as well as the reservation inECTR.

■ Buttons□ Create: Creates a new datamodel object in ECTR and links it to the design.□ Assign: Opens a search dialog to select an existing object in ECTR and to link it to the

design.□ Unassign: Deletes the link information in the design and internally in the integration.

Note: The object links in ECTR are not deleted and remain. If necessary, deletethem manually in ECTR.

□ Refresh: Updates the object properties from ECTR.□ Show: Shows the object in ECTR.

■ Checkboxes□ Keep reserved: Option to control the reservation for the object and the current user in

ECTR.□ Upload design: Option to create a ZIP file of the design files and save the result in ECTR.



□ PDF: Option to create a PDF file of the basic schematic and save the result in ECTR.□ Extra 1/Extra 2: Options to include custom configurable output files in ECTR. Options are

hidden by default but you can activate them if required. See Installation and AdministrationGuide for details.

Section: PCB

In this section, you can manage the PCB and the related fabrication information in ECTR.

■ Buttons□ Create: Creates new datamodel objects in ECTR and links them to the bare board.□ Assign: Opens a search dialog to select an existing object in ECTR and to link it to the

bare board.□ Unassign: Deletes the link information for the bare board in the design and internally in the

integration.Note: The object links in ECTR are not deleted and remain. If necessary, deletethem manually in ECTR.

□ Refresh: Updates the object properties from ECTR.□ Show: Shows the object in ECTR.□ Edit: Opens a module dialog to change the linked objects in ECTR individually, for example

adjusting names or creating new objects.■ Checkboxes

□ PDF: Option to create a PDF file of the fabrication drawing (drill plot) and save the result inECTR.

□ Gerber: Option to create fabrication data (Gerber and drill files, etc.) and save the result inECTR.

□ ODB++/IPC-2581: Options to create specific exchange formats and save the result inECTR.

□ IDF/STEP 3D: Options to create specific exchange formats and save the result in ECTR.□ Extra 1/Extra 2: Options to include custom configurable output files in ECTR. Options are


Section: Assemblies

In this section, you can manage the assembly variants, the related output files and BOMs inECTR.

■ Buttons□ Create: Creates new datamodel objects for the selected line item in ECTR.□ Assign: Opens a search dialog to select an existing object in ECTR and to link it to the

selected line item.□ Unassign: Deletes the link information for the selected line item in the design and internally

in the integration.Note: The object links in ECTR are not deleted and remain. If necessary, deletethem manually in ECTR.

□ Refresh: Updates the object properties from ECTR.□ Show: Shows the object in ECTR.



□ Edit: Opens a module dialog to change the linked objects in ECTR individually, for exampleadjusting names or creating new objects.

■ Checkboxes□ Assembly Data: Option to create the assembly data for the assembly variant, and save the

result in ECTR.□ SCH PDF: Option to create a PDF file of the schematic for the assembly variant, and save

the result in ECTR.□ ASSY PDF: Option to create a PDF file of the assembly drawing for the assembly variant,

and save the result in ECTR.□ Extra 1/Extra 2: Options to include custom configurable output files in ECTR. Options are


□ BOM: Option to export and upload the BOM to ECTR and link existing materials.□ Layout BOM: Option to show the placement side of the component (top or bottom) in the

BOM Comparison dialog and to add it to the BOM.


■ Buttons left□ Select All: Enables all options in the module dialog.□ Unselect All: Disables all options in the module dialog.

■ Buttons right□ OK (all options except BOM enabled):

● Updates the objects and their relationships in ECTR.● Updates the link information in the design.● Creates the selected output files and uploads them to ECTR.● Keeps the reservation for the object and the current user active.● Closes the module dialog.

□ OK (all options enabled):● Updates the objects and their relationships in ECTR.● Updates the link information in the design.● Creates the selected output files.● Keeps the reservation for the object and the current user active.● Exports the BOM from the design, compares it with ECTR and opens the BOM

Comparison dialog.□ Cancel: Closes the module dialog without any further actions.□ Apply: Same as OK, but doesn't close the module dialog. The options are automatically

reset after successful execution. New options can be enabled again and executed with OKor Apply.

Note: If the BOM option is enabled, you must first make a selection in the BOMComparison dialog before the module dialog becomes active again.

See alsoSaving design in ECTR on page 27



2.2.3.1 BOM Comparison dialogBefore uploading the data to ECTR, the BOM Comparison dialog shows the compared OrCADCIS and ECTR BOMs in different views. You can check the BOM items in each view and, ifnecessary, cancel the upload.

Section: BOM Comparison

■ Tabs□ Refdes View: Shows the compared BOMs with focus on the individual reference

designators in the design.□ Quantity View: Shows the compared BOMs with focus on the the summarized quantity for

reference designators with the same component number.□ Missing Parts: Shows components in the design that are not synchronized with ECTR, or

for which no material number was found in ECTR.□ Unreleased Parts: Shows materials in ECTR that are synchronized with OrCAD CIS but

are not released, or no longer released (obsolete).□ Unassigned Parts: Shows components in the design for which no component number was

found in the library.■ Checkboxes

□ Added: Shows BOM items in OrCAD CIS that have been linked to materials in ECTR.□ Unchanged: Shows BOM items that are identical in OrCAD CIS and ECTR.□ Modified: Shows BOM items that have been modified.□ Removed: Shows previously synchronized BOM items that still exist in ECTR but have

been deleted in OrCAD CIS.□ Missing: Shows BOM items in OrCAD CIS that must be created in ECTR.


■ Buttons□ OK:

● Uploads the selected output files and BOM items to ECTR.



● Closes the BOM Comparison dialog.□ Cancel: Closes the BOM Comparison dialog without further actions in ECTR.



2.2.4 EditUse this integration module to download and open designs from ECTR.

Section: Design

In this section, you can search for objects in ECTR.

■ Buttons□ Search: Opens the ECTR dialog to select an existing object in ECTR.

Note: The ECTR dialog automatically comes fore when the function Edit isexecuted. To open the design read-only, select Open Original. To open the designfor editing, select Open Original for Edit.

■ Read-only fields□ Document: Shows the returned number and revision of the object in ECTR.□ Name: Shows the returned name of the object in ECTR.

Section: Project Settings

In this section, you can change the project directory, if required.■ Read-only fields

□ ECAD Project Name: Shows the derived directory name to be created in the file system.Note: If the design is opened read-only, the prefix view is automatically added tothe directory name.

■ Input fields□ Target Directory: Defines the directory in which the design is to be saved.


■ Checkboxes

The two read-only options View and Check out in this module dialog indicate the previouslyselected opening option in ECTR. See the following table for more information.



ECTR status Opening option Remark

Not reserved Open Original The option View is selected. Opens the design read-only in OrCAD CIS. Edited design files cannot besaved back to ECTR.

Not reserved Open Originalfor Edit

The option Check out is selected. Opens the designfor editing in OrCAD CIS and reserves it for the currentuser in ECTR.

Reserved bycurrent user

Open Original The option Check out is enabled by default.

Reserved bycurrent user

Open Originalfor Edit

The option Check out is enabled by default.

If the design is already reserved by the currentuser and available in the target directory, a warningmessage is shown with the option to overwrite thedesign files with the ECTR status.

If the design is already reserved by the current user onmachine A, and the same user tries to open the designfor editing on machine B, an error message is shown.In this case, the user must first save and remove thereservation in the design on machine A in order to editit on machine B.

Reserved byanother user

Open Original The option View is selected. Opens the design read-only in OrCAD CIS. Edited design files cannot besaved back to ECTR.

Reserved byanother user

Open Originalfor Edit

Although the option is selectable in ECTR, editing thedesign is not possible and an error message is shown.

Released Open Original The option View is selected. Opens the design read-only in OrCAD CIS. Edited design files cannot besaved back to ECTR.

Released Open Originalfor Edit

Although the option is selectable in ECTR, editing thedesign is not possible and an error message is shown.

■ Buttons□ OK: Opens the design read-only or editable.□ Cancel: Closes the module dialog without further actions.

See alsoOpening design from ECTR on page 31



2.2.5 Synchronize PartsUse this integration module to synchronize components, materials and their attributes betweenOrCAD CIS and ECTR.

Section: Menu bar

Specific to this module dialog, the menu bar contains additional entries.

■ Menu item: Items□ Add > With Class Hierarchy: Opens a selection dialog to search for components in the

library according to classes and load them into the section Overview for synchronization.□ Add > Missing Parts: Shows a list of the recent BOM uploads with the components for

which no material was found in ECTR. Selecting an entry loads these components into thesection Overview for synchronization.

□ Exclude: Removes the entries from the section Overview.□ Refresh: Updates the entries in the section Overview.

■ Menu item: Synchronize□ Select All: Selects all entries in the section Overview.□ Synchronize: Synchronizes the selected entries between OrCAD CIS and ECTR.□ Link: Manually links a selected component to a material.□ Open in ECTR: Shows the material in ECTR.

Section: Quick search and tool bar

■ The quick search field supports searching by component, material number, or name. This wayyou can also search for materials in ECTR.

■ The toolbar contains the same functions as in menu Synchronize.



Section: Overview

In this section, the search results are shown. You can filter the entries according to the followingcriteria and color codes:

■ Unchanged: Shows unchanged and synchronized entries.■ OrCAD CIS Only: Shows components that exist in OrCAD CIS only.■ ECTR Only: Shows materials that exist in ECTR only.■ Changed: Shows differences in attribute values.

To find a specific entry in the tree structure, press CTRL+F. This opens the tree search dialog:

In this dialog, you can search for any value that is shown in the tree structure:

■ Find: Defines the search value.■ Case sensitive: Searches for case-sensitive values.■ Wrap Search: Continues the search from the top when the last entry is reached.■ Backward: Searches from bottom to top and not from top to bottom.■ Find: Starts the search.■ Close: Closes the dialog.

Note: To remove the entries from the section Overview, press the keyboard shortcutCTRL+A to select everything, and press Delete.

Section: Details

In this section, the compared attribute values are shown:

■ OrCAD CIS: Shows the current value in OrCAD CIS.■ OrCAD CIS New: Shows the new value in OrCAD CIS (hidden by default).■ Action: Shows the update direction.■ ECTR: Shows the current value in ECTR.■ ECTR New: Shows the new value in ECTR (hidden by default).

Note: You can show hidden columns by clicking and select the missing column.

See alsoSynchronizing components and materials on page 32



2.2.6 Event logThe event log is part of all module dialogs and shows the progress of the current module.

By default, module dialogs of successfully finished modules are automatically closed. You canchange this behavior in the IVS settings, so that the module dialog remains open.

The status icons indicate the module execution:

■ Green: No problems■ Orange: Warning■ Red: Error

If the module has finished with errors, all other controls except the menu bar are disabled. In thiscase, the following actions can be helpful:

■ Module > Show Log: Opens the log file of the current module.■ Help > Report Problem: Opens a dialog to create a problem report. Options include making

a screenshot of the current module, selecting log files and additional configuration files, andfinally saving of the files to the hard drive.



2.2.7 Integration Visualization ServerThe Integration Visualization Server (IVS) stores common settings for all modules and logsinformation about previous module runs. IVS starts automatically when a module is executed andcontinues to run in the background.

IVS icon and menu

The icon to access IVS is located in the Windows notification area. Right-click the icon to open theIVS menu.

Menu items: IVS

■ About: Shows the IVS version.■ Open Integrate folder: Opens the directories INTEGRATE_HOME or INTEGRATE_PRODUCT_HOME.■ Preferences > Runtime

□ Remove log files after this number of days: Defines how long to keep logs in the logdirectory. By default, log files created by the integration are saved in %TEMP%\integrate.

□ Show this number of recent modules: Limits the number of functions in the menu RecentModules.

□ Log files location: Defines the path where the log files and other files for a problem reportare saved.

■ Preferences > Module□ Log level

● Default: Defines the default log level without logging any additional errors or warnings.● Warning: Logs error and warnings.● Normal: Logs errors, warnings and short information.● Debug: Logs errors, warnings and detailed information. Temporary files of the module

run are not deleted.● Trace: Defines the highest log level. This setting is for debugging errors only and

shouldn't be used in normal operation because it impacts the performance of theintegration.

Note: Debug and Trace are useful for analyzing problems in support cases.

□ Close windows automatically when module has finished successfully: Closes moduledialogs automatically if they were executed successfully and without errors and warnings.

□ Close windows automatically when module was aborted by user: Closes moduledialogs automatically when they have been canceled by the user.

■ Close finished modules: Closes all finished but still open module dialogs.



■ Recent modules: Shows the last executed modules with result and timestamp. Move thecursor over a line to display an additional menu with more options.□ Show Log: Opens the current log file of the module.□ Open Log Folder: Opens the default log directory %TEMP%\integrate.□ Report Problem: Opens a dialog to create a problem report. Options include making a

screenshot of the current module, selecting log files and additional configuration files, andfinally saving of the files to the hard drive.

■ Exit: Stops and closes IVS.

See alsoMenu bar on page 10



2.2.8 Working with module dialogsYou can configure the module dialogs individually according to your needs.

Adjust table data

In each module dialog that contains table data, you can change the table layout as follows:

■ Drag'n'drop the columns to a new position.■

Click and select the columns to show in the table.

Position and columns are saved for the Windows user on the PC.

Adjusting window sizes

Adjust the window size for every module dialog. The size is saved for the user and restored in thenext session.

Moving event log window

Drag'n'drop the event log window in each module dialog to a new position and resize it. Positionand size are saved for the user and restored in the next session.

Moving specific module windows

Similar to the event log window in all module dialogs, the windows Overview and Details in themodule Synchronize Parts can also be moved and resized.


3 Using the integration3.1 Creating new design

3 Using the integrationThe following use cases describe typical integration actions, but by far not all possiblecombinations and special cases.

3.1 Creating new designThis chapter describes use cases for creating new designs from different sources.

Note: Make sure you are in the OrCAD CIS view, which shows the SAP ECTR menu.

See alsoNew ECAD Project on page 11

3.1.1 Creating new design from template in the file systemCreate design templates and save them in the file system. With the integration, you can thencreate new designs based on these templates.

Procedure

1. Select SAP ECTR > New ECAD Project.ResultThe module dialog opens.

2. In the section Project Settings, enter a name for the new design.

3. Optional: Define a target directory other than the default.

4. In the section Project Source, activate the tab Template.

5. Select a schematic and a layout template from the list.

6. Click OK.

Result

■ The new design is created according to the selected source and opened in OrCAD CIS. Thedesign is not yet linked to ECTR objects.

■ The module dialog closes.

3.1.2 Creating new design from design in the file systemWith the integration, you can create new designs based on existing designs in the projectdirectory.

Procedure




4. In the section Project Source, select the tab Design.


3 Using the integration3.1 Creating new design

5. Click on More.

ResultThe file selection dialog opens.

6. Select an existing design in the file system.

7. Click OK.

Result



3.1.3 Creating new design from design in ECTRUse the integration to save designs centrally and available to everyone in ECTR. With theintegration, you can then create new designs based on these designs.

Procedure




4. In the section Project Source, select the tab PLM.

5. Click on More.

ResultThe ECTR dialog comes fore.

6. Search for an existing design object in ECTR.

7. Right-click the object and select Open Original.ResultThe module dialog with the design selected comes fore.

8. Click OK.

Result



3.1.4 Creating new design from template in ECTRCreate design templates and save them centrally and available to everyone in ECTR. With theintegration, you can then create new designs based on these templates.


3 Using the integration3.2 Saving design in ECTR

Procedure




4. In the section Project Source, select the tab PLM Template.

5. Click on More.


6. Search for an existing template object in ECTR.

7. Right-click the object and select Open Original.ResultThe module dialog with the template selected comes fore.

8. Click OK.

Result



3.2 Saving design in ECTRThis chapter describes use cases for creating and updating OrCAD CIS engineering informationin ECTR.

The modular structure of this module dialog, combined with the options to create and uploadoutput files, allows you to save exactly the data in ECTR that is currently relevant.

Whether you just want to back up the design, create PCB or assembly information, or save theBOM, all these actions are started from the same module dialog.

Note: Select the right project and make sure you are in the OrCAD CIS view, which showsthe SAP ECTR menu.

See alsoSave on page 12

3.2.1 Saving designWith the integration, you can manage the design information in ECTR, and create and upload aPDF file of the schematic.



Before you start

A design not yet saved in ECTR is available locally. Such a design contains only the name on thetitle block of the drawing but no other ECTR information.

Procedure

1. Click SAP ECTR > Save.

ResultThe module dialog opens. If not configured differently, the field Description in the sectionDesign is automatically filled with the design name. The value in this field is used asdescription in ECTR. Adjust it if necessary.

2. In the section Design, click Create.

ResultA new object is created in ECTR and the option Keep reserved is enabled.

3. Enable options for output files.

4. Click OK or Apply.

Result

■ The enabled output files are created and saved in ECTR.■ The link information in the design is updated and the object is reserved for the current user in

ECTR.■ The module dialog closes (OK) or remains open (Apply).

Next steps

■ Check the title block of the drawing for updated ECTR information.■ Check the created output files in ECTR.■ Repeat the procedure again to save modified design information in ECTR at any time.

3.2.2 Manually linking designNormally, when saving, you first create a new object in ECTR and automatically link it to thedesign. With the integration, you can also manually link the design to an existing object in ECTR.

Before you start

A design not yet saved in ECTR is available locally and unlinked objects exist in ECTR.

Procedure


ResultThe module dialog opens. If not configured differently, the field Description in the sectionDesign is automatically filled with the design name. The value in this field is used asdescription in ECTR. Adjust it if necessary.

2. In the section Design, click Assign.


3. Search for an existing and not reserved object in ECTR.




5. Optional: Enable options for output files.


Result

■ The link information in the design is updated and the object is reserved for the current user inECTR.

■ The module dialog closes (OK) or remains open (Apply).

3.2.3 Controlling the reservationWith the integration, you can keep or delete the object reservation when you execute the saveprocess.

When saving to ECTR, a newly created or manually linked object is automatically reserved for thecurrent user. The option Keep reserved remains activated by default.

■ Check in (delete object reservation)

If you want to check in the design and thus delete the object reservation, deactivate optionKeep reserved the next time you save.

■ Check out (reserve object)

If you want to check out an existing design and thus reserve the object for the current user, usethe integration function Edit.

See alsoOpening non-reserved design for editing on page 31

3.2.4 Saving PCB informationWith the integration, you can create the fabrication data for the PCB and save it in ECTR.

Before you start

A design without linked objects in ECTR is available locally.

Procedure


ResultThe module dialog opens. If not configured differently, the field Name in the section PCB isautomatically filled with the design name and the additional suffix PCB. The value in this field isused as description in ECTR. Adjust it if necessary.

2. In the section PCB, click Create.

ResultNew objects are created in ECTR.

3. Optional: Click Edit.ResultThe edit dialog opens and you can change the linked objects individually.



4. Enable options for output files.


Result

■ The selected output files are created and saved in ECTR.■ The link information in the design is updated.■ The module dialog closes (OK) or remains open (Apply).

Next steps

Check the created output files in ECTR.

3.2.5 Saving assembly information and BOMWith the integration, you can create various output files for the assembly variants, export theBOM, and save everything in ECTR. To create missing BOM items in ECTR, you need the moduleSynchronize Parts.

Before you start

A design without linked objects in ECTR is locally available.

Procedure


ResultThe module dialog opens. If not configured differently, the field Name in the sectionAssemblies is automatically filled with the name of the assembly variant from the design. Thevalue in this field is used as description in ECTR. Adjust it if necessary.

2. In the section Assemblies, select a line item and click Create.

ResultNew objects are created in ECTR.

3. Optional: Click Edit.ResultThe edit dialog opens and you can change the assigned objects individually.

4. Enable options for output files and the option BOM.

5. Optional: Enable the option Layout BOM.


ResultThe BOM is exported from the assembly variant and compared with ECTR. The BOMComparison dialog opens.

7. In the BOM Comparison dialog, check the BOM changes before uploading the BOM to ECTR.Note: Check the entries in the tab Missing parts. These BOM items do not yet exist inECTR and therefore cannot be included in the BOM.

8. Click OK.

9. Optional: If you discover any defects in the BOM, click Cancel. In this case, no BOM andoutput files are uploaded to ECTR.


3 Using the integration3.3 Opening design from ECTR

Result

■ The selected output files are created and saved in ECTR.■ The BOM is uploaded to ECTR and synchronized between both systems. Already linked BOM

items are added to the BOM in ECTR, missing BOM items have to be created first.■ The link information in the design is updated.■ The module dialog closes (OK) or remains open (Apply).

Next steps

■ Check the created output files in ECTR.■ Check the BOM in ECTR.■ Use the module Synchronize Parts to create missing materials in ECTR. Next, execute the

module Save again to complete the BOM in ECTR.

3.2.6 Working with change numbers in ECTRWhen a change number is active in ECTR, the integration uses it when creating documents,materials and BOMs in ECTR. The new objects are automatically added to the active changenumber.

3.3 Opening design from ECTRThis chapter describes how to download designs from ECTR and open them in OrCAD CIS.


See alsoEdit on page 17

3.3.1 Opening non-reserved design for editingWith the integration, you can download a non-reserved design from ECTR, open it for editing inOrCAD CIS, and reserve it in ECTR for the current user.

Before you start

A design is saved in ECTR but not reserved.

Procedure

1. Click SAP ECTR > Edit.ResultThe module dialog opens and the ECTR dialog comes fore.

2. Search for an existing and non-reserved object in ECTR.

3. Right-click the object and select Open Original for Edit.ResultThe module dialog with the design selected comes fore.

4. Optional: Select another target directory.

5. Click OK.

Result

■ The design files are downloaded from ECTR, extracted, and opened in OrCAD CIS for editing.


3 Using the integration3.4 Synchronizing components and materials

■ The object is reserved for the current user in ECTR.■ The module dialog closes.

See alsoControlling the reservation on page 29

3.3.2 Opening reserved or released designWith the integration, you can also open reserved or released designs from ECTR in OrCAD CIS.You can edit the design locally, but you cannot save it back to ECTR.

Before you start

A design is saved in ECTR and is either reserved or released.

Procedure

1. Click SAP ECTR > Edit.ResultThe module dialog opens and the ECTR dialog comes fore.

2. Search for an existing and non-reserved object in ECTR.


4. Optional: Select another target directory.

5. Click OK.

Result

■ The design files are downloaded from ECTR, extracted, and opened read-only in OrCAD CIS.■ The module dialog closes.

Next steps

Revise the released design in ECTR to open it for editing in OrCAD CIS.

3.4 Synchronizing components and materialsThis chapter describes use cases for synchronizing components, materials and attribute valuesbetween the library and ECTR.


How you work with the components in OrCAD CIS and the materials in ECTR depends on yourworkflow.

■ You can manage all components in the library in OrCAD CIS and use the functionSynchronize Parts to create new materials in ECTR and to synchronize the attribute values inboth systems.

■ You can manage all materials in ECTR and use the function Synchronize Parts tosynchronize the data with the library in OrCAD CIS.

■ You can use a mix of both: Manage the materials and the most important attribute values inECTR. Manage the other attribute values in the library in OrCAD CIS and use the function



Synchronize Parts to keep both systems in synch. To do this, you need to configure differentsynchronization directions, for example:□ ECTR number for materials: ECTR > OrCAD CIS□ Description: ECTR > OrCAD CIS□ OrCAD CIS specific attributes: OrCAD CIS > ECTR

See alsoSynchronize Parts on page 19

3.4.1 Creating missing materialsWith the integration, you can automatically create missing materials from the last BOM upload andlink them to the components.

Before you start

A design was saved with the option BOM to ECTR. Make sure the design includes componentsthat do not exist as materials in ECTR and are listed in the view Missing Parts of the BOMComparison dialog.

Procedure

1. In OrCAD CIS, select SAP ECTR > Synchronize Parts.

ResultThe module dialog opens. By default, you are not notified about missing materials in ECTRfrom the last BOM upload. If you want to be notified on start of the module Synchronize Parts,you can configure this behaviour. See Installation and Administration Guide for details.

2. From the menu, select Items > Add > Missing Parts and select the entry from the last BOMupload.

ResultThe components without a corresponding material in ECTR are loaded into the sectionOverview.

3. In the section Overview select single components or click Select All.

4. Click Synchronize.

Result

■ For each selected component, a material is created in ECTR and the new number is linked tothe component.

■ Depending on the setup, the material number is created in the same way as the componentnumber, or the material number is auto-generated and written into an own field in the library.

3.4.2 Synchronizing a new componentWith the integration, you can synchronize new components in the library with ECTR. Thereby,new materials are created in ECTR and linked to the components.



Procedure

1. Create a new component in the library.


ResultThe module dialog opens.

3. Search for the new component in two ways:■ Enter the component number in the quick search field and press Enter.■ Select Items > Add and find the component over its class.

4. In the section Overview, select the component and click Synchronize.

Result

■ For the selected component, a material is created in ECTR and the new number is linked tothe component.

■ Depending on the setup, the material number is created in the same way as the componentnumber, or the material number is auto-generated and written into an own field in the library.

3.4.3 Linking component to materialWith the integration, you can also link components to materials manually.

Before you start

Unlinked components and materials are available in both systems.

Procedure



2. Search for the new component in two ways:■ Enter the component number in the quick search field and press Enter.■ Select Items > Add and find the component over its class.

3. In the section Overview, select the component and click Link.

4. Search for the material in ECTR, select it and click OK.

5. Alternative: If both the component (green = OrCAD CIS only) and the material (red = ECTRonly) are available in the section Overview, you can select both entries and click Link.

Result

■ The component is linked to the material and the attributes are synchronized.■ Depending on the setup, the material number is created in the same way as the component

number, or the material number is auto-generated and written into an own field in the library.

3.4.4 Synchronizing attribute changesWith the integration, you can synchronize attribute changes made to materials already linked withcomponents.


3 Using the integration3.5 Releasing and revising design

Before you start

Linked materials are available in ECTR.

Procedure

1. In ECTR, search for an already synchronized material and open its properties.

2. Change some of the shared OrCAD CIS attributes.



4. Enter the material number in the quick search field and press Enter.

5. In the section Overview, select the component.

6. In the section Details, check the modified attribute values in ECTR.

7. Click Synchronize.

Result

The modified attribute values of the material in ECTR are synchronized with the component.

3.5 Releasing and revising designBy default, you cannot release and revise a design with the integration and must do this directly inECTR. However, such options are available on request.


4 Troubleshooting4.1 Enabling debug logging

4 Troubleshooting

4.1 Enabling debug loggingThe debug logging helps to identify problems with the integration.

Procedure

1. In the Windows notification area, right-click the IVS icon and select Preferences.

2. Switch to the tab Module and select either Debug for normal debug logging or Trace for thehighest logging level.

Note: Debug and Trace are not recommended for normal use, as they will greatlyaffect the performance of the integration. Use these settings for problem analysis only,and then reset the log level to Normal.

3. Click OK.

4. In OrCAD CIS, start the integration function that caused the problem and try to replicate it.

Result

The defined debugging level logs errors, warnings and other information. All temporary files aresaved between module runs.

4.2 Reporting a problemFor integration problems, create a problem report with all relevant log files.

Procedure

1. In the running module, select Help > Report Problem from the menu bar.

ResultThe dialog for reporting problems opens.

2. Optional: Select whether you want to take a screenshot or not.

3. Do not change the already enabled log files and continue.

4. Click Save to Disk to save the complete problem report to the hard drive.

5. Visit https://support.sap.com and browse the knowledge base, or create a ticket and attach thereport if required.

Result

A problem report was created and addressed.


https://support.sap.com

Documents

User Guide - help.sap.com