DRUID Data Service

DRUID Data Service is DRUID’s data storage used to persist DRUID entity records created and managed within the DRUID Platform simplifying records authoring. Bot authors can further use these records in NER training and in other different contexts. For example, if you have a CRM where you keep your Accounts list, you can have as well a Data Service from DRUID where you can keep the account records list.

This section describes how to enable DRUID Data Service in a cloud deployment. If you want to use DRUID Data Service in a hybrid deployment, you need to install it. For information on how to install DRUID Data Service, see DRUID Data Service Installation.

Important!  DRUID Data Service is a tenant feature available on request. If you want to activate it, get in touch with DRUID Support.
Note:   DRUID Data Service is available across all bots on your tenant.

Enable DRUID Data Service

After DRUID Support team activates DRUID Data Service on your tenant you need to enable it. To do so, follow these steps:

  1. In DRUID Portal, on the Administration menu, click Settings.
  2. Click the DRUID Data Service tab.
  3. Tick Is enabled.
  4. DRUID screens all existing entities across all bots on your tenant and detects the entities that have fields for which the field type is incompatible with the required system field type. You can go through the list and click on entity (entities) to see which field types were found incompatible.

    Important!  The upgrade is irreversible; so before upgrading, we strongly recommend you to check the new system entity field types and review your existing configurations to make sure that they are not affected by these changes.
    Note:  The upgrade is mandatory if you want to use this entity with DRUID Data Service and Workspaces. If you do not upgrade an entity, you have Data Service active on your bot and you try adding a DRUID Data Service Integration task on the entity, you will get an error message.

    The following DRUID system fields are automatically populated on entity and entity field creation; therefore, a specific field type is required by DRUID.

    DRUID System Field DRUID field Type
    Id String
    CreatedByUserId String
    CreatedOn DateTime
    ModifiedByUserId String
    ModifiedOn String
    OperatedByBotId String
  5. Click the Overwrite entity fields button at the bottom of the pop-up to overwrite your existing field types to the ones required by DRUID.
  6. At the top-right corner of the page, click the Save all button ().
Important!   Make sure that you click Save all; otherwise, enabling DRUID Data Service and overwriting the entity fields will have no effect.

Use DRUID Data Service Connector to manage entity records within the conversational flows.

Add Data Service Indexes

Note:  This feature is available in DRUID 7.8 and higher.

You can optimize Data Service queries for entities with a large volume of records by adding indexes directly within the DRUID Data Service DB. To add an entity index, follow these steps:

  1. Navigate to Administration > Settings and access the Druid Data Service Tab.
  2. In the Druid Data Service Indexes section, click the Add New button.
  3. In the pop-up that appears, select the desired Entity and provide an Index Name. Optionally, add specific entity fields to the index in the 'Index Fields' area.
  4. Save the index.

Feel free to add as many entity indexes as needed to suit your requirements.

Review entity indexes

To review existing entity indexes:

  1. Click the View all button in the Druid Data Service Indexes section.

  2. A pop-up will display a comprehensive list of all indexed entities.

  3. You can manage indexes by removing them using the corresponding delete icon.

Druid Data Service indexes offer improved query performance and greater control over data retrieval, enhancing the efficiency of your DRUID experience.