The SST Registration Module is able to perform all the standard functions of the SST Registration Web Service. This page discusses the configuration of the SST Registration Module in the Gateway Client. The supported operations for this module are REQUEST, STATUS, GET, SEND, RETRIEVE, and ACK.
The SST Registration Client Module section (below) is placed in the "modules" section of the main XML configuration in order to activate and configure the SST Registration Module. The section below is a basic configuration and as a result will execute the standard SST Registration procedure, which is to REQUEST registrations, get their STATUS, GET registrations, SEND them to the Gateway, RETRIEVE acks from the Gateway, and then ACK them to the SST Register.
<sstregister-module enabled="true" priority="1">
<status-database>oracle.database</status-database>
<target-database>hsql.database</target-database>
<sstp-web-service>sstp-test</sstp-web-service>
<sstregister-web-service>sstreg-test</sstregister-web-service>
</sstregister-module>
Additional configuration XML may be added to customize the execution of the SST Registration Module. The example below displays how one would go about getting registrations from the SST Register web service.
<sstregister-module enabled="true" priority="1">
<status-database>oracle.database</status-database>
<target-database>hsql.database</target-database>
<sstp-web-service>sstp-test</sstp-web-service>
<sstregister-web-service>sstreg-test</sstregister-web-service>
<sstregister-step>
<sstregister-step-name>GET</sstregister-step-name>
<sstregister-transmissionid>TESTUSER123456123456</sstregister-transmissionid>
</sstregister-step>
</sstregister-module>
The valid steps that can be run as specified in the "sstregister-step-name" are listed below:
REQUEST - Request job from SST Register
STATUS - Request job status from SST Register
GET - Get registrations job from SST Register
SEND - Send registrations job to Gateway
RETRIEVE - Retrieve acknowledgements from Gateway
ACK - Acknowledge registrations to SST Register
A new feature has been added to allow the user to specify the type of request they wish to make to the SST Register. Previously the client was only able to retrieve changed registrations.
The mode can be specified by using the follow element "sstregister-request-type" in the module configuration:
<sstregister-module enabled="true" priority="1">
<status-database>oracle.database</status-database>
<target-database>hsql.database</target-database>
<sstp-web-service>sstp-test</sstp-web-service>
<sstregister-request-type>ALL</sstregister-request-type>
<sstregister-web-service>sstreg-test</sstregister-web-service>
</sstregister-module>
The following request modes are now available:
ALL - Request all registrations
CHANGED - Request all changed registrations
CHANGED_UNACKED - Request all changed and unacknowledged registrations
ALL_ACTIVE - Request all active registrations
If you choose to request ALL or ALL_ACTIVE registrations, you will be prompted to confirm this action. This is because you should only need to perform this type of request once, and never as a batch job. Once you have requested ALL registrations and entered them into your system, you will only need to request changes and updates.
Note that only the STATUS, GET, SEND, RETRIEVE and ACK steps require the "sql-batchid" element to be present, otherwise it is ignored.