EBICS Subscription Manager Service

The EBICS Subscription Manager service to validate the keys on the Initialization letters for INI and HIA, update the status of the user to Ready before exchanging the EBICS messages, and import or export EBICS profiles that are created through Subscription Manager.

The following table provides an overview of the EBICS Subscription Manager service:

System name

EBICS Subscription Manager Service

Graphical Process Modeler (GPM) categories

All Services

Description

Use the EBICS Subscription Manager service to perform the following tasks:

  • Validate the keys on the Initialization letters for INI and HIA
  • Update the status of the user to Ready before exchanging the EBICS messages
  • Import or export EBICS profiles created through Subscription Manager

Business usage

Use this service to validate the keys on the INI and HIA initialization letters. On successful validation, the status of the user is updated to Ready.

Use this service to import or export subscription manager data to or from the database.

Usage examples

Validate the keys that you received in the initialization letter.

Preconfigured?

This service is preconfigured as part of the system installation.

Requires third-party files?

No

Platform availability

All supported Sterling B2B Integrator platforms.

Related services

None

Application requirements
  • The subscription manager master data must be in the bank's system.
  • The EBICS Server must be configured.
  • The validation of initialization letters can be carried out only after the INI and HIA initialization letters have been sent to the bank.

Initiates business processes?

None

Invocation

This service is invoked from a business process.

Business process context considerations

Use this service to either pack or unpack an ES.

Returned status values

Fatal - Nonrecoverable error

Transient - Recoverable error

Logic - Recoverable error

Success

Warning

Restrictions

None

Persistence level

System Default

Debug

To test this service, run the EBICS Subscription Manager service business process and verify if it completes successfully. The status report (for validation and initialization letters) and instance data (for import and export) display the test results.

Configuring the EBICS Subscription Manager Service

To configure the EBICS Subscription Manager service, you must specify the settings for the following fields in the Graphical Process Modeler (GPM) or in the Business Processing Modeling Language (BPML):

Field

Description

Partner ID

(partnerID)

Required for INI and HIA initialization letters. Partner ID of the customer.

User ID

(userID)

Required for INI and HIA initialization letters. User ID of the subscriber.

Public Electronic Signature Key (INI)

(esKey)

Required for validation of the hash value of the client certificates. To set the status of the user to Ready, the bank must receive the INI and HIA initialization letters.

Initialization letter for INI contains the user's public signature key.

The hash value is in hexadecimal, for example, 3C B0 19 66 C9 9C 6E 2C A5 BA 6A 2B 56 01 92 35 2A B4 91 53 E9 0B BA 34 C1 5E B5 9F 4A 64 F7.

Public Encryption Key (HIA)

(encrKey)

Required for validation of the hash value of the client certificates. To set the status of the user to Ready, the bank must receive the INI and HIA initialization letters.

Initialization letter for HIA contains the user's public encryption key.

The hash value is in hexadecimal, for example, 3C B0 19 66 C9 9C 6E 2C A5 BA 6A 2B 56 01 92 35 2A B4 91 53 E9 0B BA 34 C1 5E B5 9F 4A 64 F7.

Public Identification and Authentication Key (HIA)

(authKey)

Required for validation of the hash value of the client certificates. To set the status of the user to Ready, the bank must receive the INI and HIA initialization letters.

Initialization letter for HIA contains the user's public identification and authentication key.

The hash value is in hexadecimal, for example, 3C B0 19 66 C9 9C 6E 2C A5 BA 6A 2B 56 01 92 35 2A B4 91 53 E9 0B BA 34 C1 5E B5 9F 4A 64 F7.

Electronic Signature Key Hash Algorithm

(esKeyHashAlgo)

Optional. Hash algorithm for the user's public electronic signature Key. Valid values are SHA256 and SHA1. SHA256 is the default value.

Encryption Key Hash Algorithm

(encrKeyHashAlgo)

Optional. Hash algorithm for the user's public encryption key. Valid values are SHA256 and SHA1. SHA256 is the default value.

Identification and Authentication Key Hash Algorithm

(authKeyHashAlgo)

Optional. Hash algorithm for the user's identification and authentication key. Valid values are SHA256 and SHA1. SHA256 is the default value.

Business Process Examples

The following example business process illustrates using the EBICS Subscription Manager service to validate a user's initialization letters, both INI and HIA, using the default SHA256 hash algorithm: 
<operation>
  <participant name=" EBICSSubscrMgrService"/>
  <output message="validateSubscrKey">
    <assign to="partnerID">partner002</assign>
    <assign to="userID">user003</assign>
    <assign to="esKey">D4 7A 24 27 5C 5F D8
 0D 50 1B CF 28 C5 38 FE 1F 51 DD 24 8B 3E 5C 
 72 D5 CD 47 9D 82 79 0C EF 52</assign>
    <assign to="encrKey">B8 3C B0 19 66 C9 9C
 6E 2C A5 BA 6A 2B 56 01 92 35 2A B4 91 53 E9 0B BA 34
 C1 5E B5 9F 4A 64 F7</assign>
    <assign to="authKey">9D 2D C0 AF 55 6E D4 D9
 04 00 BB 23 AF C8 1B AB 91 A3 7A 2E 97 A9 31 6D D0 01 79
 5F C6 D0 CD 54</assign>
    <assign to="." from="*"/>
  </output>
  <input message="testing">
    <assign to="." from="*"/>
  </input>
</operation>

The following example illustrates importing Subscription Manager data:

<operation>
  <participant name=" EBICSSubscrMgrService"/>
  <output message="importSubscrMgrInfo">		
    <assign to="." from="*"/>
  </output>
  <input message="testing">
    <assign to="." from="*"/>
  </input>
</operation>

The following example illustrates exporting host related data. A user can call either the FileSystem adapter or Mailbox service to place a file in a mailbox.

<operation>
  <participant name=" EBICSSubscrMgrService"/>
  <output message="exportSubscrMgrInfo">
    <assign to="." from="*"/>
  </output>
  <input message="testing">
    <assign to="." from="*"/>
  </input>
</operation>
<!-- to extract to filesystem location -->
<operation name="To extract to a filesystem location">
  <participant name="extractFSA"/>
  <output message="extractFile">
    <assign to="Action">FS_EXTRACT</assign>
    <assign to="extractionFolder">/my/location</assign>
    <assign to="assignFilename">true</assign>
    <assign to="assignedFilename">exported.xml</assign>
    <assign to="." from="PrimaryDocument"/>
  </output>
  <input message="NOP"/>
</operation>
<!-- or to add into a mailbox -->
<operation>
  <participant name="MailboxAdd"/>
  <output message="AddExportedFileInfoMailbox">
    <assign to="." from="*"/>
    <assign to="MailboxPath">myMailbox</assign>
    <assign to="MessageName">exported.xml</assign>
    <assign to="ExtractableCount">1</assign>
  </output>
  <input message="inmsg">
    <assign to="MessageAddResults" from="*"/>
  </input>
</operation>