Request save point and last pages mechanism

Application save point

Application save point is a key element of the form flow in the Eximee system. It defines the moment when the application data is passed to the form repository and related actions are triggered — such as starting a BPMN process, saving data in an external system, or displaying final information pages to the user. It is configured in the tab Steps of the application editor and appears as one of the items in the form step sequence. It is most often placed as the last step of the application. All pages located in the steps below the Application save point are treated as end pages.

Figure 1. View of the application save point in the "Steps" tab

When the application is being submitted, crossing this point saves the application to the form repository along with all data filled in on it.

Properties of the Application save point step

Step Application save point has the following properties:

• can be moved in any way moved using the mechanism drag & drop in the step structure,
• it cannot be deleted, because it is an integral part of the template,
• pages cannot be placed in it — it serves a technical, not visual, function.

Configuration of the application save point

When the save point is crossed, the system performs a data-saving action. If a BPMN process is to be started at this moment, in the section Application save point add the element EximeeRouter2.

The configuration of this element includes:

• Process name — the BPMN process definition key (matching the process identifier in EximeeBPMS).
• Case number (Business key) — the business identifier of the application. It may point to a form component or a session variable containing a unique case number. If the field is left blank, the system will automatically use the application number as the business key.

Figure 2. View of the application save point with the EximeeRouter2 process attached

Sample XML configuration in the tab Source of the form:

<saveActions>
  <action xsi:type="eximeeWorkflow">
    <processDefinitionKey>process_name</processDefinitionKey>
    <businessKeyMapping>case_number</businessKeyMapping>
  </action>
</saveActions>

Setting these parameters causes the system, after passing the application save point, to:

1. Saves the form data to the repository (FormStore),
2. Starts the BPMN process in the engine EximeeBPMS,
3. Passes the form data to the process according to the mapping in the tab Data model.

Final pages mechanism

After passing the application save point, the system displays the so-called final pages of the application — final screens visible after the form is submitted. If there are no end pages, the system automatically displays the standard thank-you page defined at the Forms application level.

End pages can be used to:

• displaying a message confirming submission of the application (e.g. thanks, reference number),
• providing information about the next stages of the process,
• invoking additional services or validators.

Characteristics of final pages:

• data from the end pages are not saved in the repository along with data collected from full application pages,
• components on the end pages work like regular components, they can perform validations, services, or display dictionary data,
• after submitting the application and moving to the end pages, the user cannot return to previous pages,
• there is no possibility to park the application after it has been submitted,
• after going through the end pages, the application does not go to the abandoned applications pool,
• end steps work analogously to regular steps, and we can define their basic properties according to the instructions.

Defining the final pages of the application

The process of creating final pages is analogous to defining regular form pages. The only difference is their location — they must be placed in the step below the Application save point.

The illustration below shows the steps of a sample application template. This template has:

• three application pages placed in steps Step1 and Step2
• Application save point specifying the location of the thank-you page,
• one end page located in the step Step3.

Figure 3. Sample steps with a thank-you page

All pages placed in the steps located below the Application save point are treated as end pages.