Audit Code Requirements and Options

When you define audit code for either scenario, make sure that the code does not write any output to the current device. Also make sure that it does not kill any % variables required by InterSystems IRIS® data platform.

Your code can use the following variables:

$USERNAME — name of the current user.
$ROLES — roles of the current user.
%dsQueryText — text of the current query.
%dsCubeName — logical name of the cube used in the current query.
%dsResultSet — current instance of %DeepSee.ResultSetOpens in a new tab, which you can use to access other information, if needed. For details on working with %DeepSee.ResultSetOpens in a new tab, see Executing Business Intelligence Queries Programmatically.
%dsDashboard — name of the dashboard that is being accessed, if any.

Typically, audit code writes output to a file or to a global.

Note that %dsQueryText, %dsCubeName, and %dsResultSet are only available to audit routines using ^DeepSee.AuditQueryCode, while %dsDashboard is only available to routines using ^DeepSee.AuditCode.

Example