User Record Link Component

Function

a!userRecordLink( label, user, view, showWhen, openLinkIn )

Defines a link to a user record.

See also:

Parameters

Name Keyword Types Description

Label

label

Text

Text displayed as the link name the user clicks on.

User

user

User

The User whose record is linked.

View

view

Text

The URL stub of the view to open for the record. Default is "summary".

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" (default), "NEW_TAB".

Usage considerations

Changing and deactivating usernames

  • User record links can be created for both active and deactivated users.
  • User record links continue to work when the user's username changes as long as the "user" field was configured by referencing a variable (e.g. process variable) rather than a username string.

User record links can be used inside :

Examples

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

Record type object references are specific to each environment. If you copy and paste these examples into your interface, they will not evaluate. Use them as a references only.

1
2
3
4
5
a!userRecordLink(
  label: "John Doe",
  user: "john.doe",
  view: "summary"
)

The following patterns include usage of the User Record Link Component.

  • Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.

  • Event Timeline (Timeline, Events): Use the event timeline pattern to display a dated list of events and actions in chronological order. This pattern uses a combination of cards, rich text, and user images to show an easy to navigate list of dated events.

  • User List Pattern (Looping): The user list pattern retrieves all the users in a specified group and displays them in a single column.

Open in Github Built: Mon, Oct 18, 2021 (02:58:47 PM)

On This Page

FEEDBACK