Timeout Receiver

Timeout Receiver activity receives the timeout event when the managed notifications expire. Expiration means that at least one or more devices that were supposed to receive the notification, did not acknowledge the receipt of the notification. This activity triggers, when the notifications expire on the server.

General

The General tab has the following fields.

Field Description
Name The name to be displayed as the label for the activity in the process.

Description

Provide a short description for the activity.

Advanced

The Advanced tab has the following fields.

Field Description
Sequence Key This field can contain an XPath expression that specifies which processes should run in sequence. Process instances with sequencing keys that evaluate to the same value are executed sequentially in the order the process instance was created.
Custom Job Id This field can contain an XPath expression that specifies a custom ID for the process instance.

Output

The following is the output for the activity.

Output Item Datatype Description
TimeOutNotification text This element consists of the following:
  • notificationId: The unique ID of the notification generated by the MI Service.
  • alertText: The text used as an alert message.
  • badge: The number of waiting notifications on the server.

    For managed notifications the badge number is:

    • dynamically stamped by ActiveMatrix BusinessWorks™ Plug-in for Mobile Integration, and
    • the value is equal to the number of unacknowledged notifications for the specified device token at the time of dispatch.
  • sound: Name of the sound file to be played, when the notification is delivered on the device.
  • businessId: An optional custom id to be associated with a set of notifications to be used by the business users.
  • collapseKey: Collapse key added to the outgoing message.
  • creationTime: The creation time of the notification.
  • expirationTime: The time when the notification expires on the server.
  • timeToLive: The time limit (in minutes) for the notification to be retained by the Mobile Integration Service.
    Note: The default time is set to "5" minutes.
  • retryCount: The number of times the server can retry to send the notification, if the device does not respond by sending an acknowledgement notification within a stipulated time.

    Actual retry is limited by the timeToLive value.

    Important: Retry works only for live notifications.
    Note: Default value is set to 0. The negative values if specified, gets converted to 0. Specify only a positive value, that is, 1 or greater.
  • retryInterval: Specified time interval (in milliseconds) between the retry process of the notifications.
    Note: Default value is set to 0. The negative values if specified, get converted to 0. Specify only a positive value, that is, 1 or greater.
acknowledgedDevices text Contains the list of device tokens for the iOS and Android devices and the acknowledged receipt of the notification by the user.
unacknowledgedDevices text Contains the list of device tokens for the iOS and Android devices and the unacknowledged receipt of the notification by the user.