Naming conventions

A naming convention is optional and made by you: it says how the names of your filters and dashboards (and, in Boards and sprints, of your sprints) should be written. A Jira admin sets it, and TuneCraft shows how many names follow it, suggests a new name for the others and renames several at once.

Where to find it

Set a convention

Nothing is flagged until you save one. Saving or removing a convention changes TuneCraft only.

Step 1: Open the convention

Open Naming convention and select Set a convention. To change it later, select Edit the convention.

Step 2: Choose how to write it

Under Write it with, choose Building blocks or A regular expression (advanced).

Step 3: Write it

With building blocks, use the Add buttons (space key, team word, your own text, date and separator) or type it, with a separator or fixed text between two blocks. Each block can be used once, and the convention can be 120 characters at most.

• {Space} is a space key: a capital, then capitals, digits or underscores, 2 to 10 characters, such as ABC.
• {Team} is one word: letters, digits or underscores.
• {Text} is any text that does not start or end with a space.
• {Date} is a date written YYYY-MM-DD. {Date:YYYY-MM} and {Date:YYYY} write less of it; {Date:YYYYMMDD} and {Date:YYYYMM} have no dashes.

With a regular expression, the whole name must match, in 160 characters at most. A repeat inside a repeat, such as (a+)+, and back-references are not accepted, and a test with a time limit runs in your browser before you can save.

Step 4: Read the preview

Preview on your names uses your own names, read from Jira as you and never stored. Use it takes the shape most of your names already share.

Step 5: Save it

Select Save the convention. Remove the convention clears it.

Tip: On sites with Rovo, Ask Rovo helps you write a convention from a plain sentence. TuneCraft checks it as it checks your own, and saves nothing until you do.

Find the names that do not follow it

Step 1: Read the names

Select Read the names. TuneCraft reads 50 names in each request, as you, at about 51 Jira points a request (estimated), and stops after 1,000 names so that other work keeps its points. Carry on reading continues, up to 5,000 names. Names are shown here and never stored. Jira lists the dashboards you own and those shared with you; others are not listed.

Step 2: Choose what to show

Use Show to look at Names that do not follow, Yours that do not follow, Names that follow or All names.

Step 3: Fill the missing parts

Under Fill the parts a name does not give, type a Space key, Team word or Date for the suggestions. These values are used on this page only and nothing is stored.

Rename names

Jira lets only the owner of a filter or a dashboard rename it. The names you do not own are listed and left alone.

Step 1: Pick the names

Tick up to 25 names and check each New name. TuneCraft marks a new name that is empty, too long, the same as the current one, or given to two picks.

Step 2: Select Rename N filters

For dashboards, select Rename N dashboards. A panel lists each rename.

Step 3: Read the list and tick the box

Download the record file. For filters, if the panel shows a box saying you understand which filters and flows may stop matching (it does when a filter or flow writes one of these filters by its name, or when TuneCraft cannot see them all), tick it.

Step 4: Confirm

The window names the site and, outside production, the environment. TuneCraft renames in Jira as you, and sends back each description, JQL and share as it was. The result says, for each name, renamed or left, and why.

• A name changed since you read it is left as it is.
• Jira may refuse a name that is in use, or a filter whose JQL it no longer accepts: repair the JQL first, in Filters and dashboards.
• A dashboard is renamed after TuneCraft reads it and sends back its description, its share list and its edit list. One shared with anyone on the web, or with a share TuneCraft cannot send back, is left untouched, and its row says so.

Important: A filter written by its name in another filter's JQL (filter = "Name") or in a flow stops matching after a rename. TuneCraft lists the filters of its last reading and the flows of its last scan that write it by its name, as far as it could read them, and asks you to tick a box when it cannot see everything.

Note: A filter used by its number, such as on boards, dashboards and subscriptions, is expected to keep working after a rename, but this has not been checked on a test site yet.

What it changes in Jira and how to undo it

To undo, open Changes, select Undo, then choose the record file you downloaded: it holds the names before, and TuneCraft keeps only a code to check the file. Only the owner of an object can give its name back: one you do not own is left as it is, and its owner can undo it from Changes. An object whose name was changed again since is left too.

Related pages

• Filters and dashboards: the pages where a convention is set, and Repair.
• Boards and sprints: the convention for sprint names.

Questions about the app? Write to info@plugincraft.ca.