This document gives a short description to each available setting in the plugin configuration. It's structured in the same order as the plugin configuration's tabs and subtabs (from left to right).
Some functions are restricted to a certain API version. The version can be found by typing https://[your-opencast-url]/api in your browser.
URL of your Opencast installation, followed by /api. E.g.: https://myopencast.com/api
Login of the user which will be used to call the API.
Note that the API user must have enough permissions to access all API nodes and to switch user roles. Therefore it should have all roles beginning with 'ROLE_API_', plus the role 'ROLE_SUDO'
Password for the above configured API user.
ID of the Workflow which will be started after uploading an event.
In older versions of Opencast, the event's publications have to be retracted before deleting an event, otherwise the publications will remain somewhere in the system. If this is the case for the configured installation, enter the ID of the retracting workflow here.
Link used for the action 'cut'. The placeholder {event_id} can be used. Default: https://[your-opencast-url.com]/admin-ng/index.html#!/events/events/{event_id}/tools/editor
If this is empty, the Publication Usage for cutting will be used to fetch the link from Opencast (see Publications)
If active, admins will have the possibility to create scheduled events via an Opencast series in ILIAS.
Warning: Scheduling events requires Opencast API v1.1.0.
Introduces a button "Opencast Studio" for users with the permission 'Upload' and/or 'Edit Videos'. This button redirects to Opencast Studio while configuring it to upload the event to the current series. Note that users will have to login in Opencast to use Opencast Studio.
Opencast Studio is integrated in Opencast versions > 8.3
Configures the Upload form to allow audio files. Note that the same workflow as for videos will be used, so this workflow has to be able to handle audio files.
This enables the usages of the plugin's integrated standalone Paella Player. Otherwise the 'Play' button will redirect to Opencast, which may require the user to login to Opencast.
In order for the player to find the video data, the 'Player' publication will have to be configured correctly (see chapter Publications).
The player can be configured to use streaming URLs. This requires a Wowza streaming server though.
Allow viewing Live Streams, optionally with an on-screen chat during the event. The publication "Live Stream" has to be configured properly for the plugin to recognize live events.
If this is active, the plugin will generate streaming urls with the given 'Wowza URL', according to this pattern:
[WowzaURL]/smil:engage-player_[EventID]_[presenter|presentation].smil/playlist.m3u8
Otherwise, the urls will be fetched from the player publication. These can be static video urls or streaming urls, depending on how Opencast is configured.
When active: the video player will not be opened in a seperate window but in a overlaying "Modal" window.
If enabled, the "Actions" dropdown of events will offer the option "Report Quality Problems". This will open an overlay where the user can describe the problem and send it to the here configured email address.
If active and a series contains one or multiple scheduled events, the toolbar will show a button "Report Date Modifications" for admins. This button opens an overlay where the admin can describe the problem and send it to the here configured email address.
Defined whether scheduled events can be edited in ILIAS.
Define what config.json should be used for the plugin's Paella Player. You can chose from the default config (located in the plugins code), an uploaded file, or a remote URL.
Note that there's a separate config for live streams and for Video on Demand, since they need different flags to be set in the config.
This is a group which must exist in Opencast. Users with the permission 'Edit Videos' will be enlisted in this group when a series is created or when the user performs the actions 'cut' or 'annotate'. This should grant these users the permission to access the Opencast video editor and annotation tool, so this group should contain enough roles to enable these tools.
A list of Opencast roles which will be added (with read and write permissions) to every event and series created by the plugin. This should not be necessary in a normal setup, if the api user has enough permissions.
User specific role in Opencast, which is automatically created for each user. Is used by the plugin to grant the user permission on a series in Opencast. This will usually be ROLE_USER_{IDENTIFIER}, where {IDENTIFIER} will be replaced with the user's identifier (external account or email).
Indicates the owner of an event. This rules doesn't have to exist in Opencast, although it will be set in Opencast. Example: ROLE_OWNER_{IDENTIFIER}
Will transform the user's identifier to all uppercase. Possibly necessary to match the user role. E.g. if the user's external account is 'jdoe', the user role will be ROLE_USER_JDOE instead of ROLE_USER_jdoe.
"End User License Agreement". Will be shown in objects in a separate tab 'Terms of Use'.
If active, users will have to accept the ToU the first time they create an event.
If this is checked when saving the config form, all users which have already accepted the ToU are reset and will have to accept it again on the next upload.
The URLs for the player, download, thumbnail and annotation tool can be signed by Opencast, in order to make them available only for a certain period of time and optionally for a certain IP address. This will only work if the url signing is configured in Opencast (see https://docs.opencast.org/develop/admin/#configuration/stream-security/).
The download links are not visible to the user, because the download is executed by the plugin. The plugin will then deliver the file to the user's browser. Therefore, the IP restriction is not available for download links.
This function will only work with a certain version of the Annotation tool (https://github.com/mliradelc/annotation-tool/tree/uzk-ilias-frontend-hash).
Sends the course reference ID, and the user, admin or a student, as a hash to the annotation tool. With that information, the tool will verify if the user is coming from ILIAS and if it is the same user as the user logged in ILIAS.
If active, links will be presigned by Opencast. This may impact the performance. Note that the above configuration is still necessary because links will still have to be signed by the plugin in certain situations.
Check if ILIAS and Opencast are using the same identity provider (e.g. Shibboleth or LDAP). This allows for more precise permission checks: if a common IdP is used, the plugin can send the username to Opencast to check for permissions, so Opencast can validate all roles possessed by this user. Otherwise, the user very likely doesn't exist in Opencast, so the plugin can only send the user-specific role for permission checks. This is currently only used by the PageComponent plugin.
Defines which user attribute will be used to map an ILIAS user to an Opencast user (or user role, respectively). If your ILIAS and Opencast are both connected to the same Identity Provider (e.g. an LDAP server) this should be the 'External-ID', since ILIAS stores the ID coming from the IdP in this attribute. If you want to use 'Email', make sure that users in ILIAS are not allowed to change their own email address.
Improves the performance by temporarily storing event metadata.
Level of detail for log entries. The log can be found in ILIAS' external data directory (same place where the ilias.log is found) and is titled 'curl.log'.
If enabled, the upload will be executed via Ingest Nodes instead of the external API. This improves the load distribution on the Opencast server when uploading multiple files simultaneously. Note that the REST endpoint /ingest has to be available for the ILIAS server and the API user.
This view allows you to configure workflow definitions with optional workflow parameters. If any workflows are configured, the "Actions" menu of events will show a new option "Publish" which will open an overlay through which one of the configured workflows can be started for that event.
A workflow configuration requires the following fields:
- ID: a valid workflow definition ID
- Title: will be used in the overlay
- Parameters: a comma-separated list of workflow parameters. These parameters will be set to 'true' when starting the workflow.
Workflow Parameter are information which are passed to Opencast through the variable 'processing' when uploading or scheduling an event. Note that the parameters must match the given workflow definition (Settings -> Events -> Processing Workflow ID). Clicking the button "Load Parameters via API" will try to load the parameters automatically - however this will only work if the workflow definition in Opencast has configured a configuration panel.
The default parameters match the default workflow 'schedule-and-upload'.
If enabled, the configuration of parameters will also be available in the settings of an Opencast series. Otherwise the plugin settings will be effective globally.
After an event is created, an Opencast workflow will process the event and create certain publications. These publications contain the links required by the plugin to enable essential functionalities, like the video player, thumbnails or download links.
Therefore, for each of these functionalities, a publication has to be configured. Each publication is identified by a 'channel' and may contain media and attachments. Media and attachments can be identified by a flavor or tags.
So e.g. for the thumbnails to work, a publication of the usage 'thumbnail' has to be configured. The channel and flavor/tags must identify the correct publication and attachments to find the url of the thumbnails. Here's a list with a short description of what each publication usage is used for:
- annotate: renders button with a link to the Opencast annotation tool.
- cutting: fetches the url used for the action 'Cut'. Can be replaced by the configuration at Settings -> Events -> Link to Opencast editor.
- download: renders a button to download an event.
- download_fallback: fallback for the download publication.
- live_event: if this publication is found for an event, it will be considered a live event (only necessary if Live Streaming is active).
- player: renders the button to start the player. If the internal video player is active, this configuration should be of the type "Media", otherwise "Publication itself".
- segments: renders the segments for the paella player (only used for the internal video player).
- preview: renders the preview thumbnails for the paella player (only used for the internal video player).
- thumbnail: renders the thumbnails
- thumbnail_fallback/thumbnail_fallback_2: fallbacks for the thumbnails
- video_portal: renders a link to the external video portal (see chapter Video Portal).
- unprotected_link: renders an unprotected link in the event list.
The default configuration (after a fresh install, or at /configuration/default_config.xml) contains publication configurations for all essential functions, that is the player, download, and thumbnails. Additionally, there are default values for the publications player, download, thumbnails, segments and preview, so these publications will use default values, even if they are not configured in the plugin configuration.
Note that the default configuration only works with an out-of-the-box Opencast. If there are different workflows which affect the publications, this configuration will have to be adjusted accordingly.
The plugin uses a configurable selection of Opencast's Metadata Catalogue. Note the subtabs for switching between event's and series' metadata configuration.
The configured Metadata fields will be visible in:
- the forms for creating or editing a series/an ILIAS object (series metadata)
- the forms for creating or editing an event (event metadata)
- the table containing events (event metadata)
A metadata field can be configured as:
- visible for: either everyone or only for admins
- read-only: field can not be edited in a form. Note that some fields are defined to be read-only by Opencast, so they can't be configured editable in ILIAS.
- required: field is required in a form. Note that some fields are defined to be read-only by Opencast, so they can't be configured editable in ILIAS.
- prefilled: field is prefilled when creating an event or a series. Options are prefilled with current user's username or title of the course.
Some institutions run an external video portal to which Opencast events will be published, based on the permissions set for events. This configuration allows to create permission templates, which can be chosen when creating a new series.
Will be shown when creating a new series and in the settings tab of an existing series.
Will be displayed in the settings and info tab of a series. {series_id} can be used as a placeholder. E.g.: https://myopencast-tube.com/cast/channels/{series_id}
The created templates can be chosen from when creating or editing a series. If chosen, the configured role with the given permissions and actions will be set on the series. The roles of the residual templates will be removed.
Import or export the entire plugin configuration.
An overview over all messages sent with the functions "Report Quality Problem" and "Report Date Modification".