Form Version Services

   Journey Manager (JM) The transaction engine for the platform. |   Platform Developer |   23.10This feature was updated in 23.10

Manager comes with a set of standard services, which you can assign and customize for each form version, so they will be invoked at different stages of form processing. If services are not assigned, Manager uses the system defaults. It is recommended to assign services to a form version only when necessary.

You can also create and customize optional services for a form version, for example, when a form version is configured with a collaboration job. The optional services doesn't default to any services when not selected. For example, if a form version uses a collaboration job, then you need to select the applicable job controller service. Otherwise, this form is a standard form and no system default service will be used for the job controller service.

Another common example where you need form version services is receipt customization, especially, the headers and footers of a receipt. For more information, see Receipt Headers and Footers Customization.

To view and assign services to a form version:

1. Select Forms > Forms.
2. Locate a form and click the Form Version tab.
3. Select a form version and click the Services tab.
   Note

   The list of available services is limited when the Use Transact Functions checkbox is selected from the Build Options in Maestro.  |  17.10 This feature was introduced in 17.10.

   

4. Select a Job Controller service from the Job Controller Service dropdown list, which is invoked when a form submission creates a new collaboration job.
5. Select a form security filter service from the Form Security Filter dropdown list, which controls user access to the form. This service is called when a form is rendered before Manager access controllers run.
6. Select a form prefill data service from the Form Prefill Data Service dropdown list, which is invoked to provide XML prefill of data when a form is rendered.
7. Select a form render service from the Form Render Service dropdown list, which is called to render the form template.
8. Select a form submission preprocessor service from the Form Submission Preprocessor dropdown list, which is called when a form is submitted so it can review, modify or reject the submission before it is stored in Manager.
9. Select a form saved processor server from the Form Saved Processor dropdown list, which is called when a form is saved online. Optional.
10. Select a submission data validator service from the Submission Data Validator dropdown list, which is called to validate the submitted form XML data
11. Select a submission completed processor service from the Submission Completed Processor dropdown list, which is invoked when a submission changes to a form status Completed (form submission for a collaboration job is complete) and no more user steps are required.
12. Select a receipt render service, such as Dynamic PDF Receipt service, from the Receipt Render Service dropdown list, which is called to render the form submission as a PDF receipt. If not specified, the form uses the system default rendering service.
13. Select a task expiry service from the Task Expiry Service dropdown list, which is invoked when tasks expire.
14. Select an email service from the Email Service dropdown list, which is called to send submission related emails to users. This service uses the system default.
15. For each pre-defined services, click New to create a new service or click Edit to configure a selected service.
16. Click Save to update the changes.

To make sure the correct services are assigned to the form version, render it by clicking Direct on the Form Dashboard.

This is especially important when you assign services to a global form version. Manager checks whether these services are allowed to be global or not. If a service is incorrectly assigned, it throws an Illegal Argument Exception (java.lang.IllegalArgumentException) when you try to render the form. If a service and a form are under the same organization, the form will render fine. However, if they are from different organizations - an exception is thrown.

Next, learn how to configure form version properties.