Defining the ION API connection point - HxGN EAM - 12.0.1 - Feature Briefs - Hexagon

HxGN EAM ION API Swagger

Language
English
Product
HxGN EAM
Search by Category
Feature Briefs
HxGN EAM Version
12.0.1

In order to use ION API in a document flow you must first define an ION API connection point.

  1. Provide all the required connection point information like Name and Description.

  2. On the Connection tab, import the service account. Go to the Creating service account section to learn more about service account.

  3. The supported scenarios for the ION API Connection point

    Get from API - Request a response from API. Use the data from the response to send an output document.

    Send to API - Use the data from the input document to send a request to API.

    Trigger API - Combination of Get and Send API, Use the data from the input document to send a request to API. Use the data from the response to send an output document.

  4. Now we will use Trigger API scenario. On the Documents tab, click Add Document and select the Trigger API.

  5. The use case used for this scenario includes taking a SyncEnvelope custom bod or AnyDocument as an input document and making a request to ION API for getting the default parts.

    The SyncEnvelope BOD and Any Document is attached to this PDF in the Attachments pane.

    SyncEnvelope AnyDocument

  6. For this use case, you need to select SyncEnvelope or AnyDocument on the Document To Receive tab.

  7. On the ION API tab, select the API you defined in the Infor IONĀ® API screen.

  8. On the Request Body tab, select the format as "text/xml" and Name should be inputXml.

  9. On the Output Document tab, to get an xml to output from the API, use the Document type as AnyDocument and format as text/xml.

  10. You can make a make a test call to the Target endpoint to check if the details provided are good. You can use the Test Connection option, while making the test request make sure the HTTP headers in the Input Request Parameters should always be "text/xml" for Accept and Content-Type headers as shown below as EAM webservice will only cater soap request XMLā€™s.

    While making a Test ION API call from ION API connection point, you may encounter an issue saying ā€œyou must specify a tenant as part of the website addressā€ as part of response as shown below, this is because the Https headers Content-Type is incorrect, though the UI its showing the Content-Type as text/xml, in the actual request content-type is set as something different from text/xml.

    TestIONAPICall

    To set the correct content-type as part of the request you need to set a header property as part of ION API suite endpoint policy as shown below screenshot with policy definition as:

    <header

    xmlns="http://www.infor.com/ion/api"

    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    name="header-example" displayName="header-example" enabled="true" version="1.0">

    <action>set</action>

    <headerName>Content-Type</headerName>

    <headerValue>text/xml</headerValue>

    </header>

    Available_APIs

  11. If you want to map file fields from the Input document to the Input API request you need to select the Map input document to API Request check box and give the request xml with place holders.

    You can use <IonApiRef> tag as a place holder as shown here.

    For more information on <IonApiRef> see the Infor IONĀ® Technology Connectors Administrative Guide.