<style>
.pdl .syntaxhighlighter table td.code .container {
    margin-top: 0px !important;
    padding-bottom: 0px !important;
}
</style>

 

Description

Gigya's Schema is an integral part of our Customer Identity (RaaS) platform which allows you to add and access up to 1000 (one-thousand) additional custom fields beyond the default Profile object for each of your sites (API keys). If you are using Gigya's Data Store, you may also edit its schema using the Schema Editor. The editor gives you an un-paralleled ability to customize, not only the information you store for each user, but the unique experience every user has when visiting your site.

You can use the Schema Editor of the Gigya Console to easily and interactively edit your site's schema whenever the need arises, and these new fields will be ready for use immediately.

This utility is only available to Console users that have the necessary Console permissions to use at least one of the following APIs:

If your Console user account only has permissions for accounts.getSchema, you will be able to view the current schema but all editing capabilities will be disabled.

If your account has the necessary permissions, you can locate the Schema page of the Console from the left-hand menu of the Dashboard.

 

Using The Schema Editor

Navigate to the Schema Editor of the Gigya Console.

 

Dynamic Schema

When first arriving at the Schema Editor, the data node of your site's schema will be selected and you will see the Enable dynamic schema checkbox. Dynamic schema affects the APIs you can use to create new fields in your schema.

 

Editing Existing Field Properties

When you select a field from the tree in the left-hand pane of the editor, or after clicking the Create Data Field button and creating a new field, a Properties dialog will display in the right-hand pane. 

Existing fields support editing of the following properties:

For an explanation of the above fields, see Adding New Fields, below.

 

Adding New Fields

  1. Click the Create Field button on the top-right of the editor. Note that you can not add additional nodes beneath existing fields.
  2. In the Create Field window: 

    1. If you have the Data Store enabled for your account, select whether to create the field in the Accounts or the DS schema.
    2. If you have Lite Registration or Subscription Management enabled for your account, select the type: a Data or Subscription field.
    3. Enter the field name. See limitations below: Available Field Properties
    4. Click Create.
  3. Your new field is displayed in the left-hand tree and you can configure its properties in the right-hand panel.


Available Field Properties

For additional information on the above properties, see accounts.setSchema and ds.setSchema.

Important notes:

  • Once a field is saved to the schema using the Schema Editor, it can not be deleted using accounts.setSchema. Using accounts.setSchema, it is only possible to delete fields that data has never been saved to (even if said data has been deleted) and it has not had a type defined (creating a field using the Schema Editor always assigns a  type). If you think there is a scenario where you may not use a field and would like the ability to delete it and create another field with the same name, use accounts.setSchema to create the field without setting it's type. Once a field is created using the Schema Editor, it can only be removed via the Schema Editor or using the accounts.deleteSchemaFields API and you can not create a new field using the same name.
  • Once you set a field to encrypted, you cannot reverse that definition.
  • Not all the above properties are available for all field types. For example, for subscription fields, you can only choose whether they are required or not.

 

From the Properties panel of the selected new field you can Remove Data Field if you do not want to save it, or Save Changes to the schema to make the new field permanent. You can also Refresh the schema or Discard Changes if you want to remove all unsaved changes.

 

When you are finished editing your schema, Save Changes to add all new fields to your site's schema.

 

 

Deleting Fields

If no data has yet been saved to a custom data field, you can delete it. 

  1. Select the data field you wish to delete, and click Delete Data Field. 

  2. Confirm the deletion. 
  3. The field will be deleted once you save all the changes you made in this session (when you click Save Changes). 

 

Changed Properties

When an existing field's Properties have changed, you will see an asterisk "*" next to the corresponding field name in the left-hand tree, as well as all parent nodes. The process for saving or discarding the change are the same as described above. Note that you can not edit the Name or Type of an existing field.

 

Site Group Schema

If your site is a member of a Site Group, the only option available is to edit the Required property of existing fields, new fields can only be added to the site group schema via the parent's Dashboard.

 

Additional Information

For additional information see the following resources:

 

As part of our cloud hosted solution for storing all of your user data, the Gigya schema can support up to 1000 (one thousand) additional custom fields beyond the default schema. The Schema Editor allows you to edit the schema from your account Dashboard.