Task Finish Action

Description

A Task Finish Action should be included as the last Action in every Task. It sets the status of the Task to FINISHED. Optionally it can send an AQMP message to an Authority.

Java Class

The Action is implemented by the Java class de.ecm4u.faw.api.impl.TaskFinishAction.

Parameters

This example contains the parameters that send an AMQP message about the finished Task to the Authority identified by the Task Property authority.

FinishedAction.exchange: "$amqpExchange"
FinishedAction.routingKey: "$authority"
FinishedAction.contentType: application/json
FinishedAction.bodyTemplate: '{"command": "finishedTask","args": {"task": "${taskPath}"}}'

There are no required parameters.

There are four optional parameters that belong together.

  • FinishedAction.exchange: The AMQP exchange to deliver the AQMP message to.
  • FinishedAction.routingKey: The AMQP routing key to set on the AMQP message.
  • FinishedAction.contentType: The content type of the AMQP message.

If the server shall send an email to all authorities who would have received an AMQP message but are currently not present, use the following parameters.

  • WaitingAction.emailFrom: Optional string. The value for the From header of the email. Example: "SBCS FaW" <sbcs-faw@example.com>. Must be set for any email to be send.
  • WaitingAction.emailSubject: Optional string. The subject of the email, can be a string or the name of a template textresource of type emailTemplate.
  • WaitingAction.emailBody: Optional string. The body of the email, can be a string or the name of a template textresource of type emailTemplate.