Activation form
Use the activation form to have users enter data when they activate the playbook.
You can define a form with one or more fields. You can define whether each field must be
completed or not. You can also define placeholder values and tooltip text to assist the user.
- In Form element type, choose the type of field that appears when a user
activates the playbook or sub-playbook.
The types are the same types that you chose when you created the incident layouts.
- In Input field label, enter a name for the field. Make the name
meaningful to the user who activates the playbook or sub-playbook.
The API name field is automatically populated with the same name as the field name but with underscores for spaces. You can change the API name to meet the need of your app developers, although it is not usually done.
- In Requirement, select whether the user must enter a value or leave it blank.
- Optional. The user does not needs to enter a value.
- Always. The user must enter a value.
- In Tooltip, you can enter descriptive but brief text that would help the
user understand what is needed.
The user can see the text when they hover the mouse over the tooltip icon. You do not need to enter a tooltip.
- In Placeholder value, if needed, enter a value that is shown in the field. The value can be a common entry or a value that helps the user to determine what data is needed.
- Click Add form element.
The field as you configured it displays in the Activation form section of the screen.
- Repeat these steps to define extra fields.
- Drag the fields so that they are in the order you that want to analyst to see them.
- When you are finished, click Done.
The following video shows how to create a manually triggered playbook with an activation form.