Creating & Editing Content in a Workspace Connected to Altium Designer

The Items are created directly within a connected Workspace, and all of the data needed to manufacture/represent an Item is then stored in that Workspace against that Item number. Depending on the content type, an Item can be created manually or automatically as part of a save/upload/release process. All content types can be created within Altium Designer through the Explorer panel. When working with components, creation is also possible through the Components panel.

The content is organized in the Workspace in a tree-like structure of folders, much like the tree of folders used on a PC to organize files. To add a folder to a Workspace, right-click in the Server Folders region of the Explorer panel.

Items are created in a connected Workspace. From within Altium Designer, the Explorer panel provides the full interface to your Workspace.
Items are created in a connected Workspace. From within Altium Designer, the Explorer panel provides the full interface to your Workspace.

Creating an Item

Once you have defined the required folders, you can proceed to create the content in the Workspace. To create an Item, select the appropriate folder, then right-click in the Items grid region of the panel and choose one of the commands from the Create Item sub-menu. Alternatively, if the folder is empty, use the Add an item control in the center of the region to access the menu.

The context menu will be populated with the content type(s) associated with the active folder type. If the content type you want to create is not listed, choose the Other Item Type command. Remember, you can create any type of content in a folder – the folder type is purely visual. You can always move content between folders at a later stage.

Right-click within the Items grid region of the Explorer panel to access commands relating to content creation.
Right-click within the Items grid region of the Explorer panel to access commands relating to content creation.

The Create New Item dialog will appear, providing all controls necessary to fully define the Item.

Specify the details of the new Item in the Create New Item dialog.
Specify the details of the new Item in the Create New Item dialog.

For many content types, you have the option to edit and release the applicable design document into the initial revision of that content, after creation. To do so, enable the option Open for editing after creation, at the bottom of the Create New Item dialog (which is enabled by default). The Item will be created and the relevant temporary editor will open, ready for you to create the data for that Item. For more information on working with a particular content type, read its dedicated page, a link to which is provided in the table.

You can access a variation of the Create New Item dialog by right-clicking on an Item and then selecting Properties from the context menu. If the Item is in the Planned State, the Edit Item dialog from which you can change the properties of the item as required will open. If the Item is in its saved state, the View Item Properties dialog that contains the read-only view of item properties will open.
It is a good idea to add a Name and Description as part of an item's definition. This information is used when searching the Workspace and enables quick identification of what an item offers.

A Workspace supports item-less Workspace Component creation. This does not mean an item is not created, but rather an instance of the Component Editor is accessed directly, which allows the Component Template details to be applied prior to adding and saving the required component. The actual Component Item (and planned revision) is created as part of release preparation. Using the Create Item » Component command from the right-click menu will enter this mode directly.

To get the Create New Item dialog when creating a new Workspace Component, use the Create Item » Other Item Type command. In this case, the Planned revision of the Workspace Component will be created first. To see your newly created component, which has yet to be defined and saved to the Workspace, either disable the Show only latest option (available from the menu accessed by clicking the button at the top of the Explorer panel) or switch the view for the folder from Components View to Classic View (available from the same menu). Note, however, since the Item is created first, the information in the template (i.e. naming scheme, revision scheme and lifecycle definition) is not assigned since the Component Item is already created.

A Word About the Item ID...

An important aspect of the parent folder in which content is created is the Item Naming Scheme employed for it. This defines the format of the unique ID for each Item created in that particular folder. By defining the Item Naming Scheme at the folder level, content can be created quickly within that folder, while adhering to the correct ID naming scheme. This is especially the case when Items are being created automatically 'on-the-fly', rather than releasing to existing Items that have been manually created directly within the target Workspace.

Several default example schemes are available, utilizing the short-form code for either the folder type or the content type (refer back to the table earlier in this document for a list of codes). Using a default naming scheme, the software will automatically assign the next available unique ID, based on that scheme, having scanned the entire Workspace and identifiers of existing content.

A custom scheme can also be defined for a folder by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. DraftsmanDOC-TMP-{0000}, or DraftsmanSHEET-TMP-{0000}). The Item Naming Scheme employed for the parent folder can be changed at any time. The modified scheme will then be applied to any subsequent newly-created Items within that folder. In addition, the scheme defined for a parent folder will automatically be inherited for its descendent child folders.

Alternatively, should there be a need to have full, manual control over the naming of an Item, select the [NO ITEM NAMING SCHEME] entry. A unique Identifier must then be defined for an Item as part of its creation. Note that the system will not allow creation of an Item with a duplicated identifier, so manually assigning an identifier requires knowledge of which identifiers have been used.

The Item Naming Scheme of the parent folder is applied to the Unique ID for each Item created within that folder.
The Item Naming Scheme of the parent folder is applied to the Unique ID for each Item created within that folder.

Irrespective of the setting for the Item Naming Scheme at the folder level, you are free to override any automatically determined ID at the Item level. Modify any such ID as required, through the Create New Item dialog.

Choosing a Scheme for Item IDs

There is an infinite number of possible name/numbering schemes that can be used for Items, the ones shown in images within the documentation are just examples. There are numerous discussions you can read about what is the best numbering scheme to use. Generally, the experts agree that a short, non-significant, numeric-only numbering scheme is best. Non-significant means that there is no information encoded into the numbering scheme, such as the product category, sub-category, location, etc, each new Item is simply issued the next number in the sequence.

The length is important because the longer the identifier, the greater the chance of a human making an error when they record or recall the Item ID. Experience and academic study have shown that data entry errors increase as the number of characters increase. Seven digits is believed to be the magic number in terms of being easily and reliably recalled by a human. Beyond a certain length errors increase at an increasing rate – at 15 characters, the error probability is close to 100%.

If it is important in your organization to create identity in the Item ID, then a composite identifier could be the answer. In this case, a simple alpha/numeric commodity prefix code is recommended. For example, consider the ID D-820-0001. Here the D in the code could denote Design, meaning this is an Item used for designs. In the next 3 digits, the first digit could denote the product category, such as Peripheral Boards, the second and third digits in the block of three could be used to denote bare boards (1X) or assemblies (2X and up). The final four digits in the Item ID are a simple, non-significant, next-in-the-queue type number.

Setting the ID for the Initial Revision of a Workspace Item

Changing from a local design paradigm to a Workspace one requires migrating existing data to a Workspace. Such data may well have passed through multiple iterations, and have revision numbering assigned that is recognized across the organization. For example, rev.3 of a Magno-Synthetic Digitizer board may well have passed out the door already, with enhancements to be delivered in rev.4. On releasing to the Workspace, having an initial revision that started back at 1 would be confusing to say the least – not just within the organization but, more importantly, to its customer base (who are expecting a later version than their current rev.3!).

To this end, Altium Designer provides the ability to manually set the ID for the initial revision of a newly-created Item in a Workspace.

The ID of the Item's first planned revision can be changed at any point after the Item is created, and before data is released into that initial revision (i.e. it is still in the Planned state).

Setting the Initial Revision's ID

Create the required new Item in the Workspace as usual. After creation, right-click on the Item and choose Properties – giving access to the Edit Item dialog. Expand the Advanced region of the dialog and click the button, to the right of the Revision ID field. The Set Initial revision Id values dialog will appear, from where you can set the ID to meet your requirements. Fields will be provided, as applicable, to modify the various levels of the ID, in accordance with the chosen Revision Naming Scheme.

To access project-related Items (PCB Fabrication Data, PCB Assembly Data, PCB Project Design) in the Explorer panel, ensure that you are viewing a project in its Classic View. You may need to manually switch over from Project View – commands are available from the menu associated to the button, at the top-right of the panel.
To quickly obtain project-related Items (PCB Fabrication Data, PCB Assembly Data, PCB Project Design) for a newly created managed project, run the Project Releaser (right-click on the project in the Projects panel and choose the Project Releaser command from the context menu). The related Items will be created as part of the preparation stage. Be sure not to release the project though, so that you can set the initial revision's ID.

Set the various levels of the ID (as applicable to the Revision Naming Scheme employed).
Set the various levels of the ID (as applicable to the Revision Naming Scheme employed).

The initial revision can also be defined as part of releasing a design through use of the Project Releaser. A Custom entry is available on the context menu associated with the link next to a Target Revision entry (in the initial Configure Server Release stage of the release process). Use this command to access the Custom Revision ID dialog, from where you can manually specify the revision of the target item into which the generated data will be released. Learn more about Controlling the Target Revision when Releasing Your Design into a Workspace.

Creating & Editing Content Directly through a Workspace

Your connected Workspace provides a flexible and secure method of centralizing the storage and management of all types of design data used in Altium Designer. From the schematic model to the component, from managed schematic sheets through to completed PCB designs, the Workspace delivers an ideal method of storing and managing your electronic design data.

A powerful aspect of a Workspace is its support for Direct Editing. Just what does that mean, 'Direct Editing'? It means you can right-click on a model, or a component, or even a managed sheet in the Workspace and select Edit. Sure, a file opens in Altium Designer ready for you to edit – opened in a temporary editor – but when you are finished, you simply save it back to the Workspace. As for the file you just edited, well you don't have to worry about it, it is no longer needed since your edits are securely stored back in the Workspace, so it is destroyed, and the temporary editor instance is closed.

Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported Item type using a temporary editor loaded with the latest source direct from the Workspace itself. And once editing is complete, the entity is released (or re-released) into a subsequent planned revision of its parent Item, and the temporary editor closed. There are no files on your hard drive, no questioning whether you are working with the correct or latest source, and no having to maintain separate version control software. The Workspace handles it all with great integrity and in a manner that greatly expedites changes to your data.

While you can still create source files under your control, the freedom offered through direct editing takes this variable out of the equation, so-to-speak. The Workspace becomes both source and target for design data, allowing you to access and edit the secure (and latest!) source without the headache of managing two sets of data.

Content Types Supported for Direct Editing

The following Workspace content types are supported with respect to Direct Editing:

Editing the Initial Revision of an Item

From the Explorer panel, when you create an Item of one of the supported content types, you have the option to edit and release the associated data entity into the initial revision of that item, after creation. So instead of creating the source data outside of the Workspace and releasing it, you can start working on the source directly from the moment the empty Item is created, courtesy of direct editing. And when that editing is complete, the entity is released into the initial planned revision of its parent Item, and the temporary editor closed.

To take advantage of this feature, enable the Open for editing after creation option, found at the bottom of the Create Item dialog. Pre-empting the usefulness of this functionality, the option is enabled by default. The Item will be created and the relevant temporary editor will open, presenting the relevant document as the active document in the main design window. This document will be named according to the Item-Revision, in the format: <Item>-<Revision>.<DocumentExtension>.

The exception to this is the Component Item which, when a new item of this type is created, the Single Component Editor will open, with the name of the component used as reference. If a name has not been specified, the default New component naming will be used until it is defined.

The image below shows this in action for the creation of a new Symbol Item (SYM-001-0031). A temporary Schematic Symbol editor is opened, presenting a document to define the symbol as required.

Example of editing the initial revision of a Symbol Item, directly from the Workspace – the temporary Schematic Symbol editor provides the document with which to define your schematic symbol.
Example of editing the initial revision of a Symbol Item, directly from the Workspace – the temporary Schematic Symbol editor provides the document with which to define your schematic symbol.

Direct Editing Controls

There are three relevant controls when direct editing, readily available from the Quick Access Bar (at the top-left of the main application window), or from the Standard toolbar for the active temporary editor (where available):

  • Save Active Document. Use this button to save any changes made to the document. This allows you to save current changes if you want to return later to make further changes before ultimately releasing to the Workspace.
  • /Save to Server. Use this button to release (effectively save and release) the document to the Workspace, storing it within the initial (planned) or next revision of the target Item. The Create Revision dialog (or Edit Revision dialog) will appear, in which you can change the Name and Description, and add release notes as required. The document and editor will close after the release.

Where applicable and if desired, revisions of parent items related to (referencing) the current revision of the item being saved can be updated also. This is controlled by the Update items related to <ItemRevision> option, which is enabled by default. Note that this option only appears when:

  • creating a new revision of a domain model (symbols, footprints, simulation models) referenced by revisions of component items.
  • creating a new revision of a component template referenced by revisions of component items.
  • creating a new revision of a 3D model referenced by revisions of footprint model items.

If you want to keep all related parent Items using the current revision of the Item, disable this option. Only the item itself will then be saved.

To save a document being edited to the Workspace, you also can use the Save to Server control next to the document entry in the Projects panel.
  • /Discard Local Changes. Use this button if you wish to cancel editing. The temporary file (used purely to facilitate the editing) will be deleted, with its entry removed from the Projects panel, and nothing will be released to the target Item.

    With the applicable temporary file used for a direct editing session, you do not have to complete the updating process in a single editing session - you can save your work and close the file if you wish. Altium Designer understands that this is a special file, so it retains it in the <SourceWorkspaceName> folder in the Projects panel, so that you can re-open it when you are ready, and complete the updating and re-releasing process.

These controls can also be accessed as commands from the right-click menu of the document entry in the Projects panel. For many editors, these controls are also available as commands – Save (shortcut: Ctrl+S), Save to Server (shortcut: Ctrl+Alt+S), and Discard Local Changes – from the main File menu.

For a revision of a Project Template Item, commands to Save, Save to Server, and Discard Local Changes, can only be accessed from the Projects panel. Right-click over the entry for the Item Revision to access the relevant context menu.

Editing an Existing Revision of an Item

At any stage, you can come back to any revision of an Item of a supported content type in the Workspace (through the Explorer panel) and edit it directly. Right-click on the revision and choose the Edit command from the context menu. Once again, the temporary editor will open, with the document contained in the revision opened for editing. Make changes as required, then commit the release of the document into the next revision of the item.

Right-clicking on the top-level entry for an Item itself will edit the latest revision of that Item.

Example of accessing the command to launch direct editing of an existing Draftsman Document Template.
Example of accessing the command to launch direct editing of an existing Draftsman Document Template.

The Behavior of the Temporary Files

To be able to edit Workspace data, something must be created for you to edit in Altium Designer. What happens is that temporary files are created. For example, when you right-click on a Symbol Item and select Edit, a temporary SchLib file is created and opened in Altium Designer. When you finish and perform a Save to Server, this file is destroyed as soon as the Workspace data is updated.

However, if you do not release it and instead Save and Close the file, it will remain in the Projects panel. This is done so that you do not have to complete the updating process in a single editing session – you can save your work and close the file if you wish, Altium Designer understands that this is a special file so it retains it under the <WorkspaceName> entry in the Projects panel (e.g., /) so that you can re-open it when you are ready and complete the updating and re-releasing process.

The temporary documents remain accessible so that you do not have to complete your changes in a single editing session.
The temporary documents remain accessible so that you do not have to complete your changes in a single editing session.

If you change your mind at some point and no longer want to perform the edits, simply right-click on an entry and choose the Discard Local Changes command from the context menu, to close the temporary file.

Direct Editing of Components from the Components Panel

In the day-in, day-out management of your components, direct editing is available from the Components panel – which you will tend to use more than the Explorer panel with respect to that particular content type. Browse for the required component, select it, then right-click and choose the Edit command from the context menu. A temporary instance of the Component Editor – in its Single Component Editing mode – will be opened, ready for you to make changes as needed.

If you edit multiple selected components, a single instance of the Component Editor will be opened – in its Batch Component Editing mode – containing all components in the selection.

An example of direct editing from the Components panel.
An example of direct editing from the Components panel.

Direct Editing of Models from the Component Editor

When editing a component using the Component Editor in its Single Component Editing mode, you are able to edit the linked domain models using the direct editing paradigm. To modify a model that is currently being used (referenced) by the component, click the  control at the top-right of its preview. The corresponding temporary editor for that model type will open, ready for you to make changes to the model as required. Once ready, just save and close the editor – the modified model will appear linked back in the Models region. Upon release of the component, the modified model will automatically be released to the Workspace also, into the next revision of its parent Item.

If the model is referenced by multiple components, a dialog will appear alerting you to this and offering you various choices. You can create a copy of the model (clone it) so that the change affects only the current component, or you can continue with editing this shared model, and update the other components that reference it later. Alternatively, you can simply cancel the editing process.

An example of direct editing an existing model that is being referenced by a component that is itself being directly edited, using the Component Editor in its Single Component Editing mode.
An example of direct editing an existing model that is being referenced by a component that is itself being directly edited, using the Component Editor in its Single Component Editing mode.

The direct editing paradigm can also be employed for linked domain models when editing a component using the Component Editor in its Batch Component Editing mode. Right-click on the model entry in the Model Links region of the editor and choose the Edit command from the context menu.

Uploading Data into a New Revision of an Item

Most content types support the creation of a new revision by uploading the applicable data file.

The following content types do not support this method of creating a new revision: Component, Reuse Block, Schematic Snippet, PCB Snippet.

Uploading data into a new revision of an Item can be performed in a couple of ways.

Upload Menu

A file can be uploaded by right-clicking on the required Item in the Explorer panel and choosing the Upload command from the context menu. The Create New Revision dialog will appear, in which you can change Name, Description, and add release notes as required. Use the Sources region of the dialog to load the required file. This can be performed by dragging and dropping the file from Windows Explorer, onto the region. Alternatively, click the button – the Add Files dialog (a standard Windows open-type dialog) will appear. Use this to browse to, and open, the required file.

If the Item has no planned revision, upload will be to the next planned revision, created on-the-fly as part of the upload process.

Example upload. In this case, manually specifying a 3D model file to be uploaded to a target 3D Model Item.
Example upload. In this case, manually specifying a 3D model file to be uploaded to a target 3D Model Item.

Once the desired file is dropped in, or selected and the Open button clicked, an entry for it will appear back in the Sources region.

For a content type that supports upload of multiple files into a revision of it, such as the Binary File, the chosen file(s) will be added, and listed, in the Sources region of the dialog. If you need to adjust the content of the list, add additional files or select and remove files (click the  button) as required. The Sources area supports selection of multiple files using standard multi-select techniques (Ctrl+Click, Shift+Click, and click-and-drag).

Proceed with the upload by clicking the OK button. As applicable to the content type, information regarding the uploaded file(s) will be presented on the Details and/or Preview aspect view tabs for the Item Revision, in the Explorer panel.

Browse the saved revision of the Item (shown here for a 3D Model Item), back in the Explorer panel. Switch to the Preview aspect view tab to see its graphical depiction (where applicable).
Browse the saved revision of the Item (shown here for a 3D Model Item), back in the Explorer panel. Switch to the Preview aspect view tab to see its graphical depiction (where applicable).

Drag and Drop from Windows Explorer

The relevant data file(s) can also be uploaded by dragging the selected file(s) from a source folder in your Windows Explorer and dropping onto the required target Item in the Explorer panel. The Create New Revision dialog will appear, with the dragged file listed in the Sources region. Add any Release Notes as required, then click the OK button.

For some content types, you will need to modify the Name (which will be the file name, including extension (for multiple files, entries will be separated by a semi-colon)) and Description (which will be in the format Uploaded from <FileNameandPath>, Size <FileSize>, Created on <FileCreationDate> (for multiple files, entries will be separated by a semi-colon)). For those content types that support multiple files, if you need to add additional files this can be done by clicking the button, and browsing for the file(s), or by dragging and dropping file(s) onto the Sources area. If you need to remove files, select them in the list and click the  button.

Uploading using the drag and drop method, shown here for a 3D Model.
Uploading using the drag and drop method, shown here for a 3D Model.

If the existing Item has no planned revision, upload will be to the next planned revision, created on-the-fly as part of the upload process. If you drop the dragged data file away from an existing Item, a new Item will be created. The Create New Item dialog will appear. The Name and Description fields will be prefilled. Depending on the content type, this can be:
  • The Name of the item will be the file name. The Description will be the file name (with extension).
  • The Name of the Item will be the file name, including extension (for multiple files, entries will be separated by a semi-colon). The Description will be in the format Uploaded from <FileNameandPath>, Size <FileSize>, Created on <FileCreationDate> (for multiple files, entries will be separated by a semi-colon).

Change these as required.

The Item ID will be in accordance with the Item Naming scheme defined at the folder level. If the folder has no naming scheme defined, naming will follow the $CONTENT_TYPE_CODE-{000000} scheme.

For content types that support only a single data file to be stored, the Release Manager dialog will automatically launch if you attempt to drag and drop more than one data file. Use this to complete upload of multiple files.

Cloning the Workspace Content

The Explorer panel provides the ability to clone a variety of Workspace Items. So rather than creating that required component, domain model, schematic sheet, or template from scratch, you can simply clone it. Direct Editing ensures any required changes – to a copy of the source data from the original Item Revision – is a streamlined affair, with the resulting changes released into an initial revision of a new Item of the same type. Done and dusted in record time, you can quickly expand your Workspace content without facing a blank canvas.

The following content types can be cloned:

  • Component
  • Footprint
  • Symbol
  • Simulation Model
  • Component Template
  • Managed Schematic Sheet
  • Schematic Template
  • Project Template
  • Draftsman Document Template
  • Draftsman Sheet Template
  • Layerstack
  • OutputJob

The command to clone one of the supported content types is accessed from the Explorer panel in the following ways:

  • By right-clicking over the entry for the source Item-Revision, and choosing the Operations » Clone command from the context menu.
  • By selecting the entry for the source Item-Revision and using the Ctrl+D keyboard shortcut.

The Clone command is available throughout the Explorer panel, wherever the applicable Item-Revision is presented, including:

  • The main Item listing within a folder.
  • Children aspect view tab (when viewing a Managed Schematic Sheet Item).
  • Where-used aspect view tab (when viewing a Component Item, Symbol Item, Footprint Item, Simulation Model Item, Component Template Item, or Schematic Template Item).
  • Preview aspect view tab (when viewing a Component Item, Managed Schematic Sheet Item, or Schematic Template Item).
When browsing the main listing of Items in a particular folder, access the Clone command from the top-level entry for an Item, to clone the latest revision of that Item.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Примечание

Набор доступных функций зависит от вашего уровня доступа к продуктам Altium. Ознакомьтесь с функциями, включенными в различные уровни Подписки на ПО Altium, и функциональными возможностями приложений, предоставляемых платформой Altium 365.

Если вы не видите в своем ПО функцию, описанную здесь, свяжитесь с отделом продаж Altium, чтобы узнать больше.

Content