Exporting and importing a model-based custom entity type

You can export a model-based entity type to an encrypted file. The export includes the entire configuration.

You can then import the entity type into another instance of Textual.

Exporting an entity type

Required global permission: Edit any custom entity type

From the details page for an entity type, to export the entity type:

  1. Click the actions menu next to the entity type name, then click Export Entity Type.

Actions menu for a model-based custom entity type
  1. After it downloads the custom entity type to the encrypted file, Textual displays the encryption key that was used to encrypt the file, and that you will need when you import the entity type. To copy the key, click the copy icon.

Export Entity panel with the encryption key for the exported custom entity type

Importing an exported entity type

Required global permission: Must have one of the following:

  • Create custom entity types

  • Edit any custom entity type

After you export a model-based custom entity type, you can import it into another instance of Textual.

When you import an entity type, you are prompted to provide the encryption key that Textual provided during the import.

You cannot use the import to update or replace an existing entity type. If there is already an entity type with the same name, the import fails.

Regardless of whether the imported entity type was complete and had an active model, it is inactive when it is imported. After the import, you can update the entity type to identify an active model.

To import an exported entity type:

  1. On the Custom Entity Types page, click Import Entity Type.

  2. On the Import Entity panel, to search for and select the exported file, click Choose file.

Import Entity panel to select the exported file and provide the decryption key
  1. In the Decryption key field, paste the encryption key that you copied during the export.

  2. Click Import.

Last updated

Was this helpful?