Note: You are currently viewing documentation for Moodle 2.6. 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
(Obtaining a Box.net client ID and secret, reorganising info)
Line 4: Line 4:
==Box.net API v2==
==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. Two important consequences of the new API are:
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. Three important consequences of the new API are:


# The Moodle site must use HTTPS in order to access Box.net.
# Box.net plugins must be configured with a Box.net client ID and secret.
# 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.''
# 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.
 
==Obtaining a Box.net client ID and secret==
 
# Go to https://app.box.com and create an account or log in
# Go to https://app.box.com/developers/services and click the link 'Create new application'
# Enter an application name and click the 'Content API' button
# Once the application is created, click the 'Edit this application' button
# On the Edit a Box Application page, scroll down to the section 'OAuth2 parameters' and make a note of the client ID and secret
 
The client ID and secret can then be used to configure the Box.net repository and Box.net portfolio.
 
==Box.net repository configuration==
 
# Go to ''Administration > Site administration > Plugins > Repositories > Manage Repositories''
# Reactivate the Box.net repository by selecting 'Enabled and visible' in the dropdown menu
# Configure the repository plugin by entering the Box.net client ID and secret. Make sure you don't include any white space in the text boxes!
# Save changes
 
==Box.net portfolio configuration==
 
# Go to ''Administration > Site administration > Plugins > Portfolios > Manage Portfolios''
# Reactivate the Box.net portfolio by selecting 'Enabled and visible' in the dropdown menu
# Configure the portfolio plugin by entering the Box.net client ID and secret
# Save changes


==The Box.net-alias-to-copy-conversion tool==
==The Box.net-alias-to-copy-conversion tool==
Line 17: Line 42:
Either from within Moodle:
Either from within Moodle:


# Ensure that the Box.net repository has been configured according to the instructions above
# Go to ''Administration > Site administration > Modules > Repositories > Manage repositories'' and click the settings link for Box.net
# Go to ''Administration > Site administration > Modules > Repositories > Manage repositories'' and click the settings link for Box.net
# Click the link to run the tool.
# Click the link to run the tool


Or via a CLI script, found at /repository/boxnet/cli/migrationv1.php.
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.''
''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===
# Go to ''Administration > Site administration > Plugins > Repositories > Manage Repositories''
# Reactivate the Box.net repository by selecting 'Enabled and visible' in the dropdown menu
# Configure the repository plugin by entering the client ID and secret from [https://app.box.com/developers/services Box.net]. Make sure you don't include any white space in the text boxes!
# Save changes
If you can't remember your Box.net client ID and secret, you can obtain new ones by following the instructions in [[Box.net repository]].
===Box.net portfolio configuration===
# Go to ''Administration > Site administration > Plugins > Portfolios > Manage Portfolios''
# Reactivate the Box.net portfolio by selecting 'Enabled and visible' in the dropdown menu
# Configure the portfolio plugin by entering the client ID and secret from [https://app.box.com/developers/services Box.net]
# Save changes
Note: You can use the same client ID and secret for the Box.net repository and Box.net portfolio.


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

Revision as of 14:05, 20 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. Three important consequences of the new API are:

  1. The Moodle site must use HTTPS in order to access Box.net.
  2. Box.net plugins must be configured with a Box.net client ID and secret.
  3. 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.

Obtaining a Box.net client ID and secret

  1. Go to https://app.box.com and create an account or log in
  2. Go to https://app.box.com/developers/services and click the link 'Create new application'
  3. Enter an application name and click the 'Content API' button
  4. Once the application is created, click the 'Edit this application' button
  5. On the Edit a Box Application page, scroll down to the section 'OAuth2 parameters' and make a note of the client ID and secret

The client ID and secret can then be used to configure the Box.net repository and Box.net portfolio.

Box.net repository configuration

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

Box.net portfolio configuration

  1. Go to Administration > Site administration > Plugins > Portfolios > Manage Portfolios
  2. Reactivate the Box.net portfolio by selecting 'Enabled and visible' in the dropdown menu
  3. Configure the portfolio plugin by entering the Box.net client ID and secret
  4. Save changes

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. Ensure that the Box.net repository has been configured according to the instructions above
  2. Go to Administration > Site administration > Modules > Repositories > Manage repositories and click the settings link for Box.net
  3. 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.

Retrieved from "https://docs.moodle.org/26/en/index.php?title=Box.net_APIv1_migration&oldid=107906"
Powered by MediaWiki