Browse Guides

Sherweb Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><style> p { margin: 0; } span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px; } blockquote blockquote { border-color: #00bcd4; color: #00bcd4; } blockquote blockquote blockquote { border-color: #43a047; color: #43a047; } table.grid { border-collapse: collapse; } table.grid td, table.grid th { border: 1px solid #ddd; } .fr-fic.fr-dib { display: block; margin: 5px auto; } .fr-fic.fr-dib.fr-fir { text-align: right; margin: 5px 0 5px auto; } .fr-fic.fr-dib.fr-fil { text-align: left; margin: 5px auto 5px 0; } .fr-fic.fr-dii { float: none; margin: 5px auto; } .fr-fic.fr-dii.fr-fil { float: left; margin: 5px auto; } .fr-fic.fr-dii.fr-fir { float: right; margin: 5px auto; } img.fr-dib.fr-fir { margin-right: 0; text-align: right; } img.fr-dib.fr-fil { margin-left: 0; text-align: left; } img.fr-dib { margin: 5px auto; display: block; float: none; } img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC; } img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc; } img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box; } </style><style> p { margin: 0; } span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px; } blockquote blockquote { border-color: #00bcd4; color: #00bcd4; } blockquote blockquote blockquote { border-color: #43a047; color: #43a047; } table.grid { border-collapse: collapse; } table.grid td, table.grid th { border: 1px solid #ddd; } .fr-fic.fr-dib { display: block; margin: 5px auto; } .fr-fic.fr-dib.fr-fir { text-align: right; margin: 5px 0 5px auto; } .fr-fic.fr-dib.fr-fil { text-align: left; margin: 5px auto 5px 0; } .fr-fic.fr-dii { float: none; margin: 5px auto; } .fr-fic.fr-dii.fr-fil { float: left; margin: 5px auto; } .fr-fic.fr-dii.fr-fir { float: right; margin: 5px auto; } img.fr-dib.fr-fir { margin-right: 0; text-align: right; } img.fr-dib.fr-fil { margin-left: 0; text-align: left; } img.fr-dib { margin: 5px auto; display: block; float: none; } img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC; } img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc; } img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box; } </style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Sherweb Integration?</strong></p><p><strong>- Enabling the Sherweb Integration&nbsp;</strong></p><p><strong>- Connecting Sherweb</strong></p><p><strong>- Customers</strong></p><p><strong>- Subscriptions</strong></p><p><strong>- Halo Integrator</strong></p><p><br></p><p><br></p><p><strong>Related Guides:</strong></p><ul><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/2508" target="_blank" rel="noopener noreferrer"><strong>Licences/Subscriptions Overview</strong></a></li></ul><p id="isPasted"><br></p><p><span style="font-size: 14pt;"><strong>What is the Sherweb Integration?<br></strong></span></p><p>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.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Sherweb Integration<br></span></strong></p><p>You will need to enable the integration module by hovering over it and clicking the &quot;+&quot; icon that appears. Navigate to Configuration &gt; Integrations &gt; Distribution to find the Sherweb module.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ5MmRmODE2LTA2ZDQtNGQ2YS05NDdlLWFhOWIzYTQxMDRiZiJ9.5RmaAruFvJiGgVKC3yDVUw3HNAQtmgBH3bEJfVNfj90" class="fr-fic fr-fil fr-dib" width="88" height="115"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the Sherweb module.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting Sherweb</span></strong></p><p>The credentials to input can be found within Sherweb&#39;s application. Sherweb&#39;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:</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY3YWExMTg2LWE0YzEtNDBlNy1hNDI4LWE4NTAwOGUwMTdiZiJ9.WM0PM3Xj55nwAn0A4DS0lwJkT4Law2qZxJ6BibboN0s" class="fr-fic fr-fil fr-dib" width="1216" style="width: 1218px; height: 287.112px;" height="287"></p><p><strong><span style="font-size: 10pt;">Fig 2. Connecting Halo to Sherweb.</span></strong></p><p><br></p><p>Click the &quot;Test Configuration&quot; 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).</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk3ZjlhM2FlLTAxNWQtNDZiMi1hY2E1LWI4ZmQ5NGZiMjNlNyJ9.kmanrMDnw3MvV1OHQZgpDNnQWifzP1x0iLh10wnx9Xc" class="fr-fic fr-fil fr-dib" width="172" height="123"></p><p><strong><span style="font-size: 10pt;">Fig 3. Successful test of Sherweb configuration.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Customers</span></strong></p><p>The &quot;Generate Mappings&quot; 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.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU5ODNhZDBhLTE5YzktNDYzOC04ZjBjLTg4MzhhMGYxY2ZiMSJ9.L5EJ2psvb2442UcYIWJ4hodP4VNsjWQDMJV0oauBst4" class="fr-fic fr-fil fr-dib" width="1208" style="width: 1210px; height: 241.68px;" height="242"></p><p><strong><span style="font-size: 10pt;">Fig 4. Generated mapping.</span></strong></p><p><br></p><p>Other mappings can be manually added, if the names do not match between Sherweb and Halo, for example with Org 2 and 3.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhjMGJiZjY4LWFmNDktNDY5Ni04NDFhLTcwNzk2M2U2OTBjOSJ9.VthESWauSJ2Le6AK3pwmQrIh5tRtA6xVowJs67iSw0I" class="fr-fic fr-fil fr-dib" width="1209" style="width: 1211px; height: 311.009px;" height="311"></p><p><strong><span style="font-size: 10pt;">Fig 5. Manual customer mappings.</span></strong></p><p><br></p><p>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.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNhZDRkYTFjLTAyZGUtNDM1Mi05NzZiLTMzM2ZiNDQxYjYzZCJ9.fg3c_53rwIjU0bvUmybrEfT0XaICw4OYRenvr6riRXg" class="fr-fic fr-fil fr-dib" width="1216" style="width: 1218px; height: 348px;" height="348"></p><p><strong><span style="font-size: 10pt;">Fig 6. Automatically created mapping from an import.</span></strong></p><p><br></p><p>The new customer now shows in the customer list.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFmNjE5MzQzLTNjM2QtNDNiNC1hZTk5LTA3M2NjM2Y5MjZjMCJ9.SaWJn_esvU_NiXIuTnnD6TyvSK7twWgJp1aYa7Rwz5c" class="fr-fic fr-fil fr-dib" width="253" height="105"></p><p><strong><span style="font-size: 10pt;">Fig 7. Newly created customer.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Subscriptions</span></strong></p><p>The Subscriptions can then also be imported by clicking on the &quot;Import Subscriptions&quot; 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: <a href="https://usehalo.com/halopsa/guides/2319/" target="_blank" rel="noopener noreferrer"><strong>Managing a Recurring Invoice Lines Quantity, Price and Cost</strong></a> &nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNiMWZhNmEyLWNhM2EtNDRmMy1hZGQ5LTFhMzIxYTcyZjZlZiJ9.q9iHNUJXO_TYjZ-PKB5Tfg54Q6xWliXdyxBL6WtHR-o" class="fr-fic fr-fil fr-dib" width="1183" height="169"></p><p><strong><span style="font-size: 10pt;">Fig 8. Import Subscriptions button.</span></strong></p><p><br></p><p>The subscription will then appear in the corresponding tab on the customer.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ2NWYyZTIxLTU1NDUtNGE4Ni1hYjJkLTgyNWFkMjIyMzQwMSJ9.RiObrm6ptBZPxamezR4sY5IXxyX0Kckdy2rvRMRVzxQ" class="fr-fic fr-fil fr-dib" width="1215" style="width: 1217px; height: 272.224px;" height="272"></p><p><strong><span style="font-size: 10pt;">Fig 9. Sherweb subscription on a customer.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Halo Integrator</span></strong></p><p>The subscriptions and/or customers can then be synced on a daily schedule.</p><p><br></p><p>You can set to deactivate subscriptions in Halo when they are deleted from Sherweb with the last checkbox.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU4NzNjNjljLTQ4OWEtNDMyYi04ZTk0LTNhZDQ3ZDQ1ZGExOCJ9.67dQkpI-24BV9GxMH6CEbJz8yq4P4dLQMPzMz-nRu9k" class="fr-fic fr-fil fr-dib" width="1217" style="width: 1219px; height: 264.929px;" height="265"></p><p><strong><span style="font-size: 10pt;">Fig 10. Halo Integrator configuration.</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.