Documentation for a newer release is available. View Latest

ODS Search

The ODS search module will let you search payments via a series of different fields (ID’s, party details and summary info).

Configuration

Config

This config is used for the autocomplete and dropdowns on certain Summary Info search fields in the UI. Those are global statuses, transaction types and system event names. This example shows the global statuses; to add more, you would add to this array:

The global status config is an array of objects where the name value should be set as whatever you would like the global status to be, and this is the value that will show up on the UI. Each status should be assigned one of 6 categories that has the closest meaning to the global status name. There are only 6 status categories available, and you should not assign a category that does not exist in the following list: PENDING, ACCEPTED, REJECTED, MANUAL_ACTION_REQUIRED, SCHEDULED, CANCELLED. The categories come from the default global state set. You can find more information on global states here. There can be more than one status in each category. Categories have been introduced because they drive certain screen behaviours in the UI. For example, only payments with a non-terminal and non-manual global status category i.e. PENDING and SCHEDULED will be able to be cancelled. NOTE: The cancel functionality has only been added on the frontend at the moment, there needs to be a backend implementation added in order for this to work which will be avaliable in the near future. 
global-statuses = [
    {
        name: "Pending",
        category: "PENDING"
    },
    {
        name: "Accepted",
        category: "ACCEPTED"
    },
    {
        name: "Completed",
        category: "ACCEPTED"
    },
    {
        name: "Rejected",
        category: "REJECTED"
    },
    {
        name: "Manual Action Required",
        category: "MANUAL_ACTION_REQUIRED"
    },
    {
        name: "Scheduled",
        category: "SCHEDULED"
    },
    {
        name: "Cancelled",
        category: "CANCELLED"
    }
  ]

In the config there are also date and amount types (payment, recall, bulk and batch) which appear in dropdowns in the UI. You can change the order in which these types appear in the dropdowns by changing the order in which they appear in the config.

For example, currently bulk date types appear in the UI in the following order:

bulk-date-types = [
                    "CREATED_AT",
                    "MESSAGE_RECEIVED_AT",
                    "INTERBANK_SETTLEMENT_DATE"
                  ]

If you want the message received at type to appear at the top of the list, you would change it to be like this:

bulk-date-types = [
                    "MESSAGE_RECEIVED_AT",
                    "CREATED_AT",
                    "INTERBANK_SETTLEMENT_DATE"
                  ]

The property 'detailsDefault' is used to handle the behaviour of the payment details screen:

details-defaults = {
       "showGraphs": true,
       "flows": {
           "opened": "latest",
           "sort": "asc",
       },
       "events": {
           "opened": "all",
           "sort": "asc",
       }
     }

Where 'showGraphs' handles whether the graphs are shown by default

'opened' handles if you want to have certain flows opened by default ('latest', 'all', 'none')

'sort' handles the order in which the flows/events are sorted ('desc', 'asc')

Columns

The payment-columns, recall-columns, bulk-columns and batch-columns are used to determine which columns are shown in the search results table on the search page for each of the payment types. The columns will be shown in the order they are defined in the config, so if you want to change the order of the columns, you can do so by changing the order in which they appear in the config.

It’s recommended to limit the number of columns to 10, as adding more negatively impacts the table’s readability and appearance.

The columns are defined as follows:

payment-columns = [
    {
        columnName: "createdAt"
    },
    {
        columnName: "transactionType"
    },
    {
        columnName: "csm"
    },
    {
        columnName: "amount"
    },
    {
        columnName: "clientRequestId"
    },
    {
        columnName: "debtor"
    },
    {
        columnName: "creditor"
    },
    {
        columnName: "bankingAccount"
    },
    {
        columnName: "globalStatus"
    },
    {
        columnName: "reasonCode"
    }
  ]

  recall-columns = [
     {
         columnName: "createdAt"
     },
     {
         columnName: "agentDetails"
     },
     {
         columnName: "originalEndToEndId"
     },
     {
         columnName: "originalTransactionId"
     },
     {
         columnName: "amount"
     },
     {
         columnName: "originalInterbankSettlementDate"
     },
     {
         columnName: "debtor"
     },
     {
         columnName: "creditor"
     }
   ]

  bulk-columns = [
      {
          columnName: "createdAt"
      },
      {
          columnName: "agentDetails"
      },
      {
          columnName: "totalInterbankSettlementAmount"
      },
      {
          columnName: "transactionType"
      },
      {
          columnName: "csm"
      },
      {
          columnName: "clientRequestId"
      },
      {
          columnName: "globalStatus"
      },
      {
          columnName: "reasonCode"
      }
   ]

   batch-columns = [
      {
          columnName: "createdAt"
      },
      {
          columnName: "transactionType"
      },
      {
          columnName: "clientRequestId"
      },
      {
          columnName: "debtor"
      },
      {
          columnName: "globalStatus"
      },
      {
          columnName: "reasonCode"
      }
   ]

ODS Page Size

ODS search results default settings. The maximum number of search results returning from ODS is set to 1000.

ods-page-results = {
    size = 1000
}

Alternative Identifiers

Custom alternative identifiers for Summary Info search fields need to be added to alternative identifiers within config if they are to be used as part of the autocomplete for that search field:

alternative-identifiers = [
    {
      searchBy: "CLIENT_REQUEST_ID",
      displayName: "Client Request ID"
    }
]

Reason Codes

Reason codes from common config can be overwritten for this module by supplying your own payment-search-reason-codes.conf.

In the dropdown on the UI, the reason code will be displayed along with the definition of the reason code. E.g. "Reason Code 1 — This is the reason code definition".

Example of reason code config:

reason-codes = [
    {
      reasonCode = "AB06",
      definition = "Transaction stopped due to timeout at the Instructed Agent.",
      source = "ISO"
    },
    {
      reasonCode = "AB07",
      definition = "Agent of message is not online. Generic usage if it cannot be determined who exactly is not online.",
      source = "ISO"
    },
    {
      reasonCode = "AB08",
      definition = "Creditor Agent is not online.",
      source = "ISO"
    }
]

Currency Codes

Currency codes from common config can be overwritten for this module by supplying your own payment-search-currency-codes.conf.

In the dropdown on the UI, the currency will be displayed along with the alphabetic code. E.g. "Alphabetic Code — Currency".

Example of currency code config:

currency-codes = [
        {
            "alphabeticCode": "AFN",
            "currency": "Afghani"
        },
        {
            "alphabeticCode": "EUR",
            "currency": "Euro"
        },
        {
            "alphabeticCode": "ALL",
            "currency": "Lek"
        }
]

Date Formats

Date Formats from common config can be overwritten for this module by supplying your own payment-search-date-formats.conf. If you don’t provide any values, the dates will be the UK standard.

Date formats are set per Processing Entity.

Example of date format config:

date-formats = {
  BANK_ENTITY_1 = {
    dateInput = "DD/MM/YYYY",
    datetimeInput = "DD/MM/yyyy HH:mm:ss",
    dateDisplay = "dd/MM/YYYY",
    datetimeDisplay = "dd/MM/YYYY"
  },
  BANK_ENTITY_2 = {
    dateInput = "DD/MM/YYYY",
    datetimeInput = "DD/MM/yyyy HH:mm:ss",
    dateDisplay = "dd/MM/YYYY",
    datetimeDisplay = "dd/MM/YYYY"
  }
}

Summary Configuration

This configuration will determine how to render and layout the various summary pages for unit of works in the UI. One set of configuration is required per summary type - payment, recall, bulk, batch

The evaluated layout can be retrieved from /api/ods/summary/{unitOfWorkId}

The configurable values are as follows:

Property Description

Summary

layout.<summary-type>

The set of cards to be rendered on the screen for the given summary type. This will be what is loaded when a user clicks on an invidual unit of work in the UI

Cards

layout.<summary-type>.cardNameTranslationKey

The translation key to be used by transloco for the card title. This will be added to the translation root key. e.g. t(payment-summary.debtorinformation)

layout.<summary-type>.translationRoot

The translation root for the transloco translation file. e.g. payment-summary

layout.<summary-type>.type

Type of card to use from the dynamic summary page. 3 current types list, gridList and relatedSummaries. Default is list

layout.<summary-type>.width

How many columns this card should take. Default is 1 and max is 6

layout.<summary-type>.data

The translation root for the transloco translation file. e.g. payment-summary

Items

layout.<summary-type>.data.<index>.translationKey

The translation key to be used by transloco for the card title. This will be added to the translation root key. e.g. t(payment-summary.debtorinformation)

layout.<summary-type>.data.<index>.type

The type of the value. Defaults to text but will include modifier such as status, reason code, bold, etc.

  • subtitle: Subtitle will be displayed as a title in the card, any following items in the list will appear under this subtitle until another one is specified.

  • text: Plain text that will ellipsis if too long and be copiable by the user.

  • date: Display as a date,

  • datetime: Display as date and time, clicking on this item will convert the date time to a duration of how long ago the date time was.

  • bold: Bolds the text.

  • status: Status will display the text, if the item has a warning value then a warning icon will be displayed along side it.

  • reasonCode: Reason code will reference the config for a relevant reason code and show some text alongside it when hovered over.

layout.<summary-type>.data.<index>.valuePath

The location of the value on the /details/{unit of work id} api of ODS. This path is defined using SPEL. e.g. "transactionData.customerCreditTransferInitiation.pmtInf[0].cdtTrfTxInf[0].pmtId.endToEndId" and can either be input as a single string or an array of strings if the value is conditional, input in preferential order with the first index being the highest preference i.e. ["firstChoicePath", "secondChoicePath].

layout.<summary-type>.data.<index>.fallbackValue

A string to use should the value be missing in the details response. Defaults to N/A

If you want any other data to come after alternative identifiers in a card, then make sure you add a subtitle in the following config to keep the data separate.

The source file for defaults is called summary-layout.conf and can be overridden in the client project by supplying your own summary-layout.conf.

layout = {
  payment = [
    {
      cardNameTranslationKey: "paymentTitle",
      translationRoot: "summary.processingIds",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "uowId",
          type: "text",
          valuePath: "summary.unitOfWorkId",
        },
        {
          translationKey: "clientRequestId",
          type: "text",
          valuePath: "summary.clientRequestId",
        },
        {
          translationKey: "transactionId",
          type: "text",
          valuePath: "summary.transactionId",
        },
        {
          translationKey: "instructingId",
          type: "text",
          valuePath: "summary.instructionId",
        },
        {
          translationKey: "uetr",
          type: "text",
          valuePath: "summary.uetr",
        },
        {
          translationKey: "alternativeIds",
          type: "altIds"
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingDates",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "created",
          type: "date",
          valuePath: "summary.createdAt",
        },
        {
          translationKey: "instructed",
          type: "date",
          valuePath: "summary.instructionReceivedAt",
        },
        {
          translationKey: "executionStarted",
          type: "date",
          valuePath: "summary.executionStartedAt",
        },
        {
          translationKey: "settled",
          type: "date",
          valuePath: "summary.settlementCompletedAt",
        },
        {
          translationKey: "acceptance",
          type: "date",
          valuePath: "summary.acceptanceDateTime",
        },
        {
          translationKey: "interbankSettlement",
          type: "date",
          valuePath: "summary.interbankSettlementDate",
        },
        {
          translationKey: "timeZone",
          type: "text",
          valuePath: "summary.timeZone",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.relatedSummaries",
      type: "relatedSummaries",
      width: 2,
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.executionStatus",
      type: "gridList",
      width: 3,
      data: [
        {
          translationKey: "csm",
          type: "text",
          valuePath: "summary.csm",
        },
        {
          translationKey: "priority",
          type: "text",
          valuePath: "summary.priority",
        },
        {
          translationKey: "processingEntity",
          type: "text",
          valuePath: "summary.processingEntity",
        },
        {
          translationKey: "globalStatus",
          type: "status",
          valuePath: "summary.globalStatus",
        },
        {
          translationKey: "reasonCode",
          type: "reasonCode",
          valuePath: "summary.reasonCode",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingAmounts",
      type: "gridList",
      width: 3,
      data: [
        {
          translationKey: "instructedAmount",
          type: "amount",
          valuePath: "summary.instructedAmount",
        },
        {
          translationKey: "instructedAmount",
          type: "currency",
          valuePath: "summary.instructedAmountCurrency",
        },
        {
          translationKey: "transactionAmount",
          type: "amount",
          valuePath: "summary.transactionAmount",
        },
        {
          translationKey: "transactionAmount",
          type: "currency",
          valuePath: "summary.transactionAmountCurrency",
        },
        {
          translationKey: "convertedAmount",
          type: "amount",
          valuePath: "summary.convertedTransactionAmount",
        },
        {
          translationKey: "convertedAmount",
          type: "currency",
          valuePath: "summary.convertedTransactionAmountCurrency",
        },
        {
          translationKey: "exchangeRate",
          type: "text",
          valuePath: "summary.exchangeRate",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.debtorDetails",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "debtorName",
          type: "text",
          valuePath: "summary.debtorName",
        },
        {
          translationKey: "debtorIban",
          type: "text",
          valuePath: "summary.debtorAccount",
        },
        {
          translationKey: "debtorBic",
          type: "text",
          valuePath: "summary.debtorBic",
        },
        {
          translationKey: "debtorAgentBic",
          type: "text",
          valuePath: "summary.debtorAgentBic",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.creditorDetails",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "creditorName",
          type: "text",
          valuePath: "summary.creditorName",
        },
        {
          translationKey: "creditorIban",
          type: "text",
          valuePath: "summary.creditorAccount",
        },
        {
          translationKey: "creditorBic",
          type: "text",
          valuePath: "summary.creditorBic",
        },
        {
          translationKey: "creditorAgentBic",
          type: "text",
          valuePath: "summary.creditorAgentBic",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.settlementNotificationInformation",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "debitAccount",
          type: "text",
          valuePath: "summary.debitAccount",
        },
        {
          translationKey: "creditAccount",
          type: "text",
          valuePath: "summary.creditAccount",
        },
        {
          translationKey: "debitAmount",
          type: "amount",
          valuePath: "summary.debitAmount",
        },
        {
          translationKey: "debitAmount",
          type: "currency",
          valuePath: "summary.debitAmountCurrency",
        },
        {
          translationKey: "creditAmount",
          type: "amount",
          valuePath: "summary.creditAmount",
        },
        {
          translationKey: "creditAmount",
          type: "currency",
          valuePath: "summary.creditAmountCurrency",
        },
      ]
    }
  ],
  recall = [
    {
      cardNameTranslationKey: "recallTitle",
      translationRoot: "summary.processingIds",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "uowId",
          type: "text",
          valuePath: "summary.unitOfWorkId",
        },
        {
          translationKey: "clientRequestId",
          type: "text",
          valuePath: "summary.clientRequestId",
        },
        {
          translationKey: "originalMessageId",
          type: "text",
          valuePath: "summary.originalMessageId",
        },
        {
          translationKey: "originalInstructionId",
          type: "text",
          valuePath: "summary.originalInstructionId",
        },
        {
          translationKey: "originalEndToEndId",
          type: "text",
          valuePath: "summary.originalEndToEndId",
        },
        {
          translationKey: "originalTransactionId",
          type: "text",
          valuePath: "summary.originalTransactionId",
        },
        {
          translationKey: "cancellationId",
          type: "text",
          valuePath: "summary.cancellationId",
        },
        {
          translationKey: "returnId",
          type: "text",
          valuePath: "summary.returnId",
        },
        {
          translationKey: "alternativeIds",
          type: "altIds"
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingDates",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "created",
          type: "date",
          valuePath: "summary.createdAt",
        },
        {
          translationKey: "messageReceived",
          type: "date",
          valuePath: "summary.messageReceivedAt",
        },
        {
          translationKey: "settled",
          type: "date",
          valuePath: "summary.interbankSettlementDate",
        },
        {
          translationKey: "originalInterbankSettlement",
          type: "date",
          valuePath: "summary.originalInterbankSettlementDate",
        },
        {
          translationKey: "timeZone",
          type: "text",
          valuePath: "summary.timeZone",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.relatedSummaries",
      type: "relatedSummaries",
      width: 2,
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.executionStatus",
      type: "gridList",
      width: 3,
      data: [
        {
          translationKey: "csm",
          type: "text",
          valuePath: "summary.csm",
        },
        {
          translationKey: "priority",
          type: "text",
          valuePath: "summary.priority",
        },
        {
          translationKey: "processingEntity",
          type: "text",
          valuePath: "summary.processingEntity",
        },
        {
          translationKey: "globalStatus",
          type: "status",
          valuePath: "summary.globalStatus",
        },
        {
          translationKey: "reasonCode",
          type: "reasonCode",
          valuePath: "summary.reasonCode",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingAmounts",
      type: "gridList",
      width: 3,
      data: [
        {
          translationKey: "returnedInterbankSettlementAmount",
          type: "amount",
          valuePath: "summary.returnedInterbankSettlementAmount",
        },
        {
          translationKey: "returnedInterbankSettlementAmount",
          type: "currency",
          valuePath: "summary.returnedInterbankSettlementAmountCurrency",
        },
        {
          translationKey: "originalInterbankSettlementAmount",
          type: "amount",
          valuePath: "summary.originalInterbankSettlementAmount",
        },
        {
          translationKey: "originalInterbankSettlementAmount",
          type: "currency",
          valuePath: "summary.originalInterbankSettlementAmountCurrency",
        },
        {
          translationKey: "chargeAmount",
          type: "amount",
          valuePath: "summary.chargeAmount",
        },
        {
          translationKey: "chargeAmount",
          type: "currency",
          valuePath: "summary.chargeAmountCurrency",
        },
        {
          translationKey: "convertedAmount",
          type: "amount",
          valuePath: "summary.convertedTransactionAmount",
        },
        {
          translationKey: "convertedAmount",
          type: "currency",
          valuePath: "summary.convertedTransactionAmountCurrency",
        },
        {
          translationKey: "exchangeRate",
          type: "text",
          valuePath: "summary.exchangeRate",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.debtorDetails",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "debtorName",
          type: "text",
          valuePath: "summary.debtorName",
        },
        {
          translationKey: "debtorIban",
          type: "text",
          valuePath: "summary.debtorAccount",
        },
        {
          translationKey: "debtorAgentBic",
          type: "text",
          valuePath: "summary.debtorAgentBic",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.creditorDetails",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "creditorName",
          type: "text",
          valuePath: "summary.creditorName",
        },
        {
          translationKey: "creditorIban",
          type: "text",
          valuePath: "summary.creditorAccount",
        },
        {
          translationKey: "creditorAgentBic",
          type: "text",
          valuePath: "summary.creditorAgentBic",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.agentDetails",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "instructingAgent",
          type: "text",
          valuePath: "summary.instructingAgent",
        },
        {
          translationKey: "instructedAgent",
          type: "text",
          valuePath: "summary.instructedAgent",
        },
      ]
    }
  ]
  bulk = [
    {
      cardNameTranslationKey: "bulkTitle",
      translationRoot: "summary.processingIds",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "uowId",
          type: "text",
          valuePath: "summary.unitOfWorkId",
        },
        {
          translationKey: "clientRequestId",
          type: "text",
          valuePath: "summary.clientRequestId",
        },
        {
          translationKey: "messageId",
          type: "text",
          valuePath: "summary.messageId",
        },
        {
          translationKey: "alternativeIds",
          type: "altIds"
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingDates",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "created",
          type: "date",
          valuePath: "summary.createdAt",
        },
        {
          translationKey: "messageReceived",
          type: "date",
          valuePath: "summary.messageReceivedAt",
        },
        {
          translationKey: "interbankSettlement",
          type: "date",
          valuePath: "summary.interbankSettlementDate",
        },
        {
          translationKey: "timeZone",
          type: "text",
          valuePath: "summary.timeZone",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.relatedSummaries",
      type: "relatedSummaries",
      width: 2,
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.executionStatus",
      type: "gridList",
      width: 3,
      data: [
        {
          translationKey: "csm",
          type: "text",
          valuePath: "summary.csm",
        },
        {
          translationKey: "priority",
          type: "text",
          valuePath: "summary.priority",
        },
        {
          translationKey: "processingEntity",
          type: "text",
          valuePath: "summary.processingEntity",
        },
        {
          translationKey: "globalStatus",
          type: "status",
          valuePath: "summary.globalStatus",
        },
        {
          translationKey: "reasonCode",
          type: "reasonCode",
          valuePath: "summary.reasonCode",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingAmounts",
      type: "gridList",
      width: 3,
      data: [
        {
          translationKey: "totalInterbankSettlementAmount",
          type: "amount",
          valuePath: "summary.totalInterbankSettlementAmount",
        },
        {
          translationKey: "totalInterbankSettlementAmount",
          type: "currency",
          valuePath: "summary.totalInterbankSettlementAmountCurrency",
        },
        {
          translationKey: "controlSum",
          type: "text",
          valuePath: "summary.controlSum",
        },
        {
          translationKey: "numberOfTransactions",
          type: "text",
          valuePath: "summary.numberOfTransactions",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.agentDetails",
      type: "list",
      width: 6,
      data: [
        {
          translationKey: "instructingAgent",
          type: "text",
          valuePath: "summary.instructingAgent",
        },
        {
          translationKey: "instructedAgent",
          type: "text",
          valuePath: "summary.instructedAgent",
        },
        {
          translationKey: "initiatingPartyName",
          type: "text",
          valuePath: "summary.initiatingPartyName",
        },
      ]
    }
  ]
  batch = [
    {
      cardNameTranslationKey: "batchTitle",
      translationRoot: "summary.processingIds",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "uowId",
          type: "text",
          valuePath: "summary.unitOfWorkId",
        },
        {
          translationKey: "clientRequestId",
          type: "text",
          valuePath: "summary.clientRequestId",
        },
        {
          translationKey: "paymentInformationId",
          type: "text",
          valuePath: "summary.paymentInformationId",
        }
        {
          translationKey: "alternativeIds",
          type: "altIds"
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.processingDates",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "created",
          type: "date",
          valuePath: "summary.createdAt",
        },
        {
          translationKey: "timeZone",
          type: "text",
          valuePath: "summary.timeZone",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.relatedSummaries",
      type: "relatedSummaries",
      width: 2,
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.executionStatus",
      type: "gridList",
      width: 6,
      data: [
        {
          translationKey: "csm",
          type: "text",
          valuePath: "summary.csm",
        },
        {
          translationKey: "priority",
          type: "text",
          valuePath: "summary.priority",
        },
        {
          translationKey: "processingEntity",
          type: "text",
          valuePath: "summary.processingEntity",
        },
        {
          translationKey: "globalStatus",
          type: "status",
          valuePath: "summary.globalStatus",
        },
        {
          translationKey: "reasonCode",
          type: "reasonCode",
          valuePath: "summary.reasonCode",
        }
      ]
    },
    {
      cardNameTranslationKey: "title",
      translationRoot: "summary.debtorDetails",
      type: "list",
      width: 6,
      data: [
        {
          translationKey: "debtorName",
          type: "text",
          valuePath: "summary.debtorName",
        },
        {
          translationKey: "debtorIban",
          type: "text",
          valuePath: "summary.debtorAccount",
        },
        {
          translationKey: "debtorAgentBic",
          type: "text",
          valuePath: "summary.debtorAgentBic",
        }
      ]
    },
  ]
}

Within your application you will want to define your translations correctly. So for the example of a layout config:

 layout = {
  payment = [
    {
      cardNameTranslationKey: "paymentTitle",
      translationRoot: "summary.processingIds",
      type: "list",
      width: 2,
      data: [
        {
          translationKey: "uowId",
          type: "text",
          valuePath: "summary.unitOfWorkId",
        }
      ]
    }
  ]
}

You will want to define your translation file as follows:

"summary": {
      "processingIds": {
          "paymentTitle": "Test"
      },
      "unitOfWorkId": "12345"
  }

MDS Search Configuration

This configuration will determine how to render and layout the various MDS search page tables in MDS Search module on the GUI. This has to be done per MDS object that you want to be displayed on your MDS search page

The evaluated layout can be retrieved from /api/ods/mds-info

The configurable values are as follows:

Property Description

Name

mds.name

The name of the MDS Object for which you want to provide the table headers for in the MDS Search page.

Response Digest

mds.responseDigest.name

The key to the translation in the transloco translation file for the name of the header you want to be represented in the MDS Search table for a given MDS Object.

mds.responseDigest.paths

The location of the values you want to display in your rows of the designated header taken from the ods/all/mds-objects/{type} api response. This path is defined using dot-based JSON path. e.g. "object.headers.unitOfWorkId"

mds.responseDigest.type

The type of the value.

  • STRING: Plain text that will ellipsis if too long and be copiable by the user.

  • AMOUNT: Two value paths need to be supplied a value and a currency, and this will be converted to an amount displayed in the result table.

  • INTEGER: Value path to be displayed as a number.

  • BOOLEAN: Value path to be displayed as a boolean in the result table.

  • DATE: Display as a date,

  • DATETIME: Display as date and time.

  • ARRAY: Value paths to be displayed collectively as a column of results within a row.

  • REASONCODE: Reason code will reference the config for a relevant reason code and show some text alongside it when hovered over.

The source file for defaults is called mds-response-fields.conf and can be overridden in the client project by supplying your own mds-response-fields.conf.

{
  mds = [
    {
      name = "PAIN_001",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "mdsObjectId"
          paths = ["object.payload.mdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "initiatingParty"
          paths = [
            "object.payload.content.grpHdr.initgPty.nm",
            "object.payload.content.grpHdr.initgPty.id.orgId.anyBIC"
          ]
          type = "ARRAY"
        }
      ]
    },
    {
      name = "PAIN_001_PAYMENT_INSTRUCTION",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "parentMdsObjectId"
          paths = ["object.payload.parentMdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "debtor"
          paths = [
            "object.payload.content.dbtr.nm",
            "object.payload.content.dbtrAcct.id.iban",
            "object.payload.content.dbtr.id.orgId.anyBIC"
          ]
          type = "ARRAY"
        }
      ]
    },
    {
      name = "PAIN_001_CREDIT_TRANSFER_TRANSACTION",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "parentMdsObjectId"
          paths = ["object.payload.parentMdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "creditor"
          paths = [
            "object.payload.content.cdtr.nm",
            "object.payload.content.cdtrAcct.id.iban",
            "object.payload.content.cdtr.id.orgId.anyBIC"
          ]
          type = "ARRAY"
        }
      ]
    },
    {
      name = "PACS_008",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "mdsObjectId"
          paths = ["object.payload.mdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "instructingAgent"
          paths = [
            "object.payload.content.grpHdr.instgAgt.finInstnId.nm",
            "object.payload.content.grpHdr.instgAgt.finInstnId.bicfi"
          ]
          type = "ARRAY"
        }
      ]
    },
    {
      name = "PACS_008_CREDIT_TRANSFER_TRANSACTION",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "parentMdsObjectId"
          paths = ["object.payload.parentMdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "transactionId"
          paths = ["object.payload.content.pmtId.txId"]
          type = "STRING"
        },
        {
          name = "debtor"
          paths = [
            "object.payload.content.dbtr.nm",
            "object.payload.content.dbtrAcct.id.iban",
            "object.payload.content.dbtr.orgId.anyBIC"
          ]
          type = "ARRAY"
        },
        {
          name = "creditor"
          paths = [
            "object.payload.content.cdtr.nm",
            "object.payload.content.cdtrAcct.id.othr.id",
            "object.payload.content.cdtr.orgId.anyBIC"
          ]
          type = "ARRAY"
        },
        {
          name = "instructingAgent"
          paths = [
            "object.payload.content.instgAgt.finInstnId.nm",
            "object.payload.content.instgAgt.finInstnId.bicfi"
          ]
          type = "ARRAY"
        }
      ]
    },
    {
      name = "PACS_004",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "messageId"
          paths = ["object.payload.content.msgId"]
          type = "STRING"
        },
        {
          name = "mdsObjectId"
          paths = ["object.payload.mdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "instructingAgent"
          paths = [
            "object.payload.content.instgAgt.finInstnId.nm",
            "object.payload.content.instgAgt.finInstnId.bicfi"
          ]
          type = "ARRAY"
        }
      ]
    },
    {
      name = "PACS_004_PAYMENT_TRANSACTION",
      responseDigest = [
        {
          name = "unitOfWorkId"
          paths = ["object.headers.unitOfWorkId"]
          type = "STRING"
        },
        {
          name = "clientRequestId"
          paths = ["object.headers.clientRequestId"]
          type = "STRING"
        },
        {
          name = "parentMdsObjectId"
          paths = ["object.payload.parentMdsObjectId.id"]
          type = "STRING"
        },
        {
          name = "originalMessageId"
          paths = ["object.payload.content.orgnlGrpInf.orgnlMsgId"]
          type = "STRING"
        },
        {
          name = "reasonCode"
          paths = ["object.payload.content.rtrRsnInf[0].rsn.cd"]
          type = "REASONCODE"
        },
        {
          name = "debtor"
          paths = [
            "object.payload.content.orgnlTxRef.dbtr.pty.nm",
            "object.payload.content.orgnlTxRef.dbtrAcct.id.iban",
            "object.payload.content.orgnlTxRef.dbtr.pty.orgId.anyBIC"
          ]
          type = "ARRAY"
        },
        {
          name = "creditor"
          paths = [
            "object.payload.content.rtrChain.cdtr.pty.nm",
            "object.payload.content.orgnlTxRef.cdtrAcct.id.iban",
            "object.payload.content.rtrChain.cdtr.pty.id.orgId.anyBIC"
          ]
          type = "ARRAY"
        }
      ]
    }
  ]
}

Unknown Processing Entity Configuration

In some circumstances, certain System Events and Message Logs routed to the Operational Dashboard do not have an identifiable processing entity. This can happen for a variety of reasons. Two common examples are:

System Events

An inbound message from a payment scheme fails schema validation. Currently, scheme packs do not determine the processing entity for inbound payments.

Message Logs

Transport failure events emitted by a connector.

In these cases, they will be assigned to UNKNOWN.

In order for a user to view such items, UNKNOWN should be included with ROLE_PAYMENT alongside any other processing entities in users.conf.

To prevent issues such as users creating processing settings against this UNKNOWN processing entity, it is recommended that ROLE_PAYMENT is the only role assigned to it.

users = [
  {
    username: "user"
    password: "password"
    roles: {
      UNKNOWN = [ROLE_PAYMENT]
      OTHER_PROCESSING_ENTITY = [...]
    }
  }
]

For more information about searching for System Events and Message Logs assigned to UNKNOWN, see here.