Build Scheduling

The following sections describe how to manage the scheduling for automatic submission of the build definition. Each section describes an element that can be specified within the createBuildDefinition or updateBuildDefinition element. These elements are not required and may not be applicable to the type of definition you are creating.

Refer to Build Reference to determine which elements are valid for the build you are defining.

buildSchedule Element

Code one or more buildSchedule elements to configure scheduling for the build definition using the Jazz scheduler. The following table describes the attributes for the buildSchedule element:

Attribute Required Description
hour No

Specify the time to submit the build. The hour must be an integer in the range 0 to 23. Either a time (hour and minute) or an interval is required.

minute No Specify the time to submit the build. The minute must be an integer in the range 0 to 59. Either a time (hour and minute) or an interval is required.
interval No

Specify an integer build submit interval in minutes. The build will be submitted at the end of the interval, continuously throughout the day. Either a time (hour and minute) or an interval is required.

sun No Specify true if the schedule item is enabled on Sunday. The schedule must be enabled at least one day during the week. The default is false.
mon No Specify true if the schedule item is enabled on Monday. The schedule must be enabled at least one day during the week. The default is false.
tue No Specify true if the schedule item is enabled on Tuesday. The schedule must be enabled at least one day during the week. The default is false.
wed No Specify true if the schedule item is enabled on Wednesday. The schedule must be enabled at least one day during the week. The default is false.
thu No Specify true if the schedule item is enabled on Thursday. The schedule must be enabled at least one day during the week. The default is false.
fri No Specify true if the schedule item is enabled on Friday. The schedule must be enabled at least one day during the week. The default is false.
sat No Specify true if the schedule item is enabled on Saturday. The schedule must be enabled at least one day during the week. The default is false.

scheduleProperty Element

One or more scheduleProperty elements can be specified within a buildSchedule element to define build properties associated with the schedule item. For example:

<xt:buildSchedule hour="02" minute="30" mon="true">
    <xt:scheduleProperty
      name="monday"
      value="this is monday"
      description="Property for Monday"
      kind="com.ibm.team.build.property.string"
    />
  </xt:buildSchedule>

The monday property will be available to the build when the schedule item submits the build. The following table describes the valid values for the scheduleProperty element attributes:

Attribute Required Description
name Yes Name of the build property. The name can not be another build property or contain white space. A build property can be specified as part of the name, but it must be present and resolvable prior to the invocation of this task.
value Yes

Value of the build property. The value for the property may be specified in nested text format. For example:

<xt:scheduleProperty name="name">value</xt:scheduleProperty>
asis No An "asis" property value means that the value is already in its resolved form. For example, if a build property specifies a workspace name, the unresolved form of the value is the name of the workspace and the resolved form of the value is a workspace UUID string. When the asis attribute is set to true, it signifies that the workspace value is already in UUID form. Valid values are true and false. The default is false.

description

No

Description of the build property.

genericEditAllowed

No

Specify true to allow this property to be altered during processing. Valid values are true and false. The default is true.

kind

No

The type of build property. The default data type is string. Valid values are:
Data type Value to specify
Boolean com.ibm.team.build.property.boolean
Build com.ibm.team.build.property.build
Build Result com.ibm.team.build.property.buildresult
Component com.ibm.team.build.property.component
Dataset com.ibm.team.build.property.dataset
File Item com.ibm.team.build.property.fileitem
Integer com.ibm.team.build.property.integer
Language com.ibm.team.build.property.language
Library List com.ibm.team.build.property.librarylist
Search Path com.ibm.team.build.property.searchpath
Stream com.ibm.team.build.property.stream
String com.ibm.team.build.property.string
String List com.ibm.team.build.property.stringlist
String Pair com.ibm.team.build.property.stringpair
String Pair List com.ibm.team.build.property.stringpairlist
Timestamp com.ibm.team.build.property.timestamp
Translator com.ibm.team.build.property.translator
Work Item com.ibm.team.build.property.workitem
Workspace com.ibm.team.build.property.workspace

label

No

Internal use attribute of type string. Do not specify this attribute. The default is null.

override

No

Whether or not this property overrides a Team Build property value. Valid values are true and false. The default is false. Code true when specifying a schedule override for a Team Build property.

required

No

Internal use attribute of type boolean. Do not specify this attribute. The default is false.

scheduleOverride

No

Whether or not this property is a schedule override. Valid values are true and false. The default is true.

wellKnown

No

Internal use attribute of type boolean. Do not specify this attribute. The default is false.

teamBuildProperty Element

One or more teamBuildProperty elements can be specified within a buildSchedule element to define Team Build properties associated with the schedule item. For example:

<xt:buildSchedule hour="02" minute="30" mon="true">
    <xt:teamBuildProperty name="team.deploy.common.action" value="loadMain"/>
</xt:buildSchedule>

The team.deploy.common.action property will be available to the build when the schedule item submits the build. The following table describes the valid values for teamBuildProperty element attributes:

Attribute Required Description

name

Yes Name of the build property. Valid names are described in Team Build Properties.
value Yes
Value of the build property. Valid values and restrictions are described in Team Build Properties. Restrictions on the valid values are noted in the value column. The restrictions noted are as follows:
Restriction Description
boolean This is a boolean value which must be specified as either true or false.
integer This must be an integer value.
true/false This is a boolean value which must be specified as either true or false.
value list One of the listed values must be specified. For example: ALWAYS, NO_ERRORS, or NO_WARNINGS.

asis

No

Valid values are true and false. The default is false. Specifying this attribute will control how the property is resolved.

description

No

This attribute is ignored.

genericEditAllowed

No

This attribute is ignored.

kind

No

This attribute is ignored.

label

No

This attribute is ignored.

override

No

This attribute is ignored.

required

No

This attribute is ignored.

scheduleOverride

No

This attribute is ignored.

wellKnown

No

This attribute is ignored.


video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki