user() Function

Function

user( username, property )

Returns information for a user. locale and timeZone return the user's preference or null if not set.

Parameters

Keyword Type Description

username

Text

The username or user object of the user whose information should be retrieved.

property

Text

The information to retrieve for this user. See Usage considerations.

Returns

Text

Usage considerations

The property value accepts the following (case-sensitive) values:

  • firstName
  • middleName
  • lastName
  • displayName (the user's nickname)
  • supervisorName
  • titleName
  • email
  • phoneOffice
  • phoneMobile
  • phoneHome
  • address1
  • address2
  • address3
  • city
  • state
  • province
  • zipCode
  • country
  • locale
  • timeZone
  • customField1
  • customField2
  • customField3
  • customField4
  • customField5
  • customField6
  • customField7
  • customField8
  • customField9
  • customField10
  • uuid
  • created
  • status
  • userTypeId
  • userTypeName

user() cannot be used to define a column of process report data or in a process event.

Examples

The following examples use a sample record type called Employee. These expressions illustrate how to display data in a record list, which is why they uses the fv! domain prefix.

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.

Return a user's first and last name

1
user(username: fv!row[recordType!Employee.fields.username], property: "firstName") & " " & user(username: fv!row[recordType!Employee.fields.username], property: "lastName")

Returns

Jane Doe

Return the timestamp when a user was created

1
user(username: fv!row[recordType!Employee.fields.username], property: "created")

Returns

12/20/22 10:36 PM GMT

Return a user's email

1
user(username: fv!row[recordType!Employee.fields.username], property: "email")

Returns

jane.doe@example.com

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Partially compatible

Can be used with Appian Portals if it is connected using an integration and web API.

Offline Mobile Partially compatible

Can be used with offline mobile if it is loaded at the top of the form.

Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Process Reports Compatible
Process Events Compatible
Open in Github Built: Fri, Dec 09, 2022 (09:01:28 PM)

On This Page

FEEDBACK