Getting started with customization
Overview
This page shows how to create a custom clone operation. Only the Jira Administrators can create a customized clone operation. You can create a customized clone operation using the Configuration user interface. It is recommended to customize in a test environment before moving to production.
You can customize the default clone plus operations or create a new customized clone operation. It is recommended to do simple customization on the default clone plus operations to set fieldExcludes and leave all other customization to the new customized clone operation.
In your environment, there are likely a bunch of custom fields that should not be copied when cloning issues. It is easy to exclude them by adding a global fieldExcludes line in your clone-plus.properties. This can be extended or overridden on a specific custom clone operation if necessary.
Start by doing a simple customization following the steps and one of the examples on this page. Once you are comfortable with the process, you can look at the detailed documentation for all the customization possibilities: Clone properties
Steps
| Steps | Details | Examples |
|---|---|---|---|
1 | Select a number from 1 to 8 to uniquely identify the customization to be used. |
|
|
2 | Decide whether you need a base clone or extended clone custom clone operation. |
|
|
3 | Enable the module corresponding to your selection from steps 1 and 2. | For more details, see the Enable and disable clone operations page. |
|
4 | If you doing the customization for the first time, create a clone-plus.properties file in the Jira home directory If you have already done the customization earlier, the file must be available in the directory. |
|
|
5 | The property file works based on named entries that start with a prefix. | The prefix corresponds to the selection of number and type from steps 1 and 2. |
|
6 | Set the required name of the clone operations. |
|
|
7 | Set the condition that determines whether or not the clone operation is valid for a specific issue. | If no condition is set, the operation will not show up for any issue. Tip: For testing, limit the clone operation to a test project until you are happy with the rest of the customization |
|
8 | Add other condition elements. |
|
|
9 | Test the clone operation. |
|
|
10 | If required ddd other properties to match your requirements. | See Clone properties for all the customization points. |
|
11 | Test the clone operation. |
|
|
Example
This example properties file defines two custom clone operations. See Clone properties for more information.
Example clone-plus.properties
# Example property file for Clone Plus
# More details are available in the Administrator Guide: https://bobswift.atlassian.net/wiki/display/JCPP/Administrator%27s+Guide
## Custom 1
# Show this operation for all projects, issue types and status
1.condition.*.*.*.* = true
# Enable Bulk Clone
1.bulkClone = true
# Restrict clone operation to support and administrators
1.role.* = Support, Administrators
# Names that show to users
1.label = Escalate to Engineering
1.tooltip = Creates a task for Engineering
# Set default clone options
1.option.copyAttachments = true
1.option.copyWatchers = false
1.option.copyWorklogs = hide
# Set clone options available for fields
1.option.copycustomfield_11060 = true
1.option.copysummary = false
1.option.copyfixVersions = true
1.option.copycomponents = false
1.option.copyduedate = true
1.option.copyassignee = false
1.option.copytimeestimate = true
1.option.copysecurity = false
# Set target project
1.project.*.*.* = ZCLONE
# Set project category
1.condition.*.*.*.newcategory = true
## Custom 1.plus
# Show this operation for all issues of type bug (id = 1) or task (3)
1.plus.condition.*.1.*.* = true
1.plus.condition.*.3.*.* = true
1.plus.bulkClone = true
# Restrict clone operation so administrators
1.plus.role.* = Administrators
# Names that show to users
1.plus.label = Clone for administrators
1.plus.tooltip = Custom clone operation
# Map issue type to default to a task (id = 3)
1.plus.type.*.*.* = 3
# Set fields
1.plus.set.summary = Clone of issue with summary: %original_summary%
# Set default clone options
1.plus.option.copyAttachments = true
1.plus.option.copyWatchers = false
1.plus.option.copyWorklogs = hide