Importing and exporting object schemas

Importing and exporting schemas can be useful if you're using other instances of Assets and want to move schemas between them, or if you exported a schema in the past, and now's the time to bring it back. For example, you can choose to export only schema structure (including object types and their attributes) or also include objects.

What is included exports and imports:

  • Schema structure and their object types and attributes.

  • Objects

  • Archived objects

  • Attachments and avatars

What is not included in exports and imports. You’ll need to recreate these items manually in the target instance:

  • Automation and import configurations

  • Object history and comments

  • Connected Jira tickets. As a workaround, you can use the CSV import of Jira issues with Assets custom fields and their data. More about importing data with built-in importers

  • Confluence type attributes. As a workaround, check that the application link ID in your export matches the target system. If not, update the ID in the schema.xml file before importing. Also, if a Confluence space is set as an Additional value, update it to ensure attributes import correctly.

Importing an object schema

To import an existing Assets object schema:

  1. In the top navigation bar, select Assets > Configure.
  2. Switch to the Import/Export tab.
  3. Fill in the schema details. You can find descriptions of available fields in the table below.
  4. Once you're ready, select Import

After importing an object schema, you'll need to reindex Assets (not Jira). You can do it by going to Administration > Manage apps > Indexing Assets.

FieldDescriptionRequired
File name

List of previously exported object schemas that are available for import. This includes all schemas that are in the import directory specified below this field. If your schema is not on the list, copy it to this directory.

Yes
Name

Name of the object schema that will be created by the import. The name must be unique.

Yes
KeyKey of the object schema that will be created by the import. The key must be unique.Yes
DescriptionDescription of your schema.No
Import objects

Choose whether you'd like to import objects that belong to the schema. Here are some details:

  • Yes (default): Objects will be imported.
  • No: Only object schema structure will be imported. This includes object types, object type attributes, etc., but not objects themselves.
Yes
IncludeChoose whether to include attachments and avatars of objects.No
PasswordIf the file chosen for the import is protected by a password, then that password must be provided in order to perform the import.No

Exporting an object schema

To export an object schema:

  1. In the top navigation bar, select Assets > Configure.
  2. Switch to the Import/Export tab.
  3. Fill in the schema details. You can find descriptions of available fields in the table below.
  4. Select Export.

FieldDescription
File name

File name for your exported schema. The file will be saved in the directory shown below this field.

Object schemaList of object schemas that can be exported.
Object schema with / without objectsChoose whether to export objects together with the schema, or only the schema structure (object types, object type attributes).
PasswordIf provided, the exported file will be protected by the password entered by the user. Later when importing this file, the same password must be provided in order to be able to perform the import.
Last modified on Nov 13, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.