Show TOC

Background Job TypesLocate this document in the navigation structure

Use

Using the background job monitor you can configure the archiving, deleting, restarting, and recovering jobs for PI messages.

Archiving Job

Used for archiving messages that have been processed successfully or edited.

Message archiving allows you to archive message versions that have been saved during processing in the message store of the Advanced Adapter Engine. This includes as well asynchronous messages (saved with the staging function) and logged synchronous messages.

You require two archiving sessions to archive messages:

  • One session to write the messages to the archive

  • One session to delete the persisted messages that have been archived

A standard job (Default Version Archive Job) is automatically created for archiving messages edited with Message Editor. It runs once a day and ensures that messages that were edited are archived. Before you can use this job you must first activate it. You cannot define rules for this job.

To archive messages processed without being edited, you must create and schedule a separate archiving job, which then, in turn and implicitly, schedules the runs for writing the archives and for deleting the archived messages. The system archives all information displayed for a message in message monitoring, in addition to the audit log for each message.

Deleting Job

Used for deleting messages that are not to be archived.

A standard job for deleting is created automatically. It runs once a day. You can schedule additional delete jobs; however, you cannot define rules for them.

For jobs of this type you can define the NON-FINAL parameter. It determines whether the job should delete non-final log messages created for consumption by Business Process Management. When setting this parameter, enter a Boolean value, either true or false .

Restarting Job

Used for restarting messages with errors.

Instead of restarting messages with errors manually in message monitoring, you can schedule a job to restart these messages automatically. This is possible for all messages for which the number of defined restart attempts has been exceeded (messages with the system error status). For more information, see Monitoring Messages .

For jobs of this type you can define the following parameters and values:

  • MAX-RESTART determines the number of times the system should try to restart the messages. When setting this parameter, enter a positive integer number.

  • RESTART-BLACKLISTED determines whether this job should restart blacklisted messages or not. When setting this parameter, enter a Boolean value, either true or false . For more information, see Administrator Tasks for Blacklisting .

Recovering Job

Used for recovering lost messages.

A standard job to recover messages is created automatically. The job runs once a day and ensures that messages lost as a result of database failure, for example, are recovered. You can schedule additional recovering jobs.

Cancelling Job

Used for cancelling unfinished messages (for example, messages in the system error status).

Instead of cancelling unfinished messages manually in message monitoring, you can schedule a job to cancel these messages automatically. This is particular useful if there is a high number of messages to be cancelled.

The cancel job will move the messages to the Cancel status. This is a final status. That means the messages cannot be resent anymore and they will be removed from the system by the standard clean up mechanism as soon as possible (Deleting Job).
Caution

Use this job cautiously since the cancellation cannot be undone.

  • Parameters

    There are 4 message parameters available. They are all optional. Two parameters are used by default, whereas you can change the default values.

    1. Older than (hours): Default is 8760 hours, that is 1 year. This is related to the Sent timestamp of messages.
    2. Younger than (hours): This is related to the Sent timestamp of messages.
    3. Only simulate (no actual change of the messages): Default is active.

      This paramameter determines messages that would be deleted. These messages will be displayed on the Logs tab.

      Use this parameter to simulate cancelling since after messages have been cancelled sucessfully they will definitely be deleted with the next Deleting Job. With that parameter you can also test the scope of the job, that is, whether you chose the rules and parameters properly.

    4. Process only messages with status. You can enter the following 4 status, separated by comma:
      1. TBDL (to be delivered): Messages are still in the queue and not processed yet.
      2. WAIT: Messages are scheduled for retry.
      3. HOLD: The predecessor message has not been processed yet.
      4. NDLV: (not delivered - corresponds to the system error status in message monitoring): This status is used by default if you do not enter any other status. Anyway you can use this status in combination with the other 3 status.
  • Logs
    The Logs tab shows important job information of running or carried out cancelling jobs. For example:
    • Start time
    • End time
    • Number of cancelled EO messages
    • Number of cancelled EOIO messages per sequence
    This is useful particularly for simulation purposes (it shows the number of messages that would be cancelled if the job runs in non-simulation mode).
More Information

For more information about setting job parameters, see Scheduling Jobs .