Delivery Channels Overview
Journey Manager (JM)
The transaction engine for the platform. |
System Manager / DevOps | 21.05
This feature was updated in 21.05.
With very few exceptions, Managerr is implemented as a hosted solution. It is a Platform as a Service (PaaS) solution, which means that the data collected do not reside in the client’s database while applications are in progress. The Manager server lives in Temenos’s cloud subscription – not the client’s. For that reason, the last step of most Manager jobs is the all-important delivery step in which everything about the completed application is zipped up into a file and delivered to the client, usually by means of secure file transfer. It is critical that everything goes well with the delivery step, since the client needs to have the detailed record of the application for compliance purposes including all of the customer’s sign-offs on disclosures, terms, and conditions. For this reason, Manager provides a robust delivery framework that includes retry capabilities and notifications should delivery fail even after repeated attempts.
Once a form is submitted and ready for further processing, the organization needs to be notified so they can take appropriate action. Journey Manager allows you to set up automatic email, web service or REST delivery on a per-form basis, with separate settings for test and production mode. A delivery channel sends user form submissions to a platform backend or third-party system for processing. After a user submits a form, a delivery channel determines what happens to the submitted, abandoned and invalid form transactions.
A delivery channel utilizes one of the following mechanisms:
- PDF receipt: a read-only copy of a form with user details in PDF format.
- Form XML data: a machine-readable copy form's filled details in format.
- Attachment: a file which is a part of a form submission, for example, a copy of a driver license.
You can configure different delivery channels for:
- An organization: this is the organization level when you configure the organization-wide delivery channels, which are used by all forms and form versions if their delivery channels are not configured
- A form: this is the form level when you configure a delivery channel, different to the organization's one, for individual forms. This gives you an extra flexibility to have different delivery flows for various forms within one organization.
- A form version: this is the form version level when you configure a delivery channel, different to the form's one, for individual form versions. This means you can implement requirements when each form version of a form should use various delivery channels. | 21.05
This feature was introduced in 21.05..
Manager determines a delivery channel to use in the following order:
- The form version's delivery channel.
- The form's delivery channel, if the above is not set.
- The organization's delivery channel, if the above is not set.
- The Trash Can delivery process, if the above is not set.
Manager delivers a form submission only if all attachments are scanned for viruses and marked as free of viruses or malicious software.
A delivery channel can be one of the following:
Let's look at each method in details.
- Delivery Process
- The Delivery Process is the most widely used delivery method because it's highly customizable and secure way for immediate submission data transfer. A Delivery Process invokes a Groovy service to perform a delivery of submission details. A delivery is marked as complete if the service indicates that delivery has been successful.
- If delivery has not been completed within the default 72 hours of a form been submitted, escalation emails are sent to all global and organization administrators in the Receive Delivery Escalation Alerts group.
- Email
- The Email method sends the submission details as attachments to one or more configured email addresses. A delivery is marked as complete as soon as the email is sent. The email can include a link to the submission attachments, if they were added by a user.
- Email Secure
- The Email Secure method differs from Email in that the email sent does not contain any submission details. Instead, it contains a link to a secure page in Manager where the submission details can be downloaded.
- A delivery is marked complete only after a user has accessed this secure page and confirmed that the submission has been received.
- If delivery has not been acknowledged within a certain period, which is 24 hours by default, reminder notifications are sent to the recipients defined in the delivery channel. This continues daily until a recipient acknowledges it.
- If the delivery channel's Email Addresses field is left blank, a reminder is sent to all global and organization administrators in the Receive Delivery Escalation Alerts group.
- If delivery remains unacknowledged within the default 72 hours of a form been submitted, escalation emails are sent out to all global and matching organization administrators in the Receive Delivery Escalations Alerts group.
- REST Service
- The REST Service method stores the submission details within Manager and offers a secure method of the enterprise retrieving these submission details, using a REST endpoint, when convenient.
- For more information, see the services guide.
- Web Service
- The Web Service method notifies your enterprise by making a web service call, using a pre-defined API. For more information, see the Manager Web Service API documentation.
- Web services may be either defined as part of the or defined separately by a developer.
- Delivery is marked as complete once the web service client confirms that it has received the submission.
- If delivery has not been completed within the default 72 hours of a form been submitted, escalation emails are sent out to all global and organization administrators in the Receive Delivery Escalation Alerts group.
- Trash Can
- The Trash Can Delivery process is a do-nothing delivery process for form testing. This is usually configured as the default and won't be available in the organization configuration, but is available in the form configuration. The Trash Can Delivery process is essential in ensuring that every form has a delivery channel set up so its submissions and transactions can be purged from the system by Data Retention Management service.
In a conclusion, Journey Manager’s job delivery framework is a powerful tool that ensures all the critical data collected during an application process is securely and reliably transferred to the client. By following the steps outlined above, you can set up a robust delivery process that includes retry mechanisms and notifications to handle any potential issues. Whether you’re a developer or an IT administrator, understanding how to configure and use job delivery is essential for maintaining compliance and ensuring the smooth operation of your systems.
Manager automatically delivers submissions according to the delivery channel currently configured for the form, and the organization default delivery channel if the form is not associated with a delivery channel, and will automatically retry delivery if failures occur depending on the delivery method used. However, you can monitor submission delivery and change the status for a set of submissions, for example, to retry delivery after a prolonged outage.
Next, learn how to create a delivery channel.