Job Tokens
Tokens for Job Actions that Transfer Files
The tokens described below are available for configuring Job actions that transfer files.
-
For each Job action, tokens that specify a filename or path are generated for each new or updated file in the scanned directory.
-
For sample expressions using these tokens, see Entering Expressions for Destination Files.
| Token | Description |
|---|---|
| $FILENAME$ | The name of the file on the scanned server.myfile.txt |
| $JOB_ID$ | A unique numeric ID assigned to each Job. |
| $JOB_NAME$ | The descriptive Name specified in the New/Edit Job page. |
| $RELATIVE_FILE_NAME$ | The path and filename of the file relative to the scanned directory on the scanned server.subdir/myfile.txt |
| $SCANNED_PATH$ | The fully-qualified scanned directory on the scanned server. (This is the location specified under Source Files > Directory in the Job definition)./home/scanfiles |
More Information
Tokens for Job Actions that Execute Commands
Tokens can be used to pass arguments to commands that you specify for Job actions. You can type token values or select tokens using the Tokens buttons.
The tokens available depend on whether Options is set to Run once or Run for each file.
For sample commands using tokens, see Sample Commands for Job Actions.
Run once
The following tokens are available when Options is set to Run once.
| Token | Description |
|---|---|
| DATE | The date of the action on the system running Gateway Administrator. |
| JOB_ID | A unique numeric ID assigned to each Job. |
| JOB_NAME | The descriptive Name specified in the New/Edit Job page. |
| RELATIVE_FILE_LIST | A list of files – including relative path information – that meet the scan criteria. |
| TIME | The time of the action on the system running Gateway Administrator. |
| TIMEZONE | The time zone of the system running Gateway Administrator |
Run for each file
The following tokens are available when Options is set to Run for each file.
| Token | Description |
|---|---|
| DATE | The date of the action on the system running Gateway Administrator. |
| FILENAME | The name of the file on the scanned server.myfile.txt |
| FILE_PATH | The fully qualified path to the file on the scanned server – without the filename./scandir/subdir/ |
| FILE_SIZE | The file size (in bytes). |
| FULL_PATH | The fully qualified path – including the filename – of the file on the scanned server./scandir/subdir/myfile.txt |
| JOB_ID | A unique numeric ID assigned to each Job. |
| JOB_NAME | The descriptive Name specified in the New/Edit Job page. |
| RELATIVE_FILE_NAME | The path and filename of the file relative to the specified scan directory on the scanned server.subdir/myfile.txt |
| TIME | The time of the action on the system running Gateway Administrator. |
| TIMEZONE | The time zone of the system running Gateway Administrator. |
More Information