Citrix CPSM Integratin Specificatin
Cntents 1. Intrductin... 2 2. Activatin f the Integratin Layer... 3 3. Getting the Services Definitin... 4 3.1 Creating a Prduct Type per Lcatin... 5 3.2 Create Instance Prduct Types... 5 4. Creatin f Services Offerings... 5 5. Custmers Prvisining... 6 5.1 Creating a CPSM Custmer underneath a Reseller... 6 5.2 Sync a BSS Accunt with an existing CSPM Custmer... 6 5.3 Un-Syncing a BSS Accunt... 6 6. UC1 Service Prvisining... 7 7. UC2 Transactins Impersnatin... 8 8. UC3 - Pay-Per-Use Charges... 9 9. UC4 Multi-tiering... 12 1
1. Intrductin The purpse f this dcument is t describe the integratin mechanism between Interwrks Clud Platfrm and Citrix CludPrtal Services Manager (CPSM). The built-in integratin f Clud Platfrm with Citrix CPSM, enables the Citrix Service Prviders (CSPs) t take advantage f an advanced business supprt system and create a unified envirnment fr prvisining and billing clud services. The main integratin highlights are the fllwing: Creatin f services fferings based n CPSM supprted services. The integratin layer reads the services definitins in CludPrtal and creates the apprpriate prduct types in Clud Platfrm. Then, based n these prduct types, the prduct manager in Clud BSS can create different fferings fr the same service. Each service ffering will have specific characteristics, a fully defined pricing plicy (retail price, vlume discunts, setup fee, extra charges etc.) and a set f available add-ns. Custmer Prvisining. The integratin layer supprts tw-way sync between Clud Platfrm Accunts and CPSM custmers. Fr the resellers and custmers f CSP we supprt ne-way sync frm Clud Platfrm t CPSM. Fr the custmers f the reseller we supprt tw-say sync. When a reseller creates a new custmer is CPSM, this custmer is synced autmatically with Clud BSS. This ptin is available as part f the pay-per-use functinality. Service Prvisining. When a custmer service subscriptin is created in Interwrks Clud Platfrm, integratin layer cmmunicates with CludPrtal fr the prvisining f the service. The service prvisining in CludPrtal will be perfrmed based n subscriptin prperties. Service add-ns prvisining. Clud BSS supprts services add-ns that increase specific prperties f a service (e.g. the mailbx strage limit f the exchange service). When and addn is applied t an active custmer subscriptin, the service resurces in CludPrtal will be increased by the values define in the add-n. Subscriptins and add-ns suspensin / cancellatin / deletin. When ne f these actins is perfrmed in Clud BSS, the resurce limits f the service in CludPrtal will be decreased accrdingly. In cases where a usage check must be perfrmed (e.g. when yu cancel an Exchange user plan) the system will cancel nly the unused resurces. Resellers supprt. Clud Platfrm supprts t have yur reseller s custmers in Clud BSS. Yu can create subscriptins fr these custmers that are prvisined autmatically t CPSM and we als generate a usage analysis reprt per reseller s end custmer. We als supprt transactin impersnatin (i.e. the reseller can place in CSP marketplace an rder n behalf f ne f his custmer). 2
Usage based Billing. The integratin layer cmmunicates with CPSM ecmmerce SDK fr getting the usage data. These data are imprted in Clud BSS fr charging the custmer. We cllect usage data in a daily basis and we als cllect data nt nly fr CSP custmers and resellers but als fr reseller s end custmers. In the fllwing paragraphs we will see in detail the integratin architecture and the mst imprtant integratin requirements. 2. Activatin f the Integratin Layer The integratin layer is activated by setting up the cmmunicatin with CPSM XML API. All the prvisining related actins fr the custmers and the services are perfrmed by calling this API. The credentials that will be set they must belng t a CSP user that has the API access permissins enabled. During activatin yu can als enable and the cmmunicatin with CPSM ecmmerce SDK. In this case, Clud Platfrm will be able t gather usage data frm CPSM in rder t bill services in a pay-per-use basis. The last ptin that can be enabled is fr prviding usage analysis t yur resellers. If this ptin is selected, the Integratin layer will autmatically imprt in Clud BSS each new custmer the resellers add in CPSM, it will check which services have been prvisined t these custmers and will cllect usage data fr these services. Fr the reseller s end custmer, the integratin layer will gather data fr the services defined in activatin frm. Belw is a screensht f the activatin frm. 3
3. Getting the Services Definitin When the integratin layer has been activated, Clud Platfrm gets frm CPSM the definitin f the deplyed services. In general we get fr each service the custmer plans and the user plans the CSP administratr has defined and als the available resurces f each service. There are f curse and exceptins like Citrix Service where we als need and the cnfigured applicatins. The services we supprt are the fllwing: All the services that their prvisining is based n custmer and user plans. We have implemented a generic mechanism fr getting the definitin f this kind f services. We dn t supprt nly the ut-f-the-bx services that wrk that way (e.g. Hsted Exchange, Lync, Hsted Apps and Desktps etc.) but and the custmer defined services. Fr custm services, we first check their schema in CPSM t find ut what has been enabled and then we get the apprpriate infrmatin. Fr services that the prvisining is nt based nly n the custmer / user plans but they supprt multiple service instances r they have cnfiguratin setting, we created separate service managers fr getting their definitin. These services are: Citrix Service. Fr the Citrix service we get and the server cllectins and the applicatins defined in these cllectins SharePint 2010 service. Virtual Machine service File Sharing service Web Hsting service We use the services definitin infrmatin we get frm CPSM in rder t create the apprpriate prduct types. The attributes f these prduct types crrespnd t the plans / resurces / cnfiguratin settings each service has in CPSM. A typical example is Hsted Exchange and belw is the list f the prduct type attributes. Prperty Name Value Type Cmments Exchange Package List field It cntains the custmer plans f the Hsted Exchange Service. It s a list field because each custmer can have nly ne custmer plan assigned. Plan A Number Fr each Exchange Service user plan, we create a numeric Plan B Number field. The value f this field will be the user limit f the user plan in CPSM. Mailbx Strage (MB) Number These prperties crrespnd t service available resurces Public Flder (MB) in CPSM. 4
The abve paradigm applies t all services that use plans. Fr the rest services the prduct types are enriched t supprt service special requirements. Fr example, fr the Citrix service we create a prperty fr each applicatin. 3.1 Creating a Prduct Type per Lcatin The integratin layer understands and the lcatins that have been setup in CPSM. During integratin activatin, the administratr defines fr which lcatins the integratin will be active. Then, we get the services definitins frm all lcatins and we create a prduct type fr each service / lcatin cmbinatin. This is necessary because the custmer and user plans may differ per lcatin. Fr understanding fr which lcatin is a prduct type, we use the naming cnventin <Service Name> - <Lcatin Name>. An exceptin t this apprach is the Citrix Service. Fr this service we dn t create a prduct type per lcatin but per lcatin / server cllectin cmbinatin. This is necessary because the applicatins set is different per server cllectin. 3.2 Create Instance Prduct Types There are services that the prvisining mechanism in CPSM is different when we prvisin the service t a reseller r t custmer. Fr example, the SharePint service when is prvisined t a reseller we must define which custmer plans are available and sme quta fr the number f SharePint instances his custmers can create. On the ther hand, when the SharePint service is prvisined t a custmer, a SharePint instance is created. Fr such services we create tw prduct types per lcatin: ne fr the resellers and ne fr the custmers. The naming cnventin we are using in such cases is <Service Name> - <Lcatin Name> - Reseller and <Service Name> - <Lcatin Name> - Instance. 4. Creatin f Services Offerings Since we have the crrespndent prduct types in place, the prduct manager can create in Clud BSS different fferings fr the same service. Each service ffering will have specific prperties, a fully defined pricing plicy (retail price, vlume discunts, setup fee, extra charges etc.) and a set f available addns. If fr example the CSP has tw types f mailbxes, the crrespndent user plans will have be defined in CPSM (suppse it s user plan A and user plan B). As we explained befre, the prduct type fr the Exchange Service will have a numeric prperty fr each plan. S, the prduct manager will create the exchange ffering as belw: Prduct User plan A. It will be f type Hsted Exchange Lcatin X and it will have the fllwing prperties: Exchange Package. One f the available custmer plans 5
User plan A = 1. This value means that when this service is prvisined t CPSM the user limit fr plan A will be set t 1. User plan B=0 Mailbx Strage (MB) = 0. This prperty is used fr giving extra strage Public Flder (MB) = 0. This prperty is used fr giving extra strage fr public flders. Prduct User plan B. It will be als f type Hsted Exchange Lcatin X but the prperty User Plan A will be 0 and the prperty User Plan B will be 1. We will nt describe in detail hw yu setup the pricing plicy since this dcument is fcused n integratin layer. 5. Custmers Prvisining When a new accunt is created in Clud BSS, it can be synced with CPSM by setting his Synchrnizatin Optins. These are the custmer cde, his dmain, if he is a reseller r a custmer (his rle) and frm which lcatin he will cnsume resurces. If he is a reseller, the system displays the available reseller services that can be prvisined t the reseller. The default behavir f the integratin layer, is the new CSPM custmer t be created underneath the rt reseller (i.e. as direct custmer / reseller f the CSP). During prvisining, we als create and an admin user based n accunt s primary cntact details. 5.1 Creating a CPSM Custmer underneath a Reseller If the ptin fr prviding usage analysis t the reseller has been enabled, the integratin layer will imprt in Clud BSS the resellers end custmer autmatically. But this actin can be als perfrmed and manually. This can be accmplished by defining that the custmer is billed t reseller. If an accunt has as Bill t Accunt a CPSM Reseller, then during prvisining the custmer will be created underneath his reseller and nt as a direct custmer f the Service Prvider. 5.2 Sync a BSS Accunt with an existing CSPM Custmer A BSS accunt can be synced with an existing CPSM custmer by entering the cde f the CSPM custmer in sync ptins. In this case, the integratin layer des nt create a new custmer in CPSM but it syncs the BSS Accunt with the existing CPSM custmer. 5.3 Un-Syncing a BSS Accunt This actin is available nly fr synced Accunts with n active subscriptins. This actin breaks the relatin between BSS and CPSM but can be perfrmed nly fr custmers with n subscriptins in BSS. 6
6. UC1 Service Prvisining In the fllwing paragraphs we will examine sme use cases that cver mst f the integratin functinality. We will start with the mst cmmn use case, hw a service is prvisined in CPSM when an rder is executed in Clud Platfrm. Primary Actr: End Custmer Supprted Actr: Accunt Manager Descriptin: A custmer can buy frm CSP a clud service and the service is prvisined autmatically in CPSM. Primary Flw: 1. The custmer enters CSP Marketplace and places an rder. 2. Clud BSS creates services subscriptins that include all billing related parameters. 3. Integratin layer will autmatically prvisin rdered services in CPSM. The flw that will be executed will be the fllwing: a. Integratin layer checks if the rdered service is already prvisined t custmer in CPSM (i.e. the custmer has already mailbxes and bught mre) b. If it is nt prvisined, integratin layer will prvisin the service using the values f the prduct prperties. c. If it is already prvisined, the integratin layer will increase (delta actin) the quta in CPSM (i.e., the limits f the user plans, the values f the resurces) All the prvisining actins are perfrmed by calling SET actins frm CPSM XML API. The calls are asynchrnus and the prvisining is marked as cmpleted when we receive the crrect status f the XML API. 4. Every subscriptins update (increase / decrease resurces, cancellatin) will be mirrred autmatically t CPSM. Alternative Flw 1: Services can be bught and frm a CPSM reseller. The reseller has the fllwing ptins during the checkut prcess. 1. T use the rdered services fr reselling. In this case the integratin layer will increase the quta in the Reseller Service. 2. T use the rdered services fr persnal usage. In this case the primary flw will be executed and the rdered services will be prvisined t reseller. Alternative Flw 2: The use case can als be executed by an Accunt Manager frm inside Clud BSS. Belw is a diagram that explains the use case. 7
7. UC2 Transactins Impersnatin Primary Actr: Reseller Descriptin: A reseller enters CSP marketplace and places an rder n behalf f ne f his endcustmers. Basic Flw: 1. The reseller enters CSP marketplace and places an rder. During checkut he specifies if the rder is fr an existing custmer r a new. 2. If the rder is fr a new custmer, CludPlatfrm creates a new accunt and prvisins it in CPSM underneath reseller. In BSS, the reseller is set as the Bill t Accunt f the custmer 8
3. A subscriptin is created fr each rder service and all these subscriptins are marked that are billed t reseller. 4. Integratin layer executes a duble prvisining in CPSM. a. Increases the reseller resurces accrding t rder quantities b. Prvisins the services t the end custmer. Alternative Flw: The use case can als be executed by an Accunt Manager frm inside Clud BSS. 8. UC3 - Pay-Per-Use Charges This use case explains hw the integratin layer handles the services that must be charged in a pay-peruse mde. Primary Actrs: CSPs and their resellers Descriptin: CSP resellers prvisin services t their custmers frm inside CPSM. The integratin layer gets the usage data frm CPSM and the resellers are charged based n what services their custmers have used. Basic Flw: The basic flw is executed when the ptin fr prviding usage analysis t the resellers has been enabled. 1. The Chargeback Data Cllectr Service runs in daily basis 9
2. It checks if new custmers have been prvisined underneath the resellers in CPSM. These new custmers are imprted in Clud BSS and are marked that are charged t the reseller. 3. It checks which services have been prvisined t these new custmers. Fr each service the apprpriate pay-per-use subscriptin is created (the PPU subscriptin is the trigger fr the cllectr service t search fr data, see step 6) 4. It checks if new services have been prvisined t existing resellers custmers. Fr these services the apprpriate pay-per-use subscriptins are created in Clud BSS. 5. It checks if there are custmers that have been disabled / de-prvisined in CPSM r services that have been de-prvisined. If a custmer has been disabled / de-prvisined all his subscriptins will be cancelled in BSS. The same applies t the services as well. If a service has been de-prvisined, the crrespndent subscriptin in BSS will be cancelled. 6. The purpse f the abve steps is t have in BSS an updated set f PPU subscriptins. Nw, the Cllectr service will request frm CPSM ecmmerce SDK usage data fr these subscriptins. The usage data we can get are the fllwing: Service Quantity Billing Unit Services that are prvisined using custmer and user plans Cunt f Prvisined Users Cunt f Prvisined Custmer Per User Plan Per Custmer Plan Citrix Cunt f Applicatins Prvisined t Users Per Applicatin Sharepint2010 Cunt f Prvisined User Per User Cunt f Prvisined Site Per Site Virtual Machine Cunt f Prvisined Virtual Machines Per Machine 7. The usage data are related with the PPU subscriptins. 8. The invices are generated based n the usage data. These invices include and analysis per end custmer. Alternative Flw 1: The alternative flw is executed when the ptin fr prviding usage analysis t resellers is nt enabled. 1. Fr every service the reseller is charged based n usage, a PPU subscriptin is created manually in BSS. 2. The Cllectr service requests frm CPSM ecmmerce SDK usage data fr these subscriptins. Because these PPU subscriptins are related with the reseller, the cllectr service searches fr usage data in recursive mde by checking reseller s custmers and sub-resellers. 10
Alternative Flw 2: Usage based charges can be applied and t enterprise custmers. Yu can relate PPU subscriptins with the enterprise custmers and the Cllectr service will gather usage data fr these subscriptins. 11
9. UC4 Multi-tiering Clud Platfrm has built-in supprt fr channels. If the integratin layer is enabled, the resellers f the Service Prvider can have access t their wn instance f Clud Platfrm that will be ppulated with their custmers and their subscriptins. Primary Actr: Citrix Service Prvider Descriptin: CSP ffer t his resellers their wn Clud Platfrm instance fr managing their custmers. Basic Flw: 1. CSP creates a Clud Platfrm reseller and specifies which services he can resell 2. A Clud Platfrm instance is created fr the reseller. His instance includes: a. The service catalg his CSP has selected. b. His custmers and their subscriptins. This infrmatin is derived frm Service Prvider Clud BSS. They are the custmers that integratin layer maintains in rder t be able t prvide usage analysis per reseller. 3. Reseller has nw a fully peratinal CludPlatfrm that includes als and a marketplace, fr managing his custmers, their subscriptin and all the billing related actins. 12