Endpoint Configuration Guide - Custom SOAP

Receiver Settings

The URL of the ONEiO SOAP receiver in the PROD environment

Username generated by ONEiO. The button to the right will generate the password.  

Data Settings

A comma-separated list of conditions that must all match in order to allow the inbound message to be processed. Each contains an attribute name, operation, and value. Supported operation types are:

= (or ==) for EQUALS

!= for NOT EQUALS

IN which evaluates to true if any of the values in the list are equal to the value compared to.

Defines the representation of the attributes when parsed by ONEiO from the original payload. Which in turn affects the path for mapping an element. I.e., "Legacy" dot (.) versus "Structured Body" slash(/) notation. See more about the attributes representation in this article.

Response Settings

Allows to create a template for a message ONEiO would respond to a request from your system.

Defines the HTTP status code of a response by ONEiO.

Entity Type Resolving

By default the root element of the inbound message will be the entity type. This can be configured differently by using the system property Inbound Container or Fixed Entity Type.

If Inbound Container is used and ${entityType} is not part of configuration, then Fixed Entity Type has to be used.

The container element the inbound message uses . (dot) for separating elements/fields and supports the variables ${entityType} and ${messageType}. E.g. '${entityType}.${messageType}.attributes'. Defaults to ${entityType}.

The path to the element, whose value will be used as the entity type. Supports using "*" wildcards for cases where the path is dynamic. Only one wildcard per path will be supported in order do avoid complexity.

For example, it the root element of a message contains a dynamic message type, an exact path can not be given. So to resolve the entity type in:

<Dynamic_Message_type>
    <Entity_type>Incident</Entity_type>
</Dynamic_Message_type>

The path to use would be "*.Entity_type"

Supports using "\@" at for cases where it requires to retrieve an attribute value instead of element value. For example, If you what to extract the value "Incident" from:

<Message_type>
    <Entity Entity_type="Incident">Wrong_Value</Entity >
</Message_type>

The path to use would be "Message_Type.Entity@Entity_type"

If there is no element in the path it will retrieve the attribute from the root. For example, If you what to extract the value "Incident" from:

<Message_type Entity_type="Incident">
    <Entity>Wrong_Value</Entity >
</Message_type>

The path to use would be "@Entity_type" or "Message_type@Entity_type". 

You can use "*" and "\@" in the same path but one after other, for instance "some.*@attribute" is an invalid path, but "*.element@attribute" is a valid path.

For use when there is no element representing the entity type in the inbound payload or if you want to set it fixed to a specific value.

Inbound Attachments

The name of the parent element that contains all the actual attachment elements. You can give a static path for the element as well, e.g. "data.attachments" would mean that the element is a child of data element and is named attachments.

The name of the actual attachment element whose child elements contain the actual data, empty string tries getting the attachments directly from the path of the Parent Element.

The name of the element that contains the content type of the file. 

The name of the element that contains the filename

The name of the element that contains the Base64 encoded attachment

Enables the function at ONEiO to filter the attachments in case they have already been "seen", i.e., we already received and parsed them at an earlier stage or they have been integrated by ONEiO.

Mandatory for Duplicate Filtering the name of the element representing the "ID" of an attachment. 

List of numeric HTTP response codes that are to be handled as non-recoverable when sending messages to your API. If ONEiO receives an error code that is not on the list, it will retry the message automatically, indefinitely. If ONEiO receives an error code that IS on this list, the message will result in an error. Values are separated by a comma (",").

Read timeout for the client in milliseconds.

60000

Connection timeout for the client in milliseconds.

60000

SOAP Settings

Sets the outbound namespace prefix for a message configurable on System, Entity type, Message type and attribute level with a cascading down inheritance

Sets the outbound namespace URI for a message configurable on System, Entity type, Message type and attribute level with a cascading down inheritance. 

Defines the SOAP action header which can cascade down from the System to the Entity and then Message level. Currently it's not possible to add a custom header value through the UI, however it's possible via a support request. 

By default the entity type will be used as root element for the outbound message.

The container element of the outbound message uses "." (dot) for separating elements/fields and supports the variables  ${entityType} and ${messageType}. E.g. '${entityType}.${messageType}.attributes'.

${entityType}

Specifies that empty fields should be added to outbound message if the field value is missing.

Disabled

Specifies that all attributes should be added to outbound message whether it has attribute configuration or not.

Enabled

Outbound Attachments

The name of the parent element that contains all the actual attachment elements. You can give a static path for the element as well, e.g. "data.attachments" would mean that the element is a child of data element and is named attachments.

attachments

The name of the actual attachment element whose child elements contain the actual data, empty string places the attachments directly under Parent Element.

attachment

The name of the element that contains the content type of the file. 

The name of the element that contains the filename

name

Name for the element that contains the file extension of the attachment. If the attachment doesn't have an extension at all, an empty value is put in the element.

The name of the element that contains the Base64 encoded attachment

base64Data

Response Handling

Defines a comma-delimited list of HTTP codes representing a success of an operation. (i.e. 200,201,202)

The path to the attribute containing the status of a successful operation. This property is mutually exclusive with the "Id Element".

Defines a comma-delimited list of values representing a successful operation.

The path to the attribute containing error information.

The path to the element representing the "ID" of an inbound entity.

The path to the element representing the "External ID" of an inbound entity. 

The name of an attribute 

The data type of an attribute