job execute

The job execute command runs one or more jobs. After the job runs, the job name and job ID are returned in the format:

<JobName=JobID>

Usage

job execute --j JobNames --f JobPropertyFile --i PollInterval --d ReportDelimiter --n NotificationEmails --o OptionPropertyFile --r ReportTrueOrFalse --t Timeout --w WaitTrueOrFalse --l FileOverrides --v VerboseTrueOrFalse
RequiredArgumentDescription
Yes--j JobNamesSpecifies the name of one or more jobs to run. If you specify more than one job, separate each job with a comma. Jobs run in the order you list them. If the job name contains spaces, enclose the name in quotes.
Tip: If you are unsure of the exact dataflow name you can use the dataflow list command to get a list of the dataflow names.
No--f JobPropertyFileSpecifies the path to a job property file. A job property file contains arguments that control the execution of jobs. For more information, see Using a Job Property File.
No--i PollIntervalWhen --w is set to true, use this option to specify how often to check for completed jobs, in seconds. The default is 5.
No--d ReportDelimiterSets the delimiter character to use in the report output when you also specify --w true or --r true. The default is the pipe character ( | ).
No--n NotificationEmailsSpecifies one or more email addresses to receive notifications about the status of jobs, as configured in Spectrum Management Console. Separate each email address with a comma.
No--o OptionPropertyFile

Specifies a path to a flow options property file. Use a flow options property file to set options for stages in the flow. In order to set flow options using a property file, you must configure the flow to expose stage options at runtime. For more information, see Adding Flow Runtime Options.

For example, a flow options properties file for a flow that contains an Assign GeoTAX Info stage may look like this:

OutputCasing=U
UseStreetLevelMatching=N
TaxKey=T
Database.GTX=gsl
No--r ReportTrueOrFalseSpecify true to return a detailed report about the job. This option only works if you also specify --w true . The report contains the following information:
  • 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

For example,

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

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

No--t TimeoutSets the timeout value for synchronous mode, in seconds. The default is 3600.
No--w WaitTrueOrFalseSpecify true to run jobs one at a time in synchronous mode. Specify false to run all the jobs at the same time. The default is false.
No--l FileOverridesOverrides the input and output file and file format. Separate file and format specifications with a comma. For more information see Overriding Job Files and Overriding File Format.
No--v VerboseTrueOrFalseSpecify true to return information about the arguments used to run the job and other details about the job execution.

Example

This example runs a job named Example1. It returns a comma-delimited report. Note that --w true is specified because this is required to return a report even if only one job is running. The input file specified in the Read from File stage is changed from what is specified in the stage to a different file named CandidateHomes2.csv. Verbose output is also returned.

job execute --j Example1 --w true --d "," --r true --l "Read from File=file:/e:/SampleDataflows/DataFiles/DataFiles/CandidateHomes2.csv” --v true