Parent page: Vault Items
Altium Designer, in conjunction with Altium Vault, caters for the ability to create and manage Outputjob Items in an Altium Vault. Such Items are created directly from within the target vault. Once an Outputjob Item has been created (and data released into a revision of it), and its lifecycle state set to a level that the organization views as ready for use at the design level, it can be reused in future board-level design projects.
Folder Type
When creating the folder in which to store Outputjob Items, you can specify the folder's type. This has no bearing on the content of the folder - releasing an Output Job Configuration file will always result in a corresponding Outputjob Item. It simply provides a visual 'clue' as to what is stored in a folder and can be beneficial when browsing a vault for particular content. To nominate a folder's use as a container for Outputjob Items, set its Folder Type as Output Jobs, when defining the folder properties in the Edit Folder dialog.
Specifying the folder type - its intended use - gives a visual indication of the content of that folder when browsing the vault!
Item Naming Scheme
Another important aspect of the parent folder is the Item Naming Scheme employed for it. This defines the format of the unique ID for each Item created in that particular folder. Several default example schemes are available, utilizing the short-form code for either the folder type (OUTC - OutputJob Collection) or the content type (OUT - OutputJob):
- $CONTENT_TYPE_CODE-001-{0000} - for example, OUT-001-0001.
- $CONTENT_TYPE_CODE-001-{A00} - for example, OUT-001-A01.
- $FOLDER_TYPE_CODE-001-{0000} - for example, OUTC-001-0001.
- $FOLDER_TYPE_CODE-001-{A000} - for example, OUTC-001-A001.
Using a default naming scheme, the software will automatically assign the next available unique ID, based on that scheme, having scanned the entire vault and identifiers of existing Items. This can be a great time-saver when manually creating Outputjob Items prior to release.
A custom scheme can also be defined for a folder, simply by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. OUTJOB-001-{0000}).
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 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.
Item Type
When creating a target Outputjob Item in which to store your Output Job Configuration, ensure that its Content Type is set to Outputjob, in the Item Properties dialog. If you are creating the Item in a Output Jobs type folder, this Item type will be available from the right-click context menu when creating the Item.
Creating an Outputjob Item within an Output Jobs folder - the correct Content Type is available on the context menu.
Item Lifecycle Definition and Revision Naming
When defining an Outputjob Item, be sure to specify the type of lifecycle management to be used for the Item, and the naming scheme employed for its revisions, respectively.
Control over which Item types can use a particular lifecycle definition or revision naming scheme, can be defined and enabled at a global level from within the Content Types dialog, when defining each schema. For a newly-installed vault, the default schemes assigned for use by an Outputjob Item are: Simple Lifecycle and 1-Level Revision Scheme, respectively.
Once a template definition has been released into the initial revision of an Outputjob Item, these schemes cannot be changed for that particular Item.
Specify the required schemes in the Item Properties dialog, using the Lifecycle Definition and Revision Naming Scheme fields respectively.
If the option to control use of lifecycle definitions and revision naming schemes per content type is enabled for any definitions/schemes, and the Outputjob Item type is not set to use a particular definition/scheme, then that definition/scheme will not be available in the applicable drop-down list.
Selecting the Lifecycle Definition and Revision Naming schemes for a manually created Item.
Observing standard revision naming schemes and lifecycle definitions, across the various types of design item in a vault ensures smooth, consistent management of those items.
It is a good idea to add a comment and description as part of the Item's definition. This information is used when searching the vault and enables quick identification of what an Outputjob Item offers.
Releasing an Output Job Configuration
So far, we've discussed the support for an Outputjob Item in the vault, in terms of related folder and item types. Releasing an actual defined Output Job Configuration into a revision of such an item can be performed in a single streamlined way.
An Output Job Configuration can be edited and released into the initial revision of a newly-created Outputjob Item, courtesy of the vault's support for direct editing. 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 vault 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 Altium Vault handles it all, with the same great integrity you've come to expect, and in a manner that greatly expedites changes to your data.
When you create an Outputjob Item, you have the option to edit and release an Output Job Configuration into the initial revision of that item, after creation. To do so, simply enable the option Open for editing after creation, at the bottom of the Create Item dialog (which is enabled by default). The Item will be created and the temporary OutputJob Editor will open, presenting a .OutJob 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>.OutJob (e.g. OUT-001-0001-1.OutJob).
Example of editing the initial revision of an Outputjob Item, directly from the vault - the temporary OutputJob Editor provides the document with which to define your configuration.
Use the document to define the Output Job Configuration as required.
Maximizing Reusability - Making Your Output Job Configuration Generic
A number of innovative features are available when configuring your outputs to make the resulting Output Job Configuration as generic as possible. By keeping an OutJob generic, you can effectively maximize its ability to be reused across future design projects.
Generic Data Source Names
Many output generators use a specifically-named underlying document as their source, from which the applicable output data is generated - for example Gerber files generated from the PCB document FluxTriangulator.PcbDoc. However, doing so locks the Output Job Configuration to being useful only with that document's parent design project. To keep things non-specific, a generic entry for the underlying Data Source is available for selection across many of the output generators. The following table summarizes which output generators are supported, and the generic entry (entries) available.
| Category |
Output Type |
Generic Data Source Entry |
| Netlist Outputs |
All |
[Project] |
| Simulator Outputs |
Mixed Sim |
[Project] |
| Documentation Outputs |
Composite, PCB 3D Print, PCB 3D Video, PCB Prints, PDF3D |
[PCB Document] |
| |
Schematic Prints |
[Project Physical Documents] |
| Assembly Outputs |
All |
[PCB Document] |
| Fabrication Outputs |
All |
[PCB Document] |
| Report Outputs |
Bill of Materials |
[Project]
[ActiveBOM Document] |
| |
Component Cross Reference, Report Project Hierarchy, Simple BOM, Report Single Pin Nets |
[Project] |
| Validation Outputs |
Component states, Configuration compliance, Electrical Rules Check |
[Project] |
| |
Design Rules Check, Differences Report, Footprint Comparison Report |
[PCB Document] |
| Export Outputs |
Ansoft Neutral (AutoPCB), AutoCAD dwg/dxf File PCB, Export IDF, Export PARASOLID, Export STEP, Export VRML, Hyperlynx (AutoPCB), P-CAD ASCII (AutoPCB), Protel PCB 2.8 ASCII (AutoPCB), Save As/Export PCB, SiSoft (AutoPCB), Specctra Design PCB |
[PCB Document] |
| |
AutoCAD dwg/dxf File Schematic, OrCAD SDT Schematic (AutoSCH), OrCAD v7 Capture Design (AutoSCH), P-CAD V16 Schematic Design (AutoSCH), Save As/Export Schematic |
[Project] |
| PostProcess Outputs |
Copy Files |
[Project] |
Layer Classes
You have the ability to add named layer classes to configurations for the following output generators:
- PCB Prints
- Gerber Files
- ODB++ Files
This makes these output generators generically reusable. For example, add a class 'signal layers' and refer to it in the OutJob - any design that has a 'signal layers' class will be able to use that output generator without modification.
The Job Manager Toolbar toolbar provides three relevant controls when direct editing:
-
- Save Active Document. Use this button to save the changes made to the document. This is required before you can release the document back to the vault.
-
- Release Document. Use this button to release the defined configuration to the vault, storing it within the initial (planned) revision of the target Outputjob Item. The Create Revision dialog will appear, in which you can change Comment, Description, and add release notes as required. The document and editor will close after the release. The document containing the configuration, *.OutJob, will be stored in the revision of the Item.
-
- Cancel Editing. Use this button if you wish to cancel editing. The document and editor will close, and nothing will be released to the target Outputjob Item.
The released data stored in the vault consists of the Output Job Configuration, defined in the Output Job Configuration file (<Item><Revision>.OutJob). In the Vaults panel, switch to the Preview aspect view to see the outputs defined within the configuration.
Browse the released revision of the Outputjob Item, back in the Vaults panel. Switch to the Preview aspect view to see the outputs contained within the configuration.
Reusing a Managed Outputjob Item
Related page: Controlling Access to Vault Content
Once an Output Job Configuration has been released to an Altium Vault, and its lifecycle state set to a level that the organization views as ready for use at the design level, that configuration can be reused in future board-level design projects.
When you are signed in to your Altium Vault, you are free to manually reuse the revisions of any Outputjob Items that have been shared with you.
If you do not sign in to your Altium Vault you can still work with Altium Designer (under your valid Altium Designer License), but you will not be able to access your organization's Altium Vault, or any other services provided through its installation. You will therefore not be able to reuse any vault-based Outputjob Items. You will only be able to use file-based configurations defined locally.
Choose a revision of an Outputjob Item to use, from the Managed OutputJobs tab of the Project Options dialog. Simply click the Add button and use the subsequent Choose Managed OutputJob Revision dialog to browse to, and select, the required revision in the connected Altium Vault. The region will populate with details for the chosen Item Revision, including its lifecycle state.
Manually choosing a revision of an Outputjob Item from within the Managed OutputJobs tab of the Project Options dialog.
Continue adding further revisions of different OutputJob Items as required. After clicking OK to exit the Project Options dialog, save the project and recompile - the chosen OutputJob Item Revision(s) will appear in the Projects panel.
A managed OutputJob is distinguished by the
icon.
The added revisions of OutputJob Items will be reflected in the Projects panel after the project is saved and recompiled.
You are free to create and use unmanaged (local, file-based) Output Job files, in addition to using those from a vault, should this be required.
Reuse as Part of an Environment Configuration
A released Output Job Configuration can also be used as a configuration data item in one or more defined Environment Configurations. An environment configuration is used to constrain a designer's Altium Designer working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center - a service provided through the Altium Vault installation.
Once you have signed in to the Altium Vault, and chosen (if applicable) from the selection of environment configurations available to you, Altium Designer will be configured, with respect to use of Output Job Configurations. If the chosen environment configuration has one or more defined Outputjob Items, then only those defined configurations can be used. If the chosen environment configuration applicable to you does not have any Outputjob Items specified/added, then these will remain manually definable. In other words, you are free to use local Output Job Configuration files, or manually reuse a vault-based Output Job Configuration. For more information, see Environment Configuration Management.
Altium Designer will be configured, with respect to use of Output Jobs, in the following areas.
Project Options dialog
Revisions of Outputjob Items are specified for use from the Managed OutputJobs tab of the Project Options dialog, in much the same way when reusing them manually. The difference with their use under management of an environment configuration is that you can only add those revisions of Outputjob Items defined for that environment configuration.
Simply click the Add button - the Select configuration item (Output Jobs) dialog will appear. Use this dialog to choose which OutJob to use for the project, from the list of OutJobs defined as part of the environment configuration currently in-force. Add additional OutJobs - available to you - as required.
Choose from the environment configuration's defined Outputjob Item Revisions, when adding OutJobs to a project.
With all OutJobs added as required, OK out of the Project Options dialog, save the project, and recompile - the chosen managed OutJob(s) will appear in the Projects panel.
Creating a New OutJob File
Under configuration management, and when at least one OutJob is defined for the active environment configuration, this will no longer be possible. Commands for creating a new OutJob - either using the File » New » Output Job File command, or right-clicking on a project's entry in the Projects panel and choosing Add New to Project » Output Job File, will be hidden.
Trying to use an Existing OutJob File
Under configuration management, and when at least one OutJob is defined for the active environment configuration, this will no longer be possible. If you attempt to add an existing Output Job File to the project, by right-clicking on a project's entry in the Projects panel, choosing Add Existing to Project, and browsing for that file, a warning dialog will appear - alerting you to the fact that OutJobs are being managed by that environment configuration.
OutputJob Editor
The OutputJob Editor - accessed when opening a managed OutJob - will reflect that the file is a Managed OutputJob Document, with an indication of the Item Revision, its description, and the parent Altium Vault in which that Item resides.
The appearance and use of the OutputJob Editor as described, is for when using a revision of a managed (vault-based) Outputjob Item. It is the same, irrespective of whether manually reusing the Item Revision, or using it through an enforced environment configuration.
The Output Job Editor when viewing a managed Output Job.
Since the OutJob is managed, any controls that would otherwise effect its modification in some way, are disabled. So the following abilities ARE NOT available:
- Addition of new Output Generators.
- Configuration of existing Output Generators.
- Cut, copy, paste, duplication or deletion of an existing Output Generator.
- Addition of new Output Containers or Hard Copy Jobs.
- Configuration of an existing Output Container or Hard Copy Job.
- Cut, copy, paste or deletion of existing Output Containers or Hard Copy Jobs.
- Toggle the inclusion state of an Output Generator with respect to a valid Output Container or Hard Copy Job.
You can, however, still determine variant usage for the OutJob.
Re-Releasing an Outputjob Item
At any stage, you can come back to any revision of an Outputjob Item in the vault, and edit it directly. Simply right-click on the revision and choose the Edit command from the context menu. Once again, the temporary editor will open, with the configuration 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.
Accessing the command to launch direct editing of an existing revision of an Outputjob Item.
Downloading Released Data
Download the data stored in a revision of an Outputjob Item by right-clicking on that revision and choosing the Operations » Download command from the context menu. The Output Job Configuration file will be downloaded into a sub-folder under the chosen directory, named using the Item Revision name. The file can be found in the Released folder therein.
Access the Download command from the top-level entry for an Outputjob Item itself, to download the Output Job Configuration file file stored in the latest revision of that Item.
Click the Explore button in the Download from Vault dialog, to quickly explore to the download folder.
Batch Releasing File-based Output Job Configurations
If you have a set of file-based Output Job Configurations (*.OutJob) that you need to release to a target Altium Vault quickly, and simultaneously, then you can use Altium Designer's Release Manager. Use it to batch-release configurations stored across multiple source documents, in a nominated source folder location.
The Release Manager is considered to be a legacy tool.
Accessed the Release Manager dialog by running the File » Release Manager command.
Release Output Job Configurations, stored in one or more source documents, using the Release Manager.
Setting up for release couldn't be simpler:
- Set the Document Type to
OUTJOB.
- Point to a top-level folder containing the Output Job Configuration files you want to release. Files can be stored in sub-folders within this folder.
- Choose the target vault.
- Choose to create a top-level folder in the vault based on the nominated top-level Windows folder, or choose an existing vault folder. You can optionally create sub-folders in the nominated vault folder, for each Windows sub-folder. Additionally, you can opt to create a vault folder for each source Output Job Configuration file.
- Use the Default Options for New Released Output Job Documents region of the Release Manager to control how required new Items are created as part of the release process - in terms of Lifecycle Definition, Item Naming (default is OUT-{00000}) and Item Revision Naming schemes, and starting index.
- Hit the Analyze Folders button.
Analysis of source folders and target vault folders (and Items) based on your chosen options will be performed and the source Output Job Configuration files detected will be listed. For each entry, the target Item will be displayed, its current and/or next revision (as applicable) and the action that will be performed by the release process.
Enable the Output Job Configurations that you want to release and then click the Prepare Items and Documents button to effectively commit the link information to the source Output Job Configuration files involved in the release. Once saved, proceed with the release by clicking the Release Items button.
