ITPError

Because of the way jobs are divided over Document Processors by the Document Processor Manager and the possibility that an ITP/Server installation is distributed over several machines, the normal way of reporting errors might result in errors being missed, we advise to use this script command to handle error reports.

This command does the following:

• It returns the original error, the ITP log and the ITP Data Manager log as progress messages.
• It writes an itperror.txt file next to the log.
• It re-throws the error, extended with the ITP log and the ITP Data Manager log.
• It saves the following files to the folder indicated at the parameter ErrorDir:
  • dm.ini
  • ITP configuration file (itp.cfg) that actually was active at the time of the error including all settings that were generated automatically.
  • In case the command ITPRunCrtRun was called and the Create part fails: stage2_model.doc. This is the model document generated after the first run.
  • In case the command ITPRunCrtRun was called and the Create part fails: stage2_error.doc. This is the error document from stage2_model.doc.
  • In case the command ITPRunCrtRun was called and the Create part fails: stage2_error.txt. This is the ASCII error text document from stage2_model.doc.
  • postinc.doc: this is the result document in which the post include statements have not been processed yet. This file is useful to debug post include paths.
  • itperror.log. This file contains all other relevant information for ITP jobs that have failed. In particular, it contains the information from the ITP and the ITP Data Manager log files. The information in the ErrorDir is appended so that it contains history for this particular ErrorDir.

Usage

To install the ITPError script as an error handler, use the following the commands:

ITPErrorReset; /* Only the first time */

OnError Script(ITPError)

	Model("Model")

	ErrorDir ("Path\folder") 

;

Note

Closing semicolon is required.

Note the usage of the command ITPErrorReset before ITPError is installed as an error handler. This command is required to ensure that only relevant information is included in the error report. It should be called once, before the first time that the ITPError handler is installed. When the ITPError handler is re-installed e.g., after disabling error handling using OnError Script(*), the command ITPErrorReset should not be re-issued.

Parameters

Model: Required.
Name of the model used in the ITP process of which the ITPError is the error handler.

ErrorDir: Optional.
The name of the folder that will be used to save the files to. This folder is specified relative to the Log folder of a document processor. By default, the name of the folder will be set to the job id with which the service is called.