This article details how to use Citrix Intelligent Traffic Management (ITM) as a CDNs score provider for Streamroot COMPASS™ (also known as CDN Orchestrator since our acquisition by CenturyLink).
A CDN score provider is an API responsible for providing Streamroot Compass with QOS and metadata around each CDN (host, current bandwidth, availability rate, business rules ...).
This data, often tailored to the ISP and/or Country of the viewer, allows Streamroot Compass to make better delivery decision right from the start of the session and to guarantee the best possible start-up experience to your viewers.
Step 1: Integrate Compass Client
Integrate Streamroot Compass into your webpage. Following this tutorial to do so.
Step 2: Configure Citrix Openmix
Configure your CDNs and business rules in Citrix Dashboard. Check out Citrix Openmix documentation here.
Step 3: Create your Compass Property
Create your Compass property or edit the default Compass property and choose Citrix as CDN Score Provider.
- Copy your customerID and appID from your ITM dashboard and fill them in.
- You don't need to select a CDN list if you are using Citrix ITM. You can optionally set one up as a fallback. Check Step 4 to do so.
| Parameter name | Mandatory | Description |
|---|---|---|
| Property Name | Yes | The name (used as a unique identifier) of your Compass property. Two properties can't have the same name. |
| CDN Score Provider | Yes | Choose Citrix as your provider and have Compass use Citrix OpenMix to gather initial scores for CDNs. |
| CDN List | No | The name of the CDN list that you want this property to use. Optional if you are using Citrix ITM as your CDN Score Provider. Check Step 4 if you want to use it as a fallback. |
| CustomerID | Yes | Your Citrix ITM Customer ID. It can be found in your Openmix dashboard and is part of your Openmix application url. |
| AppID | Yes | Your Citrix ITM Application ID. It can be found in your Openmix dashboard and is part of your Openmix application url. |
| Activation Ratio | Yes | Activation Ratio enables Compass on a certain percentage of your traffic. It can be used for testing and progressive production ramp-up. If the activation is 20%, 20% of viewers who have Compass in their page will turn it on. |
Step 4 (Optional): Configure your CDNs in Streamroot Dashboard
This step is optional as Citrix ITM will provide Compass with all the configuration required to use your CDNs.
Nonetheless, you can configure your CDNs in Streamroot Dashboard to have a fallback in case Citrix ITM API doesn't answer.
Follow this page to configure your CDNs.