EBICS Compression Service

The EBICS Compression service compresses and decompresses files.

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

System Name	EBICS Compression Service
Graphical Process Modeler (GPM) categories	All Services
Description	This service performs EBICS compression and decompression using zlib in pipeline mode.
Business usage	The EBICS Compression 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 compress or decompress 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 compress or decompress 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 Compression Service

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

Parameter	Description
action	Required. The action to be taken. Valid values are COMPRESS and DECOMPRESS.
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.
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.

Business Process Examples

The following example business process illustrates payload compression:

<process name="ebicscompression">
  <sequence>
    <operation>
      <participant name="EBICSCompressionService"/>
      <output message="compressRequest">
        <assign to="." from="*"/>
        <assign to="action"from="'COMPRESS'"/>
      </output>
      <input message="compressResponse">
        <assign to="." from="*"/>
      </input>
    </operation>
  </sequence>
</process>

The following example business process illustrates payload decompression:

<process name="ebicsdecompression">
  <operation>
    <participant name="EBICSCompressionService"/>
    <output message="decompressRequest">
      <assign to="." from="*"/>
      <assign to="action" from="'DECOMPRESS'"/>
    </output>
    <input message="decompressResponse">
      <assign to="." from="*"/>
    </input>
  </operation>
</process>