Skip to main content

Open registration

Users must log in to access your application (unless you have made pages public). You can add new users to your application by sending them an email invitation. Alternatively, you can enable open registration so that new users can create accounts without first being invited.

You can enable open registration for different authentication options, including signing in with a Google or Microsoft account. Open registration is useful when you want to allow:

  • Anyone to be able to create an account in your application.
  • Users to log in via a customer's SSO.
  • All members of a particular organization to be able to log in when you don't have a list of all users or you do not want to send invitations.

When open registration is enabled, visitors to any of your application's non-public pages are redirected to the XXID login page. If the user selects an authentication option for which open registration has been enabled and they do not already have an XXID account, then a new account is created. When the user accesses your application, a new User case is created using their email address and/or any other details provided by the authentication provider.

Tip:

For more information about XXID, including how to enable additional security measures or change the styling of the login page, see XXID.

Enable open registration from My Grexx​

You can use My Grexx to enable open registration for a particular DTAP environment. You can only enable open registration using an existing Google or Microsoft account, or the user's email address and password.

To enable open registration:

  1. Open My Grexx and select the Settings page.
  2. Navigate to Advanced Settings > Open registration is allowed and edit the value for the relevant DTAP environment(s). The Set open registration form is displayed.
  3. Enable Allow open registration.
  4. In the Registration providers field, enter the relevant value(s): google, microsoft, and/or username/password.
  5. Click Submit. The Open registration settings are updated for the selected environment.
  6. From your Studio, click the "compile" icon to apply the changes from My Grexx to your application, and then promote the changes to Testing, Acceptance, or Production as required.
Note:

It is not currently possible to enable open registration from your Studio using the options under Settings > Platform settings.

Collect additional user details​

When a new User case is created via open registration, basic details (such as the user's email address) are provided by the authentication provider. You may want to ask new users to provide additional information (such as their display name or locale) as part of the onboarding process. You can do this by redirecting the user to a page that displays a form activity after they sign up.

For example, you can add a form activity to the User casetype and display it on a page using an activity widget and custom dataset:

  1. Create the form activity on the User casetype so that new users can view and update their details.
    1. Ensure the form contains the attributes that you want the user to be able to view and edit.
    2. Grant Execute rights to the Profile owner platform role.
  2. From the User casetype open the Start user activity and select the When done stage. Add an Execute trigger for the new form activity. This ensures that the form activity will be generated as a mandatory task each time a new user is created.
  3. Create a dataset that identifies mandatory tasks on the current user:
    1. Base the dataset on the Mandatory tasks on platform without right check dataset.
    2. Add a column for Task metadata > Case ID. This identifies the case to which the task belongs.
    3. Add a column for Activity metadata > ID. This identifies the activity on which the task is based.
    4. Add a condition that compares the Task case ID column to the current user's case ID (using the user.Current user template function). This ensures the dataset only returns tasks on the current user.
    5. Optionally add a second condition to return only tasks based on the form activity.
  4. Create a new page casetype to use as the landing page for users that have signed up via open registration.
    1. Edit the view for the page casetype and add an activity widget.
    2. From the Activity picklist, select the form activity that you added to the User casetype.
    3. From the Task dataset picklist, select the dataset that identifies tasks on the current user.
    4. Grant rights to view the widget to authenticated users.
    5. Add other widgets to the view as required. For example, you may want to use a template widget to display some additional text or images.
  5. From the User casetype, open the Start user activity. Add a mapping to change the newly created user's landing page to the page containing the activity widget:
    1. From the activity designer, select the When done stage and add a mapping.
    2. Set the mapping To attribute type to Casedata and then select Landing page.
    3. Set the mapping From attribute type to Inline template and then enter page. and select the relevant page casetype.
  6. Return to the form activity that you created in the first step, and use a mapping to change the user's landing page back to the homepage (or another page) so that once they have updated their details they are not asked to check them again:
    1. From the activity designer, select the When done stage and add a mapping.
    2. Set the mapping To attribute type to Casedata and then select Landing page.
    3. Set the mapping From attribute type to Inline template and then use the page. template function to specify the landing page that the user will be redirected to each time they log in.

For more information about form activities, see Edit case details. For more information about template functions, see Standard template functions.

Tip:

You can use the user.user-session template function to retrieve additional information such as the user's locale, and any claims from the authentication provider. To populate the attributes on the User case with these values, add mappings to the When done stage of the Start user activity. By default, the activity form is populated with any existing values so that the user can view and edit them.

Add new users to roles​

You may want to add users that have signed up via open registration to a platform role. For example, you might create a Guest user platform role so that you can grant users rights to view widgets and navigation items on the main pages in your application.

To add users to a platform role when a user has created an account via open registration:

  1. Create a page casetype (or use an existing User management page or similar) and add a multivalue attribute to store the case IDs of users that you want to add to the role.
  2. Create the role name and associated platform role, and link it to the page and attribute. For more information, see Configure user roles.
  3. Add a form activity to the page casetype to edit the platform role attribute.
  4. Trigger the form activity from the Start user activity:
    1. From the User casetype, open the Start user activity and select the When done stage.
    2. Add an Execute and submit trigger, set the activity To type to Page, and then select the relevant page and form activity.
    3. Add a mapping to the On start stage of the trigger.
    4. Set the mapping From attribute type to Case metadata and then select Case ID. This identifies the case ID of the new User case.
    5. Set the mapping To attribute type to Task in and then select the form field for the platform attribute.

Each time a new user is added, the user will be added to the attribute on the page, and therefore to the platform role.