Search Knowledge Base by Keyword

Inbound Job Templates

< Back

The Inbound Job Templates tab provides the ability to manage inbound job templates.

Available operations:

  • Create new inbound job templates by clicking on the New Inbound Job Template button
  • View inbound job templates associated with the connector
    • Columns available (available job template fields differ by connector)
      • Id (hidden by default) – System Id of the job template
      • Connector (hidden by default) – Connector of the job template
      • Job Description – Description of the job template
      • Job Schedule – Frequency the job template will run (Hourly, Daily, Weekly, Every 5 Minutes, Every 15 Minutes, Every 30 Minutes, Custom)
      • Status – Whether the job template is enabled or disabled
        NOTE: Disabling job templates is recommended.
      • Use Unparsed Data – Whether incoming data is parsed or left in its raw format
      • Log Raw API Calls – Whether raw API calls are logged
      • Allow Empty Table – Whether an empty table is allowed (Yes, No)
      • Destination Table – Name of the destination table (e.g., my_table_cm_computer)
      • Data Identity – Identity of the data for dashboards (e.g., cm_computer)
      • XML Envelope Payload – XML envelope payload of the SOAP call
      • Data Selection (hidden by default) – Connector specific data selection command of the job template
      • CSV/JSON/XML File or Path (hidden by default) – CSV/JSON/XML file or path
      • Append Files to Same Destination Table – Whether multiple files in the same path will append to the same destination table, or will create a new destination table for each file
      • Append New Data to Existing Tables – Whether new data will append to the same destination table, or will create a new destination table
      • Fields to Index (hidden by default) – Fields to index
      • Request Unique Key Field – Request unique key field of the job template
      • Request Sort By Field (hidden by default) – Field to sort the job template by (databases only)
      • Request Limit – Request limit of the job template
      • Method Type – Method type of the job template (GET, POST, PUT, PATCH, DELETE)
      • API End Point – API end point of the job template
      • API Data Parameters (hidden by default) – API data parameters of the job template
      • Body Data Sending Method – Method for sending the body data of the job template (JSON Encoded Data, Form Data)
      • Raw JSON Body Data – Raw JSON body to send. Do not use body selections in the API Parameters if this is used.
      • API Return Data Node – API return data node of the job template
      • Ignore XML Attributes – Whether field attributes are ignored and not included in the data when parsing XML
      • Pagination Type – Paging type of the job template (Records, Pages, Next Record Node, Next Page Node)
      • API Pagination Node – API pagination node of the job template (Next Page, Next Node)
      • Pagination Offset Start – Request paging offset start or data node of the job template
      • Pagination Limit – Request pagination limit of the job template
      • Pagination Termination Node – Pagination termination node of the job template
      • Maximum API Calls – Limit of API calls that can be made by the job template to avoid an endless loop
      • Enumeration 1 Type – Enumeration type of the job template (API End Point, Other ETL Job, Data Type, External Data)
      • Enumeration 1 ETL Job – ETL job for the enumeration values of the job template
      • Enumeration 1 Data Type – Data type and fields of the enumeration values
      • Enumeration 1 Keys End Point (hidden by default) – Enumeration keys end point of the job template
      • Enumeration 1 Node – Enumeration node of the job template
      • Enumeration 1 Fields (hidden by default) – Enumeration fields of the job template
      • Enumeration 2 Type – Enumeration type of the job template (API End Point, Other ETL Job, Data Type)
      • Enumeration 2 ETL Job – ETL job for the enumeration values of the job template
      • Enumeration 2 Data Type – Data type and fields of the enumeration values
      • Enumeration 2 Keys End Point (hidden by default) – Enumeration keys end point of the job template
      • Enumeration 2 Node – Enumeration node of the job template
      • Enumeration 2 Fields (hidden by default) – Enumeration fields of the job template
      • Enumeration 3 Type – Enumeration type of the job template (API End Point, Other ETL Job, Data Type)
      • Enumeration 3 ETL Job – ETL job for the enumeration values of the job template
      • Enumeration 3 Data Type – Data type and fields of the enumeration values
      • Enumeration 3 Keys End Point (hidden by default) – Enumeration keys end point of the job template
      • Enumeration 3 Node – Enumeration node of the job template
      • Enumeration 3 Fields (hidden by default) – Enumeration fields of the job template
      • Pause Enumeration (hidden by default) – Pause enumeration every X calls for Y seconds
      • Kill Enumeration on Error – Whether enumeration is stopped on an error
      • Additional Fields (hidden by default) – Additional fields to add to the staging data when the jobs run
      • 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)
      • Order – Order of the job template in the Activate New Connection dialog
      • Job Schedule Id (hidden by default) – System Id of the job schedule
      • Override Settings – Error settings that have been overridden
  • Override ETL error settings by selecting a job template (row) and clicking the Job Template Error Settings button on the toolbar
  • Edit inbound job templates by selecting a job template (row) and clicking the Edit Job Template button on the toolbar
  • Delete inbound job templates by selecting a job template (row) and clicking the Delete Job Template button on the toolbar
  • You can also change the number of visible rows in the table, set column visibility, refresh the table, and search for text