フィールド自動選択マニュアル2.0

オープンソース ソリューション専門企業

株式会社アンコウソフト- 1 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

目次
1. 機能紹介 .................................................................................................................................................................................................................3
1.1

関連フィールド自動フィルタリング ...........................................................................................................................................3

1.2

関連フィールド自動選択 ..................................................................................................................................................................4

2. インストールと支援環境 ................................................................................................................................................................................5
2.1

インストールと支援環境 ..................................................................................................................................................................5

3. プラグインのインストールとアンインストール ..................................................................................................................................6
3.1

インストール（Linux 系列） ..........................................................................................................................................................6

3.2

アンインストール(Linux 系列) ......................................................................................................................................................7

3.3

インストール (Windows 系列) ........................................................................................................................................................8

3.4

アンインストール(Windows 系列) .............................................................................................................................................. 10

3.5

インストールされたプラグインのバージョン確認............................................................................................................. 11

4. 設定と機能説明 ................................................................................................................................................................................................ 12
4.1

ライセンスの登録 ............................................................................................................................................................................. 12

4.2

基準フィールドと対象フィールドの追加 ............................................................................................................................... 14

4.3

フィールド自動選択 ......................................................................................................................................................................... 16

4.4

デフォルト値選択 ............................................................................................................................................................................. 20

4.5

多重フィールド連結 ......................................................................................................................................................................... 22

4.6

フィールド変更時のアラート表示 ............................................................................................................................................. 24- 2 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

1.機能紹介1.1

関連フィールド自動フィルタリング⚫

リスト型のカスタムフィールドの中で相互に関連があるカスタムフィールドの値を選択しなければならない場合があります。このような場合、不必要な選択肢が残っていたり、選択時に誤って正しくない選択肢が選択される場合があります。このような問題を解決するために、自動で関連した選択肢だけが表示されるようにフィルタリングする機能です。

<既存の Redmine の不便な点>⚫

下図のようにカスタムフィールド「大」の「A グループ」を選択した場合、関連したカスタムフィールドである「中」には「A-1」、「A-2」、「A-3」だけが選択肢として必要ですが、不必要な「B-1」、「B-2」、「B-3」…などが表示され、選択する時に混乱を与える場合があります。

<既存の不便な選択画面><本プラグインを適用後に改善できる点>⚫

下記のようにカスタムフィールド「大」の「A グループ」を選択した場合、関連フィールドである「中」の「A-1」、「A-2」、「A-3」だけを選択することができるように自動で変更されて選択する時に便利に使用できます。

<自動で関連フィールドがフィルタリングされた画面>- 3 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

1.2

関連フィールド自動選択⚫

カスタムフィールド(リスト型)の中で相互に関連があるフィールドを選択する時に、自動でデフォルト値を選択する機能で、必ず入力しなければならない値が自動で選択されます。

<対象フィールドである「中」のカスタムフィールドの値がデフォルト値として自動的に選択された画面>- 4 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

2. インストールと支援環境
2.1 インストールと支援環境
1)

本製品をインストールして使用するためには下記の環境が必要です。本製品をインストールする前にインストール先環境と支援環境が正しいことをご確認ください。
区分

インストール

支援環境
2)

種別

種類とバージョン

備考

Redmine3.x ～ 4.2Ruby

2.0 ～ 2.7

Database

Mysql、MariaDB、Postgresql、Microsoft SQL Server

Browsers

Chrome、Safari、Edge、Firefox

IE はサポートをしませんが、IE11 では動作することを確認しています。

プラグインのインストール環境の確認方法はシステム管理者で Redmine にログイン後、「管理」->「情報」で確認できます。
* ユーザーのアクションが必要な場合はで表示します。

で表示し、結果と参照を示す場合は<プラグインのインストール環境の確認画面>- 5 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3. プラグインのインストールとアンインストール
3.1 インストール（Linux 系列）
1)

インストール環境は顧客の環境によって異なるため、パスなどは顧客環境に読み替えて適用してください。
例示では bitnami を使って Redmine をインストールした場合のプラグインのインストール方法で説明します。

2)

弊社から提供する圧縮ファイルを下記のパスに解凍してください。
解凍先パス: {REDMINE_ROOT}/plugins#cd /opt/redmine-xxx#./use_redmine#cp openalm_customfield_autofiltering_x.x.x.zip /opt/redmine-xxx/apps/redmine/htdocs/plugins#cd /opt/redmine-xxx/apps/redmine/htdocs/plugins#unzip openalm_customfield_autofiltering_x.x.x.zip3)

DB にテーブルを生成します。
#cd /opt/redmine-xxx/apps/redmine/htdocs#bundle exec rake redmine:plugins:migrate RAILS_ENV=production== 1 CreateOpenalmCustomfieldAutofilteringMaps: migrating =====================-- create_table(:openalm_customfield_autofiltering_maps, {:options=>"ENGINE=InnoDB", :id=>:integer})-> 0.0293s== 1 CreateOpenalmCustomfieldAutofilteringMaps: migrated (0.0294s) ============== 2 CreateOpenalmCustomfieldAutofilteringValues: migrating ===================-- create_table(:openalm_customfield_autofiltering_values, {:options=>"ENGINE=InnoDB", :id=>:integer})-> 0.0136s== 2 CreateOpenalmCustomfieldAutofilteringValues: migrated (0.0137s) ============ 20190528003123 AddTargetDefaultValueToOpenalmCustomfieldAutofilteringValues: migrating-- add_column(:openalm_customfield_autofiltering_values, :target_default_value, :integer,{:default=>0})-> 0.0176s== 20190528003123 AddTargetDefaultValueToOpenalmCustomfieldAutofilteringValues: migrated (0.0176s)

4)

エラーが発生しないで正常に実行できたら web サーバーを再起動させることによってインストールが完了します。
#cd /opt/redmine-xxx#./ctlscript.sh restart apache- 6 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3.2 アンインストール(Linux 系列)
1)「openalm customfield autofiltering」プラグインで使用するテーブルを DB から削除します。テーブル削除後は関連データーを復元することはできません。
#cd /opt/redmine-xxx#./use_redmine#cd /opt/redmine-xxx/apps/redmine/htdocs#bundle exec rake redmine:plugins:migrate NAME=openalm_customfield_autofiltering VERSION=0RAILS_ENV=production== 20190528003123 AddTargetDefaultValueToOpenalmCustomfieldAutofilteringValues: reverting-- remove_column(:openalm_customfield_autofiltering_values, :target_default_value, :integer,{:default=>0})-> 0.0785s== 20190528003123 AddTargetDefaultValueToOpenalmCustomfieldAutofilteringValues: reverted (0.0819s)== 2 CreateOpenalmCustomfieldAutofilteringValues: reverting ===================-- drop_table(:openalm_customfield_autofiltering_values, {:options=>"ENGINE=InnoDB", :id=>:integer})-> 0.0233s== 2 CreateOpenalmCustomfieldAutofilteringValues: reverted (0.0235s) ============ 1 CreateOpenalmCustomfieldAutofilteringMaps: reverting =====================-- drop_table(:openalm_customfield_autofiltering_maps, {:options=>"ENGINE=InnoDB", :id=>:integer})-> 0.0205s== 1 CreateOpenalmCustomfieldAutofilteringMaps: reverted (0.0207s) ============

2)

プラグインフォルダーを削除します。
#cd plugins#rm -rf openalm_customfield_autofiltering3)

エラーがなく正常に実行されたら、web サーバーを再起動するとアンインストールが完了します。
#cd /opt/redmine-xxx#./ctlscript.sh restart apache- 7 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3.3 インストール (Windows 系列)
1)

インストール環境は顧客の環境によって異なるため、パスなどは顧客環境に読み替えて適用してください。
例示では bitnami を使って Redmine をインストールした場合のプラグインのインストール方法で説明します。

2)

弊社から提供する圧縮ファイルを下記のパスに解凍してください。
解凍先パス: {REDMINE_ROOT}/plugins「C:\Bitnami\redmine-4.2.0-0\apps\redmine\htdocs\plugins\」（このフォルダパスは環境により異なります。）に「openalm_customfield_autofiltering」のフォルダーをコピーします。

<プラグインインストールフォルダー>3)

Windows の「スタート」ボタンをクリックして、「Bitnami Redmine Stack」の中の「Bitnami RedmineStack を使用する」をクリックします。

<「Bitnami Redmine Stack を使用する」画面>- 8 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4)

コ マ ン ド プ ロ ン プ ト が 起 動 し ま す の で 、 「 bundle exec rake redmine:plugins:migrate
RAILS_ENV=production」を実行します。
下図のように「AddTargetDefaultValueToOpenalmCustomfieldAutofilteringValues: migrated」などの文字が表示されれば DB にテーブルが正常に生成されたことになります。

<テーブル生成完了画面>
5)

Windows の「スタート」ボタンをクリックして、「Bitnami Redmine Stack」の中の「Bitnami Redmine
Stack Manager Tool」をクリックして実行します。

<「Bitnami Redmine Stack Manager Tool」クリック画面>
6)「Manage Servers」タブで、「Thin_redmine」と「Thin_redmine2」を選択して「Restart」ボタンをクリックして再起動させます。

<「Thin_redmine」と「Thin_redmine2」の再起動画面>- 9 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3.4 アンインストール(Windows 系列)
1)

インストール環境は顧客の環境によって異なるため、パスなどは顧客環境に読み替えて適用してください。
例示では bitnami を使って Redmine をインストールした場合のプラグインのアンインストール方法で説明します。

2)「openalm customfield autofiltering」プラグインで使用するテーブルを DB から削除します。テーブル
削除後は関連データーを復元することはできません。
項 目 「 3.3.3) 」 で 説 明 を し た 「 Bitnami Redmine Stack 」 を ク リ ッ ク し て 、 「 bundle exec rake
redmine:plugins:migrate NAME=openalm_customfield_autofiltering VERSION=0 RAILS_ENV=production」
を実行します。下図のように「1 CreateOpenalmCustomfieldAutofilteringMaps: reverted」などの文字が表示されれば DB からテーブルが正常に削除されたことになります。

<テーブル削除完了画面>
3){REDMINE_ROOT}/plugins 配下のプラグインフォルダーを削除します。

4)

エラーがなく正常に実行されたら、web サーバーを再起動するとアンインストールが完了します。web サー
バーを再起動させる方法は項目「3.3.5)」と「3.3.6)」と同じです。

- 10 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.03.5

インストールされたプラグインのバージョン確認

1)

システム管理者(admin)権限があるユーザーで Redmine にログインして「管理」>「情報」をクリックすると、Redmine plugins の項目にインストールされたプラグイン名が下図のように表示されます。

2)

Redmine plugins の欄に「openalm_customfield_autofiltering」が表示されることを確認してください。

<プラグインが正常にインストールされた画面>- 11 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4.設定と機能説明
4.1
1)

ライセンスの登録
システム管理者(admin)権限があるユーザーで Redmine にログインして「管理」->「プラグイン」->「OPENALM Customfield Autofiltering plugin」の設定をクリックします。

<プラグイン設定画面>
2)

システムセキュリティーキーをコピーして下記のリンク先のページをブラウザで開いて、評価版もしくは購入したライセンスキーを取得して、取得したライセンスキーを「ライセンスキー登録」に入力して適用をクリックしてライセンスキーを登録します。
https://www.redmine-marketplace.com- 12 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3)正常にライセンスキーが登録されると、有効期限が表示されます。

4)

有効期限が満了になると下図のように表示されます。

- 13 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4.21)

基準フィールドと対象フィールドの追加
本プラグインでは、カスタムフィールドを「基準フィールド」と「対象フィールド」に指定して使用します。本プラグインの機能の説明のために、本マニュアルでは「基準フィールド」として「大」、「対象フィールド」として「中」、「小」という名前のカスタムフィールドを作成して説明します。
基準フィールドと対象フィールドの説明は下記の表のとおりです。

区分
基準フィールド

対象フィールド2)

説明
基準フィールドは対象フィールドの上位概念で該当フィールドを選択する時に対象フィールドがフィルタリングまたは選択されるようにする基準になるフィールドです。
基準フィールドによりフィルタリングまたは選択される対象フィールドです。

備考

基準フィールドとして使用するカスタムフィールドは、必ず、カスタムフィールドの形式欄で「リスト」
を選択して、かつ、「複数選択可」のチェックボックスをオフにしてください。この基準を満たしていれば既存のカスタムフィールドも基準フィールドとして使用することができます。

<基準フィールドとして使用するカスタムフィールドの追加画面>- 14 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3)

対象フィールドとして使用するカスタムフィールドは、カスタムフィールドの形式欄で「リスト」を選択します。複数選択可のチェックボックスはオフでもオンでも任意に設定が可能です。

<対象フィールドとして使用するカスタムフィールドの追加画面>
4)

対象フィールドとして「小」をもう一つ追加します。

<対象フィールド追加画面>- 15 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4.3
1)

フィールド自動選択
Redmine のシステム管理者(admin)権限で Redmine にログインして「管理」>「フィールド自動選択」をクリックします。

<フィールド自動選択設定画面>
2)

追加ボタンをクリックすると、フィールド自動選択の登録画面が表示されます。基準フィールドと対象フィールド欄のセレクトボックスで項目「4.2.」で登録した任意のカスタムフィールド名を選択して「追加」ボタンをクリックします。

<基準フィールドと対象フィールドをマッチングする画面>- 16 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3)

先ほど「追加」をクリックしたことにより、基準フィールドと対象フィールドのマッピングが設定されました。削除ボタンをクリックすると設定された関係が削除されます。保存ボタンをクリックして保存します。

<基準フィールドと対象フィールドをマッチングされた画面>

4)

基準フィールド欄をクリックして、セレクトボックスから任意の基準フィールドを選択します。下図の例
示では「大」を選択します。

<登録された基準フィールドを選択する画面>- 17 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.05)

下図の例示では、基準フィールド欄に「大」のカスタムフィールドの選択肢の値が表示されて、対象フィールド欄に「中」のカスタムフィールドの選択肢の値が表示されます。

<基準フィールドの値と対象フィールドの値を表示する画面>
6)

基準フィールドの各選択肢と関連のある対象フィールドの選択肢を選択して保存ボタンをクリックします。
対象フィールドの選択肢欄で、Windows OS の場合は、コントロールキーをクリックした状態で、マウスの左ボタンをクリックすると複数の選択肢を選択できます。

<基準フィールドの値と対象フィールドの値をマッチングする画面>- 18 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

7)

チケット登録ページもしくはチケット編集ページで、基準フィールドの値を選択すると、「フィールド自動選択」欄で指定した通りに、対象フィールドに選択肢が表示されます。
下図の例示では、基準フィールドである「大」で、「A グループ」を選択したため、対象フィールドである「中」のカスタムフィールドには「フィールド自動選択」欄で指定した通りに、「A-1」、「A-2」、「A-3」だけが表示されます。

<対象フィールドが自動でフィルタリングされた画面>- 19 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4.4
1)

デフォルト値選択「フィールド自動選択」で対象フィールドの値をデフォルト値として選択したい場合に「デフォルト値」チェックボックスをオンにしてください。

<デフォルト値選択画面>
2)

上記手順で「デフォルト値」をオンに設定されると、下図の例示の場合、チケット登録ページもしくはチケット編集ページで、基準フィールドである「大」のカスタムフィールドで「A グループ」を選択すると、対象フィールドである「中」のカスタムフィールドでは自動的に「A-1」、「A-2」、「A-3」が指定された状態になります。

<対象フィールドである「中」の値が自動的に選択されている画面>- 20 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

3)

対象フィールドの「複数選択可」の欄がオフの場合（単一選択の場合）は、一つの選択肢だけデフォルト値として選択できます。複数の選択肢が選択されていると、「デフォルト値」のチェックボックスが無効になります。

<デフォルト値のチェックボックスが無効状態の画面>
4)

対象フィールドの「複数選択可」の欄がオフの場合（単一選択の場合）は一つの選択肢だけがデフォルト値として指定できます。
下図の例示では、チケット登録ページもしくはチケット編集ページで、基準フィールドである「大」で「Aグループ」が選択されたため、対象フィールドである「中」には「フィールド自動選択」で指定した「A2」が自動的に指定されます。

<対象フィールドである「中」のカスタムフィールドの値が自動で選択された画面>- 21 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4.51)

多重フィールド連結
基準フィールドで複数のカスタムフィールドを相互に連結することができます。例えば、「大」(基準フィールド)と「中」(対象フィールド)と、「中」(基準フィールド)と「小」(対象フィールド)を連結できます。

<「大」と「中」のフィールドを設定した画面><「中」と「小」のフィールドを設定した画面>- 22 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.02)

下図の例示では、チケット登録ページもしくはチケット編集ページで、「大」のカスタムフィールドで「Aグループ」を選択すると、自動的に「中」と「小」のカスタムフィールドに事前に指定した「A-1」と「A1-1」と「A-1-2」が選択されます。

<「大」を選択すると「中」と「小」のフィールドが自動で変更される画面>- 23 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4.6

フィールド変更時のアラート表示1)

既存のカスタムフィールドの属性や値が変更された場合、すでにマッチングされた基準フィールドと対象フィールドの値に影響が発生します。そのような場合は、注意を喚起するアラートを表示します。

2)

下図の例示のように「小」カスタムフィールドは元々「複数選択可」がオンでしたが、オフに変更して、登録します。

<対象フィールドの複数選択可能を解除した画面>
3)

下図の例示では、対象フィールドの「複数選択可」をオンからオフに変更したため、「フィールド自動選択」ページで既存のマッチングされた画面を開くと、アラートが表示されます。アラートの指示内容に従って、対象フィールドのデフォルト値を選択する場合は、複数の選択肢ではなく、一つの選択肢だけを選択するように設定を変更してください。

<対象フィールドに変更された事項を表示した画面>- 24 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

4)

基準フィールドは「複数選択可」をオフにする必要がありますが、「複数選択可」をオンにすると「フィールド自動選択」ページでアラートメッセージが表示されます。

<基準フィールドの「複数選択可」をオンにした画面><基準フィールドに表示されるアラートメッセージ>- 25 -www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

5)「追加」ボタンをクリックすると、基準フィールドのフィールドが変更されたことを認識することができるように赤い色で表示します。

<基準フィールドが変更された場合のフィールド自動選択画面>
6)

対象フィールドが削除された場合は、基準フィールドを選択した時に下図のようにメッセージが表示されます。表示される番号は該当フィールド ID です。

<対象フィールド削除後、フィールド自動選択画面>- 26 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0

7)

基準フィールドが削除された場合は、基準フィールド選択リストから該当フィールドが削除されます。

<基準フィールドから削除された画面>
8)

追加ボタンをクリックすると、既存のマッチングされたフィールドが削除されたことを案内します。この場合、「削除」ボタンをクリックしてマッチングされた設定を削除してください。

<フィールド自動選択のマッチング画面に削除されたフィールド ID が表示される画面>- 27 -

www.ankosoft.co.jp

フィールド自動選択マニュアル2.0ⓒ 2022 Ankosoft Inc.
- 28 -

www.ankosoft.co.jp