Save

Click the button to save all changes to the current session, or use the drop-down menu:

Reload without saving

Used to refresh the system, clearing any changes made since the last save.

Save again

Used to update the system when the Save button is disabled (useful to refresh the current connection message in case its timestamps have expired).

Clear all non-required parameters

Each message parameter is tagged as being either Required, Recommended or Optional; this option will remove the values from all the recommended and optional parameters.

Start new session

This will clear the system and reset all values to their defaults.

View

Use this menu to display one of the following:

• Last service message (last service request received and the response returned)
• Gradebook (all the current line items and outcomes)
• Tool settings (any tool settings created by the Tool Provider)
• Event store (a sample store for Caliper Analytics^® event data)

Options

Open the Options form (see below). Use the drop-down menu to access the Sign in window (see below).

Connect

Send a message based on the currently selected settings to the tool. This button is disabled after you change the value of a parameter; your changes must be saved first.

Open connections in a new window?

When selected connections to the Tool Provider will be opened in a new window rather than a page within the same window.

Include empty parameters in message?

By default any parameter which does not have a value will be omitted from a message; select to include them.

Allow empty secret values?

Allow a connection to be attempted even though no shared secret has been defined.

Display optional features?

Select to show any feature which is flagged as optional; e.g., those parameters which are neither required nor recommended.

Display unofficial extensions?

Select to show features which have been published but are not part of the 1EdTech specification.

Enable unpublished LTI features?

This option enables features which are still under development by 1EdTech and subject to change.

Enable experimental features?

These are extensions which are not expected to become part of the LTI specification at this time.

Only support outcomes for learners?

When selected only users with a Learner role will be enabled for the return of outcomes.

Display unsupported features (but disabled)?

Select to show any feature which is defined within the LTI specifications but is not supported by this system; the feature will be displayed as disabled so that it cannot be selected.

Offer browser storage?

Select to offer tools access to storage in the platform's browser frame.

Hide left navigation?

Remove the left navigation menu and show all the sections together on the page.

Use this menu to change the page which is displayed.

Platform

Details of the Platform including the security profiles, services and capabilities it supports (see below).

Context/Resource

Details of the context and resource link from which the message is to be initiated.

User

Details of the user making the connection.

Message

The type of message being sent and other related parameters.

Security Model

The LTI version and security credentials to be used when connecting to the Tool.

Tool Proxy

When a Tool Proxy is in place, this page replaces the Security Model page and shows the agreed credentials.

Tool

When not opened in a new window, messages sent to a Tool will be displayed here in an iframe.

On the Security Model page, select LTI-1p0 as the LTI version and enter the tool's message URL, consumer key and shared secret. Use the Save button to re-enable the Connect button.

Clicking on the Connect button in the top navigation bar page will cause a message of the type selected on the Message page to be sent to the Tool. You can preview the message or override where the connection is opened via the drop-down menu.

Only those parameters on each page which have been checked will be included in the message. Service parameters for any selected service will automatically be included as well.

Custom parameter substitution variables will be replaced where an appropriate value is available (for example, $User.username).

On the Security Model page, select 1.3.0 as the LTI version and enter the configuration details provided by the tool:

• Message URL
• Initiate login URL
• Redirection URI(s) (one per line)
• Public keyset URL and/or public key

The public keyset URL will be used when no public key is defined. The public key may be entered using PEM format or as JSON (JWKS format). Use the Save button to re-enable the Connect button.

The Platform Details section contains the values which should be shared with the tool:

• Platform/Issuer ID
• Client ID
• Deployment ID
• Authorization server ID (optional, defaults to the Authentication request URL when omitted)
• Authentication request URL
• Access Token service URL
• Public keyset URL and/or public key

The public key should be entered in PEM format but can be viewed as JSON by clicking on the View as JSON button.

Clicking on the Connect button in the top navigation bar page will cause a message of the type selected on the Message page to be sent to the Tool using credentials supplied on the Security Model page. You can preview the message or override where the connection is opened via the drop-down menu.

Only those parameters on each page which have been checked will be included in the message. Service parameters for any selected service will automatically be included as well.

Custom parameter substitution variables will be replaced where an appropriate value is available (for example, $User.username).

Clicking on the Register button on the Tool page will cause a ToolProxyRegistration message to be sent to the Tool. The Tool Consumer Profile will include those services and capabilities which are selected on the Platform page.

When a Tool Proxy is accepted, the Tool page is replaced with a copy of the Tool Proxy and a summary of the agreed credentials. The services and capabilites on the Platform will be selected based on the services in the security contract and the enabled capabilities for a resource. Any parameters required for the message type will always be selected. All others are signified by a checkbox with a shaded background - the system allows the choices to be changed but the checkbox presentation will identify which formed part of the agreed Tool Proxy.

A resource defined in the Tool Proxy should be selected from the menu provided on the Tool Proxy page. A message supported by the resource should be selected on the Message page.

A Tool Proxy can be cancelled by clicking on the Unregister button.

This system uses sessions to manage your activity; these sessions last for at least 2 hours. However, when a new session is started some endpoints may change and so any existing integrations you are testing may require updating. Signing into the system using a Google ID allows you to have a static set of endpoints to avoid this issue. It also provides the following options:

• backup the current configuration to local file;
• restore a previously backed-up configuration from a local file;
• automatically save your session to the server
• automatically log into the system and restore the last saved session
• manage a set of LTI 1.3 tool configurations (see below)
• send an LTI 1.3 registration request

The only data shared when you sign in is your email address and your ID number as supplied by Google.

To aid the re-use of an LTI 1.3 tool, it is possible to save a configuration and have it associated with your Google ID. By default each Google ID can have up to 5 saved tool configurations (use the Feedback option on the Help to enquire about increasing this limit if it is not sufficient for your needs).

To save a configuration, just enter its details into the fields on the Security Profile page and click on the Save button in the header of the Tool Details section. If a tool with the same initiate login URL is already defined, its details will be updated with the new values.

A tool can be dynamically registered by clicking on the Register button. By default, the process will use a registration token and send the deployment ID; uncheck either or both of these options if they are not required.

The Registered tools button opens a list of all the existing configurations which have been saved (or dynamically registered); full details can be displayed by clicking on the plus sign at the start of the row. Initially a configuration is given a name of Unnamed; click on the name to change it. A configuration can be made available for use by other users by turning on its Public setting. Click on the download icon in the Action column to copy the configuration settings to the Security Profile page. (A configuration can also be copied by selecting its name from the drop-down list on the Registered tools button.) Click on the delete button to remove the configuration.