Entities

All entity types belong to an organization as well as the botlet. For example, if the Microsoft.Outlook botlet has an entity type called ‘Contact’, a relevant action for the Microsoft.Outlook botlet might be get_contact or add_contact, which use the ‘Contact’ entity type as input and returns a ‘Contact’ as output.

All Entity Types in the Store are defined in JSON with their respective types defined in the “@” field. A specific movie stored as an entity will for example be recognizable by having a “@” field with value of “mso.movie” together with all fields specific to the movie. Likewise, Entity Types are themselves defined semantically via the type “mst.entity_type” and these are the types that are exposed in the entity directory in the Workspace.

If you want to view an MSO Entity Type in the Workspace, refer to the following steps below on how to search for them in the Store and bring them into your Workspace.

  1. To view the Full list of MSO Entities , see: Full List of MSO Entities.
  2. In the list of MSO Entities, high-light the name of an MSO Entity (e.g., mso.airline), and then click CTRL-C to copy it.
  3. Access the Store portal, and then click CTRL-V to paste the MSO Entity that you copied from the previous step into the search field.
  4. Press Enter or click the magnifying glass icon.
  5. Scroll down the page to the Entity panel, and then click Add to my items.

Note: This will redirect you back to the Workspace and the MSO entity type you added in the Store will display its properties (i.e., MSO Entity ID, Description, and Fields). In addition, the MSO Entity type you brought in from the Store will be listed under the MSO folder under the Recent Items folder.

For a complete list of Entity Type and their descriptions, see: Entity Type Definitions

For a complete list of Atomic Types and their descriptions, see Atomic Types

Creating an Entity

The steps that follow will guide you through how to create, edit, and delete an entity from an organization.

  1. In the Items Tree, click the Create new icon, and then click New item.
alternate text
  1. Click Entity, and then click Create New.
alternate text
  1. Enter the Organization name.

Note: To create an entity, you must have permissions to an organization in the Items tree. For more details about the different types of permissions, see: Permissions.

alternate text
  1. Enter an Entity Type ID. Choose a Category, and then click Next.

(Optional) You can include a Parent ID. A Parent ID is a base entity type that provides the common properties of an entity.

Additional Information

When naming an entity type ID, you may find that it already exists in the organizations that you have permissions to. Click View details to view the field names and their types. You have the option to add additional fields to it and then save these changes as a new entity type.

alternate text

If an entity type ID does not exist, a message will display, “ID available.”

alternate text

For more information about adding new fields to an existing entity type, see: Adding a New Field.
  1. Enter a Description, and then click Next.

(Optional) You may upload an image for your entity type by clicking Choose a file.

alternate text
  1. Click Done.

Now that the entity type has been created, you can now start adding new fields to it.

Adding a New Field

Upon the creation of a new entity, you have the option to continue adding new fields to it, or you can do it at another time. The steps below describe how to add a new field to an entity type that already exists under an organization.

  1. In the Items Tree, click the name of the organization, and then select an Entity under it.
  2. In the Control Panel, click the Fields menu tab.
  3. Enter a Field Name, Field type (e.g., string), Description, and then click Add.
alternate text

Note: Click Required if you require a field to be populated by a user. Click Sensitive if the field that is populated (e.g., credit card number or other personal data) shouldn’t be persisted, stored, or logged anywhere.
  1. Click Save.
alternate text

Note: To add more fields to an entity, click + Add a new field. Enter a field Name, Type, and Description, and then click Save.

alternate text

Caution: If you navigate away from the organization without saving your changes to your entity fields, click Save Changes. Click Cancel, and stay on this page to continue with your work, or you may click Discard Changes.

alternate text

Inheriting an Entity Type

You have the option to inherit an entity type from a list of available entity types that you have permissions to. To inherit an entity type from a list, refer to the steps below.

  1. Enter an Entity Type ID, and then click View Details of an entity type in the list.
alternate text
  1. Click Save as Entity Type.

(Optional) Click + Add a new field to add more fields to the new entity type.

alternate text
  1. Click Next.

Note: After you’ve saved the entity type with the new field name added to it, the Parent ID field is automatically populated.

alternate text
  1. Enter a Description and click Next.

(Optional) upload an image for your botlet.

The result of the inherited entity type is shown in the image below.

alternate text

Editing an Entity

To edit an entity type, refer to the steps below.

  1. In the Items Tree, click the name of the organization.
  2. Select an Entity under an organization.
  3. To edit the Description field, click Edit to make your changes, and then click Done.
alternate text
  1. If there is a Parent Entity, click Edit to make your changes, and then click Done.
  2. Click Save.

Deleting an Entity

To delete an entity from an organization, refer to the steps below.

  1. In the Items Tree, click the name of the organization.
  2. Select an Entity under an organization.
alternate text
  1. Click Delete.
  2. Click OK.
alternate text