Question

What parameters are available for the user actions and button commands I can create in uScope Navigator?

Answer

There are a number of substitution parameters you can include in your script commands. These parameters are replaced with information from the current scan or deep zoom image. Each parameter must begin and end with percent signs ('%').

• JobFolder
  This parameter is replaced with the path to the default folder containing your slide scan jobs. For example: C:\Images.
• SavedImagesFolder
  This parameter is replaced with the path to the default folder for images saved from the browse window. For example: C:\SavedImages.
• JobName
  This parameter is replaced with the name of the job. For example: MyScan.
• JobPath
  This parameter is replaced with the path to the folder of the scan. For example: C:\Images\MyScan.
• DZPath
  This parameter is replaced with the path to the deep zoom image folder. For example: C:\Images\MyScan\DeepZoom-Unfiltered. This parameter is only valid for scripts used with deep zoom images.
• Prefix
  This parameter is replaced with the prefix used for each field image. For example, uS-.
• ImageExt
  This parameter is replaced with the file extension of the field images. For example: .jpg.
• ScanID
  This parameter is replaced with the unique ID of the scan. For example: b239e264-6ad2-4431-8e59-b2fe1a2a744f.
• MPP
  This parameter is replaced with the microns per pixel mapping value. For example: 0.490.
• Date
  This parameter is replaced with the date of the scan. For example: 2017/1/31.
• Time
  This parameter is replaced with the time of the scan. For example: 19:30:21.
• RegionWidth
  This parameter is replaced with the width of the scan region in mm. For example: 8.64.
• RegionHeight
  This parameter is replaced with the height of the scan region in mm. For example: 6.33.
• XCount
  This parameter is replaced with the width of the scan in fields. For example: 40.
• YCount
  This parameter is replaced with the height of the scan in fields. For example: 60.
• TotalCount
  This parameter is replaced with the number of total fields in the scanned region. For example, 2400.

To test the substitution parameters:

1. Create a batch file similar to the following:

   @echo off
   echo Job Path: %1
   pause

2. Select the batch file for the Command.
3. Enter a text description for the Legend.
4. To pass the path name for the job, enter the following into the Parameters for the script:

   %JobPath%