Troubleshooting Steps

This topic describes the steps you must perform to aid the debugging process of an application that calls ReportCaster Web Services.

In all of the examples in ReportCaster Web Services Functions, a methodology that catches the exceptions thrown by any of the ReportCaster Web Service functions calls is shown. This is important because ReportCaster returns messages if there are invalid or incomplete parameters for a particular Web Service function.

The following are a few examples of some of the errors that may occur while using ReportCaster Web Services: Web Services:troubleshooting;ReportCaster Web Services:troubleshooting;troubleshooting ReportCaster Web Services authentication;error messages;error messages:authentication;authentication:error messages;troubleshooting:authentication addSchedule function:error messages;troubleshooting:addSchedule function log information;log information:error messages;error messages:log information;troubleshooting:log information getLastLogByScheduleId function:error messages;error messages:getLastLogByScheduleId function

Authentication
The Logon function is used to authenticate with ReportCaster and set the security token. The security token is then used as part of the Authentication structure for every subsequent ReportCaster Web Services call. If invalid credentials are passed to the Logon function, ReportCaster will throw an exception giving a message on what is invalid.

The following is an example of an invalid user ID.

The following is an example of an invalid password.
Adding a Schedule
The addSchedule function is used to create a new schedule in the ReportCaster repository. The Schedule structure is passed as input to this function. It includes sub-structures which include Scheduling Time (for example, TimeInfoMonth), Distribution Type (for example, DistributionEmail), and Task Type (for example, TaskStandardReport). Also, a Schedule Description is unique in the ReportCaster Repository. A Schedule Description with a name that already exists in the repository cannot be added.

For Managed Reporting, the procedure name in the TaskStandardReport structure is the HREF of the report minus the .fex extension. For example, the procedure name for a report in Managed Reporting with the HREF of app/ranking.fex would be app/ranking. The HREF of the report can be obtained by right-clicking on the WebFOCUS report in Managed Reporting and selecting Properties. The HREF is the Filename property and it can also be obtained through the MREOpenDomain function within WebFOCUS Web Services.

If the schedule does not run, make sure that the Active flag in the Schedule structure is set to True.

The following message results if you try to add a schedule with a description that already exists in the repository.

The following message results if no task information is defined.

The following message results if no distribution information is defined.

The following message results if an invalid destination type exists in the Destination structure.

The following message results if an invalid notification type exists in the Notification structure.
Log Information
When schedules do not run as expected, it is important to check the log information to determine what might have gone wrong. This can be done by interrogating the logs for that schedule. The logs can be accessed through the ReportCaster application or by using the ReportCaster Log Web Service functions. A popular Web Service function for obtaining a current log for a schedule is getLastLogByScheduleId. The log information returned should give a good indication on what might have gone wrong.

In the following example, the WebFOCUS Reporting Server was not started.
```
J104inm82b03 S104inlgpe07 Ranking Report - 14 12/30/2004 2:37:01 PM 
12/30/2004 2:37:06 PM
Starting worker thread
Error connecting to the WebFOCUS Reporting Server EDASERVE: EDA SQL 
STATUS (-9)
Starting task: Task1 - Ranking Report
Task type: MRE Standard Report
Retrieving MRE report: app/ranking
Connecting to server EDASERVE with execution id EDA
Task error:Connection refused: connect
No report to distribute.
Brief notification successfully sent to toEmail@ibi.com.
Log report notification successfully sent to toEmail@ibi.com.
```

WebFOCUS