In this guide we will cover:
– Enabling the Sherweb Integration
– Connecting Sherweb
– Customers
– Subscriptions
– Halo Integrator
This guide will cover the setup and use case of the Sherweb Integration. Sherweb can be used to import customers and subscriptions, with the ability to sync the information over on a daily basis via the Halo Integrator.
Enabling the Sherweb Integration
You will need to enable the integration module by hovering over it and clicking the "+" icon that appears. Navigate to Configuration > Integrations > Distribution to find the Sherweb module.
Fig 1. Enabling the Sherweb module.
Connecting Sherweb
The credentials to input can be found within Sherweb's application. Sherweb's Service Provider API is currently in BETA. Please contact your Sherweb account manager to allow access to this API if required. The company name can be found at the end of the portal URL of Sherweb:
Fig 2. Connecting Halo to Sherweb.
Click the "Test Configuration" button to verify that the integration is connected properly. If you have an error at this stage you can trouble shoot by using the developer console in your browser (Fn + F12 if on a Windows device).
Fig 3. Successful test of Sherweb configuration.
Customers
The "Generate Mappings" button can be used to pull through customers in Sherweb that exist in Halo with exactly the same name. If the names do not match then no mapping will be created. In this example there was only one customer that had the same name, so only one mapping was made.
Fig 4. Generated mapping.
Other mappings can be manually added, if the names do not match between Sherweb and Halo, for example with Org 2 and 3.
Fig 5. Manual customer mappings.
Each time a customer import is done, the mappings table will update to check for any changes, i.e. if a new customer is imported with a name that does not match any customer in Halo, a new customer will be created in Halo and the mappings table will update to reflect this new mapping to the customer in Halo that has just been created.
Fig 6. Automatically created mapping from an import.
The new customer now shows in the customer list.
Fig 7. Newly created customer.
Subscriptions
The Subscriptions can then also be imported by clicking on the "Import Subscriptions" button. You can also select if you want to import all subscriptions or just a certain customer. To automatically sync quantities to a recurring invoice, check out this guide: Managing a Recurring Invoice Lines Quantity, Price and Cost
Fig 8. Import Subscriptions button.
The subscription will then appear in the corresponding tab on the customer.
Fig 9. Sherweb subscription on a customer.
Halo Integrator
The subscriptions and/or customers can then be synced on a daily schedule.
As of v2.184.1+, you can set to deactivate subscriptions in Halo when they are deleted from Sherweb with the last checkbox.
Fig 10. Halo Integrator configuration.
