Orbita lets developers define and manage custom data types using schemas. A schema defines content types, dynamic data models, and personas of the people with whom the application interacts. The information is stored and used by the applications you create.

For example, you can define a schema to track the number of times a user uses a voice application that includes properties with types such as:

Number of Visits (Number)
User (ID)
Last Visit (Date)

This topic shows two example schemas: a Visit Tracker, and a new Tip node for Experience Designer.

Schema element values

A schema is created with the template for one field in the edit window using the following values for each element of the field.

Fields (fieldType). URL (url), Text (text), Rich Text (richtext), Media Embed (embed), File Upload (file), Date (Date), DateTime (datetime), Checkbox (checkbox), Dropdown (select).
Key. Use lowercase alphabetic letters without spaces.
Label. Use CamelCase letters.
isDefault. Boolean (true or false). This feature has been deprecated. The default value is false.
Validation. The array of “required” object, which can be true or false.
Options. Empty array for all except checkbox and dropdown which have a key/value pair.
Type. String, object, or array.

To add extra fields, copy the object structure with the fields array and add it with the comma-separated values before the end of the fields array().

When creating a Content schema, the Experience Manager automatically creates the Title and Tags fields in your schema. These fields are mandatory.

Example: Create a Visit Tracker

The following examples create a schema called VisitTracker.

Log in as an Administrator to the Experience Manager.
Click Schema Management and then Content Types.
Click Add (plus button in the middle panel).
Enter the following information:
- Name. VisitTracker
- Description. Track the number of visits
- Tags. VisitTracker

In the schema edit panel, enter:

{
  "fields": [
    {
      "key": "yearmonthday",
      "label": "year month day",
      "isDefault": true,
      "validation": [
        {
          "required": true
        }
      ],
      "options": [],
      "ref": "",
      "fieldType": "text",
      "type": "String"
    },
    {
      "label": "Number of Visits",
      "key": "numbervisits",
      "isDefault": false,
      "validation": [
        {
          "required": true
        }
      ],
      "options": [],
      "ref": "",
      "fieldType": "text",
      "type": "Number"
    },
    {
      "label": "UserId",
      "key": "userid",
      "isDefault": true,
      "validation": [
        {
          "required": true
        }
      ],
      "options": [],
      "ref": "",
      "fieldType": "text",
      "type": "String"
    }
  ]
}

Click the Check icon when you are done to save your changes.

Example: Create a Tip Node

Log in as an Administrator to the Experience Manager.
Click Schema Management and then Content Types.
Click Add (plus button in the middle panel).
Enter the following information:
- Name. Node Tips. (In the Content Demo flow, the Name of the schema is rich text.)
- Description. Tips for building specific types of nodes.
- Tags. node, tips.
Include two fields: NodeType of node and Tip.
- Copy the lines in the schema edit window from the open curly bracket (“{”) before label to the closed curly bracket (“}”) after the type.
- Add a comma after the last curly bracket.
- Paste what you had copied previously.
Copy the two fields from their open curly bracket (“{”) before the label attribute in the first field to the close curly bracket (“}”) after the type attribute in the second field.
Note: Be sure to not include the comma in what you copy.
Toggle to your JSON editor and paste the field definitions
Note: You will get error notification on the line that includes the close curly bracket and the comma after the first field. Ignore it for now.

In the schema edit panel, enter:

{
  “key”: “NodeType”,
  “label”: “NodeType”,
  “isDefault”: “true”,
  “validation”: [
    {
      “required”: “true”
    }
  ],
  {
  “key”: “Tip”,
  “label”: “Node Tip”,
  “isDefault”: “false”,
  “validation”: [
    {
      “required”: “true”
    }
  ],
  “options”: [],
  “ref”: “”,
  “fieldType”: “text”,
  “type”: “String”
}

Click the Check icon when you are done to save your changes.

Editing Tip

You can copy the code from above and paste it into the Schema edit panel. You can also use an online JSON editor, such as http://www.jsoneditoronline.org/, to create your JSON code. It will help ensure your JSON is well-formed. When you are done, you can copy and paste it from the editor into the Schema edit panel.

How do I create a schema?

Schema element values

Example: Create a Visit Tracker

Example: Create a Tip Node

Related Articles