Appenders

Viewing Logs

The system and audit logs generated by file appenders are stored on the TeamConnect server. You can view logs by:

• Clicking a View Log link from TeamConnect.
• Opening the file on the TeamConnect server.

To view a log file

1. Click the Admin tab.
2. Click the Logging link under the tab bar.
3. To view a system log file
   • Click the System link from the left pane.
     The System Logging page displays.
   • From the System Appenders section, locate the name of the log you want to view and click the corresponding View Log link.
4. To view an audit log file
   • Click the Audit link from the left pane.
     The Audit Logging page displays.
   • From the Audit Appenders section, locate the name of the log you want to view and click the corresponding View Log link.
5. The current log file for the log you selected is displayed in a new browser window. The most recent log events are listed at the bottom of the log file.

Things to Remember

• If a log file is very large, clicking the View Log link might cause a lockup in your browser session as it tries to transfer the large amount of data from the server. If this is a concern, right- click the View Log link, then choose context menu item Save Link As, then save the log to a file on a local disk drive. Open that local file with your browser.
• To view the latest log messages, press F5 or click your browser's Refresh button.
• For both System Appenders and Audit Appenders, if TeamConnect is running on a cluster of application servers, a drop-down list to the left of the View Log link allows you to choose the specific node whose log you wish to view. Node names consist of a machine name, followed by a numeric process ID.
• The log location is specified using the app.logFolder parameter in the Web Application Deployment Descriptor when TeamConnect is installed.

Default TeamConnect Log Folders

If you did not update the Log Folder field (app.logFolder parameter) when updating the teamconnect.properties file using the TeamConnect Installer, you can find TeamConnect logs in the following locations:

• For Apache Tomcat (Linux)—/<Apache_HOME>/bin/logs
  For example:
  /opt/tomcat/apache-tomcat-6.0.16/bin/logs
• For Apache Tomcat (Windows)—C:\<Apache_HOME>\logs
  For example:
  C:\Program Files\Apache Software Foundation\Tomcat 6.0\logs
• For WebLogic (Linux)—<WebLogic_Home>/user_projects/domains/<domain_name>/logs
  For example:
  /opt/bea/user_projects/domains/Mitratech/logs
• For WebSphere—<WebSphere_Home>/AppServer/profiles/<profileName>/logs
  For example, on Windows:
  C:\WAS61\WebSphere\AppServer\profiles\AppSrv02\logs\

Managing Log Files for Multiple TeamConnect Instances on the Same Tomcat Server

When multiple TeamConnect instances are deployed on the same Tomcat server, the log files should be renamed according to the respective instance. This ensures that logs are captured based on the parameters set for each specific instance.

To understand how to rename log files, follow these steps:

Instruction	Screen capture for reference
Go to TeamConnect Setup > System Settings > . System Appenders
Navigate to Global Search Appender (or any other specific appender you need to modify).
Under File Appender Information, update the log File Name to match the instance version.
For Example	For TCE 7.1.0, rename the file name to “globalSearch-710”. For TCE 7.2.0, rename the file name to “globalSearch-720”.
This way, logs remain properly categorized for each TeamConnect instance.

Clearing Logs

For troubleshooting or maintenance purposes, you can manually clear the contents of a log. Clearing a log is different from rolling over a log in that the existing contents of the log will be deleted and not archived to a back-up file.

For example, one scenario in which clearing a log is useful is when you are trying to isolate the log messages related to a specific functional issue. You might clear a log, change the related logger's logging severity level to DEBUG, and then try to reproduce the issue. Afterward, the log would most likely isolate the event messages that can help troubleshoot the issue.

To clear a log file

1. Click the Admin tab.
2. Click the Logging link under the tab bar.
3. To clear a system log file
   • Click the System link from the left pane. The System Logging page opens.
   • From the System Appenders section, locate the name of the log you want to clear and click the corresponding Clear Log link.
4. To clear an audit log file
   • Click the Audit link from the left pane. The Audit Logging page opens.
   • From the Audit Appenders section, locate the name of the log you want to clear and click the corresponding Clear Log link.
5. To view any new log messages, click the corresponding View Log hyperlink.

Changing System Logging Levels

Each message that can be written to a log has an associated log level that indicates the severity of the issue that caused the message to be written to the log. You can specify what severity of messages you want logged for each logger (or TeamConnect component).

Note: This is a system-wide setting. When you set a logger to a specific log level, you are specifying the most verbose severity level of messages that you want written to appenders defined for that logger. Although there is an analogous setting in the appender definition for log threshold, the logger's logging level overrides the log threshold.

To set the system logging level

1. Click the Admin tab.
2. Click the Logging link under the tab bar.
3. To change a system logger's logging level
   • Click the System link from the left pane.
   • From the System Loggers or Detailed System Loggers section, scroll to a logger. From the corresponding Level drop-down list, select a logging level:
     • Debug — Minor, frequent events in TeamConnect.
     • Info — Significant, frequent events in TeamConnect.
     • Warn — Minor issues external to TeamConnect.
     • Error — Serious issues that are usually associated with a Java exception.
     • Fatal — Rarely used in TeamConnect.
       By default, system logger levels are set to Error, but you can adjust the severity based on the type of information you need to be captured in your logs.
       See System Loggers and Detailed System Loggers for a description of the system loggers that come with standard TeamConnect.
4. Click Update.

Your changes take effect immediately. All appenders defined for these loggers are now logging messages according to the log level that you have specified, and according to each appender's threshold.

Viewing Logs Generated by File Appenders

The system and audit logs generated by file appenders are stored on the web server in a location that is specified when TeamConnect is installed. If you have access to the web server, you can directly view the logs on the server.

If you do not have access to the web server, you can view the logs directly in TeamConnect using the View Log hyperlink that is provided for each file appender.

Tip: To find out where your logs are stored, see the path displayed in the Application Logs Folder field in a file appender screen.

The log location is specified using the app.logFolder parameter in the Web Application Deployment Descriptor when TeamConnect is installed.

To view a log file

1. On the Admin menu bar in the System Settings drop-down list, select either System Logging or Audit Logging, depending on the type of log you want to view.
   The Logging screen opens, with the corresponding tab displayed by default.
   

2. In the System Appenders (or Audit Appenders) section of the tab, locate the name of the log you want to view and click the corresponding View Log hyperlink.
   The current log file for the log you selected is displayed in a new browser window. The most recent log events are listed at the bottom of the log file.
3. To view the latest log messages, press F5 or click your browser's Refresh button.

Clearing Logs Generated by File Appenders

If the Rollover Policy field of an active file appender is set to Rollover on schedule, you can manually trigger the removal of the current log entries in a log file and start logging again in an empty file.

To clear a log file

1. On the Admin menu bar in the System Settings drop-down list, select either System Logging or Audit Logging, depending on the type of log you want to clear.
   The Logging screen opens, with the corresponding tab displayed by default.
2. In the System Appenders (or Audit Appenders) section of the tab, click the Clear Log hyperlink next to the file appender log you want to clear.
   
   The current log entries in the log file are removed and logging begins in the empty file.
3. To view any new log messages, click the corresponding View Log hyperlink.

Rolling Over Logs Generated by File Appenders

If the Rollover Policy field of an active file appender is set to Rollover on size, you can manually trigger the rollover of the current log file and start logging again in new file.

To clear a log file

1. On the Admin menu bar in the System Settings drop-down list, select either System Logging or Audit Logging, depending on the type of log you want to clear.
   The Logging screen opens, with the corresponding tab displayed by default.
   
2. In the System Appenders (or Audit Appenders) section of the tab, click the Rollover hyperlink corresponding to the file appender log you want to roll over. The current log file is rolled over and logging begins in an empty file.
3. To view any new log messages, click the corresponding View Log hyperlink.

To utilize the XML layout, you need to create the necessary files to use the XML output as content that is pulled in and formatted correctly.

Log Rollover Access

Note: Introduced in TCE 7.1 version.

Earlier versions of TeamConnect (TCE 7.0 and older versions), the user did not have certain functionality where they could roll over logs and view them from TeamConnect. To address this, a new feature is introduced in which the user can go to TeamConnect and click on the archive logs to determine which logs were rolled over.

The user can access rolled-over logs from the TeamConnect user interface. There will be a 'Archived Logs' hyperlink for each System Appender. On clicking this hyperlink, a modal will appear with the last 14 rolled-over archived logs based on the last modified date.

Note: Make sure that the user has login with the user account that has group rights equivalent to TeamConnect Admin group.

Below are the steps to follow for System and Audit Appenders:

Steps to follow	Screenshots for reference
Open TeamConnect. Login to TeamConnect with Admin User. Navigate to Admin > Logging > System. After scrolling down, the user finds a block called “System Appenders”. The user can find "Archived Logs" under the action column for only the File Appender type, along with the hyperlink.
Note: Additionally, the same functionality has been added for Audit appenders of the File Appender type. View Archived logs will be visible and clickable for appenders whose type is “File Appender” in Setup window and it will not be there for SMTP/Socket/CSM Appender types.
Click on the “Archived Logs” hyperlink in the Action column and a modal will appear with the 14 rolled-over archived logs based on the last modified date. Note: The user still has access to the legacy data, as previous old logs will be present in the app server's log section.
The modal will have a table with 4 columns: Name Rolled Over Date Size Action. To download the respective logs, click the download button under the Action table. Note: If there are no rolled over logs, there will be no records in the table.
Note: If an error occurs when the user clicks on the ‘Archived Logs’ hyperlink, an error message appears stating that, “Error- Unable to complete your request due to an unexpected error, please try again after a few minutes.”
Note: The user has the option to clear and rollover for Rollover policy by size and schedule, so the user can either clear the log by clicking "Clear" or save it and clear it by clicking "Rollover." For example, for “Default” System Appenders,  if the Rollover policy is set to “Rollover by Size & Schedule”, then the user can see both ‘Clear’ & ‘Rollover’ options under the Action column. If any appender has a Rollover by Size, then only the Rollover option will be visible (For example: “XML Appender” in above screen capture). When a user clicks on the Rollover hyperlink, all logs will be archived with a new index value appended & the current log will be cleared. If any appender has a Rollover by Schedule, then only the Clear option is visible (For example: “Global Search Appender” in above screen capture). When a user clicks on the Clear hyperlink, the current log will be cleared without saving. Clicking the "Clear" button will only clear the view logs and not the archived logs. It will remain intact, and all of the logs will be present. The same above functionally is applicable for Audit Appenders also.

Modify Log Rollover Policy

Note: Introduced in TCE 7.1 version.

Introduced a new rollover policy called “Rollover by Schedule & Size” where the user will be able to manage logs based on ‘schedule and size’ for efficient log management in Setup window.

Below are the steps to follow for System Appenders:

Steps to follow	Screenshots for reference
Open TeamConnect. Login to TeamConnect with Admin User. Navigate to Setup window. Click the System Settings Dropdown and select System Appenders.
For the new Appender, click New button. Note:  The user can enable the “Roll Over” and “Clear Log” options in the File appender type in the Setup window while choosing “Roll over by size & schedule”, so that they can perform the required actions.
Under the File Appender Information section, click on the Rollover policy dropdown and select "Rollover by Schedule and Size".
The user can see the below two fields are displayed on the screen. Max. File Size(MB): [Default value of ‘50’]. Backup Schedule: Dropdown with values [Daily (set as default), Weekly & Monthly].
Based on our selection (Rollover by Schedule and Size), which is a combination of both, so once the file size reaches the set limit and the set schedule, the file will automatically get rolled over. For example, if the file size is set to 1MB or if it is scheduled as Daily, whichever comes first, the file will get rolled over. The file rollover will be compressed to a zip file, which in return saves lots of space. From the Layout dropdown, the user can select Pattern Layout and the corresponding Pattern text field will be displayed that are present for the “Rollover by Schedule” & “Rollover by Size” policies. For HTML Layout and XML Layout there are no changes. Note: In case of existing appender, when the user selects the  Pattern Layout, the corresponding “Pattern text field” has existing values that are present for the “Rollover by Schedule” & “Rollover by Size” policies.
Note: When a user enters “\” in the file name under File Appender information, it will be auto-corrected to “/” on clicking the “Save” or “Save & Close” button. Avoid using the below special characters in the file name when navigating to Setup window > System Settings > System Appender > File Appender Information > File Name. / ! @ # $ % ^ & ( ) + _ - = { } [ ] | : ' “ , ? ` ~; ' “ , ?
For Max. File Size (MB), if the user sets the value as 0 (zero) and clicks the Save button, a pop-up appears stating the message, "0: "Max File Size" should be greater than 1MB!".
If the user sets the value less than 0 (zero) (E.g.: -11) and clicks the Save button, a pop-up appears stating the message, "-11: "Max File Size" should be greater than 1MB!".
If the user sets the value as alphanumeric (E.g.: 1mb) and clicks the Save button, a pop-up appears stating the message "10: Invalid value for "Max File Size!".
Note: The same above steps can be followed for the Audit Appenders: Open TeamConnect. Login to TeamConnect with Admin User. Navigate to Setup window. Click the System Settings Dropdown and select Audit Appenders.

File Appenders

File appenders define logs that capture messages in a text file as they are generated by the system. The log file is stored in the location that was specified when TeamConnect was installed.

Whether you are defining a file appender for system logging or audit logging, the settings that are specific to file appenders are the same.

For general instructions on defining appenders, see one of the following sections:

• For system logging, see Defining System Appenders.
• For audit logging, see Defining Audit Appenders.

The following table describes the file appender settings.

File Appender Information

%d{ABSOLUTE} [%t] [%p] [%c{1}] %C{1}.%M - %m%n

date [thread that generated the logging event] [level of the logging event] [logger of the logging event] class.method - message followed by a line return

11:20:44,005 [jessica] [DEBUG] [sql] TCLog$SQLLogWriter.write - UnitOfWork(2420720)
—end unit of work commit

<log4j:event logger="syslog.basic.sql" timestamp="1063916251658" level="DEBUG" thread="ExecuteThread: '10' for queue: 'default'">

<log4j:message><![CDATA[ServerSession(4688271)--client acquired

]]></log4j:message>

</log4j:event>

SMTP Appenders

TeamConnect's SMTP appender collects the logger messages in a buffer with a specified size. When the buffer receives a message with a severity of Error or higher, the SMTP appender sends an email message with the log events currently in the buffer to the specified email addresses.

To display the SMTP Appender Information

1. On the Admin menu in the System Settings drop-down list, select System Logging or Audit Logging, depending on which type of logging you need to define.

2. In the System Appenders section, click New.
   A new appender screen opens.
3. Select SMTP Appender from the Appender Type drop-down list.
   The SMTP Appender Information section is displayed.

For information on how to define appenders, see Defining System Appenders or Defining Audit Appenders. Whether you are defining an SMTP appender for system or audit logging, the SMTP appender settings are the same. The following image shows a set of sample settings:

In addition to the fields described in the following table, you must configure the Outgoing Mail Server Settings section of the Email page under Admin Settings. For more details, see the Admin Settings, Email Page Field Descriptions table.

SMTP Appender Information

Socket Appenders

A socket appender transmits logger messages to a port on a remote host. On the remote host, the messages can then be logged as if generated locally. Using a socket appender allows you to send logs from various systems to a single server where all logs for your organization are monitored or stored.

To use a socket appender, you must define a socket server to receive the log messages. Log4j® includes socket server examples as part of its distribution.

Whether you are defining a socket appender for system logging or audit logging, the settings shown in the following image are the same.

The following table describes the fields in the Socket Appender Information section of the Appender screen.

Socket Appender Information

Default System and Audit Appenders

By default, TeamConnect has several active file appenders--that is, the logs that they generate are written as text files. These files are stored in the location specified for log folders at the time when TeamConnect was installed. There are three default logging appenders:

• Default (for system logging) — Logs all of the messages that are generated by all of the system loggers and writes them to the system.log file. You can deactivate the Default appender, but it cannot be deleted.
  If you want a log that isolates messages for a specific area of TeamConnect, you must define an appender for the corresponding logger.
  • For instructions on defining a system appender, see Defining System Appenders.
  • For a description of the Default system log file, see Pattern Example.
• XML Appender — Logs messages regarding XML requests, according to the level selected for the XML logger, and writes them to the xml.log file.
• Default (for audit logging) — Logs messages from all active audit loggers and writes them to the audit.log file. You can deactivate the Default appender, but it cannot be deleted.

Note: If Collaborati Spend Management is installed on your system, the Collaborati Appender is installed by default.

Defining System Appenders

Although several default system appenders are provided, you can define new system appenders as needed. When you define a system appender, you are defining a log that you want generated for either one specific system logger or for all of the system loggers.

For example, you might want to define a log that only captures messages regarding custom rules that are defined for your implementation of TeamConnect. You can do this by defining an appender for the Rule logger.

Note: For descriptions of the system loggers, see System Loggers.

To define a system appender

1. On the Admin menu in the System Settings drop-down list, select System Logging.
2. If the Audit tab is displayed in the Logging screen, select the System tab.
3. In the System Appenders section, click New. A new appender screen opens.
   
4. In the General Appender Information section, enter the desired information as described in the General Appender Information for System Logging table.
5. Depending on which type of appender you selected in the Appender Type field, enter the desired information in the specific fields for file, SMTP, or socket appenders as described in the corresponding tables:
   • The File Appender Information table.
   • The SMTP Appender Information table.
   • The Socket Appender Information table.
6. Click Save.
7. Restart the TeamConnect application on the application server.

The general information that must be filled out for all system appenders, regardless of their type, is shown in the General Appender Information for System Logging image.

The following table describes the fields in the General Appender Information section:

General Appender Information for System Logging

Defining Audit Appenders

Appenders for audit logging differ from system appenders in the following ways:

• Because you do not have to set the levels of the audit loggers, your audit log appender does not need a threshold for which levels to log.
• You cannot define an appender for a single audit logger. Messages from all audit loggers that are turned on are logged in an audit appender.

For descriptions of the audit loggers, see Audit Loggers.

To define an audit appender

1. On the Admin menu in the System Settings drop-down list, select Audit Logging.
2. If the System tab is displayed in the Logging screen, select the Audit tab.
3. In the Audit Appenders section, click New. A new appender screen is displayed.
   
4. In the General Appender Information section, enter the desired information as described in the General Appender Information for Audit Logging table.
5. Depending on which type of appender you selected in the Appender Type field, enter the desired information in the specific fields for file, SMTP, or socket appenders as described in the corresponding table:
   • The File Appender Information table.
   • The SMTP Appender Information table.
   • The Socket Appender Information table.
6. Click Save.
7. Restart the TeamConnect application on the application server.

After you restart TeamConnect, messages are written to the log that you defined.

The following table describes the general appender information that must be filled out for all audit appenders, regardless of their type.

General Appender Information for Audit Logging

System Loggers

System loggers categorize messages in the code according to the area of TeamConnect that generates them, so that you can specify which area's messages you want to capture in a particular log. You can define multiple logs that capture messages from different TeamConnect components or all TeamConnect components.

For each log that you have defined, you can specify an overall threshold for what severity of messages you want written to it, so that the logs contain only the most pertinent information. For more details about the threshold for a log (or appender), see the General Appender Information for System Loggers table.

For each available TeamConnect component, you can specify what severity (level) of messages you want written to the logs regarding this component, so that the logs contain only the most pertinent information about the component.

The loggers that are available for system logging are listed on the System tab of the Logging screen, as shown in the System Loggers and Detailed System Loggers images.

All of the system loggers have Root as their parent logger. This hierarchy allows appenders defined for the Root logger to be available to descendant loggers. For example, this means that the Default appender, which has been defined for the Root logger, receives logging statements from all of the loggers in the hierarchy.

Tip: Because the Default appender captures messages from all loggers in the system, you do not need to define another appender for the Root logger.

You can define an appender to be the target of a single logger in the hierarchy. This appender only receives logging statements from the logger for which it is defined. For example, if you need a text file that logs events for the batch display component, you define an appender for the Batch Display Component logger.

The following image shows the System Loggers section of the Logging screen:

The following table describes the System Loggers section:

System Loggers Table

Detailed System Loggers

The following image shows the Detailed System Loggers section of the Logging screen:

The following table describes the Detailed System Loggers section:

Detailed System Loggers Table

Audit Loggers

Audit loggers send their messages to logs defined by audit appenders. Unlike system loggers, audit loggers have the following characteristics:

• Audit loggers are turned on or off system-wide. You do not have to set levels for audit loggers.
• When you define an appender for audit logging, all audit loggers that are turned on send their messages to the log. You cannot define separate logs for the various audit loggers.
• When you define an appender for audit logging, you do not have to specify a threshold. For details about defining audit appenders, see Defining Audit Appenders.

The following image shows the available audit loggers.

The following table describes the Audit Loggers section:

Audit Loggers Table

Turning Audit Loggers On or Off

To turn audit loggers on or off

1. Click the Admin tab.
2. Click the Logging link under the tab bar.
3. Click the Audit link from the left pane.
   The Audit Logging page opens.
4. From the Audit Loggers section, locate the name of the log you want to turn on and select On from the drop-down list.
5. Locate the name of the log you want to turn off and select Off from the drop-down list.

Enhanced Auditing for System Log Level Changes

Note: Introduced in TCE 8.0 version.

TeamConnect now introduces the new Log Level Audit logger that automatically records all changes to system logger severity levels, to improve compliance and simplify troubleshooting.

How It Works: When an administrator modifies a logger’s severity (e.g., from ERROR to DEBUG) on the Admin → Logging page, a detailed audit event is generated. This entry captures who made the change, the old and new severity levels, and the exact time of the modification, providing a complete and auditable history.

Note: The Log Level Audit logger is enabled by default for all new and upgraded TeamConnect versions. You can manage this setting from the Admin → Logging → Audit Loggers screen, as shown here.

The resulting audit entries are written to all active Audit Appenders and will display the details of the change clearly, as shown here:

Introducing Logging Level Timeout for System Loggers

Note: Introduced in TCE 8.0 version.

Description: TeamConnect now supports the ability for administrators to temporarily increase the detail level of system loggers to DEBUG, INFO, or WARN for a configurable duration ranging from 10 minutes to 4 days. This is done directly from the Admin Logging interface and provides a self-service way for support teams to collect rich diagnostic data for troubleshooting without requiring a system restart.

The screenshot below illustrates how the “Timer (minutes)” dropdown appears after selecting DEBUG, INFO, or WARN in the Level column, allowing you to choose a specific duration for the override.

The logger’s level will automatically revert to its previous state after the selected time expires, preventing verbose logging from being left on accidentally in production environments.

Important Note: If you see the message “Will change back to ERROR within the next minute” after the selected timer expires, refresh your browser page to see the update.

Alternatively, the feature can be disabled globally via the “Disable Logging Level Timeout” checkbox, located under System Settings → Backward Compatibility Settings, as shown below.

Note: For enhanced security and tracking, this feature is fully integrated with the Log Level Audit logger. All related actions - such as who set the timed override, the new level, the timer’s duration, and the automatic reversion event - are recorded in the audit logs.

An example of how these events appear in the audit log is shown below:

New CSM logger and Integration Logger

Note: Introduced in TCE 7.1 version.

Earlier versions of TeamConnect (TCE 7.0 and older versions), CSM logs were added to the rule logger, creating a lot of disturbance and making it hard to locate and troubleshoot rule errors.
In TCE 7.1 version, the user can configure the CSM log separately from the Rule logger or any other logger so that they can debug rules/other logger issues without CSM filling in the noise.

• Now, there is a separate CSM appender which is linked to a new Integration Logger in order to better organize and therefore troubleshoot various errors.
• The user will be able to debug issues related to rules by setting Rule Logger to DEBUG without any CSM logging in the log file.
• The user can see that there is a new log controller for any integrations called Integration Logger under Detailed Systems Logger.

Note: Integration Logger is consistent with TeamConnect log levels Ex: (Error, Debug, Info, Warn).

• The CSM Logging is also routed to the newly created “Integration Logger”.

Rule Auditor

Note: Introduced in TCE 7.1 version.

The user can view the list of rule failures which occurred as part of rule execution in the Rule Auditor table to diagnose and troubleshoot issues related to rule failures. These rules must be part of the object, and if the condition fails, whether as part of the action or as part of the qualifier, it will be triggered, and the rule will be captured.

Note:

• Runtime failures (critical exceptions) thrown from Action or Qualifier code flow directly into the Rule Auditor. Administrators can filter, sort, and export those entries via the UI, without needing to dig through log files.

• Intended validation errors (for example, explicit “deny/validate” logic) still surface to end users via the UI, but do not appear in the Rule Auditor, so they won’t clutter the list.

• If you expect a failure but see nothing in Rule Auditor, check the standard rule logger via System Logging. It may be either TCException thrown from an Action class or a TCKeyedApplicationException from a Qualifier.

• From a Rule Auditor entry, you can click built-in hyperlinks to navigate to the failing rule, object definition, or record. Use View Details to copy the full stack trace or Go to log to open the underlying log file.

Below are the steps to follow:

Steps to follow	Screenshots for reference
Open TeamConnect. Login to TeamConnect with Admin User. Navigate to Setup. Setup window will be opened. Click to open the Tools.. dropdown. Click the .Rule Auditor option.
The Rule Auditor page will be opened. Note: When there are no rule failures, a message is displayed in the table saying, “No rule failures are available".
Below data retrieved is displayed as shown below: Rule: Name of the Rule which failed. Object: Name of the object on which rule failed (E.g.: Invoice) (Displays Blank - If rule failure is not related to any object). Record ID: Name of record on which this rule failed (Displays Blank - If rule failure is not related to any records). Username: The user who triggered the rule Description: As retrieved from the database. Date of Failure: Timestamp when it failed (Similar to what is saved along with the Time zone appended to the header). Action: Provides complete stacktrace of the issue.
Note: When the user hover on any rule name or object, the hyperlink appears which makes the text clickable. Also, the RecordID is hyperlinked which when clicked will take the user to a new window where the record is displayed.
Click on any Rule name. A relevant rule configuration will be opened in a new footer-menu frame (general tab for that rule).
For the Object column, when clicked on any object, a separate footer-menu frame will be opened for Object definition.
Similarly, for the RecordID column, when clicked on any RecordID, a separate window opens in the TeamConnect user interface displaying the recordID information (in this case, when clicked on the invoice in which the failure has occurred).
In the Action column, click on the “View Details” button. The relevant stacktrace is displayed in a box to the right of the screen along with the corresponding rule title.
Click on the "Go to log" button above StackTrace Box to navigate to the Setup/System Appenders screen.
Note: The StackTrace Box has an “X” icon (while hovering, the user can see “Close the Error Log”) to close it and a copy icon (while hovering, the user can see “Copy the Error Log”) to save the stacktrace to clipboard (Ctrl+C functionality).

Exception logging behavior in Rule Auditor

The following table shows which exceptions are captured by the Rule Auditor and which are logged only in the standard rule logger.

How to paginate and sort or filter any column in rule auditor?

Note: Introduced in TCE 7.1 version.

• The user can sort by any column in ascending or descending order and filter by any column (except the Action Column).
• The user can paginate the entries in the rule auditor table, with a configurable number of Records per Page with a default value of 10.
• A message will be displayed on top of the table that indicates current records displayed out of total records. For example, “Displaying records 1-50 of 100”.

Note:

• Also, one can check the user who triggered the rule so that it can help with troubleshooting the issue when the user is known under the Username column.
• The number of entries in rule auditor is limited to 1000 records. The moment it reaches more than 1000 records, the older records get deleted and the new records get inserted in the database.

How to export rule failures to an excel file?

Note: Introduced in TCE 7.1 version.

The user can export all the entries of the rule failures  in the rule auditor to an excel file by clicking the “Export as Excel” button on the top of the RuleFailure table, so that the user can have a snapshot of all failures which can be analyzed. Furthermore, when filters are applied, the export option can be used to export even for the filtered results.

Note: The user can select multiple entries in the Rule Auditor table by clicking on checkboxes in the first column and delete them at once so that they can remove entries that have been resolved or are no longer relevant.

Rule failures saved in the database

Note: Introduced in TCE 7.1 version.

The user can capture and save rule failures in a structured format and easily display in the Rule auditor table.

• Users should make sure that stacktrace that they are capturing has only “Error” log level statements i.e., when checked on the original system log, rule auditor stacktrace should be present with "ERROR" log level in the original system log.
• Failed on timestamp indicates the application server’s timezone.
• The logging will be performed at rule failure state itself, so that relevant stacktrace details are captured.
• The rule failure data is configured so that logged format will be relevant to Rule Auditor user interface columns i.e., Rule name, Object, RecordID, Username, Rule Description, Failed on, and Action.
• Error description content can be clipped off data from stacktrace to the first 140 characters (OR, if using .css to trim the content, then display characters as it fits within the width of the column).