Access Keys:
Skip to content (Access Key - 0)

Required?: NO

The ticket-login section lists the Web Services and operations to use while logged in as a
user with the ticket received in a Proxy Tool action (i.e. via the ContextWS.loginTicket(...) method).

The Proxy Tool framework resolves the requested operations into Blackboard Learn entitlements and displays them to the System Administrator so they know what entitlements may be used by the tool before they make it available.

If this section is not specified then the list of desired operations must be specified in the registerTool method call or no entitlements will be available when using Web Services while logged in utilizing a ticket.

Unlike the tool-login requirements, specifying the operations here does not grant these entitlements. It is merely informing the System Administrator what entitlements that are needed. At runtime, a Web Service session authenticated using the loginTicket method will only have effective permissions at the intersection of all of the entitlements that their user has been granted and the generated list of entitlements based on the methods that are declared here. For example, if you do not declare that you are going to call the saveColumn method on the Gradebook.WS Web Service using ticket authentication and you then attempt that call, even if the current user has the entitlement, your call fails because you did not inform the administrator that you intended to call this method.

Not all methods require specific entitlements; for those methods it is safe to declare that you are using them, but if you do not declare them we will not stop the method call. In general it is best to declare all methods you use in case we require entitlements during a future release. In that case the tool must be completely re-registered.
Adaptavist Theme Builder (4.1.3) Powered by Atlassian Confluence 3.3, the Enterprise Wiki