Onboarding Link
In previous guides, we talked about how policies can be used to determine the required forms of a placement. We also talked about how you can create tasks based on the required forms. Once you have created tasks, you want to bring your candidates to the Onboarded candidate form experience so that they can complete the tasks. This is done by generating an onboarding link and sending it to your candidates.
Onboarding links can be generated via both Onboarded Dashboard and API.
API
To generate an onboarding links via the API, call GET /api/v1/employees/{id}/onboarding with the employee ID. By default, all tasks of the employee will be included in the link. If you want to only include specific tasks, you can specify the tasks via the task_ids parameter.
Form Sequence
When task_ids are provided, candidate will see forms in the sequence specified in task_ids. If task_ids is not provided, forms are displayed in account default sequence. You can manage the account default sequence in the Form Sequence view:
Dashboard
To generate an onboarding link from the Onboarded Dashboard, first go to the employee details view. Click on "Create Link" in the top-right corner as shown below.
The onboarding link panel now lists all tasks of the employee that can be included into the link. By default, all tasks are selected. Uncheck any task to exclude it from the link.
Form Sequence
When creating an onboarding link, tasks are by default displayed in the onboarding link panel based on your account's default from sequence. You can adjust the task sequence for each link by dragging the tasks up and down.
To change the account default sequence, go to the Form Sequence view.
When creating an onboarding links via the API, if task_ids is not set, the form sequence is dynamically determined based on account default form sequence at the time candidates visit the link. This means if you change the account default form sequence, the new sequence will apply if candidates open their links after the change.
However, when creating onboarding links via Onboarded Dashboard, the included tasks, as well as form sequence, is always determined at the time a link is generated. In other words, changing account default form sequence after a link has been created from the dashboard will not affect its form sequence. Furthermore, any new tasks added to the employee after a link is created will not be included in the link. To include new tasks in the link, you must create a new link.
Other Considerations
- Account default form sequence is designed to control form sequence in onboarding links. Therefore, forms are not displayed based on the default sequence in views that are unrelated to onboarding links. For example, when required forms are displayed for a placement in the Onboarded Dashboard, they are not displayed based on account default form sequence. Similarly, account default form sequence does not affect the way forms are listed in the "Active/Manage Forms" tables.