Configure Options


The Configure page provides users with in-depth options allowing a user to fully customize the behavior of the Auditing Framework. This page is only visible if the user is adding the Auditing Framework to packages.


1.   Use configurations: Allows the users to specify whether or not they wish to add parameters to their packages in order to control the behavior of the Auditing Framework



1.   Configure Scope: If configurations are enabled, the Configuration Scope switch details whether to save the parameters as Project or Package parameters. Project parameters will control the behavior of the auditing framework for all packages within the ISPAC, while package parameters will only control the behavior of the auditing framework for the packages on an individual basis.

2.   Add parameter to enable or disable the Auditing Framework: This parameter will allow users to manually turn off the Auditing Framework

3.   Add parameter to enable or disable variable, parameter, and connection logging: This parameter will allow users to manually turn off the logging of variable, parameter, and connection managers

4.   Add parameter to enable or disable real-time Data Flow monitoring: This parameter will allow users to manually turn off the Auditing Framework's real-time Data Flow monitoring.

5.   Add parameter to enable or disable logging of all warnings: This parameter will minimize the amount of logging that occurs by not logging warnings that occur during execution

6.   Add parameter to specify variable and connection log filtering: This parameter allows users to manually mask sensitive values contained within variables from being displayed when executions are viewed within the Monitoring Console.

2.   Package Groups: The package grouping helps create and associate packages to groups. Once associated with a group, the package execution panel can filter packages based on groups.



Package can belong to one or more groups. By clicking on "add new items" users can add new groups. Users can include preexisting groups by selecting a group's check box.


3.   Script Language: The Script Language switch allows users to specify which programming language they wish the Auditing Framework to use within Script Tasks




4.   Max Loop Iterations: The Max Loops textbox allows users to specify how many loops within a For or For Each Loop they wish to document. Setting this value to 0 means to log all iterations



5.   Log Warnings: The Log Warnings switch allows users to specify whether or not a user wishes to have warnings that are encountered during executions to be logged within the BI xPress database



6.   Real-time Data Flow Monitoring: The real-time Data Flow monitoring switch allows users to specify whether or not they wish to include the ability to monitor their package's 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


7.   Row Count Logging: The Row Count Logging switch allows users to capture row counts flowing inside your Data Flows. When you enable row count logging, each data flow task will be modified to track row count data.



1.   Source Row Count Logging: If row count logging is enabled, the Source Row Count Logging switch will track how many rows are coming from source components.

2.   Destination Row Count Logging: If row count logging is enabled, the Destination Row Count Logging switch will track how many rows are going to destination components.

3.   Source SQL Statement Logging: If row count logging is enabled, the Source SQL Statement Logging switch will log SQL Statements used to extract data. This information can be viewed using BI xPress' Extract / Load Detail Report found within Pragmatic Workbench.

4.   Connection Detail Logging: If row count logging is enabled, the Connection Detail Logging switch will log details for each source and destination component regarding the connections used

8.   Connection Logging: The Connection Logging switch allows users to log every connection manager connection string value during run-time.



9.   Variable Logging: The Variable Logging switch allows users to 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, the Object Variable Logging switch will allow the logging of object variables

2.   Initial Parameter Value Logging: If variable logging is enabled, the Initial Parameter Value Logging option will also log the initial values of parameters

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

10.   Custom Package Variable Logging: The Custom Package Variable Logging switch allows users to explicitly specify the logging of specific variables within the Auditing Framework.



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

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

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

4.   Events to Log: If custom package variable logging is enabled, the Event Logs check boxes allows users to specify upon which event(s) they wish for these custom variables to be logged:

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

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

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

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

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

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

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


After selecting an action, setting up the database, connection manager, and configuration options, click either the add or remove Auditing Framework button.



The add or remove Auditing Framework button that is visible is dependent on which action was selected. Upon clicking the add or remove Auditing Framework button, users will immediately be sent to the Progress screen.