rootdir
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
rootdir [2023/11/21 13:19] chris |
rootdir [2023/11/22 17: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. | 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 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. | * You can map multiple root directories to organize slides according to different purposes or workflows. | ||
| - | * 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 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 |}} | {{ ::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 path such as \\myserver\dir\subdir\subsubdir\ to a (much simpler to remember) 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 ==== | ==== Mounting points ==== | ||
| Line 20: | Line 20: | ||
| {{ ::rootdir_scenarios2.png?nolink&400 |}} | {{ ::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 root directory, here are some 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]] | * [[rootdir_geo_replication|Geo replication]] | ||
| Line 58: | Line 58: | ||
| | 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"... | | | 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. | | | 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 though; you're still going to have to flick the proverbial switch manually) | | + | | 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/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 | | ||
| Line 101: | Line 101: | ||
| {{ :rootdir_integrity.png?direct&400 |}} | {{ :rootdir_integrity.png?direct&400 |}} | ||
| - | 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 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. |
rootdir.txt ยท Last modified: 2023/11/22 17:46 by chris
