This feature is only available in the current version of Author Studio released in the fall of 2023. If you have not updated to the newest version of the product, see our Archived Author Studio Documentation here.
Introduction to Entities
Entities function the same way in Author Studio as they do in irAuthor, but their creation process is structured differently in Author Studio. If you are unfamiliar with the idea of entities and their purpose, read the article, Entities Overview.
Adding an entity
- Select a rule application from the Rule Application list. Then select the Entities tab in the menu on the left side.
- If the rule application is not already checked out, you have to check it out to add a new Entity.
- Click on New Entity
- The new Entity will appear in the entity list; click on the Entity to edit it.
When you select Entities from the panel on the left side of the page, you will come to the Entities page. On this page, you will see a list of the Entities in this Rule Application and the Properties panel for the Rule Application you are in.
Inside the Entity
Once you select an Entity from the Entities List, as shown above, you are directed inside the Entity.
Each field inside the entity is listed here where you can see its name, display name, and data type.
When you first navigate into the Entity, The property panel displays the properties of the Entity.
If you click on the different fields listed inside the Entity, the Property Panel will show the information for that Field. Read about the Property Panel for Fields in the article, Fields.
Specifies the name of the entity. For entities or schemas that are based on an external source, this value may not be modified on this screen.
2. Display Name
Specifies the name that will be used in the business language editor when referring to this Entity.
Here you can write a description of the Entity. This is helpful for other users in your organization and can serve as a way to create a helpful reminder for yourself.
Import JSON Snippet
You can auto-populate an Entity with a JSON snippet. This functions the same way as the Import from JSON Snippet feature in irAuthor. You can upload a JSON snippet by clicking on Import JSON Snippet in the upper right corner of the Entity page. You cannot copy and paste JSON snippets in Author Studio
Deleting an entity
From the Entities menu, you will see all the entities created in your rule.
- Hover over the row of the Entity you would like to delete, and a trashcan icon will appear.
- Select the trashcan icon to delete the Entity.
- You will be prompted to confirm the deletion. Click on Delete.