Note: You are currently viewing documentation for Moodle 2.8. Up-to-date documentation for the latest stable version of Moodle may be available here: Box.net APIv1 migration.

Box.net APIv1 migration: Difference between revisions

From MoodleDocs
Main page ► Managing content ► Repositories ► Box.net APIv1 migration
Repositories
(rewrite)
Line 1: Line 1:
{{Installing Moodle}}
{{Repositories}}
As of the 14th of December 2013, the API that Moodle uses to interact with the [[Box.net repository]] and [[Box.net portfolio]] is reaching its end of life. Box.net now recommends using their API version 2. There are a few implications related to the migration to their new API:
''Note: This page contains information for site administrators only.''


==After upgrade to 2.6==
==Box.net API v2==


===Repository===
Box.net API v1, which Moodle uses to interact with the [[Box.net repository]] and [[Box.net portfolio]], is due to expire on 14 December 2013. It will be replaced by Box.net API v2. Consequences of the new API are:


After the upgrade, and without doing anything, all the files that were referenced from Box.net will still be accessible until the 14th of December. But it will not be possible to import new files until you configure the repository for the API version 2.
# For Box.net repository users it will no longer be possible to create a shortcut/alias to a file stored in Box.net. ''Existing aliases will need to be converted to file copies by running the Box.net-alias-to-copy-conversion tool.''
# The Moodle site must use HTTPS in order to access Box.net.


To configure, do the following:
==The Box.net-alias-to-copy-conversion tool==


* Get the ''client ID'' and ''secret'' from your App at [https://app.box.com/developers/services Box.net]
<p class="note">'''IMPORTANT''': The Box.net-alias-to-copy-conversion tool must be used before 14 December 2013 to avoid data loss!</p>
* Navigate to the repository settings: Administration block > Site administration > Plugins > Repositories > Manage instances
* In the dropdown of Box.net, select ''Enable and visible''
* Then click ''Settings''
* Enter the ''client ID'' and ''secret''


===Portfolio===
Administrators are advised to run the Box.net-alias-to-copy-conversion tool immediately after upgrading their site. It may be run


You just need to configure the portfolio settings for the API version 2.
Either from within Moodle:


To configure, do the following:
# Go to ''Administration > Site administration > Modules > Repositories > Manage repositories'' and click the settings link for Box.net
# Click the link to run the tool.


* Get the ''client ID'' and ''secret'' from your App at [https://app.box.com/developers/services Box.net]
Or via a CLI script, found at /repository/boxnet/cli/migrationv1.php.
* Navigate to the repository settings: Administration block > Site administration > Plugins > Portfolios > Box.net
* Enter the ''client ID'' and ''secret''


==Requirement for HTTPS==
''Please be aware that this tool could take several hours to run depending on the number of aliases and their size.''


Compared to version 1, version 2 of the API requires your website to use HTTPS for the authentication process.
==Continued use of the Box.net repository and portfolio==


==End of alias/shortcuts==
To continue using the Box.net repository and Box.net portfolio, the ''Moodle site must use HTTPS''. Assuming this criterion is satisfied, after upgrading their site, administrators must reconfigure the Box.net repository and portfolio plugins as follows:


With the initial version of the API, we could use a direct link to a file as a reference in Moodle. But after the migration it is not possible any more, the repository will not support references any more.
===Box.net repository configuration===


==/!\ To be done before the 14th of December 2013==
# Obtain a ''client ID'' and ''secret'' from [https://app.box.com/developers/services Box.net]
# Go to ''Administration > Site administration > Plugins > Repositories > Manage Repositories''
# Activate the Box.net repository by selecting 'Enable and visible' in the dropdown menu
# Configure each repository by entering the client ID and secret. Make sure you don't include any white space in the text boxes!
# Save changes


We have provided a tool that will convert all the references you had in Moodle to real files (true copies). You can run this tool using either of the following:
===Box.net portfolio configuration===


* The Web interface, found at http://yoursite/repository/boxnet/migrationv1.php
# Obtain a ''client ID'' and ''secret'' from [https://app.box.com/developers/services Box.net] (This step is not necessary if you have them already for the Box.net repository.)
* The CLI script, found at /repository/boxnet/cli/migrationv1.php
# Go to ''Administration > Site administration > Plugins > Portfolios > Manage Portfolios''
 
# Activate the Box.net portfolio by selecting 'Enable and visible' in the dropdown menu
''Please be aware that this tool could take several hours to run depending on the number of references and their size.''
# Configure each portfolio by entering the client ID and secret
# Save changes


[[Category:Site administration]]
[[Category:Site administration]]
[[Category:Portfolios]]

Revision as of 11:36, 8 November 2013

Note: This page contains information for site administrators only.

Box.net API v2

Box.net API v1, which Moodle uses to interact with the Box.net repository and Box.net portfolio, is due to expire on 14 December 2013. It will be replaced by Box.net API v2. Consequences of the new API are:

  1. For Box.net repository users it will no longer be possible to create a shortcut/alias to a file stored in Box.net. Existing aliases will need to be converted to file copies by running the Box.net-alias-to-copy-conversion tool.
  2. The Moodle site must use HTTPS in order to access Box.net.

The Box.net-alias-to-copy-conversion tool

IMPORTANT: The Box.net-alias-to-copy-conversion tool must be used before 14 December 2013 to avoid data loss!

Administrators are advised to run the Box.net-alias-to-copy-conversion tool immediately after upgrading their site. It may be run

Either from within Moodle:

  1. Go to Administration > Site administration > Modules > Repositories > Manage repositories and click the settings link for Box.net
  2. Click the link to run the tool.

Or via a CLI script, found at /repository/boxnet/cli/migrationv1.php.

Please be aware that this tool could take several hours to run depending on the number of aliases and their size.

Continued use of the Box.net repository and portfolio

To continue using the Box.net repository and Box.net portfolio, the Moodle site must use HTTPS. Assuming this criterion is satisfied, after upgrading their site, administrators must reconfigure the Box.net repository and portfolio plugins as follows:

Box.net repository configuration

  1. Obtain a client ID and secret from Box.net
  2. Go to Administration > Site administration > Plugins > Repositories > Manage Repositories
  3. Activate the Box.net repository by selecting 'Enable and visible' in the dropdown menu
  4. Configure each repository by entering the client ID and secret. Make sure you don't include any white space in the text boxes!
  5. Save changes

Box.net portfolio configuration

  1. Obtain a client ID and secret from Box.net (This step is not necessary if you have them already for the Box.net repository.)
  2. Go to Administration > Site administration > Plugins > Portfolios > Manage Portfolios
  3. Activate the Box.net portfolio by selecting 'Enable and visible' in the dropdown menu
  4. Configure each portfolio by entering the client ID and secret
  5. Save changes
Retrieved from "https://docs.moodle.org/28/en/index.php?title=Box.net_APIv1_migration&oldid=107544"
Powered by MediaWiki