> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Team Concert Plugin

View this plugin on the Plugins site

rtcBuild: Step for interacting with EWM (RTC) Build

  • serverURI

    The Jazz Repository connection URI for the EWM (RTC) server.

    • Type: String
  • credentialsId

    Credentials for the build user. Make sure a name and password credential for the Jazz Repository should be configured.

    • Type: String
  • buildTool

    The RTC build toolkit to use when running the tasks. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). If the task is run in an agent, then the build toolkit should be available in the agent, either at the same location as the master build toolkit or an overridden location of your choice.

    • Type: String
  • task

    Request Build

    Request a EWM (RTC) build from the Jenkins pipeline. When a request is successfully created, the step returns the build result UUID in the property "buildResultUUID".


    Wait for Build

    Wait for a EWM (RTC) build result to attain a specific state. Default states to wait for are COMPLETED and INCOMPLETE. If a timeout period is provided, then the task does not return until the specified state is reached or the time period expires. By default, the task will wait indefinitely till the build result reaches the specified states.


    List Logs

    Retrieve the details of the one or more logs from an EWM (RTC) build result. Logs appear in the "Logs" tab of the EWM build result. This task will retrieve the details of the logs whose content is stored in the EWM repository.


    List Artifacts

    Retrieve the details of the artifacts from an EWM (RTC) build result. Artifacts appear in the "Downloads" tab of the EWM build result. This task will retrieve the details of the artifacts whose content is stored in the EWM repository.


    Download Log

    Download a log from an EWM (RTC) build result. You can download a log using the log’s name or content ID. To retrieve the name or contentId of the log, use the "List Logs" task.


    Download Artifact

    Download an artifact from an EWM (RTC) build result. You can download an artifact using the artifact's name or content ID. To retrieve the name or contentId of the artifact, use the "List Artifacts" task.


    Get SCM Snapshot from Build

    Retrieve the Jazz SCM snapshot details for a given EWM (RTC) build result. If the build result has a Jazz SCM snapshot contribution, then the task returns the snapshot's name and UUID. If the build result does not have such a contribution, then the task returns empty values for snapshot name and UUID.

      Nested Object
    • name
      • Type: String
    • addOrOverrideProperties (optional)
      • Type: boolean
    • buildDefinitionId (optional)
      • Type: String
    • buildResultUUID (optional)
      • Type: String
    • buildStates (optional)
      • Type: String
    • componentName (optional)
      • Type: String
    • contentId (optional)
      • Type: String
    • deleteProperties (optional)
      • Type: boolean
    • destinationFileName (optional)
      • Type: String
    • fileName (optional)
      • Type: String
    • fileNameOrPattern (optional)
      • Type: String
    • linkEWMBuild (optional)
      • Type: boolean
    • maxResults (optional)
      • Type: int
    • propertiesToAddOrOverride (optional)
        Array / List of Nested Object
      • propertyName (optional)
        • Type: String
      • propertyValue (optional)
        • Type: String
    • propertiesToDelete (optional)
        Array / List of Nested Object
      • propertyName (optional)
        • Type: String
      • propertyValue (optional)
        • Type: String
    • waitBuildTimeout (optional)
      • Type: int
  • timeout (optional)

    The timeout period in seconds for establishing a connection to the Jazz repository when running this step. Default value is 120 seconds.

    • Type: int

step([$class: 'RTCPostBuildDeliverPublisher']): RTC Post Build Deliver

Perform post build deliver for Rational Team Concert(RTC) SCM configuration in the Jenkins build.

In a Pipeline job where RTC SCM can be called multiple times, post build deliver will be attempted for each invocation of RTC SCM.

Currently, post build deliver is performed only if a build definition is used as the build configuration. The step uses the post build deliver configuration information from the build definition.

  • failOnError

    If post build deliver operation fails, set the build's status to FAILURE.

    • Type: boolean

teamconcert: Team Concert

  • buildType
      Nested Object
    • value
      • Type: String
    • buildDefinition
      • Type: String
    • buildWorkspace
      • Type: String
    • buildSnapshot
      • Type: String
    • buildStream
      • Type: String
    • acceptBeforeLoad (optional)
      • Type: boolean
    • addLinksToWorkItems (optional)
      • Type: boolean
    • buildSnapshotContext (optional)
        Nested Object
      • snapshotOwnerType
        • Type: String
      • processAreaOfOwningStream
        • Type: String
      • owningStream
        • Type: String
      • owningWorkspace
        • Type: String
    • clearLoadDirectory (optional)
      • Type: boolean
    • componentLoadConfig (optional)
      • Type: String
    • componentsToExclude (optional)
      • Type: String
    • createFoldersForComponents (optional)
      • Type: boolean
    • currentSnapshotOwnerType (optional)
      • Type: String
    • customizedSnapshotName (optional)
      • Type: String
    • generateChangelogWithGoodBuild (optional)
      • Type: boolean
    • loadDirectory (optional)
      • Type: String
    • loadPolicy (optional)
      • Type: String
    • overrideDefaultSnapshotName (optional)
      • Type: boolean
    • pathToLoadRuleFile (optional)
      • Type: String
    • pollingOnly (optional)
      • Type: boolean
    • pollingOnlyData (optional)
        Nested Object
      • snapshotUUID
        • Type: String
    • processArea (optional)
      • Type: String
    • useDynamicLoadRules (optional)
      • Type: boolean
  • changelog (optional)
    Enable or Disable 'Include in changelog':

    If 'Include in changelog' is enabled for an SCM source, then when a build occurs, the changes from that SCM source will be included in the changelog.

    If 'Include in changelog' is disabled, then when a build occurs, the changes from this SCM source will not be included in the changelog.

    • Type: boolean
  • overrideConfig (optional)
      Nested Object
    • serverURI
      • Type: String
    • credentialsId
      • Type: String
    • buildTool
      • Type: String
    • avoidUsingToolkit (optional)
      • Type: boolean
    • serverUri (optional)
      • Type: String
    • timeout (optional)
      • Type: int
  • poll (optional)
    Enable or Disable 'Include in polling'

    If 'Include in polling' is enabled or 'Include in changelog' is enabled, then when polling occurs, the job will be started if changes are detected from this SCM source.

    If 'Include in polling' is disabled and 'Include in changelog' is disabled, then when polling occurs, changes that are detected from this repository will be ignored.

    • Type: boolean

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.