Waiting Action

Description

This Action waits for the submit of a Form created by a Create Form Action. It sets its status to the special value WAITING. The submit of the Form looks it up and sets the status to FINISHED after saving the form data.

Java Class

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

Parameters

If an AMQP message about the waiting Task shall be send, use the following parameters.

  • WaitingAction.exchange: Optional. The name of the AMQP exchange to send a message about the waiting Form to. Can be a reference to a Task Property using the $ prefix.
  • WaitingAction.routingKey: Optional. The routing key to use for the AMQP message, usually the name of an authority. Can be a reference to a Task Property using the $ prefix. By default, the message is send to the authority that the task is assigned to with the role ASSIGNEE or RESPONSIBLE.
  • WaitingAction.forceOpen: Optional boolean. If true, force the client to open the Form. If false, only notify the client about the waiting Form.
  • WaitingAction.forceOpenAuthority: Optional string. The name of an authority whose client will be forced to open the Form. Only relevant if forceOpen is true. If set and not equal to the value of routingKey, the client will only be notified. Can be a reference to a Task Property using the $ prefix.

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.

Example Parameters

These parameters will not send an AMQP message.

--- {}

These parameters will send an AQMP notification.

---
WaitingAction.exchange: "$amqpExchange"
WaitingAction.routingKey: "$authority"

These parameters will force the client to open the Form if the values of $authority and $forceOpenAuthority are equal.

---
WaitingAction.exchange: "$amqpExchange"
WaitingAction.routingKey: "$authority"
WaitingAction.forceOpen: true
WaitingAction.forceOpenAuthority: "$forceOpenAuthority"