Skip to content

XML Adapter

User Guide: Integration > Configure the Integration Service > XML Adapter

XML Adapter

An XML Adapter communicates with an external data source using an XML endpoint over the HTTP protocol.

Configure XML End-point Adapter

To configure a XML service in Integration service definition tab, follow these steps:

  1. In the Name field, provide a unique name for your service.

  2. From the Service Type list, select XML.

    Note: XML is selected, by default.

  3. Provide the following details to create a XML service.

    Fields Description
    Version Specify the version number for the service.
    Base URL Type the URL.
    Web Service Authentication Select one of following modes
    None: Select this option if you do not want to provide any authentication for the service.
    Basic: Provide User ID and Password if the external Web service requires a form or basic authentication.
    NTLM: Your service follows the NT LAN Manager authentication process. You are required to provide the User ID, Password, NTLM Host, and NTLM Domain.
    Identity Service for Backend Token Select the Identity service associated with your app if this service needs backend token like access_token from that Identity service to access the backend server.

  4. For additional configuration of your service definition, provide the following details in the Advanced section.

    | Fields | Description | | Specify JAR | To specify a JAR associated to the service, select one from the Select Existing JAR list or click Upload New to add a new JAR file. Make sure that you upload a custom JAR file that is built on the same JDK version used for installing Volt MX Foundry Integration. You can download the uploaded jars to your local system. | | API Throttling | If you want to use API throttling in Volt MX Foundry Console to limit the number of request calls within a minute, do the following:
    In the Total Rate Limit text box, enter a required value. This will limit the total number of requests processed by this API.

    In the Rate Limit Per IP field, enter a required value. With this value, you can limit the number of IP address requests configured in your Volt MX Foundry console in terms of Per IP Rate Limit.
    To override throttling from Volt MX Foundry App Services Console, refer Override API Throttling Configuration. | | URL Provider Class | Enter the qualified name of the URL Provider Class. For more information, refer URL Provider Support for XML, JSON, SOAP, and API Proxy. |

Note: All options in the Advanced section are optional.

  1. Enter the Description for the service.
  2. Click SAVE to save your service definition.

Create Operations for XML

The Operations List tab appears only after the service definition is saved.

Note: Click Operations List tab > Configure Operation. The Configured Operations list appears.

To create an operation, follow these steps:

  1. Click SAVE & ADD OPERATION in your service definition page to save your service definition and display the NewOperation tab for adding operations.
                        OR
    Click Add Operation to add a new operation or from the tree in the left pane, click Add > Add New Operation.

    Click to View image

    Note: To use an existing integration service, refer to How to Use an Existing Integration Service.

  2. Type the following fields to create a new operation:

    Field Description
    Name Type a new name for the operation in the Operation Name box.> Important: While configuring an integration service with basic auth mode, ensure that some reserved IDs are not used as input (or) header IDs. Key words such as userID and password are reserved by middleware when a user selects basic auth mode.
    Operation Security Level It specifies how a client must authenticate to invoke this operation.
    Select one of the following security operations in the Operation Security Level field.

    Authenticated App User – It restricts the access to clients who have successfully authenticated using an Identity Service associated with the app.
    Anonymous App User – It allows the access from trusted clients that have the required App Key and App Secret. Authentication through an Identity Service is not required.Public – It allows any client to invoke this operation without any authentication. This setting does not provide any security to invoke this operation and you should avoid this authentication type if possible.
    Private - It blocks the access to this operation from any external client. It allows invocation either from an Orchestration/Object Service, or from the custom code in the same run-time environment.
    Note: The field is set to Authenticated App User, by default.
    Target URL You can select which HTTP method to invoke on the back-end service from integration server.The Target URL field is pre-populated with the URL. You can add the suffix, if required.
    http://baseurl.com/suffix

    For Example, to the base URL, you can add suffix such as /latest  or /sports to get latest news or sports news:
    http://feeds.foxnews.com/foxnews`/latest`
    http://feeds.foxnews.com/foxnews`/sports`
    Target HTTP Method You can select which HTTP method to invoke on the back-end service from integration server. Select the required method for the operation from the Target HTTP Method field.

  3. For additional configuration of request (or) response operations, provide the following details in the Advanced section.

    Custom Code InvocationYou can add pre and post processing logic to services to modify the request inputs. When you test, the services details of various stages in the service execution are presented to you for better debugging. All options in the Advanced section are optional. For more details, refer to Preprocessor and Postprocessor.
    Stub Backend ResponseStub Backend Response allows you enable a stub back-end service. To enable Stub Backend Response, refer How to Enable Stub Back-end Response.For more details on Stub back-end response, refer to How to Develop Apps based on a Stubbed Service.
    Additional Configuration PropertiesAdditional Configuration Properties allows you to configure service call time out cache response. For information on different types of configuration properties, refer Properties.
    Front-end APIFront-end API allows you map your endpoint ](or) backend URL of an operation to a front-end URL. For detailed information, refer Custom Front-end URL.
    Pass-through CookiesPass-through Cookies allows you send cookies present in the incoming client request to the backend target request. For detailed information, refer Pass-through Cookies.
    Server EventsUsing Server Events you can configure this service to trigger or process server side events. For detailed information, refer Server Events.

    Note: All options in the Advanced section for operations are optional.

  4. Enter the Description for the operation.

Configure Request Operation for XML

Integration services accept only form-url-encoded inputs for all input parameters provided in service input parameters (request input).

You can perform the following actions in Request Input tab:

  1. Click Add Parameter  to add an entry (if the entries for input and the output tabs does not exist).
  2. To make duplicate entries, select the check box for the entry, click Copy and Paste.
  3. To delete an entry, select the check box for an entry and click Delete .

  4. Under the Body tab, perform the following actions:

    1. To forward the body of the client's request to backend as it is, select the Enable pass-through input body check box. For more details on API Proxy service, refer to How to Enable Pass-through Proxy for Operations.

    1. To configure parameters in the clients body, do the following:
    Field Description
    Name Enter the name for the request input parameter.
    Value Three different options are available in Volt MX Foundry under VALUE during configuration of any operation. When you start editing this field, dependent identity services are auto populated. These options primarily determine the source of the value of the header.

    Select request or session or Identity.
    Request: If this option is selected, the Integration Server picks the value pairs from the client's request during run time and forwards the same to the back-end.User has the option to configure the default value. This default value is taken if the request does not have the header.

    Session: If this option is selected, the value of header is picked from session context based on the user configuration.

    Identity: If this option is selected, you can filter the request parameters based on the response from the identity provider. For more details to configure identity filters, refer to Enhanced Identity Filters - Integration Services.

    Note: The field is set to Request, by default.
    TEST VALUE Enter a value. A test value is used for testing the service.
    DEFAULT VALUE Enter the value, if required. The default value will be used if the test value is empty.
    Scope Select request or session. This field is set to Request, by default.
    DATA TYPE The default data type for the selected column is loaded under the DATA TYPE field.
    Encode Select the checkbox to enable an input parameter to be encoded. For example, the name New York Times would be encoded as New_York_Times  when the encoding is set to True. The encoding must also adhere the HTML URL encoding standards.
    Description Enter the description for the Request Input parameter.

  5. Click the Header tab to provide the following custom headers for an operation.

    You must provide the custom HTTP headers based on the operation. For example, post or get.

    Perform the following actions to provide the custom header

    1. To forward headers of the client's request to backend as it is, select the Enable pass-through input header check box. For more details on API Proxy service, refer to How to Enable Pass-through Proxy for Operations.
    2. To configure parameters in the client's header, do the following:
    Field Description
    Name Provide custom HTTP headers required by the external source.
    Value Three different options are available in Volt MX Foundry under VALUE during configuration of any operation. When you start editing this field, dependent identity services are auto populated. These options primarily determine the source of the value of the header.

    Select Request or Session or Identity

    Request: If this option is selected, the Integration Server picks the value pairs from the client's request during run time and forwards the same to the back-end.User has the option to configure the default value. This default value is taken if the request does not have the header.

    Session: If this option is selected, the value of header is picked from session context based on the user configuration.

    Identity: If this is selected, you can filter the request parameters based on the response from the identity provider. For more details to configure identity filters, refer to Enhanced Identity Filters - Integration Services.

    Note: The field is set to Request, by default.

    Note: If the header value is scoped as a Request (or) Session and the same header is accessed under the
    Expression header value, then the expression must be represented as $request.header (or) $session.header.
    Example: If a header 1 value is a request and header 2 value is an expression, then the value of the expression must be $Request.header1.
    TEST VALUE Enter a value. A test value is used for testing the service.
    DEFAULT VALUE Change the syntax, if required. The default value will be used if the test value is empty.
    Description Enter the description for the header parameter.

  6. You can add pre and post processing logic to services to modify the request inputs. When you test, the services details of various stages are displayed in the service execution for better debugging. You can refer to Test a Service Operation for the steps to test a service.

Configure Response Operation for XML

Click Response Output tab to configure the fields of the table for displaying the data.

Note: If you define parameters inside a record as the session, the session scope will not get reflected for the parameters.

  1. To forward the response from the backend to the client as is, select the Enable pass-through output body check box. For more details on API Proxy service, refer to How to Enable Pass-through Proxy for Operations.

  2. You can configure XPath expressions for extracting the required elements from the back-end response of the service call. So that the extracted output can be sent to the client app. You can create an XPath automaticallyor manually.

    Note: Auto generation of XPath support is available from Volt MX Foundry V8 SP3 onwards.

    The following table details XPath generation:

    To create XPath automatically (SP4) To create XPath manually
    After you click Save and Fetch Response, the Tree view with the back-end response appears by default in the Test > Backend Response pane.

    Click or hover your mouse cursor over the node for which you want to create XPath. The Create response button appears next to that node.Click the Create response button.

    A new row is created automatically along with the XPath for the selected node in the Response Output tab.
    Note: The Response Output tab appears if you have clicked the Create response button from Request Input tab.    		 Click Add Parameter to add new row.
    Click the Tree button in the Backend Response tab.
    This displays the backend response in a tree structure format.
    Click the node for which you want to create XPath.

    The XPath for that node is displayed at the bottom of the Tree structure.

     Enter that XPath in the row that you have created.
       

  3. To configure parameters in the response, enter the values for required fields such as name, path, scope, data type, collection ID, record ID, format and format value.

    Important: If the back-end for an XML service provides the date in a specific format and you want send the date in a different format to a device, you can configure the data format and FormatValue ( syntax : inputDateFormat~outputDateFormat) in the response tab.
    For example, if a back-end sends the date as Thu, 07 Sep 2017 07:03:00 GMT and you want convert it to 2017-09-07T07:03:00.000+0000, then set the format value as EEE, dd MMM yyyy HH:mm:ss z~yyyy-MM-dd'T'HH:mm:ss.SSSZ

    For more details on the syntax of the date formats, referhttps://docs.oracle.com/javase/7/docs/api/java/text/ SimpleDateFormat.html

    Note:  When you enable Pass-through proxy flags, you will notice that you cannot configure request input, headers, and response out parameters for this operation.

  4. To validate the operation details, click Save and Test. For more details, refer to Test a Service Operation.

  5. Click Save Operation to save the changes.

    To use an existing integration service, refer to How to Use an Existing Integration Service.

    Note: You can view the service in the Data Panel feature of Volt MX Iris. By using the Data Panel, you can link back-end data services to your application UI elements seamlessly with low-code to no code. For more information on Data Panel, click here.