Follow

Mobile Configuration Options

This article describes how to configure the Pruvan Mobile Configuration options.  The Pruvan Mobile Configuration is a set of optional configuration settings that can be set at varying levels to tailor Pruvan Mobile to your specific business needs and workflow.

Pruvan Mobile Configuration

Pruvan Mobile Configuration provides a way to control certain aspects of how the mobile devices in the field operate.  This control gives the Pruvan administrator the ability to override Device-level settings with system-wide settings.  Some settings include the ability to control Pruvan camera functions such as camera orientation, timestamp on photo and photo size.  Other settings control the behavior of Pruvan Mobile, such as how certain buttons operate and how photos are relayed.  A full reference of the Configuration options is detailed in this document.

Scope

Pruvan Mobile Configuration options also support the concept of scope.  A scope defines the context in which specific configuration setting is set.  For example, you might want to enable timestamp for photos taken for client X, but not for client Y.  In order to enable this scenario you would enable timestamp for the “work order” scope.  All work orders associated with client X would have timestamp enabled, and all work orders associated with client Y would have timestamp disabled.  There is a specific scope precedence that is respected by Pruvan Mobile; options defined at the lower scope takes precedent over options defined at higher scopes.  Currently, Pruvan supports the following scopes (from highest to lowest): Device, User, Work Order and Service.

Pruvan Supported Scopes:

  • Device settings at this Scope are controlled with the “Settings” panel in Pruvan Mobile.
  • User settings at this Scope are controlled via the Pruvan System Administration screens.
  • Work Order – settings at this Scope are controlled via the options field in the workOrder record in the getWorkOrders feed or by the Work Order type.
  • Service – settings at this level are controlled by the options field in the service record in the getWorkOrders feed.

Setting Configuration Options

In order to control the Pruvan Mobile Configuration options, you must set specific configuration options at the desired scope.  If you want to set an option system-wide for your entire field staff you would set the specific option at the user level for the master user.  Setting options at the work order or service level can be done by setting the options field in your custom getWorkOrders web service for your Integration.  For more information about Integrations, see the Get Integrated with Pruvan page on our website.  Another way to set options is by defining a Work Type in Pruvan Online.

Definitions

Mark Complete Button:  The green button that appears on the Project Details screen of Pruvan Mobile.  This button is labeled ‘Publish’ by default.  It is also commonly labeled ‘Complete’.

Complete Icon:  This is the Checkmark button on the Project Details screen of the Pruvan Mobile.  This button sends a ‘status: complete’ signal to Pruvan Online, but does not initiate any publishing.

Configuration Options

This section explains in detail each option, its purpose and scope.  Below is a list of the currently support Pruvan Mobile Configuration options.

Project Control Options

all_required_tasks_complete

required

auto_relay

mark_complete_label

mark_complete_mode

upload_pics_only_when_wo_complete

acceptance_required

camera_icon_hidden

complete_icon_hidden

allow_work_order_edits

allow_service_edits

mobile_project_review

Photo Control Options

evidenceTypes

camera_orientation

photo_size

photo_timestamp

frame_images

Video Enabled

Check In Control Options

check_in_provider

check_in_required

check_in_photo_required

check_in_relay

check_in_service

check_in_mode

check_in_timeout

Device Control Options

activity_timeout

allow_manual_work_order_creation


all_required_tasks_complete

Requires all required Services to be complete before the Work Order can be Marked Complete.  A required Service is a Service that has the option of required set to true at the Service Scope.  The act of completing a Service is determined by the Service type.  If the Service is a survey type, then the Service is complete when the survey has been submitted once.  If the Service is a photo type, then the Service is considered complete when at least one photo has been taken for the Service.

Valid Values

  • true
  • false

Related Options

  • Required

Supported Scopes

  • User
  • Work Order

required

Determines if a Service is required or not.  See the option all_required_tasks_complete for more information on the functionality of required Services.   If this option is set to true the Service is considered required.  If this option is set to false the Service is considered optional.  The default behavior when not set is false.

Valid Values

  • true
  • false

Related Options

  • all_required_tasks_complete

Supported Scopes

  • Service

mark_complete_mode

Changes the behavior of the Mark Complete button.  The button supports four modes that are described below.  When auto_relay is used, pressing the Mark Complete button will generate a new CSR.  If this option is not set the default value is workorder.

Valid Values

  • workorder - Sets status, and field status, to complete and publishes all unpublished photos
  • status - Sets the status, and field status, to complete
  • fieldstatus - Sets only the field status to complete
  • off - Removes the Mark Complete button

Related Options

  • mark_complete_label
  • auto_relay

Supported Scopes

  • User
  • Work Order

mark_complete_label

Changes the text on the Mark Complete button.  The default label is Publish.

Valid Values

  • A text string for the label
  • ie: "Complete"

Related Options

  • mark_complete_mode

Supported Scopes

  • User
  • Work Order

auto_relay

Determines if and how the photos taken should be automatically relayed.  The term “relayed” is defined as sending the photos to either the Client Integration, to the Pruvan Downloader, or both.  If the option is set to client, once the photos are uploaded to Pruvan, the photos will be automatically sent to the Client Integration defined for the Work Order on which the photo was taken.  If the option is set to downloader, once the photos are uploaded to Pruvan, the photos will be automatically sent to the Pruvan Downloader.  If the option is set to both, then the photos will be relayed to both the Client Integration and the Pruvan Downloader.  If the value is set to off, then the photos will simply be uploaded to Pruvan and wait to be Published or can be Published from the device, depending on the mark_complete_mode.  If this option is not set the default value is off.

Valid Values

  • client
  • downloader
  • both
  • off

Related Options

  • mark_complete_mode

Supported Scopes

  • User
  • Work Order

upload_pics_only_when_wo_complete

Enables and disables uploading photos only when the Mark Complete button is pressed.  If the option is set to true then photos will be uploaded only when the Mark Complete button is pressed.  mark_complete_mode must not be 'off' when this option is true.  If the option is set to false then photos will be uploaded immediately.  If this option is not set, the default value is false.

Valid Values

  • true
  • false

Related Options

  • mark_complete_mode

Supported Scopes

  • User
  • Work Order

acceptance_required

Allows mobile users to accept / reject work orders from the field, when set to true.  The accept dialogue will appear when an attempt to begin a task from the project details screen is made (photo, survey, or check in).  Default value is false.

Valid Values

  • true
  • false

Supported Scopes

  • User
  • Work Order

camera_icon_hidden

Displays or Removes the camera icon from the Project Details screen.  If the option is set to true then camera icon is removed from the Project Details screen.  If the option is set to false the icon is displayed.  If this option is not set the default value is false.

Valid Values

  • true
  • false

Supported Scopes

  • User
  • Work Order

complete_icon_hidden

Displays or Removes the complete (checkmark) icon from the Project Details screen.  If the option is set to true then complete icon is removed.  If the option is set to false the icon is displayed.  If this option is not set the default value is false.

Valid Values

  • true
  • false

Supported Scopes

  • User
  • Work Order

allow_work_order_edits

Allows you to restrict any editing of the project by a user; including status and who it's assigned to.  If the option is set to false then edits are not allowed.  If this option is not set the default value is true.

Valid Values

  • true
  • false

Supported Scopes

  • Work Order

allow_service_edits

Allows you to restrict any adding, deleting, or editing any of the tasks of the project by a user.  If the option is set to false then edits are not allowed.  If this option is not set the default value is true.

Valid Values

  • true
  • false

Supported Scopes

  • Work Order

mobile_project_review

Allows the user to review and edit a project created by Hot Link where normally the project is saved automatically.  If the option is set to true then the project must be saved by the user.  If the option is set to false then the Hot Link will work normally.  If this option is not set the default value is false.

Valid Values

  • true
  • false

Supported Scopes

  • User
  • Work Order

evidenceTypes

Defines the available evidence types a user may select when taking photos.  Evidence types are typically additional information taken, or tags, for a particular Service.  The default evidence types in Pruvan are before, during and after.

Valid Values

  • An array of strings
  • ie: ["front", "left", "right", "back"]

Supported Scopes

  • User
  • Work Order
  • Service

camera_orientation

Determines what camera orientation will be used when photos are taken by the Pruvan camera.  If this option is set at the User, Work Order or Service Scope it will override the Device setting.  If the option is set to portrait the Pruvan camera will only take photos in portrait orientation.  If the option is set to landscape the Pruvan camera will only take the photos in landscape orientation.  If the option is set to auto the Pruvan camera will take the photos based the orientation of the device.  If this option is not set, the Device setting is used.

Valid Values

  • portrait
  • landscape
  • auto

Supported Scopes

  • Device
  • User
  • Work Order
  • Service

photo_size

Determines what photo resolution will be used when photos are taken by the Pruvan camera.  These options are based on the hardware of the device used when taking the photo.  Android will select the highest size for each size category based on the hardware of the device according to the chart above.  If this option is not set, the Device setting is used.  The following chart shows what size photos Pruvan Mobile will take based on the value of the options.

Valid Values

Value

iPhone

Android

small

640 x 480 (0.3 megapixels)

640 x 480  (0.3 megapixels)

medium

640 x 480 (0.3 megapixels)

0.9 – 3.0 megapixels

large

1280 x 720 (1 megapixels)

3.0 – 5.1 megapixels

xtraLarge

1280 x 720 (1 megapixels)

Highest supported 4:3 Resolution

Supported Scopes

  • Device
  • User
  • Work Order
  • Service

photo_timestamp

Determines if and how a timestamp will be added to the photos taken by the Pruvan camera.  The timestamp is red and located in the lower right corner of the photo.  If this option is set to date the current month, day and year will be added to the photo.  If this option is set to time, then only the time will be added.  If this option is set to datetime, then both will be added.  If this option is set to off then no timestamp will be added to the photo.  If this option is not set, the Device setting is used.

Valid Values

  • date
  • time
  • datetime
  • off

Supported Scopes

  • Device
  • User
  • Work Order
  • Service

frame_images

Enables a Pruvan frame around photos taken on the project.  This photo frame contains a QR code and link to the original image on the Pruvan servers.  This can be used to verify the authenticity of the photos.  Set to true the photo will be framed.  If the option is not set, the default value is false.

Valid Values

  • true
  • false

Supported Scopes

  • User
  • Work Order

video_enabled

Enables the Mobile user to take videos in addition to pictures.  If set to false the switch to video mode is not available in the Pruvan Mobile camera.  If the option is not set, the default value is true.

Valid Values

  • true
  • false

Supported Scopes

  • User
  • Work Order
  • Service

check_in_provider

Enables the check-in system on the mobile app.  The check-in system allows a user to scan or enter an ID number for each crew member, validate the check-ins with a background check service provider, and take check-in photos on site.  Set which background check provider you need the check-in information sent to.  Check in photos can be required with the check_in_photo_required option.  Relay of check-in data to the provider is controlled with the check_in_relay option.  When not set the default value is null.

Valid Values

  • ags - Aspen Grove Solutions
  • mcsc - MCS
  • ashc - Servicelink

Related Options

  • check_in_required
  • check_in_relay
  • check_in_photo_required
  • check_in_mode
  • check_in_service
  • check_in_timeout

Supported Scopes

  • Work Order 

check_in_required

If this option is set to true the project will require a check-in to be completed.  This is enforced based on the check_in_mode option.  check-in provider must be set if check_in_required is true.  When not set, the default value is false.

Valid Values

  • true
  • false

Related Options

  • check_in_provider
  • check_in_mode

Supported Scopes

  • Work Order

check_in_photo_required

Determines if check-in photos are required or not.   If this option is set to true the photo is considered required to submit the Check In.  If this option is set to false the photo is considered optional.  Default value is false.  Currently there are no Check In providers that require a Check In photo.  Check In photos are not relayed to AGS.

Valid Values

  • true
  • false

Related Options

  • check_in_provider

Supported Scopes

  • Work Order 

check_in_relay

Determines how check-in data is sent to the check-in provider.  The term “relayed” is defined as sending the check-in data (to include survey data) to the check-in provider from Pruvan.  When set to auto, the check-in data will be relayed as soon as the project is marked complete.  When set to manual, the check-in data will upload to Pruvan’s server and hold there until it is published, to client, from Pruvan Online.  The default value when not set is manual.

Valid Values

  • auto
  • manual

Related Options

  • check_in_provider

Supported Scopes

  • Work Order 

check_in_service

Marks a specific service as part of the Check In process.  When this is set, the named service will NOT display with the regular services in the mobile app.  It will be displayed immediately after the Check In screen.  This will allow for more seamless transition in completing Check In related tasks.   The default value when not set is null.

Valid Values

  • A text string matching the serviceName of a survey service
  • ie: "AGS Checklist" or "Servicelink Checklist"

Related Options

  • check_in_provider

Supported Scopes

  • Work Order

check_in_mode

Determines when a Check In is enforced.  If set to start then the Check In will be required when a task is attempted.  If set to completion then the Check In will be enforced on pressing the Mark Complete Button.  The default value when not set is completion.  This option is only valid when check_in_required is set to true.

Valid Values

  • start
  • completion

Related Options

  • check_in_provider
  • check_in_required

Supported Scopes

  • Work Order

check_in_timeout

Determines how long a Check In Number will persist on the mobile device before requiring the Check In Number to be entered again.  When set to 0 the Check In Number will never expire.  Otherwise the Check In will expire after n seconds.  The default value when not set is 0.

Valid Values

  • An integer; in seconds

Related Options

  • check_in_provider

Supported Scopes

  • User

activity_timeout

Automatically logs out mobile users after n seconds when set.  If not set then the default value will be 0; never timeout.  Users with the option set on their account should make use of the Quick Login feature to avoid repeatedly typing in long passwords.

Valid Values

  • integer, in seconds
  • ie: 300 (for 5 minutes)

Supported Scopes

  • User

allow_manual_work_order_creation

Enables or disables the ability to create ad-hoc work orders.  If this option is set to true the ad-hoc work order or “plus” button is enabled on the Pruvan Mobile device.  If this option is set to false to ad-hoc work order button is removed.  If this option is not set the default value is true.

Valid Values

  • true
  • false

Supported Scopes

  • User

Example

{
    "workOrders": [
        {
            "workOrderNumber": "optionsTest",
            "options": {
                "all_required_tasks_complete": true,
                "auto_relay": "off",
                "mark_complete_label": "Submit",
                "mark_complete_mode": "workorder",
                "upload_pics_only_when_wo_complete": true,
                "acceptance_required": true,
                "camera_icon_hidden": true,
                "complete_icon_hidden": true,
                "check_in_provider": "ags",
                "check_in_required": true,
                "check_in_photo_required": true,
                "check_in_relay": "auto",
                "check_in_service": "AGS Checklist",
                "check_in_mode": "start",
                "check_in_timeout": 36000
            },
           "services": [
               {
                   "serviceName": "Photos",
                   "options": {
                       "evidenceTypes": ["front","right","left","back"],
                       "camera_orientation": "landscape",
                       "photo_size": "small",
                       "photo_timestamp": "datetime"
                   }
               }, {
                   "serviceName": "AGS Checklist",
                   "survey": "ags::AGSChecklist-v2",
                   "options": {
                       "required": true
                   }
               }
           ]
       }
    ]
}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments