Documentation Changes

Read about updates, corrections, and clarifications to the documentation released with Sybase Event Stream Processor.

Documentation Changes for the Adapters Guide
CR# Description
N/A The section on the JMS adapter shows you how to configure a queuing system for the JMS adapter. It should also mention that, to run the adapter, you must obtain and place vendor specific JMS jar files in the $ESP_HOME/java folder and restart the Server.
716766 The documentation incorrectly states the support provided for .NET as ".NET (C#, Visual Basic, and so on)." It should say:

.NET (C#)

This correction applies to Custom Adapters in the Adapters Guide and the Studio Users Guide, and to What You Can Do with Sybase Event Stream Processor in the Getting Started Guide.
717192

The description for the DB Service Name property in the ASE Output adapter section states that only Open Client™ connections are supported. It should also state that an Open Client entry must be used in the service.xml file to be able to use the ASE Output adapter.

See the sample service.xml file in ESP_HOME/bin for more information on this property.
717862 The RTView adapter documentation incorrectly specifies version 1.6 of Java; it should be version 1.7.
Documentation Changes for the Studio Users Guide
CR# Description
680686 The guide should state:

When you create a duplicate named window or stream in the Visual Editor, then save your file and switch to the Text Editor, a third duplicate of the original stream or window is created. You can see this third duplicate only when you switch back to the Visual Editor.

Remove this third duplicate:
  1. In the Visual Editor, click Remove all shapes from diagram error.gif to clear out all the shapes.
  2. Click Add all shapesInsert Breakpoint to get the original stream or window and the second duplicate stream or window back.
  3. Give the duplicate stream window a unique name.
682387
To redeploy a project after making changes to a running project:
  1. From the Authoring perspective, compile a project and start it.
  2. In the Run-Test perspective, do some work with the project.
  3. Stop the project.
  4. In the Authoring perspective, make changes to the project and the start it.

    An error displays and the Run-Test console states that a failure occurred because the application already exists. This is because the project still exists on the server in a stopped state.

  5. To redeploy, remove the project from the Run-Test server view, and then start the new version from the Authoring perspective.
Documentation Changes for the CCL Programmers Guide
CR# Description
643882

Delta streams are allowed key transformation only when performing aggregation, join, or flex operations. Because a delta stream does not maintain state, you cannot define a delta stream on a window where the keys differ.
Documentation Changes for the Administrators Guide
CR# Description
682458

There are undocumented restrictions on user name and password credentials for the interactive mode of the esp_cluster_admin tool. Credentials may contain alpha numeric characters but must always start with an alphabetic character. For example, password 12345678 is invalid, whereas P12345678 is valid.
682913

References to the "port number used by your Event Stream Processor installation" are referring to the port number of your cluster cache.
717192

The External Database Access section should include information about using Open Client connections to connect to Adaptive Server Enterprise with the ASE Output adapter. You can only use Open Client connections with this adapter.

The DriverLibrary parameter for Open Client connections to Adaptive Server Enterprise should be esp_db_ocs_lib. The connection block below is from the sample service.xml file in the ESP_HOME/bin directory that is provided with Event Stream Processor.
<!-- ONLY MEANT TO BE USED WITH ASE OUTPUT ADAPTER -->
	<Service Name="SampleOCSService" Type="DB">
		<Parameter Name="DriverLibrary">esp_db_ocs_lib</Parameter>
		<Parameter Name="Host">localhost</Parameter>
		<Parameter Name="Port">5000</Parameter>
		<Parameter Name="User">sa</Parameter>
		<Parameter Name="Password"></Parameter>
		<Parameter Name="TDSPacketSize">2048</Parameter>
		<Parameter Name="AppName">ASEOutputAdapter</Parameter>	
	</Service>
Documentation Changes for the .NET SDK Guide
CR# Description
648988

The guide should state:

In general terms, the return code from a Publish call indicates whether or not the row was successfully transmitted. Any error that occurs during processing on the Event Stream Processor (such as a duplicate insert) will not get returned. The precise meaning of the return code from a Publish call depends on the access mode and the choice of synchronous or asynchronous transmission.

When using callback or select access mode, the return only indicates whether or not the SDK was able to queue the data. The indication of whether or not the data was actually written to the socket will be returned by the appropriate event. The callback and select access modes do not currently support synchronous publishing.

When using direct access mode, the type of transmission used determines what the return from the Publish call indicates. If publishing in asynchronous mode, the return only indicates that the SDK has written the data to the socket. If publishing in synchronous mode, the return from the Publish call indicates the response code the Event Stream Processor sent.

In no case will errors that occur during processing (such as a duplicate insert) be returned by a Publish call.

Documentation Changes for the Utilities Guide
CR# Description
682458

There are undocumented restrictions on user name and password credentials for the interactive mode of the esp_cluster_admin tool. Credentials may contain alpha numeric characters but must always start with an alphabetic character. The document also provides an invalid sample password of 1234.