Web Link

Function: a!safeLink()

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: Link, Read-Only Grid, Images

Parameters

Name Keyword Type 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.

Notes

  • To display a single link or array of links, use inside the Link Field component. To display a link in a grid, use inside a GridTextColumn. To add a link to an image, use inside a document or web image. To add a link to a chart series, use inside the a!chartSeries() function.
  • A link created by a!safeLink() opens in a new browser window. Note that a user's browser may still be configured so that all new windows are instead opened as new tabs.
  • 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 for Mobile Devices Application. This link, if invoked via the application, will open a mobile device's default phone dialer and supports any telephone number format. 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.

Examples

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 for Mobile Devices Application

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
= a!richTextDisplayField(
  value: if(
    or(
      a!isNativePhone(),
      a!isNativeTablet()
    ),
    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 invoked on mobile devices via the Appian for Mobile Devices Application. Use isNativePhone() and isNativeTablet() to only show this link in the Appian for Mobile Devices Application.

Open in Github

On This Page

FEEDBACK