EBICS Custom Order Configuration

You can create a Custom Order Framework (COF) to create EBICS technical orders that caters to both EBICS Server and EBICS Client.

EBICS COF provides a highly flexible framework to add, edit, review, or delete EBICS order types as per business requirements, without any external support. This can be used to create a custom order type for H003 and H004 protocol version and the processing is the same as the existing order type, which is upload and download.

You can perform the following operations for every EBICS custom order type using UI and REST APIs:
  • Create Order Type
  • Update Order Type
  • Review (Approve or Reject) Order Type
  • Delete Order Type
  • View Order Type

Using the UI

You can log in to the Sterling B2B Integrator Server or Client either as an EBICS Administrator or EBICS Operator.

You can navigate to Administration Menu > EBICS > Custom Order Configuration to access the EBICS Custom Order Configuration UI.

Using REST APIs

You can use the Custom Order Services REST API for EBICS custom order types. For more information, see B2B REST APIs available in Sterling B2B Integrator.

Prerequisites

You must take note of the following:
  • Start REST HTTP Server Adapter on base port+60.
  • Start Liberty Server.
  • Add EBICS COF permissions to logged-in users.

Authorization of EBICS COF

You must configure user role as EBICS Administrator or EBICS Operator to access the UI or APIs for every user. You must also configure granular level permission for the same user.

You can navigate to Administration Menu > Accounts > User Accounts and configure the following permissions:
  • API/DELETE/Custom Order Delete
  • API/GET/Custom Order Get
  • API/POST/Custom Order Create
  • API/PUT/Custom Order Review
  • API/PUT/Custom Order Update

Troubleshooting EBICS COF errors

At present, there is no logger visible on the Logs menu to troubleshoot the EBICS COF errors. Instead, logger property files are introduced to troubleshoot the errors.

You must update the required log related configurations or settings in the following property files. 
<INSTALL_DIR>/properties/log.properties_COFAPI_ext
<INSTALL_DIR>/properties/log.properties_COFAPI_ext.in

The log files are available in this location -

<INSTALL_DIR>/logs/cofapis.log

Note: You must restart Sterling B2B Integrator after updating the required settings in above files to see the updated log files.