Background
It is important to understand three (3) concepts in Pruvan which are:
- Submit
- Complete
- Publish
The "Submit" event, also known as "the blue button" will submit a survey answer-set from the User, indicating the Survey is completed. The Submit button is available in both Pruvan Online and Pruvan Mobile.
The "Complete" event, also known as the "mark complete" or "green button" will send a completion signal to Pruvan Online indicating the work has been completed on Pruvan Mobile app for each related order/Project completed in the field. The green button on Pruvan Mobile is configured to be labeled "Complete" on Pruvan Mobile app to indicate QA is required in the back-office, or "Publish" indicating quality assurance and publishing of items is done in-field. Orders/Projects can be completed multiple times from Pruvan Mobile.
The "Publish" event, is available on both Pruvan Mobile (if configured to Publish from the field) and is always available in Pruvan Online. Related items may be published multiple times.
The User Stories below explain the workflow possible by using Pruvan powerful configuration features that allow for various workflows to be engineered to meet a variety of business requirements. Configuration examples required to enable these user stories is also discussed below.
Account administrators and Order Source developers are encouraged to fully test all changes in a test account before making any changes to production environments.
Note for all User Stories:
- Field Users deleting items captured from the device after they are sent to Pruvan Online will not delete or discard these related items from Pruvan Online. See User Story 2 if QA is to be done on Pruvan Mobile. User Story 2 configuration prevents items being sent from the device until the order/Project is marked complete (Published) on Pruvan Mobile by field User.
- Field Users are alerted to order updates on the device, but must manually refresh orders/Projects (this allows field Users to know that orders/Projects are being updated)
- Items captured on one device are not synchronized to other field Users devices who are using Pruvan Mobile app
- Items sent to Pruvan Online are not editable on Pruvan Mobile
- Surveys submitted on Pruvan Mobile must be completed again in full unless Order is updated to default the previous answers.
- Items will not be sent automatically to Pruvan Online from the device if there is no network connection on the device, or if device settings/options prevent items from relaying from device to Pruvan Online
- Configuration options can be configured to make collecting data or completing the desired workflow impossible. Use and set all configuration options with care and rigorous testing.
User Stories
The User stories below help explain the concept of QA (quality assurance) and when and where QA is performed, and if QA it is done in the field on Pruvan Mobile, in the back-office using Pruvan Online, or if no QA is done at all. Configuration options control how these features are enabled.
User Story 1: Monitor, QA and Publish from the back-office
This User story is for an account administrator that has back office User(s), with staff or administrator roles, who need to see all items captured by their field Users as soon as possible, ideally within seconds of the item(s) being collected in the field. When the field User views the order/Project the back-office User(s) want to know that the field status has changed to "Viewed." When the field User takes the first photo or submits the first survey, the back-office User wants to know the that the order/Project field status has changed to "In-Process".
The back office User does not want any field results, photos, video or survey answers, to relay to their customer or cloud storage until all related items can be "QA'd" by a Staff or Administrator User role. Back-office User(s) want to review and manage field items collected before these items are sent to their customers (their client's) integrated orders.
The field Users are instructed not to turn off automatic photo uploads and are required to be connected to a reliable cellular internet connection on their mobile device at all times whenever a network connection is available.
The back-office User(s) wish to monitor when the field orders/Projects are completed and see Pruvan Online field status change when the field User presses the green mark complete button on the Pruvan Mobile app. The users want the green button to be labeled "Complete" to let the field User know to complete each order/Project, and have the mobile app remind the field User to finish all the required services/Tasks.
The back office User wants the order/Project status to change to "Complete" once back-office User complete the QA process and publish all items.
The User wants all integrated order/Project fields to be updated to reflect the changes in the respective fields controlled by Order Source. For example, Client Status field, Client Instructions, Client Due Date, and other fields should be updated by the Order Source with enough information to complete all integrated orders/Projects
User Story 2: No QA in Office, QA and Publish from the Field
This User Story is for an account administrator that has field User(s) but does not have any back office staff to QA photos, so QA is done in the field. User Story 2 is similar to User Story 1, except the account administrator configures his/her Pruvan account to automatically publish items to Order Source as soon a possible once the field User(s) press the green mark complete button on Pruvan Mobile app. The green button is configured to be labeled "Publish" since the account administrator wishes to convey items will be auto-published to the field User(s). The account administrator wants to remind all field User to finish all required services/Tasks before they are allowed to publish results.
User Story 3: No QA, automatic Publish before Complete
This account administrator wants all items to be published as soon as they are received by Pruvan Online before order/Project is completed in the field and does not wish to do QA on Pruvan Mobile. Items automatically publish as soon a possible to both Client and downloader/cloud storage. When the order/Project is marked "Complete" in the field, the Project Status and Field Status are changed to "Complete" The green button is configured to be labeled "Complete" and will not allow the field User to complete an order/Project until all the required services/Tasks are completed. This is how Pruvan accounts are configured initially by default on account creation.
Using Story Configuration
User Story 1 configuration by the account administrator (recommended method)
If the Pruvan account holder can be trusted to configure their account profile options no work order options should be set by the Order Source. This gives account holders the most flexibility on setting up their account the way they wish without the order/Project over-riding account profile options. The profile options at the account level should be set to Auto Relay = OFF to enable User Story 1 by an account User with an Administrator role.
The example work order JSON feed below sent to a related Pruvan account will demonstrate User Story 1. All items captured require back-office staff to QA and publish results to Order Source. Setting auto_relay at the Work-Order scope overrides the Pruvan account settings set by the account administrator.
User Story 1 configured by Order Source developer
{
"workOrders": [{
"workOrderNumber": "Order_for_Story1",
"address1": "110 East Main Street",
"city": "Round Rock",
"state": "TX",
"zip": "78664",
"options": {
"all_required_tasks_complete": true,
"auto_relay": "off"
},
"services": [{
"serviceName": "Task",
"options": {
"camera_orientation": "auto"
}
}]
}]
}
Note: The account administrator and staff roles can force change order/Project setting manually if order edits are allowed. If you lock work order edits this places extreme restrictions on the account administrator and should only be done on internal integrations when no order/Project edits are allowed except by Order Source, including order status and order assignment.
User Story 2 configured by the account administrator (recommended method)
Once again, if the Pruvan account holder can be trusted to configure their account profile options no work order options should be set by the Order Source.
The profile options at the account level should be set to the profile options settings shown below to enable User Story 2 by an account User with an Administrator role.
User Story 2 configured by Order Source developer
The settings shown below in example work order JSON feed to related Pruvan account will enable User Story 2. Using the following Work-Order/Project options, the Order Source forces items in Pruvan Online in pending QA to be published automatically when the completion signal is received from Pruvan Mobile and a CSR to be generated on each publish event if auto_relay is set.
Option set at the Work-Order scope must be done with care since it overrides the Pruvan account settings set by the account administrator.
{ "workOrders": [{ "workOrderNumber": "Order_for_Story2", "address1": "110 East Main Street", "city": "Round Rock", "state": "TX", "zip": "78664", "options": { "all_required_tasks_complete": true,
"auto_relay": "both", !<- If CSR required on each publish event, otherwise remove (see docs) "mark_complete_mode": "workorder",
"mark_complete_label": "Publish" }, "services": [{ "serviceName": "Task", "options": { "camera_orientation": "auto" } }] }] }
Note: The account administrator and staff roles can force change order/Project setting manually if order edits are allowed. If you lock work order edits this places extreme restrictions on the account administrator and should only be done on internal integrations when no order/Project edits are allowed except by Order Source, including order status and order assignment.
User Story 3 configuration by the account administrator (recommended method)
The account administrator sets the following account profile options for all account holder Users shown below. This is how Pruvan accounts are set up when the account is created automatically and can be changed only by User(s) with an Administrator role.
User Story 3 configured by Order Source developer
The example JSON below sent to a Pruvan account will enable User Story 3. Items pending QA are published automatically when the completion signal is received from Pruvan Mobile. A CSR will be generated on each publish event.
Option set at the Work-Order scope must be done with care since it overrides the Pruvan account settings set by the account administrator.
{ "workOrders": [{ "workOrderNumber": "Order_for_Story3", "address1": "110 East Main Street", "city": "Round Rock", "state": "TX", "zip": "78664", "options": { "all_required_tasks_complete": true,
"auto_relay": "both", "mark_complete_mode": "status",
"mark_complete_label": "Complete" }, "services": [{ "serviceName": "Task", "options": { "camera_orientation": "auto" } }] }] }
Note: The account administrator and staff roles can force change order/Project setting manually if order edits are allowed. If you lock work order edits this places extreme restrictions on the account administrator and should only be done on internal integrations when no order/Project edits are allowed except by Order Source, including order status and order assignment.
See also: Mobile Configuration Options
Comments