Search Knowledge Base by Keyword

New Inbound Job

< Back

From the Inbound Jobs tab, you can create new inbound jobs. To create:

  1. Click the New Inbound Job button to bring up the New Inbound Job dialog
  2. Enter the properties of the new inbound job (available job 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
      3. Clone Job – Start with a clone from an existing job
    2. Job Description – Description of the job (required)
    3. Job Schedule – Choose the frequency the job 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 job is active (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 (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 (optional)
    17. Request Sort By Field – Field to sort the job by (databases only) (optional)
    18. Request Limit – Request limit of the job (optional)
    19. Method Type – Method type of the job (GET, POST, PUT, PATCH, DELETE) (required)
    20. API End Point – API end point of the job (optional)
    21. API Data Parameters – API data parameters of the job (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 (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 (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. Click Hide Pagination Fields to hide pagination fields.
      1. Pagination Type – Paging type of the job (Records, Pages, Next Record Node, Next Page Node) (optional)
      2. API Pagination Node – API pagination node of the job (Next Page, Next Node) (optional)
      3. Pagination Offset Start – Request paging offset start or data node of the job (optional)
      4. Pagination Limit – Request pagination limit of the job (optional)
      5. Pagination Termination Node – Pagination termination node of the job (optional)
      6. Maximum API Calls – Limit of API calls that can be made by the job to avoid an endless loop (optional)
    27. Click Show Enumeration Fields to enter enumeration properties of the job. Click Hide Enumeration Fields to hide enumeration fields.
      NOTE: Triple enumeration is supported.

      1. Enumeration 1 Type – Enumeration type of the job (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 (optional)
          2. Enumeration 1 Node – Enumeration node of the job (optional)
          3. Enumeration 1 Fields – Enumeration fields of the job (optional)
        2. Other ETL Job
          1. Enumeration 1 ETL Job – ETL job for the enumeration values of the job (optional)
          2. Enumeration 1 Fields – Enumeration fields of the job (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 (optional)
      2. Enumeration 2 Type – Enumeration type of the job (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 (optional)
          2. Enumeration 2 Node – Enumeration node of the job (optional)
          3. Enumeration 2 Fields – Enumeration fields of the job (optional)
        2. Other ETL Job
          1. Enumeration 2 ETL Job – ETL job for the enumeration values of the job (optional)
          2. Enumeration 2 Fields – Enumeration fields of the job (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 (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 (optional)
          2. Enumeration 3 Node – Enumeration node of the job (optional)
          3. Enumeration 3 Fields – Enumeration fields of the job (optional)
        2. Other ETL Job
          1. Enumeration 3 ETL Job – ETL job for the enumeration values of the job (optional)
          2. Enumeration 3 Fields – Enumeration fields of the job (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)
    30. Order – Choose the order the job will run at the designated frequency (required)
  3. Click the Create button when finished to create the inbound job. You will be redirected back to the Inbound Jobs tab. Click the Close button to cancel the operation.
    NOTE: New jobs inherit the configuration of the Inbound Job Templates or clone they are instantiated from.

    1. The new inbound job function is only available to users in the Administrator security group