You are here

Understanding Usage of CIP in Allegro Design Entry CIS





Introduction

Pre-requisites

Logging into CIP

Using Help

Performing a Search

Creating New Parts in CIP

Previewing and Placing a Schematic Part

Preview the PCB Footprint

Using the Temp Parts Tab

Introduction

Component Information Portal (CIP) provides a powerful interface for entering, deleting or modifying data. You can search parts as
well as generate temporary parts using CIP. CIP also facilitates the process of converting temporary parts into formal parts.

You can also create Capture symbols and PCB Footprints using the OrCAD Library builder feature available within CIP, after making sure that the license of OrCAD Library builder is available.

CIP searches the results in two types of databases: - Local and Distributor.

TOC

Pre-requisites

To take advantage of the capabilities offered with the integration of CIP, Cadence OrCAD Capture CIS and OrCAD Library Builder, set up the following configuration:

  • Cadence OrCAD Capture CIS 17.2-2016

  • CIP License (which is different from CIS)

  • OrCAD Library Builder License 17.2 and installation of OrCAD Library Builder at your machine

  • Windows 7, Vista, Windows 8, Windows 8.1, Windows 10

  • Allegro Free Viewer

TOC

Logging into CIP

You can access the CIP in two ways:

  1. From an external browser

    The URL is: SQL_Server_Name/CIP-E/

    As you can see in Figure 1 below, the URL given is: pc-radhikag/CIP-E/

    Figure 1: The CIP Login Page

  2. From within the OrCAD Capture environment

    Follow the steps mentioned below-

    1. Launch OrCAD Capture CIS. Select the CIP menu and choose “Open CIP” as shown in Figure 2.

      Figure 2: The CIP Menu

      This will launch CIP.

    2. Enter the username and password.

      Figure 3: The CIP Login Page

      If your account is a local account, you will need to enter the username and password before selecting theLog inbutton.If the account is a Windows account, you only need to select theWindowsbutton and you will be automatically logged in.

      The login you acquire will determine the privileges you have while working with CIP. This is defined by an Administrator. Only the Administrator has access to the admin menu as shown, which is used to set certain options such as define ‘user roles and permissions’, and make configuration changes in CIP.

First-time authentication:

When CIP is first installed there are some default user names that are set up.

When you launch CIP for the first time, log in with the user name admin and the password Admin.

Once logged in, set up the users who can access CIP and set them up as Windows users.

From the Admin menu select Users, Roles & Permissions.

Figure 4: The Admin menu

Click the Windows check box and enter the user name in the appropriate field. CIP will try to locate the user name as you enter it.

Figure 5: The Admin- Users, Roles and Permissions Setting

Once you have created the user and assigned the appropriate role the check mark icon at the beginning of the line will be active and you can save the user name. This user will now be able to log in to CIP using their Windows credentials.

The CIP Homepage

As soon as you invoke CIP you see the CIP Homepage which is the same as the CIS DB Search Page. This is essentially a query page inside CIP where you can build queries. You can set your parametric field using any of the
fields that are available in the drop-down list. You can also choose an operator.

Figure 6: The CIP Search Page

Note: Special characters like * cannot be used in the parametric search.

TOC

Using Help

Once logged in, the main Help link will be located at the top right area of the CIP window. Here you can also see the login name and the log off links.

Figure 7: The Help Button

When the Help document opens, you will be able to search for the items you need.

Figure 8: The Help Document

TOC

Performing a Search

The different types of searches are described below:

1. Using CIS DB Search

The CIS DB Search tab enables you to perform part searches in the local database. You can search for parts using the parametric fields for a refined search.

Figure 9: The CIP/CIS DB Search page

LAB-1: How to perform CIS DB Search

  1. Go to the Parametric Field and use the drop-down list to select Part Type. Change the operator to “Contains” and enter Ceramic in the Parametric Field.

  2. Click the + button in the Add/Remove area to add another row.

  3. Use the drop-down list to change the Parametric Field in the newly added row to PCB Footprint. Change the operator to “Contains” and enter CAPC1608X87N in the Parametric Field.

  4. Click the Search button.

    See Figure 10 below for your reference.

    Figure 10: CIS DB Search Using Different Parameters

One can include additional fields using the “Include Additional Fields in the Search Results” checkbox. For instance, we have added Tolerance in the “Include Additional Fields in Search Results” and we can see that the Tolerance field is added in the displayed search results as well. See Figure 11 below.

You can also add more additional fields by clicking on the + button. This will add a new row and you can choose any additional fields from the drop-down list.

Figure 11: Including Additional Field

You can export the results into Microsoft Excel by clicking on the Export button with the “For Excel” option, as highlighted in Figure 12 below. Click on the Export button again to view the results.

Figure 12: Export Search Results in Excel Format

2. Using Quick Search

This can be done by entering search data in the Search entry field on the right side of the Menu bar, then clicking the GO button to initiate the search.

LAB-2: How to perform Quick Search

  1. In the Search block, enter Capacitor as highlighted in Figure 13.

  2. Click Go to launch the search. Re-view the results. Note that the Table has the search string “Capacitor”.

    Figure 13: The Quick Search Page

  3. 3. Using the Part Type Search

    The Part Type determines where a part will reside in CIP. Part Types can be created if you have administrator privileges. The Part Type tab enables you to search by expanding tables and sub-categories.

    Lab-3: How to perform the Part Type Search

    1. Click the Part Type tab in the default page, that is, the CIS DB Search page.

    2. Expand the table tree and you can see the list of the available parts, as shown in Figure 14.

      Figure 14: The Part Type Tab in the CIS DB Search Page

    4. Using the Distributor Search Tab

    It provides a way to directly search for parts that are available from the list of distributors databases. These parts have varying options to check, such as In Stock, RoHS Complaint, and Lead Free parts. TheSearch Typeallows you to search based on theKeywordorManufacturer Part Number. When searching across multiple distributors, the results are limited to 25 records from each distributor.

    Figure 15: The Distributor Search Page

    Search by Keyword

    You may also perform aKeywordsearch by selecting the drop-down option from theSearch Typelist. You may search multiple distributors at the same time. Add the keyword and click theSearchbutton to obtain results.

    Note: "In Stock", "RoHS Compliant" and "Lead Free" filter options are not provided by Arrow Electronics. When selecting multiple distributors, these will not be shown when Arrow is included.

    Figure 16: Searching by Keyword

    Search by the Manufacture Part Number

    You may search bythe Manufacturer Part Numberby selecting the drop-down option from theSearch Typelist. You may search multiple distributors at the same time. Add the Manufacturer Part Number and click theSearchbutton to obtain results.

    Figure 17: Searching by the Manufacturer Part Number

    Lab-4: How to perform the Distributor Search

    1. Click on the Distributor Search menu.

    2. Select Arrow and Mouser in the Distributors field.

    3. Select the Keyword option and enter the value Capacitor.

    4. Check the options for In Stock; RoHS Complaint; Lead Free.

    5. Click Search and review the results.

    Similarly, you can search the parts using the Manufacturer Part Number in the Search Type drop-down as shown in Figure 18 below.

    Figure 18: Distributor Search

    TOC


    Creating New Parts in CIP

    There are different ways to generate new parts in CIP, as described below:

    1. Generate a blank part and then fill in all the appropriate fields.

    2. Copy an existing part, then update the fields that will differ in the new part.

    3. Use the Distributor Search to locate the part from a distributor, and add it to the database.

    Here, after adding it, the parametric data will be auto-populated into the corresponding fields and the part will receive a TMP part number.

    Creating a New Blank Part

    1. New parts can be added by clicking theNewbuttonfrom any Part Information page of a part detail. TheNewbutton is only available to users with permission to add a new part.

      Figure 19: The Part Detail Window

    2. This opens an editing page where all the fields are blank, and you can enter the data for the new part (including a new part number).

      Figure 20: The New Blank Part Window

    3. There are options for adding a part number. You can enter a preferred part number in the PART_NUMBER field.

      Figure 21: Automatic Generation of a Part Number for a New Part

    You can also add the part with a TMP part number. Once you click the “Add part with next temporary PART_NUMBER” button,
    that part will be added with the next available TMP part number in the database.

    Figure 22: Next temporary Part Number Tab

    Figure 23: New Temp Part Created

    Modifying an Existing Part

    1. Parts can be modified by selecting the Edit button on a Part Information page. If you do not see the Edit button, then you do not have permission to modify a part.

      Figure 24: The Part Information window- The Edit button

    2. Once the Part Information appears, modify the desired data and click the Update button to implement the change.

      Figure 25: The New modified part- The Update button

      If the Customizable Fields in Administrative Configurations have been configured such that a field offers a drop-down list, you will be able to choose from the pick list for the available values. For example, if the Dielectric Type field has been set up to offer a drop-down list of the values: Ceramic, Aluminum, Tantalum, or Unknown, then you will be able to access the list and choose one of those values. A default value can also be set, as shown below.

    Figure 26: Part Details

    Copying an Existing Part

    1. The Copy button allows you to create a copy of any existing Formal or Temp part. It also provides an optional check box to copy the associated Manufacturer Parts associated with the Formal or Temp part.

    2. Find the part to be copied. From the Part Information section, click the Copy button

      Figure 27: The Part Information- The Copy button

    3. This opens an editing page with all the copied properties other than the part number and part type properties, which you can add accordingly.

      Figure 28: The Part Editing Page

    4. After clicking the Copy button, you will be able to change the field values and choose whether to copy the associated Manufacturer Parts (using the check box shown) or not.

      Figure 29: The Part Editing Fields

    5. To copy a part as a temporary part, click the Copy as TMP button . This will copy the part and its field values. If Copy Manufacturer Parts is clicked, the associated Manufacturer Parts will be copied as well. CIP will assign the next available TMP PN to the copied part.

      Figure 30: The Part Editing Field- TMP part generation

    6. To copy a part with the given PN (that is, the value in the PART_NUMBER field), populate the PART_NUMBER field manually, or click to generate the next available number. When ready to complete the copy, click  to copy the given PN. If PART_NUMBER is left blank, you will receive an error message after clicking the Copy button. The error message will inform you that PART_NUMBER is a required field.

      Figure 31: The Part Number Field

    Copying a TMP Part from a Distributor Search Part

    1. Find the desired part then choose a category for the part. From the drop-down list in the Table area, select the CIS database table where the part will be stored.

      Figure 32: Part Detail- The Distributor Search

    2. After this, you will be given an option to map the part to a schematic symbol as well as a PCB footprint. CIP offers the schematic symbol and PCB footprints that are already associated with other parts in the same table. Choose them and then click ADD.

      Figure 33: Add Properties to the New Part

    3. A new TMP part will be created with the specified part data. This TMP part would have been added to the CIS database and will be available for placement in the schematic.

    TOC

    Previewing and Placing a Schematic Part

    Capture symbols can be previewed and placed from CIP, when running inside Capture. When CIP is running inside Capture, open any given part. Look at the Preview button to the far right of the Schematic Part field as highlighted in Figure 34.

    Figure 34: Click the Part Preview Button

    If the Preview button is active, click it to preview the symbol.

    In the CIP, we can preview and place the schematic symbol to the schematic page.

    In the Part Information, there are two options in the Schematic Part field:

    1. Placing the part in the schematic
    2. Previewing the part prior to placement.

    Once the preview window appears, click the Place button to place the part on the active schematic page, or click the close button, to close the preview window.

    Figure 35: Click Place for Placing the Part on Schematic or X to Close

    If there are multiple symbols (for example, CAPACITORS\CAP, CAPACITORS\CAP_P...), a drop-down list will be available to preview and place the other symbols.

    Figure 36: Preview Alternative Parts Using the Drop-down list

    If placing the part is successful, the part will be placed on the schematic. If multiple schematic pages are open, the part will be placed on the active schematic page.

    Figure 37: Part Placed Successfully

    If you click Place and a schematic page is not open/active, an error message will appear, as shown in Figure 38.

    Figure 38: Error when Active Schematic Is Not Found

    If you do not wish to Preview, you can simply Place the part on the Schematic by clicking the Place button. The part placed on the Schematic will be the same whether previewed first or just placed.

    Figure 39: Click Place for Placing the Part on the Schematic Without Previewing

    NOTE: Clicking Place without previewing first will always place the first symbol. If alternative symbols need to be placed, the Preview option should be used to select the alternative symbol before placing it.

    TOC

    Preview the PCB Footprint

    If the PCB footprint field is populated the footprint name and the symbol can be found in the pre-determined library paths, and the PCB footprint will appear after selecting the Preview button.

    NOTE: Before previewing the footprint, you need to make sure that the path to the PCB footprints is specified in the [Allegro Footprints] section of the Capture.ini file. If the path is not specified, then you will get the error message as shown below in Figure 40.

    Error: Allegro Footprint not found.

    https://cadence.my.salesforce.com/servlet/servlet.ImageServer?id=0150V00000Bc5RcQAJ&oid=00Dd0000000c1Z9EAI

    Figure 40: Error message- Allegro Footprint Not Found

    To resolve this error, set the Allegro footprints in capture.ini by performing the following steps:

    1. Close the Capture application.

    2. Open the capture.inifile, located at %home%\cdssetup\OrCAD_Capture\17.2.0, in a text editor.

    3. Look for the section called [Footprint Viewer Type]. If this section does not exist, add the following section at the bottom of the capture.ini file:

      [Footprint Viewer Type]
      type=Allegro
      [Allegro Footprints]
      dir0=<path to directory with Allegro footprints>

      You can locate the Allegro symbols for the parts present in CIP, at the CIP installation location. In the case being discussed, it is as shown below:

      C:\Cadence\CIP-E\Allegro_Library\symbols

      Add this directory under the [Allegro Footprints] section, as shown in Figure 41:

      https://cadence.my.salesforce.com/servlet/servlet.ImageServer?id=0150V00000Bc5RhQAJ&oid=00Dd0000000c1Z9EAI

      Figure 41: The Capture.ini Setting

      Note: The CIP-E folder is created on installing the starter library. Allegro_Library is the folder inside CIP-E that contains the Allegro symbols.

      Note:If you have more directories, you can add more directory statements (dir1, dir2, and so on, as shown earlier).

    4. Save the capture.ini file, then invoke Capture and open CIP and open any given part.

      Look at the Preview button to the far right of the PCB Footprint field.

      If the Preview button is active, click it to preview the footprint.

      https://cadence.my.salesforce.com/servlet/servlet.ImageServer?id=0150V00000Bc5RmQAJ&oid=00Dd0000000c1Z9EAI

      Figure 42: The Footprint View

      When you select the
      preview button, the footprint will be open by the configured viewer.

      Make sure that the footprint
      viewer is configured else you will get the error message as shown in Figure 43.

      Figure 43: The Error message when Footprint
      Viewer Is Missing

    To configure the footprint viewer, follow the steps listed below:

    1. Select CIP from the menu bar and selectSettings.

      Figure 44: The CIP Menu

      The CIP Settingspopup window appears, as shown in Figure 45:

      Figure 45: The CIP Settings Window

      You can see that the Footprint Viewer Exe field is highlighted.

    2. Here, you need to specify the path to theallegro_free_viewer.exefile, available in the installation directory, as shown in Figure 46:

      <Release 17.2 install dir>\tools\bin\ allegro_free_viewerexe

      Figure 46: The CIP Settings Window

    3. Now, click theFootprint Previewbutton, and you will be able to see the footprint of the part:

      Figure 47: The Footprint Viewer

      To return to the CIP part form, select  in the viewer. You will receive alerts if a footprint viewer has not been configured, or if you do not have [Allegro Footprint] configured in your Capture.ini file.

      Figure 48: The Footprint viewer

    TOC


    Using the Temp Parts Tab

    When you check the Temp Parts menu you can see all the temporary parts that have been generated and added to the database, the creation time, and the name of the person who generated them.

    On clicking the part, the details of the Temp part can be viewed.

    The list can also be sorted in the ascending or descending order by clicking the column title.

    You can preview the schematic symbol from the search results as well as place it on the schematic if desired.

    Figure 49: The Temp. Parts Tab

    You can also configure the display of properties when displaying each TMP part. This can be done just by selecting the fields you want to see, then choosing Save to store your preferences. Refer to Figure 50 and Figure 51.

    Figure 50: The Temp Parts Configure Display Window


    Figure 51: The Temp Parts Configure Display Settings

    Significance of the “-Assign Next PN-” button

    CIP can generate part numbers by using the “Assign Next PN” button.

    Incremental part numbers can be enabled and assigned in the Admin > Configuration > Incremental Part Number menu.

    Note: Once a part number has been assigned to the part, the Librarian would then notify you that the part has been updated, so that you can perform a Link Database Part operation in CIS to update the part.
    If a temporary part is deemed a duplicate of an existing part, it can be assigned to the existing part number by using the Assign Part feature.
    Once this happens, the Temp part is removed from CIS Database and it will notify you that this part has been assigned to the part <Part Number>.

    Figure 52: The TMP Part Information Window-Assign to Part Button

    Uploading the Bill of Materials (BOM) into CIP

    The BOM menu item allows you to import CIS BOMs into CIP. There are two sub-menus inside the BOM menu-View/Import-Export

    Figure 53: The BOM menu within CIP

    View/Import

     TheView/Importoption in the BOM menu item allows you to view, create the BOM part numbers, and import a parts list to associate with the BOM. BOMs can be modified, copied or deleted once created.

    I. New BOM Creation

    New BOMs can be added by clicking on the New button from the BOM Information page. The New button is only available to users with the permission to add a new BOM.

    Figure 54: A New BOM Creation

    A new blank BOM entry form will appear when you click the New button. The BOM information can be added from this page as well as a formal company Part Number. The BOM Revision field is a required field. Click the Add   button (same graphic as the New button from the previous figure) to generate the new BOM with all the entered information.

    Figure 55: Add a New BOM

    The New BOM results will appear in the drop-down list of parts in the top-right corner.

    Figure 56: New BOM Results

    II. Import Parts to BOM

    A parts list may only be imported to a BOM number that has been created. The BOM may be a Capture CIS BOM. In the BOM Items section, select the Import Children, button to select the file with the parts of your choice.

    Figure 57: BOM Import

    Browse to your BOM and select Upload. The selected BOM must be in the .csv format. All part numbers in the BOM must be in CIP prior to import.

    Figure 58: Upload BOM

    After the BOM is uploaded, you will see the list of parts from your BOM. You will need to map the Part_Number (PART_NUMBER) and Reference designator (RefDes) fields. If the BOM you are importing contains a child BOM (or a subassembly) that has been imported, you will also need to map Revision and Variant. You may also map any field you wish to import.

    Figure 59: BOM Items

    Select the first row of your data and click the Check button to validate the BOM. The validation ensures that part numbers in the list are in CIP. You will not be able to import a BOM that has a part that is not already in CIP. After the validation succeeds, you may import the BOM.

    Figure 60: The BOM Import Check

    After import, the BOM parts may be viewed with one of the three options: single, delimited or compact.

    • Single - Each reference designator is shown on a single line.

    • Delimited - Each part number is shown on a single line where reference designators are shown as a comma-separated list.

    • Compact - Each part number is shown on a single line where reference designators are shown as ranges or comma-separated as applicable.

      Figure 61: The BOM Items page-Imported BOM

    Part attributes (for example, the description, schematic part, PCB footprint and so on) cannot be altered or added using the BOM import function

    III. Delete BOM

    To delete a BOM, select the Delete button, of the BOM you wish to delete.

    Figure 62: Deleting BOM

    The BOM part number and the associated parts list will be deleted from CIP.

    Launching Where Used

    Manufacturer parts that are associated with multiple component part numbers will be identified in the Where Used tab under the Manufacturer Data section of the Part Information Page. The number of additional part numbers are shown inside a blue circle. When you select the Where Used tab, the list of part numbers will be displayed. If the manufacturer part is not associated with any other part, the Where Used tab will not be displayed.

    Figure 63: The Where Used Tab

    Figure 64: The Where Used Parts Information

    To view a BOM, select the link for the BOM.

    BOM Export

    The BOM Export feature allows you to upload a CIS Bill of Materials (BOM) or any parts list, add additional parametric data fields to it, and export the parts list to a comma separated (.CSV) file. This includes the ability to add multiple manufacturers that are linked to a single company part number.

    Select BOM > Export to bring up export options.

    Figure 65: The BOM Export Menu

    You may select either an existing BOM in CIP for export or can upload a BOM for export as shown in Figure 66.

    Figure 66: The BOM Export Page

    TOC