jgetfile, jtool getfile

You can use jgetfile to retrieve a file from the RunMyJobs server or a Platform Agent.

Note: For installation instructions, see jtool.

Syntax

jgetfile  [-h|-?|-help] [-l <loglevel>] [-f <logfile>] -j|-job-context|<connfile> -o|-output <output-file>
          -s|-serverpath <path> [-a|-append] [-direct only|fallback|never] [-r|-retries <retries>]
          [-d|-delay <delay>] [-retry-server ...] [-retry-other ...] [-[no]compression] [-[no]verbose]
          [-[no]protect] [-tempdir <dir>]

Specifying Files

The -s switch accepts the following syntax.

• "<step>, Job <x>:<file>": Retrieve the file named <file> from Chain Process number <x> of the Step named <step> in the Chain.
• "<jobid>:<file>": Retrieve the output file named <file> from the process with ID <jobid>.
• "parent:<file>": Retrieve the output file named <file> from the parent.
• "/document/<full_path>": Retrieve the contents of the document using the document's full path.
• "/event/<EventId>": Fetch the file content that raised <EventId>.
• "/job/<jobid>/<file>": Equivalent to <jobid>:<file>.
• "/library/<Partition>.<Name>/resource/<path>": Download an individual resource (file) from one of the sources in the library.
• "/library/<Partition>.<Name>/jar/<Name>": Download an entire .jar file from the library.
• "/processserver/<Partition>.<Name>/<path>": Fetch the content of <path> on the Process Server <Partition>.<Name>. This works for Platform Agent Process Servers. The <path> must either be inside DataRootDirectory, or in a list of allowed sources defined on the Platform Agent itself (net configuration file server_root).

Note: parent does not work in Chains because as the parent of a Chain Process is always a Step, which usually does not produce output.

TLS Arguments

The arguments require the -protect argument.

Securing Connections

If you transfer files between Platform Agents and wish to use the parameters, make sure the Platform Agents and RunMyJobs server are configured for secure communication. When you transfer files between the Platform Agent and the central server in on-site environments, you have to configure the central server for secure communication.

For more information, see:

• Securing Platform Agent Connections
• Securing Central Redwood Server Connections

Proxy Setting Environment Variables

The following environment variables are used to retrieve proxy server connection details.

• HTTP_PROXY: The URL of the proxy server. For example: https://proxy.example.com:3128.
• PROXY_USER: The user for the proxy server. This value is ignored if HTTP_PROXY is not set.
• PROXY_PASSWORD: The password for the proxy user. This value is ignored if HTTP_PROXY is not set.
• NO_PROXY: Enforces a direct connection.

Configuration

Make sure the RunMyJobs server is accessible from the host where jgetfile is run. If you want to use the -protect switch, you must configure the Platform Agent HTTP servers to use HTTPS and trust one anothers' certificates. If you have an on-site installation, make sure the central RunMyJobs server also trusts the certificate.

Process Server Parameters and Environment Variables

Use the ${<name>} syntax to specify Process Server parameter values. Note that if you shell interprets ${<val>}, you must escape the expression according to your shell. The special ${LISTALL} variable contains a list of all environment variable and Process Server parameters. Any Process Server parameter that has remote set to true can be accessed in this way.

This can be used outside of job-context, however, only environment variables are available.

Note: jgefile expects a correctly escaped environment variable name for your shell. Make sure the shell does not evaluate the variable. See the examples below.

Examples

This example retrieves a file named stdout.log from the first Chain Process of Step 2 in a Chain.

jtool getfile -j -o stdout.new -s "Step 2, Job 1:stdout.log"

This example retrieves the stdout.log file from the process with ID 123.

jtool getfile -j -o stdout.new -s 123:stdout.log

This example retrieves the output file from the parent job.

jtool getfile -j -o stdout.new -s parent:stdout.log

This example retrieves several files from different Chain Processes in the same Chain and appends them to one big file.

jtool getfile -j -o stdout.new -s "Step 1, Job 1:stdout.log"
jtool getfile -j -a -o stdout.new -s "Step 1, Job 2:stdout.log"
jtool getfile -j -a -o stdout.new -s "Step 2, Job 1:stdout.log"
jtool getfile -j -a -o stdout.new -s "Step 2, Job 2:stdout.log"
jtool getfile -j -a -o stdout.new -s "Step 2, Job 3:stdout.log"

This example retrieves the file with the specified path.

jgetfile -j -o document.txt -s '/document/doc:MyPartition:/MyPartition2.SomeApplication/A_Document.txt'

This example retrieves the file that triggered the file event with raise sequence 1234.

jgetfile -j -o input.txt -s "/event/1234"

This example retrieves the class file for the class com.redwood.scheduler.custom.functions.Utilities in library MyPartition.Custom_Utilities.

jgetfile -j -o Utilities.class -s "/library/MyPartition.Custom_Utilities/resource/com/redwood/scheduler/custom/functions/Utilities.class"

This example retrieves the .jar file named Myjar with DescriptionImport_jar.jar (the filename of the uploaded file) in library MyPartition.Custom_Utilities.

jgetfile -j -o Myjar.jar -s "/library/MyPartition.Custom_Utilities/jar/Myjar"

This example retrieves a file from Process Server myPartition.MSLN_UNIXS7 and puts it into a directory named after the InputDirectory Process Server parameter. The file server_root contains this line: c:\\redwood.

jgetfile -j -o '${InputDirectory}'/document.txt -s "/processserver/myPartition.MSLN_WINS7/C:\redwood\myfile.txt"

An alternative to the above example, with forward slashes as path separator. This will work on Windows.

jgetfile -j -o ${BustWatchDirectory}\document.txt -s "/processserver/myPartition.MSLN_WINS7/C:/redwood/myfile.txt"

jgetfile -j -o ${BustWatchDirectory}\document.txt -s "/processserver/myPartition.MSLN_UNIXS7//redwood/myfile.txt"