Job Workflow Tasks

Job tasks are used to create, update, and delete Jobs.

Create Job

task: "Job/Create@1"
name: createJob
inputs: 
  values:
    customValues: "{{ customValues }}"
    customerId: "{{ customerId }}"
    description: "{{ description }}"
    divisionId: "{{ divisionId }}"
    employeeId: "{{ employeeId }}"
    jobNumber: "{{ jobNumber }}"
    jobStatusId: "{{ jobStatusId }}"
outputs:
  - name: job
    mapping: "job"

Get Job

task: "Job/Get@1"
name: getJob
inputs: 
  jobId: "00000000-0000-0000-0000-000000000000"

outputs:
  - name: job
    mapping: "job"

Update Job

task: "Job/Update@1"
name: updateJob
inputs: 
  jobId: "00000000-0000-0000-0000-000000000000"
  values: 
    customValues: "{{ customValues }}"
    customerId: "{{ customerId }}"
    description: "{{ description }}"
    divisionId: "{{ divisionId }}"
    employeeId: "{{ employeeId }}"
    jobNumber: "{{ jobNumber }}"
    jobStatusId: "{{ jobStatusId }}"

Delete Job

task: "Job/Delete@1"
name: deleteJob
inputs: 
  jobId: "00000000-0000-0000-0000-000000000000"

Assign Job

task: "Job/Assign@1"
name: assignJob
inputs: 
  jobId: "00000000-0000-0000-0000-000000000000" # job id to assign 
  orderIds: # list of order ids to assign to job
    - 1
    - 2
  commodityIds: # list of commodity ids to assign to job
    - 1
    - 2
  accountingTransactionIds: # list of accounting transaction ids to assign to job
    - 1
    - 2

Example Job Workflow

workflow:
  name: "Job / Create Job Example Workflow" 
  description: "Create Job Example Workflow"
  version: "1.0" 
  executionMode: "Sync"

inputs:
  - name: "customValues"
    type: "string,string"
    displayName: "Custom values"
    description: "Custom values"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.customValues"
  - name: "customerId"
    type: "Contact"
    displayName: "Customer id"
    description: "Customer id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.customerId"
  - name: "description"
    type: "string"
    displayName: "Description"
    description: "Description"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.description"
  - name: "divisionId"
    type: "Division"
    displayName: "Division id"
    description: "Division id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.divisionId"
  - name: "employeeId"
    type: "Contact"
    displayName: "Employee id"
    description: "Employee id"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.employeeId"
  - name: "jobNumber"
    type: "string"
    displayName: "Job number"
    description: "Job number"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.jobNumber"
  - name: "jobStatusId"
    type: "JobStatus"
    displayName: "Job status id"
    description: "Job status id"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "job.jobStatusId"

outputs:
  - name: job
    mapping: "createJobActivity.createJob.job"

activities:
  - name: "createJobActivity"
    description: "Create Job"
    steps:
      - task: "Job/Create@1"
        name: createJob
        inputs: 
          job:
            customValues: "{{ customValues }}"
            customerId: "{{ customerId }}"
            description: "{{ description }}"
            divisionId: "{{ divisionId }}"
            employeeId: "{{ employeeId }}"
            jobNumber: "{{ jobNumber }}"
            jobStatusId: "{{ jobStatusId }}"
        outputs:
          - name: job
            mapping: "job"
  - name: "getJobActivity"
    description: "Get Job"
    steps:
      - task: "Job/Get@1"
        name: getJob
        inputs: 
          jobId: "{{ createJobActivity.createJob.job.jobId }}"
        outputs:
          - name: jobFromGet
            mapping: "job"
  - name: "updateJobActivity"
    description: "Update Job"
    steps:
      - task: "Job/Update@1"
        name: updateJob
        inputs: 
          jobId: "{{ getJobActivity.getJob.job.jobId }}"
          job:
            customValues: "{{ customValues }}"
            customerId: "{{ customerId }}"
            description: "{{ description }}"
            divisionId: "{{ divisionId }}"
            employeeId: "{{ employeeId }}"
            jobNumber: "{{ jobNumber }}"
            jobStatusId: "{{ jobStatusId }}"
  - name: "deleteJobActivity"
    description: "Delete Job"
    steps:
      - task: "Job/Delete@1"
        name: deleteJob
        inputs: 
          jobId: "{{ getJobActivity.getJob.job.jobId }}"