FunctionCopy link to clipboard
a!safeLink( label, uri, showWhen, openLinkIn )
Defines a link to an external web page. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.
See also:
ParametersCopy link to clipboard
| Name | Keyword | Types | Description |
|---|---|---|---|
|
Label |
|
Text |
Text displayed as the link name the user clicks on. |
|
URI |
|
SafeURI |
URI target of the hyperlink. See SafeURI. |
|
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
|
Open Link In |
|
Text |
(Browser-Only) Determines where the linked content should open. Valid values: |
Usage considerationsCopy link to clipboard
Displaying linksCopy link to clipboard
- To display a single link or array of links, put safe links inside of the link component.
- To display a link in a grid, put the safe link inside of a grid text column.
- To add a link to an image, put the safe link inside a document image or web image.
- To add a link to a chart series, put the safe link inside a chart series component.
Specifying URI protocolsCopy link to clipboard
It's recommended that the URI use a specific protocol. When no protocol is specified, the component will generate a hyperlink using the system's protocol and domain.
Opening links in new tabs & windowsCopy link to clipboard
- A link created by
a!safeLink()opens in a new tab by default. Opening a link in the same tab can be configured using the openLinkIn parameter. - Note that a user's browser may still be configured so that new tabs are instead opened as new windows.
Appian Mobile considerationsCopy link to clipboard
The telephone link URI ("tel:") is supported on the Appian Mobile application. If a user clicks this link in the application, the link will open a mobile device's default phone dialer.
Telephone links may work in a web browser, but behavior can differ based on operating system and whether any telephone supported applications or extensions are installed.
ExamplesCopy link to clipboard
To experiment with examples, copy and paste the expression into an interface object.
To an external websiteCopy link to clipboard
1
2
3
4
a!safeLink(
label: "Company web site",
uri: "http://www.appian.com"
)
Copy
Returns a hyperlink to http://www.appian.com
To a telephone number in the Appian Mobile ApplicationCopy link to clipboard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
a!richTextDisplayField(
value: if(
a!isNativeMobile(),
a!richTextItem(
text: (
"(555)-555-5555"
),
link: a!safeLink(
label: "(555)-555-5555",
uri: "tel: (555)-555-5555"
),
),
"(555)-555-5555"
)
)
Copy
Returns a telephone link which can be used on mobile devices via the Appian Mobile application. Use isNativeMobile() to only show this link in the Appian Mobile application.
Feature compatibilityCopy link to clipboard
The table below lists this component's compatibility with various features in Appian.
| Feature | Compatibility | Note |
|---|---|---|
| Portals | Compatible | |
| Offline Mobile | Incompatible | |
| 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. |
| Process Autoscaling | Compatible |