Meeting Exchange 5.0 Client Registration Server
Stored Procedures for Database Connectivity Guide
04-602183 Issue 1 August 2007 Compas ID 126294
© 2007 Avaya Inc. All Rights Reserved. Third-party Components Certain software programs or portions thereof included in the Notice Product may contain software distributed under third party While reasonable efforts were made to ensure that the information agreements ("Third Party Components"), which may contain terms in this document was complete and accurate at the time of printing, that expand or limit rights to use certain portions of the Product Avaya Inc. can assume no liability for any errors. Changes and ("Third Party Terms"). Information identifying the copyright holders corrections to the information in this document may be of the Third Party Components and the Third Party Terms that incorporated in future releases. apply is available on Avaya's web site at: http://support.avaya.com/ThirdPartyLicense/ Documentation disclaimer For full information, please see the complete document, Avaya Avaya Inc. is not responsible for any modifications, additions, or Third Party Terms, Document number 04-601558. To locate this deletions to the original published version of this Documentation document on the website, simply go to unless such modifications, additions, or deletions were performed http://www.avaya.com/support and search for the document by Avaya. number in the search box. Link disclaimer Warranty Avaya Inc. is not responsible for the contents or reliability of any Avaya Inc. provides a limited warranty on this product. Refer to linked third party Web sites referenced elsewhere within this your sales agreement to establish the terms of the limited warranty. Documentation and Avaya does not necessarily endorse the In addition, Avaya’s standard warranty language, as well as products, services, or information described or offered within them. information regarding support for this product, while under We cannot guarantee that these links will work all of the time and warranty, is available through the following Web site: we have no control over the availability of the linked pages. http://www.avaya.com/support. License Avaya fraud intervention USE OR INSTALLATION OF THE PRODUCT INDICATES THE END USER'S ACCEPTANCE OF THE TERMS SET FORTH If you suspect that you are being victimized by toll fraud and you HEREIN AND THE GENERAL LICENSE TERMS AVAILABLE ON need technical assistance or support, call Technical Service Center THE AVAYA WEBSITE AT http://support.avaya.com/LicenseInfo/ Toll Fraud Intervention Hotline at +1-800-643-2353 for the United ("GENERAL LICENSE TERMS"). IF YOU DO NOT WISH TO BE States and Canada. Suspected security vulnerabilities with Avaya BOUND BY THESE TERMS, YOU MUST RETURN THE Products should be reported to Avaya by sending mail to: PRODUCT(S) TO THE POINT OF PURCHASE WITHIN TEN (10) [email protected]. DAYS OF DELIVERY FOR A REFUND OR CREDIT. For additional support telephone numbers, see the Avaya Web Avaya grants End User a license within the scope of the license site: http://www.avaya.com/support types described below. The applicable number of licenses and Trademarks units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is Avaya and the Avaya logo are registered trademarks of Avaya Inc. specified in the Documentation or other materials available to End in the United States of America and other jurisdictions. Unless User. "Designated Processor" means a single stand-alone otherwise provided in this Documentation, marks identified by "®," computing device. "Server" means a Designated Processor that "™" and "SM" are registered marks, trademarks and service hosts a software application to be accessed by multiple users. marks, respectively, of Avaya Inc. All other trademarks are the "Software" means the computer programs in object code, originally property of their respective owners. licensed by Avaya and ultimately utilized by End User, whether as For the most current versions of documentation, go to the Avaya stand-alone Products or pre-installed on Hardware. "Hardware" support Web site: http://www.avaya.com/support means the standard hardware Products, originally sold by Avaya and ultimately utilized by End User.
License Type(s): Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A "Unit" means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an e-mail or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Software. Units may be linked to a specific, identified Server. Database License (DL). Customer may install and use each copy of the Software on one Server or on multiple Servers provided that each of the Servers on which the Software is installed communicate with no more than a single instance of the same database.
Copyright Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law.
Contents
Chapter 1: Introducing Stored Procedures ...... 9 General Information...... 9 Terms and Definitions ...... 10 System Setup ...... 11 Pre-Defined Data Types ...... 11 Logging into the Stored Procedures ...... 12 New Features ...... 12
Chapter 2: Stored Procedures...... 15 Generic Stored Procedures ...... 16 p_cspi_AddConferenceConferee ...... 16 p_cspi_EditConferenceConferee ...... 18 p_cspi_DeleteConferenceConferee ...... 19 p_cspi_GetConfParticipantList ...... 20 p_cspi_AddClient ...... 22 p_cspi_EditClient ...... 28 p_cspi_DeleteClient ...... 30 p_cspi_GetClientDetails ...... 31 p_cspi_DisableExpiredClients...... 34 p_cspi_AddCompany ...... 34 p_cspi_EditCompany ...... 38 p_cspi_DeleteCompany ...... 41 p_cspi_ GetCompanyDetails...... 42 p_cspi_GetCRSVersion ...... 44 p_cspi_AddWholesaler ...... 45 p_cspi_EditWholesaler ...... 46 p_cspi_DeleteWholesaler ...... 48 p_cspi_AddReseller ...... 49
3 p_cspi_EditReseller ...... 51 p_cspi_DeleteReseller ...... 52 p_cspi_GetResellerList ...... 53 p_cspi_CreateConferenceOwner ...... 55 p_cspi_GetConfereeDetails ...... 55 p_cspi_GetInActiveUsers ...... 57 p_cspi_GetPostConfReport ...... 58 p_cspi_GetPostCDRConfList ...... 61 p_cspi_GetPostConfData ...... 63 p_cspi_GetPostConfCallData ...... 64 p_cspi_Sys_CheckNumeric ...... 65 p_cspi_SecondsToDuration ...... 66 p_cspi_GetWholesalerList ...... 67 p_cspi_SetWholesalerEnabled ...... 69 CS7000 Stored Procedures...... 69 Parameter Descriptions...... 70 p_cspi_MakeBooking ...... 74 p_cspi_EditBooking...... 83 p_cspi_DeleteBooking ...... 92 p_cspi_GetConferenceDetails ...... 93 p_cspi_ExtendConference ...... 97 p_cspi_CloseConference ...... 99 Enumerated Types ...... 101 CS700 Stored Procedures...... 102 p_cspi_S700_MakeBooking ...... 103 p_cspi_S700_EditBooking ...... 119 p_cspi_S700_DeleteBooking ...... 138 p_cspi_S700_GetBooking...... 139 p_cspi_UpdateBillCode...... 142 p_cspi_GetBillCode...... 143 p_cspi_S700_ToSchDateTime ...... 145 p_cspi_S700_FromSchDateTime ...... 147 Multisite Post Conference Reports ...... 148
4 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide pg_cspi_GetPostCDRConfList ...... 149 pg_cspi_GetPostConfData ...... 150 pg_cspi_GetPostConfCallData ...... 151 CSPI Error Codes ...... 152
Chapter 3: Using the Stored Procedures ...... 155 p_cspi_AddConferenceConferee ...... 155 p_cspi_EditConferenceConferee ...... 156 p_cspi_DeleteConferenceConferee ...... 158 p_cspi_GetConfParticipantList ...... 159 p_cspi_AddClient ...... 160 p_cspi_EditClient ...... 162 p_cspi_DeleteClient ...... 163 p_cspi_GetClientDetails ...... 164 p_cspi_DisableExpiredClients...... 165 p_cspi_AddCompany ...... 166 p_cspi_EditCompany ...... 167 p_cspi_DeleteCompany ...... 168 p_cspi_GetCompanyDetails ...... 169 p_cspi_GetCRSVersion ...... 170 p_cspi_MakeBooking ...... 171 p_cspi_EditBooking...... 174 p_cspi_ExtendConference ...... 176 p_cspi_GetConferenceDetails ...... 177 p_cspi_DeleteBooking ...... 178 p_cspi_CloseConference ...... 179 p_cspi_S700_MakeBooking ...... 180 p_cspi_S700_EditBooking ...... 183 p_cspi_S700_GetBooking...... 186 p_cspi_S700_DeleteBooking ...... 187 p_cspi_UpdateBillCode...... 187 p_cspi_GetBillCode...... 188 p_cspi_GetConfereeDetails ...... 189
5 p_cspi_GetInActiveUsers ...... 191 p_cspi_GetPostConfReport ...... 192 p_cspi_GetPostCDRConfList ...... 193 p_cspi_GetPostConfData ...... 194 p_cspi_GetPostConfCallData ...... 194 p_cspi_Sys_CheckNumeric ...... 195 p_cspi_SecondsToDuration ...... 196 p_cspi_GetWholesalerList ...... 197 p_cspi_SetWholesalerEnabled ...... 199 pg_cspi_GetPostCDRConfList ...... 199 pg_cspi_GetPostConfData ...... 199 pg_cspi_GetPostConfCallData ...... 199
6 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Preface
Describes this documents purpose and ways of contacting Avaya.
This document specifies the parameters for stored procedures that provide a easy to use interface with the Client Registration Server (CRS). The CRS is primarily a booking and scheduling application. Here you can create both scheduled and demand conferences with additional attributes to suit customer requirements. The CRS is also used to enter new company and client account details. These are necessary as the relationship between company, client, and conference reservation is crucial for billing purposes. Using the CRS you can also: • Check conference schedule • Analyze resource usage • Check conference recording details • Set operator features • Extend or reduce live conference participation • Extend or reduce live conference duration Stored procedures can be easily used from different programming languages (C++™, Java™, Visual Basic™). US and Canada Tel: +1-877-742-8351 or +1-877-742-8352 E-mail: [email protected] Fax: +1-978-552-6220 International Tel: +353-1-207-5668 (CS 700/780) Tel: +353-1-207-5666 (CS7000)
7 E-mail: [email protected] www.avaya.com
8 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Chapter 1 Introducing Stored Procedures
This chapter outlines some general information and terms and definitions of the Stored Procedures and the CRS
General Information The CRS (Client Registration Server) Front End is primarily a booking and scheduling application. Here you can create both scheduled and demand conferences with additional attributes to suit customer requirements. The CRS Front End is also used to enter new company and client account details. These are necessary as the relationship between company, client and conference reservation is crucial for billing purposes. Using the CRS Front End you can also: • Check conference schedule • Analyze resource usage • Check conference recording details • Set operator features • Extend or reduce live conference participation • Extend or reduce live conference duration The CRS Stored Procedure Interface (CSPI) is a series of SQL stored procedures that provide developers with conference managing tools. CSPI is part of the BSRes2 Database. CSPI also enables third party developers call the procedures from their preferred programming language or directly via SQL. From this, third party developers can structure their own CRS Front End. It is possible to reserve a conference using the Make_Booking parameter. However, it is advisable that you create a company and client before attempting to reserve a conference.
9 Figure 1: Example of CRS work flow
CRS
Company 1 Company 2
Booking Booking Booking Booking
Conferee List Conferee List Conferee List Conferee List
Note: For more information on the CRS Front End, see The Operator Guide.
Terms and Definitions • SP- Stored Procedure • CSPI- CRS Stored Procedure Interface (CSPI) • CS700- Avaya CS700 Conferencing Server • S6200- Avaya S6200 Conferencing Server • S6800- Avaya S6800 Conferencing Server • CRS- Client Registration System.
10 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide System Setup There are 3 scripts for different suites. However, this is dependent on the CRS version. It is necessary to start Query Analyzer as “sa” (system administrator) and play the appropriate script during install.
Table 1: Setup Script
Script Software Suite CRS Version MS SQL Server Version
CSPI.sql 9.0+ 5.0 MS SQL Server 2005 compatible.
Note: The installation of the API is completed by Avaya Install engineers.
Pre-Defined Data Types The Pre-Defined data types are used as table definitions and stored procedures declarations in the CRS database.
Table 2: Pre-Defined Data Types
Name Type Comment
UDTAccountRef varchar (16) Digit String
UDTAddress varchar (50) Printable characters
UDTCode varchar (4) Digit String
UDTComment varchar (255) Printable characters
UDTDDI varchar (32) Digit String
UDTDateTime datetime Date Time
UDTDistinguishedName varchar Printable characters
UDTDescription varchar (255) Printable characters
UDTEmail varchar (50) Printable characters
UDTExternal ID int Integer
UDTFlag bit Bit
11 Table 2: Pre-Defined Data Types
Name Type Comment
UDTICC varchar (20) Digit string
UDTImportID varchar (50) Printable characters
UDTName varchar (50) Printable characters
UDTPIN varchar (16) Digit string
UDTPassword varchar (8) Printable characters
UDTPhone varchar (40) Digit string with (+ -)
UDTSortCode varchar (32) Printable characters
UDTType tinyint Tiny integer (0-255)
UDTTypeName varchar (32) Printable characters
Logging into the Stored Procedures ‘cspi_user’ is the login to access all stored procedures. The password is ‘cspi_user’.
Note: For more information on reserving a conference see the Avaya CS700 Conferencing Server Operator Guide.
New Features • Wholesaler Functionality New stored procedures have been created to enable Wholesaler functionality. These include p_cspi_AddWholesaler, p_cspi_EditWholesaler, and p_cspi_DeleteWholesaler. – See “p_cspi_AddWholesaler” on page 45 – See “p_cspi_EditWholesaler” on page 46 – See “p_cspi_DeleteWholesaler” on page 48
12 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide • Reseller Functionality Similarly, new stored procedures have been created to enable Reseller functionality. These include p_cspi_AddReseller, p_cspi_EditReseller, p_cspi_DeleteReseller, and p_cspi_GetResellerList. – See “p_cspi_AddReseller” on page 49 – See “p_cspi_EditReseller” on page 51 – See “p_cspi_DeleteReseller” on page 52 – See“p_cspi_GetResellerList” on page 53 • Add Company and Edit Company Stored Procedures A new field has been added to the p_cspi_AddCompany and p_cspi_EditCompany procedures to enable a customer to link to an external database. This field is the external string field. – See “p_cspi_GetClientDetails” on page 31 – See “p_cspi_EditCompany” on page 38 •Error Codes A number of procedures have been modifed to return specific error codes instead of just -1. These include p_cspi_MakeBooking, p_cspi_EditBooking, p_cspi_S700_MakeBooking, and p_cspi_S700_EditBoooking. – See “CSPI Error Codes” on page 152 • Conference Comments A new field to cater for conference comments has been added to the p_cspi_S700_MakeBooking and p_cspi_S700_EditBoooking procedures. – See “p_cspi_S700_MakeBooking” on page 103 – See “p_cspi_S700_EditBooking” on page 119 •PromptSet A new field to cater for the prompt set language selection has been added to p_cspi_MakeBooking, p_cspi_EditBooking, p_cspi_S700_MakeBooking, and p_cspi_S700_EditBoooking. – See “p_cspi_MakeBooking” on page 74 – See “p_cspi_EditBooking” on page 83 – See “p_cspi_S700_MakeBooking” on page 103 – See “p_cspi_S700_EditBooking” on page 119
13 14 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Chapter 2 Stored Procedures
This chapter describes CSPI stored procedures and its parameters in details.
Stored procedures are: • Generic stored procedures (for CS700/CS6200/CS6800/CS7000 systems) • CS7000 specific • CS700 specific. It is important to note that these stored procedures also operate on the CS6800 and CS6200. The following table gives information about all stored procedures and the system that they apply to:
Table 3: Stored Procedure
Name Platform
p_cspi_MakeBooking CS7000
p_cspi_EditBooking CS7000
p_cspi_ExtendConference CS7000
p_cspi_GetConferenceDetails CS7000
p_cspi_DeleteBooking CS7000
p_cspi_CloseConference CS7000
p_cspi_AddConferenceConferee Generic
p_cspi_EditConferenceConferee Generic
p_cspi_DeleteConferenceConferee Generic
p_cspi_GetConfParticipantList Generic
p_cspi_AddClient Generic
15 Table 3: Stored Procedure
Name Platform
p_cspi_EditClient Generic
p_cspi_DeleteClient Generic
p_cspi_GetClientDetails Generic
p_cspi_AddCompany Generic
p_cspi_EditCompany Generic
p_cspi_DeleteCompany Generic
p_cspi_GetCompanyDetails Generic
p_cspi_GetCRSVersion Generic
p_cspi_S700_MakeBooking CS700
p_cspi_S700_EditBooking CS700
p_cspi_S700_GetBooking CS700
p_cspi_S700_DeleteBooking CS700
Generic Stored Procedures The following stored procedures apply to the CRS on CS700, CS6200, CS6800, and CS7000 systems. p_cspi_AddConferenceConferee This procedure enables the moderator to add new conferee (participant) to specified conference. Participants can be added to scheduled conferences when it is "Confirmed" or "In Progress". In case of demand conference, participants can be added at any time. SP declaration: CREATE PROCEDURE p_cspi_AddConferenceConferee ( @ConferenceRef int,
16 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @WipeAllInd UDTFlag, @ParticipantName UDTName, @ContactPhone UDTPhone, @ContactFax UDTPhone, @ContactEMail UDTEMail, @DialNumber UDTPhone, @Comment UDTComment, @Information UDTComment output @PIN UDTPin ) Return Codes: 0=okay ~=failure Parameters:
Parameter Type Input/ Output Description
@ ConferenceRef int input Specifies reference to conference
@WipeAllInd UDTFlag input If 1 – all previously created conferees will be deleted before adding new one.
@ParticipantName UDTName input Name of conferee (participant). Can’t be empty
@ContactPhone UDTPhone input Contact phone, can’t contain illegal characters.
@ContactFax UDTPhone input Contact fax, can’t contain illegal characters.
@ContactEMail UDTEMail input Contact E-mail
17 Parameter Type Input/ Output Description
@ DialNumber UDTPhone input Dial number, used for dial out calls. Can’t contain illegal characters or be empty.
@Comment UDTComment input Comments
@Information UDTComment output only If p_ cspi_ AddConferenceConferee failed to add new participant, @Information will contain problem description.
@PIN UDTPin output Private Identification number p_cspi_EditConferenceConferee This stored procedure edits parameters of conferee in a conference (@ConferenceRef). They must be defined in the conference by their name (@ParticipantName). Participation details (if any) in other conferences for same person are not changed. For various reasons (e.g. phone number field contains characters other than 0-9 or + sign), it may happen that parameters can not be changed. @Information explains the problem. The conference is placed in the pre-editing state if any parameter is not changed. SP declaration: CREATE PROCEDURE p_cspi_EditConferenceConferee ( @ConferenceRef int, @ParticipantName UDTName, @ContactPhone UDTPhone, @ContactFax UDTPhone, @ContactEMail UDTEMail, @DialNumber UDTPhone, @Comment UDTComment, @Information UDTComment output
18 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide ) Parameters and limitations are same as in p_cspiAddConferenceConferee. Only one difference – participant is identified by @ConferenceRef and @ParticipantName. Return Codes: 0=okay ~=failure p_cspi_DeleteConferenceConferee Deletes association of all participants that are identified by their name in a live conference. Deleted Participants remain in the client’s address book and can be added/edited/deleted to, or from, other conferences. They can also be returned to the live conference. SP declaration: CREATE PROCEDURE p_cspi_DeleteConferenceConferee ( @ConferenceRef int, @ParticipantName UDTName, @Information UDTComment output ) Return Codes: 0=okay ~=failure Parameters:
Table 4: Delete Conference Conferee Parameters
Parameter Type Input/ Output Descriptions
@ ConferenceRef int input Specifies reference to conference
19 Table 4: Delete Conference Conferee Parameters
Parameter Type Input/ Output Descriptions
@ParticipantName UDTName input Name of conferee (participant). Can’t be empty. Is used to identify participant for specified conference
@Information UDTComment output only If p_cspi_ DeleteConferenceConferee failed to delete participant, @Information will contain problem description. p_cspi_GetConfParticipantList This stored procedure returns participant (conferee) list on request. Participant name filter can be used to narrow or wide selection. If ConferenceRef is 0 – all participants will be selected. SP declaration: CREATE PROCEDURE p_cspi_GetConfParticipantList ( @ConferenceRef int = 0, @ParticipantNameFilter UDTName= ‘%’, @Information UDTComment output ) Return Codes: 0=okay
20 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide ~=failure
Table 5: Get Conferee Details Parameters
Parameter Type Input/ Output Description
@ ConferenceRef int input Specifies reference to conference. If 0 selection will be based on @ParticipantNameFilter value. Default=0
@ParticipantName UDTName input Name filter of conferee (participant). If “%” – any conferee will be selected for specified Conference. SQL wildcards applies to this filter: “%” – any number of any characters “_” – any one character Default=%
@Information UDTComment output only If p_cspi_ GetConfParticipantList failed to select participant, @Information will contain problem description.
Returned record set contains following data:
Table 6: Returned Record Set Parameter
Field Type
ConferenceRef int
ParticipantRef int
ParticipantName UDTName
ParticipantPIN UDTPIN
21 Table 6: Returned Record Set Parameter
Field Type
ActualContactPhone UDTPhone
ActualContactFax UDTPhone
ActualContactEMail UDTEmail
ActualChargeTrafficInd UDTFlag
ActualDialOut UDTPhone
AssignedDDI UDTDDI
AssignedPIN UDTPIN
Comment UDTComment
Note: Note, depending on selection criteria – more then one record can be returned. p_cspi_AddClient Procedure adds new client to system. Stored procedure can identify Company using @CompanyRef or @CompanyExternalID. • If @CompanyRef and @CompanyExternalID are both specified – they have to correspond with one company. • If only @CompanyRef is specified – it will be used as key to identify Company. • If only @CompanyExternalID is specified – it will be used to find @CompanyRef SP declaration: CREATE PROCEDURE p_cspi_AddClient ( @ClientRef int output, @CompanyRef int, @Name UDTName, @AddressLine1 UDTAddress= '', @AddressLine2 UDTAddress= '',
22 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @AddressLine3 UDTAddress= '', @AddressLine4 UDTAddress= '', @Phone UDTPhone, @Fax UDTPhone= '', @EMail UDTEMail= '', @ContactName UDTName= '', @ContactPhone UDTPhone= '', @ContactFax UDTPhone= '', @ContactEMail UDTEMail= '', @AdhocAccReference UDTAccountRefoutput, @ExternalID int = 0, @CompanyExternalIDint = 0, @DisabledInd UDTFlag= 0, @Information UDTComment output, @HelplessInd UDTFlag= 0, @Apassword UDTPassword= '', @TimeZoneType UDTType= 0 @ClientMainICC UDTICC= '', @BlockDialoutInd UDTFlag= 0, @ClientExternalString UDTExternalString = '', @ClientTitle UDTName = '', @ClientJobTitle UDTName = '', @ClientLanguageType UDTType= 1, @SecondaryContactPhone UDTPhone = '', @MobileContactPhone UDTPhone= '', @Comment UDTComment= '', @DistinguishedName UDTDistinguishedName = '', @ClientStatusType UDTType= 1 @ContactAddressLine1-4 UDTAddress
23 ) Return Codes: 0=okay ~=failure Parameters:
Table 7: Add Client Parameters
Parameter Type Input/ Output Description
@ ClientRef int Output Stored procedure returns reference of new client.
@CompanyRef int Input Reference to the Company that will have a new client.
@Name UDTName Input Client name. This parameter must be populated.
@AddressLine1 UDTAddress Input Address, line1 Default:‘’, empty string
@AddressLine2 UDTAddress Input Address, line2 Default:‘’, empty string
@AddressLine3 UDTAddress Input Address, line3 Default:‘’, empty string
@AddressLine4 UDTAddress Input Address, line4 Default:‘’, empty string
@Phone UDTPhone Input Client phone. This parameter must be populated.
@Fax UDTPhone Input Client fax Default:‘’, empty string
@EMail UDTEMail Input Client email Default:‘’, empty string
24 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 7: Add Client Parameters
Parameter Type Input/ Output Description
@ContactName UDTName Input Client’s contact name Default:‘’, empty string
@ContainPhone UDTPhone Input Client’s contact phone Default:‘’, empty string
@ContainFax UDTPhone Input Client’s contact fax Default:‘’, empty string
@ContactEMail UDTEMail Input Client’s contact email Default:‘’, empty string
@AdhocAccReferen UDTAccountRef input/output This parameter is ce automatically generated and returned to the stored procedure if it is left empty. Can be used later to identify client
@ExternalID int Input An external ID of Client. For example, if client information is moved from other DB and old reference has to be saved. Default: 0
@CompanyExternalID int Input ExternalID of Company. This information will be used to identify Company. Default: 0
@DisabledInd UDTFlag Input Indicator On/Off – allows to set enable/disable status to client. Default: 0
@Information UDTComment output only If p_cspi_AddClient failed to add new client, @Information will contain problem description.
25 Table 7: Add Client Parameters
Parameter Type Input/ Output Description
@helpless UDTflag Input Flag which indicates *0 disable capability for conferences under this client.
@Password UDTPassword Input Client Password.
@TimeZoneType UDTType Input Time Zone Type 0= Local 1-99= Timezone based on the timezonetypetable in BSRes2 Database.
@ClientMainICC UDTICC Input Client Main International Calling Card. Allows storage of calling card number.
@BlockDialoutInd UDTFlag Input BlockDialOut allows the conference moderator to dial out or be restricted to dial outs. This value is based on a “per conference” basis. To enable dialout: @BlockDialoutInd=0 To disable dialout: @BlockDialoutInd=1
@ClientExternalString UDTExternalStri Input Client external string for ng linking to an external database.
@ClientTitle UDTName Input Stores the client title, such as, MR., MRS., MISS., and so on.
@ClientJobTitle UDTName Input Stores the client job title, such as, Software Developer, Doctor, and so on.
26 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 7: Add Client Parameters
Parameter Type Input/ Output Description
@ClientLanguageType UDTType Input This is the client default language and is configurable. For example, 1=English, 2=French, and so on.
@SecondaryContactPhone UDTPhone Input This is part of the client contact information. It refers to an additional telephone location.
@MobileContactPhone UDTPhone Input This is part of the client contact information. It refers to the telephone information for a mobile phone.
@Comment UDTComment Input This field allows space for comments about the client. For example, “This client has paid their bill” or “This client is entitled to a discount”.
@DistinguishedName UDTDistinguish Input This field supports LDAP edName for enterprises. It stores the DN.
@ClientStatusType UDTType Input This field stores the client status (1=Normal, 2=Not validated, 3=Payment Due, 4=Validated)
27 Table 7: Add Client Parameters
Parameter Type Input/ Output Description
@PreferredDDI UDTDDI Input Allows allocation of a “preferred” DDI. The DDI must be in the DDI list before provisioning. If a user has a preferred DDI, the CRS tries to use that DDI as the primary DDI when booking conferences.
@ContactAddressLine1-4 UDTAddress Input Client’s contact address Default:‘’, empty string p_cspi_EditClient Procedure allows to edits client details in system. Stored procedure can identify Client using @ClientRef or @ExternalID. • If only @ClientRef is specified – it is a key to identify Client (old value of @ExternalID will be kept). • If only @ExternalID is specified – it locates @ClientRef. • If both are specified - @ClientRef identifies Client and @ExternalID is used for updating Client details. @ExternalID must not be used by other Clients. SP declaration: CREATE PROCEDURE p_cspi_EditClient ( @ClientRef int, @Name UDTName, @AddressLine1 UDTAddress= '', @AddressLine2 UDTAddress= '', @AddressLine3 UDTAddress= '', @AddressLine4 UDTAddress= '', @Phone UDTPhone, @Fax UDTPhone= '',
28 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @EMail UDTEMail= '', @ContactName UDTName= '', @ContactPhone UDTPhone= '', @ContactFax UDTPhone= '', @ContactEMail UDTEMail= '', @AdhocAccReference UDTAccountRefoutput, @ExternalID int = 0, @DisabledInd UDTFlag= 0, @Information UDTComment output, @HelplessInd UDTFlag= 0, @ApplyHelplessIndUDTFlag= 0, @Apassword UDTPassword= '', @TimeZoneType UDTType= 0 @ClientMainICC UDTICC= '', @BlockDialoutInd UDTFlag= 0, @ClientExternalString UDTExternalString = '', @ClientTitle UDTName = '', @ClientJobTitle UDTName = '', @ClientLanguageType UDTType= 1, @SecondaryContactPhone UDTPhone= '', @MobileContactPhone UDTPhone= '', @Comment UDTComment= '', @DistinguishedName UDTDistinguishedName = '', @ClientStatusType UDTType= 1 ) Return Codes: 0=okay ~=failure
29 Note: Parameters and limitations are same as in p_cspiAddClient, exceptions are:
Table 8: Edit Client
Parameter Type Input/Output Description
@ ClientRef int input Specifies reference to client
@AdhocAccR UDTAccountRef input/output If empty, function will keep old eference value (will not generate new value) and return it back. Can be used later to identify client. p_cspi_DeleteClient This Stored Procedure deletes client details from system. All reservations, assigned to client, must be deleted before deleting client. Stored procedure can identify Client using @ClientRef or @ExternalID. • If @ClientRef and @ExternalID are both specified – they have to correspond with one client. • If only @ClientRef is specified – it will be used as key to identify Client • If only @ExternalID is specified – it will be used to find @ClientRef. SP declaration: CREATE PROCEDURE p_cspi_DeleteClient ( @ClientRef int, @ExternalID int = 0, @Information UDTComment output ) Return Codes: 0=okay ~=failure
30 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Parameters:
Table 9: Delete Client Parameters
Parameter Type Input/Output Description
@ ClientRef int input Specifies reference to the client that has been selected for deletion.
@ExternalID int input An external ID of Client. For example, if client information is moved from other DB and old reference has to be saved. Default= 0.
@Information UDTComment output only If p_cspi_DeleteClient failed to delete new client, @Information will contain problem description. p_cspi_GetClientDetails This stored procedure will return client details on request. If ClientRef is set, SP uses only it, after that goes AdHocAccountRef, ExternalID. Conflicts are not solved, when all values are set. NameFilter is used only when all other parameters (ClientRef, AdHocAccountRef, ExternalID) are 0/empty. CREATE PROCEDURE p_cspi_GetClientDetails ( @ClientRef int = 0, @AdHocAccountRef UDTAccountRef= '', @ExternalID int = 0, @NameFilter UDTName = '%', @Information UDTComment output ) Return Codes: 0=okay ~=failure
31 Parameters:
Table 10: Get Client Details Parameters
Parameter Type Input/Output Description
@ ClientRef int Input Specifies the client’s reference number. Can be 0, if NameFilter is used. Default: 0
@ AdHocAccountRef UDTAccountRef Input Specifies client’s AdHocAccountReference. Can be used, when ClientRef is unknown. Can be 0, if NameFilter is used. Default: ‘’
@ExternalID int Input Specifies client’s ExternalID. Can be used, when ClientRef is unknown. Can be 0, if NameFilter is used. Default: 0
@NameFilter UDTName Input NameFilter is used only when ClientRef, AdHocAccountRef and ExternalID are unknown and not set. Value “%” - will return all existing clients in system. Default:%
@Information UDTComment output only If p_cspi_GetClientDetails failed to find client, @Information will contain problem description.
32 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Returned record set contains following data:
Table 11: Get Client detail returned record set parameters
Field Type
ClientRef Int
CompanyRef Int
ClientName UDTName
ClientAddressLine1 UDTAddress
ClientAddressLine2 UDTAddress
ClientAddressLine3 UDTAddress
ClientAddressLine4 UDTAddress
ClientMainPhone UDTPhone
ClientMainFax UDTPhone
ClientEMail UDTEmail
ClientExternalID Int
ContactName UDTName
ContactAddressLine1 UDTAddress
ContactAddressLine2 UDTAddress
ContactAddressLine3 UDTAddress
ContactAddressLine4 UDTAddress
ContactPhone UDTPhone
ContactFax UDTAddress
ContactEMail UDTEmail
AdHocAccountReference UDTAccountRef
ImportID UDTImportID
DisabledInd UDTFlag
33 Note: Depending on selection criteria – more then one record can be returned. p_cspi_DisableExpiredClients p_cspi_DisableExpiredClients permits an SQL job to run on a nightly basis. The SQL job t queries the CRS to search for any user who has not used their conference in the previous X Months. If a client falls into this category, the client and their conferences are disabled.
Table 12: Get Client Details Parameters
Parameter Type Input/Output Description
@N_Months int input Default of 6 months. Sets the number of previous months that the system should use as disabling criteria.
Returns Successful: RetCode = 0 (no message) Failure: RetCode = -1 (p_cspi_DisableExpiredClients: CDRProcessTimeInvalid) p_cspi_AddCompany Procedure adds new company to system. CREATE PROCEDURE p_cspi_AddCompany ( @CompanyRef int output, @Name UDTName, @AddressLine1 UDTAddress= '', @AddressLine2 UDTAddress= '', @AddressLine3 UDTAddress= '', @AddressLine4 UDTAddress= '', @Phone UDTPhone= '', @Fax UDTPhone= '', @EMail UDTEMail= '',
34 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @ExternalID int = 0, @ContactName UDTName= '', @DisabledInd UDTFlag= 0, @Information UDTComment output, @WholesalerRef int = 0, @ResellerRef int = 0, @ExternalString UDTExternalString = '' @DirectoryServiceInd UDTFlag @BlockDialOutInd UDTFlag
SP declaration: /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @InformationUDTComment declare @CompanyRef int print 'Adding company...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_AddCompany @CompanyRef= @CompanyRef output, @Name= 'Test_Company', @AddressLine1= 'Address1', @AddressLine2= 'Address2', @AddressLine3= 'Address3',
35 @AddressLine4= 'Address4', @Phone= '+35312070000', @Fax= '+35312070001', @EMail= '[email protected]', @ExternalID= 0, @ContactName= 'Contact name', @DisabledInd= 0, @Information= @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Company Ref: ' + convert(varchar, @CompanyRef) end else begin print 'Test Failed. ' + @Information end Parameters:
Table 13: Add Company Parameters
Parameter Type Input/Output Description
Company Ref Int output Stored procedure returns reference of new company.
@Name UDTName input Company name. This parameter must be populated.
36 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 13: Add Company Parameters
Parameter Type Input/Output Description
@AddressLine1 UDTAddress input Address, line1 Default: “empty string”
@AddressLine2 UDTAddress input Address, line2 Default: “empty string”
@AddressLine3 UDTAddress input Address, line3 Default: “empty string”
@AddressLine4 UDTAddress input Address, line4 Default: “empty string”
@Phone UDTPhone input Client phone. This parameter must be populated or contain illegal characters.
@Fax UDTPhone input Client fax Default: “empty string”
@EMail UDTEMail input Client email Default: “empty string”
@ExternalID int input An external ID of Company. For example, if company information is moved from other DB and old reference has to be saved. Default: “0”
@ContactName UDTName input Client’s contact name Default: “empty string”
@DisabledInd UDTFlag input Indicator On/Off – allows to set enable/disable status to company. Default: 0
37 Table 13: Add Company Parameters
Parameter Type Input/Output Description
@Information UDTComment output only If p_cspi_AddCompany failed to add new company, @Information will contain problem description.
@WholesalerRef Int Input Optional Wholesaler Ref
@ResellerRef Int Input Optional Reseller Ref
@ExternalString UDTExternalStr Input Customer-specific external ing reference to this company
@DirectoryServiceInd UDTFlag Input Optional directory service indicator
@BlockDialoutInd UDTFlag Input Optional block dialout indicator p_cspi_EditCompany Procedure allows to modify company details. Stored procedure can identify Company using @CompanyRef or @ExternalID. • If only @CompanyRef is specified – it will be used as key to identify Company. (old value of @ExternalID will be kept) • If only @ExternalID is specified – it will be used to find @CompanyRef. • If both are specified - @CompanyRef will be used to identify Company, and @ExternalID will be used for updating Company details. @ExternalID must not be used by other Companies. • SP declaration: CREATE PROCEDURE p_cspi_EditCompany CREATE PROCEDURE p_cspi_EditCompany ( @CompanyRef int, @Name UDTName, @AddressLine1 UDTAddress= '',
38 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @AddressLine2 UDTAddress= '', @AddressLine3 UDTAddress= '', @AddressLine4 UDTAddress= '', @Phone UDTPhone= '', @Fax UDTPhone= '', @EMail DTEMail= '', @ExternalID int = 0, @ContactName UDTName= '', @DisabledInd UDTFlag= 0, @Information UDTComment output, @WholesalerRef int = 0, @ResellerRef int = 0, @ExternalString UDTExternalString = '' @BlockDialoutInd UDTFlag= 0, )
Note: The parameters and limitations are same as in p_cspi_AddCompany, with a single exception. DirectoryServiceIndicator is not supported in p_CSPI_EditCompany.
/****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @InformationUDTComment declare @CompanyRef int select @CompanyRef = 1 -- SET YOUR COMPANY REF HERE print 'Modifying company details...' /******************************************************************
39 * Execute SP *****************************************************************/ execute @RetCode = p_cspi_EditCompany @CompanyRef= @CompanyRef, @Name= 'Test_Company1', @AddressLine1= 'Address1', @AddressLine2= 'Address2', @AddressLine3= 'Address3', @AddressLine4= 'Address4', @Phone= '+35312070000', @Fax= '+35312070001', @EMail= '[email protected]', @ExternalID= 0, @ContactName= 'Contact name', @DisabledInd= 0, @Information= @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded. ( ) ' print 'Company Ref: ' + convert(varchar, @CompanyRef) end else begin print 'Test Failed. ' + @Information end
40 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Parameters and limitations are same as in p_cspiAddCompany, exceptions are:
Table 14: Edit Company Parameters
Parameter Type Input/Output Description
@ CompanyRef int input Specifies reference to company, which is required to modify.
@BlockDialoutInd UDTFlag Input Optional block dialout indicator p_cspi_DeleteCompany Procedure deletes company details from system. All clients, assigned to company, have to be deleted before deleting company. Stored procedure can identify Company using @CompanyRef or @ExternalID. • If @CompanyRef and @ExternalID are both specified – they have to correspond with one company. • If only @CompanyRef is specified – it will be used as key to identify Company • If only @ExternalID is specified – it will be used to find @CompanyRef. SP declaration: CREATE PROCEDURE p_cspi_DeleteCompany ( @CompanyRef int, @ExternalID int = 0, @Information UDTComment output ) Return Codes: 0=okay ~=failure
41 Parameters:
Table 15: Delete Company Parameters
Parameter Type Input/Output Description
@ CompanyRef int input Specifies reference for the company that has been selected for deletion.
@externalID int input An external ID of the Company. For example, if company information is moved from other DB and old reference has to be saved. Default: 0.
@information UDTComment output If p_cspi_DeleteCompany failed to delete new company @information will contain problem description p_cspi_ GetCompanyDetails This stored procedure returns company details on request. Company name filter can be used to narrow or wide selection. Also CompanyRef or/and ExternalID information can be used to find company info. CREATE PROCEDURE p_cspi_GetCompanyDetails ( @CompanyRef int = 0, @ExternalID int = 0, @NameFilter UDTName = '%', @Information UDTComment output )
42 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Parameters:
Table 16: Get Company Details Parameters
Parameter Type Input/Output Description
@ CompanyRef int input Specifies reference of the company details that are requested. Can be 0, if NameFilter is used. Default= 0
@ExternalID int input Specifies company’s ExternalID. Can be used, when CompanyRef is unknown. Can be 0, if NameFilter is used.
@NameFilter UDTName input NameFilter is used only when CompanyRef and ExternalID are unknown and not set. Value “%” - will return all existing companies in system.
@Information UDT Comment output only If p_cspi_GetCompanyDetails failed to find company, @Information will contain problem description.
Return Codes: 0=okay ~=failure Returned record set contains following data:
Table 17: Returned Record Set for Get Company Details
Field Type
CompanyRef int
CompanyName UDTName
CompanyAddressLine1 UDTAddress
43 Table 17: Returned Record Set for Get Company Details
Field Type
CompanyAddressLine2 UDTAddress
CompanyAddressLine3 UDTAddress
CompanyAddressLine4 UDTAddress
CompanyPhone UDTPhone
CompanyFax UDTPhone
CompanyEMail UDTEmail
CompanyContactName UDTName
CompanyExternalID int
ImportID UDTImportID
DisabledInd UDTFlag
Note: More then one record can be returned, depending on selection criteria. p_cspi_GetCRSVersion Procedure returns current CRS version. SP declaration: CREATE PROCEDURE p_cspi_GetCRSVersion Returned record set contains following data:
Table 18: Get CRS version Returned Record set data
Field Type Description
Major int Major part of version. For example 2.5.
Minor int Minor part of version. For example 2.5.
Part char (1) Part information. Empty for CRS earlier then 2.1.
Label UDTName Additional information. Empty for CRS earlier then 2.1.
44 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide p_cspi_AddWholesaler Procedure to add a Wholesaler
SP declaration: CREATE PROCEDURE p_cspi_AddWholesaler ( @WholesalerRef int output, @Name UDTName, @BillingCode UDTBillingCode = '', @Note UDTComment = '', @Description UDTComment = '', @ContactName UDTName = '', @ContactPhone UDTPhone = '', @ContactFax UDTPhone = '', @ContactEMail UDTEMail = '', @Reception int = 0 output, @DisabledInd UDTFlag = 0, @ExternalString UDTExternalString = '', @ExternalID UDTExternalID = 0, @Information UDTComment output ) Refer to the CSPI_Developers_Guide for details about the stored procure definition
Table 19: p_cspi_AddWholesaler
Default Parameter Type Input/Output Value Description
@WholesalerRef int Output only Ref of newly added wholesaler
@Name UDTName Input ‘’ Wholesaler Name
45 Table 19: p_cspi_AddWholesaler
Default Parameter Type Input/Output Value Description
@BillingCode UDTBillingCode Input ‘’ Billing Code
@Note UDTComment Input ‘’ Optional Notes
@Description UDTComment Input ‘’ Description
@ContactName UDTtName Input ‘’ Contact Name
@ContactPhone UDTPhone Output only ‘’ Contact Phone
@ContactFax UDTPhone Input ‘’ Contact Fax
@ContactEMail UDTEMail Input ‘’ Contact Email
@Reception Int Input/output ‘’ Reception Ref
@DisableInd UDTFlag Input 0 Disabled Indicator
@ExternalString UDTExternalString Input ‘’ Customer specific external reference to Wholesaler
@ExternalID UDTExternalID Input ‘’ External ID
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay otherwise - failure code If an error occurs, @Information will contain a description of the error p_cspi_EditWholesaler Procedure to edit a Wholesaler
SP declaration:
46 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide CREATE PROCEDURE p_cspi_EditWholesaler ( @WholesalerRef int, @Name UDTName, @BillingCode UDTBillingCode = '', @Note UDTComment = '', @Description UDTComment = '', @ContactName UDTName = '', @ContactPhone UDTPhone = '', @ContactFax UDTPhone = '', @ContactEMail UDTEMail = '', @Reception int = 0, @DisabledInd UDTFlag = 0, @ExternalString UDTExternalString = '', @ExternalID UDTExternalID = 0, @Information UDTComment output )
Refer to the CSPI_Developers_Guide for details about the stored procure definition.
Table 20: p_cspi_EditWholesaler
Default Parameter Type Input/Output Value Description
@WholesalerRef int Input Ref of wholesaler
@Name UDTName Input ‘’ Wholesaler Name
@BillingCode UDTBillingCode Input ‘’ Billing Code
@Note UDTComment Input ‘’ Optional Notes
@Description UDTComment Input ‘’ Description
@ContactName UDTtName Input ‘’ Contact Name
47 Table 20: p_cspi_EditWholesaler
Default Parameter Type Input/Output Value Description
@ContactPhone UDTPhone Input ‘’ Contact Phone
@ContactFax UDTPhone Input ‘’ Contact Fax
@ContactEMail UDTEMail Input ‘’ Contact Email
@Reception Int Input ‘’ Reception Ref
@DisableInd UDTFlag Input 0 Disabled Indicator
@ExternalString UDTExternalString Input ‘’ Customer specific external reference to Wholesaler
@ExternalID UDTExternalID Input ‘’ External ID
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay otherwise - failure code If an error occurs, @Information will contain a description of the error p_cspi_DeleteWholesaler Procedure to delete a Wholesaler
SP declaration: CREATE PROCEDURE p_cspi_DeleteWholesaler ( @WholesalerRef int, @Information UDTComment output )
48 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Refer to the CSPI_Develpoers_Guide for details about the stored procure definition.
Table 21: p_cspi_DeleteWholesaler
Default Parameter Type Input/Output Value Description
@WholesalerRef int Input Ref of wholesaler
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay otherwise - failure code If an error occurs, @Information will contain a description of the error. p_cspi_AddReseller Procedure add a Reseller
SP declaration: CREATE PROCEDURE p_cspi_AddReseller ( @ResellerRef int output, @Name UDTName, @Note UDTComment = '', @Description UDTComment = '', @ContactName UDTName = '', @ContactPhone UDTPhone = '', @ContactFax UDTPhone = '', @ContactEMail UDTEMail = '', @ExternalString UDTExternalString = '',
49 @ExternalID UDTExternalID = 0, @OwnerType UDTType = 0, @OwnerRef int = 0, @Information UDTComment output ) Refer to the CSPI_Developers_Guide for details about the stored procure definition.
Table 22: p_cspi_AddReseller
Default Parameter Type Input/Output Value Description
@ResellerRef int Output only Ref of reseller
@Name UDTName Input ‘’ Reseller Name
@Note UDTComment Input ‘’ Optional Notes
@Description UDTComment Input ‘’ Description
@ContactName UDTtName Input ‘’ Contact Name
@ContactPhone UDTPhone Input ‘’ Contact Phone
@ContactFax UDTPhone Input ‘’ Contact Fax
@ContactEMail UDTEMail Input ‘’ Contact Email
@ExternalString UDTExternalString Input ‘’ Customer specific external reference to Reseller
@ExternalID UDTExternalID Input ‘’ External ID
@OwnerType UDTType Input 0 Owner type
@OwnerRef int Input 0 Owner reference
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay
50 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide otherwise - failure code If an error occurs, @Information will contain a description of the error. p_cspi_EditReseller Procedure edit a Reseller
SP declaration: CREATE PROCEDURE p_cspi_EditReseller ( @ResellerRef int, @Name UDTName, @Note UDTComment = '', @Description UDTComment = '', @ContactName UDTName = '', @ContactPhone UDTPhone = '', @ContactFax UDTPhone = '', @ContactEMail UDTEMail = '', @ExternalString UDTExternalString = '', @ExternalID UDTExternalID = 0, @OwnerType UDTType = 0, @OwnerRef int = 0, @Information UDTComment output ) Refer to the CSPI_Developers_Guide for details about the stored procure definition.
Table 23: p_cspi_EditReseller
Default Parameter Type Input/Output Value Description
@ResellerRef int Input Ref of reseller
@Name UDTName Input ‘’ Reseller Name
51 Table 23: p_cspi_EditReseller
Default Parameter Type Input/Output Value Description
@Note UDTComment Input ‘’ Optional Notes
@Description UDTComment Input ‘’ Description
@ContactName UDTtName Input ‘’ Contact Name
@ContactPhone UDTPhone Input ‘’ Contact Phone
@ContactFax UDTPhone Input ‘’ Contact Fax
@ContactEMail UDTEMail Input ‘’ Contact Email
@ExternalString UDTExternalString Input ‘’ Customer specific external reference to Reseller
@ExternalID UDTExternalID Input ‘’ External ID
@OwnerType UDTType Input 0 Owner type
@OwnerRef int Input 0 Owner reference
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay otherwise - failure code If an error occurs, @Information will contain a description of the error p_cspi_DeleteReseller Procedure delete a Reseller
SP declaration: CREATE PROCEDURE p_cspi_DeleteReseller
52 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide ( @ResellerRef int, @Information UDTComment output ) Refer to the CSPI_Developers_Guide for details about the stored procure definition.
Table 24: p_cspi_EditReseller
Default Parameter Type Input/Output Value Description
@ResellerRef int Input Ref of reseller
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay otherwise - failure code If an error occurs, @Information will contain a description of the error p_cspi_GetResellerList Procedure to get the list of Resellers
SP declaration: CREATE PROCEDURE p_cspi_GetResellerList ( @OwnerType UDTType = 0, @OwnerRef int = 0, @ResellerRef int = 0, @Information UDTComment output
53 )
Table 25: p_cspi_GetResellerList
Default Parameter Type Input/Output Value Description
@OwnerType UDTType Input 0 Owner type
@OwnerRef int Input 0 Owner reference
@ResellerRef int Input Ref of reseller
@Information UDTComment Output only On error, it gives details about the error
Return Codes: 0=okay otherwise - failure code If an error occurs, @Information will contain a description of the error Returned recordset contains following data:
Table 26: Returned Recordset
Field Type
ResellerRef Int
ResellerName UDTName
ResellerNote UDTComment
ResellerDescription UDTComment
ResellerContactName UDTName
ResellerContactPhone UDTPhone
ResellerContactFax UDTPhone
ResellerContactEMail UDTEmail
ResellerExternalString UDTExernalString
54 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 26: Returned Recordset
Field Type
ResellerExternalID UDTExternalID
OwnerType UDTType
OwnerRef Int
OwnerName UDTName p_cspi_CreateConferenceOwner This procedure was written for CSPI to create a sub Company or Client. CREATE PROCEDURE p_cspi_CreateConferenceOwner ( @ClientRef int @Information UDTComment )
Parameter Type Input/Output
@ClientRef int Output
@Information UDTComment Output
This procedure is called from p_cspi-MakeBooking to create a company and client to place the booking under in the event that a client was not specified in the call to p_cspi_makeBooking. p_cspi_GetConfereeDetails This procedure enables the client to query the CRS for a list of recently created clients and demand conferences. The @LastProcessTime parameter is an important parameter in this procedure. The @LastProcessTime yields any client and demand conference that is created after the LastProcessTime. For example, LDAP creates clients and demand conferences automatically. If you execute this procedure using a timestamp of “today
55 minus ten days”, the procedure returns any client account reference, Moderator PIN, and Conferee PIN that was created in the last ten days. CREATE PROCEDURE p_cspi_GetConfereeDetails ( @LastProcessTime datetime, @ClientName UDTNameoutput, @AdhocAccReferenceUDTAccountRef output, @MPin UDTPinoutput, @CPIN UDTPinoutput, @Information UDTComment output )
Parameter Type Input/Output Description
@LastProcessTime datetime I Date and time that sets the lower limit for client return
@ClientName UDTName O Returns client.ClientName
@AdhocAccReference UDTAccountRef O Returns client.AdHocAccountRef
@MPin UDTPin O Returns conference.UsersMPin
@CPIN UDTPin O Returns conference.UsesCPin
@Information UDTComment O Returns error information
Returns
Successful @ClientName @AdhocAccReference @Mpin
56 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @CPin @Information
Failure
Retcode Information
-1 The Last Process Time is invalid.
p_cspi_GetInActiveUsers This procedure enables you to view a list of clients who have not used their conference in a specified number of days. The parameter, @Tdays, determines the number of days. You must combine @Tdays with a filter type of M for Moderator or C for Conferee to return a list of clients who have not used their conference in a specified number of days. CREATE PROCEDURE p_cspi_GetInActiveUsers ( @Tdays int, @FilterType char(1), @ClientName UDTNameoutput, @AdhocAccReferenceUDTAccountRef output, @Information UDTComment output )
Parameter Type Input/Output Description
@Tdays INT I Determines the number of days for which the system retrieves records
@FilterType CHAR(1) I Describes the type of filter. Filters are either Moderator or Conferee. Parameter options are M or C
57 Parameter Type Input/Output Description
@ClientName UDTName O Returns text from Client.ClientName
@AdhocAccReference UDTAccountRef O Returns text from Client.AdhocAccReference
@Information UDTComment O Returns information if there is a failure
Returns
Successful @ClientName @AdhocAccReference @Information
Failure
Retcode Information
-1 CRS Data is not up-to-date
-10 InvalidFilterType p_cspi_GetPostConfReport Use this procedure to generate a post conference report. The post conference report is based on criteria that you supply using the input parameters described here.
Note: You can use this procedure to test the output from the CSPI_PostConf procedures.
This procedure, p_cspi_GetPostConfReport, calls the following procedures: • p_CSPI_GetPostCDRConfList • p_CSPI_GetPostConfData • p_CSPI_GetPostConfCallData
58 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Declaration: PROCEDURE p_CSPI_GetPostConfReport ( @ClientName UDTName = '', @StartDT datetime, @EndDT datetime, @ShowOnlyNtfTypeInd UDTFLag = 0, @Information UDTComment output )
Parameter Type Input/Output Description
@ClientNameSch UDTName I Optional client name search criteria
@StartDT datetime I Start date/time range
@EndDT datetime I End date/time range
@ShowOnlyNTFTypeInd UDTFlag I 0=Returns all conferences 1=Returns only conferences that are marked for notification
@Information UDTComment O Error information if the procedure fails
Returns
Codes 0=okay non-zero=failure, check @Information for details on failure
Success Returned recordset contains following data:
59 Note: The output is the same as p_CSPI_GetPostConfData and p_CSPI_GetPostConfCallData. The only difference is the formatted duration of CallTotalDurationString, which is HHHH:MM:SS.
Field Type
CDRConfNum Int
NtfFax UDTFlag
NtfEMail UDTFlag
NftESMS UDTFlag
CompanyRef Int
CompanyName UDTName
ClientName UDTName
ChairmanFax UDTPhone
ChairmanEMail UDTName
ChairmanSMSNumber UDTPhone
WholesalerName UDTName
ConferenceRef Int
ConferenceName UDTName
NumConferees Int
ConfOpenDT datetime
CallTotalDurationSeconds Int
LanguageID Int
CallDurationString Varchar(10) HHHH:MM: SS
60 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Followed by:
Field Type
CallNum Int
Name UDTName
CLIDigits UDTPhone
ConfStartDT datetime
ConfEndDT datetime
CallDuration Int Seconds
CallTotalDura Varchar(10) tionString HHHH:MM:SS p_cspi_GetPostCDRConfList Use this procedure to generate a post conference report. The post conference report is based on criteria that you supply using the input parameters described here. Declaration: PROCEDURE p_CSPI_GetPostCDRConfList ( @ClientNameSch UDTName= '', @StartDT datetime, @EndDT datetime, @ShowOnlyNtfTypeInd UDTFlag = 0, @Information UDTComment = '' output
61 )
Parameter Type Input/Output Description
@ClientNameSch UDTName I Optional client name search criteria
@StartDT datetime I Start date/time range
@EndDT datetime I End date/time range
@ShowOnlyNtfTypeInd UDTFlag I 0=Returns all conferences 1=Returns only conferences that are marked for notification
@Information UDTComment O Error information if the procedure fails
Returns
Codes 0=okay non-zero=failure, check @Information for details on failure The returned recordset contains following data:
Field Type
CDRConfNum Int
ConferenceRef Int
ClientRef Int
ConferenceStartDateTime datetime
ConferenceEndDateTime datetime
62 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide p_cspi_GetPostConfData Use this stored procedure to retrieve post conference details, both booking details and CDR details, for a specific CDRConfNum. Declaration: PROCEDURE p_CSPI_GetPostConfData ( @CDRConfNum int, @Information UDTComment = '' output )
Parameter Type Input/Output Description
@CDRConfNum Int I CDR
@Information UDTComment O Error information, if the procedure fails
Returns 0=okay non-zero=failure, check @Information for details on failure Returned recordset contains following data:
Field Type
CDRConfNum Int
NtfFax UDTFlag
NtfEMail UDTFlag
NtfSMS UDTFlag
CompanyRef Int
CompanyName UDTName
63 Field Type
ClientName UDTName
ChairmanFax UDTPhone
ChairmanEMail UDTName
ChairmanSMSNumber UDTPhone
WholesalerName UDTName
ConferenceRef Int
ConferenceName UDTName
NumConferees Int
ConfOpenDT datetime
ConfCloseDT datetime
CallTotalDurationSeconds Int
LanguageID Int
GlobalID Int
SiteServerName carchar (50) p_cspi_GetPostConfCallData Use this stored procedure to retrieve post conference call details for a specific CDRConfNum.
Note: This procedure can return multiple records.
Declaration: PROCEDURE p_CSPI_GetPostConfCallData ( @CDRConfNum int, @Information UDTComment = '' output )
64 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Parameter Type Input/Output Description
@CDRConfNum Int I CDR’s conference number, as returned from p_cspi_GetPostConfList
@Information UDTComment O Error information, if the procedure fails
Returns
Codes 0=okay non-zero=failure, check @Information for details on failure Returned recordset contains following data:
Field Type
CallNum Int
Name UDTName
CLIDigits UDTPhone
ConfStartDT datetime
ConfEndDT datetime
CallTotalDurationSeconds Int
Moderator Int
Site Server Name varchar (50) p_cspi_Sys_CheckNumeric Use this stored procedure to check if a supplied string is numeric. You can specify the string using @NumericString. If it is numeric, the stored procedure returns a zero value. If it is not numeric, the stored procedure returns -1.
65 Declaration: CREATE PROCEDURE dbo.p_cspi_Sys_CheckNumeric ( @NumericString UDTComment )
Parameter Type Input/Output Description
@NumericString UDTComment I String to examine p_cspi_SecondsToDuration Use this stored procedure to convert a duration value in seconds into a duration string in the format HHHH[:]MM[:]SS. The parameter @InSeconds specifies the duration value in seconds.
Note: [:] is a configurable optional separator.
Declaration: CREATE procedure p_cspi_SecondsToDuration ( @InSeconds int, @strDurationHHHHMMSS varchar(10) output, @UseSeparatorInd UDTFlag = 1, @SeparatorChar char(1) = ':', @Information UDTComment output )
66 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Parameter Type Input/Output Description
@InSeconds Int I Duration in seconds
@strDurationHHH Varchar(10) O Output duration format HMMSS HHHH[:]MM[:]SS where [:] is a configurable separator: See @UseSeparatorInd and @SeparatorChar
@UseSeparatorInd UDTFlag I 1=Use @SeparatorChar (default is :) 0=No separator (format: HHHHMMSS)
@SeparatorChar Char(1) I Default=: Other separators=-
@Information UDTComment O Error information if the procedure fails
Returns 0=okay non-zero=failure, check @Information for details on failure p_cspi_GetWholesalerList Use this stored procedure to get a list of wholesalers for a specific wholesaler based on WholesalerRef. Declaration: CREATE PROCEDURE p_cspi_GetWholesalerList ( @WholesalerRefint= 0, @InformationUDTCommentoutput )
67 Parameter Type Input Description
@WholesalerRef Int I Specific wholesaler reference 0=All wholesalers
@Information UDTComme O Error information if the nt procedure fails
Returns 0=okay non-zero=failure, check @Information for details on failure Returned recordset contains following data:
Field Type
WholesalerRef Int
WholesalerName UDTName
WholesalerBillingCode UDTBillingCode
WholesalerNote UDTComment
WholesalerDescription UDTDescription
WholesalerContactName UDTContactName
WholesalerContactPhone UDTPhone
WholesalerContactFax UDTPhone
WholesalerContactEMail UDTEmail
WholesalerExternalString UDTExternalString
WholesalerExternalID UDTExternalID
WholesalerReception Int
WholesalerDisabledInd UDTFlag
68 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide p_cspi_SetWholesalerEnabled Use this stored procedure to disable or enable a specific wholesaler based on a WholesalerRef. Declaration: CREATE PROCEDURE p_cspi_SetWholesalerEnabled ( @WholesalerRefint, @WholesalerEnabledIndUDTFlag, @InformationUDTCommentoutput )
Parameter Type Input/Output Description
@WholesalerRef Int I Specific wholesaler reference
@WholesalerEnabledInd UDTFlag I 0=Disabled 1=Enabled
@Information UDTComment O Error information if the procedure fails
Returns 0=okay non-zero=failure, check @Information for details on failure
CS7000 Stored Procedures The CS7000 stored procedures apply to the CRS on the CS7000 only.
69 Parameter Descriptions
Table 27: Parameter Descriptions
Parameter Description
@ClientAccount AdhocAccReference of specified Client (can be used value from p_cspi_AddClient sp). If you do not supply a valid client account number then the procedure will automatically generate a sub client to own this conference.
@PaymentNumber Billing number. The billing number is used for billing purposes.
@ConferenceName Name of Conference.
@ConferenceComments Conference comment.
@ ConferenceType Conference type. Value is predefined in table ConferenceType. See below for details.
@LanguageType Language type. Value is predefined in table LanguageType. See below for details.
@PriorityType Priority type. Value is predefined in table PriorityType. See below for details.
@StartDateTime Start date and time of conference.
@Duration Conference duration in minutes. If the parameter is set to 0, the duration is replaced with the minimum allowed value. This value must be between MinConferenceDurationMinutes and MaxConferenceDurationMinutes. Max and Min values are available as system parameters. Can be viewed and modified from CRS Front-end(System Administration->Parameters). If value is greater, then maximum (or smaller, then minimum) allowed. This leads to an error message being displayed.
70 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 27: Parameter Descriptions
Parameter Description
@Conferees Maximum number of conferees for this conference. If set to 0, will be replaced with minimum allowed value. Value has to be between MinConferenceSize and MaxConferenceSize. Max and Min values are available as system parameters. Can be viewed and modified from CRS Front-end (System Administration->Parameters) An error message is displayed if a larger value than maximum (or smaller than minimum) is entered.
@SubConferees Maximum number of conferees in a sub conference. One main conference can have only one sub conference. If value is 0 – main conference will not support sub conference.
@ TollFreeInd TollFree indicator. This is used for billing purposes.
@RecordingInd On/Off recording of this conference.
@ EnterToneInd On/ Off Leaving Tone in conference
@ LeavingToneInd On/Off Leaving Tone in conference
@ QandAInd On/Off QandA in conference
@ PollingInd On/Off Polling in conference
@ RollCallInd Indicator. A new caller will be prompted for their name if this is enabled.
@BroadcastInd On/Off conference broadcast.
@ DemandInd Indicates, that conference is Demand (not scheduled). Scheduled conference has fixed time interval, Demand conference can be opened any time.
@RecordingPIN This is the pin to access conference recordings if recording is enabled.
@ModeratorInd Indicates if the conference supports moderator control. If ‘ModeratorInd’ = 0 then ‘MPIN’ will be set to the same value as ‘CPIN’.
71 Table 27: Parameter Descriptions
Parameter Description
@ AutoPINInd Indicator that requests auto generation of @MPIN and @CPIN. If it is 0, user has to specify @CPIN and @MPIN. If it is 1, values will be auto generated and returned as output parameters.
@DDI If value is empty, system will select @DDI and return it as output parameter. If value is set, system will accept it, and verify availability.
@CPIN Conferee PIN. This is used by conferee to enter conference. If @AutoPINInd is set to 1, system will generate @CPIN and @MPIN. If – 0, user has to specify unique value (Not unique value will cause failure in MakeBooking, appropriate message will be returned to user)
@MPIN Moderator PIN. This is used by moderator to enter conference. If @AutoPINInd is set to 1, system will generate @CPIN and @MPIN. If it is set to 0, user has to specify unique value. If a unique value is not specified there is a failure in MakeBooking, appropriate message will be returned to user. If @ModeratorInd is set to 0, @CPIN and @MPIN have to be same.
@Information If p_cspi_MakeBooking failed to book new conference (DDI problem, PIN conflict, etc) @Information will contain problem description.
@ReservationRef If booking is successful, @ReservationRef will contain new Reservation reference.
@ConferenceRef If booking is successful, @ConferenceRef will contain new Reservation reference.
@AvailableInd Indicates if conference is available after booking.
@OperatorType Operator type value is predefined in table OperatorType. See below for details.
72 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 27: Parameter Descriptions
Parameter Description
@RecRetentionDays Recording retention days, valid only, if @RecordingInd is 1.
@RecordingComment Recording comments, valid only, if @RecordingInd is 1.
@TranscriptInd Indicates if a transcript of the conference is required.
@TapeInd Indicates that record cannot be erased until copied to cassette.
@PaymentType Payment type. If user specifies 0, value will be set to 5. See below for details.
@BillDiscount Discount in percents. Can be used for billing purposes.
@ContactName If not set, will be substituted by ContactName from Client information.
@ContactPhone If not set, will be substituted by ContactPhone from Client information.
@ContactFax If not set, will be substituted by ContactFax from Client information.
@ContactEMail If not set, will be substituted by ContactEMail from Client information.
@DataInd. Indicates if conference supports “data conferencing”.
@WelcomeMsg Welcome message. This has to correspond with proper language type. If not set, system will set default value.
@BellMsg Bell message. This has to correspond with proper language type. If not set, system will set default value.
@HoldMsg Hold message. This has to correspond with proper language type. If not set, system will set default value.
@TenMinuteMsg Ten minutes message. This has to correspond with proper language type. If not set, system will set default value.
73 Table 27: Parameter Descriptions
Parameter Description
@OneMinuteMsg One minute message. This has to correspond with proper language type. If not set, system will set default value.
@ConferenceFullMsg Conference full message. This has to correspond with proper language type. If not set, system will set default value.
@StartLaterMsg Start later message. This has to correspond with proper language type. If not set, system will set default value.
@InConferenceMsg In conference message. This has to correspond with proper language type. If not set, system will set default value.
@EnterPINCodeMsg Enter PIN code message. This has to correspond with proper language type. If not set, system will set default value.
@WelcomeFirstMsg Welcome first conferee message. This has to correspond with proper language type. If not set, system will set default value.
@HoldFirstMsg Hold first conferee message. This has to correspond with proper language type. If not set, system will set default value.
@TimeZoneType Specifies Timezone for conference. Value has to be from TimeZoneType table (can be retrieved from Wiz1 – front-end application). If is 0 – local Timezone.
@WaitForModeratorInd Indicates if first conferee has to wait for moderator to enter conference. p_cspi_MakeBooking This stored procedure is used to book new conferences. This applies to both scheduled and demand conferences. SP declaration: CREATE PROCEDURE p_cspi_MakeBooking
74 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide ( @ClientAccount UDTAccountRef, @PaymentNumberUDTPhone, @ConferenceNameUDTName, @ConferenceCommentsUDTComment, @ConferenceType UDTType, @LanguageType UDTType, @PriorityType UDTType, @StartDateTime datetime, @Duration smallint, @Conferees smallint, @SubConferees smallint, @TollFreeInd UDTFlag, @RecordingInd UDTFlag, @EnterToneInd UDTFlag, @LeavingToneInd UDTFlag, @QandAInd UDTFlag, @PollingInd UDTFlag, @RollCallInd UDTFlag, @BroadcastInd UDTFlag, @DemandInd UDTFlag, @RecordingPIN UDTPIN, @ModeratorInd UDTFlag, @AutoPINInd UDTFlag, @DDI UDTDDI= '' output, @CPIN UDTPIN= '' output, @MPIN UDTPIN= '' output, @Information UDTComment= '' output, @ReservationRef int= 0 output,
75 @ConferenceRef int= 0 output, @ActualDuration int = 0 output, @AvailableInd UDTFlag= 0 output, @OperatorType UDTType= 0, @RecRetentionDayssmallint= 7, @RecordingCommentsUDTComment= null, @TranscriptInd UDTFlag= 0, @TapeInd UDTFlag= 0, @PaymentType UDTType= 0, @BillDiscount tinyint = 0, @ContactName UDTName= null, @ContactPhone UDTPhone= null, @ContactFax UDTPhone= null, @ContactEMail UDTEMail= null, @DataInd UDTFlag= 0, @WelcomeMsg smallint= 0, @BellMsg smallint= 0, @HoldMsg smallint= 0, @TenMinuteMsg smallint= 0, @OneMinuteMsg smallint= 0, @ConferenceFullMsgsmallint= 0, @StartLaterMsg smallint= 0, @InConferenceMsgsmallint= 0, @EnterPINCodeMsgsmallint= 0, @WelcomeFirstMsgsmallint= 0, @HoldFirstMsg smallint= 0, @TimeZoneType UDTType= 0, @WaitForModeratorInd UDTFlag= 0, @PromptSet int = 0,)
76 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @NameonEntryIndUDT Flag = 0 @NameonExitInd UDT Flag= 0 Return Codes: 0=okay(check @AvailableInd to see if conference is available) ~=failure
Table 28: Make Booking Parameters
Item Type Output Description
@ClientAccount UDTAccountRef Input Adhoc AccReference of specified client (can be used value from p_cspi_AddClient sp). If you do not supply a valid client account number then the procedure will automatically generate a ub client to own this conference.
@PaymentNumber UDTPhone For more information see “Parameter Descriptions” on page 70.
@ConferenceName UDTName For more information see “Parameter Descriptions” on page 70.
@ConferenceComments UDTComment For more information see “Parameter Descriptions” on page 70.
@ConferenceType UDTType For more information see “Parameter Descriptions” on page 70.
@LanguageType UDTType For more information see “Parameter Descriptions” on page 70.
77 Table 28: Make Booking Parameters
Item Type Output Description
@PriorityType UDTType, For more information see “Parameter Descriptions” on page 70.
@StartDateTime datetime For more information see “Parameter Descriptions” on page 70.
@Duration smallint, For more information see “Parameter Descriptions” on page 70.
@Conferees smallint For more information see “Parameter Descriptions” on page 70.
@SubConferees smallint, For more information see “Parameter Descriptions” on page 70.
@TollFreeInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@RecordingInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@EnterToneInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@LeavingToneInd UDTFlag For more information see “Parameter Descriptions” on page 70..
@QandAInd UDTFlag, For more information see “Parameter Descriptions” on page 70.
78 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 28: Make Booking Parameters
Item Type Output Description
@PollingInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@RollCallInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@BroadcastInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@DemandInd UDTFlag It is not allowed to change conference from scheduled to demand, or from demand to scheduled.
@RecordingPIN UDTPIN For more information see “Parameter Descriptions” on page 70.
@ModeratorInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@AutoPINInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@DDI UDTDDI output For more information see “Parameter Descriptions” on page 70.
@CPIN UDTPIN output For more information see “Parameter Descriptions” on page 70.
@MPIN UDTPIN output For more information see “Parameter Descriptions” on page 70.
79 Table 28: Make Booking Parameters
Item Type Output Description
@Information UDTComment output For more information see “Parameter Descriptions” on page 70.
@ReservationRef int output For more information see “Parameter Descriptions” on page 70.
@AvailableInd UDTFlag output For more information see “Parameter Descriptions” on page 70.
@OperatorType UDTType= 0 For more information see “Parameter Descriptions” on page 70.
@RecRetentionDays smallint= 7 For more information see “Parameter Descriptions” on page 70.
@RecordingComments UDTComment= For more information see null “Parameter Descriptions” on page 70.
@TranscriptInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@TapeInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@PaymentType UDTType= 0 For more information see “Parameter Descriptions” on page 70.
@BillDiscount tinyint= 0 For more information see “Parameter Descriptions” on page 70.
80 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 28: Make Booking Parameters
Item Type Output Description
@ContactName UDTName= null For more information see “Parameter Descriptions” on page 70.
@ContactPhone UDTPhone= null For more information see “Parameter Descriptions” on page 70.
@ContactFax UDTPhone= null For more information see “Parameter Descriptions” on page 70.
@ContactEMail UDTEMail= null For more information see “Parameter Descriptions” on page 70.
@DataInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@WelcomeMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@HoldMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@BellMsg smallint=0 Bell message. Has to correspond with proper language type. It not set, the system will set default value.
@TenMinuteMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@OneMinuteMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
81 Table 28: Make Booking Parameters
Item Type Output Description
@ConferenceFullMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@StartLaterMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@InConferenceMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@EnterPINCodeMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@WelcomeFirstMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@HoldFirstMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@TimeZoneType UDTType= 0 For more information see “Parameter Descriptions” on page 70.
@WaitForModeratorInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@PromptSet int Input Include prompt set for conferences.
@NtfType UDTTpe Input Notification Types0 = None (Off)1 = Fax 2 = EMail3 = Fax and EMail
@NtfConfirmationInd UDTFlag Input Enabled sending of Confirmation notifications
82 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 28: Make Booking Parameters
Item Type Output Description
@NtfCancellationInd UDTFlag Input Enabled sending of Cancellation notifications
@NtfChangeInd UDTFlag Input Enabled sending of booking Changed notifications
@NtfReminderInd UDTFlag Input Enabled sending of Reminder notifications
@NtfAttendanceInd UDTFlag Input Enabled sending of Attendance notifications
@NtfComments UDTComment Input Notification Comments
@SelfRegInd UDTFlag Input Indicates that the Conferee can register them self for a conference via the Web portal
@NameonEntryInd UDTFlag Input Plays name on entry into the conference.
@NameonExitInd UDTFlag Input Plays name on exit from the conference. p_cspi_EditBooking The Edit Booking stored procedure edits parameters of the conferences identified by a Conference Reference number. Other parameters remain unchanged. For various reasons, similar to booking (e.g. insufficient resources at that time), it may happen that parameters can not be changed. The @Information provides an explanation of the problem. The conference is placed in the pre-editing state if any parameter is not changed. SP declaration /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int
83 declare @Information UDTComment declare @ConferenceRef int declare @ReservationRefint declare @DDI UDTDDI declare @CPIN UDTPIN declare @MPIN UDTPIN declare @ActualDurationint declare @AvailableInd UDTFlag declare @StartDateTimedatetime select @StartDateTime = dateadd (mi, 120, getdate()) select @ConferenceRef = 126654 --SET YOUR CONFERENCE REF HERE print 'Modifying booking details...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_EditBooking @ConferenceRef = @ConferenceRef, @PaymentNumber = 'payment', @ConferenceName = 'Test conference', @ConferenceComments= 'Comments', @ConferenceType = 1, @LanguageType = 1, @PriorityType = 2, @StartDateTime = @StartDateTime, @Duration = 120, @Conferees = 3, @SubConferees = 0,
84 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @TollFreeInd = 0, @RecordingInd = 0, @EnterToneInd = 1, @LeavingToneInd = 1, @QandAInd = 0, @PollingInd = 0, @RollCallInd = 0, @BroadcastInd = 0, @DemandInd = 0, @RecordingPIN = '', @ModeratorInd = 0, @AutoPINInd = 1, --pins will be auto generated, if 1 @DDI = @DDI output, @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Informationoutput, @ReservationRef = @ReservationRefoutput, @ActualDuration = @ActualDurationoutput, @AvailableInd = @AvailableIndoutput @NameonEntryInd UDT Flag = 0 @NameonExitInd UDT Flag= 0 /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0 and @AvailableInd = 1) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) print 'Reservation Ref: ' + convert(varchar, @ReservationRef)
85 print 'ActualDuration: ' + convert(varchar, @ActualDuration) print 'DDI: ' + @DDI print 'CPIN: ' + @CPIN print 'MPIN: ' + @MPIN end else begin print 'Test Failed. ' + @Information end
.
Table 29: Edit Booking Parameters
Item Type Output Description
@ConferenceRef int Specifies reference to conference, which requires changes.
@PaymentNumber UDTPhone For more information see “Parameter Descriptions” on page 70.
@ConferenceName UDTName For more information see “Parameter Descriptions” on page 70.
@ConferenceComments UDTComment For more information see “Parameter Descriptions” on page 70.
@ConferenceType UDTType For more information see “Parameter Descriptions” on page 70.
@LanguageType UDTType For more information see “Parameter Descriptions” on page 70.
86 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 29: Edit Booking Parameters
Item Type Output Description
@PriorityType UDTType, For more information see “Parameter Descriptions” on page 70.
@StartDateTime datetime For more information see “Parameter Descriptions” on page 70.
@Duration smallint, For more information see “Parameter Descriptions” on page 70.
@Conferees smallint For more information see “Parameter Descriptions” on page 70.
@SubConferees smallint, For more information see “Parameter Descriptions” on page 70.
@TollFreeInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@RecordingInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@EnterToneInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@LeavingToneInd UDTFlag For more information see “Parameter Descriptions” on page 70..
@QandAInd UDTFlag, For more information see “Parameter Descriptions” on page 70.
87 Table 29: Edit Booking Parameters
Item Type Output Description
@PollingInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@RollCallInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@BroadcastInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@DemandInd UDTFlag It is not allowed to change conference from scheduled to demand, or from demand to scheduled.
@RecordingPIN UDTPIN For more information see “Parameter Descriptions” on page 70.
@ModeratorInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@AutoPINInd UDTFlag For more information see “Parameter Descriptions” on page 70.
@DDI UDTDDI output For more information see “Parameter Descriptions” on page 70.
@CPIN UDTPIN output For more information see “Parameter Descriptions” on page 70.
@MPIN UDTPIN output For more information see “Parameter Descriptions” on page 70.
88 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 29: Edit Booking Parameters
Item Type Output Description
@Information UDTComment output For more information see “Parameter Descriptions” on page 70.
@ReservationRef int output For more information see “Parameter Descriptions” on page 70.
@ActualDuration int output For more information see “Parameter Descriptions” on page 70.
@AvailableInd UDTFlag output For more information see “Parameter Descriptions” on page 70.
@OperatorType UDTType= 0 For more information see “Parameter Descriptions” on page 70.
@RecRetentionDays smallint= 7 For more information see “Parameter Descriptions” on page 70.
@RecordingComments UDTComment= For more information see null “Parameter Descriptions” on page 70.
@TranscriptInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@TapeInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@PaymentType UDTType= 0 For more information see “Parameter Descriptions” on page 70.
89 Table 29: Edit Booking Parameters
Item Type Output Description
@BillDiscount tinyint= 0 For more information see “Parameter Descriptions” on page 70.
@ContactName UDTName= null For more information see “Parameter Descriptions” on page 70.
@ContactPhone UDTPhone= null For more information see “Parameter Descriptions” on page 70.
@ContactFax UDTPhone= null For more information see “Parameter Descriptions” on page 70.
@ContactEMail UDTEMail= null For more information see “Parameter Descriptions” on page 70.
@DataInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@WelcomeMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@HoldMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@TenMinuteMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@OneMinuteMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
90 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 29: Edit Booking Parameters
Item Type Output Description
@ConferenceFullMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@StartLaterMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@InConferenceMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@EnterPINCodeMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@WelcomeFirstMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@HoldFirstMsg smallint= 0 For more information see “Parameter Descriptions” on page 70.
@TimeZoneType UDTType= 0 For more information see “Parameter Descriptions” on page 70.
@WaitForModeratorInd UDTFlag= 0 For more information see “Parameter Descriptions” on page 70.
@PromptSet int Input Include prompt set for conferences.
@NtfType UDTTpe Input Notification Types: 0 = None (Off) 1 = Fax 2 = EMail 3 = Fax and EMail
91 Table 29: Edit Booking Parameters
Item Type Output Description
@NtfConfirmationInd UDTFlag Input Enabled sending of Confirmation notifications
@NtfCancellationInd UDTFlag Input Enabled sending of Cancellation notifications
@NtfChangeInd UDTFlag Input Enabled sending of booking Changed notifications
@NtfReminderInd UDTFlag Input Enabled sending of Reminder notifications
@NtfAttendanceInd UDTFlag Input Enabled sending of Attendance notifications
@NtfComments UDTComment Input Notification Comments
@SelfRegInd UDTFlag Input Indicates that the Conferee can register them self for a conference via the Web portal
@NameonEntryInd UDTFlag Input Plays name on entry into the conference.
@NameonExitInd UDTFlag Input Plays name on exit from the conference. p_cspi_DeleteBooking This stored procedure allows the user to delete previously created conference. SP declaration: CREATE PROCEDURE p_cspi_DeleteBooking ( @ConferenceRef int, @Information UDTCommentoutput )
92 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Return Codes: 0=okay ~=failure Parameters:
Table 30: Delete Booking Parameters
Parameter Type Input/ Output Description
@ ConferenceRef int input Specifies reference to conference, which is requested to delete.
@Information UDTCom output only If p_cspi_ DeleteBooking failed to ment delete conference, @Information will contain problem description. p_cspi_GetConferenceDetails Procedure returns details of Conference with specified @ConferenceRef SP declaration: CREATE PROCEDURE p_cspi_GetConferenceDetails ( @ConferenceRef int, @Information UDTComment output ) Return Codes: 0=okay ~=failure
Note: For more information on the parameters, see “p_cspi_EditBooking” on page 83.
93 Returned record set returns the following data:.
Table 31: Returned Record Set
Field Type
ConferenceRef Int
ReservationRef Int
ParentConferenceRef Int
ConferenceStatusType UDTType
ConferenceStartDateTime UDTDateTime
ConferenceEndDateTime UDTDateTime
ConferenceOriginalDuration Smallint
ConferenceType UDTType
ConferenceLanguageType UDTType
ConferencePriorityType UDTType
ConferenceName UDTName
Conference Comments UDTComment
NumberOfSubConferees Smallint
NumberOfParticipants Smallint
ModeratorInd UDTFlag
DemandInd UDTType
CallChairmanParticipantRef Int
AllocationType UDTType
Reception Smallint
PaymentType UDTType
PaymentNumber UDTPhone
BillDiscount Tinyint
LocalDigits Tinyint
94 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 31: Returned Record Set
Field Type
ContactName UDTName
ContactPhone UDTPhone
ContactFax UDTPhone
ContactEmail UDTEMail
RecordingInd UDTFlag
RecordingRetentionDays Smallint
RecordingPIN UDTPIN
RecordingComments UDTComment
TranscriptInd UDTFlag
TapeInd UDTFlag
MailTapePriorityType UDTType
PlaybackDDI UDTDDI
NotificationType UDTType
NtfConfirmationInd UDTFlag
NtfCancellationInd UDTFlag
NtfChangeInd UDTFlag
NtfReminderInd UDTFlag
NtfComments UDTComment
DataInd UDTFlag
DataUsername UDTName
DataPassword UDTPassword
DataCode UDTPassword
DataURL UDTComment
AdvertiseConferenceInd UDTFlag
95 Table 31: Returned Record Set
Field Type
AdvertiseRecordingInd UDTFlag
NtfAttendanceInd UDTFlag
WelcomeFirstMsg Smallint
WelcomeMsg Smallint
BellMsg Smallint
HoldFirstMsg Smallint
HoldMsg Smallint
ConferenceFullMsg Smallint
StartLaterMsg Smallint
PINIncorrectMsg Smallint
PlacedInConferenceMsg Smallint
EnterPINMsg Smallint
ConferenceHasBeenExtendedMsg Smallint
TenMinuteWarningMsg Smallint
OneMinuteWarningMsg Smallint
BroadcastModeInd UDTFlag
PolycomInd UDTFlag
RollCallInd UDTFlag
PollingInd UDTFlag
QandAInd UDTFlag
TollFreeInd UDTFlag
EnterToneInd UDTFlag
LeavingToneInd UDTFlag
AcpcId UDTFlag
96 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 31: Returned Record Set
Field Type
ModificationCount Smallint
ModificationDateTime UDTDateTime
CancelledInd UDTFlag
CancelledDateTime UDTDateTime
AutoPINInd UDTFlag
UsesCPIN UDTPIN
UsesMPIN UDTPIN
OperatorType UDTType
TimeZoneType UDTType
TimeZoneStartDateTime UDTDateTime
UsesDDI UDTDDI
LockedInd UDTFlag
StreamLiveInd UDTFlag
StreamPlaybackInd UDTFlag
ExtensionCount Smallint
WaitForModeratorInd UDTFlag
NameonEntryInd UDTFlag
NameonExitInd UDTFlag p_cspi_ExtendConference This sp allows to extent conference duration and maximum conferee number. SP declaration: ( CREATE PROCEDURE p_cspi_ExtendConference @ConferenceRef int
97 @NewDuration smallint @NewConferees smallint @Information UDTCommentOutput ) Return Codes: 0=okay ~=failure
Table 32: Extend Conference
Item Type Output Description
@ConferenceRef int Specifies reference to conference, which requires extension.
@NewDuration Smallint Specifies new duration value. Value has to be between MinConferenceSize and MaxConferenceSize. Max and Min values are available as system parameters. Can be viewed and modified from CRS Front-end(System Administration->Parameters). If value is bigger, then maximum (or smaller then minimum) allowed – error message will be returned.
98 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 32: Extend Conference
Item Type Output Description
@NewConferees smallint Specifies new maximum conferee number. If set to 0, will be substituted with minimum allowed value.Value has to be between MinConferenceDurationMinutes and MaxConferenceDurationMinutes. Max and Min values are available as system parameters. Can be viewed and modified from CRS Front-end(System Administration->Parameters). If value is bigger, then maximum (or smaller then minimum) allowed – error message will be returned.
@Information UDTComment output If p_cspi_ExtendConference failed to change conference @Information will contain problem description p_cspi_CloseConference This procedure enables the participant to close previously created conference. This stored procedure is valid for scheduled conferences only (not demand). This stored procedure is a request to close scheduled conference. However, the Operator Console can extend conference duration, if there are conferees present. SP declaration: CREATE PROCEDURE p_cspi_CloseConference ( @ConferenceRef int, @Information UDTComment output ) Return Codes: 0=okay
99 ~=failure
Table 33: Close Conference Parameters
Parameter Type Input/ Output Description
@ ConferenceRef int input Specifies reference to the conference that has been selected for deletion.
@Information UDTComment output only If p_cspi_ DeleteBooking failed to delete conference, @Information will contain problem description.
100 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Enumerated Types
ConferenceType
Table 34: Conference Type
Number Type 1 Meet Me Direct 2 Meet Me Operator Assisted 3 Management Alert 4 Dial Out Operator 5Self Dial 6 Recording 7 Taping 8Fax 9 Playback 10 Marketeer 11 Crisis Alert 12 Volunteer Alert 13 Meet Me Secure
LanguageType (Example)
Table 35: Language Type
Number Language 1 English 2 Mandarin 3 Japanese 4 Malaysian
Only 4 languages are allowed, but language names can be changed during CRS setup. EMS messages has to correspond appropriate LanguageType.
101 Priority Type
Table 36: Priority Type
Number Priority
1Low
2Normal
3 High
Operator Type
Table 37: Operator Type
Number Priority
0 None
1Assisted
2 Dedicated
Payment Type
Table 38: Payment Type
Number Abbreviation Payment Type
1 DN Dial Number
2 ICC International Calling Card
3 CLI Call Line Identification
4 AR Account Reference
5 UC User Code
CS700 Stored Procedures
102 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Note: It is important to note that the CS700 stored procedures apply to the CRS on the CS700, S6200, and S6800 conferencing servers. p_cspi_S700_MakeBooking This Stored Procedure is used to book a new CS700 conference, scheduled or demand. Conferences can be only “single day scheduled” or “demand”. SP p_cspi_S700_MakeBooking declaration: CREATE PROCEDURE dbo.p_cspi_S700_MakeBooking ( @ClientAccount UDTAccountRef, @ConferenceNameUDTName, @StartDateTime datetime, @Duration int, @CodeDuration int, @MaxLines int, @EntryToneType int, @ExitToneType int, @ModeratorInd UDTFlag, @AutoPINInd UDTFlag, @ContactPhone UDTPhone = '', @CPIN UDTPIN = '' output, @MPIN UDTPIN = '' output, @Information UDTComment = '' output, @ReservationRef int = 0 output, @ConfirmNum int = 0 output, @ExtPortsAllowed UDTFlag= 0, @ModHangupInd UDTFlag= 0, @MusicInd UDTFlag= 0, @SecurityInd UDTFlag= 0, @AttendedInd UDTFlag= 0,
103 @EnabledInd UDTFlag= 0, @QandAInd UDTFlag= 0, @PollingInd UDTFlag= 0, @DemandInd UDTFlag= 0, @BillCodeInd UDTFlag= 0, @ExtDurationAllowedUDTFlag= 0, @InProgressInd UDTFlag= 0, @DataInd UDTFlag= 0, @ConfViewerInd UDTFlag= 0, @ExtRecordInd UDTFlag= 0, @SecureCodeInd UDTFlag= 0, @AuxCodeInd UDTFlag= 0, @BlockDialOutInd UDTFlag= 0, @GlobalInd UDTFlag= 0, @SelfRegInd UDTFlag= 0, @TimeZone varchar(64)= ‘’, @PINmode int = 0, @PINListName UDTName= ‘’, @NRPmode int = 0, @NRPAnnun int = 0, @MusicSrc int = 0, @BlastMode int = 0, @BlastAnnun int = 0, @DialList UDTName= ‘’, @BillingConfID UDTName= ‘’, @SignInName UDTName= ‘’, @ClientTimeZone int = 0, @GlobalID int = 0, @GlobalIDHi int = 0,
104 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @DTMFCommandSetint = 0, @HelplessInd UDTFlag= 0, @DisableOptionModIndUDTFlag= 0 @ConferenceComments UDTComment= '', @PromptSet int = 0, @NtfType UDTType= 0, @NtfConfirmationIndUDTFlag= 0, @NtfCancellationIndUDTFlag= 0, @NtfChangeInd UDTFlag= 0, @NtfReminderInd UDTFlag= 0, @NtfAttendanceInd UDTFlag= 0, @NtfComments UDTComment= '', @NtfContactFax UDTPhone= '', @NtfContactEMail UDTEMail= '' )
SP declaration: /****************************************************************** * Local variables *****************************************************************/ declare @Now datetime declare @RetCode int declare @ConfirmNum int declare @StartDateTimedatetime declare @MPIN varchar(16) declare @CPIN varchar(16) declare @Information UDTComment declare @ReservationRefint declare @ConferenceName UDTName
105 declare @ClientAccountRef UDTAccountRef set @Now = dateadd ( mi, 10 , getdate() ) set @ConfirmNum = 0 set @StartDateTime= dateadd( mi, 20, getdate() ) –- SET YOUR VALUE HERE set @MPIN = ''–- SET YOUR VALUE HERE set @CPIN = ''–- SET YOUR VALUE HERE set @Information = '' set @ReservationRef= 0 set @ConferenceName= 'Test S700 conference' + convert( varchar, getdate() ) set @ClientAccountRef= '2344266762' –- SET YOUR VALUE HERE print 'Test p_cspi_S700_MakeBooking, using ClientAccountRef=' + convert( varchar, @ClientAccountRef )
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_S700_MakeBooking @ClientAccount = @ClientAccountRef, @ConferenceName = @ConferenceName, @StartDateTime = @StartDateTime, @Duration = 20, @CodeDuration = 0, @MaxLines = 3, @EntryToneType = 0,
106 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @ExitToneType = 0, @ModeratorInd = 1, @AutoPINInd = 1, @ContactPhone = '2070000', @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Information output, @ReservationRef = @ReservationRef output, @ConfirmNum = @ConfirmNum output, @ExtDurationAllowed= 0, @ExtPortsAllowed = 0, @ModHangupInd = 0, @MusicInd = 0, @SecurityInd = 0, @AttendedInd = 0, @EnabledInd = 1, @QandAInd = 0, @PollingInd = 0, @DemandInd = 0, @BillCodeInd = 0, @InProgressInd = 0, @DataInd = 0, @ConfViewerInd = 0, @ExtRecordInd = 0, @SecureCodeInd = 0, @AuxCodeInd = 0, @BlockDialOutInd = 0, @GlobalInd = 0, @SelfRegInd = 0,
107 @TimeZone = '', @PINmode = 0, @PINListName = '', @NRPmode = 0, @NRPAnnun = 0, @MusicSrc = 0, @BlastMode = 0, @BlastAnnun = 0, @DialList = '', @BillingConfID = '', @SignInName = '', @ClientTimeZone = 0, @GlobalID = 0, @GlobalIDHi = 0, @DTMFCommandSet= 0 print 'Return Code = ' + convert( varchar, @RetCode ) print 'New confirm num = ' + convert( varchar, @ConfirmNum ) print 'CPIN: ' + @CPIN + ', MPIN: ' + @MPIN print 'Information: ' + @Information
Parameters description:
Note: In the current release, there is an issue with the p_cspi_Test_S700_MakeBooking procedure. If the @ClientTimeZone parameter is set to a value, such as 5, the
108 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide time zone is not updated on the CRS Front End when the procedure is executed. The CRS Front End timezone remains at the default value; Local.t
Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@ClientAccount UDT input Client account reference. Same Account as Adhoc AccountReference and Ref schapi UserName.
@ConferenceName UDTName input Conference name.
@StartDateTime datetime input Start Date/Time of the Conference. Format YYYYMMDD HH:MM:SS
@Duration int input Duration of conference in Minutes.
@CodeDuration int input Duration in minutes that CPIN and MPIN codes can be used to enter the conference.
@MaxLines int input Max Lines/ports. Same as @Conferees in p_cspi_MakeBooking
@EntryToneType int input Entry Tone Type Value: 0 OFF 1 System 2 Tone 3 Message 4 Both
@ExitToneType int input Exit Tone Type Value: 0 OFF 1 System 2 Tone 3 Message 4 Both
109 Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@ModeratorInd UDTFlag input Indicates, if conference supports moderator control. If ‘ModeratorInd’ = 0 then ‘MPIN’ will be set to the same value as ‘CPIN’.
@AutoPINInd UDTFlag input Indicator, which requests auto generation of @MPIN and @CPIN. If it is 0, user has to specify @CPIN and @MPIN. If it is 1, values will be auto generated and returned as output parameters.
@ContactPhone UDTPhone input Contact phone
@CPIN UDTPIN input/ output Conferee PIN that is used by conferee to enter conference. If @AutoPINInd is set to 1, system will generate @CPIN and @MPIN. If 0, user has to specify unique value (Not unique value will cause failure in booking, appropriate message will be returned to user)
@MPIN UDTPIN Moderator PIN that is used by moderator to enter conference. If @AutoPINInd is set to 1, system will generate @CPIN and @MPIN. If 0, user has to specify unique value (Not unique value will cause failure in booking, appropriate message will be returned to user). If @ModeratorInd is set to 0, @CPIN and @MPIN has to be same.
110 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@Information UDTComm output only If p_cspi_S700_MakeBooking ent failed to book new conference (DDI problem, PIN conflict, etc) @Information will contain problem description.
@ReservationRef int output only If booking is successful, @ReservationRef will contain new Reservation reference.
@ConfirmNum int output p_cspi_S700_MakeBooking will generate this value. @ConfirmNum will be the same as @ConferenceRef (as in p_cspi_MakeBooking) Should be 0, if system parameter @ConfirmationHigh = 0, so @ConfirmNum will be autogenerated. If user wants to set custom value to @ConfirmNum, system parameter @ConfirmationHigh has to be set to 1.
@ExtPortsAllowed UDTFlag input When this parameter is set, the Extend Ports Allowed feature is enabled. Default= 0
@ModHangupInd UDTFlag input When this parameter is set, the Moderator Hang Up feature is enabled. Default= 0
@MusicInd UDTFlag input When this parameter is set, the Music On feature is enabled. Default= 0
111 Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@SecurityInd UDTFlag input When this parameter is set, the Security Allowed feature is enabled. Default= 0
@AttendedInd UDTFlag input When this parameter is set, the Attended Mode feature is enabled. Default= 0
@EnabledInd UDTFlag input When this parameter is set, the Enabled Status feature is enabled. Default= 0
@QandAInd UDTFlag input When this parameter is set, the QA Mode On feature is enabled. Default= 0
@PollingInd UDTFlag input When this parameter is set, the Poll Mode On feature is enabled. Default= 0
@DemandInd UDTFlag input When this parameter is set, the On Demand feature is enabled. Default= 0
@BillCodeInd UDTFlag input When this parameter is set, the Bill Code feature is enabled. Default= 0
@ExtDurationAllow UDTFlag input When this parameter is set, the ed Extend Duration Allowed feature is enabled. Default= 0
112 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@InProgressInd UDTFlag input When this parameter is set, the Modify in Progress feature is enabled. Default= 0
@DataInd UDTFlag input When this parameter is set, the Data conference feature is enabled - the conference is associated with a Data Conferencing application. Default= 0
@ConfViewerInd UDTFlag input When this parameter is set, the Conference Viewer feature is enabled - the conference is associated with a Conference Viewer application. Default= 0
@ExtRecordInd UDTFlag input @ExtRecordInd indicates if external conference recording is supported.0(zero)= ON-BRIDGE/OFF. 1=OFF-BRIDGE.
@SecureCodeInd UDTFlag input When this parameter is set, the Add Security Code feature is enabled. The system prompts the Moderator of a Flexflow conference to an additional security code for this conference. Default= 0
@AuxCodeInd UDTFlag input When this parameter is set, the Aux Code feature is enabled. The system prompts the Moderator of a Flexflow conference for an additional code, such as a billing code. Default= 0
113 Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@BlockDialOutInd UDTFlag input When this parameter is set, the Block Dial Outs feature is enabled. In this situation, the conference may not dial out. Default= 0
@GlobalInd UDTFlag input When this parameter is set, the Global Conference feature is enabled. In this situation, this conference is associated with a global conference occurring on more than one bridge. Default=0
@SelfRegInd UDTFlag input When this parameter is set, the Self Registration feature is enabled. In this situation, the conference is associated with a Web-based, Self-Registration application. This flag is used internally with the CRS application. Default=0
@TimeZone varchar(64) input TimeZone description. This field is just information tag about timezone. TimeZone value is set in parameter @ClientTimeZone – see below. Default= 0
114 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@PINMode int input Style of PIN code usage. The table below describes the meaning of each valid value. Value: 0 [null] 1 None 2 Any 3 Restrict to list Default= 0
@PINListName UDTName input Conference PIN list. Valid only if the conference PIN style is set to PIN list. When pinmode is set to 3, there must be a non-empty string in this field. Otherwise, the value of this field is irrelevant. Default= 0
@NrpMode int input Name record/playback setting. Valid values are in the following table. Value: 0 [null] 1 Off 2 Individual 3 Conference. Default= 0
@NRPAnnun int input Annunciator to play to conferees when in Operator only NRP mode. Default= 0
115 Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@MusicSrc int input If the bridge supports multiple music sources, this byte may be set to values from 1 to 4 to specify the corresponding music source. The music bit in the flags byte controls (@MusicInd in this stored procedure)) whether to turn music on or off. If the bridge does not support multiple music sources or if this byte is set to zero, the default music source is used as indicated by the flags byte. The musicsrc byte should be set to zero when not required. Default= 0
@BlastMode int input Unattended blast mode. Where codes are interpreted as: Code Setting 0 Null 1 OFF. Unattended blast mode is off 2 MANUAL. An operator must start the unattended blast mode 3 AUTO The unattended blast occurs when the first moderator joins the conference via a security code (not when placed in the conference by an operator). Default= 0
@BlastAnnun int input Represents the annunciator message which will be played in the loop to the lines what were blast dialled. Default= 0
116 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@DialList UDTName input Conference dial list name. This field may be empty. Default= 0
@BillingConfID UDTName input Conference ID Default= 0
@SignInName UDTName input Signin. Name of account which created the conference. Default= 0
@ClientTimeZone int input Client TimeZone. Timezone difference, in seconds, from GMT to the timezone this conference is scheduled to occur in (determined by the client that created this entry). Default= 0
@GlobalID int input Global Conference ID for this reservation. Default=0.
@GlobalDHi int input Global Conference ID for this reservation. Default= 0
@DTMFCommand int input When set to 0 the conference call Set flow is the standard flow. When set to 1 the conference call flow is set to flexflow (demand must be set to 1 and Attended set to 0 for this option). Default = 0.
@HelplessInd UDTFlag input Flag, which sets “Disable Operator Help“. Users pressing *0 hear an annunciator stating, Operator Assistance is not available.
117 Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@DisableOptionMo UDTFlag input When set to 1, disables the ability dInd to change conference options on a per conference basis. After a Leader entersthe Leader PIN, the leader is not prompted to press 1 to start conference.
@ConferenceCom UDTComm input Conference Comments ments ent
@PromptSet Int input Indicates the CS700 Language, 0 will indicate that the default language will be usedValid values are 0 to 20
@NftType UDTType input Notification Types : 0 = None (Off) 1 = Fax - Not used on CS700 systems 2 = EMail 3 = Fax and Email -- not used on CS700 systems
@NftConfirmationIn UDTFlag input Enabled sending of Confirmation d notifications
@NftCancellationIn UDTFlag input Enabled sending of Cancellation d notifications
@NftChangeInd UDTFlag input Enabled sending of booking Changed notifications
@NftReminderInd UDTFlag input Enabled sending of Reminder notifications
@NftAttendanceInd UDTFlag input Enabled sending of Attendance notifications
@NftComments UDTComm input Notification Comments ent
118 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 39: Make CS700 booking Parameters
Parameter Type Input/ Output Description
@NftContactFax UDTPhone input Notification Contact Fax-- Field currently not used on CS700 systems --
@NftContactMail UDTEmail input Notification Contact Email p_cspi_S700_EditBooking This Stored Procedure is used to Edit an existing CS700 reservation/conference. SP p_cspi_S700_EditBooking declaration: CREATE PROCEDURE dbo.p_cspi_S700_EditBooking ( @ConfirmNum int = 0 output, @ConferenceNameUDTName, @StartDateTime datetime, @Duration int, @CodeDuration int, @MaxLines int, @EnterToneType int, @LeavingToneTypeint, @ModeratorInd UDTFlag, @AutoPINInd UDTFlag, @ContactPhone UDTPhone= '', @CPIN UDTPIN = '' output, @MPIN UDTPIN = '' output, @Information UDTComment = '' output, @ExtPortsAllowed UDTFlag= 0 output, @ModHangupInd UDTFlag= 0 output, @MusicInd UDTFlag= 0 output,
119 @SecurityInd UDTFlag= 0 output, @AttendedInd UDTFlag= 0 output, @EnabledInd UDTFlag= 0 output, @QandAInd UDTFlag= 0 output, @PollingInd UDTFlag= 0 output, @DemandInd UDTFlag= 0 output, @BillCodeInd UDTFlag= 0 output, @ExtDurationAllowedUDTFlag= 0 output, @InProgressInd UDTFlag= 0 output, @DataInd UDTFlag= 0, @ConfViewerInd UDTFlag= 0, @ExtRecordInd UDTFlag= 0, @SecureCodeInd UDTFlag= 0, @AuxCodeInd UDTFlag= 0, @BlockDialOutInd UDTFlag= 0, @GlobalInd UDTFlag= 0, @SelfRegInd UDTFlag= 0, @TimeZone varchar(64)= ‘’, @PINmode int = 0, @PINListName UDTName= '', @NRPmode int = 0, @NRPAnnun int = 0, @MusicSrc int = 0, @BlastMode int = 0, @BlastAnnun int = 0, @DialList UDTName= ‘’, @BillingConfID UDTName= ‘’, @SignInName UDTName= ‘’, @ClientTimeZone int = 0,
120 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @GlobalID int = 0, @GlobalIDHi int = 0, @DTMFCommandSetint = 0, @ConferenceRefInProg int = 0output, @HelplessInd UDTFlag= 0, @DisableOptionModIndUDTFlag= 0, @ConferenceComments UDTComment= '', @PromptSet int = 0, @NtfType UDTType= 0, @NtfConfirmationIndUDTFlag= 0, @NtfCancellationIndUDTFlag= 0, @NtfChangeInd UDTFlag= 0, @NtfReminderInd UDTFlag= 0, @NtfAttendanceInd UDTFlag= 0, @NtfComments UDTComment= '', @NtfContactFax UDTPhone= '', @NtfContactEMail U DTEMail= '' )
CREATE PROCEDURE dbo.p_cspi_S700_EditBooking ( @ConfirmNum int = 0 output, @ConferenceNameUDTName, @StartDateTime datetime, @Duration int, @CodeDuration int, @MaxLines int, @EnterToneType int, @LeavingToneTypeint,
121 @ModeratorInd UDTFlag, @AutoPINInd UDTFlag, @ContactPhone UDTPhone = '', @CPIN UDTPIN = '' output, @MPIN UDTPIN = '' output, @Information UDTComment = '' output, @ExtPortsAllowed UDTFlag= 0 output, @ModHangupInd UDTFlag= 0 output, @MusicInd UDTFlag= 0 output, @SecurityInd UDTFlag= 0 output, @AttendedInd UDTFlag= 0 output, @EnabledInd UDTFlag= 0 output, @QandAInd UDTFlag= 0 output, @PollingInd UDTFlag= 0 output, @DemandInd UDTFlag= 0 output, @BillCodeInd UDTFlag= 0 output, @ExtDurationAllowedUDTFlag= 0 output, @InProgressInd UDTFlag= 0 output, @DataInd UDTFlag= 0, @ConfViewerInd UDTFlag= 0, @ExtRecordInd UDTFlag= 0, @SecureCodeInd UDTFlag= 0, @AuxCodeInd UDTFlag= 0, @BlockDialOutInd UDTFlag= 0, @GlobalInd UDTFlag= 0, @SelfRegInd UDTFlag= 0, @TimeZone varchar(64)= ‘’, @PINmode int = 0, @PINListName UDTName= '',
122 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @NRPmode int = 0, @NRPAnnun int = 0, @MusicSrc int = 0, @BlastMode int = 0, @BlastAnnun int = 0, @DialList UDTName= ‘’, @BillingConfID UDTName= ‘’, @SignInName UDTName= ‘’, @ClientTimeZone int = 0, @GlobalID int = 0, @GlobalIDHi int = 0, @DTMFCommandSetint = 0, @ConferenceRefInProg int = 0 output, @HelplessInd UDTFlag= 0, @DisableOptionModIndUDTFlag= 0, @ConferenceComments UDTComment= '', @PromptSet int = 0, @NtfType UDTType= 0, @NtfConfirmationIndUDTFlag= 0, @NtfCancellationIndUDTFlag= 0, @NtfChangeInd UDTFlag= 0, @NtfReminderInd UDTFlag= 0, @NtfAttendanceInd UDTFlag= 0, @NtfComments UDTComment= '', @NtfContactFax UDTPhone= '', @NtfContactEMail UDTEMail= '' ) SP declaration: /******************************************************************
123 * Local variables *****************************************************************/ declare @Now datetime declare @RetCode int declare @StartDateTimedatetime declare @MPIN varchar(16) declare @CPIN varchar(16) declare @Information UDTComment declare @ReservationRefint declare @ConferenceName UDTName declare @ConfRefInProgint declare @ConfirmNum int
set @Now = dateadd ( mi, 10 , getdate() ) set @StartDateTime= dateadd( mi, 30, getdate() ) –- SET YOUR VALUE HERE set @MPIN = ''–- SET YOUR VALUE HERE set @CPIN = ''–- SET YOUR VALUE HERE set @Information = '' set @ReservationRef= 0 set @ConferenceName= 'Test CS700 conference' + convert( varchar, getdate() ) set @ConfRefInProg= 0 set @ConfirmNum = 123567 –- SET YOUR VALUE HERE print 'Test p_cspi_S700_'
/******************************************************************
124 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_S700_EditBooking @ConfirmNum = @ConfirmNum output, @ConferenceName = @ConferenceName, @StartDateTime = @StartDateTime, @Duration = 30, @CodeDuration = 0, @MaxLines = 3, @EntryToneType = 0, @ExitToneType = 0, @ModeratorInd = 1, @AutoPINInd = 0, @ContactPhone = '2070000', @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Information output, @ExtDurationAllowed= 0, @ExtPortsAllowed = 0, @ModHangupInd = 0, @MusicInd = 0, @SecurityInd = 0, @AttendedInd = 0, @EnabledInd = 1, @QandAInd = 0, @PollingInd = 0, @DemandInd = 0, @BillCodeInd = 0, @InProgressInd = 0,
125 @DataInd = 0, @ConfViewerInd = 0, @ExtRecordInd = 0, @SecureCodeInd = 0, @AuxCodeInd = 0, @BlockDialOutInd = 0, @GlobalInd = 0, @SelfRegInd = 0, @TimeZone = '', @PINmode = 0, @PINListName = '', @NRPmode = 0, @NRPAnnun = 0, @MusicSrc = 0, @BlastMode = 0, @BlastAnnun = 0, @DialList = '', @BillingConfID = '', @SignInName = '', @ClientTimeZone = 0, @GlobalID = 0, @GlobalIDHi = 0, @DTMFCommandSet= 0, @ConferenceRefInProg= @ConfRefInProg output print 'Return Code = ' + convert( varchar, @RetCode ) print 'Confirm num = ' + convert( varchar, @ConfirmNum ) print 'CPIN: ' + @CPIN + ', MPIN: ' + @MPIN print 'Information: ' + @Information
126 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Parameters description:
Note: In the current release, there is an issue with the p_cspi_Test_S700_EditBooking procedure. If the value of @BlastAnnun is updated using p_cspi_Test_S700_EditBooking (for example, @BlastAnnun=0 is updated to @BlastAnnun=112, or any number), the procedure executes correctly and the field is updated. However, the value cannot be changed back to its original state.
Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@ConfirmNum int input/ output Confirmation (ConferenceRef) of the conference to change. @ConfirmNum will be the same as @ConferenceRef (as in p_cspi_MakeBooking)
@ConferenceName UDTName input Conference name
@StartDateTime datetime input Start Date/Time of the Conference Format YYYYMMDD HH:MM:SS
@Duration int input Duration of conference in Minutes
@CodeDuration int input Duration in minutes that CPIN and MPIN codes can be used to enter the conference after it begins.
@MaxLines int input Max Lines/ports. Same as @Conferees in p_cspi_EditBooking
127 Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@EntryToneType int input Entry Tone Type Value: 0=OFF 1=System 2=Tone 3=Message 4=Both
@ExitToneType int input Exit Tone Type Value: 0=OFF 1=System 2=Tone 3=Message 4=Both
@ModeratorInd UDTFlag input Indicates, if conference supports moderator control. If ‘ModeratorInd’ = 0 then ‘MPIN’ will be set to the same value as ‘CPIN’.
@AutoPINInd UDTFlag input It is disabled in this stored procedure. Bridge doesn’t allow to auto generate PINs, when editing conference.
@ContactPhone UDTPhone input Contact phone
@CPIN UDTPIN input/ output Conferee PIN, which is used by conferee to enter conference. Should be set to non zero value, because PIN auto generation is not supported in edit booking.
128 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@MPIN UDTPIN Moderator PIN, which is used by moderator to enter conference. Should be set to non zero value for moderated conferences, because PIN auto generation is not supported in edit booking.
@Information UDTComment output only If p_cspi_S700_EditBooking failed to book new conference (DDI problem, PIN conflict, etc) @Information will contain problem description.
@ExtPortsAllowed UDTFlag input/ output When this parameter is set, the Extend Ports Allowed feature is enabled. Default= 0
@ModHangupInd UDTFlag input/ output When this parameter is set, the Mod Hangup On feature is enabled. Default= 0
@MusicInd UDTFlag input/ output When this parameter is set, the Music On feature is enabled. Default= 0
@SecurityInd UDTFlag input/ output When this parameter is set, the Security Allowed feature is enabled. Default= 0
@AttendedInd UDTFlag input/ output When this parameter is set, the Attended Mode feature is enabled. Default= 0
129 Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@EnabledInd UDTFlag input/ output When this parameter is set, the Enabled Status feature is enabled. Default= 0
@QandAInd UDTFlag input/ output When this parameter is set, the QA Mode On feature is enabled. Default= 0
@PollingInd UDTFlag input/ output When this parameter is set, the Poll Mode On feature is enabled. Default= 0
@DemandInd UDTFlag input/ output When this parameter is set, the On Demand feature is enabled. Default= 0
@BillCodeInd UDTFlag input/ output When this parameter is set, the Bill Code feature is enabled. Default= 0
@ExtDurationAllowe UDTFlag input/ output When this parameter is set, d the Extend Duration Allowed feature is enabled. Default= 0
@InProgressInd UDTFlag input/ output When this parameter is set, the Modify in Progress feature is enabled. Default= 0
130 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@DataInd UDTFlag input When this parameter is set, the Data Conference feature is enabled. In this situation, this conference is associated with a Data Conferencing application. Default= 0
@ConfViewerInd UDTFlag input When this parameter is set, the Conference Viewer feature is enabled. In this situation, this conference is associated with a Conference Viewer application. Default= 0
@ExtRecordInd UDTFlag input @ExtRecordInd indicates if external conference recording is supported.0(zero)= ON-BRIDGE/OFF. 1=OFF-BRIDGE.
@SecureCodeInd UDTFlag input When this parameter is set, the Add Security Code feature is enabled. In this situation, the system prompts the Moderator of a Flexflow conference for an additional security code for this conference. Default= 0
131 Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@AuxCodeInd UDTFlag input When this parameter is set, the Aux Code feature is enabled. In this situation, the system prompts the Moderator of a Flexflow conference for an additional code, such as a billing code. Default= 0
@BlockDialOutInd UDTFlag input When this parameter is set, the Block Dial Outs feature is enabled. In this situation, this conference may not dial out. Default= 0
@GlobalInd UDTFlag input When this parameter is set, the Global Conference feature is enabled. In this situation, this conference is associated with a global conference occurring on more than one bridge. Default= 0
@SelfRegInd UDTFlag input When this parameter is set, the Self Registration feature is enabled. In this situation, this conference is associated with a Web-based, Self Registration application. This flag is used internally with the CRS application. Default= 0
132 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@TimeZone varchar(64) input TimeZone description. This field is just information tag about timezone. TimeZone value is set in parameter @ClientTimeZone – see below. Default=0
@PINMode int input Style of PIN code usage. The table below describes the meaning of each valid value. Value: 0 [null] 1 None 2 Any 3 Restrict to list Default=0
@PINListName UDTName input Conference PIN list. Valid only if the conference PIN style is set to PIN list. When pinmode is set to 3, there must be a non-empty string in this field. Otherwise, the value of this field is irrelevant. Default=0
@NrpMode int input Name record/playback setting. Valid values are in the following table. Value Setting 0 [null] 1 Off 2 Individual 3 Conference Default=0
133 Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@NRPAnnun int input Annunciator to play to conferees when in Operator only NRP mode. Default=0
@MusicSrc int input If the bridge supports multiple music sources, this byte may be set to values from 1 to 4 to specify the corresponding music source. The music bit in the flags byte controls (@MusicInd in this stored procedure)) whether to actually turn music on or off. If the bridge does not support multiple music sources or if this byte is set to zero, the default music source is used as indicated by the flags byte. The musicsrc byte should be set to zero when not required. Default=0
134 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@BlastMode int input Unattended blast mode. Where codes are interpreted as: Code Setting 0 Null 1 OFF Unattended blast mode is off 2 MANUAL AN operator must start the unattended blast mode 3 AUTO The unattended blast occurs when the first moderator joins the conference via a security code (not when placed in the conference by an operator) Default=0
@BlastAnnun int input Represents the annunciator message that is played in the loop to the lines what were blast dialled. Default=0
@DialList UDTName input Conference dial list. This field may be empty. Default=0
@BillingConfID UDTName input Conference ID. Default=0
@SignInName UDTName input Sign in name of account which created the conference. Default=0
135 Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@ClientTimeZone int input Client TimeZone. Timezone difference, in seconds, from GMT to the timezone this conference is scheduled to occur in (determined by the client that created this entry). Default=0
@GlobalID int input Global Conference ID for this reservation. Default=0.
@GlobalIDHi int input Global Conference ID for this reservation. Default=0.
@DTMFCommandS int input When set to 0 the et conference call flow is the standard flow. When set to 1 the conference call flow is set to flexflow (demand must be set to 1 and Attended set to 0 for this option). Default = 0.
@ConferenceRefInPr int output Is Conference in Progress. og Default=0
@HelplessInd UDTFlag input Flag, which sets “Disable Operator Help“. Users pressing *0 hear an annunciator stating, Operator Assistance is not available.
136 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@DisableOptionModI UDTFlag input When set to 1, disables the nd ability to change conference options on a per conference basis. After a Leader entersthe Leader PIN, the leader is not prompted to press 1 to start conference.
@ConferenceComm UDTComment input Conference Comments ents
@PromptSet Int input Indicates the CS700 Language, 0 will indicate that the default language will be usedValid values are 0 to 20
@NftTypeUDTType input Notification Types0 = None (Off)1 = Fax - Not used on CS700 systems2 = EMail3 = Fax and Email -- not used on CS700 systems
@NftConfirmationInd UDTFlag input Enabled sending of Confirmation notifications
@NftCancellationInd UDTFlag input Enabled sending of Cancellation notifications
@NftChangeInd UDTFlag input Enabled sending of booking Changed notifications
@NftReminderInd UDTFlag input Enabled sending of Reminder notifications
@NftAttendanceInd UDTFlag input Enabled sending of Attendance notifications
@NftComments UDTComment input Notification Comments
137 Table 40: Edit CS700 Booking Parameters
Parameter Type Input/Output Description
@NftContactFax UDTPhone input Notification Contact Fax-- Field currently not used on CS700 systems --
@NftContactMail UDTEmail input Notification Contact Email p_cspi_S700_DeleteBooking This stored procedure is used to Delete an existing CS700 reservation/conference. SP Declaration: CREATE PROCEDURE p_cspi_S700_DeleteBooking ( @ConfirmNum: int, @Information: UDTComment output ) Return Codes: 0=okay non-zero=failure, check @Information for details on failure Parameters:
Table 41: Delete CS700 booking parameters
Parameter Type Input/Output Description
@ConfirmNum int input Confirmation (ConferenceRef) of the conference to change. @ConfirmNum will be the same as @ConferenceRef (as in p_cspi_MakeBooking) Default= 0
@Information UDTComment output Error Information, if p_cspi_S700_DeleteBooking failed
138 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide p_cspi_S700_GetBooking This stored procedure is used to retrieve the CS700 conference details. SP Declaration: CREATE PROCEDURE p_cspi_S700_GetBooking ( @ConfirmNum: int = 0, @Information UDTComment output ) Return Codes: 0=okay non-zero=failure, check @Information for details on failure Parameters:
Table 42: Get CS700 booking details
Parameter Type Input/ Output Description
@ConfirmNum int‘ input Key to the reservation/Conference. @ConfirmNum will be the same as @ConferenceRef (as in p_cspi_MakeBooking) Default =0
@Information UDTComment Output Error Information, if p_cspi_S700_GetBooking failed.
Returned record set contains following data:
Table 43: Get CS700 booking Details returned record set data
Field Type
ReservationRef int
ConfirmNum int
139 Table 43: Get CS700 booking Details returned record set data
Field Type
ClientAccount UDTAccountRef
ConferenceName UDTName
StartDateTime datetime
Duration int
CodeDuration int
MaxLines int
EntryToneType int
ExitToneType int
ModeratorInd UDTFlag
ContactPhone UDTPhone
CPIN UDTPIN
MPIN UDTPIN
ExtPortsAllowedInd UDTFlag
ModHangupInd UDTFlag
MusicInd UDTFlag
SecurityInd UDTFlag
AttendedInd UDTFlag
EnabledInd UDTFlag
QandAInd UDTFlag
PollingInd UDTFlag
DemandInd UDTFlag
BillCodeInd UDTFlag
ExtDurationAllowed UDTFlag
InProgressInd UDTFlag
140 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 43: Get CS700 booking Details returned record set data
Field Type
DataInd UDTFlag
ConfViewerInd UDTFlag
ExtRecordingInd UDTFlag
SecureCodeInd UDTFlag
AuxCodeInd UDTFlag
BlockDialOutInd UDTFlag
GlobalInd UDTFlag
SelfRegInd UDTFlag
TimeZone varchar (64)
PINmode int
PINListName UDTName
NRPmode int
NRPAnnun int
Music Src int
Blast mode int
BlastAnnun int
DialList UDTName
BillingConfID UDTName
SignInName UDTName
ClientTimeZone int
GlobalID int
GlobalDHi int
DTMFCommandSet int
HelplessInd UDTFlag
141 Table 43: Get CS700 booking Details returned record set data
Field Type
DisableOptionModInd UDTFlag
ConferenceRef int
BlastMode UDTFlag
ConferenceStatusType int
AutoPINInd UDTFlag
DDI int p_cspi_UpdateBillCode Procedures returns updates to the Bill Code in the database. @ConfNum int, @BillCode UDTPhone, @Information UDTComment output /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @ConfNum int declare @BillCode UDTPhone declare @InformationUDTComment set @RetCode = 0 set @ConfNum = 123567 –- SET YOUR VALUE HERE set @BillCode = ‘1234’ –- SET YOUR VALUE HERE set @Information = '' print 'Test p_cspi_UpdateBillCode: ConfNum = ' + convert( varchar, @ConfNum )
142 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide + ‘ BillCode = @ + @BillCode
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_UpdateBillCode @ConfNum = @ConfNum, @BillCode = @BillCode, @Information = @Information output print 'Return Code = ' + convert( varchar, @RetCode ) print 'Information: ' + @Information
Table 44: Parameters
Parameter Type Input/Output Default Value Description
@ConNum int input 0 Specifies conference number to use when updating the BillCode details
@BillCode int input 0 BillCode
@Information UDTComment output only no default value If p_cspi_UpdateBill Code returns non zero, this field will hold the details of the error. p_cspi_GetBillCode Procedure returns the billing code from a specific conference number. ( @ConfNum int,
143 @BillCode UDTPhoneoutput, @EnteredDateTimedatetimeoutput, @Information UDTComment output ) /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @ConfNum int declare @BillCode UDTPhone declare @EnteredDateTimedatetime declare @Information UDTComment set @RetCode = 0 set @ConfNum = 123567 –- SET YOUR VALUE HERE set @Information = '' print 'Test p_cspi_GetBillCode: ConfNum = ' + convert( varchar, @ConfNum )
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_GetBillCode @ConfNum = @ConfNum, @BillCode = @BillCode output,
@EnteredDateTime = @EnteredDateTimeoutput, @Information = @Information output
144 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide print 'Return Code = ' + convert( varchar, @RetCode ) print 'BillCode = ' + @BillCode print 'EnteredDateTime= ' + convert( varchar, @EnteredDateTime ) print 'Information: ' + @Information
Table 45: Parameters
Parameter Type Input/Output Description
@ConNum int input Specifies conference number to use when updating the BillCode details
@BillCode UDTPhone output BillCode returned
@EnteredDate datetime output BillCode returned Time
@Information UDTComment output only If p_cspi_UpdateBillCode returns non zero, this field will hold the details of the error. p_cspi_S700_ToSchDateTime This procedure was created to perform a breakdown on the date and returns the individual month, day, hour, and minute. CREATE PROCEDURE dbo.p_cspi_S700_ToSchDateTime ( @ConfType int, @StartDateTime datetime, @Duration int, @BookFlags int, @ConfDate int output, @MonStart int output, @MDayStart int output,
145 @YearStart int output, @MonEnd int output, @MDayEnd int output, @YearEnd int output, @TimeStart int output, @TimeEnd int output, @Information UDTComment output )
Table 46: Parameters
Parameter Type Input/Output Description
@ConfType INT I Specifies the conference type.
@StartDateTime datetime I Specifies the conference start date and time.
@Duration INT I Specifies the length of the conference.
@BookFlags INT I
@ConfDate INT O Specifies the conference date.
@MonStart INT O Specifies the month during which the conference starts.
@MDayStart INT O Specifies the date in the month on which the conference starts.
@YearStart INT O Specifies the year during which the conference starts.
@MonEnd INT O Specifies the month during which the conference ends.
@MDayEnd INT O Specifies the date in the month on which the conference ends.
@YearEnd INT O Specifies the year during which the conference ends.
146 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Table 46: Parameters
Parameter Type Input/Output Description
@TimeStart INT O Specifies the time at which the conference starts.
@TimeEnd INT O Specifies the time at which the conference ends.
@Information UDT O This field holds details of any errors. p_cspi_S700_FromSchDateTime This procedure was created to perform a breakdown on the date and returns the individual month, day, hour, and minute. CREATE PROCEDURE dbo.p_cspi_S700_FromSchDateTime ( @ConfType int, @ConfDate int, @MonStart int, @MDayStart int, @YearStart int, @TimeStart int, @TimeEnd int, @StartDateTime datetimeoutput, @Duration int output, @BookFlags int output, @Information UDTComment output
147 ))
Table 47: Parameters
Parameter Type Input/Output Description
@ConfType INT I Specifies the conference type.
@ConfDate INT I Specifies the conference date.
@MonStart INT I Specifies the month during which the conference starts.
@YearStart INT I Specifies the year during which the conference starts.
@TimeStart INT I Specifies the time at which the conference starts.
@TimeEnd INT I Specifies the time at which the conference ends.
@StartDateTime datetime I Specifies the conference start date and time.
@Duration INT O Specifies the length of the conference.
@BookFlags INT O
@Information UDT O This field holds details of any errors.
Multisite Post Conference Reports To enable the CSPI Multisite stored procedures pg_cspi_GetPostCDRConfList, pg_cspi_GetPostConfData and pg_cspi_GetPostConfCallData, you must configure the following: 1. Populate the BSRes2.CSPIMultisiteParams table with the name of the primary CRS Server in the Multisite deployment. You must perform this step on all CRS Servers in the Multisite system. 2. Set the BSRes2.SysemParameters.GlobalConfStatus value 1. This value is 0 by default. When you set it to 1, it enables global conferencing logging on the primary CRS. You must perform this step on all CRS Servers in the Multisite system.
148 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide pg_cspi_GetPostCDRConfList This procedure, when queried, returns a list of Conference instances that occurred throughout the Multisite System relating to any of the search criteria (input parameters). The query must be called on one site at a time. The results it retrieves include conference records describing the activity of all conferences booked on the queried site. The query does not return CDR data for any conferences that were booked on other sites. This data is retrieved whenever those sites are queried in turn. This query only returns CDR data for conferences that have closed completely. In other words, it returns CDR data for conferences that have closed on all sites in the Multisite system. The results returned include a GlobalConfNum field. This field can then be used in follow up calls to the pg_cspi_GetPostConfData and pg_cspi_GetPostConfCallData stored procedures in order to drill down for more data.
Input Parameters @ClientNameSch UDTName= '', @StartDT datetime, @EndDT datetime, @ShowOnlyNtfTypeInd UDTFlag = 0, @Information varchar(255) = '' output
Output Fields GlobalConfNum int, ConferenceRef int, ClientRef int, ConferenceStartDateTime datetime, ConferenceEndDateTime datetime, GlobalID int The results set matches that of the existing p_cspi_GetPostCDRConfList stored procedure, with one additional field: GlobalID. In addition, the ConfNum field is replaced by a GlobalConfNum field.
GlobalID GlobalID is a reference number given to global conference bookings that is unique throughout the multisite system. It links all nodes of the conference booking.
149 For example, in a three site Multisite system, a single global conference booking consists of three individual local conference bookings, one at each site in the system. A common GlobalID value links all three of these sites and in doing so, comprises the complete global booking.
GlobalConfNum GlobalConfNum represents a unique occurrence number for a particular global conference booking throughout the Multisite system. Each time a particular global conference opens, the conferencing server assigns a new GlobalConfNum. A demand conference, for example, could open and close a number of times throughout a day. While each instance will have the same GlobalID booking reference, each has a distinct GlobalConfNum value. pg_cspi_GetPostConfData This query behaves like the existing p_cspi_GetPostConfData stored procedure. The differences are as follows: •The @CDRConfNum parameter is replaced by a @GlobalConfNum parameter. •The CDRConfNum output field is replaced by GlobalConfNum. • There are two new output fields: GlobalID and BookingServerName. When the system steps through the results of the pg_cspi_GetPostCDRConfList stored procedure, each record represents a single global conference occurrence. Each global conference occurrence is uniquely identified throughout the system by a GlobalConfNum value. By passing this value into the pg_cspi_GetPostConfData stored procedure, you can obtain further information on the conference.
Input Parameters @GlobalConfNum int, @Information varchar(255) = '' output @GlobalConfNum The global conference instance’s unique identifier, as returned by pg_cspi_GetPostCDRConfList.
Output Fields GlobalConfNum int, NtfFax bit, NtfEmail bit, NtfSMS bit,
150 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide CompanyRef int, CompanyName varchar(50), ClientName varchar(50), ChairmanFax varchar(40), ChairmanEMail varchar(50), ChairmanSMSNumber varchar(40), WholesalerName varchar(50), ConferenceRef int, ConferenceName varchar(50), NumConferees int, ConfOpenDT datetime, ConfCloseDT datetime, CallTotalDurationSeconds int, LanguageID int, GlobalID int, BookingServerName varchar(50) The output fields are similar to those of the existing p_cspi_GetPostConfData stored procedure. There are two new output fields: GlobalID and BookingServerName.
GlobalID GlobalID is the global conference booking reference.
BookingServerName BookingServerName is the name of the server on which the conference was booked. pg_cspi_GetPostConfCallData This query is similar to the existing p_cspi_GetPostConfCallData stored procedure. The differences are as follows: •The @CDRConfNum parameter is replaced by a @GlobalConfNum parameter. •The CDRConfNum output field is replaced by GlobalConfNum. • There is a new output field: SiteServerName.
151 Input Parameters @GlobalConfNum int, @Information varchar(255)= '' output
Output Fields CallNum int, Name varchar(50), CLIDigits varchar(40), ConfStartDT datetime, ConfEndDT datetime, CallTotalDurationSeconds int, Moderator int, SiteServerName varchar(50)
SiteServerName SiteServerName is the name of the server from where the call data was retrieved.
CSPI Error Codes All positive values are error codes from the BSRes2 database, negative return codes are CSPI specific.
Error Code Description
-1 General CSPI Error.
-1002 ConferenceType
-1003 LanguageType does not exist.
-1004 PriorityType does not exist.
-1005 Contact phone number contains illegal characters.
-1006 Contact fax number contains illegal characters.
-1007 Illegal duration value. Valid values are
152 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Error Code Description
-1008 Illegal conferees value. Valid values are
-1009 RecordingPIN contains illegal characters. It should be numeric.
-1010 BSRes2_ErrorDetails +’create conference owner failed error’.
-1101 Conference reference does not exist.
-1102 Changing conference from demand to schedule is not allowed.
-1103 Changing conference from schedule to demand is not allowed.
-11002 p_cspi_S700_MakeBooking: @confirmNum should be 0 to enable auto generation. To allow you own @ConfirmNum value set @ConfirmationHigh=1 in System Parameters.
-11003 p_cspi_s700_MakeBooking:@ConfirmNum can’t be auto generated/ can’t have value 0. To allow @confirmnum auto generation set @ConfirmationHigh= 0 in System parameters.
-11004 p_cspi_S700_MakeBooking: You need to supply a non-empty conference name.
-11005 p_cspi_S700_MakeBooking: You must specify a valid client account.
-11006 p_cspi_S700_MakeBooking: You must specify a valid client account reference.
-11007 p_cspi_S700_MakeBooking: StartDateTime
-11008 p_cspi_S700_MakeBooking:Duration should be greater than zero.
-11009 p_cspi_S700_MakeBooking:
153 Error Code Description
-11010 p_cspi_S700_MakeBooking: Booking failed
-11011 p_cspi_S700_MakeBooking: Booking could not be confirmed.
-11012 p_cspi_S700_MakeBooking: You cannot specify both Attended Indication and Demand Indicator.
-11101 p_cspi_S700_EditBooking: You need to supply a non-zero @ConfirmNum.
-11102 p_cspi_S700_EditBooking: You need to supply a non empty conference name.
-11108 P_cspi_S700_EditBooking:Duration should be greater than zero.
-11109 p_cspi_S700_EditBooking:
-11110 p_cspi_S700_EditBooking: Booking failed,
-11111 p_cspi_S700_EditBooking: Booking could not be confirmed
-11112 p_cspi_S700_EditBooking: You cannot specify both attended indication and demand indicator.
154 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide Chapter 3 Using the Stored Procedures
This chapter contains example of the code for using Stored Procedures.
Stored Procedures can be accessed directly from isqlw.exe or from different programming languages using ODBC, JDBC etc. All scripts are located in CSPI Example.sql file. Developers must use their own parameters for stored procedures. p_cspi_AddConferenceConferee /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @CompanyRef int declare @ConferenceRef int declare @ParticipantName UDTName
select @ConferenceRef = 1 --SET YOUR CONFERENCE RE HERE select @ParticipantName = 'Conferee' --SET YOUR PARTICIPANT NAME HERE print 'Adding conferee...' /****************************************************************** * Execute SP
155 *****************************************************************/ execute @RetCode = p_cspi_AddConferenceConferee @ConferenceRef = @ConferenceRef, @WipeAllInd = 0, @ParticipantName = @ParticipantName, @ContactPhone = '1212', @ContactFax = '1213', @ContactEMail = '[email protected]', @DialNumber = '1234', @Comment = 'Comments', @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) print 'Participant name: ' + @ParticipantName end else begin print 'Test Failed. ' + @Information end p_cspi_EditConferenceConferee /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int
156 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide declare @Information UDTComment declare @CompanyRef int declare @ConferenceRef int declare @ParticipantName UDTName select @ConferenceRef= 1 -- SET YOUR CONFERENCE REF HERE select @ParticipantName = 'Conferee' -- SET YOUR PARTICIPANT NAME HERE print 'Modifying conferee details...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_EditConferenceConferee @ConferenceRef = @ConferenceRef, @ParticipantName = @ParticipantName, @ContactPhone= '1313', @ContactFax = '1414', @ContactEMail = '[email protected]', @DialNumber = '1234', @Comment = 'Comments', @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' end else begin
157 print 'Test Failed. ' + @Information end p_cspi_DeleteConferenceConferee /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int declare @ParticipantName UDTName
select @ConferenceRef = 1 -- SET YOUR CONFERENCE REF HERE select @ParticipantName = 'Conferee' -- SET YOUR PARTICIPANT REF HERE
print 'Deleting conferee...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_DeleteConferenceConferee @ConferenceRef = @ConferenceRef, @ParticipantName = @ParticipantName, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin
158 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) print 'Participant name: ' + @ParticipantName end else begin print 'Test Failed. ' + @Information end p_cspi_GetConfParticipantList /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int declare @ParticipantName UDTName
select @ConferenceRef = 1 --SET YOUR CONFERENCE REF HERE select @ParticipantName = '%' -- % allows to select all conferees print 'Getting conference participant list...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_GetConfParticipantList @ConferenceRef = @ConferenceRef, @ParticipantNameFilter = @ParticipantName, @Information = @Information output /******************************************************************
159 * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) print 'ParticipantName: ' + @ParticipantName end else begin print 'Test Failed. ' + @Information end p_cspi_AddClient /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ClientRef int declare @AdhocAccReference UDTAccountRef
print 'Adding client...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_AddClient @ClientRef = @ClientRef output, @CompanyRef = 1, -- SET YOUR COMPANY REF HERE
160 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @Name = 'Test_Client', @AddressLine1 = 'Address1', @AddressLine2 = 'Address2', @AddressLine3 = 'Address3', @AddressLine4 = 'Address4', @Phone = '+35312070000', @Fax = '+35312070001', @EMail = '[email protected]', @ContactName = 'Contact name', @ContactPhone = '+35312070000', @ContactFax = '+35312070001', @ContactEMail = '[email protected]', @AdhocAccReference = @AdhocAccReference output, @ExternalID = 0, @CompanyExternalID = 0, @DisabledInd = 0, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Client Ref: ' + convert(varchar, @ClientRef) print 'AdhocAccReference: ' + convert(varchar, @AdhocAccReference) end else begin print 'Test Failed. ' + @Information
161 end p_cspi_EditClient /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ClientRef int declare @AdhocAccReference UDTAccountRef
select @ClientRef = 1 -- SET YOUR CLIENT REF HERE
print 'Modifying client details...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_EditClient @ClientRef = @ClientRef, @Name = 'Test_Client1', @AddressLine1 = 'Address1', @AddressLine2 = 'Address2', @AddressLine3 = 'Address3', @AddressLine4 = 'Address4', @Phone = '+35312070000', @Fax = '+35312070001', @EMail = '[email protected]', @ContactName = 'Contact name', @ContactPhone = '+35312070000',
162 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @ContactFax = '+35312070001', @ContactEMail = '[email protected]', @AdhocAccReference = @AdhocAccReference output, @ExternalID = 0, @DisabledInd = 0, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Client Ref: ' + convert(varchar, @ClientRef) print 'AdhocAccReference: ' + convert(varchar, @AdhocAccReference) end else begin print 'Test Failed. ' + @Information end p_cspi_DeleteClient /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ClientRef int select @ClientRef = 1 -- SET YOUR CLIENT REF HERE print 'Deleting client...' /******************************************************************
163 * Execute SP *****************************************************************/ execute @RetCode = p_cspi_DeleteClient @ClientRef = @ClientRef, @ExternalID = 0, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Client Ref: ' + convert(varchar, @ClientRef) end else begin print 'Test Failed. ' + @Information end p_cspi_GetClientDetails /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ClientRef int select @ClientRef = 1 --SET YOUR CLIENT REF HERE print 'Getting client details...' /****************************************************************** * Execute SP
164 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide *****************************************************************/ execute @RetCode = p_cspi_GetClientDetails @ClientRef = @ClientRef, @AdHocAccountRef = '', @ExternalID = 0, @NameFilter = '%', @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Client Ref: ' + convert(varchar, @ClientRef) end else begin print 'Test Failed. ' + @Information end p_cspi_DisableExpiredClients /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @N_Monthsint
select @RetCode = 0 select @N_Months = 6
165 execute @RetCode = BSRes2.dbo.p_cspi_DisableExpiredClients @N_Months = @N_Months
-- @information = @information output
IF (@RetCode <> 0) begin print 'Return Code = ' + convert( varchar, @RetCode ) end p_cspi_AddCompany /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @CompanyRef int print 'Adding company...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_AddCompany @CompanyRef = @CompanyRef output, @Name = 'Test_Company', @AddressLine1 = 'Address1', @AddressLine2 = 'Address2', @AddressLine3 = 'Address3', @AddressLine4 = 'Address4', @Phone = '+35312070000',
166 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @Fax = '+35312070001', @EMail = '[email protected]', @ExternalID = 0, @ContactName = 'Contact name', @DisabledInd = 0, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Company Ref: ' + convert(varchar, @CompanyRef) end else begin print 'Test Failed. ' + @Information end p_cspi_EditCompany /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @CompanyRef int select @CompanyRef = 1 -- SET YOUR COMPANY REF HERE print 'Modifying company details...' /****************************************************************** * Execute SP
167 *****************************************************************/ execute @RetCode = p_cspi_EditCompany @CompanyRef = @CompanyRef, @Name = 'Test_Company1', @AddressLine1 = 'Address1', @AddressLine2 = 'Address2', @AddressLine3 = 'Address3', @AddressLine4 = 'Address4', @Phone = '+35312070000', @Fax = '+35312070001', @EMail = '[email protected]', @ExternalID = 0, @ContactName = 'Contact name', @DisabledInd = 0, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Company Ref: ' + convert(varchar, @CompanyRef) end else begin print 'Test Failed. ' + @Information end p_cspi_DeleteCompany /******************************************************************
168 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @CompanyRef int select @CompanyRef = 1 -- SET YOUR COMPANY REF HERE print 'Deleting company...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_DeleteCompany @CompanyRef = @CompanyRef, @ExternalID = 0, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Company Ref: ' + convert(varchar, @CompanyRef) end else begin print 'Test Failed. ' + @Information end p_cspi_GetCompanyDetails /****************************************************************** * Local variables
169 *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @CompanyRef int select @CompanyRef = 1 --SET YOUR COMPANY REF HERE print 'Getting company details...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_GetCompanyDetails @CompanyRef = @CompanyRef, @ExternalID = 0, @NameFilter = '%', @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Company Ref: ' + convert(varchar, @CompanyRef) end else begin print 'Test Failed. ' + @Information end p_cspi_GetCRSVersion /****************************************************************** * Local variables
170 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide *****************************************************************/ declare @RetCode int print 'Requesting CRS version...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_GetCRSVersion /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' end else begin print 'Test Failed. ' end p_cspi_MakeBooking /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int declare @DDI UDTDDI declare @CPIN UDTPIN declare @MPIN UDTPIN declare @ReservationRef int
171 declare @ActualDuration int declare @AvailableInd UDTFlag declare @StartDateTime datetime select @StartDateTime = dateadd (mi, 120, getdate()) print 'Making new booking...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_MakeBooking @ClientAccount = 123456,-- SET YOUR CLIENT ACCOUNT HERE @PaymentNumber = 'payment', @ConferenceName = 'Test conference', @ConferenceComments = 'Comments', @ConferenceType = 1, @LanguageType = 1, @PriorityType = 2, @StartDateTime = @StartDateTime, @Duration = 60, @Conferees = 3, @SubConferees = 0, @TollFreeInd = 0, @RecordingInd = 0, @EnterToneInd = 1, @LeavingToneInd= 1, @QandAInd = 0, @PollingInd = 0, @RollCallInd = 0, @BroadcastInd = 0,
172 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @DemandInd = 0, @RecordingPIN= '', @ModeratorInd = 0, @AutoPINInd = 1, --pins will be auto generated, if 1 @DDI = @DDI output, @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Information output, @ReservationRef= @ReservationRef output, @ConferenceRef= @ConferenceRef output, @ActualDuration = @ActualDuration output, @AvailableInd = @AvailableInd output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0 and @AvailableInd = 1) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) print 'Reservation Ref: ' + convert(varchar, @ReservationRef) print 'ActualDuration: ' + convert(varchar, @ActualDuration) print 'DDI: ' + @DDI print 'CPIN: ' + @CPIN print 'MPIN: ' + @MPIN end else begin print 'Test Failed. ' + @Information end
173 p_cspi_EditBooking /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int declare @ReservationRef int declare @DDI UDTDDI declare @CPIN UDTPIN declare @MPIN UDTPIN declare @ActualDuration int declare @AvailableInd UDTFlag declare @StartDateTime datetime select @StartDateTime = dateadd (mi, 120, getdate()) select @ConferenceRef = 126654 --SET YOUR CONFERENCE REF HERE print 'Modifying booking details...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_EditBooking @ConferenceRef = @ConferenceRef, @PaymentNumber = 'payment', @ConferenceName = 'Test conference', @ConferenceComments = 'Comments', @ConferenceType = 1, @LanguageType = 1, @PriorityType = 2, @StartDateTime= @StartDateTime,
174 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @Duration = 120, @Conferees = 3, @SubConferees= 0, @TollFreeInd = 0, @RecordingInd = 0, @EnterToneInd = 1, @LeavingToneInd= 1, @QandAInd = 0, @PollingInd = 0, @RollCallInd = 0, @BroadcastInd = 0, @DemandInd = 0, @RecordingPIN= '', @ModeratorInd = 0, @AutoPINInd = 1, --pins will be auto generated, if 1 @DDI = @DDI output, @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Information output, @ReservationRef = @ReservationRef output, @ActualDuration = @ActualDuration output, @AvailableInd = @AvailableInd output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0 and @AvailableInd = 1) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef)
175 print 'Reservation Ref: ' + convert(varchar, @ReservationRef) print 'ActualDuration: ' + convert(varchar, @ActualDuration) print 'DDI: ' + @DDI print 'CPIN: ' + @CPIN print 'MPIN: ' + @MPIN end else begin print 'Test Failed. ' + @Information end p_cspi_ExtendConference /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int
select @ConferenceRef = 1 --SET YOUR CONFERENCE REF HERE
print 'Extending conference...'
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_ExtendConference @ConferenceRef = @ConferenceRef, @NewDuration = 120, @NewConferees = 5,
176 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) end else begin print 'Test Failed. ' + @Information end p_cspi_GetConferenceDetails /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int select @ConferenceRef = 1 -- SET YOUR CONFERENCE REF HERE print 'Getting conference details...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_GetConferenceDetails @ConferenceRef = @ConferenceRef, @Information = @Information output /******************************************************************
177 * Processing results *****************************************************************/ if (@RetCode = 0) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) end else begin print 'Test Failed. ' + @Information end p_cspi_DeleteBooking /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int select @ConferenceRef = 1 -- SET YOUR CONFERENCE REF HERE print 'Deleting booking...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_DeleteBooking @ConferenceRef = @ConferenceRef, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/
178 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide if (@RetCode = 0) begin print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) end else begin print 'Test Failed. ' + @Information end p_cspi_CloseConference ****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @Information UDTComment declare @ConferenceRef int select @ConferenceRef = 1 -- SET YOUR CONFERENCE REF HERE print 'Closing conference...' /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_CloseConference @ConferenceRef = @ConferenceRef, @Information = @Information output /****************************************************************** * Processing results *****************************************************************/ if (@RetCode = 0) begin
179 print 'Test Succeeded.' print 'Conference Ref: ' + convert(varchar, @ConferenceRef) end else begin print 'Test Failed. ' + @Information end p_cspi_S700_MakeBooking /****************************************************************** * Local variables *****************************************************************/ declare @Now datetime declare @RetCode int declare @ConfirmNum int declare @StartDateTime datetime declare @MPIN varchar(16) declare @CPIN varchar(16) declare @Information UDTComment declare @ReservationRef int declare @ConferenceName UDTName declare @ClientAccountRef UDTAccountRef set @Now = dateadd ( mi, 10, getdate()) set @ConfirmNum = 0 set @StartDateTime = dateadd(mi, 20, getdate()) –- SET YOUR VALUE HERE set @MPIN = ''–- SET YOUR VALUE HERE set @CPIN = ''–- SET YOUR VALUE HERE set @Information = '' set @ReservationRef = 0
180 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide set @ConferenceName = 'Test CS700 conference' + con vert(varchar, getdate()) set @ClientAccountRef = '2344266762' –- SET YOUR VALUE HERE print 'Test p_cspi_S700_MakeBooking, using ClientAccountRef=' + convert(varchar, @ClientAccountRef) /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_S700_MakeBooking @ClientAccount = @ClientAccountRef, @ConferenceName = @ConferenceName, @StartDateTime= @StartDateTime, @Duration = 20, @CodeDuration = 0, @MaxLines = 3, @EntryToneType = 0, @ExitToneType = 0, @ModeratorInd = 1, @AutoPINInd = 1, @ContactPhone = '2070000', @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Information output, @ReservationRef= @ReservationRef output, @ConfirmNum = @ConfirmNum output, @ExtDurationAllowed= 0, @ExtPortsAllowed= 0, @ModHangupInd= 0,
181 @MusicInd = 0, @SecurityInd = 0, @AttendedInd = 0, @EnabledInd = 1, @QandAInd = 0, @PollingInd = 0, @DemandInd = 0, @BillCodeInd = 0, @InProgressInd= 0, @DataInd = 0, @ConfViewerInd= 0, @ExtRecordInd = 0, @SecureCodeInd= 0, @AuxCodeInd = 0, @BlockDialOutInd= 0, @GlobalInd = 0, @SelfRegInd = 0, @TimeZone = '', @PINmode = 0, @PINListName = '', @NRPmode = 0, @NRPAnnun = 0, @MusicSrc = 0, @BlastMode = 0, @BlastAnnun = 0, @DialList = '', @BillingConfID = '', @SignInName = '', @ClientTimeZone = 0,
182 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @GlobalID = 0, @GlobalIDHi = 0, @DTMFCommandSet = 0 print 'Return Code = ' + convert(varchar, @RetCode) print 'New confirm num = ' + convert( varchar, @ConfirmNum ) print 'CPIN: ' + @CPIN + ', MPIN: ' + @MPIN print 'Information: ' + @Information p_cspi_S700_EditBooking /****************************************************************** * Local variables *****************************************************************/ declare @Now datetime declare @RetCode int declare @StartDateTime datetime declare @MPIN varchar(16) declare @CPIN varchar(16) declare @Information UDTComment declare @ReservationRef int declare @ConferenceNameUDTName declare @ConfRefInProg int declare @ConfirmNum int set @Now = dateadd ( mi, 10 , getdate() ) set @StartDateTime = dateadd( mi, 30, getdate() ) –- SET YOUR VALUE HERE set @MPIN = ''–- SET YOUR VALUE HERE set @CPIN = ''–- SET YOUR VALUE HERE set @Information = '' set @ReservationRef = 0
183 set @ConferenceName = 'Test CS700 conference' + convert( varchar, getdate() ) set @ConfRefInProg = 0 set @ConfirmNum = 123567 –- SET YOUR VALUE HERE print 'Test p_cspi_S700_EditBooking'
Note: In the current release, there is an issue with the p_cspi_Test_S700_EditBooking procedure. If the value of @BlastAnnun is updated using p_cspi_Test_S700_EditBooking (for example, @BlastAnnun=0 is updated to @BlastAnnun=112, or any number), the procedure executes correctly and the field is updated. However, the value cannot be changed back to its original state.
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_S700_EditBooking @ConfirmNum = @ConfirmNum output, @ConferenceName = @ConferenceName, @StartDateTime= @StartDateTime, @Duration = 30, @CodeDuration= 0, @MaxLines = 3, @EntryToneType = 0, @ExitToneType = 0, @ModeratorInd = 1, @AutoPINInd = 0, @ContactPhone= '2070000', @CPIN = @CPIN output, @MPIN = @MPIN output, @Information = @Information output, @ExtDurationAllowed = 0, @ExtPortsAllowed = 0,
184 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide @ModHangupInd = 0, @MusicInd = 0, @SecurityInd = 0, @AttendedInd = 0, @EnabledInd = 1, @QandAInd = 0, @PollingInd = 0, @DemandInd = 0, @BillCodeInd = 0, @InProgressInd = 0, @DataInd = 0, @ConfViewerInd = 0, @ExtRecordInd = 0, @SecureCodeInd = 0, @AuxCodeInd = 0, @BlockDialOutInd = 0, @GlobalInd = 0, @SelfRegInd = 0, @TimeZone = '', @PINmode = 0, @PINListName = '', @NRPmode = 0, @NRPAnnun = 0, @MusicSrc = 0, @BlastMode = 0, @BlastAnnun = 0, @DialList = '', @BillingConfID = '', @SignInName = '',
185 @ClientTimeZone = 0, @GlobalID = 0, @GlobalIDHi = 0, @DTMFCommandSet = 0, @ConferenceRefInProg = @ConfRefInProg output print 'Return Code = ' + convert( varchar, @RetCode ) print 'Confirm num = ' + convert( varchar, @ConfirmNum ) print 'CPIN: ' + @CPIN + ', MPIN: ' + @MPIN print 'Information: ' + @Information p_cspi_S700_GetBooking /****************************************************************** * Local variables *****************************************************************/ declare @Information varchar (200) declare @RetCode int declare @ConfirmNum int select @Information = '' select @RetCode = -1 select @ConfirmNum = 123567 –- SET YOUR VALUE HERE print 'Test p_cspi_S700_GetBooking using Confirmation Number ' + convert( varchar, @ConfirmNum ) /****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = p_cspi_S700_GetBooking @ConfirmNum=@ConfirmNum, @Information=@Information output /****************************************************************** * Display additional output information
186 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide *****************************************************************/ print 'Return code: ' + convert(varchar, @RetCode) print 'Information: ' + @Information p_cspi_S700_DeleteBooking /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @ConfirmNum int declare @Information UDTComment set @Information = '' set @ConfirmNum = 123567 –- SET YOUR VALUE HERE set @RetCode = 0 print 'Test p_SCPI_S700_DeleteBooking: ConfirmNum = ' + convert( varchar, @Con- firmNum ) /****************************************************************** * Execute SP *****************************************************************/ Execute @RetCode = BSRes2.dbo.p_cspi_S700_DeleteBooking @ConfirmNum=@ConfirmNum, @Information= @Information output print 'Return Code = ' + convert( varchar, @RetCode ) print 'Information: ' + @Information. p_cspi_UpdateBillCode
/****************************************************************** * Local variables *****************************************************************/
187 declare @RetCode int declare @ConfNum int declare @BillCode UDTPhone declare @InformationUDTComment
set @RetCode = 0 set @ConfNum = 123567 –- SET YOUR VALUE HERE set @BillCode = ‘1234’ –- SET YOUR VALUE HERE set @Information = ''
print 'Test p_cspi_UpdateBillCode: ConfNum = ' + convert( varchar, @ConfNum ) + ‘ BillCode = @ + @BillCode
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_UpdateBillCode @ConfNum = @ConfNum, @BillCode = @BillCode, @Information = @Information output
print 'Return Code = ' + convert( varchar, @RetCode ) print 'Information: ' + @Information p_cspi_GetBillCode
/****************************************************************** * Local variables
188 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide *****************************************************************/ declare @RetCode int declare @ConfNum int declare @BillCode UDTPhone declare @EnteredDateTimedatetime declare @InformationUDTComment
set @RetCode = 0 set @ConfNum = 123567 –- SET YOUR VALUE HERE set @Information = ''
print 'Test p_cspi_GetBillCode: ConfNum = ' + convert( varchar, @ConfNum )
/****************************************************************** * Execute SP *****************************************************************/ execute @RetCode = BSRes2.dbo.p_cspi_GetBillCode @ConfNum = @ConfNum, @BillCode = @BillCode output, @EnteredDateTime = @EnteredDateTimeoutput, @Information = @Information output
print 'Return Code = ' + convert( varchar, @RetCode ) print 'BillCode = ' + @BillCode print 'EnteredDateTime= ' + convert( varchar, @EnteredDateTime ) print 'Information: ' + @Information p_cspi_GetConfereeDetails
declare @RetCode int
189 declare @LastProcessTime datetime declare @ClientName UDTName declare @AdhocAccReference UDTAccountRef declare @MPin UDTPin declare @CPin UDTPin declare @InformationUDTComment
select @RetCode = 0
select @LastProcessTime= dateadd(dd, -1, getdate()) - ENTER TIME HERE select @ClientName= '' select @AdhocAccReference= '' select @MPin = '' select @CPin = '' select @Information= ''
print getdate() execute @RetCode = BSRes2.dbo.p_cspi_GetConfereeDetails @LastProcessTime = @LastProcessTime, @ClientName = @ClientName output, @AdhocAccReference = @AdhocAccReference output, @MPin = @MPin output, @CPin = @CPin output, @Information = @Information output
IF (@RetCode <> 0) begin print 'Return Code = ' + convert( varchar, @RetCode ) print 'Information: ' + @Information end
190 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide p_cspi_GetInActiveUsers
declare @RetCode int declare @Tdays int declare @FilterType char(1) declare @ClientName UDTName declare @AdhocAccReference UDTAccountRef declare @InformationUDTComment
select @RetCode = 0 select @Tdays = '90' -- ENTER DAYS HERE select @FilterType = 'M' -- Enter Code Type Here select @ClientName= '' select @AdhocAccReference= '' select @Information= ''
print getdate() execute @RetCode = BSRes2.dbo.p_cspi_GetInActiveUsers @Tdays = @Tdays, @FilterType = @FilterType, @ClientName = @ClientName output, @AdhocAccReference = @AdhocAccReference output, @Information = @Information output
IF (@RetCode <> 0) begin print 'Return Code = ' + convert( varchar, @RetCode ) print 'Information: ' + @Information end
191 p_cspi_GetPostConfReport /****************************************************************** * Local variables *****************************************************************/ declare @RetCodeint declare @ClientName UDTName declare @StartDT datetime declare @EndDT datetime declare @ShowOnlyNtfTypeInd bit declare @info UDTComment
select @RetCode = 0 /****************************************************************** * Choose a Date range and optional Client name search and ShowOnlyNtfTypeInd *****************************************************************/ select @StartDT = '20060521' select @EndDT = '20060523' select @ClientName = '' select @ShowOnlyNtfTypeInd = 0
select @Info = ''
exec @RetCode = p_cspi_GetPostConfReport @ClientName = @ClientName, @StartDT = @StartDT, @EndDT = @EndDT, @ShowOnlyNtfTypeInd = @ShowOnlyNtfTypeInd, @Information = @info output
192 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide p_cspi_GetPostCDRConfList
/****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @ClientName UDTName declare @StartDT datetime declare @EndDT datetime declare @ShowOnlyNtfTypeInd bit declare @info UDTComment select @RetCode = 0
/****************************************************************** * Choose a Date range and optional Client name search and ShowOnlyNtfTypeInd *****************************************************************/ select @StartDT = '20060520' select @EndDT = '20060523' select @ClientName = 'cspi 1' select @ShowOnlyNtfTypeInd = 0 select @info = '' exec @RetCode = p_cspi_GetPostCDRConfList @ClientNameSch=@ClientName, @StartDT=@StartDT, @EndDT=@EndDT, @ShowOnlyNtfTypeInd=@ShowOnlyNtfTypeInd, @Information=@Info output
193 p_cspi_GetPostConfData /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @CDRConfNum int declare @Info UDTComment
/****************************************************************** * Choose a (CDRs) ConfNum *****************************************************************/ select @CDRConfNum = 3492 select @RetCode = 0 select @Info = '' exec @RetCode = p_cspi_GetPostConfData @CDRConfNum = @CDRConfNum, @Information=@info output p_cspi_GetPostConfCallData /****************************************************************** * Local variables *****************************************************************/ declare @RetCode int declare @CDRConfNum int declare @Info UDTComment
194 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide /****************************************************************** * Choose a (CDRs) ConfNum *****************************************************************/ select @CDRConfNum = 3492 select @RetCode = 0 select @Info = '' exec @RetCode = p_cspi_GetPostConfCallData @CDRConfNum = @CDRConfNum, @Information=@info output p_cspi_Sys_CheckNumeric p_cspi_Sys_CheckNumeric /****************************************************************** * Local variables *****************************************************************/ declare @NumberString UDTComment declare @RetCode int select @RetCode = 0 set @NumberString = '2121'
-- Examine @NumberString and return 0 if numeriv, otherwise -1 exec @RetCode = dbo.p_cspi_Sys_CheckNumeric @NumberString if( @RetCode = 0 )
195 print @NumberString + ' is numeric' else print @NumberString + ' is NOT numeric' set @NumberString = '21A1'
-- Examine @NumberString and return 0 if numeriv, otherwise -1 exec @RetCode = dbo.p_cspi_Sys_CheckNumeric @NumberString if( @RetCode = 0 ) print @NumberString + ' is numeric' else print @NumberString + ' is NOT numeric' p_cspi_SecondsToDuration /****************************************************************** * Local variables *****************************************************************/ declare @InSeconds int declare @RetCode int declare @strDurationHHHHMMSS varchar(10) declare @UseSeparatorInd UDTFlag declare @SeparatorCharchar(1) declare @Information UDTComment
/****************************************************************** * Choose a number of seconds – also choose optional seporator
196 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide * @UseSeparatorInd and @SeparatorChar *****************************************************************/ select @InSeconds = 10979 select @SeparatorChar= ':' select @UseSeparatorInd = 1 select @RetCode = 0 select @strDurationHHHHMMSS = '' select @Information = '' exec @RetCode = p_cspi_SecondsToDuration @InSeconds = @InSeconds, @strDurationHHHHMMSS = @strDurationHHHHMMSS output, @UseSeparatorInd = @UseSeparatorInd , @SeparatorChar = @SeparatorChar, @Information = @Information output
print @strDurationHHHHMMSS p_cspi_GetWholesalerList /****************************************************************** * Local variables *****************************************************************/ declare @info varchar(255) declare @Ref int declare @RetCode int select @Ref=2 select @RetCode = 0
-- Set Wholesaler to be disabled
197 exec @RetCode = p_cspi_SetWholesalerEnabled @WholesalerRef=@Ref, @WholesalerEnabledInd=0, @Information=@info output select @info print convert( varchar, @RetCode )
-- Get Wholesaler List exec @RetCode = p_cspi_GetWholesalerList @WholesalerRef=@Ref, @Information=@info output select @info print convert( varchar, @RetCode )
-- Set Wholesaler to be Enabled exec @RetCode = p_cspi_SetWholesalerEnabled @WholesalerRef=@Ref, @WholesalerEnabledInd=1, @Information=@info output select @info print convert( varchar, @RetCode )
-- Get Wholesaler List exec @RetCode = p_cspi_GetWholesalerList @WholesalerRef=@Ref, @Information=@info output select @info
198 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide print convert( varchar, @RetCode ) p_cspi_SetWholesalerEnabled For more information, see “p_cspi_GetWholesalerList” on page 197. pg_cspi_GetPostCDRConfList Connect to the CRS at Site A. Call pg_cspi_GetPostCDRConfList: EXECUTE pg_cspi_GetPostCDRConfList @StartDT='2007-02-01 14:00:000', @EndDT='2007-02-01 15:00:000' This returns a list of conference occurrences for the whole system that occurred between 2pm and 3pm in Site A's local time and which were booked by all Clients whose accounts exist on Site A. pg_cspi_GetPostConfData Looping through the results from pg_cspi_GetPostCDRConfList, call pg_cspi_GetPostConfData for each one, using the GlobalConfNum value to identify each conference. EXECUTE pg_cspi_GetPostConfData @GlobalConfNum=123456 This returns more output fields for each specific instance, including the conference owner and the number of actual attendees. pg_cspi_GetPostConfCallData Looping through the results from pg_cspi_GetPostCDRConfList again, call pg_cspi_GetPostConfCallData for each one, using the GlobalConfNum value to identify each conference. EXECUTE pg_cspi_GetPostConfCallData @GlobalConfNum=123456 This returns a list of callers that attended each conference, along with info on their duration (in local time) and the sites to which they had been connected.
199 200 Meeting Exchange 5.0 Client Registration Server Stored Procedures Interface Guide