Using a Job Property File - 23.1

Spectrum Dataflow Designer Guide

Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Dataflow Designer Guide
First publish date
2007
Last updated
2024-05-09
Published on
2024-05-09T23:01:03.226155

A job property file contains arguments that control the execution of jobs when you use the job executor or the Administration Utility to run a job. Use a job property file if you want to reuse arguments by specifying a single argument at the command line (-f) rather than specifying each argument individually at the command line.

To create a property file, create a text file with one argument on each line.

d %
h spectrum.mydomain.com
i 30
j validateAddressJob1
u user
p password
s 8888
t 9999
w true

The job property file can contain these arguments:

Required Argument Description
No ? Prints usage information.
No d delimiter Sets instance/status delimiter. This appears in synchronous output only.
No e Use a secure HTTPS connection for communication with the Spectrum Technology Platform server.
No h hostname Specifies the name or IP address of the Spectrum Technology Platform server.
No i pollinterval Specifies how often to check for completed jobs, in seconds. This applies only in synchronous mode.
Yes j jobname A comma-separated list of jobs to run. Job names are case-sensitive. Jobs are started in the order listed.
No n emaillist Specifies a comma-separated list of additional email addresses for configured job notifications.
Yes p password The password of the user.
No r

Returns a delimited list with this information about the job written to standard output:

  • Position 1 - Name of job
  • Position 2 - Job process ID
  • Position 3 - Status
  • Position 4 - Start Date - Time (MM/DD/YYYY HH:MM:SS)
  • Position 5 - End Date - Time (MM/DD/YYYY HH:MM:SS)
  • Position 6 - Number of successful records
  • Position 7 - Number of failed records
  • Position 8 - Number of malformed records
  • Position 9 - Currently unused

The information is delimited using the delimiter specified in the -d argument. For example:

MySimpleJob|4|succeeded|04/09/2019 14:50:47|04/09/2019 14:50:47|100|0|0|

No s port The socket (port) on which the Spectrum Technology Platform server is running. The default is 8080.
No t timeout Sets the timeout (in seconds) for synchronous mode. The default is 3600. The maximum is 2147483. This is a global, aggregate timeout and represents the maximum time to wait for all spawned jobs to complete.
Yes u username The login name of the user.
No v Return verbose output.
No w Specifies to wait for jobs to complete in a synchronous mode.

Using Both Command Line Arguments and a Property File

A combination of both command-line entry and property file entry is also valid. For example:

java -jar jobexecutor.jar -f /dcg/job.properties -j job1

In this case command line arguments take precedence over arguments specified in the properties file. In the above example, the job job1 would take precedence over a job specified in the properties file.