userlocale() Function

Function

userlocale( user )

Returns the preferred locale of the given user or the site primary locale if the user doesn't have a preference set.

Parameters

Keyword	Type	Description
user	Text	The user (or the username of the user) for whom the locale should be returned.

Returns

Text

Usage considerations

The locale is returned as a string, such as "es_MX".

Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

userlocale("john.doe") returns en_US

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	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	Partially compatible	Using this function in a process model with autoscale enabled may result in degraded site or application performance.

Feedback