Collects inputs from a user during a playbook run to use later in the playbook.

Important: As of the 26.1 release, the Collect user data activity is no longer available in the activity picker. The activity will continue to function wherever it is used, but for new activities use the Questionnaire activity instead. The Questionnaire activity does not require you to create a data definition. To learn more about the Questionnaire activity, see Questionnaire activity.
Use the Collect User Data activity if:
  • You don't have a table already,
  • You don't need to run reports on the collected data,
  • And you don't need to use the data outside of the playbook.
If you already have a table to store the collected data, use the User Form activity.

The key input for this activity is the User form for data collection field, under the Inputs section. To provide this input, you must create a data definition first.

Roles and availability

This activity is available as a common activity. Users with the admin, playbook.admin, or pd_author can add this activity to a playbook.

Example

During a playbook run, you can use data definitions to potentially:
  • Collect a shipping address, then reference the address when generating a shipping label.
  • Ask the user "yes" or "no" questions, and determine subsequent activities based on the user's responses.

Common properties

These properties are common to all to activities in Playbooks.

Open the activity properties panel and configure your activity to add values for the following inputs. If the input value varies, use the pill-picker to show where to get the value. To learn more about the pill-picker, see Dot-walking examples.

Inputs

Many of these inputs are common to activities in Playbooks. The key input for this activity is User form for data collection field.

After configuring the required inputs for your activity, you can also choose to configure additional inputs. In the side panel, select Show additional options to display these advanced inputs. For more information, see Activity experience.

Outputs

These outputs can provide data to other activities in your playbook. You can access this data as activity inputs when you configure your activity:
Output Type Description
Record Reference.Flow Data Reference to record containing collected data. Use the pill-picker to dot-walk to Outputs > Record > Vars to see all collected data. To learn more about the pill-picker, see Dot-walking examples.

UI Layouts

Set properties for how the activity renders during a playbook run.

Example: