Required?: NO
Authenticated Request?: NO
Request Arguments: tcprofileurl, regpass, returnurl
Sample Implementation: TcProfileRegistration.java

The tool-provision action is a way to make the tool easier to install. This can be either a relative URL like all the other actions or it can be a fully qualified URL.

This action will be used by the System Administrator during initial registration of your tool. They will navigate to Administrator Panel > Building Blocks > Proxy Tools and select the Register Proxy Tool/Create Proxy Tool with Placements option. On this page they will either select your tool from a drop-down list or manually enter the full path to the tool's location. For the sample server this means they would enter the following:

http://your.sample.server:9080/ws.sample.proxyserver/tcProfileRegistration

as the URL. The browser will be redirected to this page with the arguments:

In response to this page, prompt the user for whatever information you need and then call registerTool to register your Proxy Tool.

tcprofileurl

This is a fully qualified URL pointing to the Tool Consumer Profile for the Blackboard Learn system where you are installed your tool.

regpass

This is the tool registration password. You will be given a single-use registration password to be used
when calling the registerTool method

returnurl

This is a fully qualified URL you can use to redirect the user back into Blackboard Learn after you have
registered your tool. This servlet accepts a parameter of ?jump_to_guid=XXXX where XXXX is the
ourguid returned by the registerTool method. If you include this parameter then the System Administrator will be taken directly to the edit-proxy-tool page for your newly registered tool. If you leave the parameter off then they will be presented with a list of all the proxy tools on their system (from which they will have to find and edit your newly registered one to make it available).

locale

This is the java string representation of the current locale for the user. If possible, present the registration UI to them in using this locale.

direction

This is the direction attribute for the current UI (ltr or rtl). If possible, present the registration UI using this direction attribute.

vendor

This is an optional parameter to indicate the expected vendor for this registration request. This should match your vendor/code element from your tool-profile, and if you end up registering anything other than this then the Blackboard Learn system will not get what it is expecting.

program

This is an optional parameter to indicate the expected program for this registration request. Typically
this should match your tool-info/code element from your tool-profile, and if you end up registering
anything other than this then the Blackboard Learn system will not get what it is expecting. If your proxy tool server implements multiple different proxy tool programs then this can be used to determine which one is expected to be registered at this point in time.