Item Toolbar Config

Config File

src/data/ItemToolbarConfig.json

Format

{
  "noForms": {
    "delete": string[],
    "confirm": string[]
  },
  "Button": [{
      "label": string,
      "icon": string,
      "iconColor": string,
      "activityName": string,
      "actsOnSelected": boolean,
      "hiddenWhen": string,
      "subButtons": [{
        "label": string,
        "icon": string,
        "activityName": string,
        "actsOnSelected": boolean
      }, {
        "label": string,
        "icon": string,
        "activityName": string,
        "actsOnSelected": boolean
      }]
    }, {
      "label": string,
      "icon": string,
      "iconColor": string,
      "activityName": string,
      "actsOnSelected": boolean,
      "runScript": boolean,
      "scriptName": string,
      "message": string,
      "hiddenWhen": string
    }]
}

NoForms

Field	Type	Meaning
`delete`	`string[]`	Activity names that will trigger the Delete Dialog
`confirm`	`string[]`	Activity names that will trigger the Confirm Dialog

Button

Field	Type	Meaning
`label`	`string`	Button's label
`icon`	`string`	Icon in the button using fontawesome. Please see fontawesome
`iconColor`	`string`	Color of button's icon
`activityName`	`string`	Assigned activity in the button
`actsOnSelected`	`boolean`
`hiddenWhen`	`string`	See hiddenWhen below
`runScript`	`boolen`	When true then a script will run when the button is clicked.
`scriptName`	`string`	The name of the script to run when runScript is true.
`message`	`string`
`subButtons`		Sub-buttons have same properties as the Button

hiddenWhen

This expression is evaluated during runtime. If the expression evaluates to true, the button is hidden, otherwise the button remains visible.

Available variables

Variable	Type	Meaning
`thiz`	ItemToolbarComponent	For example: `thiz.couldSetPasswordOf(thiz.selectedUuid, thiz)`
`thiz.showToolbarExport`	boolean	true for item-list and item-collection, false for item-details
`this`		For example: `this.tableNames.includes('Parts')`
`hasOutcome`	boolean	For example: `( (hasOutcome) && (outcomeData.Purchasing.State !== 'CLOSED') )`
`outcomeData`		For example: `outcomeData.Purchasing.State === 'CLOSED'`
`parentData`		For example: `(parentData && parentData.Employee && !(parentData.Employee.State === 'ACTIVE'))`
`jobActivityNameArray`		For example: `jobActivityNameArray.includes( 'StoreSolution' )`
`collectionMember`		For example: `collectionMember && Number(collectionMember.Quantity) > 0` or `collectionMember && collectionMember['Default Storage'] === 'Yes'`
`buttonFound`	boolean
`button`		For example: `button.activityName === 'UpdatePickList'`
`authService`		For example: `authService.userRolesMatchAnyOf('Admin','PurchasingAgent')`

Useful methods

Method	Meaning
`authService.userRolesMatchAnyOf('Admin','PurchasingAgent')`
`thiz.dataStorage.peek('purchasing_isOneApproved')`

Example

{
  "noForms": {
    "delete": ["Deactivate", "RemoveMember", "RemoveEvent", "RemoveAddress", "RemovePurchaseOrderRow"],
    "confirm": ["CUTTING LIST", "BOM", "ASSEMBLY BOARD DRAWING", "SPLICE DRAWINGS", "WorkOrderParts_Finalize"]
  },
 "Button": [{
      "label": "Timekeeping",
            "icon": "fa-clock",
      "iconColor": "icon-black button-group-right ",
      "activityName": "New",
      "actsOnSelected": false,
      "hiddenWhen": "jobActivityNameArray.includes( 'DONE' ) || jobActivityNameArray.includes( 'Finalize' ) || jobActivityNameArray.includes( 'WorkOrderParts_Finalize' ) || (outcomeData.WorkOrder.State === 'DEACTIVATED')",
      "subButtons": [{
        "label": "Start Time",
        "icon": "fa fa-play icon-green",
        "activityName": "WorkOrder_StartTimeEmployee",
        "actsOnSelected": true
      }, {
        "label": "End Time",
        "icon": "fa fa-square icon-red",
        "activityName": "WorkOrder_EndTimeEmployee",
        "actsOnSelected": true
      }]
    }, {
      "label": "Print Non-Prod WO",
      "icon": "fa-print",
      "iconColor": "icon-black split-button-div button-group-right",
      "activityName": "NonProdWorkOrder_Print",
      "actsOnSelected": false,
      "runScript": true,
      "scriptName": "NonProdWorkOrder_Print",
      "message": "Printing Non-Productive WorkOrders...",
      "hiddenWhen": "!superUsers.includes(loggedInUser) || jobActivityNameArray.length !== 0"
    }]  
}