User Record

Overview

A directory of Appian users is available as a record type in the Tempo interface. This directory is accessible by end users by navigating to the Users record type in Tempo and browsing or searching the record list. The Users record type can also be added to a site page.

Each user in Appian has a User record, which by default includes a Summary, News, and Related Actions view. In a site, the news view is available based on a site design configuration and can be turned off. The sections below describe the aspects of this record type that you can modify and/or extend to best meet the specific needs of your organization.

  1. Edit Users Record Type
  2. Modify Name and Description
  3. Modify Security
  4. Modify List View
  5. Add User Filters
  6. Add Related Actions
  7. Add Record Views
  8. UserProfile Record Fields
  9. Deploy Changes

The content below assumes a basic familiarity with record design and focuses more on the specifics of configuring the Users record type. Consider familiarizing yourself with the Record Design and Records Tutorial pages before proceeding.

See also: Record Design and Records Tutorial

For more information on user management in Tempo, refer to User Management.

Edit Users Record Type

Since user profiles are records, you can configure the format of user profiles by configuring the corresponding Users record type. Take the following steps to do so:

  1. In Appian Designer, navigate to the Objects view.
  2. Filter the list to Record Type objects.
  3. Search for "user" to find the Users record type.
    Note: If you've changed the name of the Users record type (e.g. to Corporate Directory), search for the new name instead

You will see the following screen, from which you can edit the record type:

images:RTDUser.png

See also: Create a Record Type

Modify Name and Description

You may need to modify the name and description of the Users record type, especially if you need to translate it to a different language to fit the locale of your users. The Singular Record Type Name, Plural Record Type Name, and Description fields of the Users record type are all editable. If your user base speaks multiple languages, populate the fields accordingly with all relevant languages. For example:

  • Singular Record Type Name: User / Usuario
  • Plural Record Type Name: Users / Usuarios
  • Description: Directory of users / Directorio de usuarios

Modify Security

By default, all users have Viewer permission to the Users record type, which means that all users who can access Tempo can see the Users record type from the Records tab. This cannot be changed. However, you can configure additional security by assigning users the following permission levels:

  • Editor
  • Administrator

See also: Configuring Security for a Record Type

Modify List View

The record list view for the Users record type is set to use the system function a!userRecordListViewItem by default. This default list view displays the first and last names, email, office phone, and mobile phone for each user in the Users record list.

images:Default user record list view.png

You can replace the system function with your own rule that defines a different list view for the Users record type. For example, you could create a rule with the following expression to display each user's city and state instead of email and phone numbers:

1
2
3
4
5
a!listViewItem(
  title: rf!firstName & " " & rf!lastName,
  details: rf!city & ", " & rf!state,
  image: touser(rf!username)
)

In this expression, we used record fields available in the UserProfile CDT (the source data type for the Users record type) by using the rf! domain to access them. See the UserProfile Record Fields section below for the full list of record fields available in the UserProfile CDT. The above expression results in a different looking list view:

images:User record list view.png

See also: a!userRecordListViewItem(), Create a Record List

Add User Filters

The User Filters field of the Users record type is set to use the system function a!userRecordFacets by default. This default function contains a "Status" user filter with filter options "Active" and "Inactive", with "Active" selected by default. As a result, users see only active users in the Users record list by default. Inactive users are users whose accounts have been deactivated.

images:Default user record facets.png

Removal of the default "Status" user filter is not recommended. Doing so will result in the Users record list displaying all inactive users, with no way for users to filter out the inactive users. However, you can add your own user filters in addition to the default "Status" user filter. For example, if your users span multiple countries, you could add a "Country" user filter.

To do so, create an expression rule called userRecordUserFiltersExtension. Define the rule with the following:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
a!facet(
  name: "Country",
  options: {
    a!facetOption(
      id: 1,
      name: "China",
      filter: a!queryFilter(
        field: "country",
        operator: "=",
        value: "China"
      )
    ),
    a!facetOption(
      id: 2,
      name: "France",
      filter: a!queryFilter(
        field: "country",
        operator: "=",
        value: "France"
      )
    ),
    a!facetOption(
      id: 3,
      name: "United States",
      filter: a!queryFilter(
        field: "country",
        operator: "=",
        value: "USA"
      )
    )
  }
)

Now edit the Users record type to modify the User Filters field to include your expression rule:

1
2
3
4
{
  a!userRecordFacets(),
  rule!userRecordUserFiltersExtension()
}

After saving the record type, you will see your new "Country" user filter in the left-hand navigation when viewing the record list.

images:User record facets.png

See also:

The Users record type does not have any related actions defined by default, but you can add related actions to this record type just as you would any other record type. Additionally, you can configure related action shortcuts from any record view for the Users record type.

You have access to the record fields in the rf! domain to define the Context Expression fields for related actions.

See also: Add a Related Action

Add Record Views

The Summary record view for the Users record type is defined by default. While the Summary view has edit capabilities, you can also define additional record views to display more user information on user profiles.

Adding record to the Users record type is the same as adding record views to any other record type. You have access to the record fields in the rf! domain to define the record view interfaces.

See also: Add a Record View

UserProfile Record Fields

If you edit the Users record type in the Designer interface, you will notice that the Source Data Type for the record type is UserProfile. All the fields of the UserProfile CDT are available to you as record fields in the rf! domain. The fields of UserProfile are as follows:

  • active (Boolean): Indicates whether the user is active or not.
  • username (Text): The unique username with which the user logs into Appian.
  • firstName (Text): The user's first name.
  • middleName (Text): The user's middle name.
  • lastName (Text): The user's last name.
  • displayName (Text): The user's nickname.
  • email (Text): The user's email address.
  • address1 (Text): The first line of the user's address.
  • address2 (Text): The second line of the user's address.
  • address3 (Text): The third line of the user's address.
  • city (Text): The city of the user's location.
  • state (Text): The state of the user's location.
  • zipCode (Text): The zip code of the user's location.
  • province (Text): The province of the user's location.
  • country (Text): The country of the user's location.
  • phoneHome (Text): The user's home phone number.
  • phoneMobile (Text): The user's mobile phone number.
  • phoneOffice (Text): The user's office phone number.
  • supervisor (User): The user's supervisor.
  • blurb (Text): The user's blurb as provided on his/her profile Summary view.

See the previous sections for examples of how to make use of these field values for the Users record type.

Deploy Changes

Once you have made changes to the Users record type in one environment, you may need to deploy those changes to other environments. For example, you might make changes in a development environment that you need to deploy in a test or production environment.

The steps for deploying changes to the Users record type are the same as those for deploying changes to any other record type. Simply create an application containing the Users record type and any dependencies, export the application, and import it to the new environment.

FEEDBACK