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

Dimensions Plugin

View this plugin on the Plugins site

dimensionsscm: Dimensions

  • project
    • Type: String
  • credentialsType
    • Type: String
  • canJobDelete (optional)
    • Type: boolean
  • canJobExpand (optional)
    • Type: boolean
  • canJobForce (optional)
    • Type: boolean
  • canJobNoMetadata (optional)
    • Type: boolean
  • canJobNoTouch (optional)
    • Type: boolean
  • canJobRevert (optional)
    • Type: boolean
  • canJobUpdate (optional)
    • Type: boolean
  • certificateAlias (optional)
    • Type: String
  • certificatePassword (optional)
    • Type: String
  • certificatePath (optional)
    • Type: String
  • 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
  • credentialsId (optional)
    • Type: String
  • eol (optional)
    • Type: String
  • folders (optional)
      Array / List of Nested Object
    • value
      • Type: String
  • keystoreDatabase (optional)
    • Type: String
  • keystorePassword (optional)
    • Type: String
  • keystorePath (optional)
    • Type: String
  • keystoreServer (optional)
    • Type: String
  • password (optional)
    • Type: String
  • pathsToExclude (optional)
      Array / List of Nested Object
    • value
      • Type: String
  • permissions (optional)
    • Type: String
  • pluginDatabase (optional)
    • Type: String
  • pluginServer (optional)
    • Type: String
  • 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
  • remoteCertificatePassword (optional)
    • Type: String
  • secureAgentAuth (optional)
    • Type: boolean
  • timeZone (optional)
    • Type: String
  • userDatabase (optional)
    • Type: String
  • userName (optional)
    • Type: String
  • userServer (optional)
    • Type: String
  • webUrl (optional)
    • Type: String

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.