FactoryFour Learn Center Index

Last updated March 30, 2020


How to Format Work Instructions

Add rich-text Work Instructions to tasks in the task configuration panel


Bring your contributors’ attention to task-specific instructions without making them flip through packets of documents unrelated to the task at-hand.

At a Glance:

  • Admins configure task-specific work instructions using a rich text editor in the workflow editor
  • When work instructions are configured for a task it is the default tab users see when opening the task panel
  • Checkboxes added to work instructions are enforced in order for a user to complete the task
  • Reference task and order data like datapoints, tags, and dates in context with the rest of the work instructions

Keep in mind, this is an alpha release with more editing features (including a formatting toolbar!) coming soon. In the meantime, all existing functionality is available using the following formatting notation.

Best Practice: Write all content before adding formatting

Text Formatting Notation

# Header 1

## Sub-header 2

### Sub-header 3

**Bold**

_Italicize_

~Strike~

`Pre-formatted text`

[text](link)

Unordered List:

- Do this

  • To get this
  • …and this

Ordered List:

  1. Do this

  2. To get this
  3. …and this

Checkboxes:

- [ ] One to-do item

- [ ] Another to-do item

Checkbox Notes: 1) When adding a checkbox a bullet point will appear after the first space, and 2) a space is required between the brackets

Click the (+) Add Image button to attach an image


Data Reference Templates

Reference contextual data from the order or task using jexl (Javascript Expression Language) notation of {{jexl-formatted-template}} jexl documentation. This contextual data can be presented with any formatting, but FactoryFour recommends using pre-formatted text or bold formatting as a standard to emphasize the value is variable. The full context of the task is available to the work instructions, but some of the most common templates are listed below:

  • Order Tags: {{order.tags[.key=='Tag Group Name w Spaces'].values}}
  • Task Tags: {{tags[.key=='Tag Group Name w Spaces'].values}}
  • Datapoint: {{datapoints[.type== 'datapoint_key_with_underscores'].value}}
  • Due Date: {{order.dates.due}}
  • Requested Date: {{order.dates.needed}}
  • Submission Date: {{order.dates.submitted}}
  • Expected Task Duration: {{task.duration}}
  • Last Status Change Timestamp: {{task.lastStatusChange}}
  • Timestamp when dependencies were met: {{task.timeLeftStandby}}

Task Context Available

{
  task(id) {
    id
    name
    code
    key
    dependsOn
    status
    workflowParent
    currentMembers
    workflowMember
    workflowMemberObj {
      id
      name
      parent
      parentDatapoints {
        type
        content
      }
      dates {
        timestamp
        code
        title
      }
    }
    assetConfiguration
    workflowInitiator
    workflowInitiatorObj {
      id
      name
      baseCode
      metadata
    }
    order: parentObject {
      ... on order {
        userDefinedIdentifier
        dates {
          needed
          due
          submitted
        }
        tags {
          key
          values
        }
        datapoints {
          type
          value
          content
        }
      }
    }
    parent
    type
    format
    active {
      user
      timestamp
    }
    allocated
    allocations {
      day
      duration
      assigned
    }
    documentData
    duration
    lastStatusChange
    tags {
      key
      values
    }
    position {
      x
      y
    }
    timeLeftStandby
    activeTime {
      userSessions {
        user
        time
      }
    }
  }
}

Search the FactoryFour Learn Center


FactoryFour Learn Center