Search Knowledge Base by Keyword

Edit Outbound Job Template

< Back

From the Outbound Job Templates tab, you can edit outbound 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. Enabled – Choose if the job template is enabled (required)
    3. Log Raw API Calls – Choose if raw API calls are logged (required)
    4. Method Type – Method type of the job template (GET, POST, PUT, PATCH, DELETE) (optional)
    5. Data Sending Method – Data sending method of the job template (JSON Encoded Data, Form Data) (required)
    6. API End Point – API end point of the job template (optional)
    7. API Data Parameters – API data parameters of the job template (optional)
      1. Enter Label and Value pair 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. Click the Add button to add API data parameters
      4. Click the Delete button to delete API data parameters
    8. Body Data Sending Method – Method for sending the body data of the job template (JSON Encoded Data, Form Data) (required)
    9. 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 Return Data Fields List Field button to add return data fields
      3. Click the Delete button to delete return data fields
    10. 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 Outbound Fields List Field button to add outbound fields
      6. Click the Delete button to delete outbound fields
    11. Ignore Empty Outbound Fields – Choose if empty outbound fields are ignored (optional)
    12. Order – Order of the job template in the Activate New Connection dialog (required)
  4. Click the Update button when finished to update the outbound job template. You will be redirected back to the Outbound Job Templates tab. Click the Close button to cancel the operation.