Exporting and importing custom entity types

You can export a custom entity type to an encrypted file.

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

Exporting an entity type

Required global permission: Edit any custom entity type

Exporting a regex-based type

To export a regex-based entity type, on the Entity Types page, click the export icon for the entity type.

Exporting a model-based type

For a model-based type, the export option is available from both the Entity Types page and the entity type details.

When you export the type, you can either export:

• The full entity type configuration, including the test and training data.
• The entity type without the test and training data.

If you export a model-based entity type without the test and training data, then after you import it, you cannot change the entity type configuration. You can only select the trained model to use.

Entity Types page

From the Entity Types page, T=to export a model-based custom entity type:

1. Click the export icon for the entity type.
2. Either:

   • To export the full configuration, including the test and training data, select Export.
   • To export the entity type without the test and training data, select Export without data.

Export options for a model-based entity type on the Entity Types page

Entity type details

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

1. Click the actions menu next to the entity type name:
2. Either:

   • To export the full configuration, including the test and training data, select Export entity type.
   • To export the entity type without the test and training data, select Export entity type without data.

Actions menu for a model-based custom entity type

Copying the encryption key

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 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.

For an imported model-based type, the progression tracker reflects the status of the type. However, regardless of whether the imported entity type was complete and had a published model, it is does not have a published model when it is imported. After the import, you can update the entity type to identify a published model.

To import an exported custom entity type:

1. On the Custom Entity Types page, click Import type, then select Exported 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.