Jenkins Get Job Activity¶

Introduction¶

A Jenkins Get Job activity, using its Jenkins connection, retrieves a job from a Jenkins automation server and is intended to be used as a source to provide data in an operation.

Create a Jenkins Get Job Activity¶

An instance of an activity is created from a connection using an activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing activity can be edited from these locations:

The design canvas (see Component Actions Menu in Design Canvas).
The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure a Jenkins Get Job Activity¶

Follow these steps to configure a Jenkins Get Job activity:

Step 1: Enter a Name and Specify a Job
Provide a name for the activity and specify a job.
Step 2: Review the Data Schemas
Any request or response schemas are displayed.

Step 1: Enter a Name and Specify a Job¶

In this step, provide a name for the activity and specify a job. Each user interface element of this step is described below.

The interface used in this step of the configuration of a Jenkins Get Job activity depends on the Provide Job Name option selected:

Provide Job Name Using Object List: This option populates a list of jobs from the Jenkins instance.
Provide Job URL Using Text Field: For this option, you will manually enter the URL of the job.
Provide Parameters Using Request Transformation: For this option, you provide the data for the job in a request transformation.

Provide Job Name Using Object List¶

If Provide Job Name Using Object List is selected for Provide Job Name, this interface is presented:

Jenkins Get Job Activity Configuration Step 1 Object

Name: Enter a name to identify the activity. The name must be unique for each Jenkins Get Job activity and must not contain forward slashes / or colons :.
Provide Job Name: Select one of these options for providing the name of the job:
- Provide Job Name Using Object List: This option populates a list of jobs from the Jenkins instance.
- Provide Job URL Using Text Field: For this option, you will manually enter the URL of the job.
- Provide Parameters Using Request Transformation: For this option, you provide the data for the job in a request transformation.
Select an Object: This section displays a table of jobs available in the Jenkins endpoint. Within the table, click anywhere on a row to select a job. Only one job can be selected.
- Selected Object: After a job is selected, it is listed here.
Continue on Error: This setting is functional only when using the Provide Parameters Using Request Transformation option.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Provide Job URL Using Text Field¶

If Provide Job URL Using Text Field is selected for Provide Job Name, this interface is presented:

Jenkins Get Job Activity Configuration Step 1 Text

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Name: Enter a name to identify the activity. The name must be unique for each Jenkins Get Job activity and must not contain forward slashes / or colons :.
Provide Job Name: Select one of these options for providing the name of the job:
- Provide Job Name Using Object List: This option populates a list of jobs from the Jenkins instance.
- Provide Job URL Using Text Field: For this option, you will manually enter the URL of the job.
- Provide Parameters Using Request Transformation: For this option, you provide the data for the job in a request transformation.
Job URL: Enter the job URL.
Continue on Error: This setting is functional only when using the Provide Parameters Using Request Transformation option.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Provide Parameters Using Request Transformation¶

If Provide Parameters Using Request Transformation is selected for Provide Job Name, this interface is presented:

Jenkins Get Job Activity Configuration Step 1 Schema

Name: Enter a name to identify the activity. The name must be unique for each Jenkins Get Job activity and must not contain forward slashes / or colons :.
Provide Job Name: Select one of these options for providing the name of the job:
- Provide Job Name Using Object List: This option populates a list of jobs from the Jenkins instance.
- Provide Job URL Using Text Field: For this option, you will manually enter the URL of the job.
- Provide Parameters Using Request Transformation: For this option, you provide the data for the job in a request transformation.
Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas¶

Any request or response schemas are displayed. Each user interface element of this step is described below.

Jenkins Get Job Activity Configuration Step 2

Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

Note

Data supplied in a transformation takes precedence over the activity configuration.

The Jenkins connector uses the Jenkins Remote Access API. The request and response schemas are static and are provided internally by the connector itself.

The Get Job activity uses XML in its request schema and returns JSON in its response schema.

The request and response data schemas consist of these nodes and fields:

Request Schema Node/Field	Description
`jobProperties`	Node representing the job
`jobUrl`	The job URL

Response Schema Node/Field	Description
`getJobResponse`	Node representing the response from Jenkins
`response`	Node representing the response
`item`	Node representing each job returned
`job`	Node representing the job
`_class`	String containing the job's class
`displayName`	String containing the job's display name
`fullDisplayName`	String containing the job's full display name
`url`	String containing the job's URL
`builds`	Node representing the job's builds
`item`	Node representing each property for the build
`_class`	String containing the build's class
`duration`	The duration (in milliseconds) of the build
`id`	String containing the build ID
`number`	The build number
`result`	The result of the build, either `Success` or `Failure`
`url`	String containing the build URL
`healthReport`	Node representing the job's health report
`item`	Node representing each property for the health report
`description`	String containing a description of the job's health report
`score`	The job's health report score
`lastBuild`	Node representing the job's last build
`_class`	String containing the build's class
`number`	The build number
`url`	String containing the build URL
`lastCompletedBuild`	Node representing the last completed build
`_class`	String containing the build's class
`number`	The build number
`url`	String containing the build URL
`lastFailedBuild`	Node representing the last failed build
`_class`	String containing the build's class
`number`	The build number
`url`	String containing the build URL
`lastStableBuild`	Node representing the last stable build
`_class`	String containing the build's class
`number`	The build number
`url`	String containing the build URL
`lastSuccessfulBuild`	Node representing the last successful build
`_class`	String containing the build's class
`number`	The build number
`url`	String containing the build URL
`property`	Node representing the job property
`item`	Node representing each job property
`_class`	String containing the job's class
`parameterDefinitions`	Node representing the parameter definitions
`item`	Node representing each job parameter definition
`_class`	Field containing the parameter definition class
`defaultParameterValue`	Node representing the default parameter value
`_class`	String containing the class for the default parameter value
`name`	String containing the name of the parameter value
`type`	String containing the type of parameter value
`errors`	Node representing any errors
`item`	Node representing each error (if applicable)
`message`	String containing the response message for the job
`status`	HTTP response status code returned
`url`	String containing the job URL

Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Jenkins endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a Jenkins Get Job activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Jenkins Get Job activities can be used as a source with these operation patterns:

Transformation Pattern
Two-target Archive Pattern (as the first source only)
Two-target HTTP Archive Pattern (as the first source only)
Two-transformation Pattern (as the first or second source)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.