Sterling B2B Integrator - EBICS Encryption Service

The EBICS Encryption service encrypts and decrypts as a part of the packing and unpacking of order data.

The following table provides an overview of the EBICS Encryption service:

System Name

EBICS Encryption Service

Graphical Process Modeler (GPM) categories

All Services

Description

This service performs EBICS encryption and decryption of the order data using the AES-128 algorithm in pipeline mode.

Business usage

The EBICS Encryption service performs a part of the packing and unpacking of order data.

Usage examples

A business process is called by the EBICS Order Processing service to either encrypt or decrypt payload data.

Preconfigured?

This service must be installed and deployed before it is invoked. No configuration parameters are required.

Requires third-party files?

No

Platform availability

All supported Sterling B2B Integrator platforms.

Related services

None

Application requirements

None

Initiates business processes?

No

Invocation

This service is invoked from a business process.

Business process context considerations

Use this service in a business process to either encrypt or decrypt order data.

Returned status values

Fatal – Nonrecoverable error

Transient – Recoverable error

Logic – Recoverable error

Success

Warning

Restrictions

None

Persistence level

System default

Debug

Debugging information for this service is located in Sterling B2B Integrator. Navigate to Operations System Logs EBICS.

Output from Business Process to EBICS Encryption Service

The following table contains the parameters passed from a business process to the EBICS Encryption service:

Parameter

Description

action

Required. The action to be performed. Valid values are ENCRYPT and DECRYPT.

CommSessionId

Required. The communication session ID to which the service belongs to, for example, 012345.

pipelineTimeout

Optional. The pipeline timeout value. Default value is 300 seconds.

SymmetricKeyId

Optional if the value of the action parameter is Encrypt and required if the value of the action parameter is Decrypt. The ID of the document containing the secret key byte array, for example, sedna:node1:1200d56b272:400.

TransactionId

Required. The ID of the EBICS transaction, for example, TransactionId012345.

WfId

Required. The workflow ID of the transaction, for example, WfId012345.

mode

Optional. Indicates if the service is being invoked by the EBICS Banking Server or the EBICS Client. Valid values are Server and Client. The default value is Server. If you do not provide a value for this parameter, the default value is used.

Output from EBICS Encryption Service to Business Process

The following table contains the parameters passed from the EBICS Encryption service to a business process.

Parameter

Description

SymmetricKeyId

The ID of the document containing the secret key byte array if it is generated by this service, for example, sedna:node1:1200d56b272:400.

Business Process Examples

The following example business process illustrates payload encryption:
				
					<process name="ebicsencryption">
  <sequence>
    <operation>
      <participant name="EBICSEncryptionService"/>
      <output message="encryptRequest">
        <assign to="." from="*"/>
        <assign to="action"from="'ENCRYPT'"/>
      </output>
      <input message="encryptResponse">
        <assign to="." from="*"/>
      </input>
    </operation>
  </sequence>
</process>
				
			

The following example business process illustrates decrypting the payload:

				
					<process name="ebicsdecryption">
  <operation>
    <participant name="EBICSEncryptionService"/>
    <output message="decryptRequest">
      <assign to="." from="*"/>
      <assign to="action" from="'DECRYPT'"/>
    </output>
    <input message="decryptResponse">
      <assign to="." from="*"/>
    </input>
  </operation>
</process>
				
			

Previous Topic

Sterling B2B Integrator - EBICS Compression Service

Parent Topic

Sterling B2B Integrator - EBICS Banking Server Services

Next Topic

Sterling B2B Integrator - EBICS Encoding Service