This article covers the following topics:

• Prerequisites
• Configuration
• Filter Fields
  • Filter Name
  • File Type
  • Folder
  • Wildcard
  • Description
  • Recursive Search
  • Active
  • Match QA Device Date Filter
  • Filter Settings
  • Analysis Type
  • File Disposition
• Troubleshooting

Prerequisites

Below are the pre-requisites to use Equipment Hub to upload local or network files:

1. The latest Equipment Hub mut be installed. File uploads are not supported prior to Equipment Hub version 3.4.1.0. Instructions on how to install the Equipment Hub can be found here.
2. Any need tests to process the files must be selected in the schedule's template.
3. The Equipment Hub must have permissions to access the files. If the files are local to the host where the Equipment Hub is installed, typically the default computer account used will have the needed permissions. If the files are on a network share the Equipment Hub will need to be logged in as a network user.

Configuration

Follow the steps below to configure file uploads.

1. Navigate to Manage Measurement Devices and click the "+ Add device" button in the upper right.
2. Select File Uploader from the Device Type drop down. You should see a screen similar to that above.
3. Complete the Device Label field with a label that describes the uploader.
4. Ensure that the device is set to active.
5. Optionally select the site, fill in the device location, add a Device Description, choose an image, and add a serial number.
6. Select the desired Equipment Hub. At this point a new section will appear where you can add filters
7. Click the Add button to create a filter:
8. Click the Edit link to edit the newly created filter:
9. Complete the required fields marked by an asterisk, any desired optional fields, and click the Save button.
10. At this point you will be back to the Add Measurement Device page. Repeat steps 7 through 9 to add additional filters if desired.
11. Click the "Sign and Update device" button and complete the dialogue.
12. Navigate to Manage Schedule Configurations, find the desired schedule, and click the pencil icon to edit the schedule settings.
13. Once in the schedule settings, click the pencil icon to the right of the File Uploader section. 
14. Any schedule with image analysis tests will have a File Uploader section:
15. Click the "Add equipment" button and a new section will appear where you can select the Equipment Hub and the Equipment. Note that the Equipment dropdown will not populate until after the Equipment Hub is selected.
16. Files from more than one Equipment Hub or File Uploader device may be used in a schedule. Repeat steps 14 and 15 as needed.
17. Save the new schedule settings by clicking the Save button.
18. Navigate to Schedules and open up the schedule just edited. If the "Match QA Device Date Filter" was selected in steps 8 and 9, ensure the proper date is selected in the QA Device date filter: 
19. Click the "Upload files from {insert name here]" to confirm that the files are uploaded as expected.

Filter Fields

Adding a filter is required in order to upload files. Below are the details for each field.

Filter Name*

The filter name is required to identify file filters.

File Type

The file type is required and should not be blank. Selecting the dicom file type will make the Filter Settings field visible.

Folder*

Folder is a required field. Enter the path to the location where the desired files are kept. If using a network path, it will likely be required that the associated Equipment Hub be logged in as a network user that permissions to access the path provided.

Wildcard

Wildcard is an optional field that will filter the files returned for upload. Only files matching the wildcard field will be returned. The field uses standard MS-DOS/Windows wildcards.

Description

Description is an optional field where a scan description may be added to describe the files uploaded. This is typically to set tolerances by meta-item. One common example is in Catphan image sets where it may be desirable to apply different tolerances to a pelvis image set than you would a head image set.

Recursive Search

Recursive search is an optional field and when checked, will search all folders under neath the folder specified in the Folder field.

Active

Active is an option field and when checked the filter will be used to match and return files for upload. If unchecked the filter will not return any files.

Match QA Device Date Filter

This field is optional and if checked will only return files for upload that match the date in the "QA Device date filter" field in new QA. When checked additional fields will become visible:

• Create Date / Modify Date will match the date to the creation date or the modified date respectively. Only one can be chosen at a time.
• Days Before when set greater than zero will also include files for the number of days entered before the date in the date filter.
• Days After when set greater than zero will also include files for the number of days entered after the date in the date filter.

Filter Settings

The Filter Settings is an optional field and will only be visible if the file type is set to DICOM. Click the Add link to create a sub-filter based on DICOM tags. For each sub-filter enter the Group and Element number of the desired DICOM tag, then add the value to be matched. The operators used to match the following string are equals, starts with, ends with, contains, or a regular expression (regex). 

Multiple sub-filters may be added. All sub-filters must be matched for a file to be returned (a logical AND).

Analysis Type

Analysis Type is an option field that will preset that analysis type. And files returned by the filter will use the analysis type selected. If not analysis type is selected, any analysis in the filename will be used, if there are no specifications in the filename, the analysis will attempt to determine the analysis type automatically. It is recommended that an analysis type be selected.

When using separate image upload widgets and leaving the Analysis Type as Unassigned, no status will be provided in any of the individual widgets but the analysis will be available for preview in the new QA after processing has been completed.

File Disposition

One of the options for File Disposition must be selected. The default option is to leave the files in place.

The files may also be moved to another folder; if this option is selected a folder path must be entered. When moving the files, the filename will be prepended with a UID to ensure that older files are not overwritten.

Files may also be deleted after upload.

Troubleshooting

Please see the following articles to troubleshoot common problems:

• Error: Unable to connect to the equipment hub, please make sure it is running
• Error: Unable to get files from filter. The path is not of a legal form.
• Troubleshoot Connections