Table of Contents


  1. Preface
  2. Introduction to REST V2 Connector
  3. REST V2 connections
  4. REST V2 operations
  5. Mappings and mapping tasks with REST V2 Connector
  6. Appendix A: Supported swagger objects

REST V2 Connector

REST V2 Connector

REST source mapping example

REST source

You are a human resources administrator and you want to extract contact information, such as first name, last name, email, and phone number of employees from Apache CouchDB to a flat file.
  1. Create a REST connection. Verify that you specify the absolute path or the hosted URL of the swagger specification file, and the authentication method in the connection properties.
    The following image shows the configured REST connection:
  2. Create a flat file connection to write data to the flat file.
  3. Create a REST mapping.
    The following image shows the REST mapping:
  4. Add a Source transformation. Specify a name and description in the general properties.
  5. On the
    tab, perform the following steps:
    1. In the
      field, select the configured REST connection to connect to the Couch database.
    2. In the Operation field, select CouchDB as the operation.
      The following image shows the CouchDB operations:
    3. In the
      Request Options
      section, configure the request message in the following XML format, specify the attributes in the message, and validate the message:
      <!--1 or more repetitions:--> <proc:CouchDB_INPUT xmlns:proc="http://xml.schemas/infa/procedure/"> <!--Optional:--> <CouchDB> <!--1 or more repetitions:--> <emp> $$empID </emp> </CouchDB> </proc:CouchDB_INPUT>
      The request message fetches the details of an employee based on the specified employee ID.
    4. In the
      Advanced Properties
      section, set the tracing level to Normal, and use the default cache size of 1024 KB.
  6. On the Field Mapping tab, select the elements, such as
    , and
    in the response structure that you want to map to the output fields.
    The following image shows the response structure on the left pane in a hierarchical format and the output groups on the right pane in a relational format:
    The Secure Agent creates two output groups, workPhoneNumber and couchDB_out, which results in two relational output files. Primary and foreign keys are auto-generated.
  7. Add three Target transformations and specify the target objects for each of the transformations. Perform the following steps:
    1. Select a flat file connection for each of the target transformations to write data to the flat files.
    2. Create target objects workPhoneNumber.csv, couchDB_out.csv, and NewTarget.csv files to write data to the target.
    3. Select the output group from CouchDB that you want to link to the target objects.
  8. Add an Expression transformation, and include a
    function and the parameterized value
    in the expression so that the task updates the value of
    by one at the end of each run.
    The following image shows the configured expression that utilizes the in-out parameters:
  9. Click
    Mapping Task
    , and select the mapping for the task.
  10. When you save and run the
    task, the Secure Agent retrieves employee records from CouchDB and writes the data to the corresponding flat files.

Updated December 14, 2020