Collab2 APP
Introduction
Need more information? Want a demo?
Contact us and we will get in touch with you schedule a demo.
The Collab2 APP allows you to perform various scheduled processes on Class Collaborate recordings, such as transferring them to an external repository or deleting them from Class Collaborate.
Access and Overview of the Application
Access to Collab2
Access is via the application URL by entering your username and password. The application is currently available in Spanish and English, and you can switch the language from the selector at the top right of the screen.
General View of the Application
The application presents three sections to the user: Recordings, Summary, and Processes. In the Recordings tab, it is possible to filter the recordings by several fields:
- Integration key.
- Course.
- Session.
- Session date.
- Status in Collaborate.
- Status in the repository.
From this filter interface, you can either create a process or perform a search for recordings.
The recordings view contains a series of customizable fields, allowing you to see the status of the recordings both in Class Collaborate and in the repository.
The Summary view provides information on the number of recordings and the amount of storage used.
Finally, the Processes tab allows you to view the created processes along with the following functionality:
-
Create a new process by clicking on the + button in the upper right corner.
-
Action menu in each existing process, which allows:
- Delete the process, for which user confirmation will be required.
- Check the execution history.
- Edit the process configuration.
- Run the process directly, with prior confirmation.
The process execution history presents a log indicating the process executions, the status, the entities processed, and any detected errors.
Creating Processes
Access to process creation can be done either from the filters section in the Recordings tab or by clicking on the + button in the top right corner of the processes tab.
To create a process from the corresponding form, it is necessary to provide a description and select the type of process. Depending on the type selected, you will need to complete a different configuration.
Similarly, the active/inactive selector allows you to modify the process's availability. Inactive processes will not respect the CRON schedule but can be triggered manually.
Types of Processes
The "Sync from Collaborate" process syncs the recordings between Class Collaborate and the Collab2 application. You must choose the number of recordings to sync per process execution.
The Upload to Repository process directly uploads Class Collaborate recordings to the institutional recordings repository. This process includes selectors for:
- Delete the recordings from Class Collaborate upon completing the transfer to the repository.
- Upload chats from the recordings to the repository.
- Upload captions to the repository.
The Delete from Collaborate process deletes recordings from the Class Collaborate environment. You can choose to delete only the recordings previously uploaded to the institutional repository.
The Get LMS Objects process retrieves LMS entities (nodes and courses) associated with the recordings. This association allows other processes linked to these entities to be carried out.
The Process LMS Objects process retrieves LMS entities (nodes and courses) associated with the recordings from an external data source. This process is considered deprecated.
The Sync Attendance from Collaborate process allows synchronizing attendance information between Class Collaborate and the institutional repository.
The Sync from Repository process syncs recordings between the institutional repository and the Collab2 application. There is an option to verify the integrity of the process.
The Delete from Repository process deletes recordings from the institutional repository.
Scheduling Process Execution
The next step is to define how the process will be executed, allowing the following execution modes:
- Scheduled Execution. The process will run periodically according to a CRON configuration.
- Dependent Execution. The process will run after another preceding process is completed.
- One-Time Execution. The process will run immediately.
In Scheduled Execution mode, the CRON expression can be entered manually or through the visual editor available in the application.
In Dependent Execution mode, it is necessary to select a "parent" process. Once this process is completed, the process configured with this option will be triggered.
Filters
Depending on the type of process selected, a section of filters may appear at the bottom of the screen. These filters allow narrowing down which recordings the processes will be applied to. The filters are:
The integration key filter allows selecting recordings belonging to a deployment.
The Specific Courses filter allows searching for and selecting courses in the LMS whose recordings will be processed.
The Courses containing filter allows searching by one or more terms in the fields name, id, and course description. The search results are the courses on which the process will be executed.
The Session filter allows searching for specific Class Collaborate sessions.
The Creation Date (From) filter allows selecting recordings created from the selected date. The date can be manually entered or selected from a calendar.
The Creation Date (To) filter allows selecting recordings created up to the selected date. The date can be manually entered or selected from a calendar.
The Last Viewed Date (From) filter allows selecting recordings with a last viewed date starting from the selected date. The date can be manually entered or selected from a calendar.
The Last Viewed Date (To) filter allows selecting recordings with a last viewed date up to the selected date. The date can be manually entered or selected from a calendar.
The Recording Age filter allows selecting recordings with a certain age expressed in days.
Once the corresponding filters are selected, you will need to click the save button for the process to be saved with the established configuration.
Help us improve! Do you have suggestions or improvements for this documentation? Write to us!