Entity Types
The entity types page will list all types of entities in the Portal.
You can manage your entity types here. You can filter on each column in the table.
To edit an existing entity type, click on Edit in the ‘Actions’ column at the end of the entity type’s row. You can modify the icon and colour, and modify or select an API Request and Embedding Url for an existing entity type.
How to Create a New Entity
Click on Add Entity Type.
Provide the name of the new entity type in Type.
Provide the Source.
Choose a Category from the dropdown of Data Pipeline, Quality Rule, Content, or Infrastructure Resource. Then choose a Subcategory from the dropdown. It will display subcategories of your chosen category in the dropdown.
You can also add a new category and subcategory.
Type in your new category and subcategory and then press TAB or ENTER to add and select it in the dropdown.
Choose an icon and its colour by clicking on Edit at the bottom-right of the icon.
Provide a description for the URL field in Url Description. This is required as publishers will need to supply a URL for each asset registered against this entity type.
You can then click on Next to choose embedding details.
Or you can choose to click Save and exit if you do not want to add an embedding library.
In the Embedding Library field, provide an embedding URL to be able to embed assets with this entity type.
You can select an API Request that can be used in your customization library. Choose an API Request from the dropdown.
If you have provided an embedding library, you can then optionally add embedding parameters here.
Click on Add in the parameter section, and you can then provide the fields needed for a parameter.
Provide an Id, name, type (Text, Boolean, Choice, or Array), value, and description of this parameter.
- Id: A unique identifier for the parameter.
- Name: A display name for the parameter.
- Type: The data type of the parameter of Text, Boolean, Choice, or Array.
- Value: Optionally, you can provide a default value for the parameter.
- Description: This will be the description for this parameter when viewing an asset.
You can add another parameter using Add at the top-right of the parameter section.
Click on Save to add this entity type.
