Debug

You can debug AVEVA Work Tasks. The various methods implemented to debug include:

• Logger Console

• Setting the Debug Level

• Configuring Exception Email Settings

• Logger Message Categories

• Implementing Work Item Information interface

• Debugging Custom Actions or Properties using Debugger

Logger Console

The Logger Console is used to debug AVEVA Work Tasks. This is a utility that shows a real-time log of events during the execution of AVEVA Work Tasks. It is automatically installed at [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\Bin folder when AVEVA Work Tasks is installed.

<AVEVA Work Tasks_installed path> is the path where AVEVA Work Tasks is installed on your system.

Steps to Debug

• Run AVEVAWorkTasksLogConsole.NET2 from [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\Bin. Or

  On the Windows Start menu, point to Programs, point to AVEVA, and then click WTLogger Console.

  The WTLogger Console window appears.

  The events are displayed in the WTLogger Console when AVEVA Work Tasks is running. The WTLogger Console displays events using three types of log categories. These log categories are used to identify the type of information.

To set the Debug Level

1. On the Windows Start menu, point to Programs, point to AVEVA, and then click Farm Configuration Wizard.

   The Welcome to the AVEVA Work Tasks Configuration Wizard appears.

2. Click Next.

   The Edit AVEVA Work Tasks Farm Settings screen is displayed.

3. Select Service Settings.

4. Click Next. The Service/Global Settings page is displayed.

5. Click against Global Settings. The Global Settings screen appears.

6. Click Log/Transaction.

7. Select the Debug Level from the drop down box.

8. Click OK.

The following debug levels are available:

• Level 1: This level shows minimal information in the Logger Console. The Logger console displays information related to the start and end of a workflow. Error messages are also shown in this mode.

• Level 2: This level provides detailed information of background activities. It will show all the messages logged from the actions.

• Level 3: This level displays messages indicating whether an action is executed.

All error messages logged in the Logger Console will be sent to the user e-mail ID. This e-mail ID is picked up from the SMTP node in the configuration file.

To configure Exception Email settings

9. On the Windows Start menu, point to Programs, point to AVEVA, and then click Farm Configuration Wizard.

   The Welcome to the AVEVA Work Tasks Configuration Wizard appears.

10. Click Next.

    The Edit AVEVA Work Tasks Farm Settings screen is displayed.

11. Select Service Settings.

12. Click Next. The Service/Global Settings page is displayed.

13. Click against Global Settings. The Global Settings screen appears.

14. In the Exception Email Settings section, enter From Email and To email.

Logger Message Categories

There are three categories of messages logged in the log files.

• Information (i): This type of message is preceded by a lower case 'i'. It indicates messages containing general information about the events being logged. Each message of this type has four parts:

  • the event information

  • the module generating the event

  • the machine on which the event took place and

  • the date and time of the event

• Warning (?): This type of message is preceded by a question mark '?'. These messages are warning notes to the users about the events being logged. The messages of this type have a structure similar to the 'Information' messages with the same four parts as mentioned earlier.

• Error (!): This type of message is preceded by an exclamation mark '!'. It indicates error messages with details specific to the error. Messages of this type can be further classified into four parts similar to the other two messages. In addition, it has the 'Exception Stack Trace', which occurs before the machine name and date/time. It can be identified by the keyword 'Source' and it can be used to trace the source of the error.

Interpret Log Files

Two types of Log files are created by AVEVA Work Tasks:

• The first type of Log file is created for generic log messages. This Log file is created in the path - <AVEVA Work Tasks_installed path>\log. The Log files are saved in this folder using the date of logging as the filename with the format "MMDDYYYY" (there will be one Log file for each day).

• The second type of Log file is application-specific; it will log messages related to applications. These Log files are created in separate folders corresponding to each application. The folders are located in the path <AVEVA Work Tasks_installed path>\log and are saved with names in the format "<application name>+n" where "n" is a serial number of the log folder created.

To open and view a Log file

15. Navigate to the log file location using the relevant path,that is, "\Logs" or "\Logs\<application name>" depending on the type of Log file you need to view.

16. Locate the required Log file by looking at the date of the log file.

17. Open the log file in a text editor to view the details. It will display all the events for the day using three types of log categories to identify the type of information.

Logger Activity

The Logger Activity can be used to log custom messages like information, warnings, and errors which should be logged to the Log Console from the workflow.

Use BAM Report

This report presents details related to failed workflows.

Implement Work Item Information interface

The Workflow Engine alerts the IWorkflowInformation interface on changes in the status of Actions or Workflows. The class implementing the Workflow.NET.Interfaces.IWorkflowInformation.NET2.dll interface is used to get the information from the Workflow Engine on change in the status of Action/Workflow. This interface is used only for getting information. It does not involve any transaction.

Debug Custom Actions/Properties using Debugger

Debugger can be added in the custom code to debug custom development done in AVEVA Work Tasks.