Understanding Attributes

Anne Ramey
Platform Admins, Form Developers, Workflow Developers

Understanding Attributes

Attributes are used to add addition configuration and functionality to the platform. Arbitary attributes names are created and values are then applied to them in various configuration points within the platform.

Attributes and their values can then be retrieved by the form, bundle, workflows, or through the API. Then they can be leveraged in logic to drive behaviors, rules, or processes based upon their defined value.

There are several different types of attributes. Each one of them relates to a specific platform configuration point and can only be applied to its relevant item. For example a Space Attribute is only available for coniguration within the attribute configuration for the Space.

Space Attributes

From within a Space, Attributes can be created for and applied to:

  • Space attribute define additional characteristics of a space
  • User attribute define additional characteristics of a user

    • Can only be updated by a space admin.
    • Used for values that should not be modifiable by normal users because they are used in security policies or backend workflow.
  • User Profile attribute define additional characteristics of a user

    • Can be updated by a space admin or the user themselves.
    • Commonly used for user preferences.
  • Team attribute define additional characteristics of a team.
  • Datastore Form attribute define additional characteristics of a Datastore Form.

Kapp Attributes

From within a Kapp Attributes can be created for and applied to:

  • Kapp attribute define additional characteristics of a Kapp
  • Category attribute define additional characteristics of a Category
  • Form attribute define additional characteristics of a Form

Creating Attributes

Attributes are first created and named before values can be applied to them. From within a Space or a Kapp access "Attribute Definitions" from the left navigation pane.

An Attribute can also be supplied with a description and configured so that multiple values can be given to an attribute. Attribute Definitions

Configuring Attributes

After Attributes have been defined they can be applied to their appropriate locations. For example if a Form Attribute was created, it could then be applied to any of the forms from within the form configuration. From the form configuration the newly created Attribute will be available for selection and and be given a value. Only the Form Attributes will appear in this example. Form Attributes