Overview

The client supports many features of the Gateway. It is able to ping, send transmissions, send test data, request acknowledgements, and validate transsmissions, acknowledgements, and receipts.

Running

To run the client you must have the Gateway Client downloaded on your local machine. The SSTP GUI can currently be invoked by running the Gateway Client without any command line parameters.

Configuration

Upon running the client GUI you will be presented with the "Configure" tab open. This tab has areas to fill in your user name, password, and the location of the Gateway web service you will be using. By default it is filled out with entries for our demo site found here .

When the web service is set, the client will send a test ping to verify the service exists. A label to the right of the web service location will read "Found!" if the client receives a response.

By default when you change the web service on the "Configure" tab, the web service is sent a test ping. However if you wish to verify for yourself, you can send more with the Ping button located on the bottom of the "Configure" tab. These messages will be displayed with a time measurement corresponding to the time the server took to process the ping request.

Sending

Once configured with a web service, user name, and password. The client can send transmissions through the interface on the "Send" tab. The steps below outline sending a transmission to the gateway.

• Use the "Browse" button to select the desired transmission from file system.
• Click "Send" to connect and send transmission. Before the message is sent, validation takes place on the transmission. Error output will be displayed if your transmission fails validation.
• The receipt returned from the web service will be displayed on the screen.
• An alternative method allows you to get a transmission from the clipboard to send. If you have selected and copied a valid transmission from another source, (editor, example etc.), you may use the "Send clipboard data" button. The program will verify that the data you copied looks like a transmission and then proceed to validate and send it.
• To send some auto-generated test transmissions navigate to the "Test Send" tab and select a transmission to send. These transmissions are generated automatically and sent to the specified web service when you click the "Send test transmission" button.

Acknowledgements & Last Acknowledgements

After a transmission has been sent, its acknowledgement can be retrieved on the "Acknowledgement" tab. Once all pending acknowledgements have been sent, a message will be returned stating there is no more data for the given user.

The last acknowledgement retrieved by the given user can be retrieved any number of times on the "Last Acknowledgement" tab.

Saving Output

For the Send, Test Send, Acknowledgement, and Last Acknowledgement tabs there is a feature to allow you to save the result returned from the server. Once you have gotten a receipt, or an acknowledgement back from the server you will be able to see an output "manager". This manager allows you to select and view any of the return data the server has sent. It is also possible to save it to a file for later use.

Validation

This tab is used to test weather or not an XML transmission, acknowledgement, or receipt is valid XML. Verification also checks that the XML adheres to the rules from the implementation guide than can be verified on the client side. The steps below outline a simple verification for a transmission document.

• Use the "Browse" button to select the document to verify. This XML document must not include SOAP information as that may vary between implementations of the Gateway.
• Select the type of document you are verifying from the drop down menu located to the left of the "Validate" button. It is important to set the document type properly, otherwise a valid document may cause an error.
• If the file does not validate, error messages will be displayed in the lower text area. If there are line numbers for the error, they will be highlighted in the viewer (top text area).