***

title: Configuring Custom Entities
position: 1
excerpt: ''
deprecated: false
hidden: false
metadata:
title: ''
description: ''
robots: index
next:
description: ''
pages:

* type: basic
  slug: how-to-guides-1
  title: How To Guide for Entity Catalog

***

## Entity Configuration Guide

In the home screen of Entity Catalog, you can see a list of already configured softwares entities. Clicking on Create or Edit will open the configuration screen for creating new custom software entities. Let's understand what these configs mean.

![](https://files.readme.io/13a1fab44a81907ba463e2a0af1cc0fbffb6b68ed0cc45a16f460a93c827f1ad-entity_catalog.png)

![](https://files.readme.io/374e5dff1a5a4f584b6d4ce359a41a386345f690a4b30d21dcbf9def6ef796e2-entity_details_page_1.png)

### Understanding Key Configurations

<table>
  <thead>
    <tr>
      <th>
        Term
      </th>

      <th>
        Definition
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        Title (Not      editable)
      </td>

      <td>
        Preferred entity name shown to users
      </td>

      <td>
        `Zoom`, `Figma`, `Loom`, `Notion`, and more
      </td>
    </tr>

    <tr>
      <td>
        Canonical Name
      </td>

      <td>
        Moveworks ID
      </td>

      <td>
        ServiceNow Service Catalog → `servicenow_service_catalog`

        WebAssembly → `webassembly`

        Dolby.com → `dolby_com`

        Canonical name is snake case with spaces converted to ‘\_’ underscores
      </td>
    </tr>

    <tr>
      <td>
        Description
      </td>

      <td>
        A brief description of the entity shown to users
      </td>

      <td>
        “Zoom unifies cloud video conferencing, simple online meetings, and cross platform group chat into one easy-to-use platform.”
      </td>
    </tr>

    <tr>
      <td>
        Entity Type (Not editable)
      </td>

      <td>
        Classify entities according to different use cases
      </td>

      <td>
        Software Applications
      </td>
    </tr>

    <tr>
      <td>
        Aliases
      </td>

      <td>
        Alternate names for an entity
      </td>

      <td>
        `zoom`, `zoom video`, & `zoom pro` would be the aliases for Zoom, the video conferencing software
      </td>
    </tr>

    <tr>
      <td>
        Exact matching logic
      </td>

      <td>
        Matches a word or phrase exactly
      </td>

      <td>
        `zoom pro` would always match with zoom entity in EC
      </td>
    </tr>

    <tr>
      <td>
        Fuzzy matching logic
      </td>

      <td>
        Match a word or phrase to within a certain edit distance
      </td>

      <td>
        `zooom` (intentional spelling mistake) would try to match with zoom entity in EC.

        By default, this option will be selected for aliases
      </td>
    </tr>

    <tr>
      <td>
        Negative aliases
      </td>

      <td>
        Prevents matches against a word or phrase that would otherwise match
      </td>

      <td>
        `loom` & `moom` entities would be negative aliases for Zoom video conferencing software since those two are different apps with very similar names
      </td>
    </tr>
  </tbody>
</table>

<Callout intent="warning" title="Important Note">
  * Entity Title is also the primary alias. It is not editable once entities are created
  * Currently, Entity Type **Software Application** is selected by default and is not editable
</Callout>

<br />

### View Software Entities

1. Navigate to **Moveworks Setup** > Core Platform section > **Entity Catalog** screen to view custom software entities
2. The screen will display entity information with **Entity Name**, **Canonical Name**, and **Description**, with an **Edit button**

   ![](https://files.readme.io/5481ba568a3f3ce0a55473f33cf3d48bc5075faf8efb258dab5cf5802db3ffd8-image.png)

   <br />

### Search Software Entities

1. Navigate to **Moveworks Setup** > Core Platform section > **Entity Catalog** screen to view custom software entities
2. Click on search bar and search for entity such as `zoom` – the search string will get matched on entity name, canonical name or description

   ![](https://files.readme.io/93796ac7ef44001f8c92339fc4719ddf8e11dfd711dc374538691c49d16d5c0a-image.png)

   <br />

### Create Software Entities

1. Search whether the software entity already exists **Moveworks Setup** > **Access Software** >  **Software Catalog** > **Software/Application Name**

   ![](https://files.readme.io/e98cd11228fcfb5b40b84c100fc477475ea670f370b1c48a048238a08aac1041-image.png)
2. If the desired entity is not found, Navigate to **Entity Catalog**, click on **Create New** button

   ![](https://files.readme.io/f448b6fe27dd0c6a077085937ce40ee7ab79a93fd5e22c99fa12f86f667bc1f1-create_entity_1.png)
3. Fill in **all** required the fields

   | Field             | Value                                                                                                                       |
   | :---------------- | :-------------------------------------------------------------------------------------------------------------------------- |
   | Title             | Zoom                                                                                                                        |
   | Short Description | Zoom unifies cloud video conferencing, simple online meetings, and cross platform group chat into one easy-to-use platform. |
   | Entity Type       | Software Application (selected by default)                                                                                  |
   | Entity Aliases    | `zoom`, `zoom video`, `zoom pro`                                                                                            |
   | Negative Aliases  | `loom`                                                                                                                      |

   <br />

   ![](https://files.readme.io/3fb04c577011551323dbaee75de37324fd8aca69209d87723d00684c447e27ae-create_entity_2.png)
4. Click on **Submit Button** to create the entity

   ![](https://files.readme.io/00520e7c5798558af5534ad898b825af05bc279dd4d62ca22091af69b4caede8-create_entity_3.png)

### Modify Software Entities

1. Navigate to **Moveworks Setup** > **Entity Catalog** and Click on **Edit Button**

   ![](https://files.readme.io/2a4bea0bd3526b56e697d54769656c6719377d309cc3b3bf77c3706575aaf83e-edit_entity_1.png)
2. Edit the fields that you want to modify in Entity Details page

   * Edit Description, or
   * Add, update or remove Aliases, or change their matching logic, or
   * Add, update or remove Negative Aliases

   ![](https://files.readme.io/d60322363963da20c8d64cac803e6434b16e778be89a69e07ecf3b0dff7d7128-edit_entity_2.png)
3. Click on **Submit Button**

### Where to Utilize Software Entities?

1. Navigate to **Moveworks Setup** > **Access Software** > **Software Catalog**

   ![](https://files.readme.io/214d06adbab8a6336aa3b2cb5b165d9ec2fc37922af4af36a2a28bc0dbe16816-image.png)
2. Search for the entity in the **Software/Application Name** field

   ![](https://files.readme.io/25665189d2bea3e91cda83c4034e95a3a4e13b518137223ef2c3e8d434925866-image.png)
3. Setup the Software Provisioning for the Software or Application. For more information, read the guide on [Provision Management](/service-management/provision-management/overview)