Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Functional overview
Cisco TMSBA makes it possible to let users book resources from custom booking applications (in this
document referred to as "clients"), integrating the custom booking application with the Cisco TMS
reservation database.
document referred to as "clients"), integrating the custom booking application with the Cisco TMS
reservation database.
Using Cisco TMSBA to interact with Cisco TMS is the only safe and supported way of integrating third party
or custom booking applications with Cisco TMS. The Cisco TMSBA is a versioned and stable interface into
Cisco TMS, where backward compatibility is guaranteed in new releases.
or custom booking applications with Cisco TMS. The Cisco TMSBA is a versioned and stable interface into
Cisco TMS, where backward compatibility is guaranteed in new releases.
Main features
Cisco TMSBA has three main features:
n
Importing and/or displaying Cisco TMS-managed resources in an external client or booking system.
n
Reading and displaying system availability information and bookings from the reservation database of
Cisco TMS. This information can be used for replicating bookings from Cisco TMS to the external booking
system.
Cisco TMS. This information can be used for replicating bookings from Cisco TMS to the external booking
system.
n
Forwarding booking requests made by an external booking system to Cisco TMS. Forwarding a booking
request to Cisco TMS lets the client utilize the routing logic of Cisco TMS, which determines whether
network resources like an Multipoint Control Unit (MCU) are required, and automatically reserves these
resources. The client therefore does not need to worry about infrastructure resources such as gateways
and MCU port availability.
request to Cisco TMS lets the client utilize the routing logic of Cisco TMS, which determines whether
network resources like an Multipoint Control Unit (MCU) are required, and automatically reserves these
resources. The client therefore does not need to worry about infrastructure resources such as gateways
and MCU port availability.
Booking ownership
The client can choose whether to authenticate with Cisco TMS as a service account or as the user actually
making the booking. If authenticating as a service account, the client must explicitly specify the actual owner
of the booking when performing the SaveConference function. If choosing this option, it is important that
the service account is a member of a group having Book on behalf of permissions in Cisco TMS.
making the booking. If authenticating as a service account, the client must explicitly specify the actual owner
of the booking when performing the SaveConference function. If choosing this option, it is important that
the service account is a member of a group having Book on behalf of permissions in Cisco TMS.
IsTMSBookOnBehalfUser
and IsBookonBehalfOfUser in the remote setup API can be used to
assess whether a service account or other user has Book on behalf of permissions. The
GenerateConferenceAPIUser
GenerateConferenceAPIUser
Conference routing
When booking through the Cisco TMSBA, clients book endpoints only. Network infrastructure products,
such as gateways and Multipoint Control Units (MCUs) are automatically added by Cisco TMS if needed.
The settings under
such as gateways and Multipoint Control Units (MCUs) are automatically added by Cisco TMS if needed.
The settings under
Administrative Tools > Conference Settings > Advanced Conference Options
in
Cisco TMS are used when routing conferences created through Cisco TMSBA.
Replication
Cisco TMSBA supports two-way replication between the client and Cisco TMS. If the client maintains its
own copy of the reservation database, it must periodically ask Cisco TMS for changes.
own copy of the reservation database, it must periodically ask Cisco TMS for changes.
Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide (14.4)
Page 8 of 77
API overview
Functional overview