Publisher API Configuration

The publisher API configuration dialogs allow you to set the UAF agent listening port and UAF component name, identify the data channels to be used by the publisher API, set listening ports and performance options, and identify the JINI server host name.

Operations Console communicates with the publisher API through an intermediary UAF agent. Use this dialog to set the UAF agent listening port and optional UAF component name.

Publisher API dialog 1 configuration options

Field name

Default value

Description

Listening Port

3201

Identifies the listening port that the UAF agent uses to communicate with Operation Console. You can use any free port on your system.

Component Name

None

Identifies this component. This name provides an identity that distinguishes this component from other components of the same type. Projects may include several subscribers or publishers. Track items more easily by assigning unique component names to them.

The publisher API multicasts messages to subscribers over one or more data channels. Sybase recommends that you use four channels for a system that handles 300,000 messages per second. Use this dialog to identify the data channels.

Publisher API dialog 2 configuration options

Field name

Default value

Description

Channel Name

Custom Channel 1

Identifies the data channel that publisher API uses to send messages to a subscriber. Although the installer assigns custom channel 1 to the first data channel by default, you can use any value as the channel name.

You must supply a channel name to any subsequent data channels you define. Track channel name errors more easily by assigning unique names to channels.

Local Interface

None

Identifies the IP address of the network interface to which the channel will be bound. Users can enhance performance by binding various data channels to separate network interfaces.

  • If you plan to install all publishers and subscribers on the same server, you must configure the local interface to use the loopback interface (127.0.0.1).

  • If you install publishers and subscribers on different servers, use the local machine address of the secondary Ethernet network card installed by the system administrator.

Broadcast IP Address

224.0.2.0

Identifies the Class D multicast IP address that the publisher API uses to send multicast messages to subscribers. This value should match the multicast address that subscribers use to receive messages.

Although the installer assigns 224.0.2.0 as a default multicast IP address to all broadcast IP address fields, your network administrator can choose an alternate multicast address. All multicast IP addresses must range from 224.0.2.0 – 224.0.255.0

Broadcast Port

3250

Identifies the local port on which this data channel will operate.

Publishers can send multicast messages to a subscriber on multiple data channels that share the same local interface and broadcast IP address, but the broadcast port must be unique to that data channel.

Note: After you define the first channel, do one of the following:
  • Click Next, making sure that the "I would like to define another data channel" is selected.

  • Unselect "I would like to define another data channel", and click Next to display the next set of configuration options.

The publisher API listens for administrative requests from Operations Console and resend requests. Use this dialog to set listening ports and performance options.

Publisher API dialog 3 configuration options

Field name

Default value

Description

Administration Listening Port

3202

Identifies the listening port that the publisher uses to monitor administrative requests (including shutdown, restart, and refresh commands) from Operations Console.

Resend Listening Port

3203

Identifies the port that the publisher uses to resend cached message packets to the subscriber. Publishers maintain a cache of recently sent message packets to ensure that the subscriber processes all message deliveries.

Local Interface Machine hostname Identifies the local interface that the publisher uses to monitor administrative requests.

Number of Packet Buffers

10000

Identifies the number of packet buffers. The publisher holds onto arriving packets of messages until the packets are processed. The specified number of packet buffers are created per data stream.

This setting can have a value between 1 and 4 billion, but the machine must have enough memory to hold the number of packets specified. Adjust this setting if resend requests from publishers are failing because the packet no longer exists.

For publishers, a value of 10000 usually provides sufficient packet history to maintain data integrity under moderate loads.

Number of Message Buffers

None

Identifies the number of message buffers the publisher temporarily stores to track data deliveries.

One message buffer is required for each message that is being simultaneously built. This setting can have a value from 1 to 65535, though the machine must have enough memory to hold the number of buffers specified

Installing Operations Console also installs a JINI server that tracks RAP components. This dialog only appears if you install components separately. If you install multiple components at the same time, and previously identified the JINI server host name, the installer does not display this dialog.

Publisher API dialog 4 configuration options

Field name

Description

JINI Server Host Name

Identifies the host name of the server where the RAP JINI server resides. This is the machine on which Operations Console is installed.