{"data":{"allMdx":{"nodes":[{"frontmatter":{"title":"Page not found","description":null},"rawBody":"---\ntitle: Page not found\n---\n\nimport { Box } from '@xstyled/styled-components'\nimport { Article, ScreenContainer, Button } from '../components'\nimport { Link } from \"gatsby\"\nimport notFoundImageURL from '../images/404.png'\n\n\n \n \n There's a leak in the website.\n \n \n \n The page you are looking for does not actually exist.\n \n
\n \n
\n \n\n","slug":"404"},{"frontmatter":{"title":"","description":null},"rawBody":"---\nslug: /docs/\ntitle: \"\"\norder: 0\n---\n\n\n# Pathcore Upload Client\n\n## User Manual\n\n[Release Notes - v2.2](https://docs.pathcore.com/upload-client/release-notes/v2.2/)\n\n- Upload Client\n - [Overview](/docs/upload-client/overview/)\n - [Requirements](/docs/upload-client/requirements/)\n - [Installation Guide](/docs/upload-client/installation-guide/)\n - [Quick Start Guide](/docs/upload-client/quick-start-guide/)\n - [Supported Formats](/docs/upload-client/supported-formats/)\n - [Support](/docs/upload-client/support/)\n- User Interface\n - [Main Window](/docs/user-interface/main-window/)\n - [User Account](/docs/user-interface/user-account/)\n - [Settings](/docs/user-interface/settings/)\n - [Settings (Advanced)](/docs/user-interface/settings-advanced/)\n - [Custom Fields](/docs/user-interface/custom-fields/)\n - [Upload History](/docs/user-interface/upload-history/)\n- Background Service\n - [Overview](/docs/background-service/overview/)\n","slug":"docs/"},{"frontmatter":{"title":"Installation Guide","description":"installation guide"},"rawBody":"---\ntitle: Installation Guide\nsection: Upload Client\ndescription: installation guide\norder: 15\n---\n\n# Upload Client Installation Guide\n\n \n\n1. Download the installer executable file from the **Tools & Resources** section of the [Pathcore Help Center](https://pathcore.com/help)\n\n2. Run the installer executable file\n\n
\n If you have previously installed the Upload Client, the installer will provide the opportunity to remove the old version before installing the updated one.
\n\n Your settings will be preserved.\n
\n\n3. Click on the **Next** button\n \n\n4. Accept the License Agreement by clicking on the **I Agree** button\n \n\n5. Select a location for installation and click on the **Next** button\n \n\n6. Select a Start Menu folder and click on the **Next** button\n \n\n7. Review the list of components to install and the space required. Click on the **Install** button to begin the installation\n \n\n8. Wait for the installation to complete then click on the **Next** button\n \n\n9. The Upload Client is now installed. Click on the **Finish** button\n \n","slug":"docs/upload-client/installation-guide"},{"frontmatter":{"title":"","description":null},"rawBody":"---\nslug: /\nredirect: /docs/\n---\n","slug":""},{"frontmatter":{"title":"Overview","description":"overview"},"rawBody":"---\ntitle: Overview\nsection: Upload Client\ndescription: overview\norder: 5\n---\n\n\n# Overview\n\n \n\nThe Upload Client is a Windows utility designed to automate uploads to a PathcoreFlow installation. It can be configured to monitor a folder and automatically upload files to PathcoreFlow as they are added. The Upload Client can handle MRXS and VSI multi-file images natively. It also provides the option to ignore files with certain extensions, so only the items you are interested in are transferred. PathcoreFlow’s API is used to communicate with the PathcoreFlow server over HTTPS on port 443.\n\nThe Upload Client has two main components: a [background service](/docs/background-service/overview/) that monitors a specified folder, and the [user interface](/docs/user-interface/main-window/) that shows upload progress and lets you change configuration settings.\n\n\n## Features\n\nThe Upload Client provides some additional features to facilitate data ingestion into PathcoreFlow:\n- Files can be [filtered](/docs/user-interface/settings/#filter-conditions) based on extension, folder, or file name\n- [Support](/docs/upload-client/supported-formats/) for multi-file images, including VSI, MRXS, NDPIS, and AFI\n- [Custom metadata fields](/docs/user-interface/custom-fields/) for uploaded files, such as a scan workstation name\n- Transfers can be paused and resumed at any time\n- Active file transfers continue when the user interface is closed, and even continue when the Windows user is logged out thanks to the [background service](/docs/background-service/overview/)\n","slug":"docs/upload-client/overview"},{"frontmatter":{"title":"Quick Start Guide","description":"quick start guide"},"rawBody":"---\ntitle: Quick Start Guide\nsection: Upload Client\ndescription: quick start guide\norder: 20\n---\n\n# Quick Start Guide\n\n \n\nHow to quickly set up the Upload Client to scan a folder and upload its contents to your Pathcore service.\n\n1. Log in. See the [User Account](/docs/user-interface/user-account/) page for more details\n\n 1. When you open the main user interface, you should immediately be presented with the login window\n\n 2. Enter the URL of your PathcoreFlow service in the **Pathcore Team URL** field (e.g., `https://example.pathcore.com` or `http://192.168.0.120`).\n\n
\n It is important that the URL has the correct scheme (\"http\" or \"https\") or you may not be able to log in. All Pathcore managed cloud services use HTTPS.\n
\n\n 3. Click on the **Log In** button\n\n 4. Your default web browser will open and take you to your Pathcore service login page. You can log in using your email address and password, or via [SAML SSO](https://docs.pathcore.com/flow/manual/latest/docs/settings/saml-sso/)\n\n
\n You may be prompted to allow the site to open the \"pathcore-upload-client\" link. Click on the Open Link button in the dialog box.\n
\n\n2. Configure the basic Upload Client settings\n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Click on the  button to the right of the **Scan Directory** field to open the **Select a Directory** dialog window and browse to the desired watch folder\n\n 3. (Optional) Set the options for **Scan Depth**, **Scan Schedule**, **Stable Threshold**, **Delete After Upload**, and/or **Filter Conditions**. See the [Settings](/docs/user-interface/settings/) page for more details\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n3. Click on the  **Resume** button in the Action Bar at the top of the main window to begin the scanning process\n","slug":"docs/upload-client/quick-start-guide"},{"frontmatter":{"title":"Requirements","description":"requirements"},"rawBody":"---\ntitle: Requirements\nsection: Upload Client\ndescription: requirements\norder: 10\n---\n\n\n# Requirements\n\n \n\n## Operating System\n\nThe Upload Client can be installed on the following operating systems:\n\n- Microsoft Windows 10 (1809 or later), 64 bit\n- Microsoft Windows 11, 64 bit\n\n## SSO Notes\n\nTo use Upload Client v2.2, you must be connecting to a PathcoreFlow service running at least release v4.0. This version is needed to support single sign-on (SSO) in the Upload Client.\n\nUpload Client v2.2 cannot be used with previous versions of PathcoreFlow (<= v3.4.2).\n\n### User Account\n\nA valid user account is necessary to connect the Upload Client to PathcoreFlow. This user account, which may be a dedicated upload account rather than an individual's user account, has the following requirements:\n- Access to all Team content in the Repository. See the [Accessible Content](https://docs.pathcore.com/flow/manual/latest/docs/settings/accessible-content/) page in the PathcoreFlow user manual for more details.\n- The following [permission flags](https://docs.pathcore.com/flow/manual/latest/docs/settings/permissions/) are needed:\n - Team Permissions \\> Manage uploaded files\n - File Permissions \\> Upload\n- Additional functions of the Upload Client require these permissions:\n - Folder Permissions \\> View: to launch PathcoreFlow from the Upload Client\n - Image Permissions \\> View: to open uploaded images in PathcoreFlow\n - Image Permissions \\> Edit metadata: to apply custom fields to images\n - File Permissions \\> View: to open other uploaded files in PathcoreFlow\n - File Permissions \\> Edit metadata: to apply custom fields to other files\n","slug":"docs/upload-client/requirements"},{"frontmatter":{"title":"Overview","description":"overview"},"rawBody":"---\ntitle: Overview\nsection: Background Service\ndescription: overview\norder: 5\n---\n\n\n# Background Service Overview\n\n \n\nMost of the Upload Client functionality is provided by a Windows service — software that runs in the background and is started automatically when the computer is turned on. This is what allows the detection and transfer of new files to continue even when the [User Interface](/docs/user-interface/main-window/) is closed and the user is logged off.\n\n\n## Details\n\nThe background service is named \"Pathcore Upload Background\" and can be managed using the standard Windows service administration tools (Control Panel > System and Security > Administrative Tools > Services).\n\nThe service runs as the \"Local System\" account by default.\n\n### Windows 10\n\n\n\n To stop the \"Pathcore Upload Background\" service (Windows 10) \n\n
\n If the service is stopped or uninstalled, files will not be transferred to PathcoreFlow.\n
\n\n 1. Click on the **⊞ Start** button at the bottom left of the screen\n\n 2. Click on **Settings**\n\n 3. In the search bar type \"Control Panel\" and click on the result that matches\n\n 4. Click on **System and Security**\n\n 5. Click on **Administrative Tools**\n\n 6. Open **Services**\n\n 7. Locate the \"Pathcore Upload Background\" service and right-click on it to bring up the context menu\n\n 9. Click **Stop**\n\n\n\n\n\n To manually install the \"Pathcore Upload Background\" service (Windows 10) \n\n 1. Open a Command Prompt as an administrator:\n\n 1. Click on the **⊞ Start** button at the bottom left of the screen\n\n 2. Enter \"command prompt\" into the search bar\n\n 3. Click on **Run as administrator** in the right-hand panel\n\n 4. Click on the **Yes** button in the User Account Control warning that pops up.\n\n 2. Enter the following command into the Command Prompt:\n ```\n \"%ProgramFiles%\\Pathcore Upload Client\\upload_background_service.exe\" /i\n ```\n\n 3. Close the Command Prompt window\n\n\n\n\n\n To manually uninstall the \"Pathcore Upload Background\" service (Windows 10) \n\n
\n If the service is stopped or uninstalled, files will not be transferred to PathcoreFlow.\n
\n\n 1. Stop the \"Pathcore Upload Background\" service\n\n 2. Open a Command Prompt as an administrator:\n\n 1. Click on the **⊞ Start** button at the bottom left of the screen\n\n 2. Enter \"command prompt\" into the search bar\n\n 3. Click on **Run as administrator** in the right-hand panel\n\n 4. Click on the **Yes** button in the User Account Control warning that pops up.\n\n 3. Enter the following command into the Command Prompt:\n ```\n \"%ProgramFiles%\\Pathcore Upload Client\\upload_background_service.exe\" /u\n ```\n\n 4. Close the Command Prompt window\n\n\n\n### Windows 11\n\n\n\n To stop the \"Pathcore Upload Background\" service (Windows 11) \n\n
\n If the service is stopped or uninstalled, files will not be transferred to PathcoreFlow.\n
\n\n 1. Click on the **⊞ Start** button in the taskbar at the bottom of the screen\n\n 2. Click on the **Apps >** button at the top right of the popup\n\n 3. Click on **Windows Tools**\n\n 4. Open **Services**\n\n 5. Locate the \"Pathcore Upload Background\" service and right-click on it to bring up the context menu\n\n 6. Click **Stop**\n\n\n\n\n\n To manually install the \"Pathcore Upload Background\" service (Windows 11) \n\n 1. Open a Command Prompt as an administrator:\n\n 1. Click on the **⊞ Start** button in the taskbar at the bottom of the screen\n\n 2. Click on the **Apps >** button at the top right of the popup\n\n 3. Click on **Windows Tools**\n\n 4. Right-click on **Command Prompt** to bring up the context menu\n\n 5. Click on **Run as administrator**\n\n 6. Click on the **Yes** button in the User Account Control warning that pops up.\n\n 2. Enter the following command into the Command Prompt:\n ```\n \"%ProgramFiles%\\Pathcore Upload Client\\upload_background_service.exe\" /i\n ```\n\n 3. Close the Command Prompt window\n\n\n\n\n\n To manually uninstall the \"Pathcore Upload Background\" service (Windows 11) \n\n
\n If the service is stopped or uninstalled, files will not be transferred to PathcoreFlow.\n
\n\n 1. Stop the \"Pathcore Upload Background\" service\n\n 2. Open a Command Prompt as an administrator:\n\n 1. Click on the **⊞ Start** button in the taskbar at the bottom of the screen\n\n 2. Click on the **Apps >** button at the top right of the popup\n\n 3. Click on **Windows Tools**\n\n 4. Right-click on **Command Prompt** to bring up the context menu\n\n 5. Click on **Run as administrator**\n\n 6. Click on the **Yes** button in the User Account Control warning that pops up.\n\n 3. Enter the following command into the Command Prompt:\n ```\n \"%ProgramFiles%\\Pathcore Upload Client\\upload_background_service.exe\" /u\n ```\n\n 4. Close the Command Prompt window\n\n\n","slug":"docs/background-service/overview"},{"frontmatter":{"title":"","description":null},"rawBody":"---\nredirect: /docs/upload-client/quick-start-guide/\n---\n","slug":"docs/upload-client/initial-set-up-guide"},{"frontmatter":{"title":"Support","description":"support"},"rawBody":"---\ntitle: Support\nsection: Upload Client\ndescription: support\norder: 30\n---\n\n# Support\n\n \n\n\n## Uninstall\n\nRemoving the software requires administrator rights. Please consult with your local IT support for assistance.\n\n### Windows 10\n\n\n\n To uninstall the Upload Client from Apps & Features (Windows 10) \n\n 1. Click on the **⊞ Start** button at the bottom left of the screen\n\n 2. Click on **Settings**\n\n 3. Click on **Apps**\n\n 4. Click on \"Pathcore Upload Client\" in the list of Apps\n\n 5. Click on the **Uninstall** button\n\n 6. Follow the instructions on the screen to remove the software\n\n\n
\n\n\n\n\n\n To manually uninstall the Pathcore Upload Client (Windows 10) \n\n 1. Click on the **⊞ Start** button at the bottom left of the screen\n\n 2. In the search bar, enter the following:\n ```\n \"%ProgramFiles%\\Pathcore Upload Client\\Uninstall.exe\"\n ```\n\n 3. Click on **Run as administrator** in the right-hand panel\n\n 4. Follow the instructions on the screen to remove the software\n\n\n\n### Windows 11\n\n\n\n To uninstall the Upload Client from Apps & Features (Windows 11) \n\n 1. Click on the **⊞ Start** button in the taskbar at the bottom of the screen\n\n 2. Click on **Settings**\n\n 3. Click on **Apps**\n\n 4. Click on **Installed Apps**\n\n 5. Locate \"Pathcore Upload Client\" in the list of Apps and click on the **...** icon to the right\n\n 6. Click on **Uninstall** in the popup menu\n\n 7. Follow the instructions on the screen to remove the software\n\n\n
\n\n\n\n\n\n To manually uninstall the Pathcore Upload Client (Windows 10) \n\n 1. Click on the **⊞ Start** button in the taskbar at the bottom of the screen\n\n 2. In the search bar, enter the following:\n ```\n \"%ProgramFiles%\\Pathcore Upload Client\\Uninstall.exe\"\n ```\n\n 3. Click on **Run as administrator** in the right-hand panel\n\n 4. Follow the instructions on the screen to remove the software\n\n\n\n\n## Contact Support\n\nIf you require additional assistance, please email [Pathcore Support](mailto:support@pathcore.com) to request help.\n","slug":"docs/upload-client/support"},{"frontmatter":{"title":"Supported Formats","description":"supported formats"},"rawBody":"---\ntitle: Supported Formats\nsection: Upload Client\ndescription: supported formats\norder: 25\n---\n\n# Supported Formats\n\n \n\nThe Pathcore Upload Client attempts to identify image files and handle them intelligently, including multi-file images. Several other file types are also identified and uploaded to the destination Repository as attachments.\n\n## Supported File Formats\n\nThe following is a list of file formats and their level of support in the Upload Client. The table includes the file extension(s) used in [Filter Conditions](/docs/user-interface/settings/#filter-conditions) to include or exclude these types.\n\n| Vendor | Format | Single or Multiple Files | Extension(s) | Supported |\n| ----------- | ---------- | ------------------------ | ------------ | --------- |\n| 3DHISTECH | MRXS | Multiple | .mrxs | Yes |\n| Aperio | AFI | Multiple | .afi | Yes |\n| Aperio | SVS | Single | .svs | Yes |\n| Hamamatsu | NDPI | Single | .ndpi | Yes |\n| Hamamatsu | NDPIS | Multiple | .ndpis | Yes |\n| Hamamatsu | VMS | Multiple | | No [[1]](#notes) |\n| Hamamatsu | VMU | Multiple | | No [[1]](#notes) |\n| Huron | TIFF | Single | .tif/.tiff | Yes |\n| Indica Labs | TIFF | Single | .tif/.tiff | Yes |\n| KFBIO | SVS | Single | .svs | Yes |\n| Leica | SCN | Single | .scn | Yes |\n| Lunaphore | TIFF | Single [[2]](#notes) | .tif/.tiff | Yes |\n| Motic | Motic SVS | Single | .svs | Yes |\n| Nikon | ND2 | Single | .nd2 | Yes |\n| Olympus | VSI | Multiple | .vsi | Yes |\n| OME | OME-TIFF | Single / Multiple | .ome/.tif/.tiff | Single only [[3]](#notes) |\n| PerkinElmer | QPTIFF | Single | .qptif/.qptiff | Yes |\n| Philips | iSyntax | Single | .isyntax | Partial [[4]](#notes) |\n| Philips | TIFF | Single | .tif/.tiff | Yes |\n| Sakura | SVSlide | Single | .svslide | Yes |\n| Ventana | BIF | Single | .bif | Yes |\n| Ventana | TIFF | Single | .tif/.tiff | Yes |\n| WG26 | DICOM | Single / Multiple | .dcm | Single only [[3]](#notes) |\n| Zeiss | CZI | Single | .czi | Yes |\n| - | BigTIFF | Single | .tif/.tiff | Yes |\n| - | Bitmap | Single | .bmp | Yes |\n| - | JFIF | Single | .jpeg/.jpg | Yes |\n| - | JPEG | Single | .jpeg/.jpg | Yes |\n| - | JPEG2000 | Single | .jp2 | Yes |\n| - | PNG | Single | .png | Yes |\n| - | TIFF | Single | .tif/.tiff | Yes |\n| - | Tiled TIFF | Single | .tif/.tiff | Yes |\n| - | PDF | Single | .pdf | Attachment [[5]](#notes) |\n| - | Text | Single | .txt | Attachment [[5]](#notes) |\n| - | XML | Single | .xml | Attachment [[5]](#notes) |\n\n### Notes\n\n1. These formats are supported in PathcoreFlow, but not currently recognized by the Upload Client.\n\n2. Lunaphore TIFF images can have an auxiliary XML file with additional metadata, but this is not currently recognized by the Upload Client or PathcoreFlow.\n\n3. The Upload Client and PathcoreFlow do not work with multi-file OME-TIFF or DICOM images.\n\n4. The Upload Client can detect and upload Philips' iSyntax files, but PathcoreFlow does not yet support the image format. These files will appear as attachments in the PathcoreFlow Repository.\n\n5. Non-image file formats handled by the Upload Client will appear as attachments in the PathcoreFlow Repository.\n\n## Other Limitations\n\nThere may be other restrictions, see the [Known Limitations](https://docs.pathcore.com/flow/manual/latest/docs/repository/supported-formats/#known-limitations) section of the Pathcore User Manual Supported Formats page for more details.\n","slug":"docs/upload-client/supported-formats"},{"frontmatter":{"title":"Custom Fields","description":"custom fields"},"rawBody":"---\ntitle: Custom Fields\nsection: User Interface\ndescription: custom fields\norder: 25\n---\n\n# Custom Fields\n\n \n\nWith custom fields, the Upload Client can apply user-defined metadata to all images uploaded to PathcoreFlow. These fields can be a static key-value pair (e.g., a scanner model name), file properties (e.g., the local path from which the image was uploaded), or an environment variable (e.g., the workstation name).\n\n
\n In order to apply custom fields, the user account used to connect the Upload Client to PathcoreFlow requires the \"Edit metadata\" permission flag.\n
\n\n\n## Values\n\nFields are key-value pairs that can be associated with items in the PathcoreFlow Repository. A **Value** custom field is a user-defined key-value pair that is applied to every file uploaded to PathcoreFlow from the Upload Client.\n\nFor more information, see the [Custom Fields](https://docs.pathcore.com/flow/manual/latest/docs/metadata/custom-fields/) page of the PathcoreFlow user manual.\n\n\n\n To add a Value custom field \n\n 1. Click on the  **Open Custom Fields** button in the Action Bar at the top of the main window to display the Custom Fields window\n\n 2. Click on the  button at the top right of the field list, or right-click in the custom fields list to bring up the context menu and click **Add**\n\n 3. In the **Custom Field** popup dialog:\n 1. Click on the **Value** tab\n 2. Enter the **Name** of the metadata field in PathcoreFlow\n 3. Enter the **Value** to apply to the field\n 4. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Custom Fields** window to save your changes\n\n\n\n\n## File Properties\n\nA **File Property** custom field is similar to a **Value** field, but instead of the value being user-defined it is taken from the metadata of the local file before upload.\n\n\n\n To add a File Property custom field \n\n 1. Click on the  **Open Custom Fields** button in the Action Bar at the top of the main window to display the Custom Fields window\n\n 2. Click on the  button at the top right of the field list, or right-click in the custom fields list to bring up the context menu and click **Add**\n\n 3. In the **Custom Field** popup dialog:\n 1. Click on the **File Property** tab\n 2. Enter the **Name** of the metadata field in PathcoreFlow\n 3. Select the desired information from the **Value** dropdown menu:\n - **Relative Path**: the local path to the file, relative to the defined scan folder\n - **Absolute Path**: the local path to the file\n - **Size**: the size of the file, in bytes\n - **Format**: the file format. This is not necessarily the same as the file extension (e.g., a PerkinElmer .tiff file would have a format of qptiff)\n\n 4. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Custom Fields** window to save your changes\n\n\n\n\n## Environment Variables\n\nAn **Environment** custom field takes it value from an environment variable of the operating system (Windows) where the Upload Client is running. These may be set by the host OS, or by other software and services running on the computer (e.g., scanner management tools).\n\n
\n The Upload Client background service runs as a local system account, and it is in that context that the environment variables are resolved. This means that values from the currently logged in user are NOT available.\n
\n\n\n\n To add an Environment custom field \n\n 1. Click on the  **Open Custom Fields** button in the Action Bar at the top of the main window to display the Custom Fields window\n\n 2. Click on the  button at the top right of the field list, or right-click in the custom fields list to bring up the context menu and click **Add**\n\n 3. In the **Custom Field** popup dialog:\n 1. Click on the **Environment** tab\n 2. Enter the **Name** of the metadata field in PathcoreFlow\n 3. Enter the name of the local environment variable to use in the **Value** field\n 4. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Custom Fields** window to save your changes\n\n\n\n\n\n Example environment variables in Windows \n\n - **COMPUTERNAME**: The name assigned to the local workstation\n - **OS**: Current operating system\n\n\n\n\n## Managing Custom Fields\n\n\n\n To edit an existing custom field \n\n 1. Click on the  **Open Custom Fields** button in the Action Bar at the top of the main window to display the Custom Fields window\n\n 2. Right-click on the item in the custom fields list to bring up the context menu\n\n 3. Click **Edit**\n\n 4. In the **Custom Field** popup dialog:\n 1. Make the desired changes to the field settings\n 2. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 5. Click on the **Apply** button in the **Custom Fields** window to save your changes\n\n\n\n\n\n To remove a custom field \n\n 1. Click on the  **Open Custom Fields** button in the Action Bar at the top of the main window to display the Custom Fields window\n\n 2. Right-click on the item in the custom fields list to bring up the context menu\n\n 3. Click **Delete**\n\n 4. Click on the **Yes** button to confirm\n\n 5. Click on the **Apply** button in the **Custom Fields** window to save your changes\n\n\n\n\n\n To remove all custom fields \n\n
\n There is no undo option after removing all custom fields.\n
\n\n 1. Click on the  **Open Custom Fields** button in the Action Bar at the top of the main window to display the Custom Fields window\n\n 2. Click on the **Clear All** button at the top right of the filter list\n\n 3. Click on the **Yes** button to confirm\n\n\n","slug":"docs/user-interface/custom-fields"},{"frontmatter":{"title":"Main Window","description":"main window"},"rawBody":"---\ntitle: Main Window\nsection: User Interface\ndescription: main window\norder: 5\n---\n\n# Main Window\n\n \n\n
\n If the user has not logged in, instead of the main window they are presented with the Log In Screen.\n
\n\nThe main window of the Upload Client shows the current status of active uploads, recent activity, and provides access to both the PathcoreFlow web application and the local folder it is monitoring for new files.\n\n
\n When the main user interface window is closed, the background service continues to upload files and monitor the scan folder for new images.\n
\n\n\n## Action Bar\n\nAt the top of the main window is the Action Bar, which includes buttons for many common activities.\n\n- **Logged in as _Name_**: Clicking on the current user's name opens the PathcoreFlow account page in your default web browser\n-  **Pause** /  **Resume**:\n - **Pause**: Stops active uploads and scanning for new files until the user resumes\n - **Resume**: Resumes any paused transfers and restarts the scheduled scan of new files\n-  **Launch PathcoreFlow**: Opens PathcoreFlow in your default web browser\n-  **Open Folder**: Opens the folder which the client is monitoring for new files in Windows Explorer\n-  **Open Settings**: Displays the [Settings](/docs/user-interface/settings/) window\n-  **Open Custom Fields**: Displays the [Custom Fields](/docs/user-interface/custom-fields/) window\n-  **Log Out**: Log out of the current user account\n\n\n\n To pause/resume all uploads \n\n - Click on the  **Pause** button in the Action Bar at the top of the main window to pause all activity, or\n\n - Click on the  **Resume** button in the Action Bar at the top of the main window to resume transfers\n\n\n\n\n## Recent Activity\n\nThis section displays a list of active and previous file transfers. This list is cleared whenever the Upload Client user interface is closed, however the [Upload History](/docs/user-interface/upload-history/) retains the full list for future reference.\n\nThe Recent Activity list includes the following columns:\n\n- **Name**: the filename of the detected image or file\n- **Size**: the total size on disk of the item\n- **Status**: one of the following:\n - A progress bar: This indicates an active transfer. Hover over the progress bar for a tooltip which includes additional details\n - \"Uploaded\": the file has been transferred to the target Repository\n - \"Skipped\": the Upload Client did not transfer the item. Hover over the text to display a tooltip with the reason for this (e.g., \"Previously uploaded\" for items which already exist in the Repository)\n\n\n\n To upload a file \n\n 1. Click on the  **Open Folder** button from the Action Bar at the top of the main window to open the monitored folder in Windows Explorer\n\n 2. Copy a file into this folder, and the Upload Client will automatically begin the transfer\n\n\n
\n The upload will not start instantly. The background service polls the scan folder according to the Scan Schedule defined by the user in the Settings.\n
\n\n\n\n\n\n To see the current transfer rate of an active upload \n\n 1. Locate the item in the **Recent Activity** list\n\n 2. Hover over the progress bar of the item with the cursor. A tooltip will appear which includes the amount of data uploaded, the total size of the item, and the current transfer rate\n\n\n\n\n\n If the progress bar for an upload is red \n\n This indicates that a problem has occurred:\n - Hover over the progress bar of the item with the cursor. A tooltip will appear which provides additional information\n - Consult the [Status Bar](#status-bar) at the bottom of the window for any relevant error messages\n\n\n\n\n\n To see the full local path of a file \n\n 1. Locate the item in the **Recent Activity** list\n\n 2. Hover over the name of the item with the cursor. A tooltip will appear which shows the full path of the file on the local computer\n\n\n\n\n\n To open a transferred file in PathcoreFlow \n\n 1. Locate the item in the **Recent Activity** list\n\n 2. Click on the item name to open it in PathcoreFlow in your default web browser\n\n\n
\n If the item has been deleted from PathcoreFlow, clicking on its name in this list will do nothing.\n
\n\n \n\n
\n If the user account used to connect the Upload Client to PathcoreFlow does not have the required permissions to view the item, clicking on it will also do nothing.\n
\n\n\n\n
\n A \"Delete after upload enabled\" label appears below this section and to the left if a Delete After Upload policy has been defined by the user in the Settings.\n
\n\n\n## Status Bar\n\nAt the bottom of the main window of the user interface is the Status Bar. This displays a message reflecting the state of the Upload Client to the user.\n\nSome examples of messages:\n- \"xxx file(s) remaining.\": The number of remaining files to upload\n- \"Uploads paused.\": Transfers have been paused by the user. They can be resumed by clicking on the **Resume** button in the [Action Bar](#action-bar)\n- \"Unable to connect to the server. Please try again later.\": A network problem is preventing the Upload Client from reaching PathcoreFlow. Transfer will resume automatically when the network problem is resolved\n","slug":"docs/user-interface/main-window"},{"frontmatter":{"title":"Settings (Advanced)","description":"settings (advanced)"},"rawBody":"---\ntitle: Settings (Advanced)\nsection: User Interface\ndescription: settings (advanced)\norder: 20\n---\n\n# Settings (Advanced)\n\n \n\n
\n The options in this section are only recommended for advanced users.\n
\n\n## Custom Cron Expressions\n\nThe Upload Client supports great flexibility in its scan schedule via custom cron expressions. A cron expression is 6 fields representing a time schedule of the form:\n\n```\n\n```\n\n\n### Allowed Values\n\nThe following values are allowed in the corresponding cron fields:\n\n| Field | Allowed Value | Special Characters |\n| --- | --- | --- |\n| seconds | 0-59 | `*` `,` `-` |\n| minutes | 0-59 | `*` `,` `-` |\n| hours | 0-23 | `*` `,` `-` |\n| days of month | 1-31 | `*` `,` `-` `?` `L` `W` |\n| months | 1-12 | `*` `,` `-` |\n| days of week | 0-6 | `*` `,` `-` `?` `L` `#` |\n\n\n### Cron Special Characters\n\n| Special Character | Meaning | Description |\n| --- | --- | --- |\n| `*` | all values | selects all values within a field |\n| `?` | no specific value | specify one field and leave the other unspecified |\n| `-` | range | specify ranges |\n| `,` | comma | specify additional values |\n| `/` | slash | specify increments |\n| `L` | last | last day of the month or last day of the week |\n| `W` | weekday | the weekday nearest to the given day |\n| `#` | nth | specify the Nth day of the month |\n\n\n### Cron Expression Examples\n\n- At 22:00 on every day-of-week from Monday through Friday:\n ```\n 0 0 22 * * 1-5\n ```\n\n- At the 12th minute past every 4th hour:\n ```\n 0 12 */4 * * *\n ```\n\n- Every 10 minutes overnight between 5:00 p.m. and 7:50 a.m.:\n ```\n 0 */10 17-23,0-7 * * *\n ```\n\nAdditional information about cron can be found on [Wikipedia](https://en.wikipedia.org/wiki/Cron), or by consulting the [croncpp library](https://github.com/mariusbancila/croncpp).\n\n\n## Regular Expressions\n\nA regular expression is a notation that specifies a search pattern. The **RegEx** filter condition provided by the Upload Client is based on [Perl Compatible Regular Expressions (PCRE)](https://www.pcre.org/). A comprehensive guide to regular expressions is beyond the scope of this manual, however some resources are linked below for reference:\n- A complete [Syntax](https://github.com/google/re2/wiki/Syntax) reference for the expressions is available.\n- The article on [regular expressions](https://en.wikipedia.org/wiki/Regular_expression) at Wikipedia.\n\n
\n A regular expression filter matches against the path (i.e., folders and filename) relative to the Scan Directory, not just the filename.\n
\n\n\n### Regular Expression Examples\n\n- Match files with either \"slide\" or \"WSI\" in the file name:\n ```\n .*(slide|WSI).*\n ```\n\n- A more complex match based on a specific file name format:\n ```\n 202[123][01]\\d\\d\\d- Slide \\d\\d\\d-\\d\\d-[ABC]S1.*\\.svs\n ```\n - This would match the following file names:\n - `20220724 Slide 123-45-BS1 - Sample taken from lab 42.svs`\n - `20211113 Slide 987-65-AS1 - wsi_test_scan.svs`\n - `20211113 Slide 345-67-CS1.svs`\n - But not these:\n - `20192602 Slide 56-4738-29.svs` (invalid date and wrong number sequence)\n - `20220724 Slide 123-45-BS1.mrxs` (wrong file extension)\n\n","slug":"docs/user-interface/settings-advanced"},{"frontmatter":{"title":"Settings","description":"settings"},"rawBody":"---\ntitle: Settings\nsection: User Interface\ndescription: settings\norder: 15\n---\n\n# Settings\n\n \n\nThere are several configurable settings to customize the behavior of the Upload Client.\n\n\n\n To access the Settings window \n\n 1. Open the main user interface\n\n 2. Click on the  **Open Settings** button in the Action Bar at the top of the window\n\n\n\n\n## Directory Scanning\n\n\n### Scan Directory\n\nThe scan directory is the location on the local computer or network to monitor for new files. Files placed in this folder are automatically uploaded to PathcoreFlow.\n\nEnter the path to the folder in the field, or use the  button to open the **Select a Directory** dialog window and browse to the desired folder.\n\n\n### Scan Depth\n\nThe scan depth determines how many subfolders deep to scan for new files.\n\n- If set to `-1` (the default), the Upload Client will scan all subfolders recursively\n- If set to `0`, the Upload Client will only scan the specified folder. It will not scan subfolders\n- If set to a positive value, the Upload Client will scan that number of levels deep into subfolders\n\nSetting the scan depth to `0` or a positive value can be useful for preventing the Upload Client from unnecessarily scanning into a nested archive folder structure, for example.\n\n\n### Scan Schedule\n\nThe scan schedule determines how often the [background service](/docs/background-service/overview/) checks the specified folder for new files to upload.\n\nThe default scan schedule is \"every 10 minutes\".\n\n\n\n To set the scan schedule \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Click on the **Edit** button next to the current **Scan Schedule** value\n\n 3. In the **Set Search Schedule** popup dialog:\n 1. Select how often you want to scan: **Minutes**, **Daily**, **Weekly**, or **Custom (Advanced)**\n 2. Adjust the value according to the base schedule you have selected:\n - **Minutes**: How many minutes between each scan\n - **Daily**: The time of each day to perform a scan\n - **Weekly**: The number of weeks between each scan\n - **Custom (Advanced)**: A [custom cron expression](/docs/user-interface/settings-advanced/#custom-cron-expressions)\n 3. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n
\n The next five (5) scheduled scan times, based on the current configuration, are displayed at the bottom of the dialog under Next Scheduled Scans\n
\n\n\n\n\n### Stable Threshold\n\nThe stable threshold is the amount of time a file must remain unchanged before the Upload Client considers it ready to begin processing. This prevents the problem of files being uploaded while still in the process of being created (e.g., a WSI in the mid-point of being written from a scanner).\n\n\n\n To set the stable threshold \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Enter the number of seconds, minutes, or hours you want to wait before uploading a file into the **Stable Threshold** field\n\n 3. Select the desired time unit from the dropdown menu: **second(s)**, **minute(s)**, or **hour(s)**\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n\n\n### Delete After Upload\n\nWhen a delete policy is set, it determines how much time must pass after a successful upload before the source file is deleted. This allows the Upload Client to automatically free up storage space on the local system as file transfers are completed. As files deleted in this way bypass the Recycle Bin, this feature is disabled by default. Use caution when applying this setting.\n\n
\n This setting only applies to currently active and future items. Items which have previously been uploaded or skipped and appear in the Upload History are not affected.\n
\n\n \n\n
\n Files which are marked as read-only in the operating system will not be deleted, and there will be no further attempts to remove them.\n
\n\n\n\n To set the delete policy \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Enter the number of seconds, minutes, or hours you want to wait after a successful upload into the **Delete After Upload** field. A value of zero (`0`) disables this feature, and no files will be deleted\n\n 3. Select the desired time unit from the dropdown menu: **second(s)**, **minute(s)**, or **hour(s)**\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n
\n You will be prompted to confirm that you wish to enable this policy, and have your images deleted from the local computer after they have been uploaded to your Repository.\n
\n\n\n\n\n## Filter Conditions\n\nFilter conditions allow you to limit which files are processed by the Upload Client, by matching against the file extension, folder name, or a custom [regular expression](/docs/user-interface/settings-advanced/#regular-expressions).\n\n
\n If you create an Include filter, all non-matching files are automatically excluded from processing.\n
\n\n\n\n To add a filter based on file extension \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Click on the  button at the top right of the filter list\n\n 3. In the **Filter Condition** popup dialog:\n 1. Click on the **File Extension** tab\n 2. Select the desired file type from the **Extension** dropdown menu\n 3. Select whether to **Include** or **Exclude** the selected file type\n 4. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n
\n For more information on supported file formats and their extensions, see the Supported Formats page.\n
\n\n\n\n\n\n To add a filter based on folder name \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Click on the  button at the top right of the filter list\n\n 3. In the **Filter Condition** popup dialog:\n 1. Click on the **Folder** tab\n 2. Enter the relative path to the folder in the field, or use the  button to open the **Select a Directory** dialog window and browse to the desired folder.\n 3. Select whether to **Include** or **Exclude** the selected folder\n 4. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n\n\n\n To add a filter based on a regular expression \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Click on the  button at the top right of the filter list\n\n 3. In the **Filter Condition** popup dialog:\n 1. Click on the **RegEx** tab\n 2. Enter a [regular expression](/docs/user-interface/settings-advanced/#regular-expressions) in the field to match against. When it is validated, the \"Invalid\" notice at the bottom right of the dialog will change to \"Valid \"\n 3. Select whether to **Include** or **Exclude** the selected folder\n 4. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 4. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n\n\n\n To edit an existing filter condition \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Right-click on the item in the filter conditions list to bring up the context menu\n\n 3. Click **Edit**\n\n 4. In the **Filter Condition** popup dialog:\n 1. Make the desired changes to the filter settings\n 2. Click on the **Apply** button to save your changes, or click on the **Cancel** button to cancel\n\n 5. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n\n\n\n To remove a filter condition \n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Right-click on the item in the filter conditions list to bring up the context menu\n\n 3. Click **Delete**\n\n 4. Click on the **Yes** button to confirm\n\n 5. Click on the **Apply** button in the **Settings** window to save your changes\n\n\n\n\n\n To remove all filter conditions \n\n
\n This will remove all configured filters and cause the Upload Client to process all files in the monitored folder.\n
\n\n 1. Click on the  **Open Settings** button in the Action Bar at the top of the main window to display the Settings window\n\n 2. Click on the **Clear All** button at the top right of the filter list\n\n 3. Click on the **Yes** button to confirm\n\n\n","slug":"docs/user-interface/settings"},{"frontmatter":{"title":"Upload History","description":"upload history"},"rawBody":"---\ntitle: Upload History\nsection: User Interface\ndescription: upload history\norder: 30\n---\n\n# Upload History\n\n \n\nThe Upload Client retains the list of all files it uploaded to your PathcoreFlow Repository.\n\n
\n Though the client keeps a complete history of uploaded files, the Upload History table shows a maximum of 512 entries.\n
\n\n\n\n To access the Upload History window \n\n 1. Open the main user interface\n\n 2. Click on the **View Upload History** button at the bottom right of the window\n\n\n\n\n## Details\n\nThe Upload History list includes the following columns:\n\n- **Name**: the filename of the image or file\n- **Size**: the total size on disk of the item\n- **Status**: one of the following:\n - \"Uploaded\": the file has been transferred to the target Repository\n - \"Skipped\": the Upload Client did not transfer the item. Hover over the text to display a tooltip with the reason for this (e.g., \"Previously uploaded\" for items which already exist in the Repository)\n- **Completed**: a phrase that describes the relative time that the upload completed or was skipped (e.g., \"20 days ago\" or \"3 hours ago\"). Hover over the text to display a tooltip with the specific date and time in the workstation's local timezone and UTC\n\nTo return to the main window, click on the **Done** button at the bottom right of the window.\n\n
\n A message at the bottom left of the window indicates the number of items currently displayed: Showing latest xxx uploads.\n
\n\n\n\n To filter the upload history list by filename \n\n 1. Click on the **View Upload History** button at the bottom right of the main window to display the Upload History window\n\n 2. Click in the search box indicated by the  icon\n\n 3. Type in the filter you wish to apply to the filenames. Only the items matching this text will be displayed\n\n\n\n\n\n To open a transferred file in PathcoreFlow \n\n 1. (Optional) Use the search box to filter the list of items\n\n 2. Locate the item in the Upload History list\n\n 3. Click on the item name to open it in PathcoreFlow in your default web browser\n\n\n
\n If the item has been deleted from PathcoreFlow, clicking on its name in this list will do nothing.\n
\n\n \n\n
\n If the user account used to connect the Upload Client to PathcoreFlow does not have the required permissions to view the item, clicking on it will also do nothing.\n
\n\n\n","slug":"docs/user-interface/upload-history"},{"frontmatter":{"title":"User Account","description":"user account"},"rawBody":"---\ntitle: User Account\nsection: User Interface\ndescription: user account\norder: 10\n---\n\n# User Account\n\n \n\nBefore images can be uploaded, a user account must be logged in to connect the Upload Client to PathcoreFlow.\n\n
\n A valid user account is necessary to connect the Upload Client to PathcoreFlow. This user account has certain requirements.\n
\n\n\n\n To log in to the Upload Client \n\n 1. Open the main user interface. If you are not currently logged in, you will be presented with the login window\n\n 2. Enter the URL of your PathcoreFlow service in the **Pathcore Team URL** field (e.g., `https://example.pathcore.com` or `http://192.168.0.120`)\n\n
\n It is important that the URL has the correct scheme (\"http\" or \"https\") or you may not be able to log in. All Pathcore managed cloud services use HTTPS.\n
\n\n 3. Click on the **Log In** button\n\n 4. Your default web browser will open and take you to your Pathcore service login page. You can log in using your email address and password, or via [SAML SSO](https://docs.pathcore.com/flow/manual/latest/docs/settings/saml-sso/)\n\n
\n You may be prompted to allow the site to open the \"pathcore-upload-client\" link. Click on the Open Link button in the dialog box.\n
\n\n\n\n\n\n\n To log out from the Upload Client \n\n 1. Open the user interface\n\n 2. Click on the  button at the top right of the window\n\n 3. Click on the **Yes** button when prompted to confirm you want to pause uploads and log out\n\n\n\n\n\n To see when your login token expires \n\n 1. Open the user interface\n\n 2. Hover over the **Logged in as _Name_** button at the top left of the window\n\n\n
\n Your login token will refresh automatically every day as long as the Background Service is running and there is activity (e.g., new files to upload).\n
\n\n\n\n\n\n To open your PathcoreFlow account profile page \n\n 1. Open the user interface\n\n 2. Click on the **Logged in as _Name_** button at the top left of the window\n\n 3. Your default web browser will open your [My Account](https://docs.pathcore.com/flow/manual/latest/docs/settings/my-account/) page\n\n\n","slug":"docs/user-interface/user-account"}]},"site":{"siteMetadata":{"showSearch":true,"showVersions":true}}}}