1. Home
  2. On-premises 5.2
  3. Guides
  4. Tours
  5. Concepts
    1. Aggregate filter
    2. Alias
    3. Apache Avro™
    4. Apache Kafka™
    5. Applied filter
    6. Base table
    7. Bookmark
    8. Business schema
    9. Business schema view
    10. Business schema view column
    11. Business schema view formula column
    12. Column
    13. Connector
    14. Dashboard filter
    15. Dashboard folder
    16. Dashboard runtime filter
    17. Data agent
    18. Data alert
    19. Data destination
    20. Date system variable
    21. Distinct filter
    22. Expression
    23. External data source
    24. External session variable
    25. Filter expression
    26. Filter expression session variable
    27. Filter option
    28. Formula column
    29. Formula expression
    30. Full load
    31. Global Variable
    32. Incorta Analyzer Table
    33. Incorta Analyzer Table column
    34. Incorta Analyzer Table formula column
    35. Incorta Analyzer View
    36. Incorta Analyzer View formula column
    37. Incorta SQL Table
    38. Incorta SQL View
    39. Individual filter
    40. Insight filter
    41. Internal query expression
    42. Internal session variable
    43. Join
    44. Join condition
    45. Join condition column
    46. Join filter
    47. Join filter column
    48. Level based measure
    49. Load filter
    50. Local data file
    51. Local data folder
    52. Materialized View
    53. Materialized View Column
    54. Materialized View Formula Column
    55. Measure filter
    56. Miscellaneous system variable
    57. Multi-Source table
    58. Physical schema
    59. Physical schema table
    60. Physical schema table column
    61. Physical schema table formula column
    62. Physical schema table runtime security filter
    63. Presentation variable
    64. Prompt
    65. Query system variable
    66. Runtime business view
    67. Runtime business view formula column
    68. Runtime security filter
    69. Session variable
    70. Shared Storage
    71. SQL Interface
    72. Upgrade Readiness
    73. Variable
    74. Visualization
  6. Tools
  7. References
  8. Integrations
  9. Data applications
  10. Releases

Concepts → External Session Variable

About an external session variable

An external session variable is a tenant object that defines a SELECT command for an SQL statement to an external data source. In this regard, the adjective “external” describes a reference to the external data sources defined within a given tenant.

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 external session variable — usually by means of a calling expression such a formula expression — the Analytics Services creates an instance of the variable for the user, executes the SELECT query for the external data source, and then assigns the query result as the variable value for the given user's session. From the results of the SELECT query, the value can be a scalar value of type String or an array of values of the type String. The value for an external session variable is mutable.

You can use the Schema Manager to create and test an external session variable. You can reference an external session variable in specific expression contexts such as a formula expression or filter expression. You can assign access rights to an external session variable.

The Name of an external 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

Properties of an external session variable

The following are the properties of an external session variable:

PropertyControlDescription
Nametext boxEnter the name of the external session variable
Descriptiontext boxOptional description of external session variable.
Data Sourcedrop down listSelect the data source to query data for use in the external session variable.
Querytext boxConstruct the query to request data from a data source. Query result will be the external session variable value.

Example of the Query property for an external session variable

In the following example, the WHERE clause references the $user miscellaneous system variable.

SELECT ID FROM USER WHERE LOGINNAME = $user

Even though ID is of the tpye INT in this example, the external session variable stores the scalar value as string or as an array of scalar values as strings.

Access rights for an external 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 external session variables in a given tenant.

Note: Super User and SuperRole access rights

  • 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 all session variables regardless of the access rights and the Enable Super User mode option.

The following are the available access rights for an external session variable:

PropertyIconDescription
Can VieweyeThe user can View the external session variable, for example, in the Formula Builder.
Can Sharenode treeThe user is able to Share the external session variable with other users.
Can Editpen and paperThe user is able to Edit the external session variable.

Test an external session variable

If you have edit access rights to an external 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.

Note

The result of a test on an external session variable is independent of the current user’s session. As such, if the external data source is updated during your session the test result will reflect the change. Your session’s captured value of the external session variable will not express this update. You will need to sign out and start a new session to have your external session variable value updated.

Steps to test an external session variable

Here are the steps to test an external 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 an external session variable.
  • In the External Variable 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 an external session variable

Here are some additional considerations for working with an external session variable:

  • Conversion
  • Modification
  • Owner of a scheduled job

Conversion

Regardless of the source data type, an external session variable stores a scalar value as a string or array of scalar values as strings. When you use an external session variable in a formula expression or filter expression, you may need to convert the string value to another data type using a built-in conversion function.

Modification

If the owner or a user that belongs to a group with Edit access rights to an external session variable alters the query 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 external session variables in production while not in maintenance window. When a user invokes the external session 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 an external session variable, the value of the variable is defined by the user session of the scheduled job owner.