DataSourceSessionToken
- Last Updated: May 12, 2026
- 1 minute read
- OpenAccess SDK
- Version 8.1
- Documentation
Specifies a setting that allows easy correlation of the OpenAccess SDK session as displayed in OpenAccess SDK monitoring/tracing tools, and the RDBMS session as it can be visualized using the RDBMS-specific monitoring/tracing tools.
Associated with each connection, the OpenAccess SDK server creates a session token, which is exported to:
- The monitor tree, if a monitor profile with session monitoring enabled is active.
- The event trace, if an event trace profile that has been configured to trace any session-related events is active.
- An RDBMS-specific session/connection setting, which allows easy correlation of the OpenAccess SDK session as displayed in the OpenAccess SDK monitor, and the RDBMS session as viewed using RDBMS-specific monitoring and tracing tools.
If the length of the session token exceeds the allowed length of the DBMS field, the session token is truncated and a warning is issue.
Valid values
A combination of static text and the following placeholders that will be replaced at runtime by the corresponding values. For example:
Session from ${ClientInfo} connected to ${DataSourceName}
| Placeholder Value | Runtime Value |
| ${ClientApi} | One of JDBC, ODBC, ADMIN, or OLEDB |
| ${ClientInfo} | Client IP address or host name |
| ${ClientApplName} | Application name provided by the client application through the ApplicationName connect attribute/keyword |
| ${DataSourceName} | Name of data source for the current session |
| ${ServiceName} | Name of the OpenAccess SDK service for the current session |
| ${SessionId} | OpenAccess SDK session ID |
| ${ClientApplId} | Application ID being used for the current session |
| ${ClientAutoApplIdDesc} | The text part of the automatic application ID is used for the current session |
Default
None
Type
Dynamic