Proxy Tool XML Description

Version 1

    The following is a sample XML description that would be provided to the registerTool method. Click the links for detailed information on the particular element.

     

    <?xml version="1.0" encoding="ISO-8859-1"?>
    <tool-profile ltiVersion="2.0-July08" xmlns:locale="http://www.ims.org/lti/localization">
    <vendor>
      <code>Vendor</code>
      <name>Name Not Used</name>
      <description>Description not used</description>
      <url>http://www.your.url</url>
      <contact><email>vendor contact not used.John.q.Admin@proxy.server.host</email></contact>
    </vendor>
    <tool-info>
      <code>Program</code>
      <name>Name Not Used</name>
      <version>1</version>
      <description>Text Description</description>
    <tool-info>
    <tool-instance>
      <base-urls>
        <base-url type="http">http://your.server.com/proxyApp</base-url>
        <base-url type="https">https://your.server.com/proxyApp</base-url>
        <base-url type="server-to-server">https://your.server.com/proxyApp</base-url>
      </base-urls>
      <contact><email>John.q.Admin@proxy.server.host</email></contact>
      <security-profile>
        <digest-algorithm>SHA</digest-algorithm>
      </security-profile>
    </tool-instance>
    <required-webservices>
      <tool-login>
        <service name="Context.WS">
          <operation>logout</operation>
    ... More <operation/> rows as required
        </service>
    ... More <service ... elements as required for tool-authentication
      </tool-login>
      <ticket-login>
        <service name="Context.WS">
          <operation>logout</operation>
        </service>
    ... More <service ... elements as required for ticket-authentication
      </ticket-login>
    </required-webservices>
    <http-actions>
      <action type="tool-provision" path="/tcProfileRegistration"/>
      <action type="bundle" path="/getBundle"/>
      <action type="remove" path="/removeAction"/>
      <action type="config" path="/configAction"/>
      <action type="state-change" path="/stateChangeAction"/>
      <action type="reregister" path="/reregisterAction"/>
      <action type="ping" path="/ping"/>
      <action type="course-deleted" path="/courseHandler">
        <param name="action" fixed="course-deleted"/>
      </action>
      <action type="course-copied" path="/courseHandler">
        <param name="action" fixed="course-copied"/>
      </action>
      <action type="course-exported" path="/courseHandler">
        <param name="action" fixed="course-exported"/>
      </action>
      <action type="course-imported" path="/courseHandler">
        <param name="action" fixed="course-imported"/>
      </action>
      <action type="group-copied" path="/courseHandler">
        <param name="action" fixed="group-copied"/>
      </action>
      <action type="group-exported" path="/courseHandler">
        <param name="action" fixed="group-exported"/>
      </action>
      <action type="group-imported" path="/courseHandler">
        <param name="action" fixed="group-imported"/>
      </action>
    </http-actions>
    <links>
      <content-handler>
        <name locale.key="resource/x-my.content.type.name">Content Type Name</name>
        <handle value="resource/x-my.content.type"/>
        <http-actions>
          <action type="create" path="/contentHandler">
          <param name="action" fixed="create">
          </action>

          <action type="modify" path="/contentHandler">
          <param name="action" fixed="modify">
          </action>

          <action type="remove" path="/contentHandler">
          <param name="action" fixed="remove">
          </action>

          <action type="view" path="/contentHandler">
          <param name="action" fixed="view">
          </action>

          <action type="viewattempt" path="/contentHandler">
          <param name="action" fixed="viewattempt">
          </action>

          <action type="content-copied" path="/contentHandler">
          <param name="action" fixed="content-copied">
          </action>

          <action type="content-exported" path="/contentHandler">
          <param name="action" fixed="content-exported">
          </action>

          <action type="content-imported" path="/contentHandler">
          <param name="action" fixed="content-imported">
          </action>

          <action type="content-deleted" path="/contentHandler">
          <param name="action" fixed="content-deleted">
          </action>

        </http-actions>
        <can-copy value="true"/>
        <icons>
          <icon>unused default lti icon</icon
          <icon platform="blackboard" style="toolbar" locale:key="icon.lang.key">/images/icon1_on.gif</icon>
          <icon platform="blackboard" style="listitem" locale:key="icon.lang.key">/images/icon1_on.gif</icon>
        </icons>
      </content-handler>
    ... More <content-handler>...</content-handler> sections
      <menu-link>
        <category-choice>
          <category>TBD - LTI defined generic category currently unused</category>
          <category platform="blackboard">course_tool</category>
        </category-choice>
        <name locale:key="course_tool.name.key">Link Name</name>
        <http-actions>
        <action type="menu-view" path="/courseTool"/>
        </http-actions>
        <description locale:key="course_tool.link.description.key">Link Desription</description>
        <icons>
          <icon>unused default lti icon</icon
          <icon platform="blackboard" style="listitem" locale:key="icon.lang.key">/images/icon1.gif</icon>
        </icons>
      </menu-link>
    ... More <menu-link>...</menu-link> sections
    </links>
    </tool-profile>