Extracting Data from a Workspace

Parent page: Designing with a Connected Workspace

Your Workspace is sure to become a welcome part of your design arsenal – your single source for component data, real-time sourcing information, component traceability within designs, and collaboration with your mechanical design team. However there may be a time, for whatever reason, that you can no longer continue your design journey with the Workspace.

Data can be extracted from your connected Workspace in the following ways:

• Batch download of components and models. For components, they are essentially exported to IntLib format. Components can also be acquired into an IntLib through the use of the Content Cart.
• Checking out designs (if under the own version control of the connected Workspace and you don't have a local working copy already).
• Stopping synchronization for designs that have been made available in (registered with) your Altium 365 Workspace.
• Downloading release packages.

The following sections take a look at how these various actions are performed.

Batch Download of Items

The Explorer panel in Altium Designer supports the ability to select multiple Items in your connected Workspace and have the source entities for those Items downloaded, en masse, into a newly created single source library or folder, as applicable. The following Item types are supported by this feature:

• Components – with the selected components downloaded into a Zip archive file containing source symbol and model libraries, and a source Integrated Library Package (*.LibPkg).
• Symbols – with the selected symbols downloaded into a Schematic Library (*.SchLib).
• Footprints – with the selected 2D/3D component models downloaded into a PCB Library (*.PcbLib).
• Simulation Models – with the released data applicable to each Item in the selection (*.SimModel, *.mdl, *.ckt) downloaded to a separate sub-folder.

Component Extraction using the Content Cart

You also have the ability to acquire components from your connected Workspace into an Integrated Library (*.IntLib). The vehicle through which this is done – your interface to the Workspace's Data Acquisition Service – is the Content Cart. Access to the Content Cart dialog is made from within the Explorer panel in Altium Designer. While browsing your Workspace from which you wish to obtain data, right-click on an Item Revision that you wish to acquire and choose the Operations » Add to Content Cart command from the context menu.

From the Content Cart dialog, the process to acquire into an IntLib is as follows:

1. Click on the Select target server link and choose IntLib file from the menu.

   
   Set the target of the Content Cart to be an IntLib file.

2. Specify the name, and location, for the generated IntLib file. By default, the file will be named in the format Integrated_Library - <Date> - <Time>.IntLib, and generated in the location \Users\Public\Documents\Altium\AD<Version>\Library\ExportCmpLib. Modify this as required through the Save As dialog – accessed by clicking the Change link.

   
   Accept the default target folder and filename, or change as required.

   Specify the name, and location, for the generated IntLib file. By default, the file will be named in the format Integrated_Library - <Date> - <Time>.IntLib, and generated in the location \Users\Public\Documents\Altium\NEXUS<Version>\Library\ExportCmpLib. Modify this as required through the Save As dialog – accessed by clicking the Change link.

   
   Accept the default target folder and filename, or change as required.

3. If you need to acquire additional components into the same IntLib, click the Add More Items link, and choose the Select entry to access the Choose Item dialog. From here you can browse the source Workspace for more components. Alternatively, choose the Add manually entry to access the Add new items dialog. This dialog allows you to paste an external list of components that you require (one item per line), and which can then be searched for within the source Workspace, using a chosen search criteria (GUID, Item ID, Name, or MPN).

4. Once ready, click the button to proceed with generation of the IntLib. A temporary Integrated Library Package (*.LibPkg) will be created, with source SchLib (with symbols, parameters, and model links) and PcbLib (with footprint models) files generated and added. This is then compiled to produce the IntLib file, which is generated in the specified folder. An information dialog will confirm successful generation of the file.

   
   Deliver the cart to the target folder, which will contain the required Integrated Library file.

After generation, the IntLib can be added as part of the available file-based libraries for the software (through the Installed tab of the Available File-based Libraries dialog). It will then be available for use from the Components panel. Place components from the IntLib into your design as required.

Checking Out Designs under a Workspace's Native Version Control

You have the option to open the project to the default checkout path or use the  drop-down menu to specify a custom path. The default checkout path is defined as a property of the design repository in which the project resides. For a Git repository (e.g. the Versioned Storage repository that is native to the connected Workspace), this is the Local Path field found in the Git Repository properties dialog. Access the properties dialog by selecting the entry for the repository – on the Data Management – Design Repositories page of the Preferences dialog – and clicking the  button.

Once opened, the project will appear under an entry for your Workspace, within the Projects panel in Altium Designer.

Stopping Synchronization for Registered Designs (only for Altium 365 Workspace)

If you have 'registered' an existing project (local project, or a project currently under external version control) with your Workspace through use of the Make Project Available Online feature, without bringing it under the Workspace's native version control, then you already have the project. The version in the Workspace is a 'mirror' of it – a synchronized copy that allows you to enjoy the collaborative features available through the Altium 365 platform. If made available and are under full management of the Workspace's version control, then you can simply open the project (if not already) to get a local copy of it.

Should you wish to stop the synchronization between your local project and the incarnation of it that was made available in the Workspace – therefore removing all linkage to the Workspace – click the button, provided on the General tab of the Project Options dialog. The Turn off project synchronization window will appear. Click on the Unlink option, then click OK back in the Project Options dialog. The local project will no longer be associated with the project in the Workspace

This is reflected in the Projects panel after saving the local project, by the project being presented under the active Project Group (*.DsnWrk), rather than as an entry under the active Workspace. A save is required since the links to the project in the Workspace are removed from the project file.

You can sever the connection between your local project and the incarnation of it made available in the Workspace.

Downloading Release Packages

Extraction of any and all releases of design projects – released into your connected Workspace using the Project Releaser in Altium Designer – is simply a case of downloading those release packages from within the Workspace's browser interface.

The detailed management page for the project is opened by selecting the required project, clicking the  control above the listing of projects, and choosing the Open entry on the associated menu. Alternatively, double-click directly on the required project entry in the list (or click on its name). The page will open in a new browser tab.

Any and all of the data sets included in a release can be downloaded. Click the button associated with the release to access a window in which to define which of that release's data sets to download. After clicking the button a single Zip archive containing a folder for each included data set will be downloaded to your Browser's default downloads folder.

Click the Show Files control to browse the files involved with each data set that is part of the release. Download is supported at all levels of granularity – from the whole data set, to a particular folder/type of output, down to the individual file level. Hover over an entry and click the button to start the download. For a data set or specific folder of output, a Zip archive will be downloaded. For an individual file, that file (not zipped) will be downloaded.

Data can also be downloaded when viewing a release package. To open a release package for viewing click on its associated button to open the full release package. Alternatively, click the button and choose what to view – either the full release package (All Release) or a specific assembly (variant). An opened project release is presented in a new Manufacturing Portal browser tab.