Logging Options

BI xPress ›› Features ›› Auditing ›› Workbench ››
Parent Previous Next

Logging Options


The Logging Options section allows users the ability to customize how the Auditing Framework will control Basic, Data Flow, Connection, Parameter, and Variable, and Advanced User Defined Logging Options.


Basic Options

The Basic section controls other logging options that do not control details regarding Data Flow, Connection, Parameter, and Variable, and Advanced User Defined Logging Sections.



1.   Script Language: Controls which programming language the user wishes the Auditing Framework to use within Script Tasks

2.   Maximum Loop Iterations: Controls how many loops within a For or For Each Loop they wish to document. Setting this value to 0 means to log all iterations

3.   Log Warnings: Controls whether or not a user wishes to have warnings that are encountered during executions to be logged within the BI xPress database


Data Flow Logging Options

The Data Flow Logging section controls logging details within each Data Flow present within each SSIS Packages.


1.   Real-time Data Flow Monitoring: Controls whether or not the Auditing Framework will monitor data flows in real-time


Important Note:

If real-time Data Flow monitoring is turned off, some of the features of Monitoring Console's Execution Diagram will be unavailable


2.   Row Count Logging: Controls whether or not the Auditing Framework will capture row counts flowing inside data flows. When enabled, each data flow will be modified to track row count data.

1.   Source Row Count Logging: If row count logging is enabled, controls whether or not the Auditing Framework will track how many rows are coming from source components.

2.   Destination Row Count Logging: If row count logging is enabled, controls whether or not the Auditing Framework will track how many rows are going to destination components.

3.   Source SQL Statement Logging: If row count logging is enabled, controls whether or not the Auditing Framework will log SQL Statements used to extract data. This information can be viewed using BI xPress' Extract / Load Detail Report.

4.   Connection Detail Logging: If row count logging is enabled, controls whether or not the Auditing Framework will log details for each source and destination component regarding the connections used.


Connection, Parameter, and Variable Logging Options

The Connection, Parameter, and Variable Logging section controls logging details for connection managers, parameters, and variables within each SSIS Packages.



1.   Connection Logging: Controls whether or not the Auditing Framework will log every connection manager's connection string value during run-time

2.   Variable Logging: Controls whether or not the Auditing Framework will log variable values during an SSIS execution. If no other options are enabled, variable values are logged two times during package execution: when the package execution is started and when the package execution completes

1.   Object Variable Logging: If variable logging is enabled, Controls whether or not the Auditing Framework will allow the logging of object variables

2.   Initial Parameter Value Logging: If variable logging is enabled, Controls whether or not the Auditing Framework will also log the initial values of parameters

3.   Variable Logging Type: If variable logging is enabled, Controls whether or not the Auditing Framework will change the behavior of variable logging to either log all variables, or only variables used within For Each loops


Advanced User Defined Logging Options

The Advanced User Defined Logging section allows users to explicitly specify the logging of specific variables within the Auditing Framework.



1.   Custom Variable Logging: Custom Variable Logging enables custom variable logging and will allow the Auditing Framework the ability to explicitly specify the logging of specific variables.

1.   Numeric Variables: If custom variable logging is enabled, the three Numeric Variable text boxes allow users to log up three custom variables of a numeric data type

2.   String Variables: If custom variable logging is enabled, the three String Variable text boxes allow users to log up three custom variables of a string data type

3.   Data Variables: If custom variable logging is enabled, the three Date Variable text boxes allow users to log up three custom variables of a date data type

4.   Events to Log: If custom variable logging is enabled, Event to Log allow users to specify upon which event(s) they wish for the above custom variables to be logged:

  OnPreExecute (Start): When enabled, all custom variables will be logged at the start of the selected logging scope(s)

  OnPostExecute (End): When enabled, all custom variables will be logged at the end of the selected logging scope(s)

  OnError: When enabled, all custom variables will be logged when an error occurs

  OnWarning: When enabled, all custom variables will be logged when a warning occurs


5.   Logging Scope: If custom variable logging is enabled, Custom Logging Scope(s) allows users to specify the scope of custom logging:

  Package Level: When enabled, custom variables will be logged at the Package Level for the events specified in the Events to Log section

  Task Level: When enabled, custom variables will be logged for every task using for the events specified in the Events to Log section


Once done setting additional logging options, users can continue to any of the following sections:

  Database Connection

  Connection Manager

  Package Grouping

  Configuration Options


Users may also immediately begin applying or removing the auditing framework.