Skip to main content

NIM

Configure Onboarding

Requirements
  • Internal System

  • Target System to Provision (e.g. Active Directory, Google Workspace, ...)

  • User Data for Questions/Answers

Setting up Onboarding Table

Before we can configure the Onboarding profile, you need to configure the Onboarding table to store user data

  1. Click Internal System, check the "Onboarding" table

    OnboardingTable01.png
  2. Open onboarding table, click Columns

  3. Check Key for the ID column

    OnboardingTable02.png
  4. Next, a relationship need to be created between the Onboarding Table and the target system table. In this case AD > Users. See Inter-system relations for more on this

    OnboardingTable03.png
Preparing User Data

You will need to a couple of filters to create records into the internal onboarding table. These filters will provide answer data (e.g. Birth Date, Birth Place, Phone Number) and decide who should be provisioned. Additionally, we recommend including a personal email address so the user can be notified by email.

  1. Create a new filter and name it according (e.g. Onboarding_Employee_Create). Add additional attributes as needed to refine your results

    OnboardingPreparingUserData01.png
  2. Create 2 script columns within this filter: onboardExpires and secureID. You can name them whatever makes sense to you, but for consistency’s sake, we will label them as such

    1. onboardExpires - Generates a timestamp in milliseconds for the onboarding profile to use as an expiration date. Adjust the number of days you want the profile to be accessible by changing the “7” to the number of days needed.

      OnboardingPreparingUserData02.png
    2. secureID - Generates the unique secure ID that will be used for each users onboarding profile

      OnboardingPreparingUserData03.png
  3. Create a new filter and name it accordingly (e.g. OnboardingQuestionAnswer). This will be used to generate the variables for the answers to your security questions and the mapping in your Onboarding Profile. This will be a parameter-based filter for the ExternalID in the onboarding table.

    OnboardingPreparingUserData05.png
Provisioning Onboarding Records

The filter data we created now needs to be used to create onboarding records

  1. Create a new mapping

  2. Use the Create filter and add these attributes, but you will have to come back to this mapping after you create the Profile in the Onboarding Profiles section.

    OnboardingProvision01.png
  3. Create a new Job

  4. Under Configuration tab, add a new CRUD task and select the mapping you just created

  5. Under Execution, Evaluate and Run

  6. You should now have Onboarding records provisioned

Managing Onboarding Profile

The onboarding profile contains the settings and configurations that tie each component together and define how they interact.

  1. Go to Configuration > Onboarding

  2. Create an onboarding profile by clicking Add

  3. These are the profile settings that would be used for the enableAccount profile in this example. Each profile needs to have a form function for each form within the app.

    1. Under Onboarding app, select Onboarding

    2. Under Question-answer filter, select your filter with the Questions and Answers

    3. Select message for the remaining two drop downs on the right

  4. Each form on the configuration page needs to be updated to fit the answers you choose as an Onboard Variable. In this example, there are 4 security questions that will be included in the onboarding process, along with the welcome, registration, password, and summary forms. Depending on the level of security you desire, you can update the number of question/answer forms, but the other 4 forms are required

    1. Under the Form Variable column, select the drop down option vAnswer.

    2. Create a variable name for that vAnswer in Onboard Variable column

    3. In the Answer Column, choose the attribute from your QuestionAnswer filter that you would like to use as your answer to the question you just set. In this example, we are using first name so we would set the Answer Column attribute to match

  5. In Form Contents in the bottom section of the configuration page of the form you’re creating or editing, you will need to update the input.label, input.placeholder, and info fields. Label and placeholder are title fields, you can match those to the question. The info field is a description field for the question, giving instructions on any specifics of how to answer the question properly, such as date formats as shown here.

  6. The action variables page will show the output of the QuestionAnswer filter. To give the proper naming conventions, you can select the play button on the right of the variable name to autofill. If you choose to autofill instead of putting in your own variable name, make sure it matches what you set as the Onboard Variable name in the previous configuration page. For consistencies sake, choose easy to understand names and include the prefixes included by default with the autofill feature.

  7. Onboarding actions are similar to mappings for filters in their function

    1. Add a new action by selecting the Add at the top right

    2. Select the system, likely Active Directory.

    3. Select the UserUpdate function

    4. Map what variables you’ve created in the configuration and action variables pages to their corresponding AD attribute. In this case, you will need the objectGUID, accountPassword, and Enabled set to true to allow the user to claim their account

    5. Select Generate Notification Event if you want to receive a notification the account was claimed

  8. In the settings page, all of the time values are shown in minutes and can be updated to meet your needs.

  9. The Validation page is similar to the NIM validation. If there are any errors, this will tell you where and what they are to begin troubleshooting. Once you’ve completed these steps, return to the Mappings section and add the Onboarding Profile you just created to the Profile attribute in the Create mapping

  10. For a user to receive the email invitation with their secure link, you need to create the Event Template. You will also create a template for the onboarding summary with the details of their new account, which may include the password and login name they’ve just created or other details you might want to send after the account is successfully claimed

    1. Create the template

    2. Create an event for the mapping you created earlier