Skip to main content
Blackboard Help

Registering Proxy Tools

Administrator can link to a proxy tool descriptor which registers the tool, places access points according to defined properties, and enables access to the web service through the proxy tool.

Before registering a proxy tool, there are three Global Properties to keep in mind:

  • Use the Proxy Tool Registration Password field to restrict access to the registerTool method. Proxy tools that must supply the password entered in this filed to register themselves. The proxy tool cannot login as a tool until a password is specified on the proxy tool configuration page. Proxy tools cannot receive any entitlements until granted by giving the individual proxy tool its own password.
  • Allowing access to Unknown Proxy Tools means that these proxy tools can connect and use user-based authentication to access web services. A password is required and access is restricted based on the users' entitlements within the system. Access for unknown proxy tools can be accomplished without explicitly granting them the right to use web services.
  • Exposing the Tool Consumer Profile allows proxy tools to auto-discover the capabilities of the system by using the URL /webapps/ws/wsadmin/tcprofile. Disabling this does not disable proxy tools, but it disables their ability to perform pre-registration capability validation.

How to Find the Proxy Tools Page

  1. On the Administrator Panel, in the Building Blocks section, click Building Blocks.
  2. Click Proxy Tools.

How to Register a Proxy Tool without Placements

  1. In the Register Proxy Tool list, click Create Proxy Tool without Placements.
  2. Provide the Vendor and Program information.
  3. Determine the Availability of the proxy tool by clicking Unavailable or Available.

    If the proxy tool is not Available, then it cannot log in to any web service using any authentication methods in addition to having any requested placements disabled.

  4. Provide a Shared Password.

    The Shared Password is required only for tool-authenticated web service sessions.

  5. Provide individual IP addresses or a range of IP addresses to allow or block in the IP Filters field. Type one address per line.

    Using IP Filters is optional and all IP addresses are allowed by default (ALLOW*). Here are some guidelines for using the IP Filters:

    • Type BLOCK a.b.c.d to block an IP address or range of addresses.
    • Type ALLOW a.b.c.d to allow an IP address or range of addresses.
    • Wildcards (*) are allowed in any position of the IP address.
    • IP address ranges are specified using a slash as follows: a.b.c.d/e.f.g.h
  6. Click Submit.

How to Register a Proxy Tool with Placements

  1. In the Register Proxy Tool list, click Create Proxy Tool with Placements.
  2. In the Known Servers list, select a Proxy Server and click Go.


    Provide the registration URL for the proxy server in the Server Registration URL field.

    Use the full path for the URL furnished by the proxy tool vendor.

  3. Click Submit.

How to Download Sample Tools

  1. Click Download Sample Tools.
  2. Click OK to accept the download of a ZIP file containing sample proxy tools.

What's in the Sample Tools Package

The ZIP file contains the following sample tools:

  • .NET-based Proxy Tool
  • Java-based Proxy Tool
  • Java-based Proxy Server

Consult the README and the LICENSE_for_samples files before using the sample tools. The most current information is included in these files and may supersede this documentation.