Using the CIC Studio Auditor

The Auditor view is a diagnostic tool used to identify and troubleshoot integration runtime errors and exceptions. It is also used to manage other log-driven activities, such as process and document-oriented logs, log filtering and customization, reprocessing, and purging. This view contains several sections:

Log Entries
Log Filters
Quick Searches

Log Entries

The Log Entries section displays log data based on different log types and log filters selected in the other sections of the Auditor view. Filters include inbound, outbound, success or failure, etc.

Log types can be at the interchange, group, message levels, etc. (see below for complete list). Each log displays a table of attributes for that selected log type. Date is common to all log types, but the Process log, as shown here, also shows the Process Number and Business Process name. The Group log shows the Group control reference number, the Connection log shows the Connection Number, and so on.

A toolbar provides functionality to manage the display and behavior of selected log entries.

Refresh: reload log entries.
Log Entries Preferences: opens the Preferences window for general log configuration.
Reprocess logs: reprocesses an EDI transaction at the connection, interchange or message level.
Change log status: Changes the log entry status to Completed.
Change acknowledgment status: Change a log entry acknowledgment status (accepted, rejected, etc.).
Delete: Removes log entries.

How to work with individual log entries

Clicking on a log opens a new tab in the Auditor view with log-specific details and processing structure, a key tool in diagnosing errors.

Double-clicking an entry opens up a process tab.

Expand nodes to display details of each task performed by a deployed Business Process. Also, drill down to view source and target data.

Red error notifications can be expanded and investigated for possible error causes.

Reprocessing

Reprocessing allows documents to be processed again after they have been initially processed and logged. Transactions can be reprocessed at the connection, interchange or message log level. After a transaction fails and is corrected, reprocess the proper log from the Auditor.

Reprocessing is particularly useful when, for example, an interchange may have had one of its messages fail, while other messages successfully processed. In this case, that message can be reprocessed after a fix has been applied, and prevents other messages in the interchange from being reprocessed.

Note: An interchange cannot be reprocessed if it has duplicates present in the system. To reprocess, either delete the original interchange (or its duplicate), or re-define the related Inbound EDI Route to process duplicate interchanges.

Changing Auditor Preferences and Entries display

Click the Log Entries Preferences button to display the Preferences window. Its Log Entries panel allows for customization of the display area for each log and Log Filter. Besides column settings, other settings include the ability refresh logs automatically, determine the default number of logs displayed, and adjust log entry font.

Quick Searches

Quick Searches are a log query, available from the Auditor view, which allows you to use and create custom logs based on different log types. This feature allows you to search based upon either basic log type data or specific groupings of commonly-used types and attributes.

Quick Searches can be created with specific conditions, and these can be saved as a Log Filter and added to a Log Filter Group.

All Quick Search results can be viewed from the Log Entries section of the Auditor.

Quick Searches are based on the type of log selected in the Log Type drop-down. The selected log type determines which log information shows on the Log Entries section. Certain features are not available for all log types.

Modify your Quick Search with conditions

A Quick Search can be customized and refined to include specific conditions. Using different expressions and properties, create new conditions to filter for desired results.

Follow these steps to create a Quick Search:

Under the Quick Search section, select a log type.
Click the Add Group button to create either an inclusive or exclusive statement, such as an All (and) or Any (or) statement. This will apply to any child expressions.
Click the Add Columns Expression button to create a new row.
(For Connection log type only) Click the Add Property Expression button to choose specific Properties for searching.
For the Name, Condition, and Value columns, click the appropriate field and select the desired attribute, or populate the value by typing into the field. Different options are available according to log type.

The log results change instantly in the Log Entries section based on your modifications.

Save a Quick Search as a Log Filter

In the example above, if you were to select another log type, the modifications would not be saved. You can however save a Quick Search as a Log Filter and add it to a Log Filter Group for re-use and more effective log management.

Take these steps to save a modified Quick Search as a Log Filter.

Under the Quick Search section, create a Quick Search based on your requirements.
Click the Save Quick Search as a Log Filter button.
Provide a name for your Log Filter.
If desired, you can add this Log Filter to one, or more, Log Filter Groups.
Click OK to complete.

Log Filters

A Log Filter is an activity-based log query made available from the Admin Console | Auditor. It allows you to filter log results based on different groupings, including custom groups.

The Studio uses logs to record system activity. While system activities can be specific to individual objects, such as a Business Process, they may also be set to record specific transformation activity, such as inbound EDI document processing.

Filtering by Log Type

The information returned by a Log Filter corresponds to the type of log being queried. Log types are selected from the Quick Search section, shown below. The selection determines what logs display in the Log Entries section. For detailed information on this section and how it can be used, refer to Quick Searches above.

Available log types include:

Connection: a log that records activity at the EDI connection level.
Interchange: a log that records activity at the EDI interchange level.
Group: a log that records activity at the EDI group level.
Message: a log that records activity at the EDI message level.
Route: a log that records activity for inbound and outbound Routes.
Process: a log that records Business Process activity.
Outbound Acknowledgement: a log that records outbound acknowledgment activity.
Inbound Acknowledgement: a log that records inbound acknowledgment activity.
Interchange Inbound Acknowledgement: a log that records inbound interchange acknowledgment activity.
Group Inbound Acknowledgement: a log that records inbound group acknowledgment activity.
Message Inbound Acknowledgement: a log that records all inbound message acknowledgment activity.

Log Filter Groups

Log Filter Groups are a collection of Log Filters. These can be selected from a drop-down in the Log Filter Group section. The group you select determines which logs display in all other sections of the Auditor view.

Log Filter Groups can be used from the Studio in which they were created. User-created Log Filter Groups are not available for all Studio users, as they exist within the local Workspace. Log Filter Groups can be accessed from the Workspace installation in a folder called logFilterGroups. These files can be distributed among other Studio team members, or even placed inside of a Project and shared with an SVN Repository.

While custom Log Filter Groups can be created, the following default groups are provided:

Group	Description
All User Created	This group shows all custom Log Filters.
Application	This group contains these Log Filters: Process: Shows the date, process number, and name for Business Process activity.
Inbound EDI	This group contains these Log Filters: Connections – Inbound: Shows the date and connection number for inbound activity. Interchanges – Inbound: Shows the date and interchange control reference for inbound activity. Process – Inbound: Shows the date, process number, and name for inbound Business Process activity.
Outbound EDI	This group contains these Log Filters: Connections – Outbound: Shows the date and connection number for outbound activity. Interchanges – Outbound: Shows the date and interchange control reference for outbound activity.
Unsuccessful Outbound EDI	This group contains these Log Filters: Connections – Outbound – Unsuccessful: Shows the date and connection number for unsuccessful outbound activity. Interchanges – Outbound – Unsuccessful: Shows the date and interchange control reference for unsuccessful outbound activity.
Status Checks	This group contains these Log Filters: Inbound Ack Failures: Shows the date, Message ID, and segment reference for inbound acknowledgement that have not been accepted. Outbound Group Ack Rejected: Shows the date and Group control reference for rejected outbound acknowledgements. Unsuccessful Connections: Shows the date and connection number for unsuccessful connections, including those not delivered to ESX. Unsuccessful Processes: Shows date, process number, and name for unsuccessful Business Processes.

Related Topics: