Infor ION API Receiver

The infor_ion data receiver connects to and reads table data from Infor ION APIs.

Example:

If we want to retrieve table data from an Infor ION API hosted at https://111.32.43.2:8081, our configuration will look something like this:

{
    "data_receiver": [
      {
          "connections": [
            {
              "connection_name": "some_connection_name",
              "host": "https://111.32.43.2:8081",
              "auth_endpoint": "CUSTOMER_INFOR_ION_ENDPOINT/as/token.oauth2",
              "data_api_endpoint": "CUSTOMER_INFOR_ION_ENDPOINT/IBP/api/dataservice",
              "timeout": 60,
              "username": "some_username",
              "password": "some_password",
              "client_id": "some_client_id",
              "client_secret": "some_client_secret"
            }
          ],
          "data_receiver_name": "my_infor_ion_receiver",
          "poll_interval": 10,
          "protocol": "infor_ion",
          "streams": [
              {
                  "asset": "infor_ion_asset",
                  "stream_type": "infor_ion_stream_type",
                  "table_names": [
                      "SOME_TABLE_1",
                      "SOME_TABLE_2"
                  ]
              }
          ]
      }
    ]
}

Configuration:

Required and optional properties that can be configured for the receiver:

  • data_receiver_name: Unique name of the data receiver. This name will be used to track the progress state of the data stream.

  • protocol: Protocol to be used. Should be set to infor_ion.

  • connections: How to connect to the Infor ION API Server. A Infor ION API Server connection has the following configurable settings:

    Required and optional properties that can be configured for the Infor ION API - Table Export connection:

    • auth_endpoint: Endpoint for oauth authentication. E.g. https://10.1.1.1:443/CUSTOMER_INFOR_ION_ENDPOINT/as/token.oauth2

    • data_api_base_endpoint: Base endpoint for table data API. E.g. https://10.1.1.1/CUSTOMER_INFOR_ION_ENDPOINT/IBP/api/dataservice

    • connection_name: Unique name for the connection.

    • username: Username used along with a password to access the Infor ION API server.

    • password: Password used along with a username to access the Infor ION API server.

    • client_id: client_id used along with a client_secret to access the Infor ION API server.

    • client_secret: client_secret used along with a client_id to access the Infor ION API server.

    • timeout: Maximum number of seconds to wait for a response from a Infor ION API server. Default is 180.

  • streams: List of data streams. Each input stream has the following configurable settings:

    • asset: Asset identifier.

    • stream_type: Type of data stream

    • table_names: List of the table names to fetch.

    • ignored_columns_for_diff: List of columns to ignore when diffing the data. Default is an empty list. This is useful for columns that are expected to change based on when the data was requested and not when there is an actual change in the data. E.g. [“created_by”, “creation_time”, “modification_time”, “modified_by”]

  • poll_interval: The number of seconds to wait between attempts to fetch new data from the server.