SAP Event Stream Processor: Adapters Guide

Introduction

Input and Output Adapters

Subscribing to Data with Input Adapters

Publishing Data with Output Adapters

Adapter Run States

Editing Adapter Property Sets

Adapter Logging Configuration

Internal and External Adapters

Changing Studio Local Cluster Credentials for External Access

External Adapter Connectivity

Streaming Data to SAP HANA

Performance and Tuning Tips for the SAP HANA Adapter

Datatype Mapping for the SAP HANA Output Adapter

Adapters Currently Available from SAP

Adapter Summary

Atom Feed Input Adapter

Database Adapter

Database Input Adapter

Database Output Adapter

Datatype Mapping for the Database Adapter

Datatype Mapping: SAP HANA

Datatype Mapping: SAP Adaptive Server Enterprise

Datatype Mapping: Microsoft SQL Server Database

Datatype Mapping: IBM DB2 Database

Datatype Mapping: Oracle Database

Datatype Mapping: KDB Database

Datatype Mapping: SAP IQ

File FIX Input Adapter

Datatype Mapping for the File FIX Input Adapter

File FIX Output Adapter

Datatype Mapping for the File FIX Output Adapter

File/Hadoop CSV Input and Output Adapter

Managed Mode Configuration

File/Hadoop CSV Input Adapter Studio Properties

File/Hadoop CSV Output Adapter Studio Properties

Unmanaged Mode Configuration

File/Hadoop CSV Input Adapter Configuration

Sample Configuration File for the File/Hadoop CSV Input Adapter

File/Hadoop CSV Output Adapter Configuration

Sample Configuration File for the File/Hadoop CSV Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

Configuring Sandboxing for the File/Hadoop CSV Input and Output Adapter

File/Hadoop Event XML Input and Output Adapter

Managed Mode Configuration

File/Hadoop Event XML Input Adapter Studio Properties

File/Hadoop Event XML Output Adapter Studio Properties

Unmanaged Mode Configuration

File/Hadoop Event XML Input Adapter Configuration

Sample Configuration File: File/Hadoop Event XML Input Adapter

File/Hadoop Event XML Output Adapter Configuration

Sample Configuration File: File/Hadoop Event XML Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

Configuring Sandboxing for the File/Hadoop Event XML Input and Output Adapter

File/Hadoop JSON Input and Output Adapter

Managed Mode Configuration

File/Hadoop JSON Input Adapter Studio Properties

File/Hadoop JSON Output Adapter Studio Properties

Unmanaged Mode Configuration

File/Hadoop JSON Input Adapter Configuration

Sample Configuration File for the File/Hadoop JSON Input Adapter

File/Hadoop JSON Output Adapter Configuration

Sample Configuration File for the File/Hadoop JSON Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

Configuring Sandboxing for the File/Hadoop JSON Input and Output Adapter

File/Hadoop XML Input and Output Adapter

Managed Mode Configuration

File/Hadoop XML Input Adapter Studio Properties

File/Hadoop XML Output Adapter Studio Properties

Unmanaged Mode Configuration

File/Hadoop XML Input Adapter Configuration

Sample Configuration File for the File/Hadoop XML Input Adapter

File/Hadoop XML Output Adapter Configuration

Sample Configuration File for the File/Hadoop XML Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

Configuring Sandboxing for the File/Hadoop XML Input and Output Adapter

FIX Session Input Adapter

Control Flow

Start Command

Stop Command

Status Command

Data Streams

Example: FIX Session Input Adapter Data Stream

Stream and Column Names

Header and Trailer Fields

Record Indexing

Adapters and Sessions

Message Flow

Datatype Mapping for the FIX Session Adapter

Setting the JAVA_HOME Environment Variable

Configuration

FIX Session Adapter Directory

Schema and Configuration File

Adapter Controller Parameters

SAP Event Stream Processor Parameters

FIX Input Adapter

Event Stream Processor Properties

FIX Dictionary

Stream Configuration

Connectors

Inbound and Outbound Connectors

Sample Configuration File for All-In-One Connectors

File Connectors

Sample Configuration File for File Connectors

Client Socket Connectors

Sample Configuration File for Client Socket Connectors

Server Socket Connectors

Sample Configuration File for Server Socket Connectors

Session Settings

Default Settings

Specific Settings

Session Logins

Sender Login Properties

Target Login Properties

Session Properties

Example: Receiving and Hosting Inbound Messages

Logging

Duplicate Messages

Operation

Starting the FIX Adapter

Checking the FIX Adapter Status

Stopping the FIX Adapter

Examples

Example: Using File Connectors

Example: Using File Connectors With Batch Publishing

Example: Using Client Socket Connectors

Example: Using Server Socket Connectors

Example: Using All-In-One

Flex Output Adapter

Control Flow

Start Command

Stop Command

Status Command

Message Flow

Stream Handler

Setting the JAVA_HOME Environment Variable

Configuration

Flex Adapter Directory

Schema and Configuration File

Adapter Controller Parameter

SAP Event Stream Processor Parameters

Flex Server Settings

Sample Flex Configuration File

Logging

Operation

Starting the Flex Adapter

Checking the Flex Adapter Status

Stopping the Flex Adapter

Example: Sending a Subscription Request

FTP CSV Input and Output Adapter

Managed Mode Configuration

FTP CSV Input Adapter Studio Properties

FTP CSV Output Adapter Studio Properties

Unmanaged Mode Configuration

FTP CSV Input Adapter Configuration

Sample Configuration File: FTP CSV Input Adapter

FTP CSV Output Adapter Configuration

Sample Configuration File: FTP CSV Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

FTP Event XML Input and Output Adapter

Managed Mode Configuration

FTP Event XML Input Adapter Studio Properties

FTP Event XML Output Adapter Studio Properties

Unmanaged Mode Configuration

FTP Event XML Input Adapter Configuration

Sample Configuration File: FTP Event XML Input Adapter

FTP Event XML Output Adapter Configuration

Sample Configuration File: FTP Event XML Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

HTTP Client Output Adapter

Managed Mode Configuration

HTTP Client Output Adapter Studio Properties

Unmanaged Mode Configuration

HTTP Client Output Adapter Configuration

Sample Configuration File: HTTP Client Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

HTTP Output Adapter

Control Flow

Start Command

Stop Command

Status Command

Message Flow

Setting the JAVA_HOME Environment Variable

Configuration

HTTP Adapter Directory

Schema and Configuration File

Adapter Controller Parameter

SAP Event Stream Processor Parameters

HTTP Server Settings

Sample HTTP Configuration File

HTTP Output Adapter Parameters

Logging

Operation

Starting the HTTP Adapter

Checking the HTTP Adapter Status

Stopping the HTTP Adapter

Example: Sending, Receiving, and Viewing Data

JDBC Input and Output Adapter

Managed Mode Configuration

JDBC Input Adapter Studio Properties

JDBC Output Adapter Studio Properties

Unmanaged Mode Configuration

JDBC Input Adapter Configuration

Sample Configuration File: JDBC Input Adapter

JDBC Output Adapter Configuration

Sample Configuration File: JDBC Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

JMS Adapter

Configuring a Queuing System for JMS Adapter

JMS CSV Input and Output Adapter

Managed Mode Configuration

JMS CSV Input Adapter Studio Properties

JMS CSV Output Adapter Studio Properties

Unmanaged Mode Configuration

JMS CSV Input Adapter Configuration

Sample Configuration File: JMS CSV Input Adapter

JMS CSV Output Adapter Configuration

Sample Configuration File: JMS CSV Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

JMS FIX Input Adapter

JMS FIX Output Adapter

JMS Object Input and Output Adapter

Managed Mode Configuration

JMS Object Input Adapter Studio Properties

JMS Object Output Adapter Studio Properties

Unmanaged Mode Configuration

JMS Object Input Adapter Configuration

Sample Configuration File: JMS Object Input Adapter

JMS Object Output Adapter Configuration

Sample Configuration File: JMS Object Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

JMS Event XML Input and Output Adapter

Managed Mode Configuration

JMS Event XML Input Adapter Studio Properties

JMS Event XML Output Adapter Studio Properties

Unmanaged Mode Configuration

JMS Event XML Input Adapter Configuration

Sample Configuration File: JMS Event XML Input Adapter

JMS Event XML Output Adapter Configuration

Sample Configuration File: JMS Event XML Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

JMS Map Input and Output Adapter

Managed Mode Configuration

JMS Map Input Adapter Studio Properties

JMS Map Output Adapter Studio Properties

Unmanaged Mode Configuration

JMS Map Input Adapter Configuration

Sample Configuration File: JMS Map Input Adapter

JMS Map Output Adapter Configuration

Sample Configuration File: JMS Map Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

KDB Input and Output Adapter

Control Flow

Start Command

Stop Command

Datatype Mapping for the KDB Adapter

KDB Datatypes to SAP Event Stream Processor Datatypes

SAP Event Stream Processor Datatypes to KDB Datatypes

KDB Input Adapter

KDB Output Adapter

Enabling Kerberos Authentication for the KDB Input and Output Adapters

Log File Input Adapter

Configuration

Properties

Starting the Adapter

Example: Reading from a Log File

Log File Input Adapter Script

NYSE Technologies Input Adapter

Control Flow

Start Command

Stop Command

Status Command

Watchlists

Market Data Watchlists

Order Book Watchlists

Data Streams

Market Data Streams

Order Book Data Streams

Stale Records

Message Flow

Datatype Mapping for the NYSE Adapter

Setting the JAVA_HOME Environment Variable

Configuration

NYSE Adapter Directory

Schema and Configuration File

Adapter Controller Parameter

SAP Event Stream Processor Parameters

Watchlist Stream Configuration Parameters

Data Stream Configuration

Datafeed Parameters

Sample NYSE Configuration File

NYSE Input Adapter

Logging

Operation

Starting the NYSE Adapter

Checking the NYSE Adapter Status

Stopping the NYSE Adapter

Watchlist Operation

Insert

Delete

Example: Subscribing to and Publishing Data

Open Input and Output Adapter

Tips for Migrating Your Open Adapter Scripts

Datatype Mapping for the Open Adapter

Setting the JAVA_HOME Environment Variable

Configuration

Open Adapter Directory

Include Files Syntax

Variable Substitution

Wildcard Property Names

Autoincremented Property Names

XML Properties Files

Open Adapter Components

Source Components

AsapSource Properties

SpPersistentSubscribeSource Properties

Sink Components

AsapSink Properties

WSSink Properties

Pipe Components

BeanShellPipe Properties

JDBCLookupPipe Properties

Reader Components

MultiFlatXmlStringReader Properties

XPathXmlStreamReader Properties

XPathMultiTypeXmlReader Properties

EspDelimitedStringReader

Writer Component

XPathXmlStringWriter Properties

Specifying Datetime Formats

Third-Party JAR Files

Valid Time Zones for the Open Adapter

Africa Time Zones

Asia Time Zones

Australasia Time Zones

Europe Time Zones

North America Time Zones

South America Time Zones

Starting the Open Adapter

Monitoring the Open Adapter

Remote Control Interface

HTTPRemoteControl

MailRemoteLogger

PasswordEncryptor

Generating Self-Signed RSA Keys Using Java Keytool

Generating Self-Signed RSA Keys Using OpenSSL

Generating Self-Signed RSA Keys Using OpenSSL (PKCS8 Keystore)

Examples

Example: Using the AsapSink Component

Example: Using the AsapSource Component

Example: Using the BeanShellPipe Component

Example: Using the JDBCLookupPipe Component

Example: Using the MultiFlatXmlStringReader Component

Example: Using the SpPersistentSubscribeSource Component

Example: Using the WSSink Component

Example: Using the WSSource Component

Example: Using the XPathMultiTypeXmlReader Component

Example: Using the XPathXmlStreamReader Component

Example: Using the XPathXmlStringWriter Component

Random Tuples Generator Input Adapter

Replication Server Adapter

Configuring the Adapter on the Replication Server Workstation

Setting the JAVA_HOME Environment Variable

Configuring the Adapter in Studio

Configuring the Adapter for Communication through Secure Sockets Layer

Supported Datatypes

Performance Tips

Logging

Tracing

Increasing the Debug Logging Level

Enabling Replication Server Tracing

Increasing JDK Logging Levels

Troubleshooting

Gathering Version Information

Verifying Connectivity Between Components

Verifying that the Adapter is Running

Verify that Replication Server is Communicating With the Adapter

Problems Resetting and Restarting the System

Common Errors and Resolutions

Unsupported Replication Server Features

RTView Adapter

Installing the RTView Adapter

Running the Publisher Example

Running the Subscriber Example

Creating and Updating an SAP Event Stream Processor Connection

SAP Event Stream Processor Parameters

Encrypting the RTView Adapter Password

Operation

Starting the RTView Display Builder

Starting the RTView Display Viewer

Creating Shortcuts for Dashboard Projects

Dashboard Objects and Data Streams

Creating a Cache

Example: Attaching an Object to a Cache

Example: Attaching an Object to a Stream

Example: Creating a Function

Publishing to SAP Event Stream Processor

Logging

Datatype Mapping for the RTView Adapter

Known Limitations

SAP Adaptive Server Enterprise Output Adapter

Error Handling for the SAP ASE Output Adapter

Troubleshooting Tips for the SAP ASE Output Adapters

Datatype Mapping for the SAP ASE Output Adapter

SAP IQ Output Adapter

Datatype Mapping for the SAP IQ Output Adapter

Error Handling for the SAP IQ Output Adapter

Enabling File Activity Monitoring for the SAP IQ Adapter

SAP RFC Input and Output Adapter

Generic RFC Mode

RFC Chaining

Read Table Mode

BW Mode

Control Flow

Start Command

Stop Command

Message Flow

Enabling the RFC Adapter

Managed Mode Configuration

SAP RFC Input Adapter Studio Properties

SAP RFC Output Adapter Studio Properties

Unmanaged Mode Configuration

SAP RFC Input Adapter Configuration

Sample Configuration Files for the RFC Input Adapter

SAP RFC Output Adapter Configuration

Sample Configuration Files for the RFC Output Adapter

Starting the SAP RFC Adapter

Stopping the RFC Adapter

Logging

Adapter Controller Parameters

RFC Adapter Directory Reference

Mapping File for Generic RFC Mode

Mapping File for Read Table Mode

Mapping File for BW Mode

Datatype Mapping for the SAP RFC Output Adapter

Datatype Mapping for the SAP RFC Input Adapter

SMTP Output Adapter

Socket CSV Input and Output Adapter

Managed Mode Configuration

Socket CSV Input Adapter Studio Properties

Socket CSV Output Adapter Studio Properties

Unmanaged Mode Configuration

Socket CSV Input Adapter Configuration

Sample Configuration File: Socket CSV Input Adapter

Socket CSV Output Adapter Configuration

Sample Configuration File: Socket CSV Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

Socket FIX Input Adapter

Datatype Mapping for the Socket FIX Input Adapter

Socket FIX Output Adapter

Datatype Mapping for the Socket FIX Output Adapter

Socket JSON Input and Output Adapter

Managed Mode Configuration

Socket JSON Input Adapter Studio Properties

Socket JSON Output Adapter Studio Properties

Unmanaged Mode Configuration

Socket JSON Input Adapter Configuration

Sample Configuration File: Socket JSON Input Adapter

Socket JSON Output Adapter Configuration

Sample Configuration File: Socket JSON Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

Socket Event XML Input and Output Adapter

Managed Mode Configuration

Socket Event XML Input Adapter Studio Properties

Socket Event XML Output Adapter Studio Properties

Unmanaged Mode Configuration

Socket Event XML Input Adapter Configuration

Sample Configuration File: Socket Event XML Input Adapter

Socket Event XML Output Adapter Configuration

Sample Configuration File: Socket Event XML Output Adapter

Adapter Examples

Starting the Adapter

Stopping the Adapter

Adapter Controller Parameters

Logging

TIBCO Rendezvous Adapter

Control Flow

Start Command

Stop Command

Status Command

Data Streams

Message Flow

Datatype Mapping for the TIBCO Rendezvous Adapter

Setting the JAVA_HOME Environment Variable

Configuration

TIBCO Rendezvous Adapter Directory

Schema and Configuration File

Adapter Controller Parameters

SAP Event Stream Processor Parameters

Stream Configuration

Input Stream Parameters

Output Stream Parameters

Rendezvous Server Settings

Sample TIBCO Rendezvous Configuration File

TIBCO Rendezvous Adapter

Logging

Operation

Starting the TIBCO Rendezvous Adapter

Checking the TIBCO Rendezvous Adapter Status

Stopping the TIBCO Rendezvous Adapter

Example: Subscribing and Publishing

Web Services (SOAP) Input and Output Adapter

Control Flow

Start Command

Stop Command

Message Flow

Mapping a Web Service Response to an SAP Event Stream Processor Column

Managed Mode Configuration

Web Services (SOAP) Input Adapter Studio Properties

Web Services (SOAP) Output Adapter Studio Properties

Unmanaged Mode Configuration

Web Services (SOAP) Input Adapter Configuration

Sample Configuration File for the Web Services (SOAP) Input Adapter

Web Services (SOAP) Output Adapter Configuration

Sample Configuration File for the Web Services (SOAP) Output Adapter

Stopping the Web Services (SOAP) Adapter

Logging

Adapter Controller Parameters

Web Services (SOAP) Adapter Directory

Examples

Example: Using a Simple Web Services (SOAP) Input Adapter

Example: Using a Web Services (SOAP) Input Adapter with Policy Driven Security

Example: Using a Web Services (SOAP) Input Adapter with Transport Level Security

Example: Using a Simple Web Services (SOAP) Output Adapter

Datatype Mapping for the Web Services (SOAP) Input Adapter

Datatype Mapping for the Web Services (SOAP) Output Adapter

WebSphere MQ Adapter

WebSphere MQ Input Adapter

WebSphere MQ Output Adapter

High Availability for the WSMQ Output Adapter

Queue Configuration

SAP Event Stream Processor Add-In for Microsoft Excel

Prerequisites

Enabling Automatic Publishing with the SAP Event Stream Processor Add-in for Microsoft Excel

Connection Wizard

Enabling Kerberos Authentication for the SAP Event Stream Processor Add-In for Microsoft Excel

Subscription Wizard

Publication Wizard

Automatic Publishing

Subscription Queries

Applying a Query

Known Issues and Limitations

SAP Event Stream Processor REST Provider

Configuring the SAP Event Stream Processor REST Provider

Example: Sending a JSON Request Using a REST Web Service Client

Accessing REST API Reference Information

Customizing Input Formatting of REST Requests

Managing a Large Number of Connections

REST Requests for Streams and Windows

View the Metadata of a Stream or Window

Publish to a Stream or Window

Publish to Multiple Streams or Windows

Update a Record in a Window

Update Multiple Records in Windows

Upsert a Record in a Window

Delete a Record in a Window

Delete Multiple Records in Windows

REST Requests for Life Cycle Management of a Project

Deploy a Project

Start a Project

Deploy and Start a Project

Update a Project

Stop a Project

Remove a Project

Stop and Remove a Project

Verify Deployment Success

REST Requests for SAP Event Stream Processor Resource Navigation

View WebSocket Server Connection Information

View a List of Workspaces in a Cluster

View a List of Projects in a Cluster

View a List of Projects in a Workspace

View the Metadata of a Project

View a List of Streams and Windows

View the Schema of a Stream or Window

SAP Event Stream Processor SOAP Provider

Configuring the SAP Event Stream Processor SOAP Provider

Example: Deploying a Project with wsp_deploy

Example: Using a Sample Client to Connect to the SAP Event Stream Processor SOAP Provider

wsp_deploy

Managing a Large Number of Connections

SAP Event Stream Processor WebSocket Provider

Configuring the SAP Event Stream Processor WebSocket Provider

Subscribe, Publish and Unsubscribe using JSON Requests

Example Requests

Streaming WebSocket Connections

Subscribe Using a Streaming Connection

Publish Using a Streaming Connection

WebSocket Provider Message Format

Managing a Large Number of Connections

Schema Discovery

Adapter Support for Schema Discovery

Guaranteed Delivery and Persistent Subscribe Pattern

Log Window

Truncate Window

Adapter Parameter Datatypes

Date/Time Format Codes

SecondDate and MsDate strftime() Formats for Input Adapters

SecondDate and MSDate strftime() Formats for Output Adapters

Deprecated Adapters

Deprecated Adapters Summary

Deprecated Adapter Support for Schema Discovery

JMS CSV Input Adapter

JMS CSV Output Adapter

JMS Custom Input Adapter

JMS Custom Output Adapter

JMS Object Array Input Adapter

JMS Object Array Output Adapter

JMS XML Input Adapter

JMS XML Output Adapter

Socket (As Client) CSV Input Adapter

Socket (As Client) CSV Output Adapter

Socket (As Client) XML Input Adapter

Socket (As Client) XML Output Adapter

Socket (As Server) CSV Input Adapter

Socket (As Server) CSV Output Adapter

Socket (As Server) XML Input Adapter

Socket (As Server) XML Output Adapter

Important Disclaimers and Legal Information

Copyright / Legal Notice