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.

$class: 'RTCScm'

  • $class: 'RTCScm'
    • overrideGlobal : boolean

      The build toolkit location and Jazz Repository connection can be defined globally or overridden. If not defined globally, it must be overridden.

    • buildTool : String

      The RTC build toolkit to use when performing builds. The toolkits available are defined in the system configuration (with the other tools like Ant and Java). The build toolkit is also necessary on the Master for polling and validating the job configuration unless the "Avoid using build toolkit on Master" option is enabled.

    • serverURI : String

      The Jazz Repository connection URI for the Rational Team Concert (RTC) server

    • timeout : int

      The timeout period in seconds for Jazz repository requests made during the build.

    • userId : String

      The build user id. Either credentials or a user id and password information should be supplied.

    • password

      The Jazz Repository password for the build user. The use of a password is not secure, it can be easily discovered by anyone with access to this page. Credentials, a password file or a password should be supplied.

      • Type: class hudson.util.Secret
    • passwordFile : String

      The path to the file containing the obfuscated Jazz Repository password for the build user. Credentials, a password file or a password should be supplied.

    • credentialsId : String

      Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.

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

      Where possible avoid using the Build toolkit when performing tasks on the Master. This is still in the experimental stage. You will require an RTC 5.0 server which provides some of the services used.

      The Build toolkit will not be used when polling RTC and terminating the RTC Build. The toolkit is still required though. It is used for other configuration tasks on the Master (i.e. validating the connection to RTC, the build definition or workspace). It is also used for checkout tasks typically performed on agent nodes.

  • 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.