How do I create Domain Metadata fields?

Ryan Richins
  • Agilix team member
  • Updated:

Create metadata fields that allow you to record and track additional information about a domain.

To do so:

  1. Open Domain Settings.
  2. Click Add on the Metadata for domain card.
  3. Provide the following:
    • Name: This names the field behind-the-scenes and is not visible to the users.
    • Title: This appears wherever the metadata appears for users to complete.
    • Input Type: This specifies how you want users to provide the metadata.
    • Placeholder Text: This is what you want to appear in the field when left blank; you can use this to provide directions and or example content to help users complete the field.
    • Default: This defines the state or content that you want present in the field when users first encounter it and is recorded and treated as metadata if it isn't changed (you may want a True/false field to record False unless changed by a user, for example).
  4. Click Done and Save Domain Settings.

Once created, the Domain Metadata field appears on the Create Subdomain screen.

Comments (2)

Sort by
Lori Gully

Can the metadata fields be used to add user information (i.e., grade level) which we could then request in custom reports?

Is there another way to display/include grade level in reports on user activity that you can recommend?


0 Comment actions Permalink
Scott Taylor

Hello Lori,

In the Domain Settings under the User Options tab there is a section to create custom User Metadata fields for this purpose. The added custom fields would then be able to be modified for users in the user Edit page and will display the content on the User Data tab of the user as well. This data could then be referenced in custom reports to query for the custom metadata with an example following.

If a custom field of Grade Level was created a suggested name would be gradelevel and a title of Grade Level. The name needs to be only alphanumeric characters with no spaces, and will be case sensitive for the query. To query the data to find users with a grade level of "2" one would use the API command ListUsers with the following format (Replacing {DomainID} with the ID of the domain to query):


The returned information could then be used for further reports as desired.

1 Comment actions Permalink
Please sign in to leave a comment.