{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The Zoom Meeting Virtualmeeting plugin allows trainers to create an ad hoc room that will automatically generate a scheduled Zoom Meeting for any seminar session with which it is associated. The start meeting and join meeting URLs are available to admins and trainers at any time. The join meeting URL is revealed to booked learners beginning 15 minutes before the session starts.","type":"text"}]},{"type":"paragraph","content":[{"text":"For more information on working with virtual rooms, see our ","type":"text"},{"text":"product documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://help.totaralearning.com/display/TH13/Working+with+virtual+rooms"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"To enable the plugin, you will need to ","type":"text"},{"text":"create an OAuth app in Zoom Marketplace","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":", and set the App ID and Client Secret in the Zoom Virtualmeeting plugin settings.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Zoom API Limitations","type":"text"}]},{"type":"paragraph","content":[{"text":"There are a few limitations to the Zoom API and, consequently, to the Zoom Meeting plugin:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Create Meeting API can be used a maximum of 100 times per user in a 24 hour period. This means that a user can only assign a Zoom virtual meeting room to 100 seminar sessions per day, before those assignments will start to fail virtual meeting creation.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Update Meeting API can be used a maximum of 100 times per user in a 24 hour period. This means that a user can only edit 100 seminar sessions with a Zoom virtual meeting room assigned per day, before those sessions will start to fail virtual meeting update.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Private Zoom apps can only be used by other users in the same account. If your use case requires trainers to schedule Zoom Meetings using a different company account, you will either need to publish your app to the Zoom Marketplace, or start the publishing process and request access for one or more specific accounts.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Capacity of Zoom rooms is limited by user licence type. Pro accounts are limited to 100 participants.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Please note that if virtual meeting creation/update fails due to rate limits the user can wait 24 hours, edit the seminar event, and click ","type":"text"},{"text":"Save changes","type":"text","marks":[{"type":"strong"}]},{"text":" (without making any changes) to retry any pending virtual meeting operations.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Manual meeting setup","type":"text"}]},{"type":"paragraph","content":[{"text":"Event creation","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a meeting in Zoom. Specify the event date and time, and copy the meeting URL.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create an event in a Totara Seminar activity, ensuring the same date and time (including time zone) is used as the Zoom meeting you created.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a custom virtual room link to an ad-hoc room and paste the link.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Event updating","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"If an event needs to be updated, this will need to be updated in Totara and on your Zoom account:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to your Zoom account and update the meeting to the new desired date and time.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to Totara and update the event to the new desired date and time.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Event deletion","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"If an event needs to be deleted, this will need to be updated in Totara and on your Zoom account:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to Zoom and delete the meeting.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to Totara and cancel the event.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Requirements","type":"text"}]},{"type":"paragraph","content":[{"text":"To set up the Zoom Meeting Virtualmeeting plugin you will need to meet the following requirements:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A Zoom Pro or Business licence","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A Zoom admin account, or a Zoom user account with permission to create apps in the marketplace (this is provided by the \"","type":"text"},{"text":"Zoom for developers","type":"text","marks":[{"type":"strong"}]},{"text":"\" role)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Your Totara site MUST be available via https:// URL","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creating the app","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to ","type":"text"},{"text":"Zoom Marketplace","type":"text","marks":[{"type":"link","attrs":{"href":"https://marketplace.zoom.us/"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Develop","type":"text","marks":[{"type":"strong"}]},{"text":" menu, select ","type":"text"},{"text":"Build App","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"General App","type":"text","marks":[{"type":"strong"}]},{"text":" (click ","type":"text"},{"text":"Create","type":"text","marks":[{"type":"strong"}]},{"text":"). ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The app is given a generic name by default, which can be changed by clicking the pencil icon next to the name in the top-left corner. We recommend something clear, e.g. Totara virtual meeting integration","type":"text"},{"text":".","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you are not an admin user, the app type will be ","type":"text"},{"text":"User-managed app","type":"text","marks":[{"type":"strong"}]},{"text":" by default. Otherwise, you will need to select this option so that other members of your organisation can make meetings with this plugin.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In another tab, log in to your Totara site.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to the virtual meeting plugin setting under ","type":"text"},{"text":"Quick-access menu > Plugins > Virtual meetings > Zoom Meeting","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the ","type":"text"},{"text":"Redirect URL for OAuth","type":"text","marks":[{"type":"strong"}]},{"text":" from the top of the settings page. It should look like: https://your.site.name/integrations/virtualmeeting/auth_callback.php/zoom","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Zoom Marketplace","type":"text","marks":[{"type":"strong"}]},{"text":" tab, paste the URL into the ","type":"text"},{"text":"OAuth Redirect URL","type":"text","marks":[{"type":"strong"}]},{"text":" for the OAuth field.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check that your site's URL automatically appears in the ","type":"text"},{"text":"OAuth Allow Lists","type":"text","marks":[{"type":"strong"}]},{"text":" field.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Continue","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Surface","type":"text","marks":[{"type":"strong"}]},{"text":" blade, select the ","type":"text"},{"text":"Meetings","type":"text","marks":[{"type":"strong"}]},{"text":" option, and click ","type":"text"},{"text":"Continue","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Scopes","type":"text","marks":[{"type":"strong"}]},{"text":" blade, open the ","type":"text"},{"text":"Add Scopes","type":"text","marks":[{"type":"strong"}]},{"text":" menu and select:","type":"text"},{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"User > View all user information:","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"a. ","type":"text"},{"text":"View a user's collaboration device","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"b. ","type":"text"},{"text":"Verify a user's email","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"c. ","type":"text"},{"text":"View a user's permissions","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"d. ","type":"text"},{"text":"Verify a user's personal meeting room","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"e. ","type":"text"},{"text":"View a user's token","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"f.","type":"text"},{"text":" View a user","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Meeting > View all user meeting summaries:","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"a.","type":"text"},{"text":" View a meeting's summary","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Meeting > View all user meetings:","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"a.","type":"text"},{"text":" View a meeting's invitation","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"b.","type":"text"},{"text":" View a user's meetings","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"c. ","type":"text"},{"text":"View a meeting","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Meeting > View an manage your meetings:","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"a. Delete a meeting","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"b. Update a meeting","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"c. Create a meeting for a user","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"d. Add a open app to a meeting","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Done","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optionally, ","type":"text"},{"text":"add a description","type":"text","marks":[{"type":"strong"}]},{"text":" to the ","type":"text"},{"text":"Scope Description ","type":"text","marks":[{"type":"strong"}]},{"text":"box, e.g. 'Used to create and update Zoom meetings on your behalf'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Continue","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If there are no warnings on the ","type":"text"},{"text":"Local Test","type":"text","marks":[{"type":"strong"}]},{"text":" blade, your app is ready to use.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the ","type":"text"},{"text":"Client ID ","type":"text","marks":[{"type":"strong"}]},{"text":"from the ","type":"text"},{"text":"App Credentials","type":"text","marks":[{"type":"strong"}]},{"text":" widget at the top of the menu.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Switch to Totara.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Paste the value into ","type":"text"},{"text":"Client ID","type":"text","marks":[{"type":"strong"}]},{"text":" field of the Totara Zoom Meeting settings.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Switch back to Zoom.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the ","type":"text"},{"text":"Client Secret ","type":"text","marks":[{"type":"strong"}]},{"text":"from the ","type":"text"},{"text":"App Credentials","type":"text","marks":[{"type":"strong"}]},{"text":" widget at the top of the menu.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Switch to Totara.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Paste the value into the ","type":"text"},{"text":"Client secret","type":"text","marks":[{"type":"strong"}]},{"text":" field of the Totara Zoom Meeting settings.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Save changes","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Testing the integration setup in Totara Learn","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a course with a seminar activity.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Add event","type":"text","marks":[{"type":"strong"}]},{"text":" or edit an existing event.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Select room","type":"text","marks":[{"type":"strong"}]},{"text":" on a session.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Switch to the ","type":"text"},{"text":"Create","type":"text","marks":[{"type":"strong"}]},{"text":" tab in the modal.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the room ","type":"text"},{"text":"Name","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"Capacity","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the ","type":"text"},{"text":"Add virtual room link","type":"text","marks":[{"type":"strong"}]},{"text":" dropdown.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"Zoom Meeting","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Connect","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A popup will open and one of the following things may happen:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You will be asked to log in to your Zoom account","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your browser is already logged in to Zoom in another tab or window, you will skip to the next step","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Note that if your browser is logged in to a Zoom account other than the one you wish to use, you will need to log out first.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You may be asked to approve the permissions set.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If everything works correctly, the popup will automatically close, and you will see your Zoom user name and email address next to the ","type":"text"},{"text":"Connect","type":"text","marks":[{"type":"strong"}]},{"text":" button.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you want to use a different account, open ","type":"text"},{"text":"https://zoom.us","type":"text","marks":[{"type":"link","attrs":{"href":"https://zoom.us"}}]},{"text":" in another browser tab and log out, then switch back to Totara and click the ","type":"text"},{"text":"Connect","type":"text","marks":[{"type":"strong"}]},{"text":" button again.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"OK","type":"text","marks":[{"type":"strong"}]},{"text":" to close the modal.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Save changes","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wait for a minute (virtual meeting room creation happens in the background via adhoc task, so this may take a few minutes depending on your site's cron settings).","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

For testing purposes, disabling the Cron execution via command line only admin setting allows you to run cron from the following URL: https://(your.totara.site)/admin/cron.php

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"For testing purposes, disabling the ","type":"text"},{"text":"Cron execution via command line only","type":"text","marks":[{"type":"strong"}]},{"text":" admin setting allows you to run cron from the following URL: ","type":"text"},{"text":"https://(your.totara.site)/admin/cron.php","type":"text","marks":[{"type":"strong"}]}]}]}],"version":1},"reason":"An info macro in a list item can't be created or edited in the new editor."}}}]},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If virtual meeting creation fails, you will receive a notification.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the room name to go to the room detail page.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If everything works correctly, you should see a card in the upper right with a ","type":"text"},{"text":"Go to Room","type":"text","marks":[{"type":"strong"}]},{"text":" button.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Host meeting","type":"text","marks":[{"type":"strong"}]},{"text":" to start the meeting as the host, or ","type":"text"},{"text":"Join meeting","type":"text","marks":[{"type":"strong"}]},{"text":" to join as a participant.","type":"text"}]}]}]}],"version":1}