Please enable JavaScript to view this site.

WebOffice  2.66 Complete Guide

Warning:
Creating and modifying a routing must be done by a developer
CALEWE~1_img317

Field

Explanation

Name

Name that identifies the provider.

Enabled

Enables or disables the provider.  A client can have only one enabled provider per push export type at a time.

Push Export Type

The push export type.

Collections v3

Events v2

Purchase v5

Terminal Communication v1

Description

Text that describes the provider.

Backup Message On Process Failure

If an error occurs during the push export processing,  the message should be backed up for reprocessing.  This is usually false for heartbeats (terminal communication) because the information is only pertinent if it is received in real time.

Do Not Send Empty Requests

Controls whether the system sends the request to the server in the case when the body element is empty and there is no data to submit.

Path

URI path for the SOAP/REST service.

* The path or the Path Transformation must be specified.

Web Service Type

SOAP or REST

Http Request Method

The HTTP request method.

POST

GET

Request Content Type

The content type for the request.

Examples:

text/xml

application/xml

application/x-www-form-urlencoded

Return Type

The return type expected.

Http Status Code (1)

Xml Document

(1) A successful transmission for a return type http Status Code is a response of OK or Created.

Body Transformation

The XSL transformation that needs to be applied to the WebOffice terminal message and that will be included in the body of the request.
Depending on the push export type, parameters are available to facilitate the transformations,

see the list of parameters below for each push export type:

Here are the WebOffice messages that can be transformed::

Collections v3 (SubmitCollectionsRequest v3)

Events v2 (SubmitEventsRequest v2)

Purchase v5 (SubmitPurchasesRequest v5)

Terminal Communication v1 (SubmitTerminalCommunicationRequest v1)

Path Transformation

The XSL transformation that needs to be applied to the WebOffice terminal message that will be used as the path for the request.

The same WebOffice messages as the body transformation are used.

Node XPath

The system can validate a response for requests that return an Xml Document.  The XPath and the Node ID attribute need to be specified.  The XPath specified a node within the response that contains the validation value.

Node ID Attribute

The attribute for the XPath node that contains the validation value.  

Expected Value

The system can validate the XPath node against a specified value when the returned XML contains a static success value.

Example: response message contains an <returnCode>OK</returnCode>

Target Namespace

The target namespace for the service.

Authentication Code

Basic authentication, the username value for the credentials.

Authentication Password

Basic authentication, the password value for the credentials.

Claims Wrap Endpoint Acquire

CLAIMS Authentication, the endpoint acquire value.

Claims Wrap Scope Realm

CLAIMS Authentication, the scope realm value.

Claims Wrap Issuer

CLAIMS Authentication, issuer value.  Like a username.

Claims Signing

CLAIMS Authentication, signing value.  A hash.