Custom form templates

OpenIAM provides the ability to create custom form templates to capture user information. The section below describes how the forms can be created and then associated with a URL. In this way a single template can be used to capture user information in a consistent manner across operations.

Out-of-the-box templates are provided as there are pages within OpenIAM that are based on these templates:

  • Default Role Template. Create a new role and edit an existing role.
  • Default Group Template. Create a new group and edit an existing group.
  • User template for content provider name. Create a new user and edit existing users. Note that in previous versions of OpenIAM this template was called Default Template for content provider name .
  • Templates for various managed systems. Create a new managed system and edit an existing managed system.

You can modify existing default templates or create new ones.

  1. Begin by selecting Administration from the top-menu, and then select Page Template as shown below:

Select Page Template

  1. Choose Create New Template on the next screen.

Create New Template

  1. You will now begin creating your custom user template. For this example, we will design a template to capture fields for faculty at a university. Please take note of the following fields:
  • Template Name: The label for your new user template.
  • Template Type: Choose User Page Template.
  • Metadata Grouping and Metadata Type Name are for organizational purposes.

Faculty User Template

Click Save after completing the fields.

  1. The next section allows you to add fields to the template which are used to collect specific details about the user:

Template Fields

From the drop-down menu labeled Select Field Type, choose the field you wish to add to the template and click Add to list, located to the right of the drop-down. To create new fields, please visit the section on Creating custom fields.

Next, we can assign rules to individual fields to make the page dynamic. Under the Actions column, click on the pencil icon of the corresponding field you wish to edit. On the pop-up window, click the plus sign to the right of the Actions label. Under Rule, you can choose an option from the drop-down menu to assign a rule to the field. The rules available include:

  • Hide: Make the field invisible.
  • Show: Make the field visible.
  • Disable: Make the field read-only.
  • Enable: Make the field editable.
  • Set required: The field cannot be empty.
  • Set not required: The field is optional.

Click the plus sign to right of Rule to add a condition to the rule. Click the plus sign to the right of Actions to add additional rules to the field.

As an example, we can mark the Department field to be read-only (not editable) by using the Actions feature to set the field to Disable, as shown in the screenshot below.

Field Action

Click Save to commit your changes.

  1. We can add our new user template to URIs in OpenIAM that support user creation:

URI Patterns

Begin by typing in the name of the URI pattern into the text field, and click Search on the right hand side. Next, choose the URI you wish to add the user template to.

Search URI Patterns

Finally, click Save. Now when we go to create a new faculty user within OpenIAM, we can see the customizations we've just created.

Faculty template