Live Supplier Data - Import to Libraries and Schematics
Contents
For any given Supplier Item found through a search in the Supplier Search panel, you can import its parameters, data sheet links, pricing and stock information, as parameters of a target library component (SchLib, DbLib, SVNDbLib), or placed component on a schematics sheet.
Creating a live link between an Altium Designer component and a Supplier Item has always been a simple process and importing information from an item is equally so. Simply select the parameter(s), data sheet link(s), pricing information, or stock information that you wish to import, in the detailed information section of the Supplier Search panel, then drag and drop:
- Anywhere within the main editing area of the Schematic Library Editor – ensuring the source Schematic Library document is the active document in the main design window and the recipient component is focused. You can also add information to a component by dropping onto the component's name (in the Components region of the SCH Library panel).
- Onto the required component record, in the Table Browser tab of the relevant Database Library file or SVN Database Library file – ensuring the DbLib or SVNDbLib file is the active document in the main design window.
- Onto the schematic symbol of a placed component – ensuring the source schematic document is the active document in the main design window.
For parameters, pricing and stock information, the import will proceed in accordance with any defined parameter import options.
The following sections take a look at the import of these different pieces of information.
Importing Parameters
Consider, as an example, the case where we have a component defined in a Schematic Library, which represents an N-channel MOSFET (a 2N7002). We have already linked a Supplier Item to this component and now need to import the parameters.
The example library component and the linked Supplier Item.
For the purposes of demonstrating the feature, a couple of parameters have already been defined for the component in the library – the Continuous Drain Current (Id) and the Drain Source Voltage (Vds). The Supplier Item names these parameters differently, so let's set up some parameter name mapping to ensure the data comes in to our existing parameters in these two cases.
It's a simple case of adding the two parameters – named as per the Supplier Data area – and using our naming for the Imported Parameter Name fields.
Define parameter name mappings to ensure the existing parameters for the component get used,
rather than adding new parameters for this same data.
Now the options are set, we need to just select the parameters we want to import, in the detailed Parameters section for the Supplier Item. As this Supplier Item is already linked to the component, we don't need to import the Supplier or Supplier Part Number parameters. Let's import all others. Once selected, just drag the selection onto the component's name – in the Components region of the SCH Library panel – or within the main editing area for the component itself. That's all there is to it – a quick check in the properties dialog for the component shows that the parameters have been imported, and the two existing parameters have been used to receive data as required!
Parameter import in action!
- Parameters can be imported without setting up a prior live link to the Supplier Item, however importing the Supplier and Supplier Part Number parameters in this manual, drag and drop fashion, will not create a live link to the item.
- Another way to initiate the import of parameters is to select the required parameter(s) in the detailed Parameters section for the Supplier Item, right click and choose the command from the context menu that appears. If a Schematic Library, Database Library or SVN Database Library is active, the command will appear in the format
Add Parameters To ComponentName, whereComponentNameis the currently focused component/component record in the library. If a Schematic document is active, the command will appear in the formatAdd Parameters To Part. Simply click on each placed component to which you want to add the parameters using the cross hair cursor. Right-click or press Esc to exit.
- All importable data for a Supplier Item can be imported, along with a new supplier link to that item, in one step. Simply right-click on the Supplier Item entry in the Supplier Search panel and choose the Add Supplier Link And Parameters To command (see Adding a Supplier Link and Parameters Simultaneously).
Importing Data Sheet Links
The process for importing a data sheet link from a Supplier Item is the same as that for importing parameters. The only difference is that there are no options to set up beforehand – just click and drag the data sheet link from the detailed Documents section for the Supplier Item onto the target component/component record in the active library (SchLib, DbLib, SVNDbLib), or component on the active schematic sheet as required.
The process will add a ComponentLink parameter pair, targeting the data sheet. By default, the same value will be entered for both the ComponentLinknDescription and ComponentLinknURL parameters – the URL for the data sheet. Access the link from the usual References sub-menu for the component.
Add a link to a data sheet for a Supplier Item with a drag of the mouse!
It can be a good idea to change the value for the ComponentLinknDescription parameter to a shorter, more meaningful entry, for better display in the References sub-menu.
Importing Pricing Information
To import pricing information from a Supplier Item, simply click anywhere within the detailed Pricing section for the Supplier Item and drag the data onto the target component/component record in the active library (SchLib, DbLib, SVNDbLib), or component on the active schematic sheet as required. Import will proceed in accordance with defined parameter import options for the Pricing parameter.
Although a Supplier Item may typically list a range of different prices, based on quantity levels, the import results in only a single Pricing parameter. The value of the parameter will reflect these various price-quantity relationships in the following format:
Quantity1=Price1, Quantity2=Price2, ... Quantityn=Pricen
The left-most Quantity-Price pairing in the imported parameter corresponds to the first entry for pricing for the Supplier Item in the Supplier Search panel.
Pricing information for a Supplier Item can be imported as a distinct parameter.
Importing Stock Information
To import stock information from a Supplier Item, simply click anywhere within the detailed Stock section for the Supplier Item and drag the data onto the target component/component record in the active library (SchLib, DbLib, SVNDbLib), or component on the active schematic sheet as required. Import will proceed in accordance with defined parameter import options for the Stock parameter.
If a Supplier Item is currently out-of-stock, there will be no available Stock section in the detailed information area of the Supplier Search panel.
Stock information for a Supplier Item can be imported as a distinct parameter.
Defining Parameter Import Options
Prior to importing any parameters from Supplier Items, you have the opportunity to define name mappings. This is particularly useful where, for example, you already have certain parameters defined for your library components, and those existing parameters have different names to those used by the Supplier in their published data for an item. Rather than importing data into a new/separate parameter, you want to import it into your existing parameter – and therefore need to setup the mapping to do so.
Parameter name mappings are defined as part of the Parameter Import Options, on the System – Suppliers page of the Preferences dialog (DXP»Preferences).
Define options for imported parameters on the System - Suppliers page of the Preferences dialog.
When importing a parameter, the software will look to these options to see if that parameter has a defined mapping – specified by the Imported Parameter Name field. If this field is blank, or the parameter is not listed, it will be imported using the parameter name used by the Supplier. If the Imported Parameter Name field has a value, then data will be imported into a new or existing parameter with that name. In the case of the latter, the data will overwrite any existing data. Add, define and remove name mappings as required.
You can also specify whether or not you want the imported parameter to be visible in the workspace.
The Supplier Link options only apply when creating a new Library component from a Supplier Item, or when adding a Supplier Link and parameters simultaneously using the Add Supplier Links And Parameters To command. For each listed parameter, you can choose to exclude it from import, and also define whether a suffix is to be used – useful if importing parameters from multiple Supplier Items to the same Altium Designer component. The suffix identifies a parameter as belonging to a particular supplier link. Hence it can be deleted when the supplier link is deleted. Note that non-suffixed parameters will not be deleted.
By default, several base parameters are defined, all enabled for import when creating new components from Supplier Items, or importing parameters along with a supplier link. With the exception of Supplier and Supplier Part Number, options for these parameters can be edited, including specification of imported name. None of these parameters can be deleted.
The Supplier and Supplier Part Number parameters will always be added when creating a new component or adding a supplier link – you cannot exclude them. They will also always be given a suffix and the Supplier Part Number will be made visible by default.
When creating a new component from a Supplier Item or importing parameters along with a supplier link, if a parameter for that item is not listed, it will be imported by default. If you don't want a certain parameter imported, you must add an entry for it and check its Exclude option.