Follow

How to Enable Check In with an Integration

Pruvan’s Check In solution is compatible with Aspen Grove Solution’s (Aspen) Proof of Service capability, MCS's Vendor360, and ServiceLink's Assetshield.  To use Pruvan to Check In to job sites you must enable the Check In feature in Pruvan and set the provider using our Mobile Configuration Options.  The work order number provided to Aspen by the original client, or MCS's / ServiceLink's work order number, must be the workOrderNumber used for the project.  We also have a method for generic Check Ins that are only relayed back to your integration.

Source Work Order Information

Many times your project number will not exactly match the work order number that is on file with your check in provider.  To support these cases we have some fields available in the project JSON that will let you define information for Check In providers.

  • source_wo_number:  This is the work order number from the source workorder provider
    • Aspen - This will be the work order number that is in iRecord
    • MCS - MCS's work order number
    • ServiceLink - ServiceLink's work order number
    • Generic - Open for your use
  • source_wo_id:  This is the work order Id, usually from an API, from the source workorder provider
    • Aspen - N/A
    • MCS - This is the WorkOrderId from MCS's API to get work orders from their system
    • ServiceLink - N/A
    • Generic - Open for your use
  • source_wo_provider:  This is highest level work order provider, usually the entity that initially received the work from the mortgager.

Options

There are seven options that regulate how the check-in system works in Pruvan:

  1. check_in_required: Set this to ‘true’ to make the check-in feature required
  2. check_in_provider: Set this based on the following available providers:
    • Aspen - ags
    • MCS - mcsc
    • ServiceLink - ashc
    • Generic - stdc
  3. check_in_photo_required: Set this to ‘true’ to make a check-in photo required; this is not sent to Aspen
  4. check_in_relay: Set this to ‘auto’ to have your check-in data sent to the provider when the project is complete
  5. check_in_service: Set this to ‘AGS Checklist’, or another Check In survey task, to link your survey to the Check In event on the device
  6. check_in_mode: This can be set to ‘start’ to enforce Check In before work is started
  7. check_in_timeout: This can be set to force users to re-enter their ABC / badge number after X seconds

These must be included in the work order level options payload for any order that requires a check-in.  

Checklists

Some Check In providers require a Checklist to be completed before a Check In can be submitted.

Aspen

For all Aspen Check Ins you must load a survey task on to each of these projects for the checklist and it must link to a valid Aspen survey.Use the serviceName "AGS Checklist" and use the survey from Aspen’s account, ags::AGSChecklist-v2.  In the service instructions you must include a link to the Code of Conduct that the mobile users will be agreeing to in question 11 when completing an Aspen Check In.  We have hosted this COC here:  https://pruvan.zendesk.com/entries/44023619.  This task should include the service level option "required":true ("all_required_tasks_complete":true should be set at the project level) to ensure that the survey is not skipped.

MCS

Follow the instructions for the Aspen Checklist for MCS orders requiring its presence.  In place of the COC used when completing an Aspen Check In, in the service instructions, use the MCS COC hosted here:  https://pruvan.zendesk.com/hc/en-us/articles/205507145.  For information about what orders require a Check In or checklist please see the MCS Check In article.

ServiceLink

For all ServiceLink Check Ins you must load a survey task on to each of these projects for the checklist and it must link to a valid ServiceLink survey.Use the serviceName "ServiceLink Checklist" and use the survey from ServiceLink's account, servicelink::ASHChecklist-v1.  In the service instructions you must include a link to the Code of Conduct that the mobile users will be agreeing to in question 11 when completing an Aspen Check In.  We have hosted this COC here:  https://pruvan.zendesk.com/entries/44023619.  This task should include the service level option "required":true ("all_required_tasks_complete":true should be set at the project level) to ensure that the survey is not skipped.

Generic

You may use the check_in_service field to link any survey task that you require to the Check In process.  Simply put the serviceName of that survey task in the check_in_service field.  A checklist is not required by Pruvan to complete a generic Check In.

Examples

Aspen Check In

"options": {
     "all_required_tasks_complete": true,
     "check_in_required": true,
     "check_in_provider" :"ags",
     "check_in_relay": "auto",
     "check_in_service": "AGS Checklist",
     "check_in_mode": "start",
     "check_in_timeout": 36000
},
"source_wo_number": "123456",
"source_wo_provider": "afas",
"services":[{
     "serviceName": "AGS Checklist",
     "survey": "ags::AGSChecklist-v2",
     "instructions": "<html><body><a href=\"https://pruvan.zendesk.com/entries/44023619\">Tap here to view your code of conduct</a></body></html>",
     "options": {"required":true}
}]

MCS Check In

"options": {
     "all_required_tasks_complete": true,
     "check_in_required": true,
     "check_in_provider": "mcsc",
     "check_in_relay": "auto",
     "check_in_service": "AGS Checklist",
     "check_in_mode": "start",
     "check_in_timeout": 36000
},
"source_wo_number": "M123456",
"source_wo_id": "98765",
"source_wo_provider": "mcs",
"services":[{
     "serviceName": "AGS Checklist",
     "survey": "ags::AGSChecklist-v2",
     "instructions": "<html><body><a href=\"https://pruvan.zendesk.com/hc/en-us/articles/205507145\">Tap here to view your code of conduct</a></body></html>",
     "options": {"required":true}
}]

ServiceLink Check In

"options": {
     "all_required_tasks_complete": true,
     "check_in_required": true,
     "check_in_provider": "ashc",
     "check_in_relay": "auto",
     "check_in_service": "ServiceLink Checklist",
     "check_in_mode": "start",
     "check_in_timeout": 36000
},
"source_wo_number": "123456",
"source_wo_provider": "serviceLink",
"services":[{
     "serviceName": "ServiceLink Checklist",
     "survey": "servicelink::ASHChecklist-v1",
     "instructions": "<html><body><a href=\"https://pruvan.zendesk.com/entries/44023619\">Tap here to view your code of conduct</a></body></html>",
     "options": {"required":true}
}]

Generic Check In

"options": {
     "check_in_required": true,
     "check_in_provider": "stdc",
     "check_in_relay": "auto",
     "check_in_service": "",
     "check_in_mode": "start",
     "check_in_timeout": 36000
}

Check In Results

The Check In results will be compiled for the Check In Provider when the project is marked complete in the field.  If the check-in relay mode is set to auto then the data is sent immediately, if it is set to manual then the data must be published from Pruvan Online.

There is also a Check In Data object.  This is sent to you over your /uploadPictures endpoint.  For generic Check Ins this the only resulting data-set.  The JSON data will contain "fileType": "checkin", identifying it as a Check In record.  The file attached to the payload will be a text document containing the following JSON string:

[{
     "idNumber" : "OH430031034",
     "checkInProvider" : "ags",
     "status" : "valid"
}]

Note that this is an array of all users that were checked in to the property.

Check In Object Fields

Key Value
idNumber This is the ABC number that the user checked in with
checkInProvider This is the provider that was listed in the project's check_in_provider option
status This is the status of the idNumber in iRecord
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments