MITEL OPEN INTEGRATION GATEWAY (OIG): END- CUSTOMER DEVELOPMENT & LICENSING

Transcription

1 MITEL OPEN INTEGRATION GATEWAY (OIG): END- CUSTOMER DEVELOPMENT & LICENSING JULY, 2014

2 The infrmatin cnveyed in this dcument is cnfidential and prprietary t Mitel and is intended slely fr Mitel emplyees and members f Mitel s reseller channel wh specifically have a need t knw this infrmatin. If yu are nt a Mitel emplyee r a Mitel authrizedpartner, yu are nt the intended recipient f this infrmatin. Please delete r return any related material. Mitel will enfrce its right t prtect its cnfidential and prprietary infrmatin and failure t cmply with the freging may result in legal actin against yu r yur cmpany.

3 MITEL OPEN INTEGRATION GATEWAY (OIG): END-CUSTOMER DEVELOPMENT & LICENSING INTRODUCTION The purpse f this dcument is t prvide guidance t Mitel resellers and channel partners wh have custmers interested in building their wn custm call cntrl applicatins r ther integratins int MiVice Business, using the Mitel Open Integratin Gateway (OIG). OIG OVERVIEW Mitel OIG prvides a cmmn infrastructure layer fr single sign-n t current and future MiVice Business Web Services-based API Services, alng with administrative capabilities and netwrked sftware licensing and delivery via the Mitel Applicatins Management Center (AMC). Each Web Service is defined using the Web Services Descriptin Language (WSDL) frm Mitel, and is prvided using SOAP and XML r REST/JSON ver HTTPS. Custmer and 3rd-Party Partner (3PP) applicatins d nt require sftware frm Mitel t cmmunicate with a Mitel OIG. A third-party applicatin des nt need t integrate r cmpile-in any Mitel cde. Applicatin develpers are free t chse a prgramming language, a sftware develpment envirnment, an perating system, and a hardware platfrm. The Web Service mdel decuples the OIG sftware frm the third-party applicatin. CALL CONTROL SERVICE Mitel OIG ffers tw types f Call Cntrl API Services n MiVice Business. The Standard Call Cntrl Service feature set prvides a rich suite f client / user / desktp-fcused features required t meet the needs f a majrity f Mitel develpers and custmers fr Call Cntrl applicatin functinality, such as: Screen Pp Click-t-Dial and Desktp / First-Party Call Cntrl Basic CRM Integratin Embedded Web Apps These Standard Call Cntrl features allw an applicatin t mnitr and cntrl the telephny activity f Mitel physical and lgical devices (e.g., MiVice IP phnes) cnnected t a MiVice Business system (single nde r cluster). That is, the Standard Call Cntrl Service allws an applicatin t d what a user can d manually at a MiVice IP phne. The Advanced Call Cntrl Service feature set ffers develpers the ability t build sphisticated cntact center applicatins, including capabilities such as: ACD path and Ht Desk Agent functins Trunk, Ring & Hunt Grup, Cnference and MiVice Business feature mnitring Setting message waiting lamp and aut answer Third-party Call Cntrl Cntact Center CRM integratin 1 QUICK START GUIDE

4 DATA ACCESS SERVICE Mitel OIG als ffers Data Access API Services n MiVice Business. The OIG Data Access Service prvides a generic Read-Only SQL-like interface, enabling applicatins t read and get change ntificatins n MiVice Business cnfiguratin data related t Mitel physical and lgical devices (i.e., devices prgrammed r cnfigured in Mitel MiVice Business instances) including IP phnes, Persnal Ring Grups and line appearances n multi-line phnes. The Data Access Service allws applicatins t retrieve MiVice Business data that is needed when using ther Mitel OIG services (e.g., when an applicatin needs t knw the Device Number f a MiVice Business phne t create a mnitr using the OIG Call Cntrl Service). The OIG Data Access Service includes the fllwing specific capabilities: Allw applicatins t read cnfiguratin infrmatin frm MiVice Business databases, including: User Data: Details abut a phne and user cnfigured in a MiVice Business nde, including user authenticatin details, phne number, phne cnfiguratin, phne type, user assigned t phne, language displayed, number f lines, ht desk user infrmatin and status, user rles, COS & COR settings, etc. Grup Data: Detailed data abut Hunt Grups, COR Grups, Ring Grups, and Persnal Ring Grups, including grup member phne numbers, hunt / search algrithms used, MCD assciated with a grup, Ruting rules, etc. MCD Data: Detailed data abut MiVice Business ndes in the MiVice Business system cluster, including the MCD FQDN / IP address, name, unique ID, resiliency infrmatin, cluster infrmatin, etc. Prvide data abstractin thrugh applicatin use f SQL tables that prvide a simple high level rganizatin f MiVice Business cnfiguratin data (sample cde prvided). Receive and maintain data change ntificatins frm MiVice Business, and prvide data change ntificatin t applicatins. Prvide MiVice Business versin cntrl, i.e., reprt MiVice Business versin infrmatin, and enable applicatins t cnnect t multiple MiVice Business ndes with different versins. OBTAINING MORE INFORMATION ON OIG The latest OIG Develper Guide, Installatin & Maintenance (I&M) Guide, and Engineering Guidelines are available n the Mitel Prduct Dcumentatin prtal here. A Brchure and link t an OIG Primer are available here. It is recmmended that Mitel resellers with end-custmers interested in pursuing in-huse applicatin develpment and integratin using OIG begin by having the custmer review these materials, starting with the OIG Primer. MOVING AHEAD WITH AN OIG DEVELOPMENT PROJECT After getting familiar with OIG frm the materials available n MOL as nted abve, the prcess fr a Mitel endcustmer t get started with OIG applicatin develpment and deplyment is as fllws. Start with the ptinal Step 1, r prceed directly t Step 2: 1. Optinal In advance f jining MSA r purchasing OIG fr develpment purpses, rder the OIG 60- Day Free Trial (P/N ), and cnnect t existing custmer MiVice Business/MCD. Use this ne-time nn-renewable Trial t evaluate the OIG capabilities and applicatin develpment prcess at n charge. 2 QUICK START GUIDE

5 The 60-day Trial license includes access t develper dcumentatin, OIG sample applicatins, and supprt via MSA. See the Mitel Open Integratin Gateway (OIG) 60-Day Trial Quick Start Guide, here (n MOL at Hme / Prducts / UC Integratins / Mitel Open Integratin Gateway). Upn successful evaluatin f OIG using the 60-Day Trial, prceed t Step Mandatry Purchase MSA Crprate Develper Advanced Membership USD$2000/year, w/year 2+ renewal fees waived fr custmers wh maintain cntinuus SWAS cverage n their Mitel platfrms. Enrll at (Custmer enrlls and purchases membership directly frm MSA). Enables access t: OIG Develper Training & Certificatin (n additinal charge, but cmpletin is mandatry fr supprt eligibility). Develper Supprt Sample OIG cde & dcumentatin; develper diagnstic tls Applicatin registratin (required t deply OIG applicatins in a prductin envirnment) 3. Mandatry Purchase OIG sftware via Mitel reseller (see Nte 1): All OIG P/Ns are rderable via SWB. OIG Develper Guide, Engineering Guidelines, and Installatin & Maintenance Guide available n edcs. Mitel reseller must cmplete OIG I&M Training & Certificatin in rder t be eligible t pen a ticket with Mitel Prduct Supprt fr I&M assistance. Additinal infrmatin here (n MOL at Hme / Prducts / UC Integratins / Mitel Open Integratin Gateway). Optin A - OIG Sftware (assuming nly Standard Call Cntrl features are required see Nte 2): Mandatry One OIG Base Package per MCD r MCD cluster (physical OIG P/N , r virtual OIG P/N ) - $1000MLP The Base Packages include Standard Call Cntrl licensing fr 20 users, s fr applicatins supprting 20 r fewer users and using nly the Standard Call Cntrl features, the custmer can stp there. T supprt mre users, add Call Cntrl User licensing (P/N fr individual Users - $30/ea MLP; r with P/N fr a server license t enable the maximum number f Users - $1950MLP). Optinal Standard r Premium SWAS Optin B - OIG Sftware (assuming Advanced Call Cntrl features are required see Nte 3): Mandatry One OIG Base Package per MCD r MCD cluster (physical OIG P/N , r virtual OIG P/N ) - $1000MLP Add Advanced Call Cntrl User licensing (P/N fr individual Users - $65/ea MLP; r with P/N fr a server license t enable the maximum number f Users - $4875/MLP). 3 QUICK START GUIDE

6 Optinal Standard r Premium SWAS Nte 1: These requirements assume that the end-custmer develper will use the same OIG and MiVice Business/MCD platfrm fr bth develpment and testing. If the custmer intends t maintain a standalne lab/develpment/test envirnment, separate frm their prductin envirnment, they will als need t purchase an OIG Base Package (and additinal User Licensing, as necessary fr the testing activities) and MiVice Business/MCD fr their lab envirnment. P/Ns and pricing are the same regardless f whether the prducts are used fr prductin r lab purpses. Nte 2: See Standard Call Cntrl feature verview under abve Call Cntrl Service heading. Develpers shuld review the detailed licensing guidance in the OIG Call Cntrl Develper Guide (available n edcs and the MSA-n-MOL web prtal) fr differentiating between Standard and Advanced Call Cntrl capabilities, including specific feature descriptins and classificatins as Standard vs. Advanced, befre rdering r specifying OIG User licensing fr field deplyment. Nte 3: See Advanced Call Cntrl feature verview under abve Call Cntrl Service heading. Develpers shuld review the detailed licensing guidance in the OIG Call Cntrl Develper Guide (available n edcs and the MSA-n-MOL web prtal) fr differentiating between Standard and Advanced Call Cntrl capabilities, including specific feature descriptins and classificatins as Standard vs. Advanced, befre rdering r specifying OIG User licensing fr field deplyment. SAMPLE LICENSING & FEE SUMMARY OIG licensing and MSA fees fr tw example scenaris are summarized as fllws: 1. Sample Qute Custmer develping an OIG applicatin integratin with Standard Call Cntrl User Licensing fr deplyment n 20 user desktps Qty 1 - OIG Base Package Physical - P/N USD$1000 MLP MSA Crprate Develper Advanced membership - USD$2000 Ttal = USD$3000 MLP, nt including SWAS, MCD, r lab platfrm 2. Sample Qute Custmer develping an OIG applicatin integratin with Advanced Call Cntrl User Licensing fr deplyment n 200 user desktps Qty 1 - OIG Base Package Physical - P/N USD$1000 MLP Qty 1 OIG MCD Call Cntrl Adv Server License P/N USD$4875 MLP MSA Crprate Develper Advanced membership - USD$2000 Ttal = USD$7875 MLP, nt including SWAS, MCD, r lab platfrm Cntact MSAInf@mitel.cm fr mre infrmatin. 4 QUICK START GUIDE