How to manage onboarding actions?
This page describes how to customize actions defined in the onboarding stages. If you don't know yet what are onboarding actions, please read the documentation first.
Before you begin
In this article
Manage actions for a given onboarding stage from the stage's page:
- Go to the Manage page
- Click on the Partner onboarding item
- Select the onboarding pipeline you'd like to edit
- Click on the stage you'd like to edit:
Add action
From the onboarding stage's page:
- Click the Add action button on the top-right corner
- Choose the right type of action (different types of actions)
Then you need to fill in the form. It is specific to each action type. The common fields are:
| Field | Description |
|---|---|
| Title | This is the title of the action. It is visible to partners. Make sure to choose a clear and concise title so partners understand the purpose of the action. |
| Description | Provide additional information about what is expected from partners. It is visible to partners on their partner portal when they complete the action. |
Finally, click the Add button to save the new action.
Action-specific fields
View asset
Click the Add asset button to choose the asset partners must view. It can be a file, a URL, or even a folder.
Asset permissions
It's up to you to make sure you select an asset that will be accessible/visible to partners. If access to the selected asset is restricted, some of your partners may not be able to complete this action.
Read article
Click the Add article button to choose the article partners must read.
Article permissions
It's up to you to make sure you select an article that will be accessible/visible to partners. If access to the selected article is restricted, some of your partners may not be able to complete this action.
Provide information
Open the Add field dropdown and select a property to be included in the form partners will have to fill in:
Those are partner custom properties. You can add more properties to this list following the instructions here: How to customize properties?
Then you can:
- Mark fields required so partners must provide information (1)
- Re-order fields to make sure they appear in the correct order to partners (2)
- Remove fields from the form
Upload document
Simply specify the name (title) of the document to be uploaded in the Document title field.
Understand the impacts of adding actions in the section below.
Edit action
From the onboarding stage's page, click on the Edit button on the action you'd like to edit:
Then for all types of actions, you can:
- Change the title to rename the action
- Change the description
And depending on the type of action you can:
- Change the asset (for View asset actions)
- Change the article (for Read article actions)
- Edit fields (for Provide information actions)
- Rename the uploaded document (for Upload document actions)
Understand the impacts of editing actions in the section below.
Delete action
From the onboarding stage's page, click on the Delete button on the action you'd like to edit:
Understand the impacts of removing actions in the section below.
Re-order actions
The order you see actions from the onboarding stage's page is the order they are shown to partners.
From the onboarding stage's page, click on the drag handle on the action you'd like to re-order and drop it wherever it suits you:
Impacts on existing partners
When adding, editing, or deleting actions from an existing onboarding stage it may impact partners currently in the same onboarding pipeline.
For all partners who already completed the stage where actions are modified, modifications won't be visible to them.
Examples:
- If you add a new action in the first stage of your onboarding pipeline and some partners already completed it, they won't be required to complete the new action.
- If you edit an action, for instance, change the article from the Help Center used to train new partners, they won't be required to read the new article.
For all partners who haven't completed the stage yet, regardless if they completed some of the actions required in this stage or none of them, the new modifications will be visible.
Example:
- If you add a new action to the last stage of your onboarding pipeline, all partners who haven't reached this stage yet will see the action and will have to complete it. It's particularly handy if you want to adjust the onboarding process for all partners.
Next step