Parent page: Altium 365 Workspace
The Workspace facilitates the uni- or bi-directional synchronization of component data with an enterprise system. The Workspace uses an XML-based configuration file to specify the directions of synchronization, the components that will be included and the mapping of parameter data. Component data synchronization between the Workspace and the target enterprise system uses a built-in synchronization process that is manually triggered on demand.
When the synchronization process first adds a component's data in the target enterprise system, a system-generated item number is passed back to the component in the Workspace as a
PlmPartNumber parameter. This acts as the key parameter when synchronizing data between the Workspace and the enterprise system instance. In addition, the configuration can be arranged so that item parameters/attributes on the enterprise system side will update properties in the Workspace server (configurable per field), without having to formally release a new revision of that Component Item.
The connection to an external enterprise system and its configuration is set up through the Workspace's browser interface. Synchronization to an Arena® PLM system is currently supported, and a base configuration file for the Arena system is available to get you started.
Connecting to Your Enterprise System
Connection to your enterprise system is performed from the Admin - Component Sync page of the Workspace's browser interface. This involves uploading a suitable XML-based configuration file and setting up the connectivity between the enterprise system and the Altium 365 hosted Workspace.
Add and configure the interface to your company's enterprise system. With a valid connection, you can instigate synchronization of components between that system and your Workspace instance as required.
To create a new interface instance, click the button, name the instance, and then upload a configuration file that applies to the enterprise system (in this case, Arena PLM) and your component data synchronization needs. While it's most likely you will need to set up only one enterprise system instance, any number of instances may be added to the Workspace as required. Each instance must be uniquely named and have a configuration file (see below).
Each added enterprise system instance must have an associated configuration file, defined and uploaded for it. It is the configuration file that defines the synchronization of components between your Workspace and the enterprise system instance by specifying, for each component type, the direction of synchronization, which components are involved, where components are to be created and the parameter mapping.
Sample Configuration File
The sample Arena system configuration file can be obtained when adding a new instance by clicking the Download sample configuration link, below the Configuration file field. A Zip file – ConfigurationSamples.zip – will be downloaded to your browser's default download folder. This archive contains the basic
dm-Arena-config-basic.xml configuration file.
The Workspace provides a downloadable sample configuration file.
dm-Arena-config-basic.xml configuration file to suit your company's enterprise system instance and requirements. This supplied configuration includes a URL reference to the Arena API and two representative component entity sections (
Diodes), where each of those also includes a
ToAltium attribute/parameter mapping sub section.
Generated Configuration File
The Workspace also provides a configuration generator option as an alternative way of creating a configuration file for the Component Sync service. Available from the Generate configuration link in the Add new instance dialog, the generator requests connection information (PLM type and URL), and then interrogates the Workspace component data model to construct a base configuration file.
Component types that are registered in the Workspace are added as entity types in the configuration with matching
ToAltium synchronization sections and mapped attributes. Also included are
TODO comments that highlight areas to add or change for compatibility with your Workspace and PLM configuration. Once created, the configuration file (
dm-configuration.xml) is automatically downloaded to your browser.
Modify this file to suit the configuration requirements of your company's enterprise system, such as its component attribute naming scheme, and upload the updated version to the Workspace as outlined below.
Uploading a Configuration
Upload a suitable configuration file for the enterprise system instance currently being defined by clicking the button – a standard Windows Open dialog will appear with which to browse to, and open the required XML-format configuration file. Once uploaded, use the button to check for warnings and errors that relate to the configuration. The test process will first request sign in credentials for the enterprise system if these have not been already established via the button.
When the connection validation report is run, the Workspace analyses the current configuration settings for compatibility with both Workspace and the target enterprise system data. Configuration issues such as path errors, unmatched component type definitions and parameters, invalid Lifecycle or Revision settings are detected and reported in the Configuration Validation Report window.
Add and configure the interface to your company's enterprise system then check and correct any errors in the uploaded Configuration file.
If configuration errors are reported – resulting in an overall ERROR status (Status) – these will need to be addressed before the new instance can be created. A WARNING status, which indicates issues such as Workspace components types that are not included in the configuration, allows the configured instance to be saved and used.
Be sure to click the button once your instance is defined successfully. That instance will appear in the current listing of connected instances, back on the main Component Sync page of the interface.
Synchronization of components between the Workspace server and the connected enterprise system instance – or to be more specific, their parametric data – involves the following:
- Configuring the synchronization for each component type. This involves:
- Determining the direction of synchronization.
- Determining which components are involved, and where components are to be created.
- Configuring parameter mapping.
- Configuring the synchronization of Part Choices data mapping, if applicable.
- Performing the synchronization.
The first two item groups above are handled in the configuration file used for the connected enterprise system instance. The synchronization itself is performed on-demand from the Component Sync page of the Workspace's browser interface.
Within the configuration file, the connectivity with the enterprise system instance is defined between the
Instance tags, which is preloaded with
URL entries for the Arena PLM system. The section also accommodates the nomination of a particular Arena workspace that is available for an Arena user account. The optional Arena workspace ID is defined in the
In the following
Schema section of the configuration file, you define a section for synchronization mapping for each dedicated part type. On the Workspace side, this is the component of type altiumType (and is the name you see in Altium Designer's Component Type dialog). On the enterprise system side, a part is defined as a plmType. This entire component section is declared as an
Entity in the file, an example of which might be, for capacitors:
<Entity altiumType="Capacitors" plmType="Capacitor">
Entity tags, two sections are used to control and configure synchronization from the Workspace server to the enterprise system , and the enterprise system to the Workspace server – allowing for uni- or bi-directional synchronization. Use the following sections, in conjunction with the comments available in the sample configuration files, to learn more. Ultimately, what gets defined in the configuration file will vary depending on your specific needs, and also the (PLM) attributes that have been defined in the connected enterprise system instance.
This sub-section is used to control and configure synchronization from the Workspace to the enterprise system instance (PLM) in the form:
Within the ToPlm section, the following sections are defined:
- How new components are created in the enterprise system instance – between the tagset <CreateInfo> and </CreateInfo>. One example might be choosing an item naming scheme defined in the target enterprise system, and specifying an item numbering prefix:
<Field name="Code" value="120"/>
- Filtering to limit which components in Workspace are synchronized with the enterprise system – between the tagset <SourceCriteria> and </SourceCriteria>.
- A listing of attributes (parameters) that should be passed for the components from the Workspace to the enterprise system – between the tagset <Attributes> and </Attributes>. An example of this is:
<ns2:Attribute attributeType="item" primaryKeyOrdinal="1">
<!-- Workspace component description will go to enterprise system field Description. Value will be prefixed with 'Extended' -->
This section is used to control and configure synchronization from the enterprise system instance to the Workspace server in the form:
<ToAltium sync="true" mode="createAndUpdate">
mode statement determines how component data is synchronized from the enterprise system to the Workspace. The default mode (
updateExisting) allows only existing Workspace components to be updated, whereas the
createAndUpdate mode also allows new components to be created in the Workspace.
Within the ToAltium section, the following sections are defined:
- How and where new components are created in the workpace – between the tagset <CreateInfo> and </CreateInfo>.
<!-- <ComponentTemplate>TODO component template Revision ID</ComponentTemplate> -->
<RevisionNamingScheme>1-Level Revision Scheme</RevisionNamingScheme>
The applied component template (if available) and Item naming scheme are taken from the nominated Workspace folder. In the sample configurations, a default revision naming scheme (
1-Level Revision Scheme) and lifecycle definition (
Component Lifecycle) are defined to be used – these are overruled if a component template is defined for the target Workspace folder.
If a specific component template reference is added (for example; <
ComponentTemplate>CMPT-00001</ComponentTemplate>), its settings and defined parameters will overrule those defined for the target Workspace folder and its associated template. Note that the specified template will apply to newly created Workspace components only.
- Filtering of data retrieved from the enterprise system instance – between the tagset <SourceCriteria> and </SourceCriteria>. A filter statement might restrict the component data received from the enterprise system to those created by a specific author (as illustrated in the supplied example configuration), or to component items that have a particular attribute Value (Company = Acme Inc), as shown below).
- A listing of attributes (parameters) that should be passed for the components from the enterprise system to the Workspace server – between the tagset <Attributes> and </Attributes>. An example of this is:
<!-- Name field from enterprise system will be passed to name/comment field in Workspace -->
<!-- Description field from enterprise system will be passed to Description field in Workspace on revision level -->
<!-- Revision level attributes will cause new revision to be created when parameter value has changed -->
<!-- Number field from enterprise system will be passed to PlmPartNumber field in Workspace on item level -->
<!-- Item level parameters will not cause revision update when changed -->
<ns2:Attribute attributeType="item" primaryKeyOrdinal="1">
The section for defining Part Choices data mapping is found at the end of the sample (or a generated) configuration file. Note also that synchronization of Part Choice data is unidirectional – from the enterprise system to the Workspace only.
Along with Entity declarations within the configuration Schema is an additional section for defining component Part Choice data mapping from the enterprise system to the Workspace. This is a global definition that specifies the component manufacturer and part number attributes used in the enterprise system.
When Part Choices synchronization is enabled in the configuration file (
sync="true"), the Value of the specified attributes are transferred from the enterprise system component item to the created/updated Workspace component. As a global definition for all defined component entities, the Part Choice data will be propagated to a Workspace component whenever it is encountered in the enterprise system component dataset.
An example entry for the Part Choices mapping in a configuration file – where the enterprise system attributes are
MFR1 (Manufacturer Name) and
MPN1 (Manufacturer Part Number) – might be:
Part Choice data synchronization supports multiple part choice data entries found in the enterprise system component item. These additional attributes need to be specified in the configuration file mapping as another pair of attribute definitions, for example:
The above mapping syntax applies to Part Choice data stored as Arena item attributes (
MPN1), however if using Arena's native Part Choice system – established in Arena as Relationships under the Sourcing tab – the following syntax structure can be used:
Performing Component Synchronization
Synchronization itself is performed from the Component Sync page of the Workspace's browser interface. Click the control associated with the synchronization instance. The synchronization process will proceed in accordance with the settings defined in the associated configuration file.
Component synchronization in progress between a Workspace and the indicated enterprise system instance.
The control changes to . If you want to stop the synchronization process, click this control. A confirmation window will appear, where you can click to cancel the synchronization – all components already synchronized will remain so, but no further synchronization beyond that point will occur.
Refresh the browser (F5) to check when the synchronization process is complete. To see further details on the completed process, or to confirm its success or otherwise, select the Synchronization status tab and choose the Closed listing option – if a process is still running it will show in the Active listing. Details of the selected synchronization event are shown in the lower pane, which also includes a link to a system-generated notification log file (PLM <Date Time>.log) for the event. Click this link to download the detailed log file to the browser's default download folder.
Example result of a successful bi-directional synchronization of 6 components.
The tangible results of a synchronization process can be observed in both Arena and the Explorer view of Altium Designer or the Workspace. In this example case six LED components have been synchronized between Arena and the Workspace, linked by the Arena
ITEM NUMBER attribute and the Altium
PlmPartNumber parameter as index keys.