Cyprexx Enhanced

CYPREXX ENHANCED
INTEGRATION
Cyprexx Enhanced Integration
Table of Contents
Generate a Cyprexx API Key.................................................................................................................................. 2
Create a Cyprexx Client ......................................................................................................................................... 2
Importing Orders .................................................................................................................................................. 4
Data Mapping ................................................................................................................................................... 4
Uploading Pictures ................................................................................................................................................ 4
Photo Relay ....................................................................................................................................................... 4
Copyright (c) 2015 Pruvan, Inc. All Rights Reserved.
Page |1
Cyprexx Enhanced Integration
This document is a step-by-step guide on how to integrate your Pruvan account with the Cyprexx Enhanced
Driver.
Generate a Cyprexx API Key
Before you can integrate the Cyprexx system with Pruvan you must generate an API Token.
1.
2.
3.
4.
5.
Login to your Cyprexx account
Click on My Account, then Manage Account Info
Click on the Integrations tab
Click on the Generate API Key button
Copy the API Token
a. Note: This is a password for your Cyprexx account, do NOT give it out publicly
Create a Cyprexx Client
Now you must tell the Pruvan system about Cyprexx. In order for your Work Orders to be automatically
downloaded from Cyprexx to Pruvan, you need to create a Pruvan Client record for Cyprexx.
1.
2.
3.
4.
Login to your Pruvan account
Click Integrations
Click New
Enter a name for your client record, something like “CPX”
a. Warning: Do NOT paste your API Token from Cyprexx here
5. Select Cyprexx Services (Enhanced)
6. Click Next
Copyright (c) 2015 Pruvan, Inc. All Rights Reserved.
Page |2
7. Enter your Cyprexx Username
8. Enter your API Token
9. Click on Validate to test your login information
a. If it works, you should see the message: Success
10. Click Save
Copyright (c) 2015 Pruvan, Inc. All Rights Reserved.
Page |3
Importing Orders
You only need to do an initial Full Refresh to import your Cyprexx orders into Pruvan. After that, all new
orders and order updates will automatically be sent to Pruvan from Cyprexx. If, for some reason the orders
in Pruvan and Cyprexx get out of sync. Simply delete all the Cyprexx orders in Pruvan and click on the Full
Refresh again. This, however, should rarely be needed. The types of work orders that are imported are Preforclosure services and maintenance orders, as well as preservation services and maintenance orders.
Inspections and repairs will not be imported and the existing systems for those types of orders should be
used.
Data Mapping
Your new Cyprexx line items should appear as Pruvan Projects in the Projects page. The table below shows
the data mapping between Cyprexx and Pruvan.
Cyprexx
Work Order
Order Number
Address
City
State
ZIP
Due
Pruvan
Project
Project Name_-_Service
Address
City
State
ZIP
Due Date
Service
Service
Service Name
Uploading Pictures
Photo Relay
Depending upon your profile options, your photos will automatically relay to Cyprexx. They will be visible in
the Cyprexx Web Portal’s Photo Manager. More on Profile Options can be found here.
Copyright (c) 2015 Pruvan, Inc. All Rights Reserved.
Page |4