Who is this article for?

IT Administrators responsible for managing logs.

IT Admin permissions may be required.

Each tier of the application produces log files.  This article describes where they are created, the default content, and how settings can be changed to get more information.

Summary

The default locations for log files are:

1. Robot service

Normally, the Robot's log file is called ServerRobot.txt and is found in the program folder (e.g. \program files (x86)\Pentana\ServerRobot\PentanaPRD\). 

The start of a typical log will look like this, showing the start-up self-test results for each active job, and the service start time.

----------Beginning Tests---------------
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: UpdateDueDateVariances
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: UpdateDueDateVariances (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: UpdateProcessNames
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: UpdateProcessNames (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: UpdateRetain
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: UpdateRetain (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: UpdateSegmentationLists
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: UpdateSegmentationLists (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: UpdateHierarchyProperties
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: UpdateHierarchyProperties (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: UpdateMilestoneVariances
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: UpdateMilestoneVariances (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Beginning Test for: RefreshTimeSheets
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Completed Test for: RefreshTimeSheets (Passed)
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13,

----------Testing Complete----------
INFO:   , Pentana.Tng.ServerRobot.RobotService, 4, 08/16/2024 08:28:13, Starting Robot...

By editing settings in the file Pentana.Tng.ServerRobot.RobotService.exe.config (most easily done via App Manager, in the ServerRobot tab), you can do the following:

• Change the logging level, by changing the AppTraceLevel value:

• • • 0: Logs nothing. We do not recommend turning off the log.
    • 1: Logs only error messages. Not recommended.
    • 2: Logs errors and warnings Not recommended.
    • 3: Shows all errors and warnings plus useful information about start and shutdown.  This should be the standard value for production systems.
    • 4: Logs a lot of additional information. This can be useful during troubleshooting, but should otherwise be avoided as the file it generates is huge, so not suitable for normal usage.
• Change the file log name and path:

If you change the settings, you need to restart the Robot service before they will take effect.

2. Desktop application

Desktop application logs to a file on the user's machine, at %localappdata%\Vision\[instance name]\LogFiles. Normally, only errors are logged.

For more advanced troubleshooting, you can raise the logging level by making a change to the client's config file vision.exe.config.

The first consideration for doing so is how the client will receive the change.  If you are using ClickOnce to deploy the clients, then options are to:

• Build a separate xcopy deployment, which could be run from the user's desktop and for which the config file can be edited easily.
• Or, use App Manager to edit the config (via the Client tab).  This will roll the change out to any user launching the application.

You make the change by updating the TraceCategories setting, which by default is set to 'Production':

The options are one or more of Production,DebugAgent,DebugCore,DebugData,DebugService,DebugUI separated by commas and with no spaces.

Using all options will create a large file that is difficult to read.  It's important to use only the options necessary.  Often Production,DebugService,DebugUI will be enough, but if it not clear which elements to use then seek guidance.

The DebugData option will log data that is saved by the user, so should be used carefully.

3. Main service

This logs to a file called PentanaTngService.log, located in the application folder (e.g. \inetpub\wwwroot\PentanaPRD\Service).

Normally this file shows timestamps for service start, and errors.

For more advanced troubleshooting it is possible to raise the logging level, by making a change to the Web.config file (most easily done via App Manager).

You make the change by updating the TraceCategories setting, which by default is set to 'Production':

The options are one or more of Production,DebugCore,DebugData,DebugService separated by commas and with no spaces.

Using all options will create a large file that is difficult to read.  It's important to use only the options necessary. Often, Production,DebugService will be enough, but if it not clear which elements to use, ask for help.

DebugData option will log data that is saved by the users, so should be used carefully.

Making any change to this file will cause the service to restart immediately and users will be disconnected, so changes should be scheduled carefully.

4. Web service

This logs to a file called WebService.log, located in the application folder (e.g. \inetpub\wwwroot\PentanaPRD\WebService). Normally this file shows timestamps for service start, and errors.

For more advanced troubleshooting, you can raise the logging level by making a change to the Web.config file via App Manager.

You make the change by updating the TraceCategories setting, which by default is set to 'Production':

The options are one or more of Production,DebugCore,DebugData,DebugService separated by commas and with no spaces.

Using all options will create a large file that is difficult to read.  It's important to use only the options necessary. Often, Production,DebugService will be enough, but if it not clear which elements to use, ask for help.

DebugData option will log data that is saved by the users, so should be used carefully.

Making any change to this file will cause the service to restart immediately and users will be disconnected, so changes should be scheduled carefully.

5. WebUI

This logs to a file called WebUI.log, located in the application folder (e.g. \inetpub\wwwroot\PentanaPRD\WebUI). Note that normally there is no file in this location, only errors are logged.

For more advanced troubleshooting, you can raise the logging level by making a change to the Web.config file via App Manager.

You make the change by updating the TraceCategories setting, which by default is set to 'Production':

The options are one or more of Production,DebugCore,DebugData,DebugService separated by commas and with no spaces.

Using all options will create a large file that is difficult to read.  It's important to use only the options necessary. Often, Production,DebugService will be enough, but if it not clear which elements to use, ask for help.

DebugData option will log data that is saved by the users, so should be used carefully.

Making any change to this file will cause the service to restart immediately and users will be disconnected, so changes should be scheduled carefully.

6. SAML

To learn more about logging for SAML, read our guide on enabling logging for SSO via SAML2.

7. Tools

Tools (e.g. the Excel Importer) log to their own application folder.

8. Timestamps

While most timestamps are UTC, there are some exceptions.  See Logging and time zones for more detail.