Link Component

On This Page

Function

a!linkField( label, instructions, links, labelPosition, align, helpTooltip, showWhen, accessibilityText )

Displays one or more links of any link type, including document links, task links, record view links, external web page links, and dynamic links that update variables. Link types serve two main purposes: to navigate to objects, such as tasks and records, or to perform actions, such as downloading documents or starting processes.

Avoid using this component for offline mobile forms because links do not execute when tapped offline.

Parameters

Name	Keyword	Types	Description
Label	label	Text	Text to display as the field label.
Instructions	instructions	Text	Supplemental text about this field.
Links	links	Any Type	Array of links to display. Create links with: a!authorizationLink() a!documentDownloadLink() a!dynamicLink() a!newsEntryLink() a!processTaskLink() a!recordLink() a!reportLink() a!startProcessLink() a!submitLink() a!userRecordLink() a!safeLink()
Label Position	labelPosition	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Alignment	align	Text	Determines alignment of link labels. Appian recommends this setting only be used inside the Grid Layout component. Valid values: `"LEFT"`, `"CENTER"`, `"RIGHT"`.
Help Tooltip	helpTooltip	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is `"COLLAPSED"`.
Show When	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.
Accessibility Text	accessibilityText	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Examples

Use the interactive editor below to test out the example code.

a!linkField(
  label: "Links",
  links: a!safeLink(
    label: "Company web site",
    uri: "http://www.appian.com"
  )
)

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Interfaces	Compatible
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	Incompatible	Cannot be used in autoscaled processes.
Event Consumer Filter Conditions	Compatible	Can be used in filter conditions.
Event Consumer Event Handlers	Compatible	Can be used in event handler expressions.

The following recipes include usage of the Link Component.

Add, Remove, and Move Group Members Browser (Hierarchical Data, Group Management):
Display the membership tree for a given group and provide users with the ability to add, remove, and move user members from a single interface.
Aggregate Data and Conditionally Display in a Chart or Grid (Reports, Charts, Query Data, Grids, Records):
Aggregate data and conditionally display it in a pie chart or grid. In this pattern, we will calculate the total number of employees in each department and display it in a pie chart and a read-only grid. Then, we'll use a link field to conditionally display each component.
Configure a Chart Drilldown to a Grid (Charts, Grids, Query Data, Records):
Displays a column chart with aggregate data from a record type and conditionally shows a grid with filtered records when a user selects a column on the chart.
Configure a Chart to Grid Toggle (Charts, Grids):
Display a column chart with a toggle to display an alternate grid view of the data.
Configure an Array Picker with a Show All Option (Pickers):
Allow users to choose from a long text array using an autocompleting picker, but also allow them to see the entire choice set using a dropdown.
Display Multiple Files in a Grid (Document Management, Grids):
Show a dynamic number of files in a grid and edit certain file attributes.
Display a User's Tasks in a Grid With Task Links (Grids, Reports, Looping):
Display the tasks for a user in a Read-Only Grid and allow them to click on a task to navigate to the task itself.
Drilldown Pattern (Grids):
The drilldown pattern allows users to select an item from a grid to see more details in place of the grid.
Filter a Grid Using a Dropdown (Grids, Filtering, Records):
Configure a dropdown for users to filter data in a read-only grid.
Filter the Data in a Grid Using a Chart (Charts, Grids, Filtering, Records):
Display an interactive pie chart with selectable sections so that a user may filter the results in a grid.
Offline Task Report (Grids, Filtering, Process Task Links, Task Reports, Looping):
Display a task report for a user that will work in Appian Mobile, even when the user is offline.
Task Report Pattern (Grids, Filters, Process Task Links, Task Reports):
Provides a simple way to create and display an Appian task report.
Update an Entity-Backed Record Type from its Summary View (Records, Smart Services):
Enable users to make quick changes to a record by updating it right from a record view.
Use Links in a Grid to Show More Details and Edit Data (Grids):
Allow end users to click a link in a read-only grid to view the details for the row, and make changes to the data. The data available for editing may include more fields than are displayed in the grid.

Feedback

Was this page helpful?