Cartridges

To manage your organization’s cartridges, go to the Configuration menu and click on Cartridges in the Processing section. Cartridges can be added and managed for your organization if you have the Cartridge Manager role.

Cartridges list

Cartridge list

In the cartridges list screen, you can:

  • Filter the list to view a more restricted list of cartridges or perform a search.

  • Create a new cartridge. For more details on how to create a new cartridge, please refer to the section: Cartridge creation.

  • Reload the table content by clicking on the Refresh button.

By selecting a specific cartridge from the list, you can:

  • Display the entire history of the selected cartridge. All changes made to the cartridge since its creation are listed with the corresponding dates and the identity of the modifier.

  • View all cartridge configuration details.

  • Edit the information of the selected cartridge. Editing an existing cartridge is very similar to creating a new cartridge. For more details on how to edit a cartridge, please refer to the section Cartridge Creation.

  • Delete the selected cartridge. A confirmation dialog will be displayed. This action is final, please perform it with caution.

Cartridge details

For each cartridge to which the user has access, the following information is available:

  • Id: Internal identifier

To access or copy this identifier, click on the number located in the first column: it is copied to the clipboard. You can use it to document issues for example.

  • Key: The cartridge key identifies the exact internal mapping to call during the transformation step.

  • Name: A meaningful name used to identify the cartridge on screens and for search.

  • Category of the cartridge. It can be Payment, PSR (Payment Status Reports), Notification, Dispatcher, or Financial Message. Note that Dispatcher is not currently being used by the platform.

  • The Type can be Inbound or Outbound. Note that Transformation Only is not currently being used by the platform and it should not be selected. The cartridge type determines if the mapping will be used to transform a specific format message into the internal model (Inbound) or from the internal model to a specific format message (Outbound).

  • Message ID Format determines the size of the identifications that the platform will generate for header, group, and transactions (depending on the channel configuration).

  • The organization to which this cartridge applies. If the organization column displays SYSTEM, these are system-created (and owned) product cartridges and cannot be edited.

Cartridge creation

When creating a new cartridge, you need to specify the following fields. The editing of an existing cartridge is very similar.

Create a new cartridge

Create a new cartridge screen

  • The organization will be prefilled with the organization that was selected when the Create button was clicked.

  • Name: A meaningful name used to identify the cartridge on screens and for search.

  • Category of the cartridge. It can be Payment, PSR (Payment Status Reports), Notification, Dispatcher, or Financial message. Note that Dispatcher is not currently being used by the platform.

  • The Type can be Inbound or Outbound. Note that Transformation Only is not currently being used by the platform and it should not be selected. The cartridge type determines if the mapping will be used to transform a specific format message into the internal model (Inbound) or from the internal model to a specific format message (Outbound).

  • Message ID Format determines the size of the identifications that the platform will generate for header, group, and transactions (depending on the channel configuration).

  • Key: The cartridge key identifies the exact (case-sensitive) internal mapping to call during the transformation step.

Note: Only certain combinations of category and type should be used.

  • If the category is Payment, the type can be Inbound or Outbound.

  • If the category is PSR, the type can be Inbound.

  • If the category is Notification, the type can be Outbound.

  • If the category is Dispatcher, the type can be Inbound. Note that Dispatcher is not currently being used by the platform.

  • If the category is Financial Message, the type can be Transformation Only or Validation.

You can now click the Create button to create the cartridge. It will appear in the list screen and will be available to use.