Diagnostic Framework

Diagnostic Framework Overview

The diagnostic framework provides features to review the journal entries created by the Subledger Accounting program. It provides the input data used for each transaction, such as the following:

The following examples describe typical uses of the diagnostic framework features.

Diagnostic Framework Business Process Flow Diagram

The figure below illustrates the business process for the generation and the report of the diagnostic framework output data and is described in the succeeding text.

Diagnostic Framework Business Process Flow

the picture is described in the document text

The following steps describe the diagnostic framework business process flow:

  1. The administrator sets the SLA: Enable Diagnostics profile option to Yes for the user or responsibility.

    See: SLA: Enable Diagnostics

  2. Users submit the Create Accounting program which automatically executes the diagnostic framework to populate the diagnostic tables.

  3. The diagnostic framework gathers source values and other information from the transaction objects.

  4. Users submit the Transaction Objects Diagnostics concurrent request to view the diagnostic report.

  5. The administrator submits the Purge Transaction Objects Diagnostics concurrent request to purge the results of the diagnostic framework.

Diagnostic Framework Features

The diagnostic framework features are as follows:

SLA: Enable Diagnostics Profile Option

The SLA: Enable Diagnostics profile option controls whether diagnostic information is gathered by the Create Accounting program.

See: SLA: Enable Diagnostics

Diagnostic Framework Execution

If the SLA: Enable Diagnostics profile option is set to Yes, the diagnostic framework is executed simultaneously with the Create Accounting program. The diagnostic framework data is stored in the diagnostic tables.

Transaction Objects Diagnostics Report

To view the diagnostic framework report, users submit the Transaction Objects Diagnostics program with the parameters described in the table below.

Transaction Objects Diagnostics Report Parameters
Field Description
Ledger Optional; limits the diagnostic data selected to those of a particular ledger
If the SLA: Enable Data Access Security in Subledgers profile option is set to Yes, only those ledgers that are included in the General Ledger Access Sets assigned to the responsibility appear in the list of values. If this profile option is set to No, all ledgers are included.
List of values includes primary and secondary ledgers with subledger accounting methods assigned to them.
Event Class Name Optional; limits the diagnostic data to the specified event class within the application
List of values includes the event classes for the corresponding application.
Event Type Name Optional; limits the diagnostic data to the specified event type within the event class. To enable this event, users enter a transaction number.
List of values includes the event types matched with the current application, entity, and event class.
If no event class is selected, users cannot enter a value. If an event class is entered, the value from the list of values is dependent on the value of the event class. If the event type field is blank, all the event types are selected.
Transaction Number Optional; limits the diagnostic data retrieved to the specified transaction. To enable this field, users must enter a transaction number.
Event Number Optional; limits the diagnostic data retrieved to the specified event
From Extract Line Number Optional; displays the data for the transaction object lines that are equal to or higher than the number specified
To enable this field, users must enter a transaction number and an event number.
List of values includes all transaction object line numbers for the given event.
To Extract Line Number Optional; displays the data for the transaction object lines that are equal to or lower than the number specified
To enable this field, users must enter a transaction number and an event number.
List of values includes all transaction object line numbers for the given event.
Accounting Program Request ID Optional; restricts the diagnostic data to the specified request ID
List of values retrieves the request IDs stored in the diagnostic framework tables.
Errors Only Required
If Yes is selected, displays the diagnostic framework data only for the events that meet the selection criteria and whose status is Error. Default is No.
Display Source Name Required
If Yes is selected, the source name is displayed. If No is selected, the source code is displayed. Default is No.
Display Accounting Attributes Required
If Yes is selected, the accounting attributes are displayed. Default is No.

Purge Transaction Objects Diagnostics

Diagnostic framework data can be purged:

The table below describes the parameters for the Purge Transaction Objects Diagnostics program.

Purge Transaction Objects Diagnostics Program Parameters
Parameter Description
Application Restricts the purge of diagnostic data to a particular application; value defaulted to the application owning the responsibility from which the program is launched
End Date Purges the diagnostic data up to the given date
Accounting Program Request ID Purges the diagnostic data for a given request ID, which corresponds to an execution of the Create Accounting program
The list of values includes all request IDs for previous executions of the Create Accounting program with diagnostics enabled.