Collect User Data activity

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 4 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Collect User Data Activity

    The Collect User Data activity enables users to gather input during a playbook run without the need for a dedicated data table. This activity is ideal when you do not require reporting on the collected data or plan to use it outside the playbook. If a data table exists, consider using the User Form activity instead.

    Show full answer Show less

    Key Features

    • User Form for Data Collection: The primary input for this activity, which must be defined in advance.
    • Roles and Access: Available to users with admin, pdadmin, or pdauthor roles for inclusion in playbooks.
    • Common Properties: Includes options for labeling, descriptions, run conditions, start rules, and delaying activity execution.
    • Assignment Controls: Allows specification of groups and individual users who can access or edit collected data.
    • Wait for User Input: Option to pause the playbook until the end user provides input or skips the activity.

    Key Outcomes

    By leveraging the Collect User Data activity, you can:

    • Gather essential information such as shipping addresses for use later in the playbook.
    • Facilitate decision-making through user responses to questions, guiding subsequent activities.
    • Ensure data is securely handled through role-based access controls, limiting visibility and edit permissions to designated users.

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

    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, pd_admin, or pd_author role can add this activity to a playbook.

    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.
    Input Type Description
    Label String Title to display as activity and playbook card.
    Description String Information to display about activity usage or outcome.
    Run condition Condition Builder Conditions that must be met to run an activity or stage. You can use data from prior activities to build conditions.
    Note:
    Show additional options to see this field.
    Start Rule Choice Under Schedule > Start Rule, select a start rule for when your stage should start running:
    • When process starts: Your stage starts running as soon as the playbook starts.
    • After specific stages: Your stage starts running after specified stage(s) have finished running.
    Under Schedule > Start Rule, select a start rule for when your activity should start running:
    • When stage starts: Your activity starts running as soon as its stage starts running. Your stage starts running when your playbook is triggered.
    • After specific activities: Your activity starts running after specified activities have finished running.
    Start with delay True/False Option to wait for a duration of time before running an activity or stage. When enabled, this input displays the Start with delay input properties.
    Note:
    Show additional options to see this field.

    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.
    Input Type Description
    Assignment Group for this Process Step Reference.Group [sys_user_group] Assignment group allowed to perform this playbook activity. If you don't set any values for Assignment Group or Assigned To, any user can read and edit the collected data. The Assignment group and Assigned to fields limit who has access to do so. To specify only individual users, use the Assigned To field. The same users do not need to be specified in both fields.
    Note:
    By default, these fields are mapped to the Assignment Group and Assigned To fields of the trigger record. This means that users assigned to work on the parent record have access to submit, view and edit the collected data by default.
    Assigned to this Process Step Reference.User [sys_user] User allowed to perform this playbook activity. If you don't set any values for Assignment Group or Assigned To, any user can read and edit the collected data. The Assignment group and Assigned to fields limit who has access to do so. To specify only individual users, use the Assigned To field. The same users do not need to be specified in both fields.
    Note:
    By default, these fields are mapped to the Assignment Group and Assigned To fields of the trigger record. This means that users assigned to work on the parent record have access to submit, view and edit the collected data by default.
    User form for data collection Choice Type of input form used to collect data. Playbook authors define the data that they want agents or fulfillers to collect during a playbook run in the sys_flow_data_definition table. When the information is collected, it is stored in the sys_flow_data table for use later in the playbook run, instead of in the record table. To define the data you want an agent or fulfiller to collect, see Create a Data Definition.
    Wait for user input Choice Option to pause the playbook until the end user manually completes or skips the activity. Only users with the pd_admin role can edit this field. By default, the activity waits for user action or data before it completes.

    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.