Browse Guides

Westcoast Cloud 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><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Westcoast Cloud Integration?</strong></p><p><strong>- Connecting to Westcoast Cloud&nbsp;</strong></p><p><strong>- Importing Customers</strong></p><p><strong>- Importing Subscriptions</strong></p><p><strong>- Importing on a Schedule</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/2384" target="_blank" rel="noopener noreferrer"><strong>Also Integration</strong></a>&nbsp;</li><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/2508" target="_blank" rel="noopener noreferrer">Licences/Subscriptions Overview</a></li></ul><p><br></p><p><strong><span style="font-size: 14pt;">What is the Westcoast Cloud Integration?</span></strong></p><p>Halo can integrate with Westcoast Cloud to import customers and their subscriptions from Westcoast into Halo. Customers and subscriptions can be synced on a scheduled basis to bring any customer/subscription changes from Westcoast Cloud into Halo automatically.&nbsp;</p><p><br></p><p>If using pro-rata billing based on your customer&#39;s subscription use this integration allows your invoices to be calculated automatically based on their subscription count in Westcoast Cloud.&nbsp;</p><p><br></p><p id="isPasted"><strong><span style="font-size: 14pt;">Connecting to Westcoast Cloud</span></strong></p><p>First ensure the integration module is enabled, head to Configuration &gt; Integrations &gt; Westcoast Cloud, enable the module using the &#39;+&#39; icon.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjIxY2VhNDE1LWVlYWUtNGE2Ni1iMjYyLTA5NjBjNWI2ZmQ1NCJ9.qXiybWBMSwCmUWwm-gb-tLutCQPGTAUWDOMGKEv7j7E" class="fr-fic fr-fil fr-dib" width="123" height="136"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enable integration module&nbsp;</span></strong></p><p><br></p><p>Once enabled click into the module to bring up the integration setup screen.</p><p>&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRiYTA5MThkLTQxZDktNDUwZi1iY2QwLTdlNzgzYjdhMzAxNCJ9.OT0IkpOQO-jkY_eMO_wMWUbXuIREYp2Zge-vGQjt87Y" class="fr-fic fr-fil fr-dib" width="1212" style="width: 1214px; height: 624.582px;" height="625"></p><p><strong><span style="font-size: 10pt;">Fig 2. Integration setup screen</span></strong></p><p><br></p><p>To connect to Westcoast Cloud enter your Marketplace URL, account username and account password in the details fields. Your &#39;Marketplace URL&#39; is just the URL you use when accessing/logging into your Westcoast Cloud marketplace, this is often &#39;<a data-fr-linked="true" href="https://cloud.westcoastcloud.co.uk" id="isPasted">https://marketplace.westcoastcloud.co.uk</a>&#39; and should follow this same format.</p><p><br></p><p>The &#39;username&#39; and &#39;password&#39; entered must belong to a Westcoast Cloud user that has at least read only permissions for customer and subscription data, they also need the &#39;Reseller Admin&#39; capabilities role. As this account will be used to authenticate the connection between Halo and Westcoast. The &#39; This account will also need to have 2FA against it disabled, this can be done by Westcoast support. If the account has 2FA Halo will not be able to connect to Westcoast Cloud.&nbsp;</p><p><br></p><p>Once you have entered your details you can use the &#39;Test Configuration&#39; button to test you have connected successfully.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Importing Customers</span></strong></p><p>Before customers can be imported from Westcoast Cloud you will need to create customer mappings. Mappings can be set manually or generated automatically. These mappings will determine which Westcoast Cloud customer the Halo customer is linked to.&nbsp;</p><p><br></p><p>Automatically generated mapping can only be used if your customers in Westcoast Cloud have the exact same name as your customers in Halo. To generate these mappings use the &#39;Generate mappings&#39; button.&nbsp;</p><p><br></p><p>Manual mappings are used when your customers already exist in both Westcoast and Halo but have different (non exact) names. To create a manual mapping add to the customer mappings table (figure 3), the customer data in Westcoast will then be imported to the mapped Halo customer.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU3YTJjNGRiLWVkNDgtNDdjZS04OTIzLTM4MDc4MWNmZThhNyJ9.wIJM0kQdsneiPll0-qqqKdZIsPYrbcizIBPwN3y7JQs" class="fr-fic fr-fil fr-dib" width="1201" style="width: 1203px; height: 558.761px;" height="559"></p><p><strong><span style="font-size: 10pt;">Fig 3. Customer import configuration.</span></strong></p><p><br></p><p>If your customers exist in Westcoast Cloud but not in Halo you do not need to configure mappings, they will be created in Halo upon import and then added to the mappings table.&nbsp;</p><p><br></p><p>You can also have customers that are created from a Westcoast Cloud import have a chosen Top Level using the &#39;Top Level for New Customers&#39; field.&nbsp;</p><p><br></p><p>Update the Customer&#39;s main Site address in Halo when an existing Customer is imported from Westcoast Cloud - When this is enabled the customer in Halo will have their main site address updated to match the address against this customer in Westcoast Cloud. If disabled address information will not be updated.&nbsp;</p><p><br></p><p>Now you are ready to import your customers, to do this hit the &#39;Import customers&#39; button then hit &#39;start.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Importing Subscriptions&nbsp;</span></strong></p><p>Subscriptions can be imported for any Westcoast Cloud customer which has been mapped. When importing the &#39;Customer Subscriptions to Import&#39; field can be used to determine which subscriptions can be imported. When this is set use the &#39;Import Subscriptions&#39; button to import the subscriptions.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY5ZTAyZjcyLTlhYmMtNDA0OC05ZWM1LWNhNGQyZTMzNjU2MCJ9.6kz1PIzzKgGWdaifwUGV_dy9RiEIllVplLxP7sKD1FM" class="fr-fic fr-fil fr-dib" width="1026" height="181"></p><p><strong><span style="font-size: 10pt;">Fig 4. Import subscriptions.</span></strong></p><p><br></p><p id="isPasted">The end date of an imported subscription will use the contract end date if there is no subscription end date.</p><p><br></p><p><strong><span style="font-size: 14pt;">Importing on a Schedule</span></strong></p><p>To have your customer and/or subscription data be imported from Westcoast automatically on a scheduled basis enable the Halo integrator for the integration using the setting shown in figure 5. Once this is enabled you will need to set which entities are imported on a schedule by adding them to the &#39;Entities to Sync&#39; field.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZkOTAxYzRmLWYwMTctNGEyZS04NWE5LTkxNjdmYTJlZTJhMiJ9.J5tC-aIZ0EsWIvJFuTqobS_Aw5aXn61MfU9NnQvcA_Y" class="fr-fic fr-fil fr-dib" width="883" height="350"></p><p><strong><span style="font-size: 10pt;">Fig 5. Enable Halo integrator for integration</span></strong></p><p><br></p><p>The Halo integrator will run the sync on a daily schedule for this integration.&nbsp;</p><p><br></p><p>If using the Halo integrator you will be able to use the setting &#39;Deactivate Licences in Halo when they are deleted from Westcoast (Halo Integrator only)&#39;.&nbsp;</p><p><br></p><p><strong>Deactivate Licences in Halo when they are deleted from Westcoast (Halo Integrator only)</strong> - When enabled subscriptions will be made inactive in Halo when they are deleted in Westcoast. When disabled subscriptions will still be made inactive in Halo when made inactive in Westcoast but if they are deleted their count will be set to 0 but their status will not update.</p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.