Working with custom entity types

From the entity types list, you can set whether each custom entity is active, and edit the custom entity configuration.

You can also create a new custom entity type.

Enabling and disabling custom entity types

Required dataset permission: Edit dataset settings

In the entity types list, custom entity types include a toggle to indicate whether the custom entity type is active for that dataset or pipeline.

Custom entity type in the found entity types list

To disable a custom entity type, set the toggle to the off position.

When a custom entity type is enabled, then it is listed under either the found or not found entity types, depending on whether the files include entities of that type.

When a custom entity type is not enabled, it is listed under Inactive custom entity types. To enable the custom entity type, set the toggle to the on position.

Inactive custom entity types list

Editing a custom entity type

Required global permission - either:

  • Create custom entity types

  • Edit any custom entity type

To edit a custom entity type, click the settings icon for that type.

Note that any changes to the custom entity type settings affect all of the datasets and pipelines that use the custom entity type.

For information on how to configure a custom entity type, go to Custom entity type configuration settings.

Creating a custom entity type

Required global permission: Create custom entity types

From the dataset details or pipeline details page, to create a new custom entity type, click Create Custom Entity Type.

Create Custom Entity Type option on the dataset details page
Create Custom Entity Type option on the pipeline details page

For information on how to configure a custom entity type, go to Custom entity type configuration settings.

Running a new scan to reflect custom entity type changes

When you enable, disable, add, or edit custom entity types, the changes do not take effect until you run a new scan.

For datasets and uploaded file pipelines, to run a new scan, click Scan.

Scan prompt for a dataset or an uploaded file pipeline

For a cloud storage pipeline, Textual scans the files when you run the pipeline.

Last updated

Was this helpful?