Skip to main content
Version: 19

Summary / Info page

🎯 Functional documentation​

It is possible to show a summary/info page in the flow to provide additional information to the counterparty. The content of this page can be configured on customer needs.

The linked flow step is DOSSIER_SUMMARY and can be configured on multiple responsibilities. See also flow steps.

⚙️ Configuration​

To configure the content of the summary/info page, there are 2 options available:

  1. Using a customer specific implementation class
  2. By defining the cards through settings

See also Technical settings

The optional flowPageTitle setting is inherited from the base flow step settings. This value should be a translation key for the title shown at the top of the flow page, not the literal text that should be displayed.

Use a translation key that exists in the white label or organization translations, for example FLOW_PAGE_TITLE.SUMMARY_INFO_PAGE.

Example translation values:

  • translation key: FLOW_PAGE_TITLE.SUMMARY_INFO_PAGE
  • English translation: Summary information
  • Dutch translation: Samenvattende informatie

With that setup, the configuration should contain the key itself:

{
  "flowPageTitle": "FLOW_PAGE_TITLE.SUMMARY_INFO_PAGE"
}

Do not configure flowPageTitle with a hard-coded end-user label such as Summary information, because the flow expects a translation key and resolves the actual text through translations.

Using a customer specific implementation class​

  • implementationClass: A fully qualified class name that implements the content of the page Example
{
  "implementationClass": "eu.myharmoney.customer.x.CustomSummaryPage"
}

Defining the cards through settings​

  • cardConfigurations: Defines the cards to be shown on the summary/info page.

In this configuration method, the only available card type is a text-based information card.

  • The content (& title) can be specified using translation keys which can be created on the white label.
  • Only icons defined by the system are supported. Some examples are
    • information
    • dossier
    • todo

See example below or check the technical documentation.

Example

{
  "flowPageTitle": "FLOW_PAGE_TITLE.SUMMARY_INFO_PAGE",
  "cardConfigurations": [
    {
      "cardWidth": "FULL",
      "icon": "information",
      "cardTitle": "FLOW_STEP.SUMMARY_INFO_PAGE.TITLE",
      "textContent": "FLOW_STEP.SUMMARY_INFO_PAGE.CONTENT"
    }
  ]
}