AX1339

Filter variables

Axiom Rolling Forecasting provides a set of filter variables that can be used in filter criteria statements throughout the software. Currently, these variables allow filtering based on the current user.

For example, you may have a column on a plan code table such as Dept.Owner, which contains user login names. When setting up plan file filters in security, you want each user to have a filter such as Dept.Owner='UserName'. Without using variables, you would need to set up each user with a user-level filter such as Dept.Owner='JDoe', Dept.Owner='RSandstone', and so on. With variables, you can instead set up a single role-level filter such as Dept.Owner='{CurrentUser.LoginName}'. For each user in the role, this filter will be resolved using that user's login name.

Filter variables can be used in any place that takes a filter criteria statement. For example, you can use the variables to impact data queries in places such as Sheet Filters, Axiom query filters, Web Report data source filters, Quick Filter, and GetData functions. You can also use the variables in utilities such as Process Plan Files and Create Plan Files.

To use a filter variable, place the variable in curly brackets within the filter criteria statement. All other filter rules still apply—for example, if the variable will resolve to a string value such as a user name, the variable must be placed in single quotation marks. The filter must result in a valid filter criteria statement once the variable is resolved to its current value.

Variable	Resolved Value
{CurrentUser.EmailAddress}	The email address of the current user.
{CurrentUser.FirstName}	The first name of the current user.
{CurrentUser.LastName}	The last name of the current user.
{CurrentUser.LoginName}	The login name of the current user.
{CurrentUser.PrincipalID}	The database ID of the current user.
{CurrentUser.QualifiedLoginName}	The qualified login name of the current user (domain\username). If the user does not have a defined domain, the regular login name is used.