MeData Definitions

MeData Definitions specify which data points are to be collected by the Mobile SDK. A MeData Definition, as the name implies, defines the source and the allowed values of a data point to be collected by the Mobile SDK and processed in the platform.

Orchestrator MeData Definitions page

MeData Sources

Each MeData Definition points to a Source in terms of the value collection / access method:

• Native, requires native code provided out of the box by the DataSapien Mobile SDK to be executed to access device hardware, mobile OS, installed apps and native APIs provided by these
• Question, requires the Question that will be displayed in the app UI, you need to define its details such as title, text, image etc.
• Script, requires a script to be executed, you need to author the script to be executed on-device.
• VC, obtained from Verifiable Credentials (eg Driving License) stored in OWF compliant service of the SDK, you need to provide the JSON path to point to the data within targeted credential.

Native sourced definitions are predefined in the platform. For instance; "Device Language" and "Mobile Operator" are native definitions and their values are collected using native iOS / Android APIs. Native sourced definitions need special code to exist in the Mobile SDK.

Info

The DataSapien Mobile SDK supports a rich set of native sourced MeData Definitions. Contact us to request a new one.

Value Types

Specifies the data type and related constraints for the value of the MeData to be collected. Having a well-defined value type, with managed constraints, allows:

• Safe usage of MeData Definitions eg when creating Segment Definitions based on them.
• Error-free programmatic Processing of MeData.

A Value Type consists of:

• Data Type: type of value for this MeData, one of string, number, boolean, date, datetime, image, video, and listed complex objects (eg "Location", "Calendar Entry" etc)
• Value Constraints: defines constraints that value must obey
  • Min value: allowed minimum value for numeric and datetime types
  • Max value: allowed maximum value for numeric and datetime types
  • Regex: allowed format for string type
  • Allow camera: if true, taking pictures with camera should be enabled for image type
  • Allow gallery: if true, picking an image from gallery should be enabled for image type

Creating / Editing MeData Definitions

The following is required to create a new MeData Definition:

• Source: a Source selected from available ones
• Name: a language-independent (programmatic) name to be used within scripts
• Label: human language name for display purposes
• Value Type: a Value Type
• Enumerated: if true, the value must be one of the defined 'Enum Values'
  • Enum values: list of predefined values, each value has following fields:
    • Name: a language-independent (programmatic) name to be used within scripts
    • Label: human language name for display purposes
    • Image: an image that will be displayed along with the text
  • Allow none: if true, 'None of listed' is allowed as a value in addition to provided value list
  • Allow IDK: if true, 'I dont know' is allowed as a value in addition to provided value list
  • Allow other: if true user is allowed to provide a freeform input
• Multivalued: If true, MeData may have multiple values, in other words it can have array of values

A "Script" sourced MeData Definitions