Search Knowledge Base by Keyword

Edit Inbound Job Template

< Back

From the Inbound Job Templates tab, you can edit inbound job templates. To edit:

  1. Select a job templates (row) to edit
  2. Click the Edit Job Template button on the toolbar to bring up the Edit Job Template dialog

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

    2. The edit function is only available to users in the Administrator security group
  3. Update the properties of the job templates (available job template fields differ by connector)

    1. Job Description – Description of the job template (required)
    2. Job Schedule – 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
    3. Enabled – Choose if the job template is enabled (required)
    4. Log Raw API Calls – Choose if raw API calls are logged (required)
    5. Allow Empty Table  – Choose if an empty table is allowed (required)
    6. Destination Table – Name of the destination table (e.g., my_table_cm_computer) (required)
    7. Data Identity – Identity of the data for dashboards (e.g., cm_computer) (optional)
      1. AD – Identity data to query from a table
    8. CSV/JSON/XML File or Path – CSV/JSON/XML file or path (optional)
    9. 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)
    10. Data Selection – Connector specific data selection command of the job template (optional)
    11. Fields to Index – Fields to index (optional)
    12. Request Sort By – Field to sort the job template by (databases only) (optional)
    13. Request Unique Key Field – Request unique key field of the job template (optional)
    14. Request Filter – Fields to filter from the job template (optional)
    15. Data Node – Data node of the job template (optional)
    16. Method Type – Method type of the job template (GET, POST, PUT, PATCH, DELETE) (required)
    17. API End Point – API end point of the job template (optional)
    18. API Data Parameters – API data parameters of the job template (optional)
      1. Enter Key and Value pair for each API data parameter
      2. Click the Add button to add API data parameters
      3. Click the Delete button to delete API query parameters
    19. Body Data Sending Method – Method for sending the body data of the job template (JSON Encoded Data, Form Data) (required)
    20. API Return Data Node – API return data node of the job template (optional)
    21. 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)
    22. Click Show Enumeration Fields to enter enumeration properties of the job template. Click Hide Enumeration Fields to hide enumeration fields.
      NOTE: Dual enumeration is supported.

      1. Enumeration Type – Enumeration type of the job template (API End Point, External Data, Other ETL Job) (optional)
        1. API End Point
          1. Enumeration Keys End Point – Enumeration keys end point of the job template (optional)
          2. Enumeration Node – Enumeration node of the job template (optional)
          3. Enumeration Key – Enumeration key of the job template (optional)
        2. External Data
          1. Enumeration Key – Enumeration key of the job template (optional)
        3. Other ETL Job
          1. Enumeration ETL Job – ETL job for the enumeration values of the job template (optional)
          2. Enumeration Key – Enumeration key of the job template (optional)
      2. Pause Enumeration – Pause enumeration every X calls for Y seconds (optional)
      3. Kill Enumeration on Error – Choose if enumeration is stopped on an error (optional)
    23. Order – Order of the job template in the Activate New Connection dialog (required)
  4. Click the Update button when finished to update the inbound job template. You will be redirected back to the Inbound Job Templates tab. Click the Close button to cancel the operation.