Installation

Installing version 1

MySQL database tables

The module requires the LTI database tables to be added to the same database schema as WebPA. Details of these tables can be found in the PHP LTI Tool Provider class documentation (see the Installation section). The tables should be given the same prefix as used when installing WebPA. The webpa-lti-tables.sql file contains the SQL statements required to create these tables. The file assumes the default prefix of pa2_; it should be edited to replace this prefix if a different one was used for the WebPA tables.

PHP source files

The download file available from OSCELOT (see Licence section below) includes the following file:

• lti.zip

This file contains the PHP source files for the module which should be added to the WebPA server:

1. Extract the lti.zip file and upload it to the mod directory on the WebPA server.
2. Extract the contents of the lti.zip file to create a directory named lti containing all the module source files.

Installing version 2

MySQL database tables

The module requires the LTI database tables to be added to the same database schema as WebPA. Details of these tables can be found in the PHP LTI class library documentation (see the Installation section). The tables should be given the same prefix as used when installing WebPA. The webpa-lti2-tables.sql file contains the SQL statements required to create these tables. The file assumes the default prefix of pa2_; the file should be edited to replace this prefix if a different one was used for the WebPA tables.

PHP source files

The download file available from the OSCELOT repository includes the following file:

• lti.zip

This file contains the PHP source files for the module which should be added to the WebPA server:

1. Extract the lti.zip file and upload it to the mod directory on the WebPA server.
2. Extract the contents of the lti.zip file to create a directory named lti containing all the module source files.
3. Use the composer install command to install the LTI class library files; or, if composer is not available, download the source files for the LTI class library and manually extract them into the vendor directory.

Updating from version 1

An existing implementation using version 1 of this connector can be upgraded to version 2 by:

1. Deleting the existing mod/lti directory.
2. Installing the version 2 PHP source files in the lti directory (see above);
3. Creating the version 2 LTI database tables (see above);
4. Running the webpa-upgrade-lti-tables.sql script.

Installing version 3

MySQL database tables

The module requires the LTI database tables to be added to the same database schema as WebPA. Details of these tables can be found in the PHP LTI class library documentation (see the Installation section). The tables should be given the same prefix as used when installing WebPA. The webpa-lti3-tables.sql file contains the SQL statements required to create these tables. The file assumes the default prefix of pa2_; the file should be edited to replace this prefix if a different one was used for the WebPA tables.

PHP source files

The simplest way to install the WebPA module is by using Composer:

1. Log into the WebPA server.
2. Navigate to the directory containing the WebPA source files.
3. Create a directory named mod if it does not already exist.
4. Navigate to the the mod directory.
5. Run the command composer create-project celtic/webpa-lti lti.

Alternatively, the source files can be installed manually as follows:

1. Extract the lti.zip file from the download file available from the OSCELOT repository.
2. Extract the contents of the lti.zip file into the mod directory on the WebPA server to create a directory named lti containing all the module source files.
3. Use the composer install command to install the LTI class library files; or, if composer is not available, download the source files for the LTI class library and its dependencies and manually extract them into the vendor directory (see the documentation for the LTI class library for details).

The setting-dist.php file should be copied to setting.php and, when LTI 1.3 connections are to be used, the private key (in PEM format) for your instance of WebPA and a random value for its kid (key ID) should be added.

Updating from version 2

An existing implementation using version 2 of this connector can be upgraded to version 3 by:

1. Keeping a copy of your existing setting.php file if you have changed any of the default values.
2. Deleting the existing mod/lti directory.
3. Installing the version 3 PHP source files in the lti directory (see above).
4. Updating the new setting.php file with any changes made in the old file.
5. Running the webpa-lti3-upgrade-mysql.sql script to upgrade the LTI tables.

Enabling the module

To enable the module, open the includes/inc_global.php file in a text editor, locate the line containing $INSTALLED_MODS = array(); and insert the following line after it:

$INSTALLED_MODS[] = 'lti';

Once the module has been enabled, additional menu options will be added to the menu for administrator and tutor users.