Enable CMS and register with YuJa
YuJa CMS integration for Pearl devices
Applies to: Pearl-2, Pearl Mini, Pearl Nano, Pearl Nexus, except where a section states otherwise. Device-specific behavior and limitations are noted in each section.
Applies to: Pearl-2, Pearl Mini, Pearl Nano, Pearl Nexus.
Pearl device hardware encoders integrate directly with YuJa. Once paired, Pearl can access your YuJa calendar to automatically start and stop recordings or streams at scheduled times. Pearl device automatically pushes event recordings to YuJa, minimizing administration time and ensuring your content makes it to the right place.
Pearl devices are fully integrated with YuJa for a seamless video recording and webcasting experience. After your Pearl device is registered, it appears as a third-party device in YuJa's device list and can be selected for scheduled recordings and webcasts. Registering a Pearl device with YuJa only needs to be done once.
To register your Pearl device with YuJa:
Log in to the Admin panel as admin. Click CMS in the Configuration panel.
Select YuJa in the Choose CMS dropdown. Click Apply.
When integrating YuJa with Pearl device you'll need an authentication token. In YuJa this is also called an API Token. For information on finding the API Token in YuJa, contact your YuJa administrator.
When generating an API token, ensure that it has at least the permissions listed below under Minimum YuJa API token permissions, or the integration will not work correctly.
Enter the following information into the YuJa settings section of the page:
YuJa Service URL: This is your organization's unique URL for YuJa. It will look like this:
https://your-organization.yuja.com/
For more information on your YuJa Service URL, contact your YuJa administrator.
Authentication token: This is a randomly generated series of numbers and letters provided by YuJa that is mentioned in the previous step. In YuJa it is called an API Token. Copy and paste an API Token in here.
User ID Type: Select Username
User ID: Enter your YuJa user name.
Device name: Label your Pearl device something that will make sense when you (and others) read it in YuJa. For example, "Biology Lab 1" or "Classroom 237".
Click Apply. If the information was entered successfully, the Status will update to Registered.
Once your Pearl device is registered with YuJa, YuJa will recognize your Pearl device and it will appear in the YuJa list of devices.
To deregister your Pearl device from YuJa, click Deregister device in the YuJa settings section.
Minimum YuJa API token permissions
The API token used for the Pearl integration needs at least the permissions below. If the integration reports permission issues, grant all permissions.
User Object Model: Retrieve All Users / Add a User; Retrieve / Update / Delete a Single User; Retrieve all Groups a User is Enrolled in; Retrieve Group Names By User.
Group Object Model: Retrieve / Create a Group for the Organization; Update / Delete / Retrieve a Single Group; Retrieve Group Details; Add Group Members.
Analytic Object Report Model: no permissions required.
Course Object Model: Retrieve Course Details.
Device Object Model: Retrieve / Update Devices; Register / Delete Device; Retrieve All Schedules for a Device; Create / Delete / Update Sessions; Create / Retrieve Capture Profiles; Start / Stop Recording Sessions; Update / Delete a Hub Profile; Play / Pause Recording Sessions; Retrieve Audio / Image and URLs; Pause / Resume Live Stream Playback; Extend / Stop Third-Party Device Session; Get / Delete Schedules; Update / Delete Third-Party Profiles; Return YuJa Profile ID Based on External ID; Other.
Audit Log Object Model: no permissions required.
User Group Object Model: no permissions required.
Media Object Model: Upload Video Details; Generate Link to Upload Recordings; Start Video Processing for S3 URLs; Add Multi-Stream Video.