Adding an Attribute

You can create a new attribute for a Dataset.

1. Select Datasets in the Settings section of the navigation bar.
   A list of all available Datasets are displayed.
2. In the search field, enter the name of the Dataset for which you want to add an attribute.
   The search results display the Dataset at the top of the list.
3. Click on the selected Dataset to display this Dataset's page.
4. Expand the Attributes on the Dataset's page and click on Add Attributes link.

   For example, the following screenshot displays the Attributes section on the Users Dataset page.

   

5. Enter the new attribute field information as described in the following table:

   Name	Description
   Name *	Enter a unique name for this attribute; duplicate attribute names are not allowed in a dataset. The name must begin with a lowercase letter and contain no spaces. The name should indicate or describe the attribute's function. Note: Some special attributes are hidden on a few datasets, such as the Users, Roles, and Interfaces datasets. These special attributes are not classified as string, integer, date, datetime, binary, or decimal type of attributes. The names of these special attributes do not display in Dataset Attributes list but, if you attempt to create a new attribute using one of the special attribute names, system will display a message to inform you that an attribute with this name is already specified for the dataset.
   Description *	Enter the description for this attribute. The description should briefly explain the attribute's function.
   Type *	Select an attribute Type from the drop-down menu. The type assigned to an attribute will restrict that Attribute from accepting any data that is not in the specified format. You can select one of the following items from the drop-down menu. Binary Boolean Date Date/Time Decimal Integer String Alias Note: If an attribute or link is created in the child of an abstract dataset, any attribute or link of the same name created in another child of the same abstract parent must also have the same type, key, and required settings.
   Path	Enter a path to be evaluated as an alias (virtual) attribute type. Alias attributes are used to reference an attribute on a dataset through a different name. Aliases can be used to create a new path to access the same required data after the data model changes, which ensures workflows and adapters are able to function properly. The path for an alias can be an attribute on the same dataset (simple), or be an attribute on a different dataset (foreign) which uses a more complex attribute path to the aliased attribute. When the path is through a link attribute, the attributes are separated by the "." character (e.g., unit.name to access the name of the unit linked to the current dataset). The path of an alias must point to a valid attribute, and an alias attribute cannot be indexed or be a key attribute. The definition of a path can have a complex attribute path through multiple attributes. The Vocera Platform Web Console follows the path of the alias attribute to ensure that it does not contain a circular path. Foreign attributes cannot use any *-to-many links.
   Key	Select the Key checkbox if you want to designate this attribute as a key value. Leave the Key checkbox de-selected if you do not want to designate this attribute as a key value. Assigning a key value to an attribute allows the record associated with the attribute to get updated. If an attribute is not assigned a key value, the record is not updated; a new record is created with the updated data that pertains to the attribute. Important: If an attribute or link is created in the child of an abstract dataset, any attribute or link of the same name created in another child of the same abstract parent must also have the same type, key, and required settings.
   Required	Select the Required checkbox if the information related to this attribute is required, as opposed to optional. For example, when creating a user in the Web Console, the "login" attribute is marked as Required in the Users Dataset, and therefore, to add a user to the system, you must configure a login for the user.The system displays an error message if it is not provided. Conversely, the "email" attribute in the Users Dataset is not marked as Required, and therefore, you can add a user the system with or without an email address in the configuration. Important: If an attribute or link is created in the child of an Abstract Dataset, any attribute or link of the same name created in another child of the same abstract parent must also have the same type, key, and required settings.
   Index	Select this checkbox to create a custom index on the new attribute. This option is not available for attributes that are the only key attributes for a dataset, as they are indexed by design. However, creating a custom index on an attribute that is part of a composite key for a dataset is available. Warning: Creating indexes can improve performance but can also adversely affect performance. Vocera provided solutions packages have the proper attributes already indexed. Adding indexes should be tested in a secondary environment to ensure no workflows are adversely affected.Vocera recommends that you consult with Customer Support before
   Admin Viewable	Select this checkbox to display the attribute in the Vocera Platform Web Console user interface. System administrators can configure the custom attributes for Users, Groups, and Devices in the system. For more information on creating custom options for Users, Groups, and Device, refer to the following: Creating Custom Options for Users Creating Custom Options for Groups Creating Custom Options for Devices
   Additional Settings	Add attribute transformations as part of the Additional Settings. Transformation is a regular expression (Regex) string that describes a unique search pattern. Transformation to implement a search pattern on incoming HL7 message. An HL7 message is a hierarchical structure associated with a trigger event. The HL7 standard define trigger a trigger even as an event in the real world of health care that creates the need for data to flow among system.

   The following screenshot displays the attriubute, "Custom1" created for Users in the system.

   

6. Select one of the following:
   • Add — to save the new attribute you created for the Dataset.

     If Add is selected and all field information is correct, a success message displays at the top of the dataset form. The Dataset page displays the new attribute in the Attributes list.

     

   • Cancel — to return to the selected Dataset's page without saving your changes.