Migrating from the Standard to the Enhanced PPW Driver

Transcription

1 New Driver Announcement! The Property Pres Wizard (PPW) Enhanced Integration is now live in Pruvan. We recommend that you use the new driver over the original one. If you are already using the current PPW driver, use the following guide to migrate over to the enhanced driver. If you would still like to use the original integration, you will find the original documentation here. Migrating from the Standard to the Enhanced PPW Driver This document is a step-by-step guide on how to the Enhanced Property Pres Wizard (PPW) Integration from your current setup. You can migrate over on a per contractor basis, leaving your current driver running for contractors that have not been moved over yet. There are 3 modes for configuring your Enhanced PPW integration: Mode 1: You are an admin in PPW and your contractors are subusers on your Pruvan account Mode 2: You are an admin in PPW and your contractors have their own Pruvan accounts or you are one of these contractors Mode 3: You are an admin in PPW with some contractors as subusers and some that have their own account. In this case follow both sets of instructions. New Features There are several new features in the Enhanced PPW driver now: Auto Import Work Orders that are Sent to Field Work Order Line Items populate in the Project Instructions Auto Close Work Orders that are marked Ready for Office Auto Relay Photos to PPW Auto Flag Photos in PPW Dynamic Bid Creation Migrate PPW PCRs to Pruvan Surveys Auto Fill PPW PCRs with information from Pruvan Surveys These features will be explained in the Configuration section of this guide. **NOTE**: All Enhanced PPW projects are imported with the following options set; camera orientation will be locked to landscape, and photo size will be locked to small. This will override device settings. Read more about Pruvan Mobile Configuration Options. Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 1

2 Setup the Enhanced PPW Driver in Pruvan In order for your Work Orders to be automatically downloaded from PPW to Pruvan, you need to create a Pruvan Client record for PPW. All Modes: 1. Login to your Pruvan account at and navigate to the Projects > Clients tab 2. Click the button 3. Enter a name for your client record, something like NEW and then select Property Preservation Wizard (Enhanced) in the drop-down box. It needs to be distinguishable from your current PPW client code. 4. Click the button. 5. You will be presented with the following dialog: 6. Enter your PPW Username and Password 7. Click on to test your login information. If it works, you should see the message: Connected successfully! 8. Select the entire Push API Key and copy the text 9. Click to save the Client record Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 2

3 Setup Property Pres Wizard with your Pruvan Information You will need to provide some information to PPW for assignment and importing to operate correctly. Mode 1: 1. Log in to PropertyPresWizard.com and navigate to Admin > Settings 2. Enter your Pruvan username in the Pruvan Master ID field 3. Paste your API Key to the Push Key field 4. Click 'save' 5. Click on your PPW username in the upper right 6. Add your Pruvan username in the Pruvan username field 7. Navigate to Admin > Users 8. Click on your migrating contractor 9. Remove the '[username]' from the name field of your migrating contractor s name 10. Enter your migrating contractor's Pruvan username to the Pruvan username field 11. Click 'save' 12. Repeat for the other contractors Mode 2: Admin 1 Log in to PropertyPresWizard.com and navigate to Admin > Users 2 Remove the '[username]' from the name field of your migrating contractors Contractors 1 Log in to PropertyPresWizard.com and click on your PPW username in the upper right 2 Add your Pruvan username to the Pruvan username field 3 Paste your Push API Key to the Push Key field 4 Click 'save' Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 3

4 Configure your Integration Importing Orders Auto Import Your work orders will import automatically once they are sent to field in PPW they will be relayed directly to your Pruvan account. They will also be imported if they are set from Ready for Office to Follow Up. Auto Close Work orders marked Ready for Office in PPW will send a trigger to Pruvan for the project to close, which will cause it to fall off of the user s project list on their device. Manual Import To manually import your PPW orders into Pruvan click on the button. This will start the order import and launch the log viewer. You can press the F5 key to refresh the log viewer if it doesn t refresh fast enough. Reconciliation You can reconcile the two systems by following the below steps to refresh all of the orders in your Pruvan account. 1. Log in to Pruvan.com 2. Go to Projects > Client Project Import Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 4

5 3. Select your PPW integration and click edit 4. Click on the Full Refresh button This will bring up the same window as in a manual import, ALL of your orders currently in PPW will be sent to Pruvan. PPW orders in Pruvan that already exist will be updated, ones that are not received will be deleted, and orders that are not in Pruvan will be inserted. Auto Assignment As long as you have the Pruvan username field filled out in your contractor s account settings in PPW orders that contractor are assigned will be automatically assigned to the corresponding user in Pruvan. Task Creation There are 3 options in Pruvan s Client Project Import setup for PPW Enhanced that affect how tasks generate on Pruvan s projects. There is the Photo Tasks box, Survey Tasks box, and Ignore Bid Task option. By default Ignore Bid Task is set to no and the Photo and Survey Task boxes are empty. Any PCRs you have linked to Pruvan that are assigned to an imported work order will also be added on to the task list in every mode. When Ignore Bid Task is Off You will receive a photo task from PPW named after the Work Type, if there is no work type then it will simply be Photos. This task can be used to create dynamic bids or to auto-flag photos. Additionally you can have photo tasks and / or surveys added to your Pruvan Project. When Ignore Bid Tasks is On Set this if you want the task structure to remain the same as the standard PPW driver. You will not get the Misc Tasks task. If there is a Work Order Type listed on a work order and no photo / survey tasks listed, then that will be the only task on the project. If you list any photo or survey tasks in Pruvan then those tasks will overwrite the work order type and be listed on the project. If you have no work order type and no photo or survey tasks then there will be a generic Photos task listed. Adding Survey Tasks Surveys can still be added using the Survey Tasks box in the integration window in Pruvan, just as before. Surveys that were previously added using the Work Type field (template ID in square brackets) will continue to work the same way as well. Survey tasks can also be generated by linking PPW PCR forms to Pruvan Surveys as described here. Any Surveys entered must be defined in Survey Management. The Template ID of the Survey must match exactly what you enter in the Survey Tasks box and the Survey must be in the status of published. The Survey version number must be included and updated whenever the version number changes. When the Survey Task is created it will use the Survey Name as the name of the Survey Task. Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 5

6 Photo Handling Relay Options There are 3 options to control how photos are sent to PPW. They are set by choosing the appropriate selection from the Send Photos to PPW menu in Pruvan s Client Project Import setup. Off: This will not relay any photos to PPW, even if they are manually published to client. CSRs will generate when a project is published. Photos will still be sent to the Downloader on publish. On: This will relay photos to PPW once they are published. This is the default in the old integration. CSRs will generate whenever a project is published. This option is for those that want to QA photos in Pruvan. Auto: This will auto-relay photos to PPW as they are taken. This means that once a photo is uploaded from the device to Pruvan, Pruvan will immediately send it to PPW. The green Publish button in the app will become a Complete button. The Complete button will mark the project complete in Pruvan, which will move the project to the bottom of the project list on the device. CSRs will generate whenever a project is marked complete. This is for those that want to QA photos in PPW. Bid and Completion Task Functions When taking photos on the photo task you will see 4 different evidence types to choose from in the camera. Photos taken under Before, During, or After evidence types will register as a completion item in PPW. Photos taken under Bid will register as a bid item in PPW. Auto Flagging Photos taken on the photo task as before / during / after will show up in PPW as Unflagged and before, during, or after. If you enter a note on one of these photos it will create a completion task in PPW with the Note as the title and all photos with that note will be flagged accordingly.. Dynamic Bid Creation When in the photo task, any photos taken with a caption and bid as the evidence type will create a bid item in PPW that matches that caption. Those photos will be flagged under that bid item. Photos taken in this task with no caption will come in to PPW unflagged. Captions are added to photos using the Pencil icon in the Pruvan camera. Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 6

7 CSRs All CSRs will be loaded in to the Document area of the work order in PPW, regardless of the configuration used. Linking PPW PCRs to Pruvan Surveys PCRs that are assigned to work orders in Pruvan will be added to the Pruvan project as a survey task. Once the survey is completed in Pruvan the PCR in PPW will be automatically populated and Pruvan s survey PDF will be sent to the Documents section in PPW. I already have a Pruvan Survey built that I want to link to my PPW PCR.. There are 2 options, one is that you can migrate the PCR over and set it up as a new survey and phase your existing survey out, the other is that you can take your survey and follow these steps to get it linked up to PPW. 1. Follow the Migrate steps below to get the Pruvan JSON 2. Paste that JSON to a blank text document (B) 3. Log in to Pruvan.com 4. Go to Projects > Survey Management 5. Select the Survey you want to link 6. Click edit 7. Click export to JSON 8. Select all of the text and copy 9. Exit out, and then click exit 10. Paste this JSON into another blank text document (A) Compare your questions to the questions in the PPW Pruvan JSON in your text document (B). You will need to edit the JSON in A and add the ID codes from B. 11. Take the survey template ID from B and completely replace the template ID in A with it 12. Take the Question IDs from B and completely replace the Question IDs in A that they match with 13. Once you have linked all of the template IDs from B to A, select all and copy 14. In Pruvan, Click new 15. Click Import from JSON 16. Paste your text here 17. Click save 18. Make any additional changes you want to the survey using the Survey Builder 19. Click save 20. Click exit 21. Follow the instructions below for publishing your Survey Migrate the PCR to a Pruvan Survey First, you will need to export your PCR to Pruvan and set up the Survey template. 1. Log in to Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 7

8 2. Go to Admin > General > PCR Forms 3. Locate the PCR you want to migrate 4. Click on the Pruvan JSON button 5. Select all of the text and copy it 6. Log in to Pruvan.com 7. Go to Projects > Survey Management 8. Click on new to create a new survey template 9. Click on Import JSON in the upper right 10. Paste the JSON text in to the window 11. Click done 12. Click save Publish the Pruvan Survey You will need to edit the survey template so that it is suitable for your needs. You can rearrange all of the questions as needed, change the answer types, add additional control questions, add photo requirements, and add answer triggers. Ensure that you do NOT alter the ppwid 1234 ID number at the beginning of all of the question IDs, as well as the survey template ID. These ID numbers are how PPW maps the answers back to your PCRs. 1. Open the Pruvan Survey 2. Clean up the survey template 3. Click save 4. Select the new survey template 5. Click publish 6. Note the version number of your survey (xxx-v1) 7. Return to 8. Click on the PCR you have migrated 9. Enter the version number in the Pruvan Survey Ver. # field 10. Click save Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 8

9 Your survey is now ready to use. As long as the PCR is assigned to a work order when that order is sent to field it will load the linked Pruvan survey as a survey task on the device. Data Mapping Your PPW work orders will appear as Pruvan Projects in the Projects page. Tasks will import based on your configuration. Surveys will save under Documents in PPW. The table below shows the data mapping between PPW and Pruvan. Work Order PPW WO# or PPW# Address City State ZIP Date Due Client Company Work Order Type Comments Line Items (description, quantity, and additional instructions) Project Pruvan Project ID WO# if it exists, otherwise PPW# Address1 City State ZIP -- Task Bid / Completion Items PCRs (that are defined in Pruvan) Photos Caption Due Date Reference Description Instructions Instructions Photo Tasks Survey Tasks Photos Notes (pencil icon in camera) Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 9

10 Integrating Pruvan with Property Preservation Wizard (PPW) These are the original PPW integration instructions. This document is a step-by-step guide on how to integrate your Pruvan account with Property Preservation Wizard (PPW.) Create a PPW Client In order for your Work Orders to be automatically downloaded from PPW to Pruvan, you need to create a Pruvan Client record for PPW. 1. Login to your Pruvan account at and click on Projects then the Client Project Import tab. 2. Click the button. 3. Enter a name for your client record, something like PPW and then select Property Preservation Wizard in the drop-down box. 4. Click the button. 5. You will be presented with the following dialog: Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 10

11 6. Enter your PPW Username and Password. (This is the username and password you use to log into Property Preservation Wizard.) 7. Click on to test your login information. If it works, you should see the message: Connected successfully! 8. If you use the WO# field in PPW, then set Pruvan Projects Map To: to WO#, otherwise set this to PPW#. **NOTE: The field you choose here must be in your active column list in your PPW home screen. 9. To have your photos automatically sent back to PPW when you publish in Pruvan set the Auto Relay Photos to PPW dropdown box to Yes. The photos will appear in PPW as Unflagged under the correct Project. 10. Click to save the Client record. Configuring the PPW Integration Additional Tasks You can optionally enter additional Photo Tasks and Survey Tasks that are created by Pruvan when your PPW Projects are imported. If you leave this field blank, then the single Task of <Work Type> Photos is created, if the Project is in the status of Follow Up the <Work Type> Follow Up Task is created. If there is no work type on the work order, then the task will simply be Photos. The Surveys must have been defined in Survey Management, the Template ID of the Survey must match exactly what you enter in the Survey Tasks box and include the version number. The Survey must also be published. When the Survey Task is created it will use the Survey Name as the name of the Survey Task. Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 11

12 You can also define a comma separated list of Survey Tasks per Work Type in PPW. These Survey Tasks will be created when the driver imports Project of that Work Type in PPW. To define Survey Tasks for a specific Work Type in PPW, Login to PPW and go to the Admin->WorkTypes. Click on an existing Work Type or create a new one and next to the Work Type name put the Pruvan Survey Template ID in brackets next to it. You may also use a comma separated list for multiple Surveys for a Work Type. Any surveys you add this way will be displayed with the Survey Name as the Task Name and not the default Work Type. Additional Instructions Additional information can be added after import in the Project Management screen to the instructions field. Any changes to this field will be retained in Pruvan, even if the order is later updated by the driver. This way you can continue to import new orders while this order is still open without having to re-enter the instructions every time. Auto-Assignment You can automatically assign incoming PPW work orders to Pruvan sub users. To automatically assign, login to Property Preservation Wizard and click on Admin->Users and select the user that you want to associate with the Pruvan sub user. In the First Name field, next to the actual first name of the user, put the Pruvan sub user in [brackets] and click Save. When an order is imp orted from PPW that is assigned to this user, it will automatically be assigned to that Pruvan sub user. Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 12

13 ***NOTE***: If you have the PPW setting for Contractor sorting in menu options set to Company Name then you will need to add the [Pruvan_username] to the Company Name field instead of the First Name field. Importing Orders To import your PPW orders into Pruvan click on the button. This will start the order import and launch the log viewer. You can press the F5 key to refresh the log viewer if it doesn t refresh fast enough. Orders that are marked Ready For Office, Invoiced, and Orders that are not in the feed on the next refresh will be automatically removed. Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 13

14 Data Mapping Your new PPW work orders and line items should appear as Pruvan Projects and Tasks in the Projects page. The table below shows the data mapping between PPW and Pruvan. Pruvan will import orders with a status of Unread, In Field, Accepted, and Follow Up. PPW Work Order WO# or PPW# Address City State ZIP Date Due Contractor [name] Various PPW Fields Project Project ID Address City State ZIP Pruvan Due Date Assigned To (name between brackets, see the Assignment and Driver Precedence section for more details) Instructions (Client, Customer, Contractor, PPW Status, Work Type) Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 14

15 Logic for Creating Photo and Survey Tasks The following flowchart explains how the Photo and Survey Tasks are created by the driver. Use this flowchart to determine how you would like to configure the driver for your business process. Start Any Photo Tasks defined? Yes Create a Task for each Photo Task No Any Survey Tasks defined? Yes Are the Surveys defined and published? Yes Create a Task for each Survey Task No Any Work Type Survey Tasks defined in PPW? Yes Are the Surveys defined and published? Yes Create a Task for each Survey Task No Is the Project in the status of Follow Up? Yes Create <Work Type> Follow Up Task No Create <Work Type> Photos Task End Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 15

16 Assignment and Driver Precedence Start Driver Assignment If the Project is assigned, then the Driver will always INSERT and UPDATE with the assignment from the Client system. Note the user to be assigned must be already defined in Pruvan as a valid subuser in your account. If the user is not already defined in Pruvan the Project will remain in Unassigned status. Pruvan Assignment If the Project is not assigned, then the Driver will never INSERT or UPDATE the assignment from the Client system. Pruvan assignment will always be preserved. End Copyright (c) 2014 Pruvan, Inc. All Rights Reserved. P a g e 16