Miris Manager User Manual
This documentation describes the different functionalities of the Miris Manager.
Miris Manager was called Campus Manager before.
The purpose of Miris Manager is to control the recorders.
This document is also available in French.
Table of contents
1. Logging into the Miris Manager
When you reach the Miris Manager platform for the first time you’ll be asked for an authentication. You should have received credentials by mail before your first login on the platform. If you didn’t, please click on the “Forgotten password” link.
You can either contact the email@example.com email address to get an access.
Type your credentials and log into the platform.
2. User accounts
2.1. MY ACCOUNT
To view your account details you need to click on your login at the top of the screen.
Here you’ll find a summary of your main information. You can change your password and your timezone if needed.
The software API key is used for third party software integration, like Calendar API usage (see Calendar API section (5.2)).
The “Email notifications” tab is used to receive different warnings and alerts emails. Here you choose the language and the type of notifications you’ll receive when setting your account.
2.2 CREATING ACCOUNTS
If your user account is entitled to manage user accounts (administrator), go to “Admin > User accounts” to add or delete accounts on the Miris Manager. You’ll find a list of existing users and in the top right corner there is a button to create a New user.
You need to fill in all the fields (Username, First name, Last name, Email address and Password) to create a new user account.
Once the user is created you can define permissions.
To allow a new user to create new accounts using its own account you can check the “Can manage users” checkbox.
If you want to allow the account to be able to control all the systems of the Miris Manager you just need to check the “Can control all systems” checkbox instead of adding each system one by one in the “Account settings” menu.
The second part of the “User management” tab is the “List of existing accounts”
You’ll find a list of all the accounts created on this Miris Manager, their joining dates and last login, the systems they can control and if they are active or not.
If you need to delete an account, go to its account settings and click the “Delete account” button on the top right corner.
To edit an account click on the pencil icon. You’ll reach the “Account settings” menu:
In this menu you’ll find the same settings you found in the previous menu plus the assigned systems. You need to add the stations one by one if you don’t want to allow this user to remote control all the systems.
2.3. LDAP SUPPORT
You’ll find here a dedicated documentation about how to enable LDAP support on Miris Manager.
3. Fleet supervision
Once you’re logged in, the first screen you’ll see is the “Fleet” screen. Here are listed all your UbiCast stations; note that the screenshots you see here are updated automatically, letting you see a live overview of all the systems.
The machines listed here are machines you can access and control remotely. Basically you’ll see their serial number (and name if you personalised it) and if they are online or not (Online or Offline).
When a machine is offline it is highlighted in red.
And when it is online the highlight is green.
You can edit the way the machines are shown by clicking on the “Display settings” right under the “Documentation tab”.
You’ll reach this menu:
This menu allows you to change:
- Display mode: you can choose between blocks or lines. Choosing the “blocks” mode allows you to see thumbnails of the machines with a live preview. This display mode is not very detailed since you’ll have partial informations about your machines.
If you need more detailed informations on your fleet you should prefer the “lines” view. In addition of the “block” view it allows you to see the “Last status update”, the “Remaining space” and a direct access to the error or warning messages recorded by the stations.
- Filters: you can filter your stations by status (Online or not) or by software version
Depending if you use the “Blocks” or “Lines” view the end of the menu is slightly different:
- Sorting: you can choose to sort the machines by hostname, by name or by statut (online or not).
-Block settings: the default setting is 4 machines per line and you can change between 1 and 9. Selecting one machine per line will allow you to see very big preview of the machines (if you need to control what is recorded by example) and 9 machines per line only small thumbnails.
- Display information on mouse hover: when you’ll hover the machines preview it will display different informations (see below).
- Columns to display: here you can add or remove different columns for the “Display in lines” mode. You have ten columns available (see above).
You can sort the fleet by column.
Now you can click on one of the online machines of your fleet to get remote control on it.
4. Remote control
In this example we want to control the n10 which is online. You’ll reach the “Graphical control” tab by default.
4.1. GRAPHICAL REMOTE CONTROL
You’ll see a summary of the system information of the machine you are controlling (software version, last known status, remaining space, last status update, IP address and the end of support date).
The machine is online as you can see in the screen capture (means visible and controllable) and the Yes mention in the “Online?” column. You can control the machine and use it in the same way that the physical station but you experience a little delay because the remote control is based on screen capture (for easycast capture systems only : Miris Capture systems are not based on screenshots).
All the functionality available physically are available remotely.
In addition to the full remote control of the machine you can take a screenshot of the station interface. You can reach the lastest capture by clicking on the “Link to the latest capture” link. It will open a new browser tab showing a screenshot of the machine. It can be really useful when you contact the support team in order to help them diagnose your problem. Under this link you can find a text field used to send text directly in the machine. You should use it to avoid typing long passwords or API keys using the graphical keyboard of the machine.
4.2. REMOTE COMMANDS
The “Commands” tab is used to perform basic maintenance operations remotely. In the “System commands” column you can ping the machine, shutdown or reboot the system, run a maintenance and wake your station using the network (Wake on lan documentation).
The “Recording controls” column is used to launch direct commands on the station like “start recording”, “stop recording” or “refresh profiles list” (which you should use to sync the list of profiles shown in the commands scheduling after creating a new profile in the system).
The last column of the “Commands” tab is used to restart the station’s software and upgrade it. For information regarding how to keep your recorder fleet up-to-date please refer to this documentation.
The “Planned commands” tab is showing you the same calendar that you saw in the “Calendar” tab at the top of the Miris Manager page but only shows the commands planned for this particular machine. For more details on planned commands please refer to this part or follow this documentation.
The last tab of the remote control page is the “Messages” page. It logs all the warnings and errors encountered by the station. Alert messages are using triangle with an exclamation point insideErrors are using a circle with a cross inside. You can archive those errors and eventually delete the archived messages.
4.5. UPDATING THE SYSTEM
In the top part of the remote control window you’ll find different informations:
the update reminder which allows you to upgrade your system every time a new update is available and to obtain the changelog in order to track the changes in each new version of the software. You can change the language of the changelog, download it or view it in an html window.
To update your station you can choose to click on the yellow arrow on the top right of the screen (easycast logo) or to use the “Click to upgrade system” button on the remote control screen.
5. Scheduling actions
5.1. USING THE CALENDAR UI
When you select the “Calendar” tab you’ll land on this screen:
The “Calendar” tab allows you to plan recordings remotely in a particular time frame. The current day is colored yellow.
You need to select the moment of the day you want to execute your command. Then a menu will pop up:
You need to set a starting and an ending date for your event or you can choose to select the “All day” checkbox to plan the event for the whole day (24h). Once done you can repeat this choice daily, weekly, on picked weekday, bi-weekly, monthly or yearly.
Then you need to choose the system you want to use and the command you want to execute.
- Record: it will launch a record and automatically publish according to the profile configuration (e.g. on MediaServer if the post-recording settings in the profile are set this way).
- Publish: the station will publish pending recorded media (you need to have setup the publishing only to happen at specific time slots, see this doc).
- Upgrade: it allows you to remotely plan the upgrade of the system
- Wake on Lan: the station will wake up at a defined hour with a network command
- Shutdown: if you want to shut down the station at a defined moment
- Note: can be used to take notes in the calendar (like a planned maintenance operation, TODO, ...)
If you want to plan a recording, once you’ve set the day, the time, the frequency and the record command you’ll need to choose the profile to use. We suggest that you choose the “Video Camera and Computer” profile. You can decide to put a live stream on by checking the “Live streaming” checkbox.
After having completed the “Title” and the “Speaker” (with the email or id to send it notifications) fields you’ll need to choose the channel inside which you want to publish. You don’t need to add a “Course Id” if you choose a “Channel”.
Note that in order to palliate the startup delay of the encoders, the actual command execution is exactly 1 minute before the actual planned time.
In the example below we planned two recordings in the week.
We set them for monday and friday between 5am and 6am. The command is “Record” so the machine will record and publish on the channel you chose after recording.
You can choose to display just one machine or all of them by using the “Systems to display” menu over the table.
If you want to display a different view than the default weekly one you can choose between “month”, “week” or “day”.
5.2. CALENDAR API
You can access the Calendar API documentation by clicking on the “About” link at the bottom of the page. This enables you to programmatically schedule actions from external data, like room booking software.
6. Support tickets
This tab will redirect you to the support website (support.ubicast.eu)
You can find here a good practice guide to report your issues in the best possible way.
7. Technical documentation
In order to access all our technical documentations you can click on the “Documentation” tab. A new window will open and you’ll be able to check our online documentation.