Collect Additional Information During Onboarding
NIM Onboarding
Collect information a new user knows best—such as a preferred name, personal phone number, start date, or home address—and use it in the final onboarding action.
Add an input form after identity verification and before the form that activates the account. NIM keeps the submitted value available to the onboarding action, where you can write it to an approved target-system attribute or use it in another controlled action.
This guide extends an existing profile. If you have not prepared user data, a profile, onboarding actions, and notifications, start with Build a Secure Onboarding Experience.
Plan the information you collectDirect link to Plan the information you collect
Collect only information that is necessary for the onboarding outcome and has a defined destination.
| Example | Recommended form type | Example target use |
|---|---|---|
| Preferred name or office location | InputVariable | Write to an approved directory or HR attribute. |
| Personal mobile number | InputPhone | Validate the format before saving it to an approved contact field. |
| Start date or other date | An installed date-input form | Use in an action or an approved downstream workflow. |
Do not use QuestionText or QuestionDate merely to collect extra details; those forms are intended for identity-verification challenges. Use the input form provided by your installed Onboarding App whenever possible.
1. Add an input form to the profileDirect link to 1. Add an input form to the profile
-
Open Configuration → Onboarding, then select the profile you want to extend.
-
On the Configuration tab, select Add in Onboarding profile forms.
-
Select InputVariable, InputPhone, or another input form provided by your installed Onboarding App.
Missing input formsIf the needed form is not available in the Form Name list, install the current NIM Onboarding App package, then return to the profile.
-
Set the Form Variable and Onboard Variable that will carry the value into the onboarding action. Use names that identify the data clearly, such as
vPreferredName. -
Position the form after Confirm when the profile uses OTP verification, or after the final identity challenge when it uses questions. Place it before the form with Execute selected—normally Password.
2. Design the user-facing questionDirect link to 2. Design the user-facing question
- Select the new form in Onboarding profile forms.
- Under Form contents, replace the default prompt, label, help text, and placeholder with wording that explains why the information is needed.
- Preview the form with the play button, then save the profile.
Use a specific prompt, such as “Enter the name you want colleagues to see,” rather than a generic “Provide more information.” Describe required formats and whether a value is optional.
3. Use the value in an onboarding actionDirect link to 3. Use the value in an onboarding action
- In the same profile, open Onboarding Actions.
- Select the target-system action that should receive the value, or add one and configure its required account identifier first.
- Under Action specification, select the target attribute.
- Set Value Source to variable, then select the onboarding variable created for the input form. For example, a form may expose a value such as
voAnswerQuestion1in the action’s variable list. - Save the action and profile.
Verify that the target attribute is appropriate for end-user input and that the selected form validates the expected format. Test with a dedicated account before allowing real users to submit values that change directory, HR, or other system records.
4. Test the complete pathDirect link to 4. Test the complete path
- Use a safe onboarding record and complete the verification step.
- Enter a recognizable test value in the new form.
- Finish the password and activation steps.
- Confirm the expected target-system attribute contains the submitted value and no unrelated attributes changed.
Related guidanceDirect link to Related guidance
Build the onboarding journey
Set up the data, profile, activation actions, notifications, and test plan first.
Use one-time passcodes
Verify identity through personal email or SMS before showing extra input forms.
Configure onboarding actions
Review the action-variable setup that targets the user’s prepared account.