FeedHenry RainCatcher workorder
This module contains a workorder model representation and its related services :
- Backend services
- Frontend services
- Frontend UI templates
Client-side usage
Client-side usage (via broswerify)
Setup
This module is packaged in a CommonJS format, exporting the name of the Angular namespace. The module can be included in an angular.js as follows:
angular
Integration
Angular controller
A sync manager must first be initialized using the workorderSync.createManager()
. This can be placed, for instance, in the resolve
config of a ui-router
controlled application.
resolve: { return workorderSync; }
For a more complete example, please check the demo portal app.
workorderSync
API
These workorderSync API methods all return Promises:
workorderSync method | Description |
---|---|
workorderSync.manager.list |
list all workorders |
workorderSync.manager.create(workorder) |
create a workorder |
workorderSync.manager.read(workorderId) |
read a workorder |
workorderSync.manager.update(workorder) |
update a workorder |
Workorder directives
Name | Attributes |
---|---|
workorder-list | workorders, resultMap, selectedModel |
workorder | workorder, assignee, status |
workorder-form | value, workflows, workers |
workorder-status | status |
workorder-sunbmission-result | result, step |
Usage in an express backend
Setup
The server-side component of this RainCatcher module exports a function that takes express and mediator instances as parameters, as in:
var express = app = mbaasExpress = mbaasApi mediator = ; // configure the express app... // setup the wfm workorder sync servermediator app mbaasExpress;
Server side events
the module broadcasts, and listens for the following events
Listens for | Responds with |
---|---|
wfm:workorder:list |
done:wfm:workorder:list |
wfm:workorder:read |
done:wfm:workorder:read |
wfm:workorder:update |
done:wfm:workorder:update |
wfm:workorder:create |
done:wfm:workorder:create |
Integration
Check this demo cloud application
Workorder data structure example
id: 1276001 workflowId: '1339' assignee: '156340' type: 'Job Order' title: 'Footpath in disrepair' status: 'New' startTimestamp: '2015-10-22T14:00:00Z' address: '1795 Davie St, Vancouver, BC V6G 2M9' location: 49287227 -123141489 summary: 'Please remove damaged kerb and SUPPLY AND FIX 1X DROP KERB CENTRE BN 125 X 150 cart away from site outside number 3.'