Part Requests in Altium Designer

Parent page: Working with Managed Components

The number of design components available to an engineer when capturing their next design can vary from a few hundred scattered across individual symbol and model libraries, through to hundreds of thousands, stored in a dedicated c ompany parts database. But no matter how many components are available to hand, there will always be more that aren't, and that need to be created and added for reuse.

For a small design house, an engineer will simply change 'hats' and become the Librarian - whipping up required components that are missing from their design arsenal. However, for a larger organization that employs a dedicated library department to grow and maintain the design components - accessible to all engineers and designers in that organization - it makes sense to submit requests for new (missing) components to that department. Providing an elegant solution to this, Altium Designer, in conjunction with your managed content server, offer the Part Requests feature.

An engineer can simply put in a request for one or more parts to be created, and get notified when that request has either been completed, and the component(s) made available, or rejected (and why). The requestor supplies as much key informat ion to support their request as possible (manufacturer and part number(s), description(s), any relevant datasheet (PDF or URL)). Stub Component Items can even be created that the librarian can then run with (and finish off).

Nominating Your Librarians

Start typing the name of an existing role into the Librarian's Role field to pop-up a list of matching roles. Select the required role from this list.

Choose a currently defined role to fulfill the Librarians role, as required.

Typically a single existing role would be specified for use as the Librarians role, but multiple roles can be chosen for assignment, especially if your company's librarians are gathered into more than one role. With the required role(s) assigned, be sure to click the  button at the top-right of the page.

The members of the nominated role will be the set of Librarians that can be assigned to, and work on, part requests.

Creating Part Requests

Part Requests can be created and browsed from the following two places:

Requesting from within Altium Designer

Part Requests can be created and maintained within Altium Designer, through the Explorer panel.

Adding a Request

Use the controls in the dialog to supply as much information as possible:

• Manufacturer - this is a mandatory field to indicate to the librarian who actually makes the part.
• Manufacturer Part Numbers - this is a mandatory field indicating to the librarian the specific part number(s) of the parts you need them to make. Multiple part numbers must be separated by a comma (,).

• Description - this field can be used to give a rich description of the part (typically taken from the manufacturer datasheet).
• Request ID - an ID is automatically generated with, and assigned to, the request, enabling users to easily track the request's progress.
• Required To Date - use this field to specify the date by which you need the component(s) to be ready. Either type the date directly (in the format dd/mm/yyyy) or click the  button to the right to access a pop-up calendar window, with which to specify the required date.
• State - this read-only field is used to specify the status of the request. The default state for a new request is New.

• Assignee - this field shows which librarian is currently working on the request. The drop-down field lists all Server users who are part of the nominated Librarian's role(s).

• Component Type - this field can be used to specify the type of component being requested. Your managed content server supports the following explicit component types: Capacitor, Resistor, Inductor, Transistor, Diode, LED, Crystal & Oscillator, Fuse, Transformer, Sensor, Connector, Switch, IC, Amplifier, Memory, Processor, Interface, Power Supply.
• Attachments - this area can be used to attach any useful files related to the requested part. For example a PDF datasheet, an image, or a document. Click the  button to locate the file(s) through a standard dialog.

• Part List - use this area to specify any existing Component Item(s) in the managed content server, which you have created as temporary stub components. Click the  button and browse for the required Item accordingly. The librarian can then run with this to fulfil the request. If no stub part exists, the librarian will simply create a new Component Item in the Server, along with requisite domain model Items.
• Parameters - this area can be used to add a set of specific parameters required for the part(s). Click the  button and use the subsequent fields to provide a name and value for the parameter. If no parameters are specified, the librarian will likely fall back to addition of the parameters in a related datasheet for that part, in accordance with organizational policy.

Once all information is defined as required - and essentially the Manufacturer and Manufacturer Part Numbers (which are mandatory) - click the OK button to effect creation of the request.

New part requests can also be added - using the  button and its associated commands - while viewing existing part requests through the Explorer panel's dedicated Part Requests folder.

Requesting from the Browser Interface of the Server

Adding a New Request

To add a new part request, click the  button at the top-right of the page. The page will change to present the new part request form, as shown in the following image, and detailed thereafter.

Use the controls on the page to supply as much information as possible:

• Manufacturer - this is a mandatory field to indicate to the librarian who actually makes the part.
• Manufacturer Part Numbers - this is a mandatory field indicating to the librarian the specific part number(s) of the parts you need them to make. Multiple part numbers must be separated by a comma (,).

• Request Id - an ID is automatically generated with, and assigned to, the request, enabling users to easily track the request's progress.
• State - this field is used to specify the status of the request. The options are Opened: New, Opened: In Progress, Closed: Completed, Closed: Rejected, or Closed: Cancelled.

• Required By Date - use this field to specify the date by which you need the component(s) to be ready. Clicking within the field will pop-up a calendar window, with which to specify the required date.
• Assign to - this field shows which librarian is currently working on the request. The drop-down field lists all Server users who are part of the nominated Librarian's role(s).

• Component Type - this field can be used to specify the type of component being requested. Your managed content server supports the following explicit component types: Capacitor, Resistor, Inductor, Transistor, Diode, LED, Crystal & Oscillator, Fuse, Transformer, Sensor, Connector, Switch, IC, Amplifier, Memory, Processor, Interface, Power Supply.
• Parameters - this area can be used to add a set of specific parameters required for the part(s). Click Add and use the subsequent fields to provide a name and value for the parameter. If no parameters are specified, the librarian will likely fall back to addition of the parameters in a related datasheet for that part, in accordance with organizational policy.
• Description - this field can be used to give a rich description of the part (typically taken from the manufacturer datasheet).
• Attachments - this area can be used to attach any useful files related to the requested part, for example a PDF datasheet, an image, or a document. Either click  to locate the file(s) through a standard dialog, or drag and drop the file(s) onto the indicated area.

• Parts List - use this area to specify any existing Component Item(s) in the managed content server, which you have created as temporary stub components. Click Add and browse for the required Item accordingly. The librarian can then run with this to fulfil the request. If no stub part exists, the librarian will simply create a new Component Item in the Server, along with requisite domain model Items.

Once all information is defined as required - and essentially the Manufacturer and Manufacturer Part Numbers (which are mandatory) - click the  button at the top-right of the form, to effect creation of the request.

With the request saved, the full details of the request will be presented.

Notice that in addition to the information supplied previously, the following is displayed:

• Request Id - the system-assigned title for the request, in the format PR-n (where n is the next integer identifier available).
• Comment - use this field to comment on the request. This allows for bi-directional communication between the requestor and the librarian. For example, the requestor may change something since original submission, and needs to flag the librarian working on the part. Or perhaps the librarian requires additional information, or confirmation on some aspect of the part. With the comment written, click the  button to submit it. Any comment will appear in the History region of the page, and also in the information stream when viewing the part request in the Explorer panel.
• History - a running stream of events related to this request.

Viewing Part Requests

At any time, a user can view the part requests that they were responsible for initiating (Requestor), or are responsible for working on (Librarian). This can be done from two places.

Explorer Panel (Altium Designer)

For both the originator of a part request (Requester) and the user(s) defined in roles associated to the Librarian role (Librarians), requests are presented through the Explorer panel using a dedicated Part Requests folder.

Example Part Requests in the Part Requests folder. A user will see the parts they have requested. A librarian will see the parts that they have been assigned to work on, as
well as those that have yet to be assigned.

Selecting a request in the upper region will display an information stream in the lower region. This information provides a running summary of any event occurring in relation to that request, including any comments made by the requestor or librarian. Each entry in the stream consists of the following elements:

• Created At - the date and time at which the event took place.
• Created By - the user responsible for the event (either the requestor, or a librarian).
• Description - an entry that consists of an auto-generated message, along with any comment included by the requestor/librarian.

Editing an Existing Part Request

To edit an existing part request, either double-click on its entry in the upper region, or select it and choose the Edit command from the region's right-click context menu.

Accessing the dialog with which to edit an existing part request.

Make changes as required, then click OK.

Controlling Data Display

Take a look at the following sections for more information on working with the data presented in the Part Requests folder.

Controlling the Display of Columns

Each column in the view corresponds to a specific field of the part request. Configuration of which columns are displayed - so which information is presented - is performed from the Select Columns dialog. Access this dialo g by right-clicking within the column headers area, and choosing the Select Columns command from the context menu that appears.

The Select Columns dialog is control central for defining which data is presented in the Part Requests folder.

By default, all data is shown. Toggle presentation of a data column by clicking the  control, to render it hidden (the control will become ).

Column Ordering & Sizing

The order of the columns is customizable. Click on a column's header and drag it horizontally to the required new position. Valid positions are highlighted by vertical positional arrows.

Alternatively, change the ordering in the Select Columns dialog. Drag and drop an entry to the required new position within the list, or select it and use the  and  buttons.

With the exception of the column containing the icon for the part request, the width of a column can be modified by clicking and dragging the right-hand separator (in that column's header).

Column-based Filtering

Like an Excel spreadsheet, the part requests can be further filtered by the contents of each column. To do this, click the small funnel (filter) icon, that appears at the right-hand side of a column header (). A menu will appear containing an entry for each value present in that column. Click on an entry to reduce the list to only include part requests with that value.

When a column filter is applied, the filter icon is displayed in blue (), indicating that there is filtering applied based on that column. Filtering can be applied to multiple data columns. Each 'column filter' becomes an ANDed condition in the overall filter. A textual representation of the filtering currently in effect will be presented at the bottom of the region.

An example of column filtering in action.

To clear filtering for a column, choose the (All) entry from the filtering drop-down. To clear filtering completely, click the  control, at the far right of the textual representation of the filter. To disable the filter, uncheck the check box to the left of its textual representation. To enable again, check the check box.

A history of just used filters is available. Click the drop-down button to the right of the textual representation of the current filter to display the history. This button will display when at least one previous filter has been applied.

To further customize the current filter, click the  button, to the far right of the textual representation of the filter, to open the Filter Editor dialog. Use this dialog to create more sophisticated and complex filters as needed.

Additional Operations

The right-click context menu for the upper region also contains the following useful commands when working with part requests:

• Operations » Create Component - this command allows you to quickly create a shell Component Item from the part request, giving the assigned Librarian a starting point with which to craft the required managed component. The temporary Component Editor will open in Altium Designer in its Single Component Editing mode - ready for direct editing of the component. Information from the part request is taken as applicable (e.g. parameteric data). Complete the component's definition, add domain models, and release.
• Close » Completed - can be used (typically) by the librarian to quickly mark the part request as being complete, without having to open the request for editing.
• Close » Rejected - can be used (typically) by the librarian to quickly reject the part request, without having to open the request for editing.
• Close » Cancelled - can be used by the librarian (or requestor) to quickly cancel the part request, without having to open the request for editing.

Each part request at this summary level is listed in terms of the following supplied information:

• ID.
• Date - the date the request was created.
• Description.
• Manufacturer.
• Manufacturer Part Numbers.
• Created by - the original author of the request (the Requestor).
• Assignee - the Librarian who is currently working on the part request.
• State - the state in which the request currently sits.

Use the top-left drop-down field to switch between viewing All States (default) to viewing all part requests in a particular state. Use the search field to quickly find a part request, based on Created By, Assignee or Description fields. Part requests can be sorted by any column possessing the  control - click on the control, or the column name.

You can access the detailed page for a part request by clicking on its ID.

Editing a Part Request

To edit a part request, access its detailed page, then click the  button at the top-right of the page. Notice also, that a Comment field is available. This is specifically for adding some explanatory text in relation to any modification to the request. This is separate to the Commenting feature available outside of editing the request.

Accessing the form with which to edit an existing part request.

Make changes as required, then click . To back out without making changes, click .

Notifications

Upon creation of a part request, the requestor, members of the Librarian role, and Server administrators, will receive notification in their message stream, on the Stream page of the managed content server's browser interface (and summarized on the Home page of that interface).

Customizing States

Once the request for a new part has been submitted, there are a number of states that that request can ultimately enter. By default, the following states are provided:

• Opened States - states in which the request is currently still 'alive':
  • New
  • In Progress
• Closed States - states in which the request has been considered resolved and therefore 'closed':
  • Completed
  • Rejected
  • Cancelled

To accommodate the requirements of different organizations, states are customizable. You can:

• Edit the names of the default states.
• Add additional states (named as required).
• Change the ordering of states (how states will appear on the relevant State drop-down menu when creating/editing a part request).

Make changes as follows:

• To edit the name of an existing state, click on its name. The Custom State Name pop-up window will appear in which to do so.
• To add a new state, click the add new control, associated with the type of state (opened or closed). Use the Custom State Name pop-up window to give the state the required naming.
• To change the order of the states, use the Move Up ()  and Move Down () controls, as applicable (and where available).
• To remove a state, click its associated Remove control ().

With the required states defined, be sure to click the  button at the top-right of the page.