HCL Workload Automation, Version 9.4

Job definition for IBM InfoSphere DataStage jobs

HCL Workload Automation job definition properties for running IBM InfoSphere DataStage jobs.

Table 1 describes the required and optional attributes for IBM InfoSphere DataStage jobs, together with a description of each attribute.

Table 1. Required and optional attributes for the job definition of IBM InfoSphere DataStage jobs.
Attribute	Description/value	Required
Domain	The domain to log on to. See Note.
Server	The server to log on to. See Note.
UserName	The user to use when logging on. See Note.
password	The password of the authorized user. It is encrypted when you submit the job. See Note.
ProjectName	The name of the project containing the job.	✓
JobName	The name of the job to run.	✓ Required if you do not specify the job alias
JobAlias	The alias associated to the job to run.	✓ Required if you do not specify the job name
FileRemotePath	The fully qualified path to the file that contains the parameter values to pass to the job.
ParameterTableValues	The list of parameters to associate to the job.
ForceReset	Specify it to reset the IBM InfoSphere DataStage job before it runs. When an IBM InfoSphere DataStage job has a status of Crashed or Aborted, you must reset it before running the job again.
WarningLimit	Specify the maximum number of warnings that the InfoSphere DataStage job can reach before failing. Specify a value from 1 through 9999999. The default value is 50.
RowLimit	Specify the maximum number of rows to process in an IBM InfoSphere DataStage job before ending. Possible values are from 1 through 9999999. The default value is 1000.
DisableProjectErrorMessageHandler	Specify it to disable any error message handler that was set on a project. A message handler defines rules about how to handle messages generated when a parallel job is running. You can, for example, use a message handler to specify that certain types of message must not be written to the log. You define a project level message handler in the InfoSphere DataStage Administrator, and it applies to all parallel jobs within the specified project.
DisableJobErrorMessageHandler	Specify it to disable any error message handler that was set on a job. From the IBM InfoSphere DataStage Designer, you can specify that any existing handler applies to a specific job. When you compile the job, the handler is included in the job executable as a local handler. In this case, it can be exported to other systems if necessary.
UseDefault	Specify it to use the default values set for the project to generate the operational metadata when the IBM InfoSphere DataStage job runs. It is the default.
GenerateOperationalMetadata	Specify it to generate operational metadata when running the IBM InfoSphere DataStage job. Operational metadata describe the events and processes that occur and the objects that are affected when you run the InfoSphere DataStage job.
DoNotGenerateOperationalMetadata	Specify it to not generate operational metadata when running the IBM InfoSphere DataStage job.

Note: If you do not want to specify this attribute in the XML, you can define it in the DataStageJobExecutor.properties file. You must define all or none of these values otherwise you receive an error message. See Customizing HCL Workload Automation to run IBM InfoSphere DataStage jobs.

The following example shows the job definition of an IBM InfoSphere DataStage job with only the required attributes specified:

NC112206#DS01
 TASK
   <?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl"
   xmlns:jsdldatastage="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdldatastage" 
   name="DATASTAGE">
  <jsdl:application name="datastage">
    <jsdldatastage:datastage>
      <jsdldatastage:DataStageParameters>
         <jsdldatastage:DataStagePanel>
              <jsdldatastage:Logon>
                 <jsdldatastage:Domain>it112206.rome.it.com:9444</jsdldatastage:Domain>
                 <jsdldatastage:Server>it112206</jsdldatastage:Server>
                 <jsdldatastage:UserName>userName</jsdldatastage:UserName>
                 <jsdldatastage:password>password</jsdldatastage:password>
              </jsdldatastage:Logon>
              <jsdldatastage:JobDefinitionGroup>
                <jsdldatastage:ProjectNameGroup>
                  <jsdldatastage:ProjectName>DatastageReport</jsdldatastage:ProjectName>
                </jsdldatastage:ProjectNameGroup>
                    <jsdldatastage:JobNameButtonGroup>
                          <jsdldatastage:JobNameRadioButton>
                              <jsdldatastage:JobName>dsj01_succ</jsdldatastage:JobName>
                          </jsdldatastage:JobNameRadioButton>
                    </jsdldatastage:JobNameButtonGroup>
                      <jsdldatastage:FileRemotePath/>
              </jsdldatastage:JobDefinitionGroup>
              <jsdldatastage:JobExecutionGroup/>
         </jsdldatastage:DataStagePanel>
         <jsdldatastage:OptionsPanel>
                 <jsdldatastage:JobOptionsGroup>
                         <jsdldatastage:WarningLimitButtonGroup>
                                 <jsdldatastage:NoWarningLimitButton/>
                         </jsdldatastage:WarningLimitButtonGroup>
                         <jsdldatastage:RowLimitButtonGroup>
                                 <jsdldatastage:NoRowLimitButton/>
                         </jsdldatastage:RowLimitButtonGroup>
                         <jsdldatastage:OperationalMetadataGroup>
                                 <jsdldatastage:UseDefault/>
                         </jsdldatastage:OperationalMetadataGroup>
                 </jsdldatastage:JobOptionsGroup>
         </jsdldatastage:OptionsPanel>
      </jsdldatastage:DataStageParameters>
    </jsdldatastage:datastage>
  </jsdl:application>
</jsdl:jobDefinition>
 RECOVERY STOP

The following example shows the job definition of an InfoSphere DataStage job with all the attributes specified:

NC112206#DS01
 TASK
    <?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl"
 xmlns:jsdldatastage="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdldatastage" name="DATASTAGE">
  <jsdl:application name="datastage">
   <jsdldatastage:datastage>
       <jsdldatastage:DataStageParameters>
            <jsdldatastage:DataStagePanel>
                <jsdldatastage:Logon>
                      <jsdldatastage:Domain>it112206.rome.it.com:9444</jsdldatastage:Domain>
                      <jsdldatastage:Server>it112206</jsdldatastage:Server>
                      <jsdldatastage:UserName>userName</jsdldatastage:UserName>
                      <jsdldatastage:password>password</jsdldatastage:password>
                 </jsdldatastage:Logon>
                 <jsdldatastage:JobDefinitionGroup>
                      <jsdldatastage:ProjectNameGroup>
                              <jsdldatastage:ProjectName>DatastageReport</jsdldatastage:ProjectName>
                      </jsdldatastage:ProjectNameGroup>
                      <jsdldatastage:JobNameButtonGroup>
                                 <jsdldatastage:JobAliasRadioButton>
                                      <jsdldatastage:JobAlias>dsj01_succ_id</jsdldatastage:JobAlias>
                                 </jsdldatastage:JobAliasRadioButton>
                      </jsdldatastage:JobNameButtonGroup>
                         <jsdldatastage:FileRemotePath>/opt/remoteFile</jsdldatastage:FileRemotePath>
                         <jsdldatastage:ParameterTableValues>
                            <jsdldatastage:ParameterTableValue key="waitTime">10
                               </jsdldatastage:ParameterTableValue>
                            <jsdldatastage:ParameterTableValue key="date">2011-09-14
                               </jsdldatastage:ParameterTableValue>
                         </jsdldatastage:ParameterTableValues>
                      </jsdldatastage:JobDefinitionGroup>
                      <jsdldatastage:JobExecutionGroup>
                              <jsdldatastage:ForceReset/>
                      </jsdldatastage:JobExecutionGroup>
              </jsdldatastage:DataStagePanel>
              <jsdldatastage:OptionsPanel>
                     <jsdldatastage:JobOptionsGroup>
                              <jsdldatastage:WarningLimitButtonGroup>
                                      <jsdldatastage:WarningLimitButton>
                                  <jsdldatastage:WarningLimit>40</jsdldatastage:WarningLimit>
                                      </jsdldatastage:WarningLimitButton>
                              </jsdldatastage:WarningLimitButtonGroup>
                               <jsdldatastage:RowLimitButtonGroup>
                                      <jsdldatastage:RowLimitButton>
                                              <jsdldatastage:RowLimit>250</jsdldatastage:RowLimit>
                                      </jsdldatastage:RowLimitButton>
                               </jsdldatastage:RowLimitButtonGroup>
                              <jsdldatastage:DisableProjectErrorMessageHandler/>
                              <jsdldatastage:DisableJobErrorMessageHandler/>
                               <jsdldatastage:OperationalMetadataGroup>
                                       <jsdldatastage:GenerateOperationalMetadata/>
                               </jsdldatastage:OperationalMetadataGroup>
                      </jsdldatastage:JobOptionsGroup>
            </jsdldatastage:OptionsPanel>
       </jsdldatastage:DataStageParameters>
 </jsdldatastage:datastage>
</jsdl:application>
</jsdl:jobDefinition>
 RECOVERY STOP