Custom attributes

Custom attributes can be used by Administrators to define additional data fields within Janison Insights. These fields can be linked to objects in the system to control where they are displayed. The fields can then be used to filter, sort, search and report on these objects. Custom attributes can also be grouped into sets.

Custom Attribute Type	Description
Boolean	Used to allow selection of  ‘true’ or ‘false’ values. The required options are displayed as checkboxes with labels. If the checkbox is selected by the end user, the value is ‘true’. If not selected, the value is ‘false’. Example, adding a checkbox to the New User screen:
Custom View	Allows custom pages to be accessed from a specified location in Janison Insights. A custom view can also serve as a data store for information from custom pages by allowing forms to display and the storage of user responses.Example: A custom view button that displays when an Author is creating a catalogue item, allowing the Author to complete tasks on the related custom page: Tip A custom page can be built to fulfil many purposes and must be built before it can be used to create a custom view attribute. Generally a Janison developer will build the custom page. Please contact the Janison customer services team for more information.
Date	Used to add a date field to a system object. The end user selects the field and then chooses a date from a date picker.Example:
Date Time	Used to add a date and time field to a system object. The end user selects the field and then chooses a date from a date picker and a time from a time picker.Example:
Float	Used to add a text entry field that accepts whole numbers and floating-point numbers (those containing a decimal point) to a system object. Lower and/or upper limits can be set to only allow entry of a number within the range. Any specified lower or upper limit is included within the allowable range. The number of decimal places the entered number is rounded to can be specified. Example: Adding a float text entry field:
Image	Used to add an image upload field to a system object. The following image files are supported: .jpg .png .gif End users select the Select file button and then browse their folders to choose an image to upload. When the image is uploaded, it is displayed and the file name listed.
Integer	Used to add a text entry field that accepts whole numbers to a system object. Lower and/or upper limits can be set to only allow entry of a number within the range. Any specified lower or upper limit is included within the allowable range. Example: Adding an integer text entry field, with a lower limit of 2 and upper limit of 5:
List	Used to add a drop-down list to a system object. Each list element can have a name, an identifier and a value associated with it.Example, adding a list drop-down field to the New User screen:
Memo	Used to add a free text entry field to a system object. Similar to a ‘string’ custom attribute, but  provides a larger text entry area. The memo can be set to: A plain text field with no word limit. For example: A rich text field with the options to set a word limit and add default text to be shown to end users in the field. This type of field allows the end user to format their entered text. For example:
Selection	Used to add a selection drop-down list to a system object. Similar to a list custom attribute, but without the option for having an identifier or value per list element.Example: Adding a selection drop-down list to the New User screen:
Selection with other	Used to add a drop-down list with an additional ‘Other’ text entry field to a system object. Essentially the same as a selection custom attribute as shown above, but allows end users to select the ‘Other’ element and enter text to create their own element.Example: Adding a selection with other drop-down list to the New User screen. If none of the elements suit, the user selects Other from the drop-down field: Then enters the required text in the field that displays:
Selection from system entity	Used to add a drop-down containing a list of system entities to a system object. The system will create the list based on the settings selected when the custom attribute is created.Example: Adding an Organisation Unit drop-down list to the User screen:
String	Used to add a free text entry field to system object. The text can be restricted by length or a regular expression as needed. This type of custom attribute is used for the majority of metadata fields.Example: Adding a free text entry field to the New User screen: Tip A regular expression (sometimes shortened to ‘regex’ or ‘regexp’), is a sequence of characters that define a pattern. More details about regular expressions can be found on the Regular-Expressions.info website.

Add a custom attribute

Custom attributes are created by following three main steps:

1. Choose to create a custom attribute and set main settings. This step is the same when creating any custom attribute.
2. Select the type of custom attribute you want to create and complete further setup steps relevant to the selected type. Refer to the section on Custom attributes for information about each type of custom attribute and how they are used by the end user.
3. Link the custom attribute to the required system object(s) to set where it will display.
   

   Tip

   Custom attributes cannot be directly linked to catalogue items, tests, test sections or questions. Instead, a custom attribute set must be created and linked to a discipline.

   Custom attributes can be linked to other objects such as new user creation, schools or assessment events.

To create a custom attribute:

1. Navigate to Settings > Custom Attributes.
2. The Custom Attributes screen displays. Select the Actions drop-down and then select Add Custom Attribute.
   
   
3. The New Custom Attributes screen displays. Complete the following information:
   
   1. Enter a name for the custom attribute in the Name field.
   2. The Identifier field populates automatically, based on the name you entered above.
   3. Enter a description of the custom attribute in the Description field (optional).
   4. Enter text to serve as a hint in the Hint Text field (optional). This will not be displayed to end users.
   5. Select the Inactive checkbox to deactivate the custom attribute (optional).
      • When creating a custom attribute, this option may be useful if you do not want the attribute to be active in the system straight away.
      • This option is also used to stop a custom attribute from displaying in the system. It is recommended that custom attributes are set to inactive rather than being deleted.
      

   Next you will need to select a type for the new custom attribute.

   Tip

   For more information on each type of custom attribute and how they display to end users, see to the Custom attributes section.

   There are further steps to complete when creating each type of custom attribute. Refer to the required custom attribute below for full details.

Add a custom attribute set

Custom attributes assigned to the Users system object can be set to allow batch edits. This allows the same change to be made in a custom attribute field across one or more Users at the same time.

In the following example, we show how batch edit can be used to add first aid certification to a group of users.

To assign custom attribute values via batch edit:

1. First you will need to create a string custom attribute and link it to the Users system object. For more details on creating a custom attribute, see the Add a custom attribute section.
   
   
2. Next you will need to activate the batch edit option for the string custom attribute. To do this:
   
   1. Navigate to Settings > User Settings in the Menu.
   2. On the User Settings screen, select the List View expandable section.
   3. Select the Batch Edit checkbox next to the required string custom attribute.
      
      
   4. Select Save Settings.
3. You will now be able to action the batch edit for the string custom attribute in the list of Users on the Users screen. To do this:
   
   1. Navigate to People > Users in the Menu.
   2. On the Users screen, select the checkbox next to each required User in the list.
   3. Select the button matching the string custom attribute you created. For example Set First Aid Certification Status.
      
      
   4. A popup displays. Enter the required value in the field and then select Ok.
      
      
   5. Select the name of one of the Users for which you just updated the string custom attribute value. The updated value is now shown on the User screen. For example:
      
      

Assign custom attributes values to Users

Custom attributes can be grouped into sets, which can be linked to disciplines. Creating disciplines is currently completed by the Janison Implementation Team.

Custom attributes must be created before they can be added to a set. For information about each type of custom attribute and how to create them, refer to the Custom attributes and Add a custom attribute sections.

To create a custom attribute set:

1. Navigate to Settings > Custom Attributes.
2. The Custom Attributes screen displays. Select the Actions drop-down and then select Add Custom Attribute Set.
   
   
3. The New Custom Attribute Sets screen displays. Complete the following details for the new custom attribute set:
   
   1. Enter a name for the custom attribute set in the Name field.
   2. The Identifier field populates automatically, based on the name you entered above.
   3. Enter a description of the custom attribute set in the Description field (optional).
   4. Enter text to serve as a hint in the Hint Text field (optional). This will not be displayed to end users.
   5. Select the Inactive checkbox to deactivate the custom attribute set (optional).
      • When creating a custom attribute set, this option may be useful if you do not want the attribute set to be active in the system straight away.
      • This option is also used to stop a custom attribute set from displaying in the system. It is recommended that custom attribute sets are set to inactive rather than being deleted.
      
4. Next you will need to add the required custom attributes to the set in the Custom Attributes section. For each custom attribute to be added:
   
   1. Select the custom attribute from the Select Custom Attribute drop-down field and then select the + button.
      
      
   2. The custom attribute displays in the list.
      
      
   3. Enter a caption to be shown next to the custom attribute field in the Caption field (optional).
   4. Enter an explanation of the custom attribute field in the Hint Text field (optional). Any text entered here will be shown as a hint when the end user hovers over the Hint question mark icon next to the custom attribute. If no hint text is provided, the Hint icon will not display.
   5. Select the Mandatory checkbox next to a custom attribute to set it as an item that must be completed (optional).
   6. Select the Inactive checkbox next to a custom attribute to stop it from displaying to end users in the custom attribute set (optional).
      
      
5. When all the required custom attributes have been added, ensure the order of the custom attributes matches how you would like the set to display to end users.
   • Select and drag the Move icon to move an element up or down the list. This changes the order elements will be displayed in the list for end users.
     
     
   • To remove a custom attribute from the set, select the Remove icon next to it.
     
     
6. Select Save Custom Attribute Set.