User Image

Function

a!userImage( user, altText, caption, link, showWhen, backgroundColor )

Displays a user's profile photo for use in an image, rich text display, tree browser, billboard layout component, or in a grid column component in a Read-Only Grid.

Parameters

Name	Keyword	Types	Description
User	user	User	The user whose profile photo will be shown.
Alternate Text	altText	Text	Alternate text of the image used for the image's alt attribute and read by screen readers; see accessibility considerations for more information.
Caption	caption	Text	Text to display in mouseovers.
Link	link	Link	Link that determines the behavior of an image when clicked. 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()
Show When	showWhen	Boolean	Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default: true.
Background Color	backgroundColor	Text	Determines the background color to use when the user's initials display instead of a profile photo. Valid values: Any valid hex color or "SECONDARY" (default), "ACCENT".

Usage considerations

Default image

If the user parameter is null or empty, the default profile picture displays.

If the user doesn't have a profile image, their initials display instead. The initials shown depend on the viewing permissions of the user viewing the image:

• With permission: The first letters of the user's first and last names from their profile.
• Without permission: The first two letters of the username.

If the initials contain non-Latin characters, the default profile picture displays.

Feature compatibility

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

Feature	Compatibility	Note
Portals	Incompatible
Offline Interfaces	Incompatible
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.

Old versions

There are older versions of this interface component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

Old Versions	Reason for Update
a!userImage_26r2	When a profile photo isn't available, the component now displays user initials instead of a generic user icon. We also added a new backgroundColor parameter so you can choose a color to display behind the initials. For more on what's changed, see New version details.

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

Related recipes

The following recipes include usage of the User Image.

• Event Timelines (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.

• Leaderboard (Looping):

  Use the leaderboard pattern to show a selection of your data in an easy to read ranked display.

• User List Pattern (Looping):

  The user list pattern retrieves all the users in a specified group and displays them in a single column.

Feedback