Kafka End Session Service

The Kafka End Session service closes the session created during the begin session.

The following table provides an overview of the Kafka End Session Service:

System name Kafka End Session Service
Description This service is used to close session with the external trading partner Kafka queue.
Business usage Use this service to close session with trading partner Kafka queue.
Usage example Sterling B2B Integrator uses the Kafka Begin Session service to establish a session with the trading partner's Kafka queue. The Kafka Consumer/Producer Service uses this session to push/pull a document from specific Kafka topic. The Kafka End Session Service closes the session with the Kafka server. It works through a configuration of the Kafka Client adapter.
Preconfigured? No
Requires third-party files? No
Platform availability All Sterling B2B Integrator supported platforms.
Related services Related services:
    • Kafka Client Adapter
    • Kafka Producer Service
    • Kafka Consumer Service
    • Kafka Begin Session Service
Application requirements A Kafka server.
Initiates business processes? This service does not initiate business processes.
Invocation This service is invoked from a business process.
Returned status values N/A
Restrictions N/A
Persistence level Default
Testing considerations Test this service by running the KafkaClientDemoAllServices business process provided with Sterling B2B Integrator. This business process tests the Kafka Client Adapter and all its related services.

Configuring the Kafka End Session Service

To configure the Kafka End Session Service, you must specify field settings in Sterling B2B Integrator:

Field Description
Name Name this service will have in Sterling B2B Integrator. Required.
Description Description of service. Required.
Select a Group Select one of the options:
  • None (default) – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Note: For more information about groups, see Managing Services and Adapters.
Action

Put - To push a document to the Kafka queue.

Get - To get a document from the Kafka queue.
KafkaClientAdapter Select the Kafka Client adapter for this service to use when ending sessions with a Kafka server.
Session ID Session ID is a unique identifier created from the Kafka Begin Session Service

Output from Service to Business Process

The following table contains the parameters passed from the Kafka End Session Service to the business process:

Parameter Description
SessionEndTime Identifies the time-stamp for end of the session.

Business Process Example

The following example business process illustrates using the Kafka End Session service for pushing a file to Kafka queue:

<process name="KafkaExample">
  <sequence>
[[Begin session here]] 
[[Producer/Consumer session here]] 
<operation name="Kafka End Session Service">
<participant name='KafkaEndSessionService'/>
<output message="xout">
<assign to="SessionID" from="SessionID/text()"/>		
<assign to="KafkaClientAdapter" from="KafkaClientAdapter/text()"/>
<assign to='Action'>put</assign>
</output>
<input message="xin">
<assign to="." from="*"/>
</input>
</operation>
</process>