<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 Ingram Micro Cloud/Ingram Integration?</strong></p><p><strong>- Enabling the Module</strong></p><p><strong>- Configuring the Module</strong></p><p><strong>- Client Imports</strong></p><p><strong>- Subscription Imports</strong></p><p><strong>- Halo Integrator</strong></p><p><strong>- Supported Regions</strong></p><p><br></p><p><br></p><p><strong>Related Guides:</strong></p><ul><li><a href="https://usehalo.com/halopsa/guides/2508" target="_blank" rel="noopener noreferrer"><strong>Licences/Subscriptions Overview</strong></a></li></ul><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">What is the Ingram Micro Cloud Integration?</span></strong></p><p>Integrating Ingram Micro with Halo will allow for Clients and their associated subscription counts to be imported into Halo. The Ingram Micro Cloud integration is also a multi-tenanted integration, allowing you to connect multiple Ingram Micro Cloud tenants to your instance of Halo.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Module</span></strong></p><p>Within Configuration > Integrations > Distributions, you will find a 'Cloud Blue' option:</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFjYjE1Zjc1LWI0OWEtNGY0Ny05NzdkLWYxOTRjOGY1Yzc2YSJ9.HuUykvFmFXpWYvM5ZFCj0B-zFN0xq4SoparWvgYv9Bw" class="fr-fic fr-fil fr-dib" width="320" height="174"></p><p><strong><span style="font-size: 10pt;">Fig 1. Ingram Micro module.</span></strong></p><p><br></p><p><strong>NB: While the module name is currently set as 'Cloud Blue', this is in fact Ingram Micro Cloud.</strong></p><p><br></p><p>Ensure this module is enabled to leverage the functionality once connected.</p><p><br></p><p><strong><span style="font-size: 14pt;">Configuring the Module</span></strong></p><p>Within this module, you will see an option to click into your tenants, clicking into this will initially open an empty page. Add a new Tenant via clicking 'New' (Top RHS). Upon adding a new Tenant, you will first be presented with the details required to connect the Ingram Micro Cloud tenant with Halo.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI2ZjIxMDE3LTAyZjItNDRmZC1hYTUzLTZiYTAwMDk3ZTg2OCJ9.1dGJaFa5I8FpFxAZB4G8cBAqdmIt8ZhnGIckmQY1hXU" class="fr-fic fr-fil fr-dib" width="1097" style="width: 1097px; height: 208.384px;" height="208.384"></p><p><strong><span style="font-size: 10pt;">Fig 2. Setup configuration.</span></strong></p><p><br></p><p>Here, you will need to input your API URL, Marketplace location (in lower case), Username/Password & Subscription key. </p><p id="isPasted"><br></p><p><strong><span style="font-size: 12pt;">Obtaining connection Details in Ingram</span></strong></p><p>The A<span style="font-size: 11pt;">PI URL, Username and Subscription key required for connection can be obtained from the Marketplace API section of the Ingram Micro Xvantage integrations hub. The URL you login to to access the hub will vary based on your region, however, this follows the format:</span></p><p><span style="font-size: 11pt;"><a data-fr-linked="true" href="https://REGIONHERE-new.ingrammicro.com/cep/app/loginSO">https://REGIONHERE-new.ingrammicro.com/cep/app/login</a> (regions 9-12) or <a data-fr-linked="true" href="https://REGIONHERE.new.ingrammicro.com/cep/app/login " id="isPasted">https://REGIONHERE.ingrammicro.com/cep/app/login</a> (regions 1-8) depending on the region you are in. </span></p><p><br></p><p>See the end of this guide for all the regions this integration is supported in and the region code used.</p><p><br></p><p>For example, UK customers would use <a data-fr-linked="true" href="https://uk-new.ingrammicro.com/cep/app/login" id="isPasted">https://uk-new.ingrammicro.com/cep/app/login</a></p><p><br></p><p>Once you have logged into this hub navigate to 'My Business' > 'Cloud Services' (opens a new window)> Markeplace API. </p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhMzhmNWI5LTA1MmQtNDBmOS05NDgwLWU3MDZlYmJhZTYzOSJ9.IVyLvWiijsBWm0wyLwCF7ZdW0K8zq0EpPJY7cI1JUCg" class="fr-fic fr-fil fr-dib" width="494" style="width: 496px; height: 690.796px;" height="691"></p><p><strong><span style="font-size: 10pt;">Fig 3. Cloud services in Xvantage portal</span></strong></p><p><br></p><p>Here, you will see the API URL, Username and subscription key needed. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA0MjQxZTQzLTM3MGYtNDA1YS1iOThkLWQ0NGY2YTRiOGY2OSJ9.2X7zb9_Ito0TD1QTalSzqERPXtTMo0FEhPDMNEVpncY" class="fr-fic fr-fil fr-dib" width="778" style="width: 780px; height: 217.742px;" height="218"></p><p><strong><span style="font-size: 10pt;">Fig 4. Subscription information in Ingram</span></strong></p><p><br></p><p>Once obtained copy and paste these into the integration setup page in Halo (figure 2). Then enter the password for the account in Ingram used to obtain these credentials along with the region of your marketplace (see the end of this guide for region codes).</p><p><br></p><p><strong><em>Note: If you are authenticating the connection using an API user, rather than your own account, do not use the username given to you on the Marketplace API page. Instead use the username and password of the API user to authenticate the connection (enter into Halo). </em></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Client Imports</span></strong></p><p>Below these options, you will find the Client import configuration.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc3MGFiMjc4LWM0OTYtNDQxNy1iMWMxLWYwZjU4MGJlMzUwMSJ9.0_gW-fM5Ze8D6iuAIDjrQPkWjt5p1I_uI_GGJTSbNlo" class="fr-fic fr-fil fr-dib" width="949" style="width: 949px; height: 416.703px;" height="416.703"></p><p><strong><span style="font-size: 10pt;">Fig 5. Client imports.</span></strong></p><p><br></p><p>First and foremost you will find a 'Mapping Table' - here, you can add mappings between Ingram Micro clients and Halo customers. Mappings will be automatically added for clients existing in both Ingram Micro Cloud & Halo that have the same name (thus the purpose of the mapping table - to avoid client duplication if names between the two platforms do not match).</p><p><br></p><p>Below this, you have the option to determine the Top Level (Must be enabled from within Configuration > Users > General Settings) that imported clients will be placed under & an option to update the Main Site address for a client, when an existing Client in Halo is imported from Ingram Micro Cloud.</p><p><br></p><p><span style="font-size: 14pt;"><strong>Subscription Imports</strong></span></p><p>Below the Client Import configuration are the Subscription import options.</p><p><br></p><p><strong><em>Note: Subscriptions must have an associated product in Ingram/Cloudblue to be imported.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY1YTRiODc3LWY5MzktNDdkNy05ZGVmLWNiMDM1MDQ3NTdlMyJ9.1F-IcPNKYrUcx9XgHhDB_Cqbqk6B3rHFVffFa2h4PpM" class="fr-fic fr-fil fr-dib" width="838" style="width: 838px; height: 139.347px;" height="139.347"></p><p><strong><span style="font-size: 10pt;">Fig 6. Subscription imports.</span></strong></p><p><br></p><p>Subscriptions can be imported for a particular client, or imported for <em>all</em> clients. Once imported, Subscriptions can be found against a customer record via the 'Subscriptions' tab:</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjExYzNmYjQ5LTM4NzEtNDgwYi1hMWRhLWMzODViZDhmMGUzMCJ9.Y_qsmK-LfV3fYmUJgXeWqz4dFYMv_XYUnQT-PFxN378" class="fr-fic fr-fil fr-dib" width="399" style="width: 399px; height: 149.954px;" height="149.954"></p><p><strong><span style="font-size: 10pt;">Fig 7. Subscriptions tab on a customer.</span></strong></p><p><br></p><p><em><strong>Note: The order of the tabs in the above screenshot may differ from those in your instance.</strong></em></p><p><em><strong>Note: The subscriptions tab will only be presented if the 'Software Licencing' module is enabled in Configuration > Asset Management.</strong></em></p><p><br></p><p>The term of the subscription will also be imported and will be visible against the subscription in Halo. This will be imported in Microsoft notation format e.g. P1Y, P1M).</p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">Halo Integrator </span></strong></p><p>The Halo Integrator can be enabled for this Integration. This is enabled using the setting highlighted in Fig 8.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFlMDNkZTk4LTdiZjQtNDg1My1iY2NhLTMyYzk1MjYzZWIzMSJ9.leMlhyPrKNRy0jJKUtbZ-2iUQkNV1qw5YemqzSCW2cI" class="fr-fic fr-fil fr-dib" width="854" style="width: 856px; height: 570.011px;" height="570"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 8. Enable Halo Integrator</strong></span></p><p><br></p><p>Once enabled choose which entities you would like to be imported regularly, customers and/or subscriptions. The sync for this integration will run on a daily basis, so the entities will be updated daily.</p><p><br></p><p>There is a checkbox called "Deactivate Subscriptions in Halo when they are deleted from Cloud Blue (Halo Integrator only)" which will only show when the Integrator is enabled (<strong data-pasted="true">Fig 15</strong>). Selecting this will make subscriptions that have been deleted in Cloud Blue inactive in Halo during the import. </p><p> </p><p><strong><span style="font-size: 14pt;">Supported Regions</span></strong></p><p>The following regions support the use of this integration:</p><ol><li>usa (this is the region used in your Xvantage hub URL, but you will need to enter "us" as the Marketplace in Halo) </li><li>ca</li><li>mx</li><li>de</li><li>in</li><li>au</li><li>nz</li><li>mi</li><li>fr</li><li>it</li><li>uk</li><li>es</li></ol><p><em><strong>Note: The Supported Region 'mi' refers to Miami which runs on a different Marketplace to other locations in the US.</strong></em></p>
