P4 Plugin

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.

Table of Contents

P4 Plugin

P4 Plugin

View this plugin on the Plugins site

`p4`: P4 Groovy

credential
- Type: String
workspace
- manualSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    Workspace name
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - spec
    - allwrite
      Type: boolean
    - clobber
      Type: boolean
    - compress
      Type: boolean
    - locked
      Type: boolean
    - modtime
      Type: boolean
    - rmdir
      Type: boolean
    - streamName
      Type: String
    - line
      Line Endings
      Set line-ending character(s) for client text files.
      
      UNIX
      linefeed: UNIX style.
      
      MAC
      carriage return: Macintosh style. (obsolete)
      
      WIN
      carriage return-linefeed: Windows style.
      
      SHARE
      hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
      
      Type: String
    - view
      View
      Lines to map depot files into the client workspace.
      
      The variable ${P4_CLIENT} will expand to the client name, for example, a simple mapping:
      
      //depot/... //${P4_CLIENT}/...
      
      Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
      
      To support migration from the old Perforce plugin, a View Mapping can be inserted from a file in Perforce. Add the depot path to the "View Mappings" field Prefix "@" (this only applies to the "Manual" Workspace behaviour).
      
      Type: String
    - changeView
      Type: String
    - type
      Type
      Type of client: writeable/readonly/partitioned/graph
      
      By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
      
      Type: String
    - serverID
      Type: String
    - backup
      Backup
      Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
      
      Type: boolean
  - cleanup
    - Type: boolean
  - syncID (optional)
    - Type: String
- specFileSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - specPath
    - Type: String
  - syncID (optional)
    - Type: String
- staticSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - syncID (optional)
    - Type: String
- streamSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - streamName
    Stream codeline
    Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
    For example: //stream-depot/main-stream
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String
- templateSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - templateName
    Templace workspace
    Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String

`p4approve`: P4 ApproveImpl Review

credential
- Type: String
review
- Type: String
status
- Type: String
description (optional)
- Type: String

`p4publish`: P4 Publish

credential
- Type: String
workspace
- manualSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    Workspace name
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - spec
    - allwrite
      Type: boolean
    - clobber
      Type: boolean
    - compress
      Type: boolean
    - locked
      Type: boolean
    - modtime
      Type: boolean
    - rmdir
      Type: boolean
    - streamName
      Type: String
    - line
      Line Endings
      Set line-ending character(s) for client text files.
      
      UNIX
      linefeed: UNIX style.
      
      MAC
      carriage return: Macintosh style. (obsolete)
      
      WIN
      carriage return-linefeed: Windows style.
      
      SHARE
      hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
      
      Type: String
    - view
      View
      Lines to map depot files into the client workspace.
      
      The variable ${P4_CLIENT} will expand to the client name, for example, a simple mapping:
      
      //depot/... //${P4_CLIENT}/...
      
      Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
      
      To support migration from the old Perforce plugin, a View Mapping can be inserted from a file in Perforce. Add the depot path to the "View Mappings" field Prefix "@" (this only applies to the "Manual" Workspace behaviour).
      
      Type: String
    - changeView
      Type: String
    - type
      Type
      Type of client: writeable/readonly/partitioned/graph
      
      By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
      
      Type: String
    - serverID
      Type: String
    - backup
      Backup
      Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
      
      Type: boolean
  - cleanup
    - Type: boolean
  - syncID (optional)
    - Type: String
- specFileSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - specPath
    - Type: String
  - syncID (optional)
    - Type: String
- staticSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - syncID (optional)
    - Type: String
- streamSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - streamName
    Stream codeline
    Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
    For example: //stream-depot/main-stream
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String
- templateSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - templateName
    Templace workspace
    Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String
publish
- shelve
  - description
    
    The change description used to shelve or submit the assets to Perforce. ${VAR} variables are expanded base on the system environment.
    - Type: String
  - onlyOnSuccess
    - Type: boolean
  - delete
    - Type: boolean
  - modtime
    - Type: boolean
  - revert
    
    Reverts open files in the pending changelist, but leaves the content in the workspace unchanged ('p4 revert -k')
    - Type: boolean
  - paths (optional)
    - Type: String
- submit
  - description
    
    The change description used to shelve or submit the assets to Perforce. ${VAR} variables are expanded base on the system environment.
    - Type: String
  - onlyOnSuccess
    - Type: boolean
  - delete
    - Type: boolean
  - modtime
    - Type: boolean
  - reopen
    
    Submitted files are reopened, allowing subsequent modification.
    - Type: boolean
  - purge
    
    The Perforce server only stores n number of revisions, where n is a number 1-10 or 16,32,64,128,256,512. Older revisions are then purged as new revisions are added.
    - Type: String
  - paths (optional)
    - Type: String

`p4sync`: P4 Sync

credential
- 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
charset (optional)
- Type: String
depotPath (optional)
- Type: String
format (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
populate (optional)
- autoClean
  - replace
    REPLACE missing/modified files
    Perforce will check out and overwrite any depot files which are either missing from workspace, or have been modified locally.
    - Type: boolean
  - delete
    DELETE generated files
    Perforce will delete any local files that are not in the depot.
    - Type: boolean
  - tidy
    - Type: boolean
  - modtime
    - Type: boolean
  - quiet
    Suppressing info messages
    Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
    - Type: boolean
  - pin
    Pinning a build at Perforce Label
    When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
    
    Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
    - Type: String
  - parallel
    - enable
      Type: boolean
    - path
      Type: String
    - threads
      Type: String
    - minfiles
      Type: String
    - minbytes
      Type: String
- previewOnly
  - quiet
    Suppressing info messages
    Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
    - Type: boolean
  - pin
    - Type: String
- flushOnly
  - quiet
    - Type: boolean
  - pin
    Pinning a build at Perforce Label
    When a build is triggered by Polling, Build Now or an external Action, the workspace will flush only to the specified label or changelist number. Any other specified change or label will be ignored.
    
    Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
    - Type: String
- forceClean
  - have
    - Type: boolean
  - quiet
    Suppressing info messages
    Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
    - Type: boolean
  - pin
    Pinning a build at Perforce Label
    When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
    
    Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
    - Type: String
  - parallel
    - enable
      Type: boolean
    - path
      Type: String
    - threads
      Type: String
    - minfiles
      Type: String
    - minbytes
      Type: String
- graphClean
  - quiet
    Suppressing info messages
    Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
    - Type: boolean
  - pin
    Pinning a build at Perforce Label
    When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
    
    Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
    - Type: String
  - parallel
    - enable
      Type: boolean
    - path
      Type: String
    - threads
      Type: String
    - minfiles
      Type: String
    - minbytes
      Type: String
- syncOnly
  - revert
    - Type: boolean
  - have
    - Type: boolean
  - force
    - Type: boolean
  - modtime
    - Type: boolean
  - quiet
    Suppressing info messages
    Enables the -q flag for all applicable Perforce operations. Summary details will still be displayed.
    - Type: boolean
  - pin
    Pinning a build at Perforce Label
    When a build is triggered by Polling, Build Now or an external Action, the workspace will sync only to the specified label. Any other specified change or label will be ignored.
    
    Supports variable expansion e.g. ${VAR}. If 'now' is used, or a variable that expands to 'now', then the latest change is used (within the scope of the workspace view).
    - Type: String
  - parallel
    - enable
      Type: boolean
    - path
      Type: String
    - threads
      Type: String
    - minfiles
      Type: String
    - minbytes
      Type: String
source (optional)
- depotSource
  - depot
    
    List of one or more depot paths (separated by new lines)
    
    For example //depot/A/...
    //depot/B/...
    //depot/C/file.txt
    - Type: String
- graphSource
  - graph
    - Type: String
- streamSource
  - stream
    - Type: String
- templateSource
  - template
    - Type: String
stream (optional)
- Type: String
template (optional)
- Type: String
workspace (optional)
- manualSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    Workspace name
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - spec
    - allwrite
      Type: boolean
    - clobber
      Type: boolean
    - compress
      Type: boolean
    - locked
      Type: boolean
    - modtime
      Type: boolean
    - rmdir
      Type: boolean
    - streamName
      Type: String
    - line
      Line Endings
      Set line-ending character(s) for client text files.
      
      UNIX
      linefeed: UNIX style.
      
      MAC
      carriage return: Macintosh style. (obsolete)
      
      WIN
      carriage return-linefeed: Windows style.
      
      SHARE
      hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
      
      Type: String
    - view
      View
      Lines to map depot files into the client workspace.
      
      The variable ${P4_CLIENT} will expand to the client name, for example, a simple mapping:
      
      //depot/... //${P4_CLIENT}/...
      
      Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
      
      To support migration from the old Perforce plugin, a View Mapping can be inserted from a file in Perforce. Add the depot path to the "View Mappings" field Prefix "@" (this only applies to the "Manual" Workspace behaviour).
      
      Type: String
    - changeView
      Type: String
    - type
      Type
      Type of client: writeable/readonly/partitioned/graph
      
      By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
      
      Type: String
    - serverID
      Type: String
    - backup
      Backup
      Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
      
      Type: boolean
  - cleanup
    - Type: boolean
  - syncID (optional)
    - Type: String
- specFileSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - specPath
    - Type: String
  - syncID (optional)
    - Type: String
- staticSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - syncID (optional)
    - Type: String
- streamSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - streamName
    Stream codeline
    Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
    For example: //stream-depot/main-stream
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String
- templateSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - templateName
    Templace workspace
    Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String

`p4tag`: P4 Tag

rawLabelName
- Type: String
rawLabelDesc
- Type: String

`p4unshelve`: P4 Unshelve

credential
- Type: String
workspace
- manualSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    Workspace name
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - spec
    - allwrite
      Type: boolean
    - clobber
      Type: boolean
    - compress
      Type: boolean
    - locked
      Type: boolean
    - modtime
      Type: boolean
    - rmdir
      Type: boolean
    - streamName
      Type: String
    - line
      Line Endings
      Set line-ending character(s) for client text files.
      
      UNIX
      linefeed: UNIX style.
      
      MAC
      carriage return: Macintosh style. (obsolete)
      
      WIN
      carriage return-linefeed: Windows style.
      
      SHARE
      hybrid: writes UNIX style but reads UNIX, Mac or Windows style.
      
      Type: String
    - view
      View
      Lines to map depot files into the client workspace.
      
      The variable ${P4_CLIENT} will expand to the client name, for example, a simple mapping:
      
      //depot/... //${P4_CLIENT}/...
      
      Maps files in the depot to files in your client workspace. Defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. See 'p4 help views' for view syntax. A new view takes effect on the next 'p4 sync'.
      
      To support migration from the old Perforce plugin, a View Mapping can be inserted from a file in Perforce. Add the depot path to the "View Mappings" field Prefix "@" (this only applies to the "Manual" Workspace behaviour).
      
      Type: String
    - changeView
      Type: String
    - type
      Type
      Type of client: writeable/readonly/partitioned/graph
      
      By default all clients are 'writeable', certain clients are short lived and perform long sync and build cycles. Over time these build clients can fragment the 'db.have' table which is used to track what files a client has synced. Setting a type of 'readonly' gives the client its own personal 'db.have' database table. A 'readonly' client cannot 'edit' or 'submit' files, however for build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the 'db.have' table. This option requires that an administrator has first configured the 'client.readonly.dir' setting. If it is necessary to submit changes as part of your build, you may specify a 'partitioned' client: like a 'reaonly' client, this type also has a separate 'db.have' table under the 'client.readonly.dir' directory, but allows journalled 'edit' and 'submit' of files.
      
      Type: String
    - serverID
      Type: String
    - backup
      Backup
      Client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
      
      Type: boolean
  - cleanup
    - Type: boolean
  - syncID (optional)
    - Type: String
- specFileSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of the Perforce workspace to be used as the Jenkins build workspace. If the workspace does not yet exist, the configuration will be saved in Jenkins; the workspace is created only when it is to be used. If the workspace exists and you are connected to a Perforce server the auto-text fill should list suitable workspaces; updates are only applied when the workspace is used.
    - Type: String
  - specPath
    - Type: String
  - syncID (optional)
    - Type: String
- staticSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - name
    An existing workspace
    Specify the name of an existing workspace in Perforce to be used as the Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - syncID (optional)
    - Type: String
- streamSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - streamName
    Stream codeline
    Specify the full Perforce depot path for the given stream. If connected to a Perforce server the auto-text fill should list possible streams.
    For example: //stream-depot/main-stream
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String
- templateSpec
  - charset
    P4CHARSET
    The character set used by Jenkins when syncing files from the Perforce server. This should be set to 'none' unless connected to a Unicode enabled Perforce server.
    - Type: String
  - pinHost
    - Type: boolean
  - templateName
    Templace workspace
    Specify the name of an existing workspace in Perforce used to create or update a Jenkins build workspace. If connected to a Perforce server the auto-text fill should list suitable workspaces
    - Type: String
  - format
    Workspace name formatter
    Jenklin slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables: (at least one variable must be used)
    
    Variables can be taken from the Jenkins Environment or Parameterized builds
    - Type: String
  - syncID (optional)
    - Type: String
shelf
- Type: String
resolve
- Type: String
tidy
- Type: boolean
ignoreEmpty
- Type: boolean

`cleanup`: Perforce: Cleanup

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

User Handbook

Tutorials

Resources

P4 Plugin

`p4`: P4 Groovy

`p4approve`: P4 ApproveImpl Review

`p4publish`: P4 Publish

`p4sync`: P4 Sync

`p4tag`: P4 Tag

`p4unshelve`: P4 Unshelve

`cleanup`: Perforce: Cleanup

Resources

Project

Community

Other

User Handbook

Tutorials

Resources

P4 Plugin

p4: P4 Groovy

p4approve: P4 ApproveImpl Review

p4publish: P4 Publish

p4sync: P4 Sync

p4tag: P4 Tag

p4unshelve: P4 Unshelve

cleanup: Perforce: Cleanup

`p4`: P4 Groovy

`p4approve`: P4 ApproveImpl Review

`p4publish`: P4 Publish

`p4sync`: P4 Sync

`p4tag`: P4 Tag

`p4unshelve`: P4 Unshelve

`cleanup`: Perforce: Cleanup