Search Knowledge Base by Keyword

New Connector

< Back

From the Connector Library page, you can create new connectors. To create:

  1. Click the New Connector button to bring up the New Connector wizard
  2. Enter the properties of the new connector on the Connector Properties tab

    1. Image Preview – Upload image to display on the Connection page (optional)
      1. Click the Change Image hyperlink and browse for an image to upload

      2. Click the Update button to upload the image. Click the Clear Selected File hyperlink to clear the file and browse for a new image. Click the Cancel Changes hyperlink to cancel the operation.
    2. Identifier – Enter identifier of the connector (required)
    3. Name – Enter name of the connector (required)
    4. Description – Enter description of the connector (optional)
    5. Help URL – Enter help URL of the connector (optional)
    6. Order – Choose the order the connector is displayed on the Connections page (optional)
    7. Enabled – Choose if the connector is enabled (required)
    8. Job Types – Choose the type of jobs available for the connector (required)
      1. Inbound Only
      2. Outbound Only
      3. Both Inbound and Outbound
  3. Click the Create button when finished to create the connector. You will be redirected to the Connector Properties tab to continue creating the connector. Click the Cancel button to cancel the operation.
  4. Create authentication methods for the new connector on the Authentication Methods tab

    1. Click the New Authentication Method button to bring up the New Authentication Method dialog
    2. Enter the properties of the new authentication method

      1. Populate Authentication Record – Choose how to populate the authentication method (required)
        1. Clear Data – Start with an empty record
        2. Clone Authentication Method – Start with a clone from an existing authentication method
      2. Name – Name of the authentication method (required)
      3. Description – Description of the authentication method (optional)
      4. Script – Name of the authentication script (required)
        1. json_rest_api.php
          1. Authentication Fields – Authentication fields of the authentication method (optional)
          2. CURLOPT Settings – CURLOPT settings of the authentication method (optional)
          3. Header Values – API header values of the authentication method (optional)
          4. Data Values – API data values of the authentication method (optional)
            NOTE: These settings are only visible when POST Endpoint has been checked.
          5. Post Authorization CURLOPT Settings – Post authorization PHP CURLOPT settings of the authentication method (optional)
            NOTE: These settings are only visible when POST Endpoint has been checked.
          6. Post Authorization Header Values – API post authorization header values of the authentication method (optional)
            NOTE: These settings are only visible when POST Endpoint has been checked.
      5. Order – Order of the authentication method in the menu (optional)
      6. Enabled – Choose if the authentication method is enabled (required)
    3. Click the Create button when finished to create the authentication method. You will be redirected back to the Authentication Methods tab. Click the Close button to cancel the operation.
      1. The new authentication method function is only available to users in the Administrator security group
    4. Override ETL error settings by selecting an authentication method (row) and clicking the Authentication Method Error Settings button on the toolbar
  5. Associate fields with the authentication method for the new connector on the Fields tab
    1. Select a field (row) to edit
    2. Click the Edit Field button on the toolbar to bring up the Edit Field dialog

      1. The edit button is grayed out unless a field (row) is selected

      2. The edit function is only available to users in the Administrator security group
    3. Update the properties of the field

      1. Enabled – Choose if the field is enabled (required)
      2. Field Name – Name of the field (required)
      3. Field Type – Type of the field (required)
      4. Field Label – Label of the field (required)
      5. Placeholder – Placeholder of the field (optional)
      6. Tooltip – Tooltip of the field (optional)
      7. Input Data – JSON input data of the field (optional)
      8. Minimum Length – Minimum length (number of characters) of the field (optional)
      9. Maximum Length – Maximum length (number of characters) of the field (optional)
      10. Default Value – Default value of the field (optional)
      11. RegEx Pattern – Regular expression pattern to validate input values of the field (optional)
      12. RegEx Message – Message to display for input values that do not match the regular expression pattern (optional)
      13. Order – Order of the field in the Activate New Connection dialog (optional)
      14. Required – Choose if the field is required (required)
    4. Click the Update button when finished to update the field. You will be redirected back to the Fields tab. Click the Close button to cancel the operation.
  6. Define the inbound job fields for the new connector on the Inbound Job Fields tab
    1. Select a job field (row) to edit
    2. Click the Edit Job Field button on the toolbar to bring up the Edit Job Field dialog

      1. The edit button is grayed out unless a job field (row) is selected

      2. The edit function is only available to users in the Administrator security group
    3. Update the properties of the job field

      1. Enabled – Choose if the field is enabled (required)
        1. The following inbound job fields are enabled by default and cannot be disabled: Order, Fields to Index, Data Identify, Destination Table, Enabled, Job Schedule, Job Description.
      2. Field Name – Name of the field (required)
      3. Field Type – Type of the field (required)
      4. Field Label – Label of the field (required)
      5. Placeholder – Placeholder of the field (optional)
      6. Tooltip – Tooltip of the field (optional)
      7. JSON Input Data – JSON input data of the field (optional)
      8. Minimum Length – Minimum length (number of characters) of the field (optional)
      9. Maximum Length – Maximum length (number of characters) of the field (optional)
      10. Default Value – Default value of the field (optional)
      11. RegEx Pattern – Regular expression pattern to validate input values of the field (optional)
      12. RegEx Message – Message to display for input values that do not match the regular expression pattern (optional)
      13. Order – Order of the field in the New Inbound Job and Edit Inbound Job dialogs (optional)
      14. Required – Choose if the field is required (required)
    4. Click the Update button when finished to update the inbound job field. You will be redirected back to the Inbound Job Fields tab. Click the Close button to cancel the operation.
  7. Create inbound job templates for the new connector on the Inbound Job Templates tab

    1. Click the New Inbound Job Template button to bring up the New Job Template dialog
    2. Enter the properties of the new job template (available job template fields differ by connector)

      1. Populate Job Record – Choose how to populate the job template (required)
        1. Clear Job Record – Start with an empty record
        2. Use Template – Start with a template job
      2. Job Description – Description of the job template (required)
      3. Job Schedule – Choose the frequency the job template will run (required)
        1. Hourly
        2. Daily
        3. Weekly
        4. Every 5 Minutes
        5. Every 15 Minutes
        6. Every 30 Minutes
        7. Custom
      4. Enabled – Choose if the job template is enabled (required)
      5. Use Unparsed Data – Choose if incoming data is parsed or left in its raw format (optional)
      6. Log Raw API Calls – Choose if raw API calls are logged (required)
      7. Allow Empty Table  – Choose if an empty table is allowed (required)
      8. Destination Table – Name of the destination table (e.g., my_table_cm_computer) (required)
      9. Data Identity – Identity of the data for dashboards (e.g., cm_computer) (optional)
      10. XML Envelope Payload – XML envelope payload of the SOAP call (optional)
      11. Data Selection – Connector specific data selection command of the job template (optional)
      12. CSV/JSON/XML File or Path – CSV/JSON/XML file or path (optional)
      13. Append Files to Same Destination Table – Choose if multiple files in the same path will append to the same destination table, or will create a new destination table for each file (optional)
      14. Append New Data to Existing Tables – Choose if new data will append to the same destination table, or will create a new destination table (optional)
      15. Fields to Index – Fields to index (optional)
      16. Request Unique Key Field – Request unique key field of the job template (databases only) (optional)
      17. Request Sort By Field – Field to sort the job template by (optional)
      18. Request Limit – Request limit of the job template (optional)
      19. Method Type – Method type of the job template (GET, POST, PUT, PATCH, DELETE) (required)
      20. API End Point – API end point of the job template (optional)
      21. API Data Parameters – API data parameters of the job template (optional)
        1. Enter Key and Value and select Type (String, Numeric, Boolean) for each API data parameter
        2. Check Body if the API data parameter is passed through the body rather than the URI (Uniform Resource Identifier)
        3. Check Header if the API data parameter is passed through the header rather than the URI (Uniform Resource Identifier)
        4. Click the Add button to add API data parameters
        5. Click the Delete button to delete API data parameters
      22. Body Data Sending Method – Method for sending the body data of the job template (JSON Encoded Data, Form Data) (required)
      23. Raw JSON Body Data – Raw JSON body to send. Do not use body selections in the API Parameters if this is used. (optional)
      24. API Return Data Node – API return data node of the job template (optional)
      25. Ignore XML Attributes – Choose if field attributes are ignored and not included in the data when parsing XML (optional)
      26. Click Show Pagination Fields to enter pagination properties of the job template. Click Hide Pagination Fields to hide pagination fields.
        1. Pagination Type – Paging type of the job template (Records, Pages, Next Record Node, Next Page Node) (optional)
        2. API Pagination Node – API pagination node of the job template (Next Page, Next Node) (optional)
        3. Pagination Offset Start – Request paging offset start or data node of the job template (optional)
        4. Pagination Limit – Request pagination limit of the job template (optional)
        5. Pagination Termination Node – Pagination termination node of the job template (optional)
        6. Maximum API Calls – Limit of API calls that can be made by the job template to avoid an endless loop (optional)
      27. Click Show Enumeration Fields to enter enumeration properties of the job template. Click Hide Enumeration Fields to hide enumeration fields.
        NOTE: Triple enumeration is supported.

        1. Enumeration 1 Type – Enumeration type of the job template (API End Point, Other ETL Job, Data Type, External Data) (optional)
          1. API End Point
            1. Enumeration 1 Keys End Point – Enumeration keys end point of the job template (optional)
            2. Enumeration 1 Node – Enumeration node of the job template (optional)
            3. Enumeration 1 Fields – Enumeration fields of the job template (optional)
          2. Other ETL Job
            1. Enumeration 1 ETL Job – ETL job for the enumeration values of the job template (optional)
            2. Enumeration 1 Fields – Enumeration fields of the job template (optional)
          3. Data Type
            1. Enumeration 1 Data Type – Data type and fields of the enumeration values (optional)
          4. External Data
            1. Enumeration Key – Enumeration key of the job template (optional)
        2. Enumeration 2 Type – Enumeration type of the job template (API End Point, Other ETL Job, Data Type) (optional)
          1. API End Point
            1. Enumeration 2 Keys End Point – Enumeration keys end point of the job template (optional)
            2. Enumeration 2 Node – Enumeration node of the job template (optional)
            3. Enumeration 2 Fields – Enumeration fields of the job template (optional)
          2. Other ETL Job
            1. Enumeration 2 ETL Job – ETL job for the enumeration values of the job template (optional)
            2. Enumeration 2 Fields – Enumeration fields of the job template (optional)
          3. Data Type
            1. Enumeration 2 Data Type – Data type and fields of the enumeration values (optional)
        3. Enumeration 3 Type – Enumeration type of the job template (API End Point, Other ETL Job, Data Type) (optional)
          1. API End Point
            1. Enumeration 3 Keys End Point – Enumeration keys end point of the job template (optional)
            2. Enumeration 3 Node – Enumeration node of the job template (optional)
            3. Enumeration 3 Fields – Enumeration fields of the job template (optional)
          2. Other ETL Job
            1. Enumeration 3 ETL Job – ETL job for the enumeration values of the job template (optional)
            2. Enumeration 3 Fields – Enumeration fields of the job template (optional)
          3. Data Type
            1. Enumeration 3 Data Type – Data type and fields of the enumeration values (optional)
        4. Pause Enumeration – Pause enumeration every X calls for Y seconds (optional)
        5. Kill Enumeration on Error – Choose if enumeration is stopped on an error (optional)
      28. Additional Fields – Additional fields to add to the staging data when the jobs run (optional)
        1. Enter Field Name and Field Data pair for each additional field
        2. Click the Add button to add additional fields
        3. Click the Delete button to delete additional fields
      29. Retry Pause – Retry API connection every X times, pausing Y seconds between each API try, with and API timeout of Z seconds (Retries,Pause,Timeout) (optional)
      30. Order – Order of the job template in the Activate New Connection dialog (required)
    3. Click the Create button when finished to create the inbound job template. You will be redirected back to the Inbound Job Templates tab. Click the Close button to cancel the operation.
      1. The new inbound job template function is only available to users in the Administrator security group
    4. Override ETL error settings by selecting a job template (row) and clicking the Job Template Error Settings button on the toolbar
  8. Define the outbound job fields for the new connector on the Outbound Job Fields tab
    1. Select a job field (row) to edit
    2. Click the Edit Job Field button on the toolbar to bring up the Edit Job Field dialog

      1. The edit button is grayed out unless a job field (row) is selected

      2. The edit function is only available to users in the Administrator security group
    3. Update the properties of the job field

      1. Enabled – Choose if the field is enabled (required)
        1. The following outbound job fields are enabled by default and cannot be disabled: Order, Outbound Fields List, Return Data Fields List, Data Sending Method, Enabled, Job Description.
      2. Field Name – Name of the field (required)
      3. Field Type – Type of the field (required)
      4. Field Label – Label of the field (required)
      5. Placeholder – Placeholder of the field (optional)
      6. Tooltip – Tooltip of the field (optional)
      7. JSON Input Data – JSON input data of the field (optional)
      8. Minimum Length – Minimum length (number of characters) of the field (optional)
      9. Maximum Length – Maximum length (number of characters) of the field (optional)
      10. Default Value – Default value of the field (optional)
      11. RegEx Pattern – Regular expression pattern to validate input values of the field (optional)
      12. RegEx Message – Message to display for input values that do not match the regular expression pattern (optional)
      13. Order – Order of the field in the New Outbound Job and Edit Outbound Job dialogs (optional)
      14. Required – Choose if the field is required (required)
    4. Click the Update button when finished to update the outbound job field. You will be redirected back to the Outbound Job Fields tab. Click the Close button to cancel the operation.
  9. Create outbound job templates for the new connector on the Outbound Job Templates tab

    1. Click the New Outbound Job Template button to bring up the New Job Template dialog
    2. Enter the properties of the new job template (available job template fields differ by connector)

      1. Populate Job Record – Choose how to populate the job (required)
        1. Clear Job Record – Start with an empty record
        2. Use Template – Start with a template job
      2. Job Description – Description of the job template (required)
      3. Enabled – Choose if the job template is enabled (required)
      4. Log Raw API Calls – Choose if raw API calls are logged (required)
      5. Method Type – Method type of the job template (GET, POST, PUT, PATCH, DELETE) (optional)
      6. Data Sending Method – Data sending method of the job template (JSON Encoded Data, Form Data) (required)
      7. API End Point – API end point of the job template (optional)
      8. API Data Parameters – API data parameters of the job template (optional)
        1. Enter Key and Value and select Type (String, Numeric, Boolean) for each API data parameter
        2. Check Body if the API data parameter is passed through the body rather than the URI (Uniform Resource Identifier)
        3. Check Header if the API data parameter is passed through the header rather than the URI (Uniform Resource Identifier)
        4. Click the Add button to add API data parameters
        5. Click the Delete button to delete API data parameters
      9. Body Data Sending Method – Method for sending the body data of the job template (JSON Encoded Data, Form Data) (required)
      10. Return Data Fields List – Return data fields of the job template (required)
        1. Enter Label and Data Object pair for each return data field
        2. Click the Add button to add return data fields
        3. Click the Delete button to delete return data fields
      11. Outbound Fields List – Outbound fields of the job template (required)
        1. Enter Label and Name and select Type (String, Numeric, Boolean) for each outbound field (required)
        2. Check Required if the outbound field is required (required)
        3. Check URI if the outbound field is passed through the URI (Uniform Resource Identifier) rather than the data packet (optional)
        4. Enter Pattern for each outbound field (optional)
        5. Click the Add button to add outbound fields
        6. Click the Delete button to delete outbound fields
      12. Ignore Empty Outbound Fields – Choose if empty outbound fields are ignored (optional)
      13. Raw JSON Outbound Template – JSON outbound template to send. This replaces any automated structures defined in the outbound fields. (optional)
      14. Order – Order of the job template in the Activate New Connection dialog (required)
    3. Click the Create button when finished to create the outbound job template. You will be redirected back to the Outbound Job Templates tab. Click the Close button to cancel the operation.
      1. The new outbound job template function is only available to users in the Administrator security group
    4. Override ETL error settings by selecting a job template (row) and clicking the Job Template Error Settings button on the toolbar
  10. Click the Close button on the Connector Properties tab when finished to exit the wizard. You will be redirected back to the Connector Library page.
Tags: