Skip to content

Tracker options

Tracker options are configured in the $options property.

Config object

Option properties

  • blocks: default set of blocks for new dispatches created with this tracker
  • body: none | require | optional
  • trackers: list of tracker handles
  • swimlanes: list of swimlane handles
  • security:
    • setting: disabled | public | org | private | admin
    • min: min level
    • max: max level
  • trackerSelection: linked | all | none
  • swimlaneSelection: linked | all | none | selected
  • swimlaneApply: swimlane handle if swimlane is selected
  • sharePost: yes | no
  • dateConfig: date | date-time | readonly | date-time-active | choice | none
  • dateConfigDetail: List of strings taking the form of "+/-N " where measure is d, w or m for day, week and month
  • requireResponse: hide | available | enabled | dropdown
  • requireResponseApply: response if enabled
  • requireResponseTracker: tracker handle if response is set
  • toolar: show | media |hide
  • userQuery: valid user query
  • userDirectory: hide | available | enabled | dropdown | rule | rule-enabled
  • userDirectoryRule: rule for showing the user directory for rule-enabled
  • showHeader: true | false
  • showChangeBlock: true | false
  • validationRule: rule to enable the Submit button; true result enables
  • fetchData: fetch the user attribute document
  • edit:
    • user: true | false
    • author: true | false
  • participants:
    • setting: hide | available | rule
    • rule: if true then make available
    • query:
  • manageParticipants: [Objects]
    • setting: "hide" | "available" | "rule" | "author". By default it's "hide".
    • rule: provide a rule for allow editing or not.
  • linkedDispatch:
    • action: hide | open | edit
    • message: text to display (optional)
  • displayLayout:
    • id: id for the layout or JSON path query from values
    • condition: rule for determining when to show
  • entryLayout:
    • id: id for the layout or JSON path query from values
    • condition: rule for determining when to show
  • welcomeLayout:
    • id: id for the layout or JSON path query from values
    • condition: rule for determining when to show
  • rewardLayout:
    • id: id for the layout or JSON path query from values
    • condition: rule for determining when to show
  • emptyValues: hide | show
  • dispatchOpen
    • date: hide | show
    • menu: hide | show | admin
  • dispatchEdit
    • date: hide | show
    • menu: hide | show | admin
  • notification:
    • create: [Object] notification configuration for dispatches creation
    • send: "all" | "none" | "some"
    • messageOveride: "yes" | "no"
    • edit: [Object] notification configuration for dispatches editing
    • send: "all" | "none" | "some"
    • messageOveride: "yes" | "no"

Example

Below configuration is used in tracker configuration as attribute.

{
  "$options": {
    "showTitle": "yes",
    "trackerSelection": "locked",
    "trackers": [],
    "userDirectory": "hide",
    "requireResponse": "hide",
    "swimlaneSelection": "locked",
    "body": "none",
    "toolbar": "hide",
    "participants": {
      "setting": "available"
    },
    "manageParticipants": {
      "setting": "author",
      "rule": ""
    }
  }
}

Example of notification configuration with tracker

{
  "$options": {
    "userDirectory": "hide",
    "requireResponse": "available",
    "showSocial": false,
    "toolbar": "hide",
    "edit": {
      "author": true
    },
    "notification": {
      "create": {
        "send": "none",
        "messageOverride": "yes"
      },
      "edit": {
        "send": "some",
        "messageOverride": "yes"
      }
    }
  }
}