Free cookie consent management tool by TermsFeed Safe Link Component (a!safeLink)
Safe Link Component

Function

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:

Parameters

Name Keyword Types Description

Label

label

Text

Text displayed as the link name the user clicks on.

URI

uri

SafeURI

URI target of the hyperlink. See SafeURI.

Visibility

showWhen

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

openLinkIn

Text

(Browser-Only) Determines where the linked content should open. Valid values: "SAME_TAB", "NEW_TAB" (default).

Usage considerations

  • 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.
  • 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.
  • 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.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

To an external website

1
2
3
4
a!safeLink(
  label: "Company web site",
  uri: "http://www.appian.com"
)

Returns a hyperlink to http://www.appian.com

To a telephone number in the Appian Mobile Application

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"
 )
)

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 compatibility

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.

Safe Link Component

FEEDBACK