Search Knowledge Base by Keyword

Edit Outbound Job

< Back

From the Outbound Jobs tab, you can edit outbound jobs.  To edit:

  1. Select an outbound job (row) to edit
  2. Click the Edit Job button on the toolbar to bring up the Edit Outbound Job dialog

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

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

    1. Job Description – Description of the job (required)
    2. Enabled – Choose if the job is enabled (required)
    3. Log Raw API Calls – Choose if raw API calls are logged (required)
    4. Method Type – Method type of the job (GET, POST, PUT, PATCH, DELETE) (optional)
    5. Data Sending Method – Data sending method of the job (JSON Encoded Data, Form Data) (required)
    6. API End Point – API end point of the job (optional)
    7. API Query Parameters – API query parameters of the job (optional)
      1. Enter Label 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
    8. Return Data Fields List – Return data fields of the job (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
    9. Outbound Fields List – Outbound fields of the job (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
    10. Ignore Empty Outbound Fields – Choose if empty outbound fields are ignored (optional)
    11. Order – Choose the order the job will run at the designated frequency (required)
  4. Click the Update button when finished to update the outbound job. Click the Close button to cancel the operation.