blog

Encompass Diagnostics - Just in Time (JIT) Logging

Written by Suzanne Krause | Jun 2, 2024 11:00:00 AM

As software administrators and developers, maintaining the smooth operation of Encompass can be a challenging task. Diagnostic Mode - Just in Time (JIT) logging is a powerful tool designed to help you identify and resolve issues efficiently. In this blog post, we'll delve into the essentials of JIT logging and how it can streamline your diagnostic process.

What is JIT Logging?

JIT logging in Encompass is a feature that allows you to diagnose issues, investigate features, and monitor activities in real time. By enabling Diagnostic Mode on each workstation prior to any work, you can capture detailed logs of the activities performed by the Encompass client. These logs are invaluable for identifying runtime errors in calculations within loan fields, business rules, and other performance-related issues.

What's in the Log?

The JIT logs capture a wide range of data, including:
  • Triggers

  • Calculations

  • Events

  • Invokers

  • Loan Alerts

  • Form builder debug

  • SMTP messages

  • Performance Meter

  • Customizations using 'WriteDebug'

Common Errors and Solutions

A significant 92% of errors are straightforward to fix. Here are some examples of common errors you might encounter:
  • The subtracted value results in an un-representable DateTime

  • Argument ‘DateValue’ cannot be converted to type ‘Date’

  • Conversion from string "" to type 'Double’ is not valid

For resolving these errors and requesting user logs, always reference the Resource Center. This ensures you're following the best practices for effective troubleshooting.

Best Practices for Diagnostic Logs

When using JIT logging for troubleshooting known issues, it's best that the user experiencing the issue creates a log, otherwise a test account mirroring that user profile. Many rules and access settings do not apply to Super Administrators.

These logs will provide a comprehensive overview of the processes within Encompass, allowing you to pinpoint issues with precision.

When using JIT logging for general auditing, it’s recommended to target these diagnostic logs:
  • Application

  • Processing

  • Preapproval

  • Approval

  • Funding

  • Purchasing

Retrieving Logs

In the event of an Encompass crash, even if JIT or entire session logging has not been enabled, you can still retrieve a session diagnostic log. Note that this log must be retrieved prior to starting a new session of Encompass; otherwise, the log will be erased. This log, while not as detailed, can be crucial when issues are not reproducible on demand or if you do not want to leave diagnostic mode enabled for extended periods.
For a visual guide on enabling Diagnostic Mode and utilizing JIT logging, check out this Vimeo video.

By leveraging Diagnostic Mode - Just in Time logging, you can significantly enhance your ability to troubleshoot and maintain Encompass. Happy debugging!

For more information on how we can help you with your Encompass Auditing, please contact us!