Differences

This shows you the differences between two versions of the page.

--- rootdir [2022/08/10 14:07] – yves
+++ rootdir [2023/11/22 15:46] (current) – chris
@@ Line 3: / Line 3: @@
 In order for PMA.core to show content, you need to set up root directories. A root directory is a starting location from which your various whole slide images will be hosted.
-The reason for working with root directories offers several advantages:
+Working with root directories offers several advantages:
   * You don't have to navigate through a complicated directory structure before reaching the files that you want to work with
   * You can map multiple root directories to organize slides according to different purposes or workflows.
-  * Swtich out different types of storage without the end-user knowing about it. When you move data from a conventional hard disk to cloud, you typically need to install a new piece of software (S3 browser, or an FTP explorer). With PMA.core, you just re-direct the root-directory to point to the updated location and you're done; the end-user remains unaffected
+  * You can switch out different types of storage without the end-user knowing about it. When you move data from a conventional hard disk to cloud storage, you typically need to install a new piece of software (S3 browser, or an FTP explorer). With PMA.core, you just have to re-direct the root-directory to point at the updated location and you're done; the end-user remains unaffected
 {{ ::rootdir_scenarios3.png?nolink&400 |}}
-The concept of root directories is not dissimilar to mapped network drives in the Microsoft Windows operating system, where you map a map such as \\myserver\dir\subdir\subsubdir\ to a (much simpler to remember and address) drive letter.
+Root directories behave similarly to mapped network drives in the Microsoft Windows operating system, where you map a path such as \\myserver\dir\subdir\subsubdir\ to a (much simpler to remember) drive letter.
 ==== Mounting points ====
-Since PMA.core 2, a root directory is defined by one or more mounting point. This was done to be able to facilitate [[rootdir_geo_replication|geo-replication scenarios]].
+Since PMA.core 2, a root directory is defined by one or more mounting points. This facilitates [[rootdir_geo_replication|geo-replication scenarios]].
-A mouning point for a root directory may either be a local directory, a UNC share, Azure blob storage, FTP folder, or an Amazon S3 compatible storage.
+A mounting point for a root directory may either be a local directory, a UNC share, Azure blob storage, FTP folder, or an Amazon S3 compatible storage.
 {{ ::rootdir_scenarios2.png?nolink&400 |}}
-A Mounting point is a further abstraction of the concept "where are my slides stored?". While most users will end up having one mounting point per any one root directory, here are the different scenarios in which you could have multiple mounting points:
+A Mounting point is a further abstraction of the concept "where are my slides stored?". While most users will end up having one mounting point per root directory, there are some different scenarios in which you could benefit from having multiple mounting points:
   * [[rootdir_geo_replication|Geo replication]]
@@ Line 27: / Line 27: @@
 {{ ::rootdir_scenarios1.png?nolink&400 |}}
-In order to make root directories work, you need to attach at least one mounting point to it.
+In order to make a root directory work, you need to attach at least one mounting point to it.
 The mounting point of a root directory refers to the base directories where the system should look into for whole slide images. All the subdirectories of the root directories are exposed by the application and whole slide images that are discovered are advertised.
@@ Line 43: / Line 43: @@
 The list displays all the configured root directories and provides options to add new, edit and delete entries.
-  * The "Offline" column indicates whether or not a root directory is enabled. An offline root directory is not advertised by the system and its contents are not available to the end-users.
+  * The "Offline" column indicates whether or not a root directory is enabled. An offline root directory is not advertised by the system and its contents are not available to end-users.
-  * The "Path exists" column indicates whether or not the system is able to mount a root directory's path and access it's contents. For example a root directory that points to a local file system folder, that has been deleted, will not have the "Path exists" column checked.
+  * The "Path exists" column indicates whether or not the system is able to mount a root directory's path and access it's contents. For example, a root directory that points to a delected local file system folder will not have the "Path exists" column checked.
-We have a [[rootdir_config|separate section]] in this wiki that takes you through the different steps that you can take to [[rootdir_config|configure root directories and mounting points]].
+We have a [[rootdir_config|separate section]] in this wiki that walks you through the different steps of [[rootdir_config|configuring root directories and mounting points]].
-Root-directories can be labeled public or private, which allow you to [[rootdir_security#public_vs_private|take security precautions when configuring these]].
+Root-directories can be labeled public or private, which allows you to [[rootdir_security#public_vs_private|take security precautions when configuring these]].
+=== Edit ====
+You can edit the following properties of a root directory
+^ Parameter                ^ Meaning  ^
+| Alias | The unique name or alias for the root directory |
+| Description | An aribitrary string that can help an administrator remember what your root directory contains. The Description field of a root directory can also be used to hide additional information about a group of data that you don't want everybody to know about immediately. Do //not// use this field for sensitive information, as it can be seen by everyone with access to PMA.core. If you're an instructor working with students, it's perfectly ok to enter reminders for yourself in this field like "these are all trick-questions"... |
+| Quota   | You can set a limit on the amount of data that you want to allow PMA.core to manage in a particular period. This can be useful when facilitating temporary workers, visiting staff, residents or other students that will only be at your department for a brief period of time. If you //don't// want to restrict the amount of data, you can leave the default value of 0 in place. |
+| Offline | When checked, the folder will not be available to downstream applications like PMA.studio. Maybe you're just creating a placeholder for a future department, or you're not done curating a new collection yet. Instructors can also use this option to prepare a list of exam slides and only expose them to students for a limited amount of time (we don't offer scheduling at this moment though; you're still going to have to flick the proverbial switch manually) |
+| Prevent rendering of labels/barcodes | This prevents the labels or barcodes of any slides in this root directory from being shown. This is primarily used to anonymize the slide |
+{{ ::prevent_rendering_of_labels.jpg?600 |}}
 ==== Security ====
@@ Line 54: / Line 67: @@
 Root directories can be either [[rootdir_security#public_vs_private|public or private]].
-Who's accessed what (either public or private) folder can be monitored via the Access log tab.
+Who's accessed which (either public or private) folder(s) can be monitored via the Access log tab.
 {{ ::access_log.png?nolink&400 |}}
@@ Line 60: / Line 73: @@
 ==== Logging ====
-Apart from manipulating root directories, monitoring their use is an important aspect of our software as well.
+Apart from manipulating root directories, monitoring their use is an important aspect of our software.
 You can monitor logs for several kinds of acivity:
@@ Line 68: / Line 81: @@
 === Audit trail ===
-The audit trail tab conbines any operations that were performed on both root directory entries and underlaying mounting point entries.
+The audit trail tab combines any operations that were performed on both root directory entries and underlying mounting point entries.
 {{ :rootdir_audit.png?direct&400 |}}
@@ Line 76: / Line 89: @@
 === Activity log ===
-In addition to an audit trail, an activity log is available that chronologically tell you which user has been accessing what slides in the root directory:
+In addition to an audit trail, an activity log is available that chronologically lists which user has been accessing which slides in the root directory:
 {{ :rootdir_activity.png?direct&400 |}}
@@ Line 84: / Line 97: @@
 When problems persist over time, a structured and proactive approach is warranted.
-When you suspect certain slides in a particular root directory are corrupt, you can run an integrity check on a particular folder:
+When you suspect certain slides in a particular root directory have become corrupted, you can run an integrity check on a particular folder:
 {{ :rootdir_integrity.png?direct&400 |}}
-This attempts to read all slides in a folder and reports on the ones that fail. You should then [[format_troubleshoot|try to find out why such slides cannot be read]].
+This attempts to read all slides in a folder and reports the ones that failed. You can then [[format_troubleshoot|try to find out why those slides cannot be read]].
-For problems that only occur occasionally and don't appear to be persistent, [[diag_elmah|Elmah logs]] are available to assist in for ad-hoc troubleshooting.
+For problems that occur occasionally and don't appear to be persistent, [[diag_elmah|Elmah logs]] are available to assist in ad-hoc troubleshooting.