Metadata is extra information in the form of key-value pairs that can be combined with Questionnaire Responses.
You may create your own metadata referring to the responder of the questionnaire and to the questionnaire.
You can see your Application Metadata by selecting the "Metadata" section on the left sidebar on the Application page:
Metadata are divided, depending on the owner of the information, into two categories:
- Questionnaire Metadata
- Responder Metadata
Questionnaire metadata are the values that are related with the customer experience itself. These can be the order id, the order date, the products of the order, anything that is related with the transaction or the experience.
Responder metadata are the values that are related to the responder itself. These can be the phone number, email, gender, anything that can be related with the customer.
You can create any metadata you need simply by clicking on the "Create New" button on the top right corner of the panel, depending on the type of metadata you need, and the following dialog will be displayed:
The name of the metadata that will be used in your code when you need to push metadata values.
NOTE: The accepted format of the metadata name is: name_with_words or namewithwords. You should not have spaces between the words.
|Title||The title of the metadata, as it will appear in the e-satisfaction dashboard.|
|Type||The type of the metadata, for comparison cases.|
|Anonymize||If activated, metadata values will be anonymized based on the Application Data Retention Configuration.|
Metadata can have their own type so that you can use comparison criteria in conditions across the dashboard. The available types are the following:
By default, e-satisfaction includes a set of metadata available to be used by your Questionnaires. These metadata are separated in two categories:
- Global Metadata: Available to all Applications
- Application Type Specific Metadata: Available to Applications of a specific Business Type only
Global metadata can include a set of metadata that are used by the platform internally to facilitate tracking and information collection to make the platform more intuitive and smart. We will mark these metadata as read-only and you should be able to check on them with a label on the right side of each item, as follows:
These metadata are for internal use and it is not recommended for use by the integration script, as they will be overwritten.
Push Metadata Values
When creating a Questionnaire Instance, you can Push metadata: