Installation and Administration Guide

(1)

Installation and

Administration Guide

SAP Engineering Control Center Interface to ECAD

For: Cadence OrCAD CIS

Product version: 1.0.4.0

Publishing 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

(2)

Legal information

Copyrights and trademarks

This document contains information protected by copyright. All rights, including those of the translation, are reserved. No part of this documentation may be reproduced in any form (print, photocopy, microfilm or in any other form) or processed, copied or distributed using electronic systems without the written permission of XPLM Solution GmbH. The information contained in this documentation does not represent a legal obligation for XPLM Solution GmbH. The described software is delivered under a license agreement that regulates its use. 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 links to 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 specific installation may vary depending on the local environment and configuration realized for the individual customer 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 EU General Data Protection Regulation (GDPR), XPLM Solution GmbH informs about the handling of personal data when using the integration.

The integration itself does not "store" personal data in a general sense, but merely exchanges information between ECAD and PLM in attributes. Whatever is defined in these attributes is left to the definition of the customer. For example, if the integration is configured accordingly, user data like first and last name are transferred 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 of integration functions. Depending on the selected log level, these log files also contain information from Windows environment variables, for example the Windows user name.

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

■ Log files are saved by default in the directory %TEMP%\integrate. This directory can be deleted, but new log 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 for Document Management (DMS) for information about how personal information is handled in their systems.

(3)

Table of Contents

Glossary... 5

1 Introduction... 7

1.1 About this document... 7

1.2 Abbreviations...7

1.3 Architecture...8

2 Installation... 9

2.1 System requirements...9

2.2 Required licenses...9

2.3 Importing and activating BC Set... 10

2.4 Installing the integration...11

2.5 Understanding the directory structure... 12

2.6 Understanding integration variables...13

3 Post-installation... 15

3.1 Cadence OrCAD CIS... 15

3.1.1 Setting up integration menu... 15

3.1.2 Installing ODB++ exporter...15

4 Initial setup...16

4.1.1 Setting up library... 16

4.1.2 Creating templates... 16

4.2 SAP Engineering Control Center...17

4.2.1 Updating DType settings... 17

4.2.2 Setting up DTypes...17

4.2.3 Setting up material... 18

4.2.4 Setting up status net... 18

4.2.5 Setting up templates... 20

4.2.6 Setting up classification...21

4.2.7 Distributing integration with Subversion...21

5 Configuration...23

5.1 Datamodel...23

5.2 Configuration files...24

(4)

5.2.1 Datamodel configuration files...24

5.2.2 Other configuration files... 26

5.3 General configuration options...27

5.3.1 Handling of variant-specific output files... 27

5.3.2 Encrypting passwords... 28

5.3.3 Configuring new attributes and mapping... 28

5.3.4 Configuring attribute field lengths... 30

5.3.5 Configuring names of output files... 30

5.3.6 Hiding output file options...30

5.3.7 Configuring additional output files...31

5.3.8 Configuring start dialog in Synchronize Parts...32

5.3.9 Configuring BOM representation...32

5.3.10 Including or excluding BOM items... 33

5.4.1 Configuring schematic PDFs...33

5.4.2 Configuring fabrication and assembly PDFs...34

5.4.3 Configuring Gerber output files... 36

5.4.4 Configuring IPC-2581 output files... 36

5.4.5 Configuring ODB++ output files... 36

5.4.6 Configuring assembly data...37

5.5 SAP Engineering Control Center...37

5.5.1 Configuring templates...37

5.5.2 Configuring alternative BOM positions...38

6 Update... 40

6.1 Updating the integration...40

6.2 Updating the integration to new OrCAD CIS version... 40

7 Uninstallation... 42

7.1 Uninstalling the integration...42

8 Troubleshooting... 43

8.1 Solving integration issues...43

9 References...45

9.1 Modifier options...45

(5)

Glossary

Assembly data

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

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 as original 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 datamodel objects are visible in ECTR and managed by the integration.

ECAD

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

Fabrication data

Defines an output file with the fabrication data (Gerber- and drill files, etc.) of the PCB. Saved by default as 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 default as original to PCB document.

IDF data

Defines an output file with the proprietary design and fabrication data of the PCB. The IDF format is used to 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 Innovation document.

(6)

IPC-2581 data

Defines an output file with the proprietary design and fabrication data of the PCB. Saved by default as original 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 as original 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 to Assembly document.

STEP data

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

(7)

1.1 About this document

1 Introduction

1.1 About this document

This document describes the installation and configuration of the integration platform SAP Engineering Control Center Interface to ECAD.

The document provides a basic understanding of the system architecture and directory structure, shows the installation and initial setup process, and provides detailed information on how to configure SAP Engineering Control Center Interface to ECAD to meet customer requirements.

This document is intended for system administrators who install and configure SAP Engineering Control Center Interface to ECAD.

1.2 Abbreviations

Become familiar with the abbreviations listed here. You will find them throughout the document.

Name Abbreviation <product> <productID> Notes SAP Engineering

Control Center Interface to ECAD

Integration

SAP Engineering Control Center

ECTR This abbreviation

is also used to describe actions for storing and reading data in SAP.

Cadence OrCAD CIS

OrCAD CIS ORCAD XOR

Note: Within this document, the placeholders <productID> and <product> are used in variables, paths and directories. The values can appear in lower and upper case.

(8)

1 Introduction 1.3 Architecture

1.3 Architecture

The integration includes several software components that interact with each other.

Legend

■ Integration Visualization Server (IVS): The IVS stores common settings for all integration modules and monitors information about previous module runs. This component is

implemented in Java.

■ GUI: The user interface represents the module dialogs of the integration. This component is implemented in Java and Ruby.

■ integrate2 core modules: The core modules include the basic integration functionality and the connector-specific configuration. These components are implemented in Ruby.

■ Connector: The connector connects OrCAD CIS via the core modules with ECTR and vice versa. Depending on the API of the systems involved, these components are implemented in COM, C/C#, Delphi or with web services.

(9)

2.1 System requirements

2 Installation

2.1 System requirements

The following system requirements must be met before installing the integration.

Operating system

■ Windows 7, 8, 8.1 and 10 (only 64-bit versions are supported)

■ Local administrator rights are required

Supported ECTR and OrCAD CIS versions

Table 1: ECTR and OrCAD CIS

Name Version Condition

SAP Engineering Control Center

ECTR 5.1.9-15 | 5.2.1

ECTR for SAP S/4HANA 1.0.9-13 | 1.1.1

A PLM administrator account can be required during installation and setup of the integration.

Cadence OrCAD CIS (with OrCAD Capture CIS and OrCAD PCB Editor)

17.2 (older versions on demand)

The integration supports CIS libraries for parts synchronization.

To create schematic PDFs, the OrCADPS_17.2 Postscript driver and Ghostscript are required.

To create PCB PDFs, one of the following options can be used:

■ Allegro Design Publisher (requires a license)

■ OrCADPS_17.2 Postscript driver and Ghostscript

To create ODB++ output, the utility ODB++

Inside is required.

Note: ECTR and OrCAD CIS must be correctly installed and licensed for a proper

functioning of the integration. ECTR must be accessible from the client computer on which the integration and OrCAD CIS are installed.

2.2 Required licenses

The integration functions are started as separate modules and require a corresponding license.

To use the integration, the following licenses are required:

ECAD SAP license ID

Cadence OrCAD CIS ■ 7585 (OrCAD Capture CIS)

■ 7584 (OrCAD PCB Editor)

For more information see: https://support.sap.com/infopages/swdc/plm/ectr_ecad10.html

(10)

2 Installation 2.3 Importing and activating BC Set

2.3 Importing and activating BC Set

Together with the integration, a Business Configuration Set (BC Set) for SAP is delivered to the customer that has to be imported and activated first.

Procedure

1. Start the SAP client and log in.

2. Importing a BC Set:

Example of a BC Set in SAP:

Define document type (dtype) XEC

Define document type language-specific DE – XEC - ECAD document

EN – XEC - ECAD document Define Status of the document

Default status net for the document type XEC Display the status of the document language-specific Text of the status for the default status

Set object link

Assigns allowed object links to the predefined document types XEC Maintain the text of the object link

DE – MARA - Materialstamm EN – MARA – Material

Define documents language-specific

Text of the status for the predefined status Define Workstation-Application

XEC - X - ECAD File

Define Workstation-Application in the network PC – XEC

a) Select Tools > Customizing > Business Configuration Sets > Display and Maintain BC Sets or use the transaction SCPR3.

b) Select BC Set > Upload > Upload BC Set.

c) Select the BC Set from the file system and complete the import.

Result

The BC Set is imported in SAP.

3. Activating a BC Set:

a) Select Tools > Customizing > Business Configuration Sets > Activation of BC Sets or use the transaction SCPR20.

b) Enter the name DSCSAG/ECTR_ECAD for the BC Set.

c) Click Activate or select the corresponding action from the menu bar.

d) Select additional activation options and complete the activation.

Result

The BC Set is activated and related data is saved in customized tables.

(11)

2.4 Installing the integration

2.4 Installing the integration

The integration is installed with an installer. The installation media are available in the SAP download portal.

Before you start

■ Make sure that OrCAD CIS is installed correctly.

■ To make sure that the integration can create and change objects in ECTR, log on to ECTR with the account used for the integration and complete the following actions:

□ Create documents and materials. Also record mandatory fields with their required values when creating the objects, you will need this information later when configuring the integration.

□ Change attribute values for the created objects.

□ Reserve objects (check out) and and clear the reservation (check in).

□ Change the object status. Also record corresponding status names/codes, you will need this information later when configuring the integration.

□ Delete the created objects.

■ Download the installation media from the download portal.

■ Import and activate the BC Set first.

Procedure

1. Close OrCAD CIS if it's running.

2. Start the installer with administration rights.

3. Select the integration to install and follow the steps of the wizard:

■ Integration to Cadence OrCAD / Allegro CIS 4. Click Install to start the installation.

5. When the installation is complete, click Finish to close the installer.

Result

The integration is installed.

Next steps

Complete the required post-installation steps. See Post-installation on page 15.

See also

System requirements on page 9

(12)

2 Installation 2.5 Understanding the directory structure

2.5 Understanding the directory structure

After the installation, the following directory structure is available. Become familiar with the directories listed here.

ECTR

├───addons

│ └───ecad

│ ├───appdata

│ ├───basis

│ └───template-customize

└───applications └───<productID>

├───appdata ├───basis

│ └───dictionary ├───customize │ └───config

│ └───environments ├───documentation ├───template-customize ├───template-templates └───templates

├───master_boards └───project_templates

Legend

■ ECTR: Defines the default SAP ECTR installation directory, for example C:\Program Files (x86)\SAP\ECTR. This path is abbreviated in this document as <ECTR_DIR>.

■ addons\ecad: Contains common code for the integration platform, for example executable modules, runtime environments, supplementary files, base configuration and translations.

■ applications: Contains code for a specific integration product, for example the available ECTR/OrCAD CIS combination.

■ applications\<productID>: Contains the OrCAD CIS-specific integration code.

■ applications\<productID>\appdata: Contains customer specific files for OrCAD CIS and ECTR, for example scripts to establish OrCAD CIS menus, ECTR customization files.

■ applications\<productID>\basis: Contains startup scripts for the integration and product- specific workflow code.

■ applications\<productID>\dictionary: Contains language files for the user interface localization.

■ applications\<productID>\customize\config: Contains product-specific configuration files.

■ applications\<productID>\customize\config\environments: Contains environment settings, for example project and library locations, ECTR connection parameters.

■ applications\<productID>\template-customize: Contains the initial config directory as delivered. During an integration update, new configuration files are placed in template- customize to not overwrite existing configuration in <productID>\customize\config.

(13)

2.6 Understanding integration variables

■ applications\<productID>\template-templates: Contains the initial project templates for schematic and PCB as delivered. During an integration update, new template files are placed in template-templates to not overwrite existing configuration in <productID>\templates.

■ applications\<productID>\templates: Contains the OrCAD CIS-specific project templates for schematic and PCB.

See also

Abbreviations on page 7 Configuration files on page 24

2.6 Understanding integration variables

Become familiar with the variables listed here. You will find them throughout the document.

Main integration variables

These global variables are created as system environment variables in Windows during the installation of the integration and should not be changed.

Variable name and definition INTEGRATE_HOME

Defines the path to the application directory, for example <ECTR_DIR>\addons\ecad\basis\sys

\win\bin.

INTEGRATE_ECTR5_<product>_PRODUCT_HOME

Defines the path to the product directory, for example <ECTR_DIR>\applications\<productID>

\basis\sys\win.

INTEGRATE_ECTR5_<productID>_ENVIRONMENT

Defines the name of the current environment and has the default value <productID> assigned.

An environment can for example describe a development and a production environment with different settings.

The file init_env.bat in the directory <ECTR_DIR>\applications\<productID>\customize

\config\environments typically contains integration variables with paths to templates, the library or the project directory.

Note: To check the existing integration variables, open a CMD window, type set int and press Enter. The variables start with INTEGRATE_*.

Other integration variables

You can change or set these variables in init_env.bat, or define them as Windows environment variables. Restart the integration module after adding or changing variables.

Variable name and definition PROJECT_DIR

Defines the path to the project directory, for example C:\projects. INTEGRATE_ECTR5_<product>_LIBRARY

Defines the path to the library. See Setting up library on page 16 for more information.

(14)

2 Installation 2.6 Understanding integration variables

Variable name and definition INTEGRATE_SCH_TEMPLATE_DIR

Defines the path to the schematic template directory, for example <ECTR_DIR>\applications

\<productID>\templates\project_templates (default).

INTEGRATE_PCB_TEMPLATE_DIR

Defines the path to the PCB template directory, for example <ECTR_DIR>\applications

\<productID>\templates\master_boards (default).

INTEGRATE_LANG

Defines the UI language of the integration modules. Allowed values are en (English, default) or de (German).

You can find the localization files for the UI in <ECTR_DIR>\applications\<productID>\basis

\dictionary\<language code>. The value of INTEGRATE_LANG is case sensitive and must match exactly one of the file names in this directory.

INTEGRATE_TEMP_DIR

Defines the temporary directory with the log files and other settings, for example %TEMP%

\integrate (default). Restart IVS after changing this variable.

INTEGRATE_DEBUG | INTEGRATE_DEEP_DEBUG

Defines the log level. Allowed values are true (enable) or false (disable). INTEGRATE_DEBUG corresponds to log level Debug and INTEGRATE_DEEP_DEBUG corresponds to Trace. See User Guide for more information on log levels.

Application priorities of variables

Depending on where variables are set, they have priority in their application and override other locations.

Upon start, the integration reads the variables in this order:

1. System environment variables in Windows 2. User environment variables in Windows 3. init_env.bat

This results in the following application priority:

1. init_env.bat

2. User environment variables in Windows 3. System environment variables in Windows

See also

Understanding the directory structure on page 12 Abbreviations on page 7

(15)

3.1 Cadence OrCAD CIS

3 Post-installation

After the main installation, you must complete certain manual steps to make the integration work correctly with OrCAD CIS and ECTR. It is important that you go through the information in this chapter carefully.

3.1 Cadence OrCAD CIS

3.1.1 Setting up integration menu

To use the integration functions, you must set up a new menu in the application.

Procedure

1. Go to the directory <ECTR_DIR>\applications\xor\appdata\capture16. 2. Copy the file integrate_menu.tcl to %CDSROOT%\tools\capture\tclscripts

\capAutoLoad.

3. Start OrCAD Capture CIS.

Result

The menu is set up and accessible from the menu bar.

3.1.2 Installing ODB++ exporter

To export ODB++ data, you must install an additional utility.

Procedure

1. Go to the website http://www.odb-sa.com/downloads and download ODB++ Inside for Cadence Allegro.

2. Start the installer and follow the instructions of the wizard.

Result

The ODB++ exporter is installed.

(16)

4 Initial setup 4.1 Cadence OrCAD CIS

4 Initial setup

4.1 Cadence OrCAD CIS 4.1.1 Setting up library

Define the library path or a connection string in the integration variable

INTEGRATE_ECTR5_<product>_LIBRARY. See the examples below for possible paths to the library.

Path to library file

■ CIS library file: C:\<path-to-library>\CISLibrary.dbc

■ CIS database (MS Access): C:\<path-to-library>\CISLibrary.mdb

Connection string

■ ODBC

Note: Set up the ODBC DSN. For more information on ODBC, see https://

docs.microsoft.com/en-us/sql/ado/guide/appendixes/microsoft-ole-db-provider-for- odbc?view=sql-server-2017.

With authentication:

Provider=MSDASQL;Data Source=CISLibrary;UID=sa;PWD=sa;

With trusted connection:

Provider=MSDASQL;PersistSecurityInfo=False;Trusted_Connection=Yes;Data Source=CISLibrary;

■ SQL Server

With authentication:

Provider=SQLOLEDB;Data Source=VM-SQL2014-SRV;Initial Catalog=CISLibrary;User Id=sa;Password=sa;

With trusted connection:

Provider=SQLOLEDB;Data Source=VM-SQL2014-SRV;Initial Catalog=CISLibrary;Integrated Security=SSPI;

■ SQLite

Path to library file:

DRIVER=SQLite3 ODBC Driver;Database=C:\<path-to-library>

\CISLibrary.db;LongNames=0;Timeout=1000;NoTXN=0; SyncPragma=NORMAL;StepAPI=0;

■ Any other valid ActiveX Data Object (ADO) connection string can also be used.

Note: You can use the password encryption tool to encrypt passwords for the integration.

See Encrypting passwords on page 28.

4.1.2 Creating templates

In the module New ECAD Project, you can select templates saved in the file system or, if supported, in ECTR. The following procedure explains how you create schematic and PCB templates and where you save them to select them in the integration.

(17)

4.2 SAP Engineering Control Center

Procedure

1. Create a new project with the following content:

■ Schematic and PCB layout

■ Project management and configuration files

■ Additional documents and information

2. Split the contents of the project into schematic and PCB data, and create two ZIP files.

Splitting rules:

■ Combine the project structure and schematic in a schematic ZIP file.

■ Combine the PCB data in a PCB ZIP file.

3. For better identification, add the page size for schematic templates and the number of layers for PCB templates to the ZIP file name.

4. Move the templates to the corresponding template directories:

■ <ECTR_DIR>\applications\<productID>\templates\project_templates (Schematic)

■ <ECTR_DIR>\applications\<productID>\templates\master_boards (PCB) 5. Save the templates in ECTR. For instructions, see the corresponding ECTR chapter.

Result

The templates are created and saved. You can select them in the module New ECAD Project.

4.2 SAP Engineering Control Center 4.2.1 Updating DType settings

The ECTR client reads the ^dtype.xml files from various sources and compares the settings with SAP. If these settings between ECTR client and SAP are different, you must update the DType settings in SAP.

Before you start Install the integration first.

Procedure

1. In ECTR, select Administrator > System Setup > Upload Settings to SAP System.

2. Click Yes to confirm the upload.

Result

DType settings in SAP are updated from the ECTR client.

4.2.2 Setting up DTypes

You must define the valid DTypes for the document objects used by the integration.

In the sections doc_*, change the value from plm :dtype to the DType definition used in ECTR.

Exception: The sections doc_*_relation require no definition.

(18)

4 Initial setup 4.2 SAP Engineering Control Center

Example

Configuration file: <ECTR_DIR>\applications\<productID>\customize\config\*.datamodel doc_inno {

...

plm :dtype => "XDXI1"

...

}

Legend

plm :dtype: Defines the DType in ECTR.

4.2.3 Setting up material

You must define the valid material properties for the material objects used by the integration.

In the sections part_pcb, part_lib, and part_group, change all plm :matl_* definitions to the values used in ECTR.

Example

Configuration file: <ECTR_DIR>\applications\<productID>\customize\config\*.datamodel part_lib {

...

plm :matl_type => "HALB"

plm :matl_group => "01"

...

}

Legend

■ plm :matl_type: Defines the material type.

■ plm :matl_group: Defines the material group.

■ See comments with definitions for other plm :matl_* entries in the configuration file.

4.2.4 Setting up status net

You must define the valid statuses for objects in work and released objects in ECTR. The integration can reserve and change objects in work; released objects are locked for modification.

Change plm :status_in_work and plm :status_released in the sections doc_* to the statuses used in ECTR. Exception: The sections doc_*_relation require no definition.

Example

Configuration file: <ECTR_DIR>\applications\<productID>\customize\config\*.datamodel doc_inno {

plm :status_in_work => "WR", "IW", "AC", "IA", "AA", "AE"

plm :status_released => "RE", "FR"

...

}

Legend

(19)

■ plm :status_released: Defines the statuses for released objects.

Status actions

Note: Some actions cannot be allowed by workflow rules in ECTR. The following tables show only integration actions depending on workflow status for documents or materials.

Ask your administrator about the defined rules in ECTR.

Table 2: Innovation document (doc_inno)

Status Default values Status actions

Released RE Save: It is not possible to save design data in ECTR.

Edit: It is not possible to reserve the design for the current user in ECTR.

In work WR, IW Save: It is possible to save design data in ECTR.

Edit: It is possible to reserve the design for the current user in ECTR.

Other - Edit: It is not possible to reserve the design for the current user in ECTR.

Table 3: Assembly document (doc_group)

Released RE Save: It is not possible to save assembly data in ECTR.

In work WR, IW Save: It is possible to save assembly data in ECTR.

Other - Save: It is not possible to save assembly data in

ECTR.

Table 4: PCB document (doc_pcb)

Released RE Save: It is not possible to save fabrication data in ECTR.

In work WR, IW Save: It is possible to save fabrication data in ECTR.

Other - Save: It is not possible to save fabrication data in ECTR.

Table 5: PCB material (part_pcb)

Released - -

In work - -

(20)

Other - -

Table 6: Assembly material (part_group)

Released - Save: It is not possible to save the BOM in ECTR.

In work - Save: It is possible to save the BOM in ECTR.

Other - Save: It is not possible to save the BOM in ECTR.

Table 7: Purchased part (part_lib)

Released - -

In work - Save: When uploading the BOM to ECTR, the

component is listed in the BOM Comparison dialog for unreleased parts.

Other - Save: When uploading the BOM to ECTR, the

component is listed in the BOM Comparison dialog for unreleased parts.

4.2.5 Setting up templates

In the module New ECAD Project, you can select templates saved in ECTR as a basis for new designs.

Before you start

In OrCAD CIS, create a schematic template and a PCB template and save each in a separate ZIP file. See the corresponding OrCAD CIS chapter under Initial setup on page 16 for best practices.

Procedure

1. Create a new document in ECTR.

2. In the list DType Group, select the ECAD application.

3. In the list DType, select the entry Schematic Template or Layout Template.

4. Click Browse and select the corresponding template ZIP file.

5. In the field Description, enter a descriptive name like Schematic template or Layout template.

6. Click OK.

Result

When you click the button Load on the tab PLM Template, the integration searches for the DType definitions Schematic Template and Layout Template and shows the results in the selection lists.

(21)

4.2.6 Setting up classification

If you use classes in ECTR and/or different tables for components in your library, you must set this up accordingly, otherwise you can not use the module Synchronize Parts.

Example (Classification based on OrCAD CIS library structure) Configuration file: <ECTR_DIR>\applications\<productID>\customize

\config\*.classification item(:part_lib) {

subitem(:capacitor, :title => 'Capacitor') { eda :table => 'Capacitor'

attr('voltage') { eda 'Voltage' plm 'vol_capcls' }

}

subitem(:resistor, :title => 'Resistor) { eda :table => 'Resistor'

attr('power') { eda 'Power' plm 'pow_rescls' }

} }

Legend

■ subitem(...): Defines the internal instance name and the class title in the module Synchronize Parts.

■ eda :table: Defines the associated component table in the library.

■ attr(...): Defines an additional component attribute to be synchronized with ECTR.

Note: Such attributes are not available in the default attribute configuration of the .release file and must be defined here in .classification.

■ eda: Defines the field to be mapped in OrCAD CIS.

■ plm: Defines the field to be mapped in ECTR.

4.2.7 Distributing integration with Subversion

It is common to manage and distribute the ECTR and integration code with a version control system like Subversion. If this method is used to distribute the software to users, you must configure the Subversion client to include certain Ruby files. Otherwise, not everything will be synchronized with the repository and the integration fails to work. Then you must register a specific DLL on the client computer to make the integration work.

About this task

By default, the Subversion client ignores certain files. One of these ignored file extension is .so, a shared Ruby library that is not normally saved in the repository. The Ruby distribution included in the integration contains many of these .so binary files, and they would all be lost unless configured otherwise.

(22)

The DLL ectr_wrapper.dll is a .NET assembly. To register the DLL, use the tool RegAsm.exe from the .NET 4 framework. Do not use regsv32.exe to register this DLL.

Procedure

1. Configuring Subversion:

a) On Windows systems, open the Subversion configuration file %APPDATA%\Subversion

\config in a text editor.

b) Locate the line # global-ignores = *.o *.lo *.la *.al .libs *.so *.so.[0-9]*

*.a *.pyc *.pyo __pycache__.

c) Uncomment the line, change it to global-ignores = xxx and save the file.

d) Add the ECTR and integration code with svn add --force for inclusion into the repository.

e) Commit the files.

Result

The ECTR and integration code was correctly synchronized with the repository and no files are missing.

2. On the client computer, update the ECTR and integration code from the repository or check out the repository.

3. Registering ectr_wrapper.dll:

a) Make sure the DLL plm_conn.dll in <ECTR_DIR>\basis\sys\win\lib64 is registered.

b) Copy the DLL plm_conn.dll from <ECTR_DIR>\basis\sys\win\lib64 to <ECTR_DIR>

\addons\ecad\basis\sys\win\bin.

c) Start a CMD window with administrative rights and go to the directory <ECTR_DIR>\addons

\ecad\basis\sys\win\bin.

d) Execute the command C:\Windows\Microsoft.NET

\Framework64\v4.0.30319\RegAsm.exe ectr_wrapper.dll /codebase /verbose / tlb.

Result

The DLL ectr_wrapper.dll is registered.

Result

Integration code that is manually distributed via Subversion works on the client computers being used.

(23)

5.1 Datamodel

5 Configuration

5.1 Datamodel

The datamodel describes the objects in ECTR used by the integration to save the design information.

BOM item n

Assembly PDF file_assy_pdf

Fabrication data file_gerber

IPC-2581 data file_ipc2581

Innovation document

doc_inno

Assembly document

doc_group

Assembly data file_assy_data

Assembly material

part_group

PCB document

doc_pcb

Fabrication PDF file_fabrication

ODB++ data file_odbpp Schematic PDF

file_sch_pdf

part_in_bom

BOM

IDF data file_idf

STEP data file_step

Custom extra file file_pcb_extra_1

Custom extra file file_pcb_extra_2

Custom extra file file_assy_extra_1

Custom extra file file_assy_extra_2 Innovation container

file_inno

Innovation PDF file_pdf

Custom extra file file_inno_extra_1

Custom extra file file_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 to support ECTR system requirements, but is not relevant for the user.

(24)

5 Configuration 5.2 Configuration files

5.2 Configuration files

5.2.1 Datamodel configuration files

The datamodel configuration is located in the product-specific configuration directory <ECTR_DIR>

\applications\<productID>\customize\config and controls the data exchange between OrCAD CIS and ECTR.

Scope of datamodel configuration

In the datamodel configuration you typically maintain:

■ General object and attribute definitions in OrCAD CIS and ECTR

■ Attribute mapping rules between OrCAD CIS and ECTR

■ Definitions of workflow status actions in ECTR

■ Creation of output files

■ Configuration of BOM processing and synchronization of components and materials Datamodel configuration files

The datamodel configuration is defined in the following main files:

Configuration file Description

*.classification Contains product-specific mapping rules for the parts

synchronization in the module Synchronize Parts. Entries in this file redefine or extend the *.release file.

Note: Only change this file if you use classes in ECTR and/or different component tables in your library.

*.datamodel Contains the product-specific configuration of the datamodel objects and attributes with extended properties. Entries in this file redefine or extend the *.release file.

Note: Always maintain changes to datamodel objects in this file.

*.release Contains the basic configuration of the datamodel objects and attributes with their default properties. The *.release file is read first by the integration and then complemented by the two other files *.datamodel and *.classification.

Note: Only change this file if it is explicitly required in this document.

Available configuration sections

In the *.datamodel file, you can change or extend the default settings of the datamodel objects.

The following table shows the available configuration sections and their application.

Configuration section Description

bom_source Defines settings and properties of the BOM attributes when exporting the BOM from OrCAD CIS.

(25)

5.2 Configuration files

bom_target Defines settings and properties of the BOM attributes when uploading the BOM to ECTR, for example the initial position number, incrementation, sorting, etc.

doc_group Defines settings and properties of the datamodel object Assembly document.

doc_group_part_group_relation This relationship object has no definition.

doc_inno Defines settings and properties of the datamodel object Innovation document.

doc_inno_doc_group_relation This relationship object has no definition.

doc_inno_doc_pcb_relation This relationship object has no definition.

doc_pcb Defines settings and properties of the datamodel object PCB document.

doc_pcb_part_pcb_relation This relationship object has no definition.

doc_template_pcb Defines settings and properties of the datamodel object that manages the PCB template.

doc_template_sch Defines settings and properties of the datamodel object that manages the schematic template.

file_assy_data Defines settings and properties of the output file Assembly data.

file_assy_extra_1 Defines settings and properties of a custom output file that is saved by default to Assembly document.

file_assy_extra_2 Defines settings and properties of a custom output file that is saved by default to Assembly document.

file_assy_pdf Defines settings and properties of the output file Assembly PDF.

file_fabrication Defines settings and properties of the output file Fabrication PDF.

file_gerber Defines settings and properties of the output file Fabrication data.

file_idf_data Defines settings and properties of the output file IDF data.

file_inno Defines settings and properties of the output file Innovation container.

file_inno_extra_1 Defines settings and properties of a custom output file that is saved by default to Innovation document.

file_inno_extra_2 Defines settings and properties of a custom output file that is saved by default to Innovation document.

file_ipc2581 Defines settings and properties of the output file IPC-2581 data.

(26)

5 Configuration 5.2 Configuration files

file_odbpp Defines settings and properties of the output file ODB++ data.

file_pcb_extra_1 Defines settings and properties of a custom output file that is saved by default to PCB document.

file_pcb_extra_2 Defines settings and properties of a custom output file that is saved by default to PCB document.

file_pdf Defines settings and properties of the output file Innovation PDF.

file_sch_pdf Defines settings and properties of the output file Schematic PDF.

file_step Defines settings and properties of the output file STEP data.

file_template_pcb Defines settings and properties of the PCB template file.

file_template_sch Defines settings and properties of the schematic template file.

part_group Defines settings and properties of the datamodel object Assembly material.

part_in_bom Defines settings and properties of the component and material attributes in the BOM Comparison dialog.

part_lib Defines settings and properties of the component and material attributes in the module Synchronize Parts.

part_pcb Defines settings and properties of the datamodel object PCB material.

See also

Understanding integration variables on page 13

5.2.2 Other configuration files

In addition to the datamodel configuration files, there are the language files that control the localized texts of UI elements in the module dialogs, and the IVS preferences file.

Language files

Configuration file: <ECTR_DIR>\applications\<productID>\basis\dictionary\<language code>\ectr.txt

By default, the integration comes localized in German and English. The following files define the language you can set in the module dialogs:

■ de\ectr.txt (German)

■ en\ectr.txt (English)

Examples of common changes to UI texts:

■ Changing names of options in the module Save and section Design, for example Keep reserved, Upload design, or PDF.

(27)

5.3 General configuration options

■ Changing tab names in the BOM Comparison dialog, for example Refdes View, Quantity View, or Unassigned Parts.

Names of options in module Save and section Design:

dialogs.button.keep_reserved=Keep Reserved dialogs.button.upload_inno=Upload Design dialogs.button.upload_pdf=PDF

Section titles in module Save:

dialogs.label.innovation=Design dialogs.label.group=Assembly

Tab names in BOM Comparison dialog:

dialogs.comparison.tag.title=Refdes View dialogs.comparison.quantity.title=Quantity View

dialogs.comparison.unreleased_parts.title=Unreleased Parts

In general, it is common to search the file ectr.txt file for the text that appears in the module dialog. Be aware that such text can appear in more than one place in the file, depending on its usage in the integration code.

Restart the integration module to see the affected changes.

IVS preferences file

Configuration file: <ECTR_DIR>\applications\<productID>\customize

\config\ivs.properties

This file saves everything you select in the IVS preferences. Further, you can define other settings, for example:

■ Define how emails are created when you click Help > Report Problem.

■ Define the default directory where problem reports are saved.

■ Define the start dialog in the module Synchronize Parts.

5.3 General configuration options

5.3.1 Handling of variant-specific output files

Not all ECAD applications manage variants and create output files the same. Because of this characteristic, variations in the product structure are possible. The following table shows how OrCAD CIS handles the variant-specific output files of schematic and assembly drawings.

ECAD Innovation PDF

(file_inno) Schematic PDF

(file_sch_pdf) Assembly PDF

(file_assy_pdf) GUI OrCAD CIS Basic schematic Variant-specific

schematic

Variant-specific assembly drawing

(28)

5 Configuration 5.3 General configuration options

5.3.2 Encrypting passwords

The integration saves passwords for certain applications in an encrypted format. If the password is changed later, you can use an external tool to re-encrypt the new password and update it in the configuration file.

Procedure

1. Go to <ECTR_DIR>\applications\<productID>\basis\sys\win\bin and double-click encrypt_password.bat.

Result

The Encrypt Password dialog opens.

2. In the field Password, enter the password in plain text and click Generate.

Result

The password is encrypted and can be copied from the field Encrypted. Example of an encrypted password:

CRYPT{AQUBFAsTAAhzQVJCHBIcQFEAWVdWHgENHUcMDVBeVg==}CRYPT

Next steps

You can use the encrypted password as-is in Ruby files (.rb) and batch files (.bat).

5.3.3 Configuring new attributes and mapping

In addition to the default attributes of the datamodel objects, you can add new attributes and define the mapping between the fields in OrCAD CIS and in ECTR.

About this task

The *.release file contains the default attributes with initial properties. If you must create new attributes, always do this in the *.datamodel file and never in the *.release file.

Adding new attributes for the parts in the library and using them in the module Synchronize Parts will be the most common use case and is described in detail here.

Procedure

1. Open the *.datamodel file in a text editor.

2. In the section part_lib, add a new attr() definition with the attribute name and modifier options.

part_lib {

attr('Value', :blank_equal => true) }

3. After the attr() definition, add a new property() definition with the same attribute name to define additional behaviours.

part_lib {

attr('Value', :blank_equal => true) property('Value')

}