MoodleDocs - Contribucions de l'usuari [ca]

Capabilities/mod/pagemenu:view

2011-02-17T23:56:02Z

Psychoph: New page: This permission allows the user to view the page menu. * Defaults ** Administrator: Allow ** Course Creator: Allow ** Teacher: Allow ** Non-editing Teacher: Allow ** Student: Allow ** Gues...

This permission allows the user to view the page menu.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Allow
** Student: Allow
** Guest: Allow
** Authenticated User: Allow

Capabilities/mod/pagemenu:manage

2011-02-17T23:55:44Z

Psychoph: New page: This permission allows the user to manage the page menu, create, update and delete menu links. * Defaults ** Administrator: Allow ** Course Creator: Allow ** Teacher: Allow ** Non-editing ...

This permission allows the user to manage the page menu, create, update and delete menu links.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Allow
** Student: Not set
** Guest: Not set
** Authenticated User: Not set

Capabilities/block/trouble ticket:submitticket

2011-02-17T20:19:06Z

Psychoph: New page: This permission allows the user to submit a trouble ticket. * Defaults ** Administrator: Allow ** Course Creator: Allow ** Teacher: Allow ** Non-editing Teacher: Allow ** Student: Allow **...

This permission allows the user to submit a trouble ticket.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Allow
** Student: Allow
** Guest: Prevent
** Authenticated User: Allow
* Risks
** Spam: User could send spam to site users or others

Capabilities/format/page:viewpagesettings

2011-02-17T19:38:40Z

Psychoph: New page: This permission allows the user to view the page's hide and show settings but no other settings for the page. This also allows a user to view hidden pages. * Defaults ** Administrator: Al...

This permission allows the user to view the page's hide and show settings but no other settings for the page. This also allows a user to view hidden pages.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Not set
** Student: Not set
** Guest: Not set
** Authenticated User: Not set

Capabilities/format/page:managepages

2011-02-17T19:37:35Z

Psychoph:

This permission allows the user to change settings for pages via the manage page settings tab.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Not set
** Student: Not set
** Guest: Not set
** Authenticated User: Not set

Capabilities/format/page:managepages

2011-02-17T19:37:27Z

Psychoph: New page: This permission allows the user to change settings for pages via the manage page settings tab. * Defaults ** Administrator: Allow ** Course Creator: Allow ** Teacher: Allow ** Non-editing...

Capabilities/format/page:addpages

2011-02-17T19:37:00Z

Psychoph:

This permission allows a user to add a new page to the flexpage course.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Not set
** Student: Not set
** Guest: Not set
** Authenticated User: Not set

Capabilities/format/page:editpages

2011-02-17T19:36:45Z

Psychoph: New page: This permission allows a user to edit a page settings as well as modify what is displayed on the page. * Defaults ** Administrator: Allow ** Course Creator: Allow ** Teacher: Allow ** Non-...

This permission allows a user to edit a page settings as well as modify what is displayed on the page.
* Defaults
** Administrator: Allow
** Course Creator: Allow
** Teacher: Allow
** Non-editing Teacher: Not set
** Student: Not set
** Guest: Not set
** Authenticated User: Not set

Capabilities/format/page:addpages

2011-02-17T19:35:58Z

Psychoph: New page: This permission allows a user to add a new page to the flexpage course. * Defaults ** Administrator: Allow ** Course Creator: Allow ** Teacher: Allow ** Non-editing Teacher: Not set ** St...

RSS in forums

2011-01-20T23:59:38Z

Psychoph:

RSS in forums allows users with an RSS aggregator program to be notified of new forum discussions in a similar manner to the emails sent as a result of [[Forum subscription|forum subscriptions]].

==Enabling RSS==

To enable RSS feeds in forums, an administrator must first enable RSS for the site in ''Administration > Server > [[RSS]]''.

RSS feeds in forums may then be enabled in the [[Forum settings|forum settings]] via the link in ''Administration > Modules > Activities''.

When RSS is enabled, two new settings appear when [[Adding/editing a forum]].

==RSS feed for this activity==

[[Image:Rss_in_forums.gif|frame|right]]

This turns RSS on or off for this forum. When set to “None,” RSS is disabled. When set to “Discussions,” the RSS feed will send out new discussions to subscribers. When set to “Posts,” the RSS feed will send out any new posts to subscribers.

==Number of RSS recent articles==

This number sets the number of articles that go out via RSS. If this number is set to 5, then the 5 most recent articles will be sent to subscribers. As new posts (or discussions) get added, the oldest post/discussion gets replaced on the RSS feed. If your forum gets a lot of posts every day, you will want to set this number high.

==Podcasting==

From version 1.6 onwards posting audio or video files to a forum will automatically turn the relevant RSS feed into a [[Podcast]].

==Cron==
The administrative cron (admin/cron.php) must run after the forum is created and posts or discussions have been made. Otherwise the user will receive an error "Error reading RSS data"

[[Category: Forum]]
[[Category:RSS]]

Capabilities/mod/folder:view

2011-01-15T00:33:33Z

Psychoph: New page: This allows the user to view the contents of the folder.

This allows the user to view the contents of the folder.

Capabilities/mod/folder:managefiles

2011-01-15T00:33:13Z

Psychoph: New page: This allows the user to add, delete, update and move files in the folder.

This allows the user to add, delete, update and move files in the folder.

Capabilities/mod/page:view

2011-01-15T00:30:46Z

Psychoph: New page: This allows a user to view a page resource.

This allows a user to view a page resource.

Capabilities/mod/url:view

2011-01-15T00:28:07Z

Psychoph: New page: This allows the user to view a url resource.

This allows the user to view a url resource.

Capabilities/mod/chat:exportparticipatedsession

2011-01-14T23:46:00Z

Psychoph: New page: This allows the user to export or download the logs for any chat session they participated in.

This allows the user to export or download the logs for any chat session they participated in.

Capabilities/mod/chat:exportsession

2011-01-14T23:45:49Z

Psychoph: New page: This allows the user to export or download all chat session logs.

This allows the user to export or download all chat session logs.

Google Apps Integration

2010-08-10T18:21:05Z

Psychoph:

=Introduction=
Moodlerooms and Google have worked together to build a state of the art integration. The 1.0 version of the integration provides:
* Automatic creation of users in Google Apps (Google Docs™, Google Calendar™, and Gmail™) when they are created in Moodle
* Automatic log in to Google Apps when a user logs in to Moodle
* A Gmail block in Moodle that displays latest Gmail messages on the Moodle Front Page
* A Google Apps block on the Moodle Front Page displays links to Google Start Page, Google Docs, Google Calendar and Gmail
* A Moodle app on the Google Apps Start PageGoogle Apps can integrates with Moodle v1.9 and above. There is a contributed code block that can be added to Moodle and a widget which can be added to Google. It will allow for a single sign-on for users from Moodle to Google.

=Integration Setup=

There are a few steps involved with setting up the Google Apps Education Edition Integration. This setup should be configured by a technically knowledgeable Moodle administrator.

# Set up Moodle's Authentication
# Set up Google's Authentication
# Add and configure the Gmail and Google Apps blocks
# Add and setup the User Sync block (optional; for those who do not have a Google account creation/management process)

==Requirements==
The following must be installed:
# auth/gsaml
# blocks/gmail
# blocks/gdata
# blocks/gaccess
# lib/zend

==Generating Private Key and SSL signed Certificate==
Generate the private key:
<code>sudo openssl genrsa -out googleappsidp.key 1024</code>

RSA encrypt the key for use with Google Apps:
<code>sudo openssl rsa -in googleappsidp.key -out googleappsidp.pem</code>

Create the .csr fill to generate the certificate from:
<code>sudo openssl req -new -key googleappsidp.key -out googleappsidp.csr</code>

Encrypt the key in x509 format using the key:
<code>sudo openssl x509 -req -days 9999 -in googleappsidp.csr -signkey googleappsidp.key -out googleappsidp.crt</code>

==Set Up Moodle's Authentication==

# Log in to Moodle as an Administrator
# Click Notifications to update block tables
# Enable the Google Authentication plug-in from the Manage Plug-ins admin page
# In the Site Admin menu, select "Users." Next, select "Authentication" and click "Google Authentication."
# Enter your Google partner page domain name.
# Upload private key (for more information on creating this, refer to Google documentation regarding key generation)
# Upload the SSL signing certificate (for more information on creating this, refer to Google documentation regarding key generation)
# Click Save Changes

==Set Up Google's Authentication==

# In a new browser window, log in to the Google Apps Control Panel page as an admin. To access this page, you can use this URL -- just change the end to have your partner page domain information: https://www.google.com/a/yourpartnerpagedomainname.com.
# Click the Advanced tools tab
# Click the Set up single sign-on (SSO) link next to Authentication
# Select the checkbox to "Enable Single Sign-on"
# Enter this URL into the Sign-in page URL text field:
## http://<moodle site url>/login/index.php
# Enter this URL into the Sign-out page URL text field:
## http://<moodle site url>/login/logout.php
# Enter this URL into the Change password URL text field:
## http://<moodle site url>/login/change_password.php
# Generate and upload a verification certificate to Google (X.509 certificate containing the public key)
# Click Save Changes
# Click the User Accounts tab
#This displays existing users as well as a message that says "You can create up to ### user accounts for this domain." If you are using the Google User Sync block for account management, this number must match or be larger than the number of accounts you plan on creating. Request more accounts if you need them by clicking the request more link on this page.
# Click the Settings link. Check the box to "Enable provisioning API" (otherwise users will NOT be updated) (Users and Groups > Settings > Enable provisioning API must be checked.)
# Click Save Changes
# Next you will add and configure the blocks as well as the Moodle-Google Gadget. See the "Google Blocks Configuration" and "Moodle-Google Gadget Setup" tutorials for more information.

==Things to Consider:==
* The Gmail feed might not be found and display an error. Troubleshooting tips include:
** Turn on debugging and the diagnostics page will perform a basic check on the Gmail feed.
** If you are using the Google User Sync block, check to see if an admin or guest user has been added to the sync. If so, remove them.
** If you are using the Google User Sync block, be sure your Google user settings are set to allow the number users you are adding to the sync in Moodle. If the number of Moodle users is larger than the number set in Google, then those accounts will not be created or synced (ie, if Google is set to 1000 users and Moodle has 1500, 500 accounts will fail to be created or synced).
* The location of the Google Authentication Plug-in in the Authentication order is important. Currently, it needs to override a user's auth type when a Moodle user changes passwords. This behavior may affect M-Net users. A solution for this problem has not yet been found.
* Do not add a user to the sync if their user name has been deleted from Google. You need to wait five days before adding them to the User Sync.
* See the Diagnostics Page in the gsaml settings for more information about your setup.

==Gmail Block Settings==
; OAuth Consumer Secret : This is a string that Google apps generates and is used as a shared secret.
; Google Apps Domain : your google apps partner domain.
; Unread Message Count : Here, you can specify the number of unread messages to display in the Gmail block. Leave as zero for no limit.
; New Window Links : By default, the Gmail links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.
; Show first name and Show last name : By default, the author's first and last name is displayed next to the e-mail title -- uncheck these settings to hide.

To configure the Gmail block:
# In Site Admin, go to Modules > Blocks > Manage Blocks
# Define the OAuth consumer secret. To find your consumer secret:
## Log in to http://www.google.com/a/YOURDOMAIN with your Google Admin account
## Click Advanced Tools
## Click Manage OAuth Access
## Copy the OAuth consumer secret from this screen and paste it into the Moodle text box
# Enter your Google apps domain
# Save changes

==Google Apps Block Settings==
; New Window Links : By default, the Google Apps links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.

==User Sync Block Settings==
; Google Apps username : This is a username in Google apps that has administrative permissions. This user should not be in Moodle and not part of the user sync. This user is used to create, delete and update Google accounts.
; Google Apps password : password for the google user to sync with.
; Google Apps domain : Your partner domain.
; Use Google Apps e-mail : This is unchecked by default. Checking this box will cause the e-mail address in the Moodle profile to be changed to the Gmail address.
; Enable events : This is turned on by default, as this causes any change of Moodle profile information to be instantly updated in Google. Unchecking this setting will cause Moodle profile updates to only be changed in Google when the cron runs. This is preferable if you do not want the deletion of Moodle accounts to immediately delete Google accounts.
; Cron interval : Enter how regularly (in minutes) you want the cron to run and sync Google and Moodle accounts. This is set to every 30 minutes by default.
; Cron expire : When the synchronization runs, it locks the cron from being executed again until it has finished. This setting is used to determine when that lock has expired. Consider setting this to a high value, especially on first runs with a lot of users. By default, it is set to 24 hours.

Configuring the Google User Sync Block:
# Log in to Moodle as an administrator. You must also be an administrator in Google.
# Click the Add Blocks drop down and choose "Google User Sync."
# Click the Settings link in the Google User Sync block.
# Configure the settings according to your Google Partner page information. You will need to enter the Google administrator user name and password in addition to your Google Partner domain.
# Save changes

Confirming the configuration is working:
# Click the Status link in the Google User Sync block to confirm that the integration was successful.
# Go to Site Administration > Security > Site policies
# Check Password Policy and make sure the Set Password Length is set to "6 or greater" (Required for Google's password policy)

===User Sync Status===

The user sync status will tell you if the integration was successful or not. If there is an error here, it means one of your settings is wrong. Check to make sure the user name and password is correct,

==Moodle-Google Gadget Setup==
To set up the Moodle-Google gadget, you need to first set up and configure the Google Apps Education Edition Integration. To complete this process, you must be an admin for both the Moodle installation and the Google installation.

# Log in to the Google Control Panel as an admin. Use the link below, substituting your Google domain name for "mroomsdev.com"
## https://www.google.com/a/mroomsdev.com
# Click the Service Settings tab, then the Start Page link.
# Click Customize and Publish
# Click Select default content
# Click Refresh default content below to make the Add stuff link appear
# Click Add stuff
# Click Add by URL
# Paste the following URL, substituting your Moodle domain name for "test.mroomsdev.com"
## http://<moodle site url>/auth/gsaml/moodlegadget.php
# Click Add
# Click close
# Click Back to Homepage
# You should see the Moodle Gadget appear
# Lastly, be sure to click the Publish link in the furthest upper right-hand corner.

==Things to Consider==

The Moodle-Google Gadget is a beta prototype. In the future, it may be much more useful. Currently, there is a known bug regarding the Gadget not updating immediately upon install. Developers are looking into it.

=Gmail Block=
==Descrption==
The Gmail block displays an inbox link, along with a list of a customizable number of unread e-mails. This list contains the subject of the e-mail as well as the name of the sender. Each subject is a link, which you can hover over with your mouse to see a summary of the e-mail.

==Granting Access==
The first time a user uses the Gmail block they will be required to grant the block access to view their Gmail account. This is required for the 3 legged OAuth connection.

To grant access perform the following steps:
# Click the Grant access link in the Gmail Block
[[Image:tut_img_60.png]]
## If Google authentication plugin is not configured then you will be asked to login to your site.
# Click the grant access button. (all of the black lines will be filled in with data about your email or site.
[[Image:tut_img_61.png]]
# Once you have granted access you will be shown a success screen an then returned to your Moodle site. You will not see a list of unread emails in your Gmail block.

=== Using Gmail block ===
To use the Gmail block
# Click the subject link of the e-mail you want to open. Click the Inbox link to go directly to your Gmail inbox.
[[Image:tut_img_gmail_block.png]]
# This opens the e-mail (or inbox) in a new browser window or tab.
# When you're done using Gmail, navigate back to your Moodle window. Unread messages will not update in your Moodle Gmail block until you log out and log back in.

==Refresh Access==
The Refresh Access Token Link can be used to renew a users access token when it expires or allows a user to deny access to an previously granted token. User's should seldom have to click this link to obtain a new access token from Google.

===Technical Notes on the Gmail Block===

* The Gmail block requires the rest of the Google-Moodle SSO system to be functional in order to operate properly.
* The system does not support Google's optional custom certificate authentication.
* If you are experiences SSO errors double check that your server time is in agreement with one of the internets many NTP servers. Your server and Google's systems must have proper time in order to process SSO requests properly.
* 2 legged OAuth is no longer supported by Google's Gmail atom feed and thus has been removed from the system.

=== Regarding General Maintenance ===
The Gmail block contains a local copy of Mozilla's Certification Authorities list. Overtime the Authority certificates bundle may need to be updated. If the Gmail block returns an error regarding SSL you may need to look into this issue.

=Google Apps Block=
To use the Google Apps block:
# Click the link of the application you want to use. This will take you directly to it in a new browser window or tab. You can choose from:
## Gmail
## Calendar
## Docs
# When you're done using the Google App, navigate back to your Moodle window.

=Logging Out of Google Apps=
If you click the Sign out link from a Google App, you will be taken to a page confirming that you want to log out.

If you click Yes, it also logs out of Moodle as well and takes you back to the Moodle Front Page. Likewise, if you log out of Moodle, it will also log out of Google. This prevents you from logging out of one system and forgetting to log out of the other. This is especially useful when using a public or shared computer.

If you click No, you will be taken back to the Moodle Front Page.

=Google User Sync=

This block allows you to create and manage Google accounts from Moodle. When a Moodle user is added to the User Sync, their account is automatically created in Google. If their account is deleted in Moodle, it will also be deleted in Google.

Once the block has been configured by a technically knowledgeable Moodle administrator (see "Google User Sync Settings" tutorial), the actual management of users can be performed by anyone with Moodle administrator permissions.

==Adding to the User Sync

# Click the Add users to sync link
# Use the Moodle filter to locate the users you wish to add. Note: never add a guest user or the main administrator. This will break the syncing process.
# Select the boxes next to the user names you wish to add. Alternatively, you can click the Add all users button.
# Click Add users to sync
# The page will refresh and the users you just added will no longer appear.

==Managing the User Sync==

To view the users currently being synced and remove them, you can use the feature Users being synced.

# Click the Users being synced link.
# This displays a list of all the users being synced. You can manage which users are displayed by searching with the Moodle filter. You can also display more users per page by using the Page size drop down menu.
# There are two ways to remove users. You can use the Remove all users button, or you can select specific users and click Remove users from sync.
# The page will refresh, and the users will no longer appear in the Users being synced tab.

=Moodle-Google Gadget=
If you have a Gmail account, you should see a Google gadget that contains a link back to Moodle on your Google Start Page. If you don't see a link to Moodle on your Google Start Page, follow these directions to add the Moodle Gadget.

# Open your Start Page.
# Click the Add stuff link.
# Click the Add by URL link.
# Copy and paste this URL, but be sure to change "test.mroomsdev.com" to your Google Partner Page domain: http://test.mroomsdev.com/auth/gsaml/moodlegadget.php
# Click Add
# A warning message will pop up. Click OK.
# A message should appear below the URL field that says it was added.
# Click Back to Homepage to return to your Start Page and verify the link is there.

==Tips and tricks==
*Once the Moodle accounts are disabled, so are the Google accounts. However one could choose to grant access via Google to continue collaboration after a course is completed.

=See also=
*Modules and Plugin page: [http://moodle.org/mod/data/view.php?d=13&mode=single&page=187 Modules and Plugin]
*Using Moodle Discusion: [http://moodle.org/mod/forum/view.php?id=7786 Google Apps integration forum]
*Download: [http://development.moodlerooms.com/mod/resource/view.php?id=210&subdir=/Google_1.0_for_Moodle_1.9 Google_1.0]_for_Moodle_1.9 on Moodlerooms.com no login required
*[[Google gadgets]]- code to put into a Moodle HTML block

[[Category:Contributed code]]

Google Apps Integration

2010-04-26T20:03:26Z

Psychoph: /* See also */

=Introduction=
Moodlerooms and Google have worked together to build a state of the art integration. The 1.0 version of the integration provides:
* Automatic creation of users in Google Apps (Google Docs™, Google Calendar™, and Gmail™) when they are created in Moodle
* Automatic log in to Google Apps when a user logs in to Moodle
* A Gmail block in Moodle that displays latest Gmail messages on the Moodle Front Page
* A Google Apps block on the Moodle Front Page displays links to Google Start Page, Google Docs, Google Calendar and Gmail
* A Moodle app on the Google Apps Start PageGoogle Apps can integrates with Moodle v1.9 and above. There is a contributed code block that can be added to Moodle and a widget which can be added to Google. It will allow for a single sign-on for users from Moodle to Google.

=Integration Setup=

There are a few steps involved with setting up the Google Apps Education Edition Integration. This setup should be configured by a technically knowledgeable Moodle administrator.

# Set up Moodle's Authentication
# Set up Google's Authentication
# Add and configure the Gmail and Google Apps blocks
# Add and setup the User Sync block (optional; for those who do not have a Google account creation/management process)

==Requirements==
The following must be installed:
# auth/gsaml
# blocks/gmail
# blocks/gdata
# blocks/gaccess
# lib/zend

==Generating Private Key and SSL signed Certificate==
Generate the private key:
<code>sudo openssl genrsa -des3 -out googleappsidp.key 1024</code>

RSA encrypt the key for use with Google Apps:
<code>sudo openssl rsa -in googleappsidp.key -out googleappsidp.pem</code>

Create the .csr fill to generate the certificate from:
<code>sudo openssl req -new -key googleappsidp.key -out googleappsidp.csr</code>

Encrypt the key in x509 format using the key:
<code>sudo openssl x509 -req -days 9999 -in googleappsidp.csr -signkey googleappsidp.key -out googleappsidp.crt</code>

==Set Up Moodle's Authentication==

# Log in to Moodle as an Administrator
# Click Notifications to update block tables
# Enable the Google Authentication plug-in from the Manage Plug-ins admin page
# In the Site Admin menu, select "Users." Next, select "Authentication" and click "Google Authentication."
# Enter your Google partner page domain name.
# Upload private key (for more information on creating this, refer to Google documentation regarding key generation)
# Upload the SSL signing certificate (for more information on creating this, refer to Google documentation regarding key generation)
# Click Save Changes

==Set Up Google's Authentication==

# In a new browser window, log in to the Google Apps Control Panel page as an admin. To access this page, you can use this URL -- just change the end to have your partner page domain information: https://www.google.com/a/yourpartnerpagedomainname.com.
# Click the Advanced tools tab
# Click the Set up single sign-on (SSO) link next to Authentication
# Select the checkbox to "Enable Single Sign-on"
# Enter this URL into the Sign-in page URL text field:
## http://<moodle site url>/login/index.php
# Enter this URL into the Sign-out page URL text field:
## http://<moodle site url>/login/logout.php
# Enter this URL into the Change password URL text field:
## http://<moodle site url>/login/change_password.php
# Generate and upload a verification certificate to Google (X.509 certificate containing the public key)
# Click Save Changes
# Click the User Accounts tab
#This displays existing users as well as a message that says "You can create up to ### user accounts for this domain." If you are using the Google User Sync block for account management, this number must match or be larger than the number of accounts you plan on creating. Request more accounts if you need them by clicking the request more link on this page.
# Click the Settings link. Check the box to "Enable provisioning API" (otherwise users will NOT be updated) (Users and Groups > Settings > Enable provisioning API must be checked.)
# Click Save Changes
# Next you will add and configure the blocks as well as the Moodle-Google Gadget. See the "Google Blocks Configuration" and "Moodle-Google Gadget Setup" tutorials for more information.

==Things to Consider:==
* The Gmail feed might not be found and display an error. Troubleshooting tips include:
** Turn on debugging and the diagnostics page will perform a basic check on the Gmail feed.
** If you are using the Google User Sync block, check to see if an admin or guest user has been added to the sync. If so, remove them.
** If you are using the Google User Sync block, be sure your Google user settings are set to allow the number users you are adding to the sync in Moodle. If the number of Moodle users is larger than the number set in Google, then those accounts will not be created or synced (ie, if Google is set to 1000 users and Moodle has 1500, 500 accounts will fail to be created or synced).
* The location of the Google Authentication Plug-in in the Authentication order is important. Currently, it needs to override a user's auth type when a Moodle user changes passwords. This behavior may affect M-Net users. A solution for this problem has not yet been found.
* Do not add a user to the sync if their user name has been deleted from Google. You need to wait five days before adding them to the User Sync.
* See the Diagnostics Page in the gsaml settings for more information about your setup.

==Gmail Block Settings==
; OAuth Consumer Secret : This is a string that Google apps generates and is used as a shared secret.
; Google Apps Domain : your google apps partner domain.
; Unread Message Count : Here, you can specify the number of unread messages to display in the Gmail block. Leave as zero for no limit.
; New Window Links : By default, the Gmail links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.
; Show first name and Show last name : By default, the author's first and last name is displayed next to the e-mail title -- uncheck these settings to hide.

To configure the Gmail block:
# In Site Admin, go to Modules > Blocks > Manage Blocks
# Define the OAuth consumer secret. To find your consumer secret:
## Log in to http://www.google.com/a/YOURDOMAIN with your Google Admin account
## Click Advanced Tools
## Click Manage OAuth Access
## Copy the OAuth consumer secret from this screen and paste it into the Moodle text box
# Enter your Google apps domain
# Save changes

==Google Apps Block Settings==
; New Window Links : By default, the Google Apps links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.

==User Sync Block Settings==
; Google Apps username : This is a username in Google apps that has administrative permissions. This user should not be in Moodle and not part of the user sync. This user is used to create, delete and update Google accounts.
; Google Apps password : password for the google user to sync with.
; Google Apps domain : Your partner domain.
; Use Google Apps e-mail : This is unchecked by default. Checking this box will cause the e-mail address in the Moodle profile to be changed to the Gmail address.
; Enable events : This is turned on by default, as this causes any change of Moodle profile information to be instantly updated in Google. Unchecking this setting will cause Moodle profile updates to only be changed in Google when the cron runs. This is preferable if you do not want the deletion of Moodle accounts to immediately delete Google accounts.
; Cron interval : Enter how regularly (in minutes) you want the cron to run and sync Google and Moodle accounts. This is set to every 30 minutes by default.
; Cron expire : When the synchronization runs, it locks the cron from being executed again until it has finished. This setting is used to determine when that lock has expired. Consider setting this to a high value, especially on first runs with a lot of users. By default, it is set to 24 hours.

Configuring the Google User Sync Block:
# Log in to Moodle as an administrator. You must also be an administrator in Google.
# Click the Add Blocks drop down and choose "Google User Sync."
# Click the Settings link in the Google User Sync block.
# Configure the settings according to your Google Partner page information. You will need to enter the Google administrator user name and password in addition to your Google Partner domain.
# Save changes

Confirming the configuration is working:
# Click the Status link in the Google User Sync block to confirm that the integration was successful.
# Go to Site Administration > Security > Site policies
# Check Password Policy and make sure the Set Password Length is set to "6 or greater" (Required for Google's password policy)

===User Sync Status===

The user sync status will tell you if the integration was successful or not. If there is an error here, it means one of your settings is wrong. Check to make sure the user name and password is correct,

==Moodle-Google Gadget Setup==
To set up the Moodle-Google gadget, you need to first set up and configure the Google Apps Education Edition Integration. To complete this process, you must be an admin for both the Moodle installation and the Google installation.

# Log in to the Google Control Panel as an admin. Use the link below, substituting your Google domain name for "mroomsdev.com"
## https://www.google.com/a/mroomsdev.com
# Click the Service Settings tab, then the Start Page link.
# Click Customize and Publish
# Click Select default content
# Click Refresh default content below to make the Add stuff link appear
# Click Add stuff
# Click Add by URL
# Paste the following URL, substituting your Moodle domain name for "test.mroomsdev.com"
## http://<moodle site url>/auth/gsaml/moodlegadget.php
# Click Add
# Click close
# Click Back to Homepage
# You should see the Moodle Gadget appear
# Lastly, be sure to click the Publish link in the furthest upper right-hand corner.

==Things to Consider==

The Moodle-Google Gadget is a beta prototype. In the future, it may be much more useful. Currently, there is a known bug regarding the Gadget not updating immediately upon install. Developers are looking into it.

=Gmail Block=
==Descrption==
The Gmail block displays an inbox link, along with a list of a customizable number of unread e-mails. This list contains the subject of the e-mail as well as the name of the sender. Each subject is a link, which you can hover over with your mouse to see a summary of the e-mail.

==Granting Access==
The first time a user uses the Gmail block they will be required to grant the block access to view their Gmail account. This is required for the 3 legged OAuth connection.

To grant access perform the following steps:
# Click the Grant access link in the Gmail Block
[[Image:tut_img_60.png]]
## If Google authentication plugin is not configured then you will be asked to login to your site.
# Click the grant access button. (all of the black lines will be filled in with data about your email or site.
[[Image:tut_img_61.png]]
# Once you have granted access you will be shown a success screen an then returned to your Moodle site. You will not see a list of unread emails in your Gmail block.

=== Using Gmail block ===
To use the Gmail block
# Click the subject link of the e-mail you want to open. Click the Inbox link to go directly to your Gmail inbox.
[[Image:tut_img_gmail_block.png]]
# This opens the e-mail (or inbox) in a new browser window or tab.
# When you're done using Gmail, navigate back to your Moodle window. Unread messages will not update in your Moodle Gmail block until you log out and log back in.

==Refresh Access==
The Refresh Access Token Link can be used to renew a users access token when it expires or allows a user to deny access to an previously granted token. User's should seldom have to click this link to obtain a new access token from Google.

===Technical Notes on the Gmail Block===

* The Gmail block requires the rest of the Google-Moodle SSO system to be functional in order to operate properly.
* The system does not support Google's optional custom certificate authentication.
* If you are experiences SSO errors double check that your server time is in agreement with one of the internets many NTP servers. Your server and Google's systems must have proper time in order to process SSO requests properly.
* 2 legged OAuth is no longer supported by Google's Gmail atom feed and thus has been removed from the system.

=== Regarding General Maintenance ===
The Gmail block contains a local copy of Mozilla's Certification Authorities list. Overtime the Authority certificates bundle may need to be updated. If the Gmail block returns an error regarding SSL you may need to look into this issue.

=Google Apps Block=
To use the Google Apps block:
# Click the link of the application you want to use. This will take you directly to it in a new browser window or tab. You can choose from:
## Gmail
## Calendar
## Docs
# When you're done using the Google App, navigate back to your Moodle window.

=Logging Out of Google Apps=
If you click the Sign out link from a Google App, you will be taken to a page confirming that you want to log out.

If you click Yes, it also logs out of Moodle as well and takes you back to the Moodle Front Page. Likewise, if you log out of Moodle, it will also log out of Google. This prevents you from logging out of one system and forgetting to log out of the other. This is especially useful when using a public or shared computer.

If you click No, you will be taken back to the Moodle Front Page.

=Google User Sync=

This block allows you to create and manage Google accounts from Moodle. When a Moodle user is added to the User Sync, their account is automatically created in Google. If their account is deleted in Moodle, it will also be deleted in Google.

Once the block has been configured by a technically knowledgeable Moodle administrator (see "Google User Sync Settings" tutorial), the actual management of users can be performed by anyone with Moodle administrator permissions.

==Adding to the User Sync

# Click the Add users to sync link
# Use the Moodle filter to locate the users you wish to add. Note: never add a guest user or the main administrator. This will break the syncing process.
# Select the boxes next to the user names you wish to add. Alternatively, you can click the Add all users button.
# Click Add users to sync
# The page will refresh and the users you just added will no longer appear.

==Managing the User Sync==

To view the users currently being synced and remove them, you can use the feature Users being synced.

# Click the Users being synced link.
# This displays a list of all the users being synced. You can manage which users are displayed by searching with the Moodle filter. You can also display more users per page by using the Page size drop down menu.
# There are two ways to remove users. You can use the Remove all users button, or you can select specific users and click Remove users from sync.
# The page will refresh, and the users will no longer appear in the Users being synced tab.

=Moodle-Google Gadget=
If you have a Gmail account, you should see a Google gadget that contains a link back to Moodle on your Google Start Page. If you don't see a link to Moodle on your Google Start Page, follow these directions to add the Moodle Gadget.

# Open your Start Page.
# Click the Add stuff link.
# Click the Add by URL link.
# Copy and paste this URL, but be sure to change "test.mroomsdev.com" to your Google Partner Page domain: http://test.mroomsdev.com/auth/gsaml/moodlegadget.php
# Click Add
# A warning message will pop up. Click OK.
# A message should appear below the URL field that says it was added.
# Click Back to Homepage to return to your Start Page and verify the link is there.

==Tips and tricks==
*Once the Moodle accounts are disabled, so are the Google accounts. However one could choose to grant access via Google to continue collaboration after a course is completed.

=See also=
*Modules and Plugin page: [http://moodle.org/mod/data/view.php?d=13&mode=single&page=187 Modules and Plugin]
*Using Moodle Discusion: [http://moodle.org/mod/forum/view.php?id=7786 Google Apps integration forum]
*Download: [http://development.moodlerooms.com/mod/resource/view.php?id=210&subdir=/Google_1.0_for_Moodle_1.9 Google_1.0]_for_Moodle_1.9 on Moodlerooms.com no login required
*[[Google gadgets]]- code to put into a Moodle HTML block

[[Category:Contributed code]]

Fitxer:tut img gmail block.png

2010-04-26T19:36:17Z

Psychoph:

Fitxer:tut img 61.png

2010-04-26T19:36:08Z

Psychoph:

Fitxer:tut img 60.png

2010-04-26T19:36:01Z

Psychoph:

Google Apps Integration

2010-04-26T19:35:13Z

Psychoph:

=Introduction=
Moodlerooms and Google have worked together to build a state of the art integration. The 1.0 version of the integration provides:
* Automatic creation of users in Google Apps (Google Docs™, Google Calendar™, and Gmail™) when they are created in Moodle
* Automatic log in to Google Apps when a user logs in to Moodle
* A Gmail block in Moodle that displays latest Gmail messages on the Moodle Front Page
* A Google Apps block on the Moodle Front Page displays links to Google Start Page, Google Docs, Google Calendar and Gmail
* A Moodle app on the Google Apps Start PageGoogle Apps can integrates with Moodle v1.9 and above. There is a contributed code block that can be added to Moodle and a widget which can be added to Google. It will allow for a single sign-on for users from Moodle to Google.

=Integration Setup=

There are a few steps involved with setting up the Google Apps Education Edition Integration. This setup should be configured by a technically knowledgeable Moodle administrator.

# Set up Moodle's Authentication
# Set up Google's Authentication
# Add and configure the Gmail and Google Apps blocks
# Add and setup the User Sync block (optional; for those who do not have a Google account creation/management process)

==Requirements==
The following must be installed:
# auth/gsaml
# blocks/gmail
# blocks/gdata
# blocks/gaccess
# lib/zend

==Generating Private Key and SSL signed Certificate==
Generate the private key:
<code>sudo openssl genrsa -des3 -out googleappsidp.key 1024</code>

RSA encrypt the key for use with Google Apps:
<code>sudo openssl rsa -in googleappsidp.key -out googleappsidp.pem</code>

Create the .csr fill to generate the certificate from:
<code>sudo openssl req -new -key googleappsidp.key -out googleappsidp.csr</code>

Encrypt the key in x509 format using the key:
<code>sudo openssl x509 -req -days 9999 -in googleappsidp.csr -signkey googleappsidp.key -out googleappsidp.crt</code>

==Set Up Moodle's Authentication==

# Log in to Moodle as an Administrator
# Click Notifications to update block tables
# Enable the Google Authentication plug-in from the Manage Plug-ins admin page
# In the Site Admin menu, select "Users." Next, select "Authentication" and click "Google Authentication."
# Enter your Google partner page domain name.
# Upload private key (for more information on creating this, refer to Google documentation regarding key generation)
# Upload the SSL signing certificate (for more information on creating this, refer to Google documentation regarding key generation)
# Click Save Changes

==Set Up Google's Authentication==

# In a new browser window, log in to the Google Apps Control Panel page as an admin. To access this page, you can use this URL -- just change the end to have your partner page domain information: https://www.google.com/a/yourpartnerpagedomainname.com.
# Click the Advanced tools tab
# Click the Set up single sign-on (SSO) link next to Authentication
# Select the checkbox to "Enable Single Sign-on"
# Enter this URL into the Sign-in page URL text field:
## http://<moodle site url>/login/index.php
# Enter this URL into the Sign-out page URL text field:
## http://<moodle site url>/login/logout.php
# Enter this URL into the Change password URL text field:
## http://<moodle site url>/login/change_password.php
# Generate and upload a verification certificate to Google (X.509 certificate containing the public key)
# Click Save Changes
# Click the User Accounts tab
#This displays existing users as well as a message that says "You can create up to ### user accounts for this domain." If you are using the Google User Sync block for account management, this number must match or be larger than the number of accounts you plan on creating. Request more accounts if you need them by clicking the request more link on this page.
# Click the Settings link. Check the box to "Enable provisioning API" (otherwise users will NOT be updated) (Users and Groups > Settings > Enable provisioning API must be checked.)
# Click Save Changes
# Next you will add and configure the blocks as well as the Moodle-Google Gadget. See the "Google Blocks Configuration" and "Moodle-Google Gadget Setup" tutorials for more information.

==Things to Consider:==
* The Gmail feed might not be found and display an error. Troubleshooting tips include:
** Turn on debugging and the diagnostics page will perform a basic check on the Gmail feed.
** If you are using the Google User Sync block, check to see if an admin or guest user has been added to the sync. If so, remove them.
** If you are using the Google User Sync block, be sure your Google user settings are set to allow the number users you are adding to the sync in Moodle. If the number of Moodle users is larger than the number set in Google, then those accounts will not be created or synced (ie, if Google is set to 1000 users and Moodle has 1500, 500 accounts will fail to be created or synced).
* The location of the Google Authentication Plug-in in the Authentication order is important. Currently, it needs to override a user's auth type when a Moodle user changes passwords. This behavior may affect M-Net users. A solution for this problem has not yet been found.
* Do not add a user to the sync if their user name has been deleted from Google. You need to wait five days before adding them to the User Sync.
* See the Diagnostics Page in the gsaml settings for more information about your setup.

==Gmail Block Settings==
; OAuth Consumer Secret : This is a string that Google apps generates and is used as a shared secret.
; Google Apps Domain : your google apps partner domain.
; Unread Message Count : Here, you can specify the number of unread messages to display in the Gmail block. Leave as zero for no limit.
; New Window Links : By default, the Gmail links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.
; Show first name and Show last name : By default, the author's first and last name is displayed next to the e-mail title -- uncheck these settings to hide.

To configure the Gmail block:
# In Site Admin, go to Modules > Blocks > Manage Blocks
# Define the OAuth consumer secret. To find your consumer secret:
## Log in to http://www.google.com/a/YOURDOMAIN with your Google Admin account
## Click Advanced Tools
## Click Manage OAuth Access
## Copy the OAuth consumer secret from this screen and paste it into the Moodle text box
# Enter your Google apps domain
# Save changes

==Google Apps Block Settings==
; New Window Links : By default, the Google Apps links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.

==User Sync Block Settings==
; Google Apps username : This is a username in Google apps that has administrative permissions. This user should not be in Moodle and not part of the user sync. This user is used to create, delete and update Google accounts.
; Google Apps password : password for the google user to sync with.
; Google Apps domain : Your partner domain.
; Use Google Apps e-mail : This is unchecked by default. Checking this box will cause the e-mail address in the Moodle profile to be changed to the Gmail address.
; Enable events : This is turned on by default, as this causes any change of Moodle profile information to be instantly updated in Google. Unchecking this setting will cause Moodle profile updates to only be changed in Google when the cron runs. This is preferable if you do not want the deletion of Moodle accounts to immediately delete Google accounts.
; Cron interval : Enter how regularly (in minutes) you want the cron to run and sync Google and Moodle accounts. This is set to every 30 minutes by default.
; Cron expire : When the synchronization runs, it locks the cron from being executed again until it has finished. This setting is used to determine when that lock has expired. Consider setting this to a high value, especially on first runs with a lot of users. By default, it is set to 24 hours.

Configuring the Google User Sync Block:
# Log in to Moodle as an administrator. You must also be an administrator in Google.
# Click the Add Blocks drop down and choose "Google User Sync."
# Click the Settings link in the Google User Sync block.
# Configure the settings according to your Google Partner page information. You will need to enter the Google administrator user name and password in addition to your Google Partner domain.
# Save changes

Confirming the configuration is working:
# Click the Status link in the Google User Sync block to confirm that the integration was successful.
# Go to Site Administration > Security > Site policies
# Check Password Policy and make sure the Set Password Length is set to "6 or greater" (Required for Google's password policy)

===User Sync Status===

The user sync status will tell you if the integration was successful or not. If there is an error here, it means one of your settings is wrong. Check to make sure the user name and password is correct,

==Moodle-Google Gadget Setup==
To set up the Moodle-Google gadget, you need to first set up and configure the Google Apps Education Edition Integration. To complete this process, you must be an admin for both the Moodle installation and the Google installation.

# Log in to the Google Control Panel as an admin. Use the link below, substituting your Google domain name for "mroomsdev.com"
## https://www.google.com/a/mroomsdev.com
# Click the Service Settings tab, then the Start Page link.
# Click Customize and Publish
# Click Select default content
# Click Refresh default content below to make the Add stuff link appear
# Click Add stuff
# Click Add by URL
# Paste the following URL, substituting your Moodle domain name for "test.mroomsdev.com"
## http://<moodle site url>/auth/gsaml/moodlegadget.php
# Click Add
# Click close
# Click Back to Homepage
# You should see the Moodle Gadget appear
# Lastly, be sure to click the Publish link in the furthest upper right-hand corner.

==Things to Consider==

The Moodle-Google Gadget is a beta prototype. In the future, it may be much more useful. Currently, there is a known bug regarding the Gadget not updating immediately upon install. Developers are looking into it.

=Gmail Block=
==Descrption==
The Gmail block displays an inbox link, along with a list of a customizable number of unread e-mails. This list contains the subject of the e-mail as well as the name of the sender. Each subject is a link, which you can hover over with your mouse to see a summary of the e-mail.

==Granting Access==
The first time a user uses the Gmail block they will be required to grant the block access to view their Gmail account. This is required for the 3 legged OAuth connection.

To grant access perform the following steps:
# Click the Grant access link in the Gmail Block
[[Image:tut_img_60.png]]
## If Google authentication plugin is not configured then you will be asked to login to your site.
# Click the grant access button. (all of the black lines will be filled in with data about your email or site.
[[Image:tut_img_61.png]]
# Once you have granted access you will be shown a success screen an then returned to your Moodle site. You will not see a list of unread emails in your Gmail block.

=== Using Gmail block ===
To use the Gmail block
# Click the subject link of the e-mail you want to open. Click the Inbox link to go directly to your Gmail inbox.
[[Image:tut_img_gmail_block.png]]
# This opens the e-mail (or inbox) in a new browser window or tab.
# When you're done using Gmail, navigate back to your Moodle window. Unread messages will not update in your Moodle Gmail block until you log out and log back in.

==Refresh Access==
The Refresh Access Token Link can be used to renew a users access token when it expires or allows a user to deny access to an previously granted token. User's should seldom have to click this link to obtain a new access token from Google.

===Technical Notes on the Gmail Block===

* The Gmail block requires the rest of the Google-Moodle SSO system to be functional in order to operate properly.
* The system does not support Google's optional custom certificate authentication.
* If you are experiences SSO errors double check that your server time is in agreement with one of the internets many NTP servers. Your server and Google's systems must have proper time in order to process SSO requests properly.
* 2 legged OAuth is no longer supported by Google's Gmail atom feed and thus has been removed from the system.

=== Regarding General Maintenance ===
The Gmail block contains a local copy of Mozilla's Certification Authorities list. Overtime the Authority certificates bundle may need to be updated. If the Gmail block returns an error regarding SSL you may need to look into this issue.

=Google Apps Block=
To use the Google Apps block:
# Click the link of the application you want to use. This will take you directly to it in a new browser window or tab. You can choose from:
## Gmail
## Calendar
## Docs
# When you're done using the Google App, navigate back to your Moodle window.

=Logging Out of Google Apps=
If you click the Sign out link from a Google App, you will be taken to a page confirming that you want to log out.

If you click Yes, it also logs out of Moodle as well and takes you back to the Moodle Front Page. Likewise, if you log out of Moodle, it will also log out of Google. This prevents you from logging out of one system and forgetting to log out of the other. This is especially useful when using a public or shared computer.

If you click No, you will be taken back to the Moodle Front Page.

=Google User Sync=

This block allows you to create and manage Google accounts from Moodle. When a Moodle user is added to the User Sync, their account is automatically created in Google. If their account is deleted in Moodle, it will also be deleted in Google.

Once the block has been configured by a technically knowledgeable Moodle administrator (see "Google User Sync Settings" tutorial), the actual management of users can be performed by anyone with Moodle administrator permissions.

==Adding to the User Sync

# Click the Add users to sync link
# Use the Moodle filter to locate the users you wish to add. Note: never add a guest user or the main administrator. This will break the syncing process.
# Select the boxes next to the user names you wish to add. Alternatively, you can click the Add all users button.
# Click Add users to sync
# The page will refresh and the users you just added will no longer appear.

==Managing the User Sync==

To view the users currently being synced and remove them, you can use the feature Users being synced.

# Click the Users being synced link.
# This displays a list of all the users being synced. You can manage which users are displayed by searching with the Moodle filter. You can also display more users per page by using the Page size drop down menu.
# There are two ways to remove users. You can use the Remove all users button, or you can select specific users and click Remove users from sync.
# The page will refresh, and the users will no longer appear in the Users being synced tab.

=Moodle-Google Gadget=
If you have a Gmail account, you should see a Google gadget that contains a link back to Moodle on your Google Start Page. If you don't see a link to Moodle on your Google Start Page, follow these directions to add the Moodle Gadget.

# Open your Start Page.
# Click the Add stuff link.
# Click the Add by URL link.
# Copy and paste this URL, but be sure to change "test.mroomsdev.com" to your Google Partner Page domain: http://test.mroomsdev.com/auth/gsaml/moodlegadget.php
# Click Add
# A warning message will pop up. Click OK.
# A message should appear below the URL field that says it was added.
# Click Back to Homepage to return to your Start Page and verify the link is there.

==Tips and tricks==
*Once the Moodle accounts are disabled, so are the Google accounts. However one could choose to grant access via Google to continue collaboration after a course is completed.

=See also=
*Modules and Plugin page : [http://moodle.org/mod/data/view.php?d=13&mode=single&page=187 Modules and Plugin]
*Using Moodle [http://moodle.org/mod/forum/view.php?id=7786 Google Apps integration forum]
*Download: [http://development.moodlerooms.com/mod/resource/view.php?id=210&subdir=/Google_1.0_for_Moodle_1.9 Google_1.0]_for_Moodle_1.9 on Moodlerooms.com no login required
*Discussion: [http://development.moodlerooms.com/course/view.php?id=30 Moodlerooms Moodle-Google course] - requires login to Moodlerooms
*[[Google gadgets]]- code to put into a Moodle HTML block

[[Category:Contributed code]]

Google Apps Integration

2010-04-26T18:18:21Z

Psychoph:

=Introduction=
Moodlerooms and Google have worked together to build a state of the art integration. The 1.0 version of the integration provides:
* Automatic creation of users in Google Apps (Google Docs™, Google Calendar™, and Gmail™) when they are created in Moodle
* Automatic log in to Google Apps when a user logs in to Moodle
* A Gmail block in Moodle that displays latest Gmail messages on the Moodle Front Page
* A Google Apps block on the Moodle Front Page displays links to Google Start Page, Google Docs, Google Calendar and Gmail
* A Moodle app on the Google Apps Start PageGoogle Apps can integrates with Moodle v1.9 and above. There is a contributed code block that can be added to Moodle and a widget which can be added to Google. It will allow for a single sign-on for users from Moodle to Google.

=Integration Setup=

There are a few steps involved with setting up the Google Apps Education Edition Integration. This setup should be configured by a technically knowledgeable Moodle administrator.

# Set up Moodle's Authentication
# Set up Google's Authentication
# Add and configure the Gmail and Google Apps blocks
# Add and setup the User Sync block (optional; for those who do not have a Google account creation/management process)

==Requirements==
The following must be installed:
# auth/gsaml
# blocks/gmail
# blocks/gdata
# blocks/gaccess
# lib/zend

==Generating Private Key and SSL signed Certificate==
Generate the private key:
<code>sudo openssl genrsa -des3 -out googleappsidp.key 1024</code>

RSA encrypt the key for use with Google Apps:
<code>sudo openssl rsa -in googleappsidp.key -out googleappsidp.pem</code>

Create the .csr fill to generate the certificate from:
<code>sudo openssl req -new -key googleappsidp.key -out googleappsidp.csr</code>

Encrypt the key in x509 format using the key:
<code>sudo openssl x509 -req -days 9999 -in googleappsidp.csr -signkey googleappsidp.key -out googleappsidp.crt</code>

==Set Up Moodle's Authentication==

# Log in to Moodle as an Administrator
# Click Notifications to update block tables
# Enable the Google Authentication plug-in from the Manage Plug-ins admin page
# In the Site Admin menu, select "Users." Next, select "Authentication" and click "Google Authentication."
# Enter your Google partner page domain name.
# Upload private key (for more information on creating this, refer to Google documentation regarding key generation)
# Upload the SSL signing certificate (for more information on creating this, refer to Google documentation regarding key generation)
# Click Save Changes

==Set Up Google's Authentication==

# In a new browser window, log in to the Google Apps Control Panel page as an admin. To access this page, you can use this URL -- just change the end to have your partner page domain information: https://www.google.com/a/yourpartnerpagedomainname.com.
# Click the Advanced tools tab
# Click the Set up single sign-on (SSO) link next to Authentication
# Select the checkbox to "Enable Single Sign-on"
# Enter this URL into the Sign-in page URL text field:
## http://<moodle site url>/login/index.php
# Enter this URL into the Sign-out page URL text field:
## http://<moodle site url>/login/logout.php
# Enter this URL into the Change password URL text field:
## http://<moodle site url>/login/change_password.php
# Generate and upload a verification certificate to Google (X.509 certificate containing the public key)
# Click Save Changes
# Click the User Accounts tab
#This displays existing users as well as a message that says "You can create up to ### user accounts for this domain." If you are using the Google User Sync block for account management, this number must match or be larger than the number of accounts you plan on creating. Request more accounts if you need them by clicking the request more link on this page.
# Click the Settings link. Check the box to "Enable provisioning API" (otherwise users will NOT be updated) (Users and Groups > Settings > Enable provisioning API must be checked.)
# Click Save Changes
# Next you will add and configure the blocks as well as the Moodle-Google Gadget. See the "Google Blocks Configuration" and "Moodle-Google Gadget Setup" tutorials for more information.

==Things to Consider:==
* The Gmail feed might not be found and display an error. Troubleshooting tips include:
** Turn on debugging and the diagnostics page will perform a basic check on the Gmail feed.
** If you are using the Google User Sync block, check to see if an admin or guest user has been added to the sync. If so, remove them.
** If you are using the Google User Sync block, be sure your Google user settings are set to allow the number users you are adding to the sync in Moodle. If the number of Moodle users is larger than the number set in Google, then those accounts will not be created or synced (ie, if Google is set to 1000 users and Moodle has 1500, 500 accounts will fail to be created or synced).
* The location of the Google Authentication Plug-in in the Authentication order is important. Currently, it needs to override a user's auth type when a Moodle user changes passwords. This behavior may affect M-Net users. A solution for this problem has not yet been found.
* Do not add a user to the sync if their user name has been deleted from Google. You need to wait five days before adding them to the User Sync.
* See the Diagnostics Page in the gsaml settings for more information about your setup.

==Gmail Block Settings==
; OAuth Consumer Secret : This is a string that Google apps generates and is used as a shared secret.
; Google Apps Domain : your google apps partner domain.
; Unread Message Count : Here, you can specify the number of unread messages to display in the Gmail block. Leave as zero for no limit.
; New Window Links : By default, the Gmail links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.
; Show first name and Show last name : By default, the author's first and last name is displayed next to the e-mail title -- uncheck these settings to hide.

To configure the Gmail block:
# In Site Admin, go to Modules > Blocks > Manage Blocks
# Define the OAuth consumer secret. To find your consumer secret:
## Log in to http://www.google.com/a/YOURDOMAIN with your Google Admin account
## Click Advanced Tools
## Click Manage OAuth Access
## Copy the OAuth consumer secret from this screen and paste it into the Moodle text box
# Enter your Google apps domain
# Save changes

==Google Apps Block Settings==
; New Window Links : By default, the Google Apps links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.

==User Sync Block Settings==
; Google Apps username : This is a username in Google apps that has administrative permissions. This user should not be in Moodle and not part of the user sync. This user is used to create, delete and update Google accounts.
; Google Apps password : password for the google user to sync with.
; Google Apps domain : Your partner domain.
; Use Google Apps e-mail : This is unchecked by default. Checking this box will cause the e-mail address in the Moodle profile to be changed to the Gmail address.
; Enable events : This is turned on by default, as this causes any change of Moodle profile information to be instantly updated in Google. Unchecking this setting will cause Moodle profile updates to only be changed in Google when the cron runs. This is preferable if you do not want the deletion of Moodle accounts to immediately delete Google accounts.
; Cron interval : Enter how regularly (in minutes) you want the cron to run and sync Google and Moodle accounts. This is set to every 30 minutes by default.
; Cron expire : When the synchronization runs, it locks the cron from being executed again until it has finished. This setting is used to determine when that lock has expired. Consider setting this to a high value, especially on first runs with a lot of users. By default, it is set to 24 hours.

Configuring the Google User Sync Block:
# Log in to Moodle as an administrator. You must also be an administrator in Google.
# Click the Add Blocks drop down and choose "Google User Sync."
# Click the Settings link in the Google User Sync block.
# Configure the settings according to your Google Partner page information. You will need to enter the Google administrator user name and password in addition to your Google Partner domain.
# Save changes

Confirming the configuration is working:
# Click the Status link in the Google User Sync block to confirm that the integration was successful.
# Go to Site Administration > Security > Site policies
# Check Password Policy and make sure the Set Password Length is set to "6 or greater" (Required for Google's password policy)

===User Sync Status===

The user sync status will tell you if the integration was successful or not. If there is an error here, it means one of your settings is wrong. Check to make sure the user name and password is correct,

==Moodle-Google Gadget Setup==
To set up the Moodle-Google gadget, you need to first set up and configure the Google Apps Education Edition Integration. To complete this process, you must be an admin for both the Moodle installation and the Google installation.

# Log in to the Google Control Panel as an admin. Use the link below, substituting your Google domain name for "mroomsdev.com"
## https://www.google.com/a/mroomsdev.com
# Click the Service Settings tab, then the Start Page link.
# Click Customize and Publish
# Click Select default content
# Click Refresh default content below to make the Add stuff link appear
# Click Add stuff
# Click Add by URL
# Paste the following URL, substituting your Moodle domain name for "test.mroomsdev.com"
## http://<moodle site url>/auth/gsaml/moodlegadget.php
# Click Add
# Click close
# Click Back to Homepage
# You should see the Moodle Gadget appear
# Lastly, be sure to click the Publish link in the furthest upper right-hand corner.

==Things to Consider==

The Moodle-Google Gadget is a beta prototype. In the future, it may be much more useful. Currently, there is a known bug regarding the Gadget not updating immediately upon install. Developers are looking into it.

=Gmail Block=
The Gmail block displays an inbox link, along with a list of a customizable number of unread e-mails. This list contains the subject of the e-mail as well as the name of the sender. Each subject is a link, which you can hover over with your mouse to see a summary of the e-mail.

To use the Gmail block
# Click the subject link of the e-mail you want to open. Click the Inbox link to go directly to your Gmail inbox.
# This opens the e-mail (or inbox) in a new browser window or tab.
# When you're done using Gmail, navigate back to your Moodle window. Unread messages will not update in your Moodle Gmail block until you log out and log back in.

==Logging Out==

If you click the Sign out link from Gmail, you will be taken to a page confirming that you want to log out.

If you click Yes, it also logs out of Moodle and takes you back to the Moodle Front Page. Likewise, if you log out of Moodle, it will also log out of Google. This prevents you from logging out of one system and forgetting to log out of the other. This is especially useful when using a public or shared computer.

If you click No, you will be taken back to the Moodle Front Page.

==Granting Access==
Upon first usage of the Gmail block you may see a "Grant Access to your Inbox" link.

Click the link.

You should only have to sign in this time to grant
Moodle permission to retrieve your mail.

Grant access.

Moodle will process the request.

The gmail block should now show your inbox messages. If you are having trouble check that your access token field (Gmail Settings) does not have an extra blank space.

NOTE

The Gmail block requires the rest of the Google-Moodle SSO system to be functional in order to operate properly.

The Refresh Access Token Link will renew a users access token when it expires. User's should seldom have to click this link to obtain a new access token from Google.

Please note, that the system does not support Google's optional custom certificate authentication.

If you are experiences SSO errors double check that your server time is in agreement with one of the internets many NTP servers. Your server and Google's systems must have proper time in order to process SSO requests properly.

2 legged OAuth is no longer supported by Google's Gmail atom feed and thus has been removed from the system.

Regarding General Maintenance
The Gmail block contains a local copy of Mozilla's Certification Authorities list.

Overtime the Authority certificates bundle may need to be updated.

If the Gmail block returns an error regarding SSL you may need to look into this issue.

==Tips and tricks==
*Once the Moodle accounts are disabled, so are the Google accounts. However one could choose to grant access via Google to continue collaboration after a course is completed.

=See also=
*Modules and Plugin page : [http://moodle.org/mod/data/view.php?d=13&mode=single&page=187 Modules and Plungin]
*Download: [http://development.moodlerooms.com/mod/resource/view.php?id=210&subdir=/Google_1.0_for_Moodle_1.9 Google_1.0]_for_Moodle_1.9 on Moodlerooms.com no login required
*Discussion: [http://development.moodlerooms.com/course/view.php?id=30 Moodlerooms Moodle-Google course] - requires login to Moodlerooms
*[[Google gadgets]]- code to put into a Moodle HTML block

[[Category:Contributed code]]

Google Apps Integration

2010-04-26T17:25:01Z

Psychoph:

Google Apps Integration

2010-04-26T17:19:48Z

Psychoph:

=Google Apps Education Edition™ Integration=
==Introduction==
Moodlerooms and Google have worked together to build a state of the art integration. The 1.0 version of the integration provides:
* Automatic creation of users in Google Apps (Google Docs™, Google Calendar™, and Gmail™) when they are created in Moodle
* Automatic log in to Google Apps when a user logs in to Moodle
* A Gmail block in Moodle that displays latest Gmail messages on the Moodle Front Page
* A Google Apps block on the Moodle Front Page displays links to Google Start Page, Google Docs, Google Calendar and Gmail
* A Moodle app on the Google Apps Start PageGoogle Apps can integrates with Moodle v1.9 and above. There is a contributed code block that can be added to Moodle and a widget which can be added to Google. It will allow for a single sign-on for users from Moodle to Google.

==Integration Setup==

There are a few steps involved with setting up the Google Apps Education Edition Integration. This setup should be configured by a technically knowledgeable Moodle administrator.

# Set up Moodle's Authentication
# Set up Google's Authentication
# Add and configure the Gmail and Google Apps blocks
# Add and setup the User Sync block (optional; for those who do not have a Google account creation/management process)

===Requirements===

# gsaml, gaccess, gmail, gdata and lib/zend code must be installed
** auth/gsaml
** blocks/gmail
** blocks/gdata
** blocks/gaccess
** lib/zend

===Generating Private Key and SSL signed Certificate===
<code>
sudo openssl genrsa -des3 -out googleappsidp.key 1024
sudo openssl rsa -in googleappsidp.key -out googleappsidp.pem
sudo openssl req -new -key googleappsidp.key -out googleappsidp.csr
sudo openssl x509 -req -days 9999 -in googleappsidp.csr -signkey googleappsidp.key -out googleappsidp.crt
</code>

===Set Up Moodle's Authentication===

# Log in to Moodle as an Administrator
# Click Notifications to update block tables
# Enable the Google Authentication plug-in from the Manage Plug-ins admin page
# In the Site Admin menu, select "Users." Next, select "Authentication" and click "Google Authentication."
# Enter your Google partner page domain name.
# Upload private key (for more information on creating this, refer to Google documentation regarding key generation)
# Upload the SSL signing certificate (for more information on creating this, refer to Google documentation regarding key generation)
# Click Save Changes

===Set Up Google's Authentication===

# In a new browser window, log in to the Google Apps Control Panel page as an admin. To access this page, you can use this URL -- just change the end to have your partner page domain information: https://www.google.com/a/yourpartnerpagedomainname.com.
# Click the Advanced tools tab
# Click the Set up single sign-on (SSO) link next to Authentication
# Select the checkbox to "Enable Single Sign-on"
# Enter this URL into the Sign-in page URL text field:
** http://<moodle site url>/login/index.php
# Enter this URL into the Sign-out page URL text field:
** http://<moodle site url>/login/logout.php
# Enter this URL into the Change password URL text field:
** http://<moodle site url>/login/change_password.php
# Generate and upload a verification certificate to Google (X.509 certificate containing the public key)
**
# Click Save Changes
# Click the User Accounts tab
#This displays existing users as well as a message that says "You can create up to ### user accounts for this domain." If you are using the Google User Sync block for account management, this number must match or be larger than the number of accounts you plan on creating. Request more accounts if you need them by clicking the request more link on this page.
# Click the Settings link. Check the box to "Enable provisioning API" (otherwise users will NOT be updated) (Users and Groups > Settings > Enable provisioning API must be checked.)
# Click Save Changes
# Next you will add and configure the blocks as well as the Moodle-Google Gadget. See the "Google Blocks Configuration" and "Moodle-Google Gadget Setup" tutorials for more information.

===Things to Consider:===
* The Gmail feed might not be found and display an error. Troubleshooting tips include:
** Turn on debugging and the diagnostics page will perform a basic check on the Gmail feed.
** If you are using the Google User Sync block, check to see if an admin or guest user has been added to the sync. If so, remove them.
** If you are using the Google User Sync block, be sure your Google user settings are set to allow the number users you are adding to the sync in Moodle. If the number of Moodle users is larger than the number set in Google, then those accounts will not be created or synced (ie, if Google is set to 1000 users and Moodle has 1500, 500 accounts will fail to be created or synced).
* The location of the Google Authentication Plug-in in the Authentication order is important. Currently, it needs to override a user's auth type when a Moodle user changes passwords. This behavior may affect M-Net users. A solution for this problem has not yet been found.
* Do not add a user to the sync if their user name has been deleted from Google. You need to wait five days before adding them to the User Sync.
* See the Diagnostics Page in the gsaml settings for more information about your setup.

===Gmail Block Settings===

In Site Admin, go to Modules > Blocks > Manage Blocks
# Define the OAuth consumer secret. To find your consumer secret:
** Log in to http://www.google.com/a/YOURDOMAIN with your Google Admin account
** Click Advanced Tools
** Click Manage OAuth Access
** Copy the OAuth consumer secret from this screen and paste it into the Moodle text box
# Unread Message Count: Here, you can specify the number of unread messages to display in the Gmail block. Leave as zero for no limit.
# New Window Links: By default, the Gmail links open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.
# Show first name and Show last name: By default, the author's first and last name is displayed next to the e-mail title -- uncheck these settings to hide.
# Save changes

===Google Apps Settings===
In Site Admin, go to Modules > Blocks > Manage Blocks
By default, Google Apps will open in a new browser window or tab. You can change this to open in the same window by unchecking this setting.

===Google User Sync Block Settings===
Google User Sync can be configured from the settings link inside the block. The same settings can be found in the Site Administration area. In Site Admin, go to Modules > Blocks > Manage Blocks. For information on how to configure the Google User Sync, see the "Google User Sync Settings" tutorial.

===Moodle-Google Gadget Setup===
To set up the Moodle-Google gadget, you need to first set up and configure the Google Apps Education Edition Integration. To complete this process, you must be an admin for both the Moodle installation and the Google installation.

# Log in to the Google Control Panel as an admin. Use the link below, substituting your Google domain name for "mroomsdev.com"
** https://www.google.com/a/mroomsdev.com
# Click the Service Settings tab, then the Start Page link.
# Click Customize and Publish
# Click Select default content
# Click Refresh default content below to make the Add stuff link appear
# Click Add stuff
# Click Add by URL
# Paste the following URL, substituting your Moodle domain name for "test.mroomsdev.com"
** http://<moodle site url>/auth/gsaml/moodlegadget.php
# Click Add
# Click close
# Click Back to Homepage
# You should see the Moodle Gadget appear
# Lastly, be sure to click the Publish link in the furthest upper right-hand corner.

===Things to Consider===

The Moodle-Google Gadget is a beta prototype. In the future, it may be much more useful. Currently, there is a known bug regarding the Gadget not updating immediately upon install. Developers are looking into it.

==Features==
*Moodle users are automatically created in Google Apps (Google Docs, Calendar, and Gmail).
*When you log in to Moodle, you are automatically logged in to Google Apps.
*A Gmail block in Moodle displays your latest Gmail messages when you login to the Moodle Front Page.
*A Google Apps block on the Moodle Front Page displays links to your Google Start Page, Google Docs, Google Calendar and Gmail.
*A Google Widget shows a link to Moodle on the Google side.

==Description==
Essentially, once the integration is complete, students will be presented with a Google Apps block that will link out to their Google account. This will allow Moodle students to work online collaboratively rather than each downloading a document, making edits, uploading it to Moodle and then comparing with other documents.

This would be great for online group activities or exercises, collaborative websites and collaborative calendars.

==How to set up==
As an admin, you need to coordinate your Moodle accounts with your Google accounts. Set up an Admin Account at Google - this is generally free if you are an educator. Each student in Moodle that is synced with Google apps will be granted a Gmail acccount. As a site admin or teacher, you will need to determine if you class(es) will use Gmail services to communicate or if you want to use the email address associated with your Moodle account (in some cases they could be the same).

==Tips and tricks==
*Once the Moodle accounts are disabled, so are the Google accounts. However one could choose to grant access via Google to continue collaboration after a course is completed.

==See also==
*Modules and Plugin page : [http://moodle.org/mod/data/view.php?d=13&mode=single&page=187 Modules and Plungin]
*Download: [http://development.moodlerooms.com/mod/resource/view.php?id=210&subdir=/Google_1.0_for_Moodle_1.9 Google_1.0]_for_Moodle_1.9 on Moodlerooms.com no login required
*Discussion: [http://development.moodlerooms.com/course/view.php?id=30 Moodlerooms Moodle-Google course] - requires login to Moodlerooms
*[[Google gadgets]]- code to put into a Moodle HTML block

[[Category:Contributed code]]

Fitxer:themed resource display themed resource.png

2010-03-31T03:30:09Z

Psychoph:

Fitxer:themed resource choose.png

2010-03-31T03:29:48Z

Psychoph:

Fitxer:themed resource theme upload.png

2010-03-31T03:28:10Z

Psychoph:

Fitxer:themed resource upload button.png

2010-03-31T03:27:48Z

Psychoph:

Fitxer:themed resource upload.png

2010-03-31T03:26:44Z

Psychoph:

Fitxer:themed content drop down.png

2010-03-31T03:26:25Z

Psychoph:

Fitxer:manage activities tab.png

2010-03-31T03:24:03Z

Psychoph:

Fitxer:themedprnt.jpg

2010-03-31T03:23:56Z

Psychoph:

Fitxer:themed resource editing off.png

2010-03-31T03:23:40Z

Psychoph:

Fitxer:themed resource in page.png

2010-03-31T03:23:31Z

Psychoph:

Fitxer:trmenu.png

2010-03-31T03:23:23Z

Psychoph:

Trouble Ticket block

2010-03-31T03:06:15Z

Psychoph: /* Block Description */

=Block Description=

The trouble ticket block was developed to provide Moodle users with a simple way to notify Moodle site administrators of a problem with the site or a specific module or block. The trouble ticket block allows Teachers to add multiple types of trouble tickets to a page as either a link or a button. Each Trouble ticket can be configured with a specific email to send the notification to as well as a custom response to the user.

'''Developers'''
Moodlerooms Inc., Mike Avelar, Sam Chaffee, Jason Hardin, Mark Nielsen

'''
== See also ==
'''
[[Category:Administrator]]
[[Category:Block]]
[[Category:Contributed code]]

Trouble Ticket block

2010-03-31T03:05:54Z

Psychoph: New page: =Block Description= The trouble ticket block was developed to provide Moodle users with a simple way to notify Moodle site administrators of a problem with the site or a specific module o...

=Block Description=

The trouble ticket block was developed to provide Moodle users with a simple way to notify Moodle site administrators of a problem with the site or a specific module or block. The trouble ticket block allows Teachers to add multiple types of trouble tickets to a page as either a link or a button. Each Trouble ticket can be configured with a specific email to send the notification to as well as a custom response to the user.

*Developers*
Moodlerooms Inc., Mike Avelar, Sam Chaffee, Jason Hardin, Mark Nielsen

'''
== See also ==
'''
[[Category:Administrator]]
[[Category:Block]]
[[Category:Contributed code]]

Fitxer:dmc deleted success.png

2010-03-30T06:41:55Z

Psychoph:

Fitxer:dmc confirmation.png

2010-03-30T06:41:47Z

Psychoph:

Fitxer:dmc select delete.png

2010-03-30T06:41:41Z

Psychoph:

Fitxer:dmc landing.png

2010-03-30T06:41:30Z

Psychoph:

Fitxer:delete courses.png

2010-03-30T06:41:22Z

Psychoph:

Course Management block

2010-03-30T06:40:47Z

Psychoph:

=Block Description=

The course management block was developed to increase site administrator’s productivity and reduce peak load on Moodle servers caused by the restoring of courses. The Course management block allows Moodle site administrators to schedule restores of courses at non-peak Moodle usage times. It also allows Moodle site administrators to delete multiple courses at one time from one user interface.

''Developers''

Moodlerooms Inc, Michael Avelar, Sam Chaffee

=Global Configuration Settings=
To get to this block's global setting options, at the site page, click to 'Modules'>'Blocks'>'Course Management'. This screen provides 3 options for the block:

Max Restores: The maximum number of restores a restore is allow
Ignore Currently Processing Flag: Allows the cron to be forced out of turn
Enable Email Notification: Site Admin (Default) or alternate contact, will receive email notifications if an error occurs.

[[Image:block_setup.png|block setup]]

=Choose a Restore File (No Metadata file)=
Make sure you are on the site home page, then click on the 'Schedule Bulk Restore' link to start the bulk restore scheduling process
.
[[Image:block_iface.png]]

You will now see two sections: 'Choose a course to restore:' and 'Choose a course metadata file'. Only the first section has a required input field. To choose a restore zip:

# First, choose the location for the zip file. The site directory is chosen by default. If the restore zip is located in a course, choose that course's shortname from the dropdown.
# Click the 'Choose from Selected Course' button
# Navigate to the restore zip (if necessary), then click on the 'Choose' link next to the resource name.

[[Image:choose_file.png]]

The section here shows how to use the metadata section to help automate the next few steps. For now, we'll show how to setup the specifics manually.
Click 'Continue'. There should be a brief pause, then you should see the following message:

[[Image:restore_validated.png]]

Click 'Continue'. This next screen is the final step in the restore scheduling process.

=Setup Restore Options (No Metadata file)=
The final screen should be split up into 4 sections: 'Course Defaults', 'Restore Options', 'Role Mappings', and 'Cron Settings'. When a metadata file was not uploaded, most of these options will be available to you. If a metadata file was uploaded, most of these options will be preselected for you.

==Course Defaults==

The 'Course Defaults' section should be filled out with data from the original restore. There are four fields in this section:

* '''Category''': The 'Category' section will default to the category the backup course originated from.
* '''Short Name''': The 'Short Name' field will be filled out with the original courses shortname.
* '''Full Name''': The 'Full Name' field will be filled out with the original courses fullname.
* '''Course Start Date''': The 'Course Start Date' field should also be populated with the original date (depending on original backup options)
*'''NOTE''': If another course already exist on the site with the same short/fullnames, the new course(s) will be appended with a number to differentiate the courses.

[[Image:course_defaults.png]]

==Restore Options==

Restore options availability are largely determined by the original backup file's backup options. EG: If not marked as a metacourse, the 'Metacourse' dropdown will be disabled. If the backup file didn't backup the Log records, the 'Logs' option will be disabled. There are 6-7 fields here (Depending on the original backup options):

* '''Metacourse''': Restores this course as a metacourse
* '''Users''': Restores this courses users
* '''Logs''': Restores the old log records specific to the old course
* '''User Files''': Restores all user's files into the new course directory
* '''Course Files''': Restores all course level files into the new course directory
* '''Restore how many times?''': How many times this course should be copied. Maximum number is determined at the global config level (see here
*NOTE: All options default to 'No'/'None' to decrease processing time. All option availability is determined by the original backup's settings.

[[Image:restore_options.png]]

==Role Mappings==

This section allows you to optionally remap incomming user roles to another role on your Moodle installation. The length of this list is dependent upon the number of assigned roles in the old course. If there is a role match on your installation, it will be selected by default. If there is no match (eg: came from another installation), 'Choose a Role...' will be selected and a valid role must be selected before continuing.

[[Image:role_mappings.png]]

==Cron Settings==

This section is the only part specific to this block. This is where you set the details for the restore to be run on the cron job. There are 3 fields here:

* '''Start Time''': The 'Start Time' prevents this restore from starting a process on the cron any time before the 'Start Time'.
* '''End Time''': The 'End Time' prevents this restore from starting a process on the cron any time on or after the 'End Time'.
* '''Priority''': Priority is either 'Low' or 'High', and helps the cron to determine which process should be run first. The restore is brought in for next processing following this process:
** Cron grabs all records that meet the following criteria:
*** Is the scheduled restore have any restores left to process?
*** Is the Current time greater than or equal to the Start Time?
*** Is the Current time less than End Time?
** All restores that satisfy the above three questions are then further processed. If any are high priority, the low priority restores are automatically removed. The remaining restores then compare their time created timestamp, and the oldest restore is then selected to be processed next.
*NOTE: All times are relative to the current server time, and are approximate.
*NOTE: Cron runs approximately every 15 minutes on a default Moodle install. This means that cron times are approximated to 15 minutes + cron approximation.
[[Image:cron_settings.png]]

=Choose a Restore File & Metadata CSV=
Restoring a course with some metadata defined really only requires one extra step. You must upload a csv file with some requuired fields. The CSV File should look like the following:

[[Image:csv.png]]

* '''shortname''': The shortname is the unique short name for the course, each entry in this field must be unique (meaning you cannot have more than one of the same shortname) or you will get an error when validating the CSV file.
* '''fullname''': The fullname is the full name of the course, it does not need to be unique.
* '''description: The description is the course's description.
* '''sitecat''': The sitecat is the Category on the site you want the course to be placed in. If you are using sub-categories, then put in the category path (Category/Sub-Category/Sub-sub Category). The sitecat must match the existing course's category or you will get an error message.
* '''startdate''': The startdate is the start date for the course. It must be in mm/dd/yyyy, yyyy/mm/dd or mm/dd/yy format.

First, follow steps 1, 2, & 3 only, then instead of clicking continue, go to the 'Choose course metadata file' section. Choose a target course where your CSV is located ('Choose File Location Course'), then click 'Choose From Selected Course'. Navigate to your csv file (or upload it then), then click the 'Choose' link next to the resource.

[[Image:choose_metadata.png]]

Now, click continue. You should see a green 'Validating...' notice at the top of the screen, then if everything is valid, you should see the following screen:

[[Image:restore_meta_validated.png]]

Click 'Continue' to go to the final step in the scheduling process.

an interface to set up the bulk creation includes identifying the zip file to restore from. an interface or a spreadsheet to upload data from with the following attributes: Course name Course description Site category Primary Facilitator ID Facilitator ID

=View Restore Schedule=
The View Restore Schedule option on the Course Management block allows the user with appropriate capabilities to view, edit, process, view error details, and reschedule a restore. To get to this page from the site home-page, click on the View Restore Schedule link in the Course Management block.

[[Image:vrs_menu.png]]

==View Restore Schedule Landing Page==
[[Image:vrs_view.png]]

==Show Active Schedules Button==

The landing page may look complicated, but it most of it is informational. The Show only Active Schedules button toggles display of the restores. This is the default, which displays completed/in-progress/failed restores. If clicked, this will display Show All Scheduled. When only the active are displayed, only the in-progress/failed restores remain visible.

==Currently Processing: Yes/No flag==

This text area notifies the user if a restore is currently processing that was triggered from this block.

==List of Restores==

Restores are listed with the most recently created restore at the top and the oldest at the bottom. However, this is not necessarily the order that these restores will be processed (see Cron Settings for more information).

==Process Next Restore Now==

This button fires the same restore process that the Moodle cron would run, but does so independently of the cron and does so immediately.
*NOTE: This feature may be disabled if a restore is currently running if the global settings are set as such.

There are two ways to run the restore process 'manually', either by using the Process Next Restore Now button, or by visiting the Moodle cron script via the url (http://yourmoodlesite/admin/cron.php). Running the cron via the url method, then refreshing the View Restore Schedule page should show the Currently Processing flag as 'Yes', if the restored class is a larger class.

[[Image:vrs_curr_yess.png]]

==Restore Actions==

The red X icon in the Actions column in the List of Restores section cancels the selected restore. It does so by setting the Remaining number of restores to 0, so the restore will no longer be in queue to be processed.

The standard Moodle Edit button allows you to modify only the cron for that restore, to allow the admin to 'reorder' restores as necessary.

[[Image:vrs_edit_restore.png]]

==Status: Failed==

If for some reason a restore fails from anywhere, the restores' Status column will be filled with a linked, red Failed link, which can be clicked for details on the error, and potential resolution.

[[Image:vrs_failed_restore.png]]
[[Image:vrs_failed_restore_details.png]]

The error shown above details missing data files (eg: files were renamed, moved, or deleted). If the files can be replaced in the same location as before, the restore can be rescheduled and successfully run again.

=Delete Multiple Courses=

[[Image:delete_courses.png]]

This feature provides an easy, searchable and sortable interface to select and delete multiple courses. You can filter courses by their parent Course Category, and further filter results with the search field, which will search the fullname of the course for a matching string.

[[Image:dmc_landing.png]]

After finding the courses you wish to completely delete, check the boxes, and select Delete from the With Selected... option box.

[[Image:dmc_select_delete.png]]

You will then see a Confirmation notice, since this will delete ALL data associated with the selected courses.

[[Image:dmc_confirmation.png]]

After confirming the courses to delete, each deleted item's status will be output, along with a green Success notification at the end of each class.
*NOTE: This process can take a long time, depending on the size and content of each of the selected courses.

[[Image:dmc_deleted_success.png]]

'''
== See also ==
'''
[[Category:Administrator]]
[[Category:Block]]

Fitxer:role mappings.png

2010-03-30T06:37:59Z

Psychoph:

Fitxer:vrs failed restore details.png

2010-03-30T06:37:52Z

Psychoph:

Fitxer:vrs failed restore.png

2010-03-30T06:37:44Z

Psychoph:

Fitxer:vrs edit restore.png

2010-03-30T06:37:36Z

Psychoph:

Fitxer:vrs curr yess.png

2010-03-30T06:37:29Z

Psychoph:

Fitxer:vrs view.png

2010-03-30T06:37:23Z

Psychoph: