Register your extension

Before you are able to build and test your extension, you must register/add it in the Developer portal.

1. Enter developer portal

Go to Developer portal link on the top menu.

images/download/attachments/19401589/DeveloperPortal.png

2. Choose your extension type.

Make sure you read the documentation provided in this space to ensure you choose the one applicable to you.

images/download/attachments/19401589/AddExtension.png

3. Registration

Register an application

The screen to register applications looks like this.

images/download/attachments/19401589/AddApplications.png

The Technical information with configuration and security settings section of the page can change depending on the item you select in the SSO Type menu.

images/download/attachments/19401589/TechnicalInfo.png

When the Use SSO version option is selected, the Technical information with configuration and security settings section is the following:

images/download/attachments/19401589/SSOType2.png

If you select the Use LTI 1.1 option, the Technical information with configuration and security settings section is the following:

images/download/attachments/19401589/SSOTypeLti.png

See the following table for explanations of the fields in both these cases.

Register an application - Field descriptions

Field

SSO

LTI

Description

Title

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The title of the extension, as shown in listings and menus

Short description

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A description of your extension, as shown in listings.

Long description

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A detailed description of your extension, as shown in detail views

Default name for new instances

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Languages

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Add languages to support descriptions in multiple languages

Available for countries / customers

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Select which itslearning markets or customers your extension should be available to.

Toolbar Icons

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Upload icons for your extension for use in listings, menus

Allow comments

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Support homepage

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A URL the user can visit for support

Support email

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

An email address to reach your support organisation

Homepage

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A URL the user can visit to get information about the plugin or the plugin vendor

Mail

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

An email address to reach your sales organisation

Content availability

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Licensing options

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

See Managing licenses for subfields

SSO Type

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The SSO type for your application.

Type

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The type of assessment your application supports. See Assessment options in applications

Sharing supported

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

See Sharing with others

Add instance URL

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

The URL itslearning should call out to when adding a new instance, see Application user scenario

View instance URL

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

The URL itslearning should call out to when an end user wants to view an existing application instance

Delete instance URL

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

The URL itslearning should call out to when deleting and instance See Deleting instances

Services URL

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

You can provide an URL that will serve for server-to-server communication, for example itslearning can call it out to create an instance copy (for the first version copying is the only supported service we introduce). See Copying of application instances for more details.

Supported services

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

Providing Services URL let you check one of the services that you think your application will support. For now it is only Copy, although the list will be extended in the future versions. See Copying of application instances for more information about implementing the service.

Application key

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

The identifier of your plug-in. Must be used when making calls to the REST API with the OAuth protocol

Shared secret

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

A shared secret is generated by itslearning. It is used to sign requests from itslearning to the plugin and from the plugin to itslearning

Provider URL

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The URL of the LTI extension provider

Application Key

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The application key used to sign the messages to the LTI application

Shared Secret Key

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The shared secret key used to sign the messages to the LTI application

Privacy Level

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

This privacy level determines which of your personal information the LTI application can access.

Custom Parameters

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Additional configuration parameters for the LTI application

Register a module

The screen to register modules looks like this.See bottom of page for explanations of the fields

images/download/attachments/19401589/worddavb3e025a0f66af669b6b577b3ae3bfd9e.png

Register a plugin

The screen to register plugins looks like this.See bottom of page for explanations of the fields

images/download/attachments/19401589/worddave064592bb929a2e5ed501528beacd135.png

Plugin, modules and native application registration - Field descriptions

Field

Modules

Plugins

Description

Title

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The title of the extension, as shown in listings and menus

Short description

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A description of your extension, as shown in listings.

Long description

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A detailed description of your extension, as shown in detail views

Languages

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Add languages to support descriptions in multiple languages

Available for

countries / customers

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Select which itslearning markets or customers your extension should be available to.

Toolbar Icons

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Upload icons for your extension for use in listings, menus

Support homepage

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A URL the user can visit for support

Support email

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

An email address to reach your support organisation

Homepage

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A URL the user can visit to get information about the plugin or the plugin vendor

Mail

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

An email address to reach your sales organisation

Content availability

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Licensing options

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

See Managing licenses for subfields

Launch URL

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The URL to the plugin or module, i.e. where itslearning should send its requests.

SSO Type

images/download/attachments/19401589/worddavef64de9e7b83831a56e11fa049341ce8.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

Don't choose anything but version 2. Version OOS version 1 is deprecated.

Application key

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

The identifier of your plug-in. Must be used when making calls to the REST API with the OAuth protocol

Shared secret

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

images/download/attachments/19401589/worddav758c690e1a791684864e9e2c631d3621.png

A shared secret is generated by itslearning. It is used to sign requests from itslearning to the plugin and from the plugin to itslearning