SOAP Header sub-elements - HxGN EAM - Version 12.0.1 - Customization & Programming - Hexagon

This section defines the elements that are the sub-elements of the SOAP Header and will be inspected or processed by MP business process subsystem.

Security Element

Description

This element provides a mechanism for attaching security-related information to the SOAP envelope that should be passed to the receiver.

Sub elements

• wsse:UsernameToken—This element is used for sending basic authentication information.

Attributes

• wsse:Username—This element specifies the username of the authenticating party.

• Username may be in the form of username@tenant, where the username may not necessarily match the username of the MP business process subsystem user. Tenant specifies HxGN EAM business tenant. Alternatively, the tenant may be specified in a separate element (see below).

• wsse:Password—This element provides password information. Infor recommends that this element only be passed when a secure transport such as SSL is being used.

Example

<?xml version="1.0" encoding="UTF-8"?>

<soapenv:Envelope x
mlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soapenv:Header>

<wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">

<UsernameToken Id="MyID">

<Username>zoe@bigcompany</Username>

<Password> gOod47p$</</Password>

</UsernameToken>

</wsse:Security >

<Organization>Org1</Organization>

</soapenv:Header>

<soapenv:Body>

<cct:processRequest xmlns:cct="EWSConnector"/>

<MP0318_GetLocation_001 noun="Location" verb="Get" version="001" xmlns="http://schemas.datastream.net/MP_functions/MP0318_001"

xmlns:dsf="http://schemas.datastream.net/MP_fields"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://schemas.datastream.net/MP_functions/MP0318_001/Projects/Schemas/Asset/MP0318_GetLocation_001.xsd">

<dsf:LOCATIONID>

<dsf:LOCATIONCODE>TEST</dsf:LOCATIONCODE>

<dsf:ORGANIZATIONID entity="USER">

<dsf:ORGANIZATIONCODE>*</dsf:ORGANIZATIONCODE>

<dsf:DESCRIPTION/>

</dsf:ORGANIZATIONID>

<dsf:DESCRIPTION/>

</dsf:LOCATIONID>

</MP0318_GetLocation_001>

</soapenv:Body>

</soapenv:Envelope>

Session element

Description

This element provides a mechanism for session handling in SOAP calls. Sub elements:

dsmp: SessionId This element is used for sending session id in subsequent requests.

SessionScenario element

Description

This element provides a mechanism for various session handling scenarios.

Currently only one session scenario is supported: terminate session after SOAP call has been processed.

<dstm:SessionScenario xmlns:dstm="http://schemas.datastream.net/MP_functions"> terminate

</dstm:SessionScenario>

Organization element

Description

This element is used to gain authorization for executing this request. The organization code supplied in this element should match the organization code from the body of the request.

Tenant element

Description

The tenant may be specified either using the ‘username@tenant’ syntax discussed above, or in a separate tenant element. The latter approach is preferable since it allows the user name to contain the ‘@’ symbol (e.g. an email address).

<Tenant>DS_MP_1</Tenant>

MessageConfig element

Description

Some clients are not able to read the InformationAlert and WarningAlert elements that are contained in the response xml messages from the server. The MessageConfig element can be added to the request to tell the server to omit the InformationAlert and WarningAlert elements from the response.

To exclude the alert elements from the response, add this block to the SOAP header:

<MessageConfig>

<configItem name="returnAlerts">false</configItem>

</MessageConfig>

The default value for ‘returnAlerts’ is ‘true,’ so clients that wish to receive the information alerts need not include the MessageConfig block in the request.

The following illustrates the use of the MessageConfig element in the SOAP header:

<soap:Header>

<Organization xmlns="http://schemas.datastream.net/headers">*</Organization>

<Security xmlns="http://schemas.xmlsoap.org/ws/2002/04/secext">

<UsernameToken Id="MyID" xmlns="">

<Username>username@tenant</Username>

<Password>password</Password>

</UsernameToken>

</Security>

<SessionScenario xmlns="http://schemas.datastream.net/headers">terminate</SessionScenario>

<MessageConfig>

<configItem name="returnAlerts">false</configItem>

</MessageConfig>

</soap:Header>

BodyCompression element

Description

This element indicates whether request, response, or both are transmitted in compressed form. Possible values are "Request", "Response", "Both".

<dstm:BodyCompression xmlns:dstm="http://schemas.datastream.net/MP_functions"> Request

</dstm: BodyCompression >