Journey Manager (JM) The transaction engine for the platform. | System Manager / DevOps | 22.04 This feature was updated in 22.04.
When a user submits a form, Manager creates a transaction, associated with this form. As a result of transaction processing and user inputs, it can become completed or abandoned. Manager considers abandoned transactions as completed transactions, so they can be purged. Abandoned transactions can also be configured to deliver data depending on a threshold value, which determines how incomplete form data was before the transaction became abandoned. Manager stores abandoned transactions along with all other transactions that are part of the transaction life cycle.
In addition to transactions, tasks and collaboration jobs can be abandoned. Also, it all can be done automatically or manually.
Automatic abandonment can happen under varying conditions depending on your Manager configuration. Manager applies the following rules to govern when draft submissions are automatically abandoned. The rules use a set of data retention parameters that you may need to configure for your particular requirements.
Data retention policy determines how long a saved transaction is maintained in Manager before it is automatically abandoned. Forms with abandonment delivery can have a more aggressive abandonment policy than the standard 1 day (24 hours) policy.
| Form Status | Standard | Abandoned Delivery |
|---|---|---|
| Open / Started | Abandoned after 1 day | Not applicable |
| Background Saved |
Abandoned after 1 day 1 |
Abandon as per the form level No User Activity in Form Max Time setting. Transaction will then be delivered if the transaction score threshold has been exceeded. Transactions which are rendered but never actually captured any data or transactions which are never saved by a user, even though they are background saved by Maestro Editor or using the |
| User Saved | Abandoned after data retention setting for Saved Transactions (days)2 | Abandon after the data retention setting for Saved Transactions (days)2 |
| Submitted | Is not abandoned automatically 3 | Abandon as per the form level Submitted Transactions Max Time setting. Transaction will then be delivered if the transaction score threshold has been exceeded. |
| Expired | Abandoned 7 Days after expiry | Abandon 7 Days after expiry |
1 - You can't change this 1 day abandonment policy time interval.
2 - Saved Transactions (days) can be set at the global, organization and form levels.
3 - Transactions in this state are mainly legacy. Normally, with a FTX flow, transactions will be completes before the transaction submits. When a transaction is left in the submitted state, it will be waiting for attachments or payments and the expectation is that help desk staff or administrators will be reviewing these transactions and either helping the users complete the form or manually abandoning them.
Tasks with configured expiration time are abandoned after this time has elapsed. If no expiration time is set, then the save abandonment time is used.
| Form Status | Standard | Abandoned Delivery |
|---|---|---|
| Assigned / Open / Started | Abandoned after data retention setting for Saved Transactions (days) 1 | Not applicable |
| Background Saved | Abandoned after data retention setting for Saved Transactions (days) 1 | Abandon as per the form level No User Activity in Form Max Time configuration. Transaction will then be delivered if the transaction score threshold has been exceeded. |
| User Saved | Abandoned after data retention setting for Saved Transactions (days) 1 | Abandon after data retention setting for Saved Transactions (days) 1 |
| Submitted | Is not abandoned automatically 2 | Abandon as per the form level Submitted Transactions Max Time setting. Transaction will then be delivered if the transaction score threshold has been exceeded. |
| Expired | Expiry time overrides the above for Assigned, Open, and Started statuses and the tasks will abandon as per the expiry setting. | Expiry time overrides the above for Assigned, Open, and Started and the tasks will abandon as per the expiry setting. |
1 - Saved Transactions (days) can be set at the global, organization and form levels.
2 - Transactions in this state are mainly legacy. Normally, with a FTX flow, transactions will be completes before the transaction submits. When a transaction is left in the submitted state, it will be waiting for attachments or payments and the expectation is that help desk staff or administrators will be reviewing these transactions and either helping the users complete the form or manually abandoning them.
The Transaction Processor service automatically abandons a collaboration job when either its Last Processed Time or Creation Time parameter expires, that is, when it is greater than a specified period of time, which you define as Collaboration Jobs Abandonment in the Data Retention configuration on both the system and organization levels. You can choose which submission attribute - the Last Processed Time or Creation Time - to be used for abandonment by configuring the Abandon Job based on Time Created deployment property.
If you have the Abandon Jobs based on Creation Time property set to true, make sure that the Collaboration Jobs Abandonment time is greater or equal of a total expiry time of all steps and tasks of a longest collaboration job flow, so In Progress collaboration jobs are not abandoned before they are actually completed. For example, if a collaboration job has 3 sequential steps or tasks, and we allow 20 days for each task to complete, the Collaboration Jobs Abandonment time should be set to at least 60 days.
When the collaboration job is abandoned, all its transactions are also abandoned. A purge date of the collaboration job, the subscription data, including PII data, are set according to the data retention configuration.
| 22.04 This feature was introduced in 22.04.
| Collaboration Job Status | Standard | Abandoned Delivery |
|---|---|---|
|
In Progress Error Paused |
Abandoned after a period of time specified in the Collaboration Jobs Abandonment of data retention configuration | Transactions, associated with a collaboration job, will be abandoned and their delivery status will set to Not Required |
|
Completed Canceled Expired |
Purged after a period of time specified in the Finished Collaboration Jobs of data retention configuration. The collaboration jobs with these statuses can't be abandoned. |
A delivery status of completed transactions, associated with a collaboration job, will be updated as Not Required, the delivery date will be set to the current date and submission's delivery message will be set to |
For more information, see collaboration job's statuses.
| Form Status | Date | Record |
|---|---|---|
| Open / Started |
Not applicable |
Transactions which were abandoned from this state will be purged in a fixed 2 day period |
| Abandoned / Completed | Purged as per the Finished Transaction PII Data (days) | It'll be purged after delivery (if required) as per the Finished Transactions (days) |
For Collaboration Jobs transaction data purging is a per standard policy but transaction record purging is different and the record will be purged when the collaboration job is purged. Collaboration Job purging is controlled by the ‘Finished Collaboration Jobs (days) ’ data retention setting.
There are situations when manual abandonment is required. It can come from:
new TxnUpdater(txn).setFormStatus(Txn.FORM_ABANDONED).update() method. For more information, see Fluent API documentation for your specific Manager version.Next, learn how to view submissions history.