List of Variables
Variables store information from form fields and business processes. The variables that you can use in a form vary depend on the situation. For example, previous task variables are not available when configuring the On Event Completion page, because the message shows before any tasks run.
Process
| Variable | Syntax | Description |
| Business Process ID | {/dataset/_bp_process_id} | The ID of the forms process. |
| Business Process Name | {/dataset/_bp_process_name} | The name of the forms process. |
| Process Time Zone | {/dataset/_process_time_zone} | The time zone of the forms process. |
| Process End Date | {/dataset/_process_end_date} | The date the form or survey is set to expire and become unavailable. |
| Current Step Name | {/_current_step_name} | The name of the currently running step in the process. |
Instance
| Variable | Syntax | Description |
| ID | {/dataset/_instance_id} | The instance ID. |
| Initiator email | {/dataset/_initiator_email} | The email address of the user who started the process instance. |
| Initiator name | {/dataset/_initiator_displayname} | The name of the user who started the process instance (e.g., John Smith). |
| Initiator username | {/dataset/_initiator} | The user name of the user who started the process instance (e.g., jsmith). |
| Start Date | {/dataset/_initiated_date} | The date when the process instance started. |
| Start Time | {/dataset/_initiated_time} | The time when the process instance started. |
Previous Submission
These variables refer to the previous user or service task that submitted a form.
| Variable | Syntax | Description |
| Action | {/dataset/_action} | The action performed by the user or task that last submitted a form (e.g., approve or reject). |
| Comment | {/dataset/_comment} | The comments left by the user or task who submitted the form. |
| Completion date | {/dataset/_submission_date} | The date when the form was submitted. |
| Completion time | {/dataset/_submission_time} | The time when the form was submitted. |
| Participant email | {/dataset/_submitter_email} | The email address of the user who submitted the form. |
| Participant name | {/dataset/_submitter_displayname} | The name of the user who submitted the form. |
| Participant username | {/dataset/_submitter} | The user name of the user who that submitted the form. |
| Submission ID | {/dataset/_submission_id} | The ID of the submission. |
| Submission IP Address | {/dataset/_submission_ip_address} | The IP address of the computer from which the last form was submitted. |
Previous User Submission
Unlike the Previous Submission Variables, these variables refer only to the previous user task.
| Variable | Syntax | Description |
| Action | {/dataset/_fs_action} | The action performed by the user who last submitted a form (e.g., approve or reject). |
| Comment | {/dataset/_fs_comment} | The comments left by the user who submitted the form. |
| Completion date | {/dataset/_fs_submission_date} | The date when the form was submitted. |
| Completion time | {/dataset/_fs_submission_time} | The time when the form was submitted. |
| Participant email | {/dataset/_fs_submitter_email} | The email address of the user who submitted the form. |
| Participant name | {/dataset/_fs_submitter_displayname} | The name of the user who submitted the form participant (e.g., John Smith). |
| Participant username | {/dataset/_fs_submitter} | The user name of the user who submitted the form (e.g., jsmith). |
| Submission ID | {/dataset/_fs_submission_id} | The ID of the submission. |
| Submission IP Address | {/dataset/_fs_submission_ip_address} | The IP address of the computer from which the last form was submitted. |
Previously Saved Form
These variables refer to the repository entry created by a Save To Repository task, and refer to the last saved data within the repository.
| Variable | Syntax | Description |
| ID | {/dataset/_saved_form_id} | The entry ID of the saved form. |
| Path | {/dataset/_saved_form_path} | The repository path to the entry. |
| Attachment List | {/dataset/_saved_form_attach_list} | The list of attachments as a comma delimited list of IDs. |
| Name | {/dataset/_saved_form_name} | The name of the entry as specified when the form was saved. |
| Link | {/dataset/_saved_form_link} | The URL of the entry. |
| Folder ID | {/dataset/_saved_form_folder_id} | The entry ID of the folder where the form was saved. |
| Folder Link | {/dataset/_saved_form_folder_link} | The URL of the folder entry. |
| Folder Name | {/dataset/_saved_form_folder_name} | The name of the folder. |
| Folder Path | {/dataset/_saved_form_folder_path} | The path of the folder. |
| Folder Attachment List | {/dataset/_saved_form_folder_attach_list} | The list of IDs for the parent folders for the files that were attached to the form. |
User Task(s)
| Variable | Syntax | Description |
| Assigned to | {/dataset/_task_assigned_to[@_step_id=n]} where n is the step ID. | The assignee of the user task. |
| Due date | {/dataset/_task_due_date[@_step_id=n]} where n is the step ID. | The due date for the task. |
| Priority | {/dataset/_task_priority[@_step_id=n]} where n is the step ID. | The priority of the user task. |
| Resume ID | {/dataset/_task_resume_id[@_step_id=n]} where n is the step ID. | The resume ID is a unique identifier for a user task. It can be used to construct task link. The resume ID will be available once a user task is generated. The resume ID will not change after a task is reassigned, and will be the latest created resume ID if there are multiple user task instances created for the same process instance. |
| Start date | {/dataset/_task_date[@_step_id=n]} where n is the step ID. | The date the user task was started. |
| Start time | {/dataset/_task_time[@_step_id=n]} where n is the step ID. | The time the user task was started. |
| Task Link | {/dataset/_task_link[@_step_id=n]} where n is the step ID. | A URL to a user task, which will navigate the user to the user task in a browser. |