User Form activity
Use this activity to surface a record to the end user. This activity requires you to select a table and record, and the desired form view that should be surfaced to the end user in your playbook. The end user can then interact with this record accordingly. Display a form during runtime to collect input values for your playbook.
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.
Inputs
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. | ||
| 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. | ||
| Tagline | String | Header tagline to display to end users. | ||
| Record fields | Reference | Any additional record fields you want in the form.Note: This field cannot be edited during a playbook run. | ||
| Associated table | Table Name | Table containing activity or playbook data. | ||
| Associated record | Reference | Reference to the record you want to display. | ||
| Form View | String | Form view to use for data collection. If you don't provide a form view, the system uses the default view. Use the new tab button Image omitted: new-tab-button.png Form Fieldsa button that opens a new tabto open and edit a form view with Form Builder in a new Workflow Studio tab.<strong>Note:</strong> Many form views are not supported in Workspace.</td></tr><tr><td> | String | Comma-separated list of fields names to display on the card for the form.Note: Make sure to include the form fields in the default view or the view of your choice, so that the fields are displayed in the playbook. |
| Attachment source | Choice | The attachment record containing the attachments that end users can upload during runtime. |
Advanced inputs
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 | Reference.Group \[sys\_user\_group\] | Group responsible for completing the task associated with the activity.Note: Select Show additional options to see this field. |
| Assigned To | Reference.User \[sys\_user\] | User responsible for completing the task associated with the activity.Note: Select Show additional options to see this field. |
| Display Order | Choice | The order in which the activity card appears during a playbook run.Note: Select Show additional options to see this field. |
| 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: Select Show additional options to see this field. |
| 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: Select Show additional options to see this field. |
| Restart rules | Choice | What an activity or stage does during restart:- Skip on restart: The stage or activity only runs during a playbook's initial run. It does not run on restart. Note: This setting is helpful if you don't want new tasks or records to be created during a restarted run, because the original execution and resulting record is still relevant.
To learn more about enabling and configuring restart for playbooks, stages, and activities, see Configure restart for Playbooks. Note: Select Show additional options to see this field. |
| Experience Status Table | Table Name | Table containing the Experience Status Record. By default, set to the table containing the flow data record created by this activity's underlying flow, subflow, or action.Note: Select Show additional options to see this field. |
| Experience Status Record | Reference | The flow data record with the status that you want to map with this activity's state. Changes made to the state in the activity card are mapped to the flow data record, and from the flow data record to the activity card. By default, this is the data record created by this activity's underlying flow, subflow, or action.Note: Select Show additional options to see this field. |
| Icon | Reference.Icon \[st\_sys\_design\_system\_icon\] | Displays an icon on the activity card.Start entering the icon name and select the icon you want to appear. Note: Select Show additional options to see this field. |
| Title | String | Title displayed to end users in the activity card. You can enter text or use the pill picker.Note: Select Show additional options to see this field. |
| Description | Reference | Details to display to end users in the activity card. This is not a string field, use the pill picker to choose a description to show in the activity card.Note: Select Show additional options to see this field. |
| Pending State Title | String | Title displayed to end users for a pending activity. You can enter text or use the pill picker.Note: Select Show additional options to see this field. |
| Pending State Description | String | Details to display to end users in a pending activity.Note: Select Show additional options to see this field. |
| Attachments read only | True/False | If enabled, prevents end users from renaming or deleting the existing attachments.Note: Select Show additional options to see this field. |
| Footer | String | Footer text to display to end users. Note: Select Show additional options to see this field. |
| Show Attachments | True/False | Option to include attachments in the user form.Note: Select Show additional options to see this field. |
| Show SLA | True/False | Option to show SLA countdown details for the task.Note: Select Show additional options to see this field. |
| Show Checklist | True/False | Option to show record checklist items.Note: Select Show additional options to see this field. |
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 |
|---|---|---|
| Table | Table Name | Name of the table associated with the activity. |
| Record | Reference.Task[task] | Reference to the record associated with the activity. |