Creating a custom Information Console web application : Configuring a custom Information Console web application : Modifying text and messages : Customizing Actuate BIRT iServer error messages

Customizing Actuate BIRT iServer error messages

Actuate Information Console uses SOAP messages to communicate with the Actuate BIRT iServer. You can customize the message text of an Actuate BIRT iServer error message before Information Console displays it to the user. For example, the following URL attempts to schedule a job for a report that is not in the repository:

http://localhost:8700/iportal/submitjob.do?requesttype=scheduled&executableName=BadFileName.x

Information Console retrieves an iServer error message, as shown in Figure 2-5.

Figure 2-5  iServer error message for a missing file.

To customize a message, you edit ErrorMessages.properties, following the procedures described later in this section. This file contains customized error messages. For a full list of all BIRT iServer error messages, see <context root>\WEB-INF\ErrorMessages.txt. This file contains the error code, error level, and the English text of every message. When you customize ErrorMessages.properties, use the error code for the message from ErrorMessages.txt.

Information Console inserts context-specific text to an error message using variables. When changing message text, maintain the original variables in your new message, if possible. For the best results, follow the format of the original message exactly to maintain the number and order of the variables. Variables appear in message text as {n} where n is a whole number, beginning with 0.

For example, the URL for a missing file produces error 3072, and you can change the entry for error 3072 to something similar to the following:

3072 = {0} is a bad file name or the file does not exist.

Using the erroneous URL above with this custom message results in a new message, as shown in Figure 2-6.

Figure 2-6  Custom iServer error message for a missing file.

(c) Copyright Actuate Corporation 2011