The JIRA Perforce plugin is configured through a property file: perforce-jira-plugin.properties. The following table details the settings within the file, how they affect the JIRA-Perforce integration and the equivalent Perforce environment variable (if one exists). Some of the more advanced settings include further notes below.
| Property File Setting | Perforce Variable |
Use |
|---|---|---|
| p4.executable | full path to the Perforce executable | |
| p4.port | P4PORT | host and port number of the Perforce server or proxy with which the JIRA Perforce plugin communicates |
| p4.user | P4USER | user that the JIRA Perforce plugin connects to the Perforce server as |
| p4.password | P4PASSWD | password for the user specified in the p4.user setting |
| p4.client | P4CLIENT | name of the client workspace |
| p4.charset | P4CHARSET | character set used for translation of unicode files |
| p4.ticketfile | P4TICKETS | location of the p4 tickets used for ticket based authentication - overrides p4.passwd setting if set |
| p4.sysroot | System root for a windows machine. Must be set if running JIRA on Windows. | |
| p4.sysdrive |
System drive for a windows machine. Must be set if running JIRA on Windows. | |
| change.indexing | Specify whether every change in Perforce will be indexed and linked to any referenced JIRA issue keys |
|
| change.maxretrieved | Number of change lists, and number of P4 jobs, that will be retrieved from the Perforce server at any one time |
|
| change.maxfileentries | The number of file entries to display for each change. -1 means "unlimited". If the actual number of file entries exceeds this, a "Showing X of Y files" link will be generated. Applies to both the Changes and the Jobs tabs. | |
| job.linking | Specify whether Perforce jobs are linked to JIRA issues |
|
| job.show.previous | Specify whether previous job associations are displayed (after the JIRA issue has been moved) |
|
| jira.customfield.name.<your_customfieldname> | Mapping of JIRA custom field to Perforce job field through JIRA custom field name |
|
| jira.customfield.id.<your_customfieldId> | Mapping of JIRA custom field to Perforce job field through JIRA custom field id |
|
| p4.logfile | Location to where logfile is written on disk |
|
| p4.log_level | Specify target of logfile (none, log to file only or log to file and stdout) | |
| p4.debug_level | Verbosity of logfile - none, error, warning, notice, verbose |
|
| p4template.jobLink | Job link template (see details in the parent page) |
|
| p4template.changeLink | Change link template (see details in the parent page) |
|
| p4template.changeFileSubsetLink | Link template for changes with not all files shown (see details in the parent page) |
|
| p4template.fileLink | File entry link template (see details in the parent page) |
|
| p4template.revisionLink | File entry revision link template (see details in the parent page) |
|
| p4template.revisionDeleteLink | Deleted file entry link template (see details in the parent page) |
|
| p4template.diffLink | File entry diff link template (see details in the parent page) |
p4.charset
This setting only affects files of type Unicode; non-unicode files are never translated.
The p4.charset must only be set if the Perforce server is running in Unicode (internationalized) mode.
If p4.charset is set, but the server is not operating in Unicode (internationalized) mode, the server returns the following error message:
- Unicode clients require a unicode enabled server.
If p4.charset is unset, but the server is operating in Unicode mode, client programs return the following error message:
- Unicode server permits only unicode enabled clients.
For more about Unicode mode, including settings of p4.charset for various UTF-8 and UTF-16 character sets, with and without byte-order marks, see the Internationalization Notes.
p4.ticketfile
The p4.ticketfile setting should only be configured for Perforce servers using Ticket-Based Authentication. This setting over-rides any setting for p4.password.
In order to enable the JIRA Perforce plugin to access the Perforce server through Ticket-Based authentication, specify the name of the file to which the p4 tickets are stored (as defined in the P4TICKETS environment variable) in p4.ticketfile. This file must be located on the classpath so as JIRA can access it. The plugin will retrieve the ticket number associated with the user as specified in p4.user.The user must have already logged into the Perforce server with the p4 login command.
change.maxretrieved
The change.maxretrieved setting specifies the number of change lists retrieved from the the Perforce server at any one time. It is recommended to reduce this number if the following error is encountered:
- Too many rows scanned
jira.customfield.name.<NAME> AND jira.customfield.id.<ID>
These settings provide a mapping for the specifed JIRA custom fields (by name or ID) to Perforce job fields (as defined in the Perforce job specification). When a Perforce job is created through JIRA, the Perforce job fields are populated with the values from the associated JIRA custom fields.
On Windows
The p4.sysroot and p4.sysdrive variables must be specified if you are running JIRA on Windows.