You are here

Using the Update Part Status Command in Capture CIS





Overview

Update Part Status command in Capture CIS

What does the Update Part Status command do?

How do I run the Update Part Status command on my design?

When should I run the Update Part Status command on my design?

Three general rules for when to run the Update Part Status command:

What the Update Part Status command does not update

How does the Update Part Status command affect instance and occurrence properties?

Controlling a property update from the CIS configuration file

Speeding up the Update Part Status command

Appendix: Part Status in CIS Part Manager

Appendix: BOM Variant Status in CIS Part Manager

Overview

Provide clear and complete instructions for the use of the Update Part Status command and its place in the Capture CIS design flow. Suggest methodologies and best practices that work with the strengths of the tool to enhance users design flow. Detail some of the common pitfalls users experience when they go to use this command and explain how to get around these issues.

TOC

Update Part Status command in Capture CIS

CIS's primary role is to help users produce accurate BOMs at all stages of the design process. CIS provides users with access to a database of known good parts during the schematic entry process. Once these parts are in a design, users have full control to edit the part and modify any of the parametric properties that make a part a unique representation of a component.

The consequence of this control is that users could introduce errors into approved parts that could sneak into a BOM. Additionally parts that were created as temporary parts and used in the design could have been updated with real part number information. Parts that have been modified and parts that have been given an approved number need to be identified and taken care of before a BOM is run. Capture CIS uses the Update Part Status command to handle these problems. The Update Part Status command uses the part number of a part to synchronize the properties on the schematic with the properties in the database.

TOC

What does the Update Part Status command do?

The Update Part Status command is one of the interfaces between the database and the design. During an Update Part Status run, CIS finds the part number property assigned to a schematic symbol. CIS passes a query using the part number through ODBC. ODBC returns the properties associated with that part number from the database. The properties that are set as Transfer to Design in the CIS database configuration (.DBC) file are then compared with properties of the same name in the schematic symbol. If a discrepancy is found, CIS alerts the user with the Update Part dialog box that displays the schematic properties and database properties side by side with the discrepancy fields highlighted in red.

Figure 1-1 Update Part status dialog box

image

Once the dialog box is open the user has the following options:

Select... To
Yes Update the current part and start the process all over with the next part
Yes All Update the current part and all parts in the design with differences.
No To skip updating the current part. The process will compare the next part.
No All Stop updates to remaining parts.

image

CIS allows a user to create and use temporary parts in a design. These temporary parts allow a user to create a placeholder in the CIS database that will be updated with real part number information. This speeds the design process since a user does not have to wait for the part approval process to proceed with the design. The Update Part Status command will find the temporary parts in a design and let the user know that these parts exist with a yellow status indicator. A user might not want to create a final BOM until every part has been through the approval process. Once the database is updated with a real part number, CIS will treat the part like any other out of date part and try to update it.

Figure 1-2 Update part status of temporary part

image

TOC

How do I run the Update Part Status command on my design?

The Update Part Status command is run from the Capture CIS Part Manager. The Part Manager allows users to quickly assess what parts are in a design and the current status of those parts. The list of properties displayed by the Part Manager is user configurable. The Part Manager is interfaced to the design variant feature in Capture CIS. Single parts or groups of parts can be linked to the database from the Part Manager.

TOC

When should I run the Update Part Status command on my design?

The part status is just a snap shot of a part's compliance with the database at a given time. The part status is not dynamic and does not change as the database changes. During a given Capture session a part's status will be remembered by CIS. Once the design is closed and reopened, CIS will assume that the part status is out of date and reset the part status for all parts to yellow.

Many users spend a lot of time running the Update Part Status command to make sure the information in the design is current with the information in the database. Every time they open the design they run the Update Part Status command to get all the part status indicators as green. The problem with this approach is that users spend a lot of time running the tool for little real gain.

As a general rule most of the data in the database is not going to change very frequently. Examples of information that almost never changes are properties like TOLERANCE and VOLTAGE. The only reason these properties might change is if they were added to the database incorrectly but most of the time these properties would not be altered. The exceptions to the above rule are properties like cost and lead time. This information could be updated by the Purchase department on a daily basis.

Properties like cost and lead time represent important design considerations. One of the advantages of CIS is that it gives engineers and Purchase departments visibility into cost and lead time considerations early in the design process. Custom bill of materials are created to assist in analysis and these BOMs require the most current information from the database. Before any report is created in Capture CIS the Update Part Status command should be run.

Designs may be modified at a later date or used as the basis for a new design. One of the first things that should be done when opening an older design for update or modification should be running the Update Part Status command. This update will make sure that the engineers are dealing with the most current part information when they begin their work. Your

database may also contain information about part obsolescence. An update part status and a custom BOM will catch this information letting an engineer know which parts are still current and which need to be replaced. The Update Part Status command should be run on any design that is opened after being archived for any length of time.

Databases are designed to be static structures that support fluid data. This is the ideal but invariably the database schema, or structure, will change. The data in the database may also periodically be refreshed and scrubbed to get rid of any inaccurate entries. When this happens, an effort should be made to update all the designs currently in process. As property names and data may change, it is a good practice to run the Update Part Status command if you know that the database has undergone some form of alteration.

The Update Part Status command serves a vital function in the CIS design flow but it can be overused. It is recommended that users follow the guidelines outlined above to minimize the number of part status updates. Ultimately the user needs to decide where the function fits into their design process to give them the maximum comfort that the design and database are synchronized.

TOC

Three general rules for when to run the Update Part Status command:

  1. Before any report creation (BOM, Variant Reports, Cross Reference reports, etc.) in Capture CIS.
  2. When updating or modifying a design that has been archived.
  3. If major database changes have occurred.

TOC

What the Update Part Status command does not update

The Update Part Status command only affects properties that were transferred from the database to the design. Properties that exist on the schematic symbol with the same name as a database property that is not transferred to the design will not get updated.

Schematic symbols are not changed by the Update Part Status command. If a difference exists between the symbol specified in the database and the symbol used on the schematic page, the Update Part Status command will note this and the Part Manager will flag it. The inability to change schematic symbols is actually built into CIS to stop potential changing of parts that could cause shorts. The Update Part Status command has the option to update all parts in the design without letting the user control which parts are updated. If schematic symbols could be changed, it would be possible for symbols to change all over the schematic without the user's knowledge or control. The only way to update schematic symbols to match

those symbols defined in the database is to use the Link Database Part function. This command can be run from the CIS Part Manager or the schematic page. The Link Database Part command transfers all the properties from the database to the schematic symbol.

TOC

How does the Update Part Status command affect instance and occurrence properties?

Hierarchical design allows a user to create a single schematic sheet that is referenced multiple times. The advantage of this is that users do not have to redraw a schematic every time they wish to reuse a similar section of circuitry. The disadvantage of this

For hierarchical designs, CIS always displays the occurrence properties and updates the occurrence properties only. When the update is complete, a list of updated parts and discrepancies with the database is written to the session log.

In a flat design each page references only instance properties. It is possible that occurrence properties begin to show in a flat design. In this case each part in the design can be considered to have a single instance property and a single occurrence property. In this situation the following rules apply.

Table 1-1

Instance level property value

Occurrence level property value

Property value in database

Result after Update Part Status command is run

1 2 1

Update Part dialog box will display difference between Occurrence and Database, and Part Manager will display 1 if the Yes button is clicked and 2 if No button is clicked

2 2 1

Update Part dialog box will display difference between Occurrence and Database, and Part Manager will display 1 if the Yes button is clicked and 2 if the No button is clicked.

1 2 3

Update Part dialog box will display difference between Occurrence and Database, and Part Manager will display 3 if the Yes button is clicked and 2 if the No button is clicked.

1 2 2

No dialog box will appear. Part Manager will display 2.

TOC

Controlling a property update from the CIS configuration file

Database properties can be set to exist only in the database or be transferred to the schematic design. As a general rule properties that are fairly static and affect the electrical characteristics of a design should be transferred to the part on the schematic. Properties that are subject to change should be left in the database. These properties are always accessible to the user through reports or through View Database Part command. Special cases may exist and it is up to the CIS administrator to decide which properties should be transferred to the design. The Update Part Status command will not change any properties that are not set to be transferred to the design. So this is a way to control which properties get updated and which do not. The Transfer to Design option can be set for each property during configuration file creation using the Database Configuration wizard or by modifying the existing configuration file.

The Database Configuration wizard can be launched from the CIS Configuration File dialog box by clicking the New button. Step 6 of this wizard allows a user to set properties for transfer to design and also allows a user to set the OrCAD Property name which controls the property name once the part is placed on the schematic. If the Transfer to Design check box next to a property is selected, the property will be transferred to the design. If the Transfer to Design check box next to a property is not selected, the property will be maintained in the database only and not transferred to the design.

Figure 1-3 Database Configuration Wizard: Transfer to Design option

image

At any time you can change the Transfer to Design setting for a property by clicking the Setup button in the CIS Configuration File dialog box. Figure 1-4 depicts the window that is opened by this operation. You can select or deselect the Transfer to Design check box next to a property in this window.

Additionally a property option exists in the CIS configuration file that will force a property from a given table to be ignored by the Update Part Status command. This is useful for users who have properties to be modified by design engineers. Examples of this would be any notes field or PSpice specific properties. Unless you have a specific reason to ignore these properties, it is recommended that you do not use this option. To set this option edit the CIS configuration file and look for the Update Part Property check box next to a property. If this check box is selected, it means that the part will get updated. If this check box is not selected, the property will be ignored. Please note that this property will have to be set for each table.

Figure 1-4 Configure Database window to change the Transfer to Design option

image

TOC

Speeding up the Update Part Status command

Values entered in the "Allowed Part Reference Prefixes" text box helps to increase the speed of the Update Part Status command. Figure 1-4 shows the “Allowed Part Reference Prefixes" text box. You can specify the part reference prefix for each and every table. If you want to specify more than one prefix, you should separate it by spaces.

"Part Reference Association" is also used in conjunction with "Allowed Part Reference Prefixes" to speed up the procedure of updating part status. You can setup the Part Reference Association by clicking Options > CIS Configuration> Setup and then selecting the "Part

Reference Associations" tab. Figure 1-5 shows the Configure Database window where you can set these references:

Figure 1-5 Configure Database window to setup Part Reference Association

image

While searching the database, CIS searches for the part reference specified for a given part type. For example, if C is defined as the Applicable Part Reference Prefix for Ceramic, CIS will search for only C part reference in the Ceramic part table. This helps to filter the search procedure and thus speed up the search.

TOC

Appendix 1: Part Status in CIS Part Manager

Status

Definition

Tool Tip

Action

imageApproved: Current

The part number defined for the placed part matches the database part, and all the transferable properties match.

None

The part is current and ready to be incorporated into reports.

imageApproved: Defined

The placed part has a defined part number property, but has not been checked against the database part.

Approved Part Number property is defined. Run Update Part Status to check parts against the database

Run Update Part Status to check parts against the database.

imageApproved: Undefined Reference Designator

The placed part has an undefined part reference prefix (such as "R?").

Undefined part reference %1 with

Part Number %2.

Annotate the design.

imageApproved: Not Current

A part number property exists in the part database, but the placed part is out of date with respect to one or more transferable properties.

Database part differs from schematic part -

%s. Affected properties: <property that differs>

Update the part status. You get an option to update the properties that are different.

Check Table-1 for the properties which will prevail once Update Part Status is run.

imageApproved: Duplicate

The part number occurs more than once in the part database. This status occurs only if your configuration does not allow duplicate part numbers.

Multiple entries in part database(s) matching approved part number.

Remove the restriction of duplicate part numbers in the CIS configuration (.DBC) file or remove the duplicate part numbers from the database.

imageApproved: Not Found

The part number does not exist in the part database.

Cannot find approved part number %1 Linked to Schematic Part %2.

Add the part with that part number to the database, or check the schematic part properties to verify that the part number has not changed.

imageUndefined

The placed part does not have a part number property, or the part number property is blank.

Part %1 on the schematic page - %2 has no part number property.

Link the part to the database part, if it is not a database part. If the part is from the database, check the database.

imageTemporary: Current

The placed part has a temporary part number, and all the transferable properties match their counterparts on the database part.

Part has temporary part number %1 has been checked against database, all properties are the same as database.

To change it to an approved part, replace the temporary part number with an approved part number in the TMPPRTS table.

imageTemporary: Defined

The placed part has a temporary part number, but has not yet been checked against the database part.

Temporary Part Number property is defined. Run Update Part Status to check parts against the database.

Run Update Part Status.

imageTemporary: Not Current

The temporary part is out of date with respect to one or more of the transferable properties.

Database part differs from schematic part - %s. Affected properties: <prop>

There is an inconsistency in the properties in the database and the schematic for the temporary part added. When you run Update Part Status, you get an option to update the changed properties. Click Yes to sync the schematic properties with the database properties.

Check Table-1 for the properties that will prevail after Update Part Status command is run.

imageTemporary: Duplicate

This status occurs only if you intentionally duplicate a temporary part number.

Multiple entries in part database(s) matching temporary part number

Check for duplicate temporary part numbers and correct.

imageTemporary: Not Found

The part number does not exist in the part database.

The temporary part number %1, linked to schematic part %2, cannot be found in the temporary part number table nor in the database table.

Add the part to the database and to the TMPPRTS table.

imageAmbiguous: Undefined

The part is ambiguous and undefined. Multiple values exist for the samecomponent.To resolve a part ambiguity, use the Resolve Ambiguity command and choose a value.

Multiple values exist for the same component. Run Resolve Ambiguity to choose one value.

Run Resolve Ambiguity to choose one value.

imageAmbiguous: Resolved

The part was ambiguous and the ambiguity has been resolved. Multiple values exist for the same component. The selected component is not used in the variant

None

The part is current and ready to be incorporated into reports.

TOC

Appendix 2: BOM Variant Status in CIS Part Manager

Status

Means

Tool Tip

Action

image

The part is not defined in a group or subgroup contained in the BOM variant folder.

None

Add a group or subgroup that contains the missing part to the BOM variant folder.

image

The part is set as not present in the current design variant. This part will be missing from any BOMs created using this variant.

None

No action required.

image

The part is linked to an alternate component. This alternate component is different from the one in the core design; any BOM created with this variant will contain the alternate components part number and properties.

None

No action required.