Exporting Artifacts
This topic provides instructions for exporting artifacts, such as data source definitions, pipelines, mappings, data sets, and graphmarts, and their related entities. Users can export the current version of an artifact or any backup version. Follow the appropriate instructions below to export artifacts:
- Export the Current Version of an Artifact
- Export a Backup Version of an Artifact
- Exported ZIP File Contents
Export the Current Version of an Artifact
Follow the instructions below to export the current, working version of an artifact.
Pipeline exports do not contain data set editions, but Dataset exports do contain the editions.
- In the Anzo application, navigate to the artifact that you want to export. For example, the image below shows the overview for a pipeline:
- Click the Export icon (
) under the artifact name. For example:
The image below shows an example of the Export icon for an artifact that has a backup version. Clicking the Export icon (
) exports the current version of the entity, not the backup version that is listed.
Anzo displays the Export Current State dialog box. For example:
- On the Export dialog box, configure the export options as needed. The list below describes each option.
- Include Related Entities: Indicates whether to export the artifact's related entities. Since most artifacts have dependencies with other artifacts, Cambridge Semantics recommends that you enable Include Related Entities (selected by default) and export all related entities. The number and type of related entities that are included varies by the type of artifact that is being exported.
When exporting a pipeline, there are several artifacts that contribute to that pipeline besides the ETL jobs. Since the pipeline reads the source data, it requires the data source connection and schema artifacts. It also depends on the ontology and mapping artifacts for instructions on mapping and/or transforming the source data to the graph data model. And it requires the file store and Anzo data store artifacts to be able to write the resulting RDF data files to the appropriate location. Capturing all of the related entities ensures that the exported package includes all of the artifacts that the pipeline depends on to run successfully.
- Include Registry Statements: Indicates whether to export the registry statements for the artifact and each of its related entities.
- Include Metadata: Indicates whether to export the metadata graph for the artifact and its related entities, such as the access control list (ACL) information and last modified date. If you exclude the metadata, the artifacts in this export will follow the ACL configuration on the destination server when they are imported. Select Include Metadata if you want to migrate the existing ACLs to the destination server. Enabling this setting also gives you the option to change the ACL configuration for the exported entities. To change the ACL configuration, expand the Advanced option and click the Sharing tab. For information about changing permissions on the Sharing tab, see Sharing Access to Artifacts.
- Advanced: If you want to change permissions or replace the values for certain properties in the exported version of an entity, such as the user name and password for a database data source, the base folder location for a file connection, or the file path for an Anzo data store, expand the Advanced option to view the Included Entities list. For example:
The entities with replaceable values are expandable. Click the ^ character to the right of an entity name to expand the options and view the editable properties. For example:
Replace any of the existing values with the new values that you want to define for the exported version of the entity. For information about configuring properties so that their values are replaceable on export, see Making Values Replaceable on Export.
If you specified Include Metadata and want modify ACL settings for the exported entities, click the Sharing tab and edit or add permissions for users, roles, and groups.
- Include Related Entities: Indicates whether to export the artifact's related entities. Since most artifacts have dependencies with other artifacts, Cambridge Semantics recommends that you enable Include Related Entities (selected by default) and export all related entities. The number and type of related entities that are included varies by the type of artifact that is being exported.
- Click Export to export the artifacts. Anzo packages the files into a .zip file and downloads it to your computer. You do not need to extract the files in order to import the artifacts to another Anzo server. See Exported ZIP File Contents below for a description of the files that are included in the .zip file.
Export a Backup Version of an Artifact
Follow the instructions below to export a backup version of an artifact. For instructions on creating a backup version, see Creating and Restoring Versions of Artifacts.
Pipeline exports do not contain data set editions, but Dataset exports do contain the editions.
- In the Anzo application, navigate to the artifact that you want to export. For example, the image below shows the overview for a graphmart:
- Click the Versions tab. Anzo displays the Versions screen, which lists the backups that exist for the artifact. For example:
- If necessary, select the version that you want to export. The details for that version are displayed on the right side of the screen.
When a row in the Related Entities list includes the compare versions icon (
) in the Actions column, you can click the icon to open the Compare Versions dialog box, which shows the TriG files for the two versions side-by-side. For example:
- Click the Export button. Anzo opens the Export Version dialog box. For example:
- On the Export dialog box, configure the export options as needed. The list below describes each option.
- Include Related Entities: Indicates whether to export the artifact's related entities. Since most artifacts have dependencies with other artifacts, Cambridge Semantics recommends that you enable Include Related Entities (selected by default) and export all related entities. The number and type of related entities that are included varies by the type of artifact that is being exported.
When exporting a pipeline, there are several artifacts that contribute to that pipeline besides the ETL jobs. Since the pipeline reads the source data, it requires the data source connection and schema artifacts. It also depends on the ontology and mapping artifacts for instructions on mapping and/or transforming the source data to the graph data model. And it requires the file store and Anzo data store artifacts to be able to write the resulting RDF data files to the appropriate location. Capturing all of the related entities ensures that the exported package includes all of the artifacts that the pipeline depends on to run successfully.
- Include Registry Statements: Indicates whether to export the registry statements for the artifact and each of its related entities.
- Include Metadata: Indicates whether to export the metadata graph for the artifact and its related entities, such as the access control list (ACL) information and last modified date. If you exclude the metadata, the artifacts in this export will follow the ACL configuration on the destination server when they are imported. Select Include Metadata if you want to migrate the existing ACLs to the destination server. Enabling this setting also gives you the option to change the ACL configuration for the exported entities. To change the ACL configuration, expand the Advanced option and click the Sharing tab. For information about changing permissions on the Sharing tab, see Sharing Access to Artifacts.
- Advanced: If you want to change permissions or replace the values for certain properties in the exported version of an entity, such as the user name and password for a database data source, the base folder location for a file connection, or the file path for an Anzo data store, expand the Advanced option to view the Included Entities list. For example:
The entities with replaceable values are expandable. Click the ^ character to the right of an entity name to expand the options and view the editable properties. For example:
Replace any of the existing values with the new values that you want to define for the exported version of the entity. For information about configuring properties so that their values are replaceable on export, see Making Values Replaceable on Export.
If you specified Include Metadata and want modify ACL settings for the exported entities, click the Sharing tab and edit or add permissions for users, roles, and groups.
- Include Related Entities: Indicates whether to export the artifact's related entities. Since most artifacts have dependencies with other artifacts, Cambridge Semantics recommends that you enable Include Related Entities (selected by default) and export all related entities. The number and type of related entities that are included varies by the type of artifact that is being exported.
- Click Export to export the artifacts. Anzo packages the files into a .zip file and downloads it to your computer. You do not need to extract the files in order to import the artifacts to another Anzo server. See Exported ZIP File Contents below for a description of the files that are included in the .zip file.
Exported ZIP File Contents
Depending on the options configured for the export, the .zip file contains one or more of the following files:
- artifact_name_graph.trig contains the model, data source, schema, and mapping definitions.
- artifact_name_metadata.trig contains metadata statements such as the access control list and last modified date for the exported entities.
- artifact_name_registry.trig contains registry statements such as the named graph information for the data source, schema, model, and instance data.
- artifact_name_version.trig contains statements about the backup version that the entities were exported from.