User Data Sets

Pass metadata in Scheduler widget requests.

User Data Sets allow you to define a set of key-value pairs (KVPs) that can be sent by a Scheduler widget to Mindful. A User Data Set allows Mindful to receive data, but you must still configure a metadata item for your Call Target in order to pass the data to the contact center.

With User Data Sets, you can define the KVPs that will be sent to Mindful by a Scheduler widget, which can then be passed on to the contact center through a Metadata item.

Create a User Data Set

  1. On the User Data Sets page, click Add New User Data Set to open the Create Scheduler User Data page.

  2. Configure the required and optional fields:

    • Name (required) — Enter a name to identify the User Data Set.

    • Description — Enter a description to define the purpose of the User Data Set.

  3. Click Add New Key to add the first key representing a user data KVP.

  4. In the modal window that appears, enter a Key Name for the KVP.

    example of adding a user data key
    Important: The Key Name (Telephony Key) must precisely match the KVP that will be received by the widget and the Metadata Item Name configured in Mindful. This requires casing to be consistent.

  5. Enter a value in the Default Value field, if applicable. This value will be assigned to the KVP if no value is received.

  6. (Optional) If you wish to replace any value that is submitted for this KVP with the specified default value, enable the Replace Value from Widget with Default Value checkbox.

  7. Click Save to save the User Data Key, then repeat the process for all remaining keys you wish to define for the set.

After creating a User Data Set, use the following steps to apply it to a widget:

  1. Click the Edit icon in the row corresponding to a particular widget.

  2. Use the User Data Set dropdown menu to select a set to apply.

  3. Save your changes.

You can return to any previously created User Data Set to make updates, as well.

Edit or delete a User Data Set

Edit a User Data Set

  1. To edit a User Data Set, click the Edit icon in the row corresponding to any existing set.

  2. Update the Name and Description fields as needed.

  3. Click the Edit icon on any row in the User Data Set Keys table to update the Key Name and Default Value fields as needed, then click Save in the edit window.

  4. Click Save on the Edit Scheduler User Data page to save all the changes you made to the User Data Set.

Delete a User Data Set

To delete a User Data Set, click the Delete icon in the row corresponding to any existing set.

Pass metadata to Mindful Datastore

Mindful has the ability to automatically capture metadata attached to Scheduler requests and store that data in Mindful Datastore. Several requirements must be met to take advantage of this capability:

  • A record must already exist in Datastore for the associated callback phone number, which can be done via the process outlined above.

  • Data keys must be configured in a Data Set Template that correspond to the metadata items you wish to capture.

  • The User Data Set associated with the Scheduler widget must be configured with the expected metadata items.

  • A corresponding Metadata Item must be configured for the Call Target, precisely matching the name configured in the Data Set Template and User Data Set.

  • The Enable Mindful Datastore Integration checkbox must be selected on the Call Target page.

With these items in place, any metadata that Mindful receives via Scheduler widget will be added to the existing Datastore record for the associated callback phone number, as long as the metadata matches a data key configured in the Data Set Template.