[8.5.5.6 or later]

Job XML substitution in the JSL editor

You can use job XML substitution in the Job Specification Language (JSL) editor to specify an expression for almost any attribute in your Java™ batch job. At run time, the expression resolves to a particular value.

Your Java batch job is defined in an XML file. You can display this file and work with it in the JSL editor. You can add various elements to your job, including step, decision, flow, listener, property, and split elements. To these elements you can add various attributes. The attributes that you can add vary from element to element. For various attributes, you can use job XML substitution.

Elements for job XML substitution

The job XML substitution expression consists of the following elements.
Job operator
Specifies where the value for the expression of an attribute comes from at run time. The valid values are Job Parameters, System Properties, Job Properties, or Partition Plan.
Target
Specifies the name of the property that is used to resolve the expression.
Default value
Specifies a default value to use if at run time the expression is not resolved, for instance, if the property is not found.

Attributes that have job XML substitution for specific elements

Attributes are in the JSL editor on the Details tab of an element. For those attributes that have job XML substitution, the Job XML Substitution button is next to the attribute on the Details tab. The following table lists elements and their attributes where you can launch the job XML substitution dialog.
Table 1. Elements with their attributes that can have job XML substitution
Elements Attributes
Property
  • Value
Flow
  • Next
Next
  • On*
  • To*
End
  • On*
Fail
  • On*
Stop
  • On*
  • Restart
Step
  • Next
  • Start limit
Chunk
  • Item count
  • Retry limit
  • Skip limit
  • Time limit

The Job XML Substitution dialog

When you click the Job XML Substitution button, the Job XML Substitution dialog is displayed. The dialog consists of the following fields:
  • Operator
  • Target
  • Default
  • Value
The Job XML Substitution dialog is pre-populated with valid values. What the values are depends on the job operator that you select for the Operator field.
  • The values for the Job Parameters job operator are obtained from existing runtime configurations.
    Important: To provide a list of valid values for the Job Parameters value, you must have a launch configuration for the associated job.
  • The values for the System Properties job operator are obtained from existing runtime configurations.
    Important: To provide a list of valid values for the System Properties job operator, you must have the following setup:
    • You must have a launch configuration for the associated job.
    • You must have a target Liberty server that is started.
    • If the target Liberty server is a local server, the target Liberty server must have a local connector.
  • The Partition Plan job operator has no values.

The Value field is pre-populated with the current value of a particular attribute. You can edit the value or you can insert a substitution expression by clicking Insert into value.

Icon that indicates the type of topic Reference topic
Timestamp icon Last updated: July 17, 2017 21:58

File name: r_batch_jobxmlsubst.html