Skip to main content
tiCrypt 2.18.1

Advanced Operations

Advanced operations are the diagnostic and recovery tools for a running virtual machine: its detailed record, its logs, the libvirt description of the machine, a VNC console, and controls for restarting the VM Controller, the agent inside the machine that tiCrypt communicates with.

Most of these are for the case where the normal path has already failed. If remote desktop works and the machine behaves, you should not need anything on this page.

Why the VM Controller can be restarted separately​

The controller is not the machine. Every VM runs a controller that handles drive mounting, user synchronisation, and file transfer on tiCrypt's behalf. When the controller becomes unresponsive the machine underneath is usually fine, and restarting the controller recovers management access without rebooting the guest and interrupting a running job.

A VNC console reaches a machine whose network path is broken. Remote desktop depends on the guest being reachable and its session healthy. VNC attaches at the hypervisor level, so it still works when the guest's own networking or desktop session has failed. It is the tool for diagnosing why the normal route is unavailable.

Syncing permissions resolves drift. Access directory permissions are applied to the folders on the VM's drives. If an access directory change has not taken effect on those folders, Sync user permissions in the VM's ⋮ menu reapplies the current access directory permissions on every drive rather than requiring a restart. It does not add or remove VM users. Two other actions do:

  • Synchronize users: the button on the warning that the running VM panel shows the VM's Owner when the backend does not know about all users authorized on the VM.
  • Sync user permissions in the Users table: the action of the same name in the Users section of VM Settings and Details, for managers with the Share VMs with other users permission. It runs the task Sync user access for vm-name, which removes VM users that were deleted from tiCrypt, deauthorizes users whose role does not match, authorizes missing users, and registers missing configuration co-owners as managers. For more information, see VM Users.

Before you begin​

  • The VM is running and you are its Owner or a Co-Owner.
  • For controller operations, be aware that in-flight file transfers and drive mounts may be interrupted.

View Virtual Machines' Details​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view the details.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Overview section in the left panel.
  6. Then, view the running CPU, Memory, Network in and Network out graphs, and the drive list with each drive's used and total capacity. A warning appears above the drive list when attached drives are not mounted.
  7. View the VM controller version in the header (VMC version) and the Last 50 log entries panel, which refreshes every five seconds. Click the panel to open the Logs section.
Confirmations, Errors & Solutions
Failed to View Virtual Machine's Details

The CPU, Memory, Network in and Network out graphs and the drive list in the Overview section keep loading and never display.

Ask VM Statistics Permissions from VM Owner

Ask the VM owner to allow you to access the VM settings and details section.



To Virtual Machine Owner
To grant VM statistics permissions to a VM user:  
  1. In the VMs section, click the virtual machine where you want to update a user's VM statistics permissions.
  2. Click the VM Settings and Details option in the bottom center.
  3. In the new window, select the Users section in the left panel.
  4. Next, select the appropriate user, then click the Open full menu button in the top-right panel.
  5. Select Edit user access.
  6. In the pop-up, set the profile to Custom.
  7. Scroll down under Permissions, and tick System Statistics View real-time system utilization.
  8. Click Save.

View Logs in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view its logs.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Logs section in the left panel.
  6. View the log entries, loaded 50 at a time.
  7. Optionally, narrow the list with the Filter ... level selector (Errors, Warnings, Info, Debug) or the Search logs ... field.
  8. Click Load Older to load the previous 50 entries, or Download to download the entries that match the filter and search.
  9. Once done, close the window with the button in its top left corner.
Result:

The log table lists each entry with its number (No.), Timestamp, User, and Log entry. Double-click an entry, right-click it, or select it and press Enter to expand it.

Confirmations, Errors & Solutions
Downloaded Logs Successfully

Downloading VM Logs.. total-downloading-time.

Failed to Load Logs

Failed to load logs start-end: error.

Load the Logs Again

The VM did not return that range of entries. Click Load Older again. If the error persists, contact your admin.

Failed to View the Logs Section, Previews and Button

The VM Settings and Details card, or its Logs section, is not shown. The VM controller returns logs only to users with the VM Manager role.

Ask the VM Owner to Grant You Permissions

Ask the VM owner to give you the Manager role on their virtual machine.



To VM Owner
To allow a VM user to view VM logs:  

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to update user permissions.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, select the user whose VM permissions you want to update.
  7. Click the Open full menu button in the top right corner.
  8. Select Edit user access.
  9. In the pop-up, set the Profile to Custom.
  10. Set the user role to Manager.
  11. Once done, click Save.

View the Logs of a Virtual Machine from the Menu​

The View logs action shows the VM's recent log in a pop-up, without opening VM Settings and Details. Everyone with access to the VM has it. Users with the View the logs of any VM permission have it for every VM, including stopped ones.

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine.
  4. Select View logs.
  5. In the Showing logs of vm-name pop-up, read the Timestamp and Log entry columns. Info, error, and warning entries are coloured.
  6. Click REFRESH to load the latest entries.
  7. Click Close.
Result:

The pop-up shows the VM's latest log entries. It has no Load Older or Download; use the Logs section of VM Settings and Details for those.

If the entries cannot be loaded, the pop-up shows "Failed to refresh logs".

Export Virtual Machine Data in JSON Format​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to export in JSON format.
  4. Select JSON Export.
  5. In the VM Info pop-up, click Expand all fields button in the top left panel.
  6. View all JSON export object data by users, groups, drives, access directories, and profiles.
  7. Once done, click Copy to copy the JSON data or click Download to download the JSON data.
  8. Click Close.
Result:

Download saves the data as vm-name-date.json. A section you are not allowed to view holds an error instead of data, for example {"error": "Cannot view users"}.

note

Use the search bar in the JSON export pop-up to search by keywords.

Confirmations, Errors & Solutions
JSON Data Copied

JSON copied to the clipboard.

View the Libvirt XML Description of a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to view the Libvirt XML description.
  4. Select Libvirt XML description.
  5. In the pop-up, view the Libvirt XML description from the backend.
  6. Click Copy to copy the XML description or click Download to download the XML description.
  7. Once done, click Close.
caution

Only super-admins can access this feature.

Confirmations, Errors & Solutions
XML Data Copied

XML copied to the clipboard.

Open a VNC Terminal in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to access the VNC terminal.
  4. Select Open VNC terminal.
  5. In the VNC console for vm-name window, use the VNC terminal.
  6. Once done, click Close.

An open VNC console counts as activity in tiCrypt only while you type, click, scroll, or touch inside it. A console left open without input does not keep your session from locking.

caution

The VNC terminal is meant for VMs whose hardware setup is in debug mode, and for debugging by system admins. For any other VM, tiCrypt shows an error and offers Try anyways.

Confirmations, Errors & Solutions
Connected to VNC Terminal

Connected to vm-name.

Unable to Connect to VNC Terminal

Something went wrong, connection is closed.

Open the VNC Terminal Again

The VNC connection closed. Close the window and select Open VNC terminal again. If the error persists, ask your system admin to check the VM.

Hardware Setup Not in Debug Mode

hardware-setup-name (the hardware setup for vm-name) not in debug mode

Try Anyways or Use a Debug Hardware Setup

Click Try anyways on the message to open the VNC terminal regardless, or ask your admin for a hardware setup with Video set to VNC, which puts the VMs created from it in debug mode. VM owners must log in to the VNC terminal to perform debugging.

Restart Virtual Machine Controller​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to restart the controller.
  4. Select Restart controller.
  5. In the pop-up, read the risks.
  6. Once done, click Restart.
caution

Restarting the controller takes time. Wait at least 15 seconds before using the virtual machine after a controller restart.

Confirmations, Errors & Solutions
Restarted VM Controller

VM restarting (wait at least 15s to reconnect)

Unauthorized to Restart VM Controller

You are not authorized to restart this VM.

Ask the VM Owner for Restart VM Controller Access

Ask the VM owner to allow you to restart the VM controller in their virtual machine.



To VM Owner
To allow a VM user to restart the VM controller:  

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add users to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, select the user whose VM permissions you want to change.
  7. Click the Open full menu button in the top right corner.
  8. Select Edit user access.
  9. In the pop-up, set the Profile to Custom.
  10. Set the user role to Manager.
  11. Scroll down under Permissions and tick the Restart VM controller permission.
  12. Once done, click Save.

Forcefully Restart a Virtual Machine Controller​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to restart the controller.
  4. Select Restart controller.
  5. In the pop-up, read the risks.
  6. Tick the box I know the risks of force restarting the controller, and wish to force restart anyways.
  7. Once done, click Force Restart.
warning

Force restarting the VM controller kills the controller process immediately via an OS syscall, without letting it finish its current work. Do not force restart a controller while other users are active on the virtual machine: pending database transactions may only partly reach the drive, ongoing file transfers cannot finish, and the VM's database of users and access directories can be corrupted.

Confirmations, Errors & Solutions
Restarted VM Controller

VM restarting (wait at least 15s to reconnect)

Sync Users' Permissions in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to sync users' permissions.
  4. Select Sync user permissions.
note

Sync user permissions in this menu only refreshes access directory permissions on the VM's drives. If a newly added user is not recognized, use the Synchronize users button on the warning shown on the running VM panel, or the Sync user permissions action of the Users table in VM Settings and Details, which shares this label but synchronizes the VM's users. See Why the VM Controller can be restarted separately.

Confirmations, Errors & Solutions
Synced User Permissions

Sync user permissions total-syncing-time.

Repair Corrupted Databases in Virtual Machines​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine to repair the corrupted database.
  4. Select Repair corrupted database.
  5. In the Warning: Database Repair Process pop-up, type Repair in the Type to Confirm field.
  6. Click Repair.
info

Repair corrupted database appears only for users the backend has authorized as managers of the virtual machine. Other users do not see it in the menu.

warning

Do not use this option unless instructed by an admin. Repairing may cause secondary issues when performed arbitrarily. All VM connections, including RDP, will be disconnected.

Confirmations, Errors & Solutions
Repaired Corrupted Database

Database repair started

Failed to Repair Corrupted Database

Failed to repair database

Ask the System Admin to Review the VM Controller

When the repair fails, the VM controller restores the original database file. Ask the system admin to review the VM controller logs before trying again.

Access the Virtual Machine Controller Logs​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to access its controller logs.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Logs section in the left panel.
  6. View the logs.
  7. Optionally, click the Load Older button to view older VM logs.

Download All Virtual Machine Controller Logs​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to download its controller logs.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Logs section in the left panel.
  6. View the logs.
  7. Click the Download button in the toolbar above the logs. The .tsv file holds every log entry that matches the current filter and search, so clear them first to download all logs.
Result:

tiCrypt saves vm-name_YYYY-MM-DD.tsv. Its first line is the header Log No., Timestamp, Information, separated by tabs, followed by one line per entry.

A log entry that starts with =, +, -, or @ (other than a plain negative number) is saved with a leading ', so a spreadsheet opens it as text instead of running it as a formula. If part of the log cannot be loaded, the download stops and the task shows the error from the VM.

caution

Only the VM owner, co-owners, and users with the VM Manager role can view and download controller logs.

Confirmations, Errors & Solutions
Downloaded VM Logs Successfully

Downloading VM Logs.. (total-downloading-time).

Access the Virtual Machine Applications​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to access its applications.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. View the existing video annotation templates.

The Applications group of VM Settings and Details holds two applications, Video annotation types and Avicenna Research Transfers (see Avicenna Research Transfers), on every VM, Linux or Windows. Adding, editing, exporting, and deleting templates needs the system permission Share VMs with other users, and adding one also needs the Manager role on the VM.

A video annotation template is the set of rules for annotating the videos in one directory of the VM. It defines the tag categories and tags that people can apply, which VM users see each tag, where annotation exports go, and how much video the player buffers. A template covers its directory and every subfolder on the same drive. When a subfolder has a template of its own, that template applies there instead, so the deepest template wins. A template on /videos does not cover /videos2.

Confirmations, Errors & Solutions
Unable to View Video Annotation Template Section

Cannot view the Video annotation types section, in VM Settings and Details.

Ask the VM Owner for the Manager Role

The Video annotation types section is listed under Applications for every VM, Linux or Windows, but it sits inside VM Settings and Details, which only the VM owner, co-owners, and managers can open. Ask the VM owner to give you the Manager role.

Create a Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to create its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Click Add template in the top right panel.
  7. In the Add annotation template to vm-name prompt, enter the template name in the Name field. The name is required, up to 32 characters, without special characters, and must differ from the other templates of the VM.
  8. Select the annotation type, Video Tags, and the Directory containing the files to annotate.
  9. Optionally, select the Directory to export annotation files (optional) and the Video playback buffer size (Default, or 16 to 256 KB).
  10. Click Create Templates.
Result:

The template appears in the Video annotation types list. Videos in its directory and subfolders now open in the annotator. Add categories and tags next, so people have something to apply.

caution

A directory can hold only one video annotation template. A subfolder of that directory can hold its own template, which then applies to the subfolder instead.

tip
  • Use a smaller buffer size to minimize buffering delay. Ideal for fast and stable internet connections.
  • Use a larger buffer size to increase template data pre-loading and enhance playback stability. Ideal for slower or less reliable internet connections.
Confirmations, Errors & Solutions
Failed to Enter Video Annotation Name

You must enter a name.

Enter Video Annotation Name

In the Add annotation template to vm-name prompt, enter the annotation name in the Name field.

Create Templates Button Inactive

The Create Templates button stays inactive because no directory is selected.

Select Home Access Directory from List

Under Directory containing the files to annotate, select an existing drive or home access directory from the Choose a Directory tree. A directory already used by another template of the same type is marked This directory is already being used by another template.

View an Existing Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to view.
  7. Click the View button in the top right panel.
  8. In the new window, view the categories and tags of the video annotation template.

Add a Category to Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add a category to its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to add a category to.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click Add category in the top-left panel.
  10. In the Create a new tag category for template-name prompt, enter the category name. It can have up to 64 characters and must differ from the other categories of the template.
  11. Click Create category.
  12. Click the Save button on the top right.
note

Changes to categories and tags, including deletions, take effect only when you click Save. If you leave the template with unsaved changes, tiCrypt asks "Save changes to template-name template?" with Discard and Save. If saving fails, tiCrypt shows "Failed to save the template".

Add a Category Tag in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to which you want to add a category tag in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to add a tag to its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click Add tag to category next to the category you want to add a tag to.
  10. Enter the tag name in the Type tag name field below the category name.
  11. Select Everybody, or the individual VM users the tag applies to. VM managers are not listed; a tag with no one selected shows Managers only.
  12. Once done, click the Save button on the top right.
note

The default tag is set to Everybody, which includes all users from the virtual machine. Selecting a user replaces Everybody. A tag hidden from a user does not appear in that user's annotator, and a category none of whose tags they can see is hidden from them too. Managers see every tag.

Edit a Category Tag in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to edit a category tag in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to edit a tag in its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, update the tag name below the category name or the VM users the tag applies to.
  10. Once done, click the Save button on the top right.

Edit a Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to edit.
  7. Click the Open full menu button in the top right panel.
  8. Select Edit.
  9. In the prompt, update the annotation name, export directory, or video playback buffer size. The type and the annotated directory cannot be changed after creation.
  10. Once done, click Save Changes.

Export a Video Annotation Template in JSON Format​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to export its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to export.
  7. Click the Open full menu button in the top right panel.
  8. Select Export annotation.
  9. In the prompt, select the export directory.
  10. Click Export.
Result:

tiCrypt saves template-name.json in the directory you chose. The file holds the template definition, not the annotations made with it: its name, type, tags, categories, the tag names and long names by tag ID, and the user names by user ID. To export the annotations of a video, see Annotate a Video.

Confirmations, Errors & Solutions
Exported Video Annotation Template

Exporting template-name.json to JSON (total-exporting-time).

Delete a Category Tag in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to delete a category tag in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to delete a tag from its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click the Delete button next to the tag you want to remove.
  10. In the Delete tag-name? prompt, which warns "This tag will be removed from the template.", click Delete tag.
  11. Click the Save button on the top right.

Delete a Category in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to delete a category in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to delete its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click the Remove category button next to the category you want to delete.
  10. In the Delete category-name? prompt, which warns "All tags in this category will be removed from the template.", click Delete category.
  11. Click the Save button on the top right.
Confirmations, Errors & Solutions
Deleted Category

Deleted category-name.

Delete a Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to delete its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select one or more video annotation templates to delete.
  7. Click the Open full menu button in the top right panel.
  8. Select Delete.
  9. In the Delete N annotation template(s)? prompt, which asks "Are you sure you want to delete N annotation template(s)?", click Delete.
Confirmations, Errors & Solutions
Deleted Video Annotation Template

Delete total-number-of-annotation-templates annotation template(s) (total-deletion-time).

Annotate a Video​

An annotation is a note attached to a video in a VM: a set of tags from the video's annotation template, applied either to the whole video, to one moment, or to a stretch of time. The annotator opens when you view a video in a directory that a template covers.

Before you begin:

  • The VM has a video annotation template that covers the video's directory. See Create a Video Annotation Template.
  • You have the VM permission Files.
  • The video is an FLV, MP4, Matroska, Ogg, WebM, 3GPP, MPEG, or QuickTime file.

This procedure describes how to annotate a video.

  1. Open the VM's File Explorer.
  2. Go to the video's folder and double-click the video, or select it and choose View.
  3. Play the video. In the editor panel, choose the annotation Type: Time interval, Time point, or Global. The default is Global, and the editor keeps the last type you used.
  4. For a time point or interval, click Set next to Start at the moment the annotation begins. Set pauses the video and pins the exact time. You can also type a time in the field.
  5. For a time interval, click Set next to End at the moment it ends.
  6. Click the tag buttons to apply. They are grouped by category.
  7. Click Add annotation.
Result:

The annotation appears in the table below the video and as a marker on the timeline. Click a row or a marker, or select a row and press Enter or Space, to skip the video to that time.

Add annotation stays disabled until the annotation has a start time (or is Global) and at least one tag, unless the template has no tags. If you set an end before the start, the end moves to the start. If saving fails, tiCrypt shows "Failed to save the annotation".

If you switch to another annotation with unsaved changes, tiCrypt asks "Do you want to save the current annotation?" with Cancel, Discard, and Save. Closing the annotator asks the same without Cancel.

Who sees which annotations​

Users who are not managers see only their own annotations, and only the tags the template makes visible to them. Managers see everyone's annotations. A manager who edits someone else's annotation does not take it over: the original author stays its owner. The table refreshes every minute.

Annotation table​

The table has the columns Timestamp (the start and end, a single time, or "Global"), User, Annotation, Created, Updated, and Actions. To edit an annotation, select it, change it in the editor, and click Update annotation. Cancel drops your changes.

Deleting an annotation does not ask for confirmation

The button in a row deletes the annotation at once. If deletion fails, tiCrypt shows "Failed to delete the annotation".

The toolbar above the table offers:

  • Filter: filters the table by Users or Tags with the Filter ... field.
  • Import: adds annotations from a file. You become the owner of the imported annotations.
  • Export: saves the annotations as JSON, either with Export all or for one user's annotations.
  • Refresh: reloads the annotations.

The following table describes the files Import accepts.

FormatContents
.jsonA list of annotations. Each needs start and tagIDs; end and type are optional.
.txtOne annotation. Line 1 is the start in seconds, line 2 the end in seconds, and each further line a tag name, matched without regard to case.

An import is refused with "The first two lines must be the start and end times in seconds", "End time is greater than video duration", "Start time is greater than video duration", "Start time is greater than end time", "Start time is negative", or "Unknown file extension:" followed by the extension.

Export opens the Export annotations pop-up with a directory picker. It starts at the template's export directory if one is set, otherwise at your home directory. tiCrypt saves video-name.json there and shows "Annotations exported to" followed by the directory and file name. Each exported annotation holds start, end, tags (tag names by category), tagIDs, userID, userName, and type.

To export the annotations of several videos at once, select them in the File Explorer and choose Export annotations. Files with annotations show a count badge. The task reads "Export annotations for N file(s)".

Video player controls​

  • Play and volume: play or pause the video, and set its volume. Space also plays or pauses.
  • Time display: shows the current time. Its copy button copies the timestamp.
  • Buffer size: sets how much video is loaded ahead, from 16 KB to 2 MB.
  • Skip back 15s and Skip forward 15s: jump 15 seconds. The Left and Right arrow keys jump 3 seconds, or 30 seconds with Shift.
  • Speed: plays the video from 0.25x to 10x.
  • Fullscreen: fills the screen with the video.
  • Previous file (Shift+P) and Next file (Shift+N): open the previous or next video in the folder.

View Drive Capacity of a Virtual Machine​

bulk-action

Method One​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view its drive capacity.
  4. In the right panel, click Show statistics, then view each drive's name, used and total capacity, and percentage in the drive list at the top of the panel.

The statistics panel is hidden by default; Show statistics and Hide statistics toggle it, and tiCrypt remembers your choice. It appears only while you are connected, once the home drive is mounted, and only if you have the VM permission System Statistics. Below the drive list, it shows CPU, Memory, Network in, and Network out graphs of the last 120 samples. Each drive's bar is green below 70% usage, amber from 70% to 90%, and red from 90%.

Method Two​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view its drive capacity.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Overview section in the left panel.
  6. In the drive list below the graphs, view each drive's name, used and total capacity, and percentage.

Open the Debugger of a Virtual Machine​

The debugger sends raw requests to the VM Controller. It exists only while tiCrypt runs in debug mode, for diagnosing the controller, and is not part of normal use.

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the menu next to the virtual machine.
  4. Select Open debugger.
  5. In the Send RAW requests to vm-name pop-up, select the Service and the Method, and edit the request body.
  6. Click Send to send the request and show the reply, or Send No Reply to send it without waiting for one.
Result:

The VM Controller receives the request. With Send, its reply appears below the request.

The debugger restarts the controller without confirmation

The Restart Controller button of the debugger stops the VM Controller at once, without asking for confirmation.