Application Server Provisioning

Embed Size (px)

DESCRIPTION

broadsoft

Text of Application Server Provisioning

Application Server ProvisioningInterface SpecificationRelease 14.0 Document Version 6

220 Perry Parkway Gaithersburg, MD USA 20877 Tel +1 301.977.9440 Fax +1 301.977.8846 WWW.BROADSOFT.COM

BroadWorks Guide

Copyright NoticeCopyright 2008 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. 220 Perry Parkway, Gaithersburg, MD 20877. BroadSoft reserves the right to make changes without prior notice.

TrademarksBroadWorks and BroadWorks AssistantEnterprise, BroadWorks AssistantMobile, 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 PAGE 2 OF 78

2008 BROADSOFT, INC.

Document Revision HistoryRelease 14.0 14.0 14.0 14.0 Version 1 1 1 1 Reason for Change Updated document for re-branding. Deleted custom features. Updated section 5.2 to correct CLI level OCI/Reporting. Added Release 13 to 14 changes and updated transactions and authorizations. Edited document. Added information for OCI-P over SOAP. Edited and published document. Added note about invalid session IDs and dropped connections to section 2.2 Technical Summary (EV 48809). Edited changes and published document. Updated OSS interface information in section 1.1 Summary of Changes between Release 13.0 and Release 14.0 for EV 53540. Made small change to section 1.1 Summary of Changes between Release 13.0 and Release 14.0 for failed EV 53540. Added note to Domains in section 4.1 Base Configuration for EV 54703. Edited changes and published document. Updated transactions and authorizations for Release 14.sp4. Edited changes and published document. Added section 8.2 SOAP Sessions with more information regarding cookies and sessions. Added section 11.7 What is the JSESSION ID and who creates it? Edited changes and published document. Date March 6, 2006 May 17, 2006 June 20, 2006 August 16, 2006 Author Patricia Renaud Patricia Renaud Robb Surridge Bob Russell

14.0 14.sp2 14.sp2 14.sp2

1 2 2 3

September 2, 2006 May 3, 2007 May 18, 2007 May 31, 2007

Patricia Renaud Doug Crank Patricia Renaud Robb Surridge

14.sp2 14.sp2

3 4

June 21, 2007 October 2, 2007

Andrea Fitzwilliam Roberta Boyle

14.sp2

4

October 18, 2007

Roberta Boyle

14.sp2

4

October 23, 2007

Roberta Boyle

14.sp2 14.sp4 14.sp4 This change applies to 14.0 and all service packs 14.sp6

4 5 5 6

November 12, 2007 February 13, 2008 February 15, 2008 July 23, 2008

Andrea Fitzwilliam Bob Russell Andrea Fitzwilliam Steve Davis

6

August 26, 2008

Andrea Fitzwilliam

BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION

05-BD5114-00 PAGE 3 OF 78

2008 BROADSOFT, INC.

Table of Contents1 1.1 1.2 2 2.1 2.2 3 3.1 Overview ......................................................................................................................................7 Summary of Changes between Release 13.0 and Release 14.0 .............................................7 Summary of Changes between Release 12.0 and Release 13.0 .............................................7 OCI Provisioning Interface Overview ......................................................................................8 Functional Summary ....................................................................................................................8 Technical Summary......................................................................................................................8 OCI Provisioning Interface Details...........................................................................................9

Authorization Levels and Access Control....................................................................................9 3.1.1 Authorization Level ..............................................................................................................9 3.1.2 Error Message Example......................................................................................................9 3.2 Aggregate OCI Commands ...................................................................................................... 10 3.3 Upload Files within Transactions.............................................................................................. 10 3.3.1 Binary Upload Method...................................................................................................... 10 3.3.2 Indirect Upload Method .................................................................................................... 10 3.4 Validation.................................................................................................................................... 10 4 4.1 4.2 4.3 5 5.1 5.2 5.3 5.4 6 6.1 BroadWorks Hierarchy ............................................................................................................11 Base Configuration.................................................................................................................... 11 Department Configuration......................................................................................................... 12 Service Configuration ................................................................................................................ 12 OCI Reporting ...........................................................................................................................14 Access Control List.................................................................................................................... 15 Reporting Over TCP/IP ............................................................................................................. 15 Filtering OCI Messages............................................................................................................. 15 Omissions .................................................................................................................................. 16 XML Schema .............................................................................................................................17 XML Schema Layout................................................................................................................. 17 6.1.1 Base XML Schema........................................................................................................... 17 6.1.2 Application Server XML Schema..................................................................................... 17 6.1.3 OCI Reporting XML Schema ........................................................................................... 18 Message Examples ..................................................................................................................19

7 7.1

Group Add.................................................................................................................................. 19 7.1.1 Request............................................................................................................................. 19 7.1.2 Success Response........................................................................................................... 19 7.1.3 Error Response................................................................................................................. 19 7.2 Retrieve Groups in a Service Provider..................................................................................... 20 7.2.1 Request............................................................................................................................. 20 7.2.2 Response.......................................................................................................................... 20BROADWORKS APPLICATION SERVER PROVISIONING INTERFACE SPECIFICATION

05-BD5114-00 PAGE 4 OF 78

2008 BROADSOFT, INC.

8 8.1 8.2 8.3 8.4 8.5 9 9.1

OCI Provisioning Using SOAP ...............................................................................................21 BroadWorks OCI-P SOAP Interface ........................................................................................ 21 SOAP Sessions......................................................................................................................... 23 Trace Example........................................................................................................................... 23 Secure SOAP ............................................................................................................................ 25 Troubleshooting SOAP ............................................................................................................. 25 8.5.1 Common Problems........................................................................................................... 26 Backwards Compatibility ........................................................................................................28 OCI Reporting Implications ................................................................................