Order document Workflow Tasks

Order document tasks are used to create, update, and delete Order documents.

Create Order document

Inputs:

• orderId - Order id
• metadata - Metadata
• documentTemplateName - Document template name (optional if documentTemplateId is specified)
• documentTemplateId - Document template id (optional if documentTemplateName is specified)
• regenerateOnOrderChange - Regenerate on order change (default: false)
• updateIfAlreadyExists - Update document if already exists (default: false)

task: "OrderDocument/Create@1"
name: createOrderDocument
inputs: 
  document:
    orderId: "{{ orderId }}" 
    metadata: "{{ metadata }}" # optional
    documentTemplateName: "{{ DocumentTemplateName }}" # or documentTemplateId
    documentTemplateId: "{{ documentTemplateId }}" # or documentTemplateName
    regenerateOnOrderChange: "{{ regenerateOnOrderChange }}"
    updateIfAlreadyExists: "{{ updateIfAlreadyExists }}"
outputs:
  - name: orderDocument
    mapping: "orderDocument"

Get Order document

task: "OrderDocument/Get@1"
name: getOrderDocument
inputs: 
  orderDocumentId: "123"

outputs:
  - name: orderDocument
    mapping: "orderDocument"

Update Order document

task: "OrderDocument/Update@1"
name: updateOrderDocument
document: 
  orderDocumentId: "123"
  document:
    metadata: "{{ metadata }}"
    regenerateOnOrderChange: "{{ regenerateOnOrderChange }}"

Delete Order document

task: "OrderDocument/Delete@1"
name: deleteOrderDocument
inputs:
  orderDocumentId: "123"

Example Order document Workflow

workflow:
  name: "Order document / Create OrderDocument Example Workflow" 
  description: "Create Order document Example Workflow"
  version: "1.0" 
  executionMode: "Sync"

inputs:
  - name: "orderId"
    type: "Order"
    displayName: "Order id"
    description: "Order id"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "orderDocument.orderId"
  - name: "documentTemplateId"
    type: "DocumentTemplate"
    displayName: "Document template id"
    description: "Document template id"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "orderDocument.documentTemplateId"
  - name: "lastGeneratedFile"
    type: "string"
    displayName: "Last generated file"
    description: "Last generated file"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "orderDocument.lastGeneratedFile"
  - name: "lastGeneratedTime"
    type: "Date"
    displayName: "Last generated time"
    description: "Last generated time"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "orderDocument.lastGeneratedTime"
  - name: "metadata"
    type: "string,Object"
    displayName: "Metadata"
    description: "Metadata"
    multiple: false
    required: false
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "orderDocument.metadata"
  - name: "regenerateOnOrderChange"
    type: "boolean"
    displayName: "Regenerate on order change"
    description: "Regenerate on order change"
    multiple: false
    required: true
    defaultValue: ""
    additionalProperties:
      visible: true
      mapping: "orderDocument.regenerateOnOrderChange"

outputs:
  - name: orderDocument
    mapping: "createOrderDocumentActivity.createOrderDocument.orderDocument"

activities:
  - name: "createOrderDocumentActivity"
    description: "Create Order document"
    steps:
      - task: "OrderDocument/Create@1"
        name: createOrderDocument
        inputs: 
          orderDocument:
            orderId: "{{ orderId }}"
            documentTemplateId: "{{ documentTemplateId }}"
            lastGeneratedFile: "{{ lastGeneratedFile }}"
            lastGeneratedTime: "{{ lastGeneratedTime }}"
            metadata: "{{ metadata }}"
            regenerateOnOrderChange: "{{ regenerateOnOrderChange }}"
        outputs:
          - name: orderDocument
            mapping: "orderDocument"
  - name: "getOrderDocumentActivity"
    description: "Get OrderDocument"
    steps:
      - task: "OrderDocument/Get@1"
        name: getOrderDocument
        inputs: 
          orderDocumentId: "{{ createOrderDocumentActivity.createOrderDocument.orderDocument.orderDocumentId }}"
        outputs:
          - name: orderDocumentFromGet
            mapping: "orderDocument"
  - name: "updateOrderDocumentActivity"
    description: "Update OrderDocument"
    steps:
      - task: "OrderDocument/Update@1"
        name: updateOrderDocument
        inputs: 
          orderId: "{{ getOrderDocumentActivity.getOrderDocument.orderDocument.orderId }}"
          orderDocumentId: "{{ getOrderDocumentActivity.getOrderDocument.orderDocument.orderDocumentId }}"
          orderDocument:
            documentTemplateId: "{{ documentTemplateId }}"
            lastGeneratedFile: "{{ lastGeneratedFile }}"
            lastGeneratedTime: "{{ lastGeneratedTime }}"
            metadata: "{{ metadata }}"
            regenerateOnOrderChange: "{{ regenerateOnOrderChange }}"
  - name: "deleteOrderDocumentActivity"
    description: "Delete OrderDocument"
    steps:
      - task: "OrderDocument/Delete@1"
        name: deleteOrderDocument
        inputs: 
          orderId: "{{ getOrderDocumentActivity.getOrderDocument.orderDocument.orderId }}"
          orderDocumentId: "{{ getOrderDocumentActivity.getOrderDocument.orderDocument.orderDocumentId }}"