Search Knowledge Base by Keyword

New Inbound Job Template

< Back

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

  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 – 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. Log Raw API Calls – Choose if raw API calls are logged (required)
    6. Allow Empty Table  – Choose if an empty table is allowed (required)
    7. Destination Table – Name of the destination table (e.g., my_table_cm_computer) (required)
    8. Data Identity – Identity of the data for dashboards (e.g., cm_computer) (optional)
      1. AD – Identity data to query from a table
    9. CSV/JSON/XML File or Path – CSV/JSON/XML file or path (optional)
    10. 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)
    11. Data Selection – Connector specific data selection command of the job template (optional)
    12. Fields to Index – Fields to index (optional)
    13. Data Node – Data node of the job template (optional)
    14. Method Type – Method type of the job template (GET, POST, PUT, PATCH, DELETE) (required)
    15. API End Point – API end point of the job template (optional)
    16. API Query Parameters – API query parameters of the job template (optional)
      1. Enter Key and Value pair for each API query parameter
      2. Click the Add API Query Parameters Field button to add API query parameters
      3. Click the Delete button to delete API query parameters
    17. API Return Data Node – API return data node of the job template (optional)
    18. Click View Pagination Fields to enter pagination properties of the job template
      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)
    19. Request Sort By Field – Field to sort the job template by (optional)
    20. Request Unique Key Field – Request unique key field of the job template (databases only) (optional)
    21. Request Limit – Request limit of the job template (optional)
    22. Request Filter – Fields to filter from the job template (optional)
    23. Pagination Termination Node – Pagination termination node of the job template (optional)
    24. Maximum API Calls – Limit of API calls that can be made by the job template to avoid an endless loop (optional)
    25. Click View Enumeration Fields to enter enumeration properties of the job template
      1. Enumeration Type – Enumeration type of the job template (API End Point, External Data, Other ETL Job) (optional)
      2. Enumeration Keys End Point – Enumeration keys end point of the job template (optional)
      3. Enumeration Node – Enumeration node of the job template (optional)
      4. Enumeration Key – Enumeration key of the job template (optional)
    26. 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