Skip to content
Pathcore Upload Client User Manual

Custom Fields


With 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).

In order to apply custom fields, the user account used to connect the Upload Client to PathcoreFlow requires the "Edit metadata" permission flag.

Values

Fields 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.

For more information, see the Custom Fields page of the PathcoreFlow user manual.

To add a Value custom field

  1. Click on the Open Custom Fields Open Custom Fields button in the Action Bar at the top of the main window to display the Custom Fields window

  2. Click on the Add Custom Field 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

  3. In the Custom Field popup dialog:

    1. Click on the Value tab
    2. Enter the Name of the metadata field in PathcoreFlow
    3. Enter the Value to apply to the field
    4. Click on the Apply button to save your changes, or click on the Cancel button to cancel

  4. Click on the Apply button in the Custom Fields window to save your changes

File Properties

A 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.

To add a File Property custom field

  1. Click on the Open Custom Fields Open Custom Fields button in the Action Bar at the top of the main window to display the Custom Fields window

  2. Click on the Add Custom Field 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

  3. In the Custom Field popup dialog:

    1. Click on the File Property tab

    2. Enter the Name of the metadata field in PathcoreFlow

    3. Select the desired information from the Value dropdown menu:

      • Relative Path: the local path to the file, relative to the defined scan folder
      • Absolute Path: the local path to the file
      • Size: the size of the file, in bytes
      • 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)

    4. Click on the Apply button to save your changes, or click on the Cancel button to cancel

  4. Click on the Apply button in the Custom Fields window to save your changes

Environment Variables

An 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).

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.
To add an Environment custom field

  1. Click on the Open Custom Fields Open Custom Fields button in the Action Bar at the top of the main window to display the Custom Fields window

  2. Click on the Add Custom Field 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

  3. In the Custom Field popup dialog:

    1. Click on the Environment tab
    2. Enter the Name of the metadata field in PathcoreFlow
    3. Enter the name of the local environment variable to use in the Value field
    4. Click on the Apply button to save your changes, or click on the Cancel button to cancel

  4. Click on the Apply button in the Custom Fields window to save your changes

Example environment variables in Windows
  • COMPUTERNAME: The name assigned to the local workstation
  • OS: Current operating system

Managing Custom Fields

To edit an existing custom field

  1. Click on the Open Custom Fields Open Custom Fields button in the Action Bar at the top of the main window to display the Custom Fields window

  2. Right-click on the item in the custom fields list to bring up the context menu

  3. Click Edit

  4. In the Custom Field popup dialog:

    1. Make the desired changes to the field settings
    2. Click on the Apply button to save your changes, or click on the Cancel button to cancel

  5. Click on the Apply button in the Custom Fields window to save your changes

To remove a custom field

  1. Click on the Open Custom Fields Open Custom Fields button in the Action Bar at the top of the main window to display the Custom Fields window

  2. Right-click on the item in the custom fields list to bring up the context menu

  3. Click Delete

  4. Click on the Yes button to confirm

  5. Click on the Apply button in the Custom Fields window to save your changes

To remove all custom fields
There is no undo option after removing all custom fields.

  1. Click on the Open Custom Fields Open Custom Fields button in the Action Bar at the top of the main window to display the Custom Fields window

  2. Click on the Clear All button at the top right of the filter list

  3. Click on the Yes button to confirm