Concepts → Filter Expression Session Variable

About Filter Expression Session Variables

A filter expression session variable defines an immutable string value. The purpose of the string value is to specify a a filter expression. In this manner a schema developer, dashboard developer, or similar user can create a filter expression as a reusable object, and in turn, easily reference that reusable object for multiple dashboard filters, insight filters, or runtime security filters.

When a user signs in to the Analytics Service, the Analytics Service — as a web application — creates a session (HttpSession in Apache Tomcat) for the user. A session maintains state information between requests for a particular user of a web application.

The first time the user invokes an filter expression session variable — usually by means of a calling expression such a dynamic applied filter or filter option — the Analytics Services creates an instance of the variable for the user with the value set to the filter expression string. For the duration of the user's session the variable value exist solely in the scope of the user session and is immutable.

You can use the Schema Manager to create and test a filter expression session variable. Using the Formula Builder, a schema developer or similar user can define a filter expression session variable.

You can reference a filter expression session variable in specific expression contexts such as a filter option for a dashboard, an applied filter, or insight filter. You can assign access rights to a filter expression session variable.

The Name of a filter expression session variable:

• must be between 1 and 250 characters in length
• must begin with an alpha character (lower or upper case) or an underscore (_)
• after the first character, can contain zero or more alphanumeric characters in lower, upper, or mixed case
• besides underscores (_), cannot contain special characters, symbols, or spaces
• must be unique
• is case-sensitive

Where can you create a filter expression session variable

You can create a filter expression session variable from the Schema Manager by using the Formula Builder. You need to sign in to Incorta Analytics with a user account that has the Schema Manager role.

Valid references in a filter expression session variable

Here are the types of objects that you can reference in a filter expression session variable:

• Physical_Schema.Table.Column
• Physical_Schema.Incorta_Analyzer_Table.Column
• Physical_Schema.Materialized_View.Column
• Business_Schema.View.Column
• Business_Schema.Incorta_View.Column
• Internal Session Variable
• External Session Variable
• Global Variable
• Presentation Variable in a Dashboard Filter

Valid contexts to reference filter expression session variables

After creating a filter expression session variable, you can reference it in the following contexts.

Access rights for an filter expression session variable

A Super User (tenant administrator) or a user that belongs to a group assigned the SuperRole or the Schema Manager role can create, view, and edit the filter expression session variables in a given tenant.

The following are the available access rights for a filter expression session variable:

Test a filter expression session variable

If you have edit access rights to a filter expression session variable and belong to a group with the necessary role access permission such as Schema Manager or SuperRole, you can test the variable. There are two forms of testing a session variable:

Test: The result of the variable for the current user.

Test As: You can select a different user to test how the variable will display information for that user. This is useful when testing if permissions are configured properly or the output of the variable is dependent on the user.

Steps to test a filter expression session variable

Here are the steps to test a filter expression session variable:

• Sign in to the Incorta Direct Data Platform.
• In the Navigation bar, select Schema.
• In the Schema Manager, select the Session Variables tab.
• In the list view, select a filter expression session variable.
• In the Filter Expression dialog, select on of the following:
  • Select Test to view the result as the current user.
  • Select Test As, and then select a user to view the results as that user.
• Select Cancel.

Additional considerations for a filter expression session variable

Here are some additional considerations for working with a filter expression session variable:

• Modification
• Owner of a scheduled job

Modifications

If the owner or a user that belongs to a group with Edit access rights to a filter expression session variable alters the filter expression for the variable object and saves the modifications, the Analytics Service deletes the session variable for all other active users. For this reason, schema developers should be wary of altering filter expression session variables in production while not in maintenance window. When a user invokes the filter expression variable again, the Analytics Services creates a new instance of the variable for the user.

Owner of scheduled job

The owner of a scheduled job for the email delivery of a dashboard defines the user session for the emailed dashboard. If the dashboard or dashboard insights contain references to a filter expression session variable, the value of the filter expression variable is defined by the user session of the scheduled job owner.