WebConnectivity Gateway

WebConnectivity Gateway

Introduction #

This document describes how to set up ACORD message integration between the WebConnectivity Gateway and SICS as a scheduled job. All the required functionality is included in SICS System Administration Utility, but custom configuration is required.

Prerequisites #

  • The WebConnectivity WC_MR SOAP interface must be running and the URL known. The URL can be verified in a browser.
  • The SICS eMessaging WebService Interface must be running. For installation instructions please see: SICS eMessaging Server.

Configure access to servers #

The messaging integration is configured in file conf\sics.emessaging.integration.properties. The various entries are documented within the file itself. The file follows Java property file syntax. Lines that begin with a ‘#’ are comments and will be ignored.

The most important properties are the URLs to the server systems.

#Name of specific queue to get messages from:
webconn.get.queue=IN_QUEUE_NAME

#Name of specific queue to put messages to:
webconn.put.queue=OUT_QUEUE_NAME

#WebConnectivity WC MR service
webconn.wcmr.url=http://localhost:8585/WS_SICS/MR3.2/Service.asmx
webconn.secure.username=USER_NAME
webconn.secure.password=PASSWORD

#URL of SicsEMessagingServer (a.k.a. acord.soap)
acord.soap.server.url=http://localhost:12942/acord.soap/wsdl/MyAcordMsgService.wsdl

Define scheduled job #

In order to carry out message integration, a scheduled job must be set up. General information on defining and scheduled jobs can be found in the SICS System Admin Guide. For scheduling WebConnectivity integration, the job step type “Generic Java Process” must be added with the parameter com.csc.sics.emessaging.gateway.integration.SicsEMessagingGatewayRouter

define_scheduled_job.png define_class.png

Configure logging #

Log output of the message integration scheduled job, is configured as part of the standard SICS log configuration in conf/log4j2.xml in the scheduler (stand-alone or SICS Batch Server). The relevant logger name is com.csc.sics.emessaging.integration.Routing.

Since the scheduled job runs unattended, one may set up additional notification (e.g. email, windows event log etc.) in case of FATAL and ERROR messages. For details on how to set up such an appender, please refer to log4j2 documentation on how to set up appropriate appenders: https://logging.apache.org/log4j/2.x/

In addition progress and error messages will be written to the job step log. In case the log statements are not displayed in chronological order, right click on the left column heading to sort all statements:

configure_job_status.png wc_job_step_log.png

eMessages Import: #

Step-by-Step process to transfer the messages from the Gateway client to the SICS

  • eMessaging Server: Ensure that the emessaging server is up.

  • Configure Access: Ensure that the configuration is correctly set up in “conf\sics.emessaging.integration.properties”.

  • Scheduler setup: Ensure that the scheduler is correctly setup.

  • Run Scheduler: Running the scheduler for the web connectivity plug-in transfers the messages(TAs, CMs, and Settlements) from the Gateway Client to eMessaging server. Once the messages are moved from gateway client, the gateway client marks the transferred messages as “Read”. Running the web connectivity plug-in again will not attempt to transfer the messages that are already marked as “Read”.

  • Import messages: The eMessaging server imports these messages into the SICS.

  • Transfer Acknowledgements: Once the messages are imported, the web connectivity plug-in retrieves the acknowledgements with status “pending delivery” for messages with external system identifier “Gateway Client” and transfers them back to the sender.

    External_system_Gateway.png

  • External System Identifier: External system helps to differentiate the messages based on the import process, with two System Defined values:

    • ADEPT.
    • GATEWAT. The default eMessaging External system code for web connectivity or the input value given to the target.system.code in the conf\sics.emessaging.integration.properties file.

    The Reference data table code for eMessaging External system is “01239”.

Note: If a user wants to run the web connectivity plug-in for two different end points, create two separate properties file “sics.emessaging.integration.properties”, one for each end point and target.system.code.

Configure JAX-WS Provider #

If you are running the scheduler job from the command-line see: SICS Installation Guide - Appendix C - Command Line Parameters, you must change the default JAX-WS Provider to org.apache.axis2.jaxws.spi.Providerinruntime/conf/META-INF/services/javax.xml.ws.spi.Provider`