Tools → Schema Manager → Session Variables

Session Variables list view

By default, the Session Variable items appear in alphabetical, ascending order. The list shows 20 items at a time. When you select multiple items that you can edit (i.e. items that you own or have Edit access rights to), the Delete option (trash can icon) is available on the Search bar. Use it to delete all the selected items. When you select only one item that you can edit, the following options appear:

  • Edit (pen icon): use to edit the selected item
  • Share (people icon): use to share the selected item
  • Delete (trash can): use to delete the selected item

For Session Variables, the list view shows the following properties:

PropertyControlDescription
NametextThe name of the session variable
DescriptiontextThe description of the session variable, if any
TypetextThe session variable type:
  ●  External
  ●  Internal
  ●  Filter Expression
PermissiontextShows the access rights:
  ●  View
  ●  Share
  ●  Edit
OwnertextThe display name of the user creator
Edit (pen icon)icon linkOpens the item details dialog (depending upon the session variable type) for editing:
  ●  External Variable dialog
  ●  Internal Variable dialog
  ●  Filter Expression dialog
View (eye icon)icon linkOpens the item details dialog for viewing only. This button is available if you have view or share access rights to the session variable.
Share (people icon)icon linkOpens the Share dialog. This button is available if you have view or share access rights to the session variable.
Delete (trash can icon)icon linkOpens the confirmation dialog for the session variable deletion
Note
  • By default, you can delete only items that you have Edit access rights to.
  • When the Cluster Management Console (CMC) admin turns the Enable Super User Mode option on, the Super User and users with the SuperRole can manage all session variables regardless of the access rights.
  • Only the Super User tenant administrator can view the list of all items on the Schema Manager regardless of the access rights to them and the Enable Super User mode option.

Schema Manager actions for session variables

Using the Schema Manager, you can perform the following actions for session variables:

Important

Validation Rules for a session variable name

A session variable name…

  • Must be unique
  • Must be between 1 and 250 characters in length
  • Must begin with an alpha character, lower or upper case
  • After the first alpha character, can contain zero or more alphanumeric characters in lower, upper, or mixed case
  • After the first alpha character, can contain zero or more underscore (_) characters
  • Besides underscore (_), cannot contain special characters, symbols, or spaces

Create an external session variable

An external session variable stores a scalar value or an array of values from the result of a query to an external data source. For more information, please refer to Concepts → External Session Variable

Here are the steps to create an external session variable:

  • In the Navigation bar, select Schema.
  • In the Action bar, select + NewSession VariableExternal Variable.
  • In the External Variable dialog, in Name, enter the name of the external session variable.
  • In Description, optionally enter a description.
  • In Data Source, select the data source to query its data.
  • In Query, construct the query to request and retrieve data from the selected data source. The query result is the external session variable value(s).
  • Optionally, select Test to test the query expression for the logged-in user and view the query value(s), if any. You can select a user to test the query expression for and view the query value(s).
  • Select Add.

Create an internal session variable

An internal session variable stores a scalar value or an array of values from the result of an internal query expression. Using the Formula Builder, you can define an internal query expression. An internal query expression queries a physical schema object or runtime business view. In this regard, the adjective “internal” references physical schemas and business schemas within a given tenant. For more information, please refer to Concepts → Internal Session Variable

Here are the steps to create an internal session variable:

  • In the Navigation bar, select Schema.
  • In the Action bar, select + NewSession VariableInternal Variable.
  • In the Internal Variable dialog, in Name, enter the name of the internal session variable.
  • In Description, optionally enter a description.
  • Select Query to invoke the Formula Builder to construct the internal query expression to request and retrieve data from a physical schema object or runtime business schema view. The query result is the internal session variable value(s).
  • Optionally, select Test to test the internal query expression for the logged-in user and view the query value(s), if any. You can also select another user to test the query expression for.
  • Select Add.

Create a filter expression session variable

A filter expression session variable is a filter expression created in the Schema Manager. Incorta introduces filter expression session variables to allow you to create a filter expression just once and reference it in different contexts. For more information, please refer to Concepts → Filter Expression Session Variable.

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

  • In the Navigation bar, select Schema.
  • In the Action bar, select + NewSession VariableFilter Expression.
  • In the Filter Expression dialog, in Name, enter the name of the filter expression session variable.
  • In Description, optionally enter a description.
  • Select Filter to invoke the Formula Builder to construct the filter expression.
  • Select Add.
Note

Testing the filter expression session variable will only show the filter expression, as the filter expression is only a boolean expression that returns true or false when evaluated in its context.

View a list of session variables

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • On the Session Variables tab, review the list view of session variables.

Search for a session variable

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • On the Session Variables tab, in the Search bar, enter a search term.
  • Review the list view of session variables.

To reset the search, in the Search bar, in the search box, select the remove button (x)

Edit a session variable

You can edit session variables that you own or have edit access rights to.

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • In the list view of session variables, for a given session variable that you can edit, do one of the following:
    • select any part of the row
    • select Edit (pen icon)
    • select the checkbox, and then in the Search bar, next to Selected, select Edit (pen icon)
  • In the dialog, you can do the following:
    • add or edit the session variable description
    • edit the query expression of an internal or external session variable or the filter expression of a filter expression session variable, and save updates
    • test the session variable as the logged-in user
    • test the session variable as another user
  • To save updates, select Save.

View session variable details

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • In the list view of session variables, for a given session variable, select View (eye icon) or select any part of the row.
  • In the dialog, review the details of the session variable.

Share a session variable

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • In the list view of session variables, for a given session variable, select Share (people icon).
  • In the Share dialog, you can do the following:
    • remove an existing user or group
    • modify the existing access rights for a user or group
    • add a new user or group with the access rights

Delete a session variable

You can delete items that you own or have Edit access rights to.

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • In the list view of session variables, for a given variable row, select Delete (trash can icon).
  • In the dialog, select Delete.

Delete one or more session variables

You can delete items that you own or have Edit access rights to.

  • In the Navigation bar, select Schema.
  • In the Context bar, select the Session Variables tab.
  • In the list view of session variables, for each variable that you want to delete, select the checkbox. You have to select only items that you own or have Edit access rights to.
  • In the Search bar, next to Selected, select the delete icon (trash can).
  • In the dialog, select Delete.