Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • how to set up your Zoom account
  • how to integrate Zoom into CAE LearningSpace
  • how to set up and manage virtual rooms in CAE LearningSpace

The guide will also recommend the most fitting Zoom subscription plan to choose for OSCE Teleconferencing purposes that can also be adjusted to the needs of your organization.

Before starting the setup process, make sure you have as many email addresses ready as the number of virtual rooms you would like to configure.

Info
titleRecommendation: Use Email Aliases

Ask your IT support to create email aliases—additional addresses—to your own email address with names like med.osce.virtualroom1@uni.edu, med.osce.virtualroom2@uni.edu, ect.
Set up as many email aliases as many virtual OSCE rooms you plan to configure.
Use your own email address as the primary address of your Zoom account, and then the email aliases to create users under your Zoom account.

The number of virtual rooms you can configure for OSCE  Teleconferencing purposes depends on your Zoom subscription plan. Aside from our recommendation, you can also check the subscription plans at Zoom’s Plans & Pricing page: https://zoom.us/pricing

Create Your Zoom Owner Account

  1. Visit zoom.us and create a new owner account by signing up.

    Note
    titleImportant

    Use the email sign-up option.


  2. Provide the email address of your Zoom account.
    Image Added

    Info
    titlePrimary Email Address

    This email address will serve as the primary address of your Zoom account.
    Virtual rooms will be organized under the owner account registered with this primary email address.

    Anyone who has access to this email account, and consequently the Zoom owner account can:


    Section
    • upgrade to a new plan (change the number of hosts)
    • see and copy the API key and secret
    • manage the type of each user in Zoom: Licensed or Basic type.


  3. Click Sign Up. You will be sent an activation email to your account email address.

  4. Go to Check your mailbox to verify your email: click
    1. Click Activate Account,
    2. or paste the provided URL
    provided in the email
    1. into your browser. 
  5. You will be redirected to Zoom to continue your sign-up process.
    Under Account Info, you need to provide your name and set a password.
  6. Your password must be at least 8 characters long, containing at least one letter, one number, and both upper and lower case letters.
    The password cannot contain only one character or consecutive characters.
  7. Image Added
  8. Click Continue.
      Optional In case you would like to share the account ownership with other colleagues, invite them on the Invite Colleagues page. The will receive an activation email to verify their email addresses.
      Otherwise, click Skip this step
      1. Invite Colleagues: We recommend to Skip this step.
        By sending out this invitation, new separate primary accounts will be created which would require their own subscription plan updates. 

        Tip

        With our CAE LearningSpace integration solution, you can manage every virtual room your training program needs from a single Zoom account.


      2. Optional Launch a test meeting.
        Click on Go to My Account if you do not want to start a test meeting right now.
    1. You will be redirected to your profile where you can find your account number, personal meeting ID, account information and meeting capacity.

      Image Added

      Note
      titleImportant

      Upon registration, you will have a Basic account that you will need to upgrade in order to register your virtual rooms as users under your Zoom account.


      Info

      Before upgrading your Zoom account, please continue with the API Configuration part.


    API Configuration

    In Zoom

    Before upgrading your account, you need to obtain the API key and

    ...

    secret from your Zoom account to

    ...

    have CAE LearningSpace communicate with Zoom.

    Obtaining the API key and secret is made entirely user-friendly in Zoom and CAE LearningSpace likewise:

    1. Stay on your Profile, and in the side menu on the left, click on Advanced to display further options.
    2. Click on App Marketplace.
      Image Added
    3. On the Zoom App Marketplace page go to the Develop drop-down on the left and open.
    4. Click on Build App.
      Image Added
    5. On the Choose your app type page, find JWT.

      Info

      JWT is a tool that generates the API Key & Secret you need for integrating Zoom services into CAE LearningSpace.


    6. Click Create to generate your API Key & Secret.
      Image Added
    7. A window pops up where you need to name the new JWT application you are creating.

      Info

      In the example, we are simply naming the new application after CAE LearningSpace, but you can give any name to the app you prefer.
      The name of the app does not affect the API configuration in any way.

      Image Added

    8. Click Create on the pop-up to continue.
    9. You will be directed to the Information page of your new JWT application where you need to administer further details such as provide the name of your organization and the Developer Contact Information.
      Image Added

      Tip

      Developer Contact Information can be the same as the account owner’s information. 


    10. Once your details are P (tick) Saved, click Continue.
    11. You will find your API Key & Secret on the App Credentials page.
      Image Added
    12. Copy the API Key and the API Secret. Use the Copy option at API Secret if you do not want to display it.

      Info

      Your generated API Key and Secret are automatically saved. You can view this page any time by repeating the steps from step # 3 (selecting App Marketplace).

      Only, the JWT tab will look slightly different: 

      Click View here to access your API Key & Secret:

      Image Added


    In CAE LearningSpace

    Now that we have the app credentials, we can enable the Zoom Telemedicine module in CAE LearnigSpace.

    1. Log into CAE LearningSpace (with Administrator privilege).
    2. Go to System.
    3. Select the Security tab.
      You will find the new Telemedicine Module at the bottom of the page right under the system password.
    4. Switch on the new module to display Zoom settings.
    5. Paste the API key and API secret in the corresponding fields.
    6. Click on Save & Test Connection to connect to Zoom. 
      Image Added
    7. CAE LearningSpace informs you about the successful or failed connection at the top of the page.

    ...

    You can check your subscription status at the User Type field on your profile:

    Image Modified

    A Basic subscription does not

    • support Zoom service integration into other applications
    • contain cloud recording
    • and  and restricts the duration of meetings to 40 minutes if there are more than three total participants at the meeting.
    Note

    In order to use Zoom services within CAE LearningSpace after completing the API setup as described in the previous part, you need to upgrade your account and include as many hosts in your subscription plan as many virtual rooms you would like to configure in CAE LearningSpace.

    • Upgrade your account to Pro if you plan to configure 9 virtual rooms or less;
    • Upgrade your account to Business if you want to configure 10 or more virtual rooms.
    Info

    Virtual room configuration in CAE LearningSpace will be explained in

    ...

    the next section.

    To upgrade your Zoom account:

    1. Click on Upgrade in the User Type field next to your current subscription status.
      You will be redirected to the Current Plans tab inside Billing
    2. Click on Upgrade Account.
      Image Added
      You will be redirected to the Plans & Pricing page.
    3. Choose one of the recommended plans by clicking Buy Now.
      1. Select Pro if you plan to configure 9 virtual rooms or less;
      2. Select Business if you want to configure 10 or more virtual rooms.
    4. Select the number of hosts you want to purchase.

      Info

      Zoom automatically calculates the monthly and annual fees afterwards.

      Image Added

      Info
      titleOptional Cloud Storage Purchase

      Zoom offers 1 GB/host cloud storage starting from Pro accounts, but in our setting, it is only used as temporary storage.

      OSCE teleconference meetings can be moved/downloaded to the Video Review module in CAE LearningSpace once a meeting is processed.

      However, if you would like to add some extra storage because you find 1 GB insufficient, scroll down to the Available Add-ons and open Cloud Recording. 
      We recommend purchasing the extra 100 GB/month solution:

      Image Added


    5. After selecting the billing schedule (and optional extra cloud storage), scroll down to the bottom of the page and click Continue.
    6. On the Payment tab, provide the
      1. Billing Contact information

    ...

      1. Info

        Beside basic details

    ...

      1. , the total employee count of your organization is required to continue.


      2. Payment Method, and
      3. Credit/debit card information
    1. Once you are finished, click Upgrade Now. You will be presented with an Order Summary.
    2. Click Confirm to complete your purchase. Zoom will confirm that your account has been upgraded successfully.

    Virtual Room Configuration

    ...