{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":4425,"path":"build-workflows/workflow-studio/user-form-activity.md","title":"User Form activity","bundle":null,"doc_type":null,"release":"australia","body":"\n# User Form activity\n\nUse 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.\n\n## Roles and availability\n\nThis activity is available as a common activity. Users with the admin, playbook.admin, or pd\\_author can add this activity to a playbook.\n\n## Inputs\n\nOpen 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/dot-walking-examples.md).\n\n<table id=\"table_ajt_sr3_plb\"><thead><tr><th>\n\nInput\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nLabel\n\n</td><td>\n\nString\n\n</td><td>\n\nTitle to display as activity and playbook card.\n\n</td></tr><tr><td>\n\nDescription\n\n</td><td>\n\nString\n\n</td><td>\n\nInformation to display about activity usage or outcome.\n\n</td></tr><tr><td>\n\nStart Rule\n\n</td><td>\n\nChoice\n\n</td><td>\n\nUnder **Schedule** &gt; **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.\n-   **After specific stages**: Your stage starts running after specified stage\\(s\\) have finished running.\n\nUnder Schedule &gt; 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.\n-   **After specific activities**: Your activity starts running after specified activities have finished running.\n\n</td></tr><tr><td>\n\nTagline\n\n</td><td>\n\nString\n\n</td><td>\n\nHeader tagline to display to end users.\n\n</td></tr><tr><td>\n\nRecord fields\n\n</td><td>\n\nReference\n\n</td><td>\n\nAny additional record fields you want in the form.**Note:** This field cannot be edited during a playbook run.\n\n</td></tr><tr><td>\n\nAssociated table\n\n</td><td>\n\nTable Name\n\n</td><td>\n\nTable containing activity or playbook data.\n\n</td></tr><tr><td>\n\nAssociated record\n\n</td><td>\n\nReference\n\n</td><td>\n\nReference to the record you want to display.\n\n</td></tr><tr><td>\n\nForm View\n\n</td><td>\n\nString\n\n</td><td>\n\nForm 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 \\[Omitted image \"new-tab-button.png\"\\] Alt text: a button that opens a new tabto open and edit a form view with Form Builder in a new Workflow Studio tab.**Note:** Many form views are not supported in Workspace.\n\n</td></tr><tr><td>\n\nForm Fields\n\n</td><td>\n\nString\n\n</td><td>\n\nComma-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.\n\n</td></tr><tr><td>\n\nAttachment source\n\n</td><td>\n\nChoice\n\n</td><td>\n\nThe attachment record containing the attachments that end users can upload during runtime.\n\n</td></tr></tbody>\n</table>## Advanced inputs\n\nAfter 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/build-workflows/workflow-studio/activity-definitions.md).\n\n<table id=\"table_cjj_sr3_plb\"><thead><tr><th>\n\nInput\n\n</th><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nAssignment Group\n\n</td><td>\n\nReference.Group \\[sys\\_user\\_group\\]\n\n</td><td>\n\nGroup responsible for completing the task associated with the activity.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nAssigned To\n\n</td><td>\n\nReference.User \\[sys\\_user\\]\n\n</td><td>\n\nUser responsible for completing the task associated with the activity.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nDisplay Order\n\n</td><td>\n\nChoice\n\n</td><td>\n\nThe order in which the activity card appears during a playbook run.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nStart with delay\n\n</td><td>\n\nTrue/False\n\n</td><td>\n\nOption to wait for a duration of time before running an activity or stage. When enabled, this input displays the [Start with delay input properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/build-workflows/workflow-studio/start-with-delay-properties.md).**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nRun condition\n\n</td><td>\n\nCondition Builder\n\n</td><td>\n\nConditions 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.\n\n</td></tr><tr><td>\n\nRestart rules\n\n</td><td>\n\nChoice\n\n</td><td>\n\nWhat 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.\n\n**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.\n\n-   **Run always**: The stage or activity always runs, whether during an initial or restarted run.\n-   **Skip on first run**: The stage or activity runs only on restart. It never runs during an initial run.\n\nTo learn more about enabling and configuring restart for playbooks, stages, and activities, see [Configure restart for Playbooks](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/build-workflows/workflow-studio/enable-define-restart.md).\n\n**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nExperience Status Table\n\n</td><td>\n\nTable Name\n\n</td><td>\n\nTable 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.\n\n</td></tr><tr><td>\n\nExperience Status Record\n\n</td><td>\n\nReference\n\n</td><td>\n\nThe 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.\n\n</td></tr><tr><td>\n\nIcon\n\n</td><td>\n\nReference.Icon \\[st\\_sys\\_design\\_system\\_icon\\]\n\n</td><td>\n\nDisplays an icon on the activity card.Start entering the icon name and select the icon you want to appear.\n\n**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr id=\"activity-input-title\"><td>\n\nTitle\n\n</td><td>\n\nString\n\n</td><td>\n\nTitle 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.\n\n</td></tr><tr><td>\n\nDescription\n\n</td><td>\n\nReference\n\n</td><td>\n\nDetails 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.\n\n</td></tr><tr><td>\n\nPending State Title\n\n</td><td>\n\nString\n\n</td><td>\n\nTitle 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.\n\n</td></tr><tr><td>\n\nPending State Description\n\n</td><td>\n\nString\n\n</td><td>\n\nDetails to display to end users in a pending activity.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nAttachments read only\n\n</td><td>\n\nTrue/False\n\n</td><td>\n\nIf enabled, prevents end users from renaming or deleting the existing attachments.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nFooter\n\n</td><td>\n\nString\n\n</td><td>\n\nFooter text to display to end users. **Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nShow Attachments\n\n</td><td>\n\nTrue/False\n\n</td><td>\n\nOption to include attachments in the user form.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nShow SLA\n\n</td><td>\n\nTrue/False\n\n</td><td>\n\nOption to show SLA countdown details for the task.**Note:** Select **Show additional options** to see this field.\n\n</td></tr><tr><td>\n\nShow Checklist\n\n</td><td>\n\nTrue/False\n\n</td><td>\n\nOption to show record checklist items.**Note:** Select **Show additional options** to see this field.\n\n</td></tr></tbody>\n</table>## Outputs\n\nThese outputs can provide data to other activities in your playbook. You can access this data as activity inputs when you configure your activity:\n\n|Output|Type|Description|\n|------|----|-----------|\n|Table|Table Name|Name of the table associated with the activity.|\n|Record|Reference.Task\\[task\\]|Reference to the record associated with the activity.|\n\n"}}