-
Notifications
You must be signed in to change notification settings - Fork 0
Addy Location Service Rock RMS Plugin
To install the plugin to your Rock RMS server, you will need to download latest release com.stewmystre.Addy.dll
file and paste it into the bin
folder of your wwwroot
(This is normally found within C:\inetpub
), doing this will trigger Rock RMS to rebuild and restart (may take a few minutes). That's it, now onto the setup.
Note: Don't use the .plugin
file, this will only be used if I decide to add the plugin to the Rock Shop
You will need to signup for a Addy free account, you just need an email address, mobile number and to setup a password. Once you have confirmed your email address (check your junk mail) and signed in, the account provides you with an API Key and API Secret that is required to gain unrestricted access to their service. No need to add credit card details as the free account gives you a generous 500 api calls per month, which should be more than enough for a small to average New Zealand church using the service. Copy the API Key and API Secret (or have the browser tab/window open) as you'll need them in the Rock setup.
Configuring your Rock instance to use Addy is easy. There are three simple changes that have to made:
- Firstly, visit
Admin Tools > General Settings > Global Attributes
and set theSupport International Addresses
value toYes
(Note: as a Kiwi church using Rock you may have already done this, but just double check). - Secondly, visit
Admin Tools > General Settings > Defined Types
, selectCountries
, selectNZ
and update the Address Format to:
{{ Street1 }}
{{ Street2 }}
{{ City }} {{ PostalCode }}
{{ Country }}
This aligns the address display format to that defined for Address Line Structure Standards within the NZ Post Standard Guide (Note: there is no State or Province detail required which is why this has been removed from the display format). Then Save.
- Thirdly, visit
Admin Tools > System Settings > Location Services
, and selectAddy
, change the service toActive
and paste the API Key and API Secret that you obtained earlier into the appropriate fields and Save. (Also deactivate any other services if you haven't already).
This location service will pass the values (if any are present) of the address line 1, address line 2, city, state, and postal code fields from Rock to the Addy Address Validation API service. If values are present in the response, it will either:
- confirm verification and replace the address values stored in Rock with the standardised response values, including geocode coordinates, or
- deny verification, due to multiple matches, and instead provide the first few listed matches provided by Addy. If this happens, check the recommended match details provided and if suitable update the address to one of the options and verify again.
The Rock Data Field is updated to match the Addy Address Details Metadata Properties as per the table:
Rock Location Data Field | Addy Address Details Property |
---|---|
Street1 | address1 |
Street2 | address2 |
City | city |
PostalCode | postcode |