---
title: "Work Order Items"
canonical: "https://help.fieldbuddy.com/space/FBDOCS/5377196080/Work%20Order%20Items"
format: markdown
---
> ℹ️ For generic information about Work Order Items, please visit [this page](https://help.fieldbuddy.com/space/FBDOCS/6025478145/Work+Order+Items+tab).
**Work Order Item (WOI) **represents a template that can be used to create a **Work Order ****Line**** Item (WOLI)**. **Work Order Line Item (WOLI)** has a link to a **Work Order (WO)**, **Installed Product (IP)** and **Work Order Item (WOI)**.
In FieldBuddy Swift, the records are all stored and accessed separately.
## Sample Structure
**WorkOrderItems** describes layout for adding of WOLI (Parts, Activities and Other expenses)
Check screenshots below:
---
Below is sample structure for the screen. Basically it consists of following elements
- `header` - label shown on top of the screen when corresponding Type is added. It is also possible to pre-define default search text there.
- `dataBinding` - default entity binding for API names. System property, should not be changed
- `dataText` -default text binding for API names. System property, should not be changed
- `events` - what should happen if record is selected or on going back (describes to which screens to navigate). Do not change it
- `params`- describes information about API object entities. Should not be changed
- `templateItem` - describes information about layout for each type of Work Order Line Item.
- `onlineSearchResults` - information for online search for WOI. It contains all the fields requested and limit of records to be found online
In most cases, only `header`, `templateItem` or `onlineSearchResults` should be changed.
Below is more information about it
### header
`title` - labels for top of the screen per WOLI type
`searchText` - default of search text per WOLI type
```
"header": {
"title": {
"Activity": "${Label.AddActivities}",
"Other expense": "${Label.AddOtherExpenses}",
"Part": "${Label.AddParts}"
},
"searchText": {
"Activity": "",
"Other expense": "",
"Part": ""
}
}
```
### templateItem
Has following format:
```
"templateItem": {
"Activity": {
"config": {
...
}
"type": "FWorkOrderItem"
},
"Other expense": {
"config": {
...
}
"type": "FWorkOrderItem"
},
"Part": {
"config": {
...
}
"type": "FWorkOrderItem"
}
}
```
### FWorkOrderItem properties
> ⚠️ Greyed properties should not be be changed!
| **Property** | **Description** | **Example value** |
| --- | --- | --- |
| `dataBinding` | describe API field names that can be used below
More information here - [https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/3107914425](https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/3107914425) | `"field": "FIELDBUDDY__Installed_Product__c"` |
| `dataText` | Object, describes properties shown for each row
support when adding a new item from **dataBinding**
For example, **Name / Code / Price**
 | ```
"dataText": {
"Id": "ID",
"Title": "NAME",
"Body": "CODE",
"Footer": "PRICE",
"Quantity": "QTY"
},
``` |
| `increment` | API of field names used for Increment. Should not be changed | ```
"increment": {
"table": "FIELDBUDDY__Work_Order_Item__c",
"field": "FIELDBUDDY__Increment__c"
}
``` |
| `searchText` | Determines which properties from **DataBinding** are used in local/offline Search | ```
"searchText": [
"NAME",
"CODE"
]
``` |
| `events` | Describe configuration and layout of creation of Work Order Line Item
Contains [FProperties](https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/4350672933) for display type Details/Checklist, as well as default properties for regular actions
`onlineSearchResults` used to search related entities | |
### onlineSearchResults
Contains `FOnlineSearchResults` information for online search for WOI. It contains all the fields requested and limit of records to be found online for search of work order items
| **Property** | **Description** | **Example value** |
| --- | --- | --- |
| `tableToSearch` | describe API field names that can be used below
More information here - [https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/3107914425](https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/3107914425) | `"tableToSearch": "FIELDBUDDY__Work_Order_Item__c",` |
| `fieldsToFilter` | Fields that should be used for search of online items | ```
"fieldsToFilter": [
"Name",
"FIELDBUDDY__Item_Code__c"
],
``` |
| `where` | Condition, should not be changed | ```
"where": {
"fieldName": "FIELDBUDDY__Type__c",
"operator": "=",
"searchValue": "${templateType}"
},
``` |
| `fieldsToRequest` | Returned fields | ```
"fieldsToRequest": [
"Id",
"Name"
],
``` |
| `limitOfRecords` | Amount of records returned for search, we advice 50 for performance reasons | |
| `skipRecordsFromBriefcase` | Should be true, | |
Below is the sample screen configuration
Config structure
```json
{
"config": {
"header": {
"title": {
"Activity": "${Label.AddActivities}",
"Other expense": "${Label.AddOtherExpenses}",
"Part": "${Label.AddParts}"
},
"searchText": {
"Activity": "",
"Other expense": "",
"Part": ""
}
},
"dataBinding": [
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order__c",
"var": "NAME"
},
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order__c",
"var": "ID"
},
{
"field": "Id",
"table": "FIELDBUDDY__Installed_Product__c",
"var": "IP"
}
],
"dataText": {
"Id": "ID",
"Name": "NAME"
},
"events": [
{
"dataBinding": [
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order__c",
"var": "NAME"
},
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order__c",
"var": "ID"
}
],
"eventName": "onPress",
"target": "WorkOrderDetails",
"triggeredEvent": "navigate"
},
{
"dataBinding": [
{
"field": "Name",
"table": "FIELDBUDDY__Installed_Product__c",
"var": "NAME"
},
{
"field": "Id",
"table": "FIELDBUDDY__Installed_Product__c",
"var": "IP"
}
],
"eventName": "onPressMultiItems",
"target": "MultiItems",
"triggeredEvent": "navigate",
"screenTitle": "${Label.Unknown}"
},
{
"dataBinding": [
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order__c",
"var": "NAME"
},
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order__c",
"var": "ID"
},
{
"field": "Id",
"table": "FIELDBUDDY__Installed_Product__c",
"var": "IP_ID"
}
],
"eventName": "onGoBackCreation",
"target": "InstalledProductCreation",
"triggeredEvent": "navigate"
},
{
"dataBinding": [
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order__c",
"var": "NAME"
},
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order__c",
"var": "ID"
},
{
"field": "Id",
"table": "FIELDBUDDY__Installed_Product__c",
"var": "IP_ID"
}
],
"eventName": "onGoBackRelation",
"target": "InstalledProductRelation",
"triggeredEvent": "navigate"
}
],
"params": {
"parentTableName": "FIELDBUDDY__Work_Order__c",
"targetTableName": {
"Activity": "FIELDBUDDY__Work_Order_Line_Item__c",
"Other expense": "FIELDBUDDY__Work_Order_Line_Item__c",
"Part": "FIELDBUDDY__Work_Order_Line_Item__c"
},
"templateTable": "FIELDBUDDY__Work_Order_Item__c",
"templateTableTypeField": "FIELDBUDDY__Type__c"
},
"templateItem": {
"Activity": {
"config": {
"dataBinding": [
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "ID"
},
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "NAME"
},
{
"field": "FIELDBUDDY__Type__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "TYPE"
},
{
"field": "FIELDBUDDY__Item_Code__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "CODE"
},
{
"field": "FIELDBUDDY__Unit_Price_Including_Tax_input__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "PRICE"
},
{
"field": "FIELDBUDDY__Tax_Rate__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "VAT"
},
{
"field": "FIELDBUDDY__Display_Type__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "DT"
},
{
"field": "FIELDBUDDY__Quantity__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "QTY"
}
],
"dataText": {
"Id": "ID",
"Title": "NAME",
"Body": "CODE",
"Quantity": "QTY"
},
"increment": {
"table": "FIELDBUDDY__Work_Order_Item__c",
"field": "FIELDBUDDY__Increment__c"
},
"searchText": [
"NAME",
"CODE"
],
"events": [
{
"eventName": "onGoInsertPlus",
"triggeredEvent": "navigate",
"target": "InsertPlus",
"templateType": "Activity",
"targetParentTableName": "FIELDBUDDY__Work_Order_Line_Item__c",
"targetChildrenTableName": "FIELDBUDDY__Work_Order_Line_Item_Detail__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"screenTitle": "${FIELDBUDDY__Work_Order_Line_Item__c.plurallabel}",
"fieldsFilters": [
"Name",
"FIELDBUDDY__Quantity__c"
],
"typesFilters": [
"STRING",
"DOUBLE"
],
"propertiesLayout": {
"config": {
"saveAll": true,
"sections": [
{
"table": "FIELDBUDDY__Work_Order_Line_Item__c",
"headless": true,
"mapping": "FIELDBUDDY__Work_Order_Line_Item__c",
"title": "",
"iconName": "md-briefcase",
"iosIconName": "ios-briefcase",
"objects": [
{
"name": "FIELDBUDDY__Quantity__c"
},
{
"name": "Name"
},
{
"name": "FIELDBUDDY__Item_Code__c",
"barcodeEnabled": true
}
]
}
]
}
},
"onlineSearchResults": {
"config": {
"recipe": {
"tableToSearch": "FIELDBUDDY__Work_Order_Item_Detail__c",
"leftJoin": "Work_Order_Item__c",
"fieldsToRequest": [
"Id",
"Name",
"FIELDBUDDY__Field_Type__c",
"FIELDBUDDY__Default_Value__c",
"FIELDBUDDY__Work_Order_Item__c",
"FIELDBUDDY__Order__c",
"FIELDBUDDY__Page__c",
"FIELDBUDDY__Picklist_Values__c",
"FIELDBUDDY__Comments__c",
"FIELDBUDDY__Required__c",
"FIELDBUDDY__Help_Text__c",
"FIELDBUDDY__API_Name__c",
"FIELDBUDDY__Filter_Logic__c",
"FIELDBUDDY__Formula__c",
"FIELDBUDDY__Unit__c",
"FIELDBUDDY__Placeholder__c"
],
"limitOfRecords": 1000
}
},
"type": "FOnlineSearchResults"
}
}
]
},
"type": "FWorkOrderItem"
},
"Other expense": {
"config": {
"dataBinding": [
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "ID"
},
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "NAME"
},
{
"field": "FIELDBUDDY__Type__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "TYPE"
},
{
"field": "FIELDBUDDY__Item_Code__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "CODE"
},
{
"field": "FIELDBUDDY__Unit_Price_Including_Tax_input__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "PRICE"
},
{
"field": "FIELDBUDDY__Tax_Rate__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "VAT"
},
{
"field": "FIELDBUDDY__Display_Type__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "DT"
},
{
"field": "FIELDBUDDY__Quantity__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "QTY"
}
],
"increment": {
"table": "FIELDBUDDY__Work_Order_Item__c",
"field": "FIELDBUDDY__Increment__c"
},
"dataText": {
"Body": "CODE",
"Id": "ID",
"Title": "NAME",
"Footer": "PRICE",
"Quantity": "QTY"
},
"searchText": [
"NAME",
"CODE"
],
"events": [
{
"eventName": "onGoInsertPlus",
"triggeredEvent": "navigate",
"target": "InsertPlus",
"templateType": "OtherExpense",
"targetParentTableName": "FIELDBUDDY__Work_Order_Line_Item__c",
"targetChildrenTableName": "FIELDBUDDY__Work_Order_Line_Item_Detail__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"screenTitle": "${FIELDBUDDY__Work_Order_Line_Item__c.plurallabel}",
"fieldsFilters": [
"Name",
"FIELDBUDDY__Unit_Price_Including_Tax_input__c"
],
"typesFilters": [
"STRING",
"CURRENCY"
],
"propertiesLayout": {
"config": {
"saveAll": true,
"sections": [
{
"table": "FIELDBUDDY__Work_Order_Line_Item__c",
"headless": true,
"mapping": "FIELDBUDDY__Work_Order_Line_Item__c",
"title": "",
"iconName": "md-briefcase",
"iosIconName": "ios-briefcase",
"objects": [
{
"name": "FIELDBUDDY__Quantity__c"
},
{
"name": "Name"
},
{
"name": "FIELDBUDDY__Item_Code__c",
"barcodeEnabled": true
}
]
}
]
}
},
"onlineSearchResults": {
"config": {
"recipe": {
"tableToSearch": "FIELDBUDDY__Work_Order_Item_Detail__c",
"leftJoin": "Work_Order_Item__c",
"fieldsToRequest": [
"Id",
"Name",
"FIELDBUDDY__Field_Type__c",
"FIELDBUDDY__Default_Value__c",
"FIELDBUDDY__Work_Order_Item__c",
"FIELDBUDDY__Order__c",
"FIELDBUDDY__Page__c",
"FIELDBUDDY__Picklist_Values__c",
"FIELDBUDDY__Comments__c",
"FIELDBUDDY__Required__c",
"FIELDBUDDY__Help_Text__c",
"FIELDBUDDY__API_Name__c",
"FIELDBUDDY__Filter_Logic__c",
"FIELDBUDDY__Formula__c",
"FIELDBUDDY__Unit__c",
"FIELDBUDDY__Placeholder__c"
],
"limitOfRecords": 1000
}
},
"type": "FOnlineSearchResults"
}
}
]
},
"type": "FWorkOrderItem"
},
"Part": {
"config": {
"dataBinding": [
{
"field": "Id",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "ID"
},
{
"field": "Name",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "NAME"
},
{
"field": "FIELDBUDDY__Type__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "TYPE"
},
{
"field": "FIELDBUDDY__Item_Code__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "CODE"
},
{
"field": "FIELDBUDDY__Unit_Price_Including_Tax_input__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "PRICE"
},
{
"field": "FIELDBUDDY__Tax_Rate__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "VAT"
},
{
"field": "FIELDBUDDY__Display_Type__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "DT"
},
{
"field": "FIELDBUDDY__Quantity__c",
"table": "FIELDBUDDY__Work_Order_Item__c",
"var": "QTY"
}
],
"dataText": {
"Id": "ID",
"Title": "NAME",
"Body": "CODE PRICE"
},
"increment": {
"table": "FIELDBUDDY__Work_Order_Item__c",
"field": "FIELDBUDDY__Increment__c"
},
"searchText": [
"NAME",
"CODE"
],
"events": [
{
"eventName": "onGoInsertPlus",
"fieldsFilters": [
"Name",
"FIELDBUDDY__Unit_Price_Including_Tax_input__c"
],
"screenTitle": "${FIELDBUDDY__Work_Order_Line_Item__c.plurallabel}",
"table": "FIELDBUDDY__Work_Order_Item__c",
"target": "InsertPlus",
"targetChildrenTableName": "FIELDBUDDY__Work_Order_Line_Item_Detail__c",
"targetParentTableName": "FIELDBUDDY__Work_Order_Line_Item__c",
"templateType": "Part",
"triggeredEvent": "navigate",
"typesFilters": [
"STRING",
"CURRENCY"
],
"propertiesLayout": {
"config": {
"saveAll": true,
"sections": [
{
"table": "FIELDBUDDY__Work_Order_Line_Item__c",
"headless": true,
"mapping": "FIELDBUDDY__Work_Order_Line_Item__c",
"title": "",
"iconName": "md-briefcase",
"iosIconName": "ios-briefcase",
"objects": [
{
"name": "FIELDBUDDY__Quantity__c"
},
{
"name": "Name"
},
{
"name": "FIELDBUDDY__Item_Code__c",
"barcodeEnabled": true
}
]
}
]
}
},
"onlineSearchResults": {
"config": {
"recipe": {
"tableToSearch": "FIELDBUDDY__Work_Order_Item_Detail__c",
"leftJoin": "Work_Order_Item__c",
"fieldsToRequest": [
"Id",
"Name",
"FIELDBUDDY__Field_Type__c",
"FIELDBUDDY__Default_Value__c",
"FIELDBUDDY__Work_Order_Item__c",
"FIELDBUDDY__Order__c",
"FIELDBUDDY__Page__c",
"FIELDBUDDY__Picklist_Values__c",
"FIELDBUDDY__Comments__c",
"FIELDBUDDY__Required__c",
"FIELDBUDDY__Help_Text__c",
"FIELDBUDDY__API_Name__c",
"FIELDBUDDY__Filter_Logic__c",
"FIELDBUDDY__Formula__c",
"FIELDBUDDY__Unit__c",
"FIELDBUDDY__Placeholder__c"
],
"limitOfRecords": 1000
}
},
"type": "FOnlineSearchResults"
}
}
]
},
"type": "FWorkOrderItem"
}
},
"onlineSearchResults": {
"config": {
"recipe": {
"tableToSearch": "FIELDBUDDY__Work_Order_Item__c",
"fieldsToFilter": [
"Name",
"FIELDBUDDY__Item_Code__c"
],
"where": {
"fieldName": "FIELDBUDDY__Type__c",
"operator": "=",
"searchValue": "${templateType}"
},
"fieldsToRequest": [
"FIELDBUDDY__Quantity__c",
"FIELDBUDDY__Tax_Amount__c",
"FIELDBUDDY__Tax_Rate__c",
"FIELDBUDDY__Type__c",
"FIELDBUDDY__Unit__c",
"FIELDBUDDY__Unit_Price_Including_Tax__c",
"FIELDBUDDY__Unit_Price_Including_Tax_input__c",
"FIELDBUDDY__Unit_Price_Excluding_Tax__c",
"Id",
"Name",
"FIELDBUDDY__Display_Type__c",
"FIELDBUDDY__Increment__c",
"FIELDBUDDY__Item_Code__c"
],
"limitOfRecords": 50,
"skipRecordsFromBriefcase": true
}
},
"type": "FOnlineSearchResults"
}
},
"name": "WorkOrderItems"
}
```
# Types of Work Order Items
When inserting or editing Work Order (Line Items), we can specify which fields will be displayed on the Insert/Edit screen. This can be done using via properties inside events array.
In case if Display Type is `Details` or `Checklist`, `propertiesLayout` is being used, and is being shown on Insert and Edit actions
Otherwise (for `Quantity` or `Checkbox`) is used, then layout is configured via `fieldsFilters`, `typesFilters` and `readonlyFields`, but those are configured only on Edit actions (since you can insert records without changing the fields)
There is only one event `onGoInsertPlus` that has following properties (gray ones should not be changed, unless you add new WOI type)
| **Property** | **Description** | **Example value** |
| --- | --- | --- |
| `eventName` | Event name | `"eventName": "onGoInsertPlus",` |
| `triggeredEvent` | Triggered action, should not be changed | `"triggeredEvent": "navigate",` |
| `target` | Type of event, should not be changed | `"target": "InsertPlus",` |
| `templateType` | Describes type of record that is created, should rarely be changed (only when new types are added) | `"templateType": "Activity"` |
| `targetParentTableName` | table name of which record is created | `"targetParentTableName": "FIELDBUDDY__Work_Order_Line_Item__c",` |
| `targetChildrenTableName` | Table name of which record is created for details | `"targetChildrenTableName": "FIELDBUDDY__Work_Order_Line_Item_Detail__c",` |
| `table` | Table name of which record is used as source | `"table": "FIELDBUDDY__Work_Order_Item__c",` |
| `screenTitle` | Title of the screen | `"screenTitle": "${FIELDBUDDY__Work_Order_Line_Item__c.plurallabel}",` |
| `propertiesLayout` | Contains [FProperties](https://upperdeck.atlassian.net/wiki/spaces/FBDOCS/pages/4350672933) component with fields from Work Order Line Item that are shown on the first tab | ```
"propertiesLayout": {
"config": {
"saveAll": true,
"sections": [
{
"table": "FIELDBUDDY__Work_Order_Line_Item__c",
"iconName": "md-person",
"iosIconName": "ios-person",
"headless": true,
"mapping": "FIELDBUDDY__Work_Order_Line_Item__c",
"title": "",
"objects": [
{
"name": "Name"
},
]
}
]
}
}
``` |
| `onlineSearchResults` | Contains information about which fields and objects are used to query Work Order Item Details for Online Search | ```json
"onlineSearchResults": {
"config": {
"recipe": {
"tableToSearch": "FIELDBUDDY__Work_Order_Item_Detail__c",
"leftJoin": "FIELDBUDDY__Work_Order_Item__c",
"fieldsToRequest": [
"Id",
"Name",
"FIELDBUDDY__Field_Type__c",
"FIELDBUDDY__Default_Value__c",
"FIELDBUDDY__Work_Order_Item__c",
"FIELDBUDDY__Order__c",
"FIELDBUDDY__Page__c",
"FIELDBUDDY__Picklist_Values__c",
"FIELDBUDDY__Required__c",
"FIELDBUDDY__Help_Text__c",
"FIELDBUDDY__API_Name__c",
"FIELDBUDDY__Filter_Logic__c",
"FIELDBUDDY__Formula__c",
"FIELDBUDDY__Unit__c",
"FIELDBUDDY__Placeholder__c"
],
"limitOfRecords": 1000
}
},
"type": "FOnlineSearchResults"
}
``` |
## **Display Type Quantity or Checkbox**
**It is using **`typesFilters`** and **`fieldsFilters`.
If `propertiesLayout` is used, `typesFilters` and `fieldsFilters` are ignored, as there is no relationship between them. When applied, `typesFilters` and `fieldsFilters` define the fields to be included based on their name or type.
### fieldsFilters
In this example, the Insert Screen will display only those two fields from Work Order Items, ignoring all others.
```json
"fieldsFilters": [
"Name",
"FIELDBUDDY__Unit_Price_Including_Tax_input__c"
],
```
### typesFilters
In this example, the Insert Screen will display only the fields of type String from Work Order Items, ignoring all other field types.
```json
"typesFilters": [
"STRING
],
```
Accepted types: `DATE`, `DATETIME, BOOLEAN, PICKLIST (only for iOS), CURRENCY, DOUBLE, TEXTAREA, EMAIL, PHONE, STRING`.
### readonlyFields
It is possible also to specify which fields are read only. It can be done via following configuration
```
"readonlyFields": [
"Name",
"FIELDBUDDY__Unit_Price_Including_Tax_input__c"
]
```
## **Display Type Details or Checklist**
Again, if `propertiesLayout` is used, `typesFilters` and `fieldsFilters` are ignored, and FProperties component is being used to show fields from Work Order Line Item as a first tab, and all the remaining WOLID as second (and more) tabs