Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Application Server Provisioning Interface Specification Release 19.0 Document V

Application Server Provisioning Interface Specification Release 19.0 Document Version 1 9737 Washingtonian Boulevard, Suite 350 Gaithersburg, MD 20878 Tel +1 301.977.9440 WWW.BROADSOFT.COM BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC. PAGE 2 OF 125 BroadWorks® Guide Copyright Notice Copyright © 2012 BroadSoft, Inc. All rights reserved. Any technical documentation that is made available by BroadSoft, Inc. is proprietary and confidential and is considered the copyrighted work of BroadSoft, Inc. This publication is for distribution under BroadSoft non-disclosure agreement only. No part of this publication may be duplicated without the express written permission of BroadSoft, Inc. 9737 Washingtonian Boulevard, Gaithersburg, MD 20878. BroadSoft reserves the right to make changes without prior notice. Trademarks BroadWorks® and BroadWorks Assistant–Enterprise™, BroadWorks Call Center™, BroadWorks Communicator™, BroadWorks Receptionist™, and BroadWorks Deployment Studio™ are trademarks of BroadSoft, Inc. Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft Corporation. Other product names mentioned in this document may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. This document is printed in the United States of America. BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC. PAGE 3 OF 125 Document Revision History Release Version Reason for Change Date Author 14.0 1 Updated document for rebranding. March 6, 2006 Patricia Renaud 14.0 1 Deleted custom features. May 17, 2006 Patricia Renaud 14.0 1 Updated section 5.2 to correct CLI level OCI/Reporting. June 20, 2006 Robb Surridge 14.0 1 Added Release 13 to 14 changes and updated transactions and authorizations. August 16, 2006 Bob Russell 14.0 1 Edited document. September 2, 2006 Patricia Renaud 14.sp2 2 Added information for OCI-P over SOAP. May 3, 2007 Doug Crank 14.sp2 2 Edited and published document. May 18, 2007 Patricia Renaud 14.sp2 3 Added note about invalid session IDs and dropped connections to section 3.2 Technical Summary (EV 48809). May 31, 2007 Robb Surridge 14.sp2 3 Edited changes and published document. June 21, 2007 Andrea Fitzwilliam 14.sp2 4 Updated OSS interface information in section 1.12 Changes for Release 14.0 for EV 53540. October 2, 2007 Roberta Boyle 14.sp2 4 Made small change to section 1.12 Changes for Release 14.0 for failed EV 53540. October 18, 2007 Roberta Boyle 14.sp2 4 Added note to Domains in section 5.1 Base Configuration for EV 54703. October 23, 2007 Roberta Boyle 14.sp2 4 Edited changes and published document. November 12, 2007 Andrea Fitzwilliam 14.sp4 5 Updated transactions and authorizations for Release 14.sp4. February 13, 2008 Bob Russell 14.sp4 5 Edited changes and published document. February 15, 2008 Andrea Fitzwilliam 15.0 1 Updated document to 15.0. June 17, 2008 Bob Russell 15.0 1 Edited changes from Release 14.0 and published document. July 14, 2008 Andrea Fitzwilliam 15.0 2 Added section 9.2 SOAP Sessions with more information regarding cookies and sessions. Added section 12.7 What is the JSESSION ID and who creates it? July 23, 2008 Steve Davis 15.0 2 Edited changes and published document. August 26, 2008 Andrea Fitzwilliam 16.0 1 Updated document for Release 16.0. June 9, 2009 Bob Russell 16.0 1 Updated section 7 XML Schema for EV 95752. July 9, 2009 Roberta Boyle BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC. PAGE 4 OF 125 Release Version Reason for Change Date Author 16.0 1 Edited changes and published document. July 15, 2009 Andrea Fitzwilliam 16.0 2 Updated the following sections for EV 100472: 12.4 Is there an OCI-P Demo Client? 12.5 Is there an OCI-P SOAP Demo Client? November 25, 2009 Patricia Renaud 17.0 1 Updated document for Release 17.0. March 10, 2010 Tony Pilote 17.0 1 Edited and published document. March 24, 2010 Margot Hovey-Ritter 17.0 2 Added a section describing requests and responses for EV 110810. August 25, 2010 Steve Davis 17.0 2 Updated section 3.1 Functional Summary for EV 117130. August 31, 2010 Goska Auerbach 17.0 2 Updated section 11.1 MD5 Encrypted Password Calculation for EV 118637. September 23, 2010 Goska Auerbach 17.0 2 Edited changes and published document. November 2, 2010 Andrea Fitzwilliam 17.0 3 Updated document for EV 120558. December 15, 2010 Goska Auerbach 17.0 3 Updated links to Xchange. January 27, 2010 Goska Auerbach 17.0 3 Updated section 10 Backward Compatibility. February 21, 2011 Engineering 17.0 3 Removed unnecessary BCCT references for EV 128395. Updated the demo client information. February 24, 2011 Engineering 17.0 3 Made minor editorial changes. February 25, 2011 Goska Auerbach 17.0 3 Edited changes and published document. April 12, 2011 Jessica Boyle 17.0 4 Updated section 10 Backward Compatibility for EV 141758. May 16, 2011 Engineering 17.0 4 Edited changes and published document. July 13, 2011 Jessica Boyle 17.0 5 Updated section 3.1 Functional Summary for EV 145537. July 14, 2011 Engineering 17.0 5 Edited changes and published document. July 26, 2011 Jessica Boyle 18.0 1 Updated document for Release 18.0. August 31, 2011 Engineering 18.0 1 Edited changes and published document. October 4, 2011 Andrea Fitzwilliam 18.0 2 Updated sections 10.3 OCI Commands Removed in Release 18.0 and 10.5 OCI Commands Removed in Release 17.0. October 27, 2011 Engineering 18.0 2 Edited changes and published document. October 31, 2011 Andrea Fitzwilliam BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC. PAGE 5 OF 125 Release Version Reason for Change Date Author 19.0 1 Updated document for Release 19.0 and EV 162887 and 154303. October 15, 2012 Engineering 19.0 1 Edited changes and published document. November 6, 2012 Patricia Renaud BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC. PAGE 6 OF 125 Table of Contents 1 Summary of Changes .............................................................................................................. 10 1.1 Changes for Release 19.0, Document Version 1 .................................................................... 10 1.2 Changes for Release 18.0, Document Version 2 .................................................................... 10 1.3 Changes for Release 18.0, Document Version 1 .................................................................... 10 1.4 Changes for Release 17.0, Document Version 5 .................................................................... 10 1.5 Changes for Release 17.0, Document Version 4 .................................................................... 10 1.6 Changes for Release 17.0, Document Version 3 .................................................................... 10 1.7 Changes for Release 17.0, Document Version 2 .................................................................... 11 1.8 Changes for Release 17.0, Document Version 1 .................................................................... 11 1.9 Changes for Release 16.0, Document Version 2 .................................................................... 11 1.10 Changes for Release 16.0, Document Version 1 .................................................................... 11 1.11 Changes for Release 15.0, Document Version 1 .................................................................... 11 1.12 Changes for Release 14.0 ........................................................................................................ 11 1.13 Changes for Release 13.0 ........................................................................................................ 11 2 Overview .................................................................................................................................... 13 3 Overview of Open Client Interface-Provisioning ................................................................. 14 3.1 Functional Summary ................................................................................................................. 14 3.2 Technical Summary ................................................................................................................... 14 4 Details of Open Client Interface-Provisioning ...................................................................... 15 4.1 Authorization Levels and Access Control ................................................................................. 15 4.1.1 Authorization Level ........................................................................................................... 15 4.1.2 Error Message Example ................................................................................................... 15 4.2 Requests and Responses ......................................................................................................... 16 4.3 Aggregate OCI Commands ...................................................................................................... 16 4.4 Upload Files within Transactions .............................................................................................. 16 4.4.1 Binary Upload Method ...................................................................................................... 16 4.4.2 Indirect Upload Method .................................................................................................... 17 4.5 Validation.................................................................................................................................... 17 5 BroadWorks Hierarchy ............................................................................................................ 18 5.1 Base Configuration .................................................................................................................... 18 5.2 Department Configuration ......................................................................................................... 19 5.3 Service Configuration ................................................................................................................ 19 6 OCI Reporting ........................................................................................................................... 21 6.1 Access Control List .................................................................................................................... 22 6.2 Reporting Over TCP/IP ............................................................................................................. 22 6.3 Filtering OCI Messages ............................................................................................................. 22 6.4 Omissions .................................................................................................................................. 23 7 XML Schema ............................................................................................................................. 24 7.1 XML Schema Layout ................................................................................................................. 24 BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC. PAGE 7 OF 125 7.1.1 Base XML Schema ........................................................................................................... 24 7.1.2 Application Server XML Schema ..................................................................................... 24 7.1.3 OCI Reporting XML Schema ........................................................................................... 25 7.2 Schema Zip Files ....................................................................................................................... 25 8 Message Examples .................................................................................................................. 26 8.1 Group Add .................................................................................................................................. 26 8.1.1 Request ............................................................................................................................. 26 8.1.2 Success Response ........................................................................................................... 26 8.1.3 Error Response ................................................................................................................. 26 8.2 Retrieve Groups in Service Provider ........................................................................................ 27 8.2.1 Request ............................................................................................................................. 27 8.2.2 Response .......................................................................................................................... 27 9 Open Client Interface-Provisioning Using SOAP................................................................. 28 9.1 BroadWorks OCI-P SOAP Interface ........................................................................................ 28 9.2 SOAP Sessions ......................................................................................................................... 30 9.3 Trace Example ........................................................................................................................... 30 9.4 Secure SOAP ............................................................................................................................ 32 9.5 Troubleshooting SOAP ............................................................................................................. 33 9.5.1 Common Problems ........................................................................................................... 33 10 Backward Compatibility .......................................................................................................... 35 10.1 Deprecated Commands ............................................................................................................ 35 10.2 OCI Command Naming ............................................................................................................ 36 10.3 OCI Commands Removed in Release 19.0 ............................................................................ 36 10.4 OCI Commands Removed in Release 18.0 ............................................................................ 36 10.5 OCI Commands Removed in Release 17.0 ............................................................................ 36 10.6 OCI Commands Removed in Release 16.0 ............................................................................ 37 10.7 OCI Reporting Implications ....................................................................................................... 40 11 Log-in Process .......................................................................................................................... 41 11.1 MD5 Encrypted Password Calculation ..................................................................................... 41 12 Appendix A: Frequently Asked Questions .......................................................................... 42 12.1 What do acronyms mean? ........................................................................................................ 42 12.2 What are the recommendations? ............................................................................................. 42 12.3 How is the OCS configured? .................................................................................................... 43 12.3.1 OCS Configuration Steps ................................................................................................. 43 12.3.2 Application Server Configuration Steps ........................................................................... 44 12.4 Is there an OCI-P Demo Client? ............................................................................................... 44 12.5 Is there an OCI-P SOAP Demo Client? ................................................................................... 44 12.6 What is the session ID and who creates it? ............................................................................. 44 12.7 What is the JSESSION ID and who creates it? ....................................................................... 44 12.8 Can I send more than one OCI message in a single SOAP message? ................................ 45 12.9 What character encodings can I use for special characters? ................................................. 45 BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION 05-BD5114-00 ©2012 BROADSOFT, INC.