FunctionCopy link to clipboard
a!urlForTask( taskIds, returnTaskPathOnly )
This function returns the URL of a process task given the task ID.
See also: Process Task Link: Use this component to within a Link Field to create a link to a process task.
ParametersCopy link to clipboard
Keyword | Type | Description |
---|---|---|
|
List of Number (Integer) |
Task IDs of process tasks to generate links. |
|
Boolean |
If true, only the last path segment to the task is included; if false, the full URL of the task is returned. Default: false |
ReturnsCopy link to clipboard
Text Array
Usage considerationsCopy link to clipboard
- The
taskIds
parameter is required. If no task exists with the provided ID number, a URL is still returned. - If
returnTaskPathOnly
is true, only the task path after/task
is returned. - If
returnTaskPathOnly
is false, the URL will return the Tempo URL for the task. - To create a URL to a site, use
returnTaskPathOnly=true
and append the path only to the end of the site URL in the following format:<base_url>/suite/sites/<site_name>/task/<task_path>
. - If a user does not have viewer rights to the task in the returned URL, the user will see an error when trying to open the URL.
ExamplesCopy link to clipboard
These examples are designed to illustrate how to use the a!urlForTask()
function in the Expression Rule Interface.
URL for a Single Task
a!urlForTask(taskIds: 123456, returnTaskPathOnly: false)
returns "https://tasks.appian.com/suite/tasks/task/WrxYT3TYySQZTUwm"
URLs for Multiple Tasks
a!urlForTask(taskIds: {123456, 654321}, returnTaskPathOnly: false)
returns {"https://tasks.appian.com/suite/tasks/task/WrxYT3TYySQZTUwm", "https://tasks.appian.com/suite/tasks/task/BU8YV4nEFVwMuc3U"}
Return the Task Path Only
a!urlForTask(taskIds: {12345, 54321}, returnTaskPathOnly: true)
returns "WrxYT3TYySQZTUwm"
Feature compatibilityCopy link to clipboard
The table below lists this function's compatibility with various features in Appian.
Feature | Compatibility | Note |
---|---|---|
Portals | Partially compatible | Can be used with Appian Portals if it is connected using an integration and web API. |
Offline Mobile | Partially compatible | Can be used with offline mobile if it is loaded at the top of the form. |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |