Setting security permissions in Provet Cloud for the Revenue Retriever integration

When you are configuring the Revenue Retriever integration in Provet Cloud for the first time, you need to configure a virtual user for Revenue Retriever which has the right permissions for accessing your Provet Cloud data.

The steps for doing this are demonstrated in this video and set out step-by-step below. The specific permissions are listed towards the bottom of the page.

Tip: To see the video more clearly, click the full-screen button towards the bottom right.

Steps to apply permissions within Provet Cloud

The menus and settings below are how Provet Cloud labels them in English. If you use Provet Cloud in a different language, we recommend that while making these settings, you temporarily set your language to English within your profile in Provet Cloud.

Here are the steps for activating and setting permissions for the Revenue Retriever integration in Provet:

1. Login to Provet Cloud with administrator privileges.
2. Select Settings -> Integrations -> Revenue Retriever.
   1. Click the pencil button to edit.
   2. Check the box to enable the integration.
   3. Save your changes.
3. Select Settings -> Users -> Permission Groups.
   1. Click the button, +Group, to add a new group.
   2. Name it Revenue-Retriever.
   3. Save.
4. Locate the newly created permissions group, Revenue-Retriever and click the shield icon to edit its permissions.
   1. Apart from the permissions listed below, everything else should be clear.
   2. Set the permissions as below.
   3. Save your changes.
5. Select Settings -> Users -> Users.
   1. In the search panel, select Virtual.
   2. Locate the user 'Integration Revenue Retriever' and click the pencil to edit the user.
   3. Scroll down and find the dropdown for 'Permission Group'.
   4. Select Revenue-Retriever.
   5. Save your settings

Make sure you have successfully checked whether the permissions are set correctly using our test utility:

1. Go to https://revenue-retriever.com/test_oauth
2. Enter your provet customer number (usually a four-digit number) and click Test
3. The system will try all the different API calls that it will need to use. If all return a successful response then the configuration is complete. If it returns errors (table-specific fails and/or timeout errors) then return to the configuration steps. The specific tables referenced in the errors will give an indication of which permissions are missing.

Permissions required for Revenue Retriever in Provet Cloud

The permissions below are how Provet Cloud labels them in English. If you use Provet Cloud in a different language, we recommend that while making these settings, you temporarily set your language to English within your profile in Provet Cloud.

Revenue Retriever requires all of the following read permissions, and write permissions where noted:

General

• Patients and clients
• Consultations and its items: Read and Write
• Delete Consultations
• Tasks of users from all wards and departments

Financial

• Invoices: Read and Write

Profile

• User profile page
• Personal details
• Other users availability information

Settings

• Department management
• Department settings
• Users
• User groups and permissions
• Items
• Item description
• Item options
• Item wholesalers
• Item stock options
• Item cost centers
• Item pricing options
• Item pricing
• Item alternative pricing
• User log
• List and list items
• Patient referrals dashboard
• Patient referrals
• See prescription fees from all users