Sterling B2B Integrator - EBICS ES Packaging Service

The EBICS ES Packaging service packs and unpacks key information that is used when signing and verifying the ES.

The following table provides an overview of the EBICS Electronic Signature (ES) Packaging service:

System name

EBICS ES Packaging Service

Graphical Process Modeler (GPM) categories

All Services

Description

Use this service either to pack or unpack EBICS ES.

Business usage

Use this service to either pack or unpack key information that is used when signing and verifying the ES.

Usage examples

A business process that is a part of EBICS requires access to either unpack key information or pack key information with its response.

Preconfigured?

This service must be installed and deployed before it is invoked.

Requires third-party files?

No

Platform availability

All supported Sterling B2B Integrator platforms.

Related services

None

Application requirements

None

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

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

Output from a Business Process to EBICS ES Packaging Service

The following parameters must be passed to the ES Packaging service when it is being invoked, with the value of the output message type set to Unpackage.

Parameter
Description

HostId

Required. The host ID defined in EBICS Banking Server and used in the transaction.

UserId

Required. The user ID used in the transaction.

PartnerId

Required. The partner ID used in the transaction.

OrderType

Required. The order type used in the transaction, for example, INI, HIA.

ProtocolVersion

Required. The supported EBICS protocol version, for example, H003.

SymmetricKeyId

Required. The document ID containing the symmetric key.

ESDocId

Required. The document ID of an ES. This document contains the packaged SignatureData element.

TransactionId

Required. The ID of the EBICS transaction.

WfId

Required. The workflow ID associated with the original workflow initiated in the EBICS request.

The following parameters must be passed to the ES Packaging service when it is being invoked, with the value of the output message type set to Package.

Parameter
Description

SignatureValue

Required. The calculated signature value that has been base64 encoded.

TransactionId

Required. The ID of the EBICS transaction.

WfId

Required. The workflow ID associated with the original workflow initiated in the EBICS request.

Output from EBICS ES Packaging Service to a Business Process

The following parameter must be passed to the business process when it is being invoked, with the value of the output message type set to Unpackage.

Parameter
Description

UserSignatureData

Required. The XML element containing information about an ES.

The following parameters must be passed to the business process when it is being invoked, with the value of the output message type set to Package.

Parameter
Description

ESDocId

Required. The document ID of ES. This document contains the SignatureData element.

SymmetricKeyId

Required. The document ID containing the symmetric key.

Business Process Examples

The following example business process illustrates the options required when attempting to unpack an ES.
				
					<process name="getESUnpacked">
  <sequence>
    <operation name="ESInfo">
      <participant name="EBICSESPackagingService"/>
      <output message="outMsg">
        <assign to="." from="*"/>
        <assign to="action" from=”'Unpackage'”/ >
        <assign to="ESPackedDocId">neith::1100909</assign>
      </output>
      <input message="inMsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
  </sequence>
</process>
				
			

The following example business process illustrates the use of the UserSignatureData element that is returned by the service:

				
					
<UserSignatureData>
  <OrderSignatureData>
    <SignatureVersion>A005</SignatureVersion>
    <SignatureValue>ABCD</SignatureValue>
    <CertId>neith::0090909</CertID>
  </OrderSignatureData>
  <OrderSignatureData>
    <SignatureVersion>A005</SignatureVersion>
    <SignatureValue>ABCD</SignatureValue>
    <CertID>neith::1180909</CertID>
  </OrderSignatureData>
</UserSignatureData>
				
			

The following example business process illustrates the options required when packing an ES:

				
					
<process name="getESUnpacked">
  <sequence>
    <operation name="ESInfo">
      <participant name="EBICSESPackagingService"/>
      <output message="outMsg">
        <assign to="." from="*"/>
        <assign to="action">Package</assign>
        <assign to="SignatureValue">dfdsf4454==
        </assign>
      </output>
      <input message="inMsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
  </sequence>
</process>
				
			

Previous Topic

Sterling B2B Integrator - EBICS Order Authorization Service

Parent Topic

Sterling B2B Integrator - EBICS Banking Server Services

Next Topic

Sterling B2B Integrator - EBICS Order Processing Service