Hullspark

Your first scan with Field Sweep

Custom fields pile up in Jira. Nobody knows which ones are still used. Field Sweep reads your saved filters, boards and dashboards. It lists the fields that nothing uses. Four steps. It only reads: it never deletes or changes anything.

Only a Jira administrator can open the app.

Install

Install Field Sweep from the Marketplace listing. Choose your Jira site.

You’ll see: Field Sweep under Apps in Jira settings. A free trial or a subscription turns on the Fields list, Settings and the CSV. Without one the app is read-only.

  1. 1Open the app

    Open Jira settings. Click Field Sweep under Apps.

    You’ll see: a badge that reads licensed or read-only. Three tabs follow: Overview, Fields and Settings. A person who is not an administrator sees Jira administrators only.

  2. 2Run a scan

    Open Overview. Click Scan.

    You’ll see: Scanning… with a progress bar. A line names the stage, such as “Reading the custom field list”. The scan reads the custom fields. It also reads the saved filters, boards and dashboards that you may see. A site with many fields takes longer.

    The scan runs in the background. You can leave the page. Click Reload later to see the result. A scan needs no license.

  3. 3Read the Overview

    Read the number at the top. Then click View on a row under What was found.

    You’ll see: a big number, for example 12 fields can be cleaned up. A bar splits all custom fields into three groups: Can clean up, To review and Nothing found.

    Six rows follow:

    • Fields nothing uses
    • “Not referenced, but still on a screen”
    • Fields that share a name
    • “Fields Field Sweep could not judge”
    • Custom field count
    • “What this scan did not read”

    One row is open at a time. An open row lists the fields and the Recommended steps. Without a license you see the counts only.

  4. 4Check the Fields list

    Open the Fields tab. Click References on a row.

    You’ll see: a table. The columns are Name and Type. Then come Screens and Contexts. The last three are Last used, References and Verdict. Verdict shows the same group as the Overview, with the reason below it.

    The dialog “What uses” lists each saved filter and each board that uses the field. It also lists quick filters and dashboards. Type in the box “Filter by name / ID / type” to find a field. The Fields list needs a license.

To clean up a field

Delete the field in Jira. Field Sweep cannot do it.

First check the places the scan does not read: automation flows and workflows. The steps are in the row Fields nothing uses. Then go to Settings → Work items → Fields in Jira. Choose More actions → Delete on the row of the field.

To undo

Field Sweep changes nothing, so there is nothing to undo.

If you delete a field in Jira, Jira keeps it for a limited time. Open the Deleted fields tab in Jira. Use the menu on the row of the field to restore it.

What it does not do

  • It never deletes or changes a field. The app has no write permission in Jira.
  • It does not read automation flows or workflows. It does not read dashboards that nobody shared with you. It does not read swimlanes or card layouts.
  • The scan runs with your permissions. It sees what you may see.
  • “No change recorded” does not prove that a field is unused. Jira does not count values that were entered before it began to track them.
  • The app works with up to 5,000 fields per scan. On a larger site it cannot work out the number to clean up.
  • Without a trial or a subscription the app is read-only.

More answers

I can’t find the app.

Open Jira settings and look under Apps. Only a Jira administrator sees the app. Anyone else sees Jira administrators only. If Field Sweep is not there, ask an administrator whether it is installed on this site.

The Overview asks me to run a scan.

Nothing has been scanned yet. The Overview reads “Run a scan to see how many fields can be cleaned up”. Click Scan.

The scan failed or stopped.

The Overview reads “The scan failed” or “The scan has stopped”. Click Scan again. If an earlier result exists, it stays on the page and is marked as the previous result. While a scan is running, you cannot start a second one.

What does “Can clean up” mean?

No filter, board or dashboard uses the field. It is on no screen. Jira has no recent value change on record. The field also has a name of its own, and the scan could check every reference. Fields where the scan is not sure go to To review.

What does “To review” mean?

The scan found something but is not sure. The field is on a screen but no filter, board or dashboard uses it. Or it shares a name with another field. Or Jira does not track its value changes. Or some JQL pointed to a field the scan could not find. Check these fields yourself.

A field I know is unused is not in “Can clean up”.

It may be used by a filter, board or dashboard. It may be on a screen. Its value may have changed recently. It may be one of Jira’s own locked fields. You may have left it out in Settings. All of these go to Nothing found or To review.

Does Field Sweep delete anything?

No. It only reads. It shows you where to delete a field in Jira and you do it there. The app does not move fields to the trash either.

What does the row “What this scan did not read” show?

It lists the places the scan cannot read. These are automation flows and workflows. These are also dashboards that nobody shared with you and swimlanes and card layouts. It also counts the items the scan tried to read but could not. A field can look unused here and still be used in one of those places.

What can I do without a license?

You can run a scan and see the counts on the Overview. The field names and the Recommended steps need a license. So do the Fields list, Settings and the CSV.

What do the settings do?

Open Settings. The box “Days before considered” sets how many days without a value change count as no change. The default is 365 days. You can also list field IDs to leave out of “Fields nothing uses”. Click Save. A change applies from the next scan.

How do I export the result?

Open Settings. Click Export CSV under Export. The text appears under “CSV (copy and save)”. Copy it and save it as a file. One field is one row. This needs a license.

Does my content leave my site?

No. Field Sweep runs on Atlassian (a Forge app) and sends nothing outside your site. The scan results stay in the app storage of your site. The app removes them 30 days after the scan. See the Marketplace listing.

Need help?

Email support@hullspark.com in English or Japanese. We reply Monday to Friday and aim to answer within 2 business days. More on the Support page.

Jira and Atlassian are trademarks of Atlassian. Field Sweep is made by Hullspark and is not made or endorsed by Atlassian.

Field Sweep で最初の走査

カスタムフィールドが増えると、どれが使われているか分からなくなります。Field Sweep は、保存フィルタ・ボード・ダッシュボードを読みます。どこからも使われていないフィールドを見つけます。4 ステップです。読むだけで、削除も変更もしません。

アプリを開けるのは Jira の管理者だけです。

インストール

Marketplace の掲載から Field Sweep をインストールします。Jira のサイトを選びます。

こう見えます: Jira の設定のアプリに Field Sweep が出ます。無料試用か購読があると、フィールド一覧・設定・CSV が使えます。ないときは読み取り専用になります。

  1. 1アプリを開く

    Jira の設定を開きます。アプリの下の Field Sweep を押します。

    こう見えます: 札のライセンス済みか読み取り専用と、3 つのタブ。概要・フィールド・設定です。管理者でない人にはJira 管理者のみ利用できますと出ます。

  2. 2走査する

    概要を開きます。走査を押します。

    こう見えます: 進み具合の棒と走査しています…。段階の名前が 1 行で出ます。例は「カスタムフィールドの一覧を読んでいます」です。走査は、あなたが見られるカスタムフィールド・保存フィルタ・ボード・ダッシュボードを全部読みます。フィールドが多いサイトは時間がかかります。

    走査はバックグラウンドで動きます。ページを離れても大丈夫です。あとで再読み込みを押すと結果が出ます。走査にライセンスは要りません。

  3. 3概要を読む

    上の数字を読みます。見つかった物の行で見るを押します。

    こう見えます: 大きな数字。例は 12 件が片づけられます。棒がすべてのカスタムフィールドを 3 つに分けます。片づけられる・確かめる・見つかったものなしです。

    続けて 6 つの行が並びます。何も使っていないフィールド・「参照は無いが、画面に残っている」・同じ名前のフィールド・判定できなかったフィールド・カスタムフィールドの数・「この走査が読まなかった範囲」です。開く行は 1 つずつです。開いた行に、該当のフィールドとおすすめの対応が出ます。ライセンスがないと件数だけ見えます。

  4. 4フィールド一覧を確かめる

    フィールドのタブを開きます。行の参照元を押します。

    こう見えます: 表の列は名前・種類・画面数・コンテキスト数・最終使用日・参照数・判定です。判定は概要と同じ区分で、下に理由が出ます。

    「を使っているもの」の画面に、そのフィールドを使う保存フィルタ・ボード・クイックフィルタ・ダッシュボードが並びます。欄「名前 / ID / 種類で絞り込み」に入力すると、フィールドを探せます。フィールド一覧にはライセンスが要ります。

フィールドを片づけるには

削除は Jira で行います。Field Sweep では削除できません。

先に、走査が読まない場所を確かめます。自動化フローとワークフローです。手順は何も使っていないフィールドの行にあります。そのあと Jira で、設定 → 作業項目 → フィールド を開きます。そのフィールドの行の「•••」→「削除」を選びます。

戻すには

Field Sweep は何も変えないので、戻すものはありません。

Jira でフィールドを削除したときは、Jira が一定の期間だけ保管します。Jira の「削除されたフィールド」のタブを開きます。行のメニューで復元します。

できないこと

  • フィールドの削除も変更もしません。アプリは Jira への書き込み権限を持ちません。
  • 自動化フロー・ワークフロー・あなたに共有されていないダッシュボード・スイムレーンとカードレイアウトは読みません。
  • 走査はあなたの権限で動きます。あなたが見られるものだけを見ます。
  • 「変更記録なし」は、使われていない証拠ではありません。Jira は、追跡を始める前に入った値を数えません。
  • アプリが 1 回の走査で扱うのは 5,000 フィールドまでです。それより大きいサイトでは、片づけられる数を出せません。
  • 無料試用も購読もないと読み取り専用になります。

そのほかの質問

アプリが見当たりません。

Jira の設定を開いて、アプリの下を見ます。アプリが見えるのは Jira の管理者だけです。ほかの人にはJira 管理者のみ利用できますと出ます。Field Sweep がなければ、このサイトに入っているか管理者に聞いてください。

概要が、走査を促しています。

まだ走査していません。概要に「走査すると、片づけられるフィールドの数が出ます」と出ています。走査を押します。

走査が失敗した・止まった。

概要に「走査に失敗しました」か「走査が止まっています」と出ます。もう一度走査を押します。前の結果があれば、ページに残ります。前回の結果と分かるように出ます。走査の途中で、もう 1 つ走査を始めることはできません。

「片づけられる」は何ですか?

フィルタ・ボード・ダッシュボードのどれも使っていません。どの画面にもありません。Jira に最近の値の変更の記録がありません。名前がほかのフィールドと重ならず、走査がすべての参照を確かめられたものです。確かでないものは確かめるに入ります。

「確かめる」は何ですか?

走査は何かを見つけましたが、確かではありません。画面にはあるのに、フィルタ・ボード・ダッシュボードが使っていないものです。ほかのフィールドと名前が同じものです。Jira が値の変更を追っていないものです。走査が見つけられないフィールドを JQL が指していたものです。ご自身で確かめてください。

使っていないはずのフィールドが「片づけられる」にありません。

フィルタ・ボード・ダッシュボードが使っているのかもしれません。画面にあるのかもしれません。最近、値が変わったのかもしれません。Jira のロックされたフィールドかもしれません。設定で対象から外したのかもしれません。どれも見つかったものなしか確かめるに入ります。

Field Sweep は何かを削除しますか?

しません。読むだけです。Jira のどこで削除するかを案内するだけで、削除はあなたが Jira で行います。フィールドをゴミ箱へ移すこともしません。

「この走査が読まなかった範囲」の行は何を示しますか?

走査が読めない場所を並べます。自動化フロー・ワークフロー・あなたに共有されていないダッシュボード・スイムレーンとカードレイアウトです。読もうとして読めなかったものの数も出ます。ここで使われていないように見えても、その場所で使われていることがあります。

ライセンスがないと何ができますか?

走査と、概要の件数の表示はできます。フィールドの名前・おすすめの対応・フィールドの一覧・設定・CSV にはライセンスが要ります。

設定では何を変えられますか?

設定を開きます。最初の欄で、値の変更がない日数がいくつなら変化なしとみなすかを決めます。既定は 365 日です。「何も使っていないフィールド」から外すフィールド ID も入れられます。保存を押します。変更は次の走査から効きます。

結果を書き出すには?

設定を開きます。書き出しの下の CSV を書き出すを押します。「CSV（コピーして保存してください）」の下に文字が出ます。コピーして、ファイルに保存します。フィールド 1 つが 1 行です。ライセンスが要ります。

内容がサイトの外に出ますか?

出ません。Field Sweep は Atlassian 上（Forge アプリ）で動き、サイトの外へは何も送りません。走査の結果は、サイトのアプリの保存領域に残ります。アプリは、走査から 30 日後に消します。Marketplace の掲載もご覧ください。

困ったら

support@hullspark.com へどうぞ。日本語でも英語でも大丈夫です。平日に対応し、2 営業日以内の返信を目標にしています。ほかの答えは サポートのページ にあります。

Jira と Atlassian は Atlassian の商標です。Field Sweep は Hullspark の製品で、Atlassian が作ったものでも推奨するものでもありません。