Custom Attributes

Benefits

ZenGRC custom attributes allow additional functionality and flexibility within the application. These are fields that users create themselves to supplement "out-of-the-box" selections for gathering information pertinent to an organization.

Overview

You can create the following types of custom attributes:

• Dropdown - Provides multiple-choice selections.
• Date - Adds a date picker.
• Checkbox - Displays a dropdown with yes/no selections only.
• Number - Allows an integer to be entered. This also has an option for decimal places.
• Text - Provides a text box.
• Rich Text - Adds a text box with formatting and hyperlink options.
• Map:person - Pulls names from your directory to display for selection.

Accessing Custom Attributes

To access the custom attribute module, complete the following steps:

1. Click Settings | Custom Attributes.
   
   

Creating a Custom Attribute

To create a custom attribute, access the Custom Attribute module and complete the following steps:

1. In the top, right-hand corner, click Create new | object type.
   
   

   TIP

   In place of object type, select the ZenGRC form where the new custom field will display. For example, if the field is to be added to an assessment, select Assessment in the dropdown. Once created, the new field will display on all current and new assessments.

   
   
   
   

2. A dialog box displays with custom attribute fields.

3. Click the dropdown under Attribute type and select the field format.
   
   
   
   

   NOTE

   For descriptions of each attribute type, please see Attribute Types.

4. Add a heading in the Title text box. This is the only required field.

5. Select Mandatory to make the field required.
   
   

   TIP

   By selecting Mandatory, the user will not be able to save the form until the information for the custom attribute is added.

   
   
   

6. Complete any fields specific to the attribute type selected and click Save.

7. Alternatively, click Cancel to close the dialog box without saving.
   
   

   NOTE

   The fields displayed for a custom attribute vary depending on the type selected. For more information, please see How Attribute Types Display and Additional Field Types.

How Attribute Types Display

This section provides information and screenshots on how the attribute types display to the end user completing the form.

Text

The Text box allows for entering text with no additional formatting.

Rich Text

A Rich Text box allows for formatting text and adding hyperlinks.

Date

The Date box opens a date selector.

Number

The Number attribute only allows an integer to be entered in the text box. In the set up, you can also specify if the answer can have a decimal point.

Checkbox

A Checkbox field allows the user to select Yes or No.

Dropdown

The Dropdown allows the user to select a choice from customized text you provide.

Multi choice

Selecting the Multi choice check box when setting up the dropdown allows the user to add more than one choice. The first selection displays in the text box and allows you to click the dropdown again to add others. Alternatively, you can remove selections by clicking the x.

Map:person

The map:person field provides a dropdown populated with your ZenGRC users.

Additional Field Types

These field types display when you select certain attribute types. This section describes how to create them and how they display to the end user.

Help Text

Completing the Help text box creates a question mark icon next to the custom attribute. When a user hovers over the icon, information you enter in the Help text box displays.

Complete the following:

1. When creating the attribute, add details the user may find helpful in the Help text box.
   
   
   
   
2. Click Save and the final result displays to the end user as shown below:
   
   

Placeholder

The Placeholder provides further instruction within the text box or text field you're creating.

Complete the following:

1. When creating the attribute, use the Placeholder field to explain information users need to enter.
   
   
   
   
2. Click Save and the final result displays to the end user as shown below:
   
   

Rearranging Custom Attribute Fields

After custom attributes are created, they are displayed in the order in which they were made. However, they can be rearranged to display in a different order to end users. Note that the re-ordering impacts only the view/edit screen for an existing object; it doesn't impact the form that displays when a new item is initially created.

The following describes overall actions for this feature:

• Drag-and-drop functionality
• Field resizing
• Section headers
• Separate organization for each item
• Applies only to the Details tab of each item

Accessing the Configuration Layout 

Each item's custom attributes can be configured separately. For example, if you have 12 custom attributes for assessments, they can be arranged by clicking the cog wheel above the Assessments section on the Custom Attributes home page.

To customize the arrangement of custom attributes, complete the following:

1. Click Settings | Custom Attributes in the left-hand navigation.
2. Click the cog wheel above the appropriate item.
3. The page displays with all custom attributes for that item.

Creating and Deleting Section Headers

To create a section heading, complete the following:

1. Click Add a Section.
   
   
   
   
2. Click the pencil beside the newly created label.
3. Add the heading.
4. Click Enter or click out of the label to save.
5. Alternatively, to delete a section heading, click the x within the label. There is no prompt asking whether you're committed to the action prior to deletion.

Moving an Attribute or Section Header

To move an attribute or section, complete the following:

1. Place your cursor over the item.
2. Click and drag to the appropriate location.
   
   

Changing the Size of a Custom Attribute

The size of all custom attributes can be changed. However, sizes snap into place within the columnar grid.

To change the size of a custom attribute, complete the following:

1. Click the lower, right corner of the custom attribute.
2. Pull it down to make it longer or right to make it wider.
3. Alternatively, click the lower, right corner and drag up or left to minimize the field.
   
   

Saving and Resetting Changes

To save your progress, complete the following steps:

1. Click Save to keep the window open, or click Save & Close to close the window after saving.
2. Reset changes made in the current editing session by clicking Reset last saved changes. 
3. Alternatively, click the X in the top, right to close the window without committing changes.

Previewing Custom Attribute Changes

Previewing updates made to the custom attributes form can only be done after saving.

To review changes complete the following:

1. After altering the form, click Save. This keeps the window open.
   
   
   
   
2. Above the save buttons, click the linked text, which opens the object you're editing in a new tab.
3. Click any of the custom attributes to view updates.

Deleting Custom Attributes

You cannot change custom attribute types after they are created, but you can delete a customer attribute and replace it with a new one. To delete a customer attribute:

1. Navigate to Settings > Custom Attributes
2. Select the checkbox to the left of the attribute you want to delete
3. At the top of the page (scroll up!) a red “delete” button will appear, click it and confirm deletion

Note: if you have any content in this attribute, it will be deleted. If you need to change the content over to your new attribute, best practice is to create the new attribute, move the content over (manually or via import) and then use the steps above to delete the old attribute.