18 Configuring Eventpush Service Objects

The Eventpush service object enables you to redirect ME logged events to an external web browser, providing pushlet functionality for use in web services applications. This functionality is only useful in environments where the application uses only Javascript or only PHP. When configured, the feature overcomes a limitation in these languages that prevent them from interacting with a Java-based pushlet. (For web services applications written in Java, configuration of this object is necessary.)

The pushlet included in the ME software allows users of a web services application to have the events applicable to their call returned to their web browser. When a sample application receives an event via WSDL, it passes the event to the pushlet. Because the pushlet sorts events by ID, the web browser can request events by pushlet ID to maintain current call status.

eventpush-service

Configures and redirects the ME logged events to an external web browser over an HTTP or HTTPS web service port. It enables events to be asynchronously sent to clients. The eventpush-service requires the external-services > event-group to declare the destination service URL of the external device.

Perform the following steps to enable and configure the eventpush-service.

  1. Configure the IP eventpush-service. This creates the process in the ME that responds top client event requests.

    CXC> config box
    config box> config interface eth3
    config interface eth3> config ip eventpush
    Creating ’ip eventpush'
    config ip eventpush> config eventpush-service
    config eventpush-service> set admin enabled
    config eventpush-service> set protocol http 8081
    config eventpush-service> set page-domain companyABC.com
    
  2. Edit the target web application to include an IFrame. The IFrame is comprised of the name of the ME device running the eventpush-service application, the eventpush service port, and the string /cometapp/covergence.html.

    For example, if the name of the ME device running the eventpush-service is xyz.com with the eventpush web service running on port 8081, and if the system is running over HTTP, then the reference is http://xyz.com:8081/cometapp/covergence.html.

  3. Configure the external-services\event-group > event-service > service-url property, so that events are passed to the destination eventpush web service. Enter the destination domain IP, the eventpush service port, and the context string / cometapp/callouts. For example, http://127.0.0.0:8081/cometapp/callouts.

    CXC> config external-services
    config external-services> config event-group a
    config event-group a> config event-service cometd
    Creating ’event-service cometd'
    config event-service cometd> set service-url http://127.0.0.0:8081/
    cometapp/callouts
    

Syntax

config cluster box number interface ethX ip name eventpush-service
config cluster box number interface ethX vlan number ip name eventpush-service
config box interface ethX ip name eventpush-service
config box interface ethX vlan number ip name eventpush-service

Properties

admin: Enables or disables the eventpush service. Enabling the service allows you to redirect the ME logged events to an external Web browser.

Default: enabled
Values: enabled | disabled

Example: set admin disabled

protocol: Sets the protocol to use for pushlet operations. After setting a protocol, you can select the pushlet listen port (or accept the default). This is the port over which the server listens for HTTP(S) requests.

Default: The default protocol is http with a port setting of 8081. If you set the protocol to https, the default port is 8443.
  • Values: http: Sets an insecure (unencrypted) protocol for use in web transmission.

  • https: Provides secure transmission of web pages by using HTTP over SSL. Optionally, you can set:

    • A reference to a previously configured certificate (configured with the certificate object).

    • An alias for the key in the key store (named in the certificate configuration).

Example: set protocol https 8444 ”vspp tls certified cxc.company.com” certKey

max-threads: Specifies the maximum number of total worker threads, both active and spare (idle), allocated to the web server (eventpush service).

Default: 10
Values: Min: 1 / Max: 500

Example: set max-threads 15

min-spare-threads: Specifies the minimum number of inactive threads that the system must leave allocated to the web server. When the system removes idle threads, it must leave this number of spares available.

Default: 1
Values: Min: 0 / Max: 50

Example: set min-spare-threads 3

max-spare-threads: Specifies the maximum number of inactive threads the system can leave allocated to the eventpush service. When the system detects idle threads, it cannot have more than this number.

Default: 5
Values: Min: 0 / Max: 50

Example: set max-spare-threads

page-domain: Specifies the common domain name of the MEand the system running the web application.

Default: There is no default setting

Example: set page-domain www.acme.com

legacy-events: Enables or disables support for legacy events where the channel set is statically generated.

Default: enabled
Values: enabled | disabled

Example: set legacy-events disabled