Description

The clone property file allows customized control over clone operations. This page describes how specific behaviors can be controlled. This page focuses on conditioning and control. See Setting fields for information on generally updating field values.

Property files are lines of key/value pairs that map keys to values - see property file syntax. The keys recognized by clone operations are defined below.

Start with Getting started with customization before diving into the details here.

Mapping keys

Mappings keys are dot-separated property names: prefix.class.qualifier1.qualifier2.qualifier3.qualifier4.

prefix - this is the profilePrefix or blank (default prefix) from the clone operation.
class - determines what mapping is being defined - like project, type, and so on.
qualifier(s)
- one or more (dot separated) qualifiers - the number of qualifiers is dependent on the class
- generic qualifier (*) matches any value of that position

For example, 1.project.JRA.1.* will match an issue in the JRA project with has type bug (1) in any (*) status.

More specific keys take precedence over more generic keys during lookup.
If you use names, make sure you escape blanks in names using \ as required by property file syntax.

Classes

The following are the classes available in Clone Plus for Jira:

Class	project
Qualifier 1	The key or id of the project.
Qualifier 2	The id of the issue type.
Qualifier 3	The id of the status.
Value	The key or id of the target project.
Example without prefix	`project.JRA.1.* = JRA2` `project...* = JRA`
Example description	Clone to JRA2 any bug (1) from JRA project. Set target project as JRA and create issues in the JRA project.

Class	project-component
Qualifier 1	The key or id of the project.
Qualifier 2	The name or id of the component.
Qualifier 3	NA
Value	The key or id of the target project.
Example without prefix	`project-component.JRA.C1 = JRA2`
Example description	Clone to JRA2 any JRA issue with component C1.

Class	type
Qualifier 1	The key or id of the project.
Qualifier 2	The id of the issue type.
Qualifier 3	The id of the status.
Value	The id of the target issue type.
Example without prefix	`type.JRA.* = 1`
Example description	Clone JRA issues to a bug (1).

Class	component
Qualifier 1	The name of the component.
Qualifier 2	NA
Qualifier 3	NA
Value	The name of the component.
Example without prefix	`component.C1 =`
Example description	Remove component C1 from cloned issues.

Class	version
Qualifier 1	The name of the version.
Qualifier 2	NA
Qualifier 3	NA
Value	The name of the version.
Example without prefix	`version.V2 = V1`
Example description	Map version V2 to V1

Condition

UI conditions apply to both default and custom clone operations.
The default clone operations (clone+, clone++) will always be displayed on the UI even if the condition property is not defined.
The custom clone operations will be displayed on the UI only if there is at least one condition property is defined and not false.
For issue type configurations, the following are different scenarios of displaying the target issue type in the Clone window while cloning an issue:
- When the original issue type exists in the target project, it is displayed in the window.
- When the original issue type does not exist in the target project, the default issue type of the target project is displayed.
- When the original issue type does not exist in the target project and default issue type is not configured in the target project, one of the available issue types from the target project is displayed.

Other properties

The following are the other properties available in Clone Plus for Jira:

Property file syntax

The clone property file follows standard property file format with some extensions and some clone specific conventions

Standard property file syntax as defined by Java summarized by:
- comment lines start with # or !
- key value pairs with syntax like key = value
- keys are separated from the value by a separator that is one of =, :, or blank
- \ is the the standard escape character, use \\ if you need the \ character
- blanks or other special characters within a key must be escaped
- lines can be continued by escaping the line terminator - this means having a \ at the end of a line just before the line terminator
For Clone Plus for JIRA release 2.2.0 and above, an Apache commons extension is supported summarized by:
properties can reference other properties
1.fieldExcludes = ${fieldExcludes}, "some other field"
Clone specific conventions
- As described on this page
- See the example included in the Example clone-plus.properties page or the file version: clone-plus.properties

Clone Plus for Jira

Clone Properties

On this page