買取インストールマニュアル

評価版から買取版への移行

評価版から買取版への移行マニュアル

0. ご注意・免責事項

移行時の注意事項

  • Lychee RedmineにはRedmineのデータベース構造を変更するなど、Redmineに対して大幅な拡張をしているものが含まれております。
  • Lychee Redmineをインストールする際には、既存環境のバックアップを取った上での導入をおすすめいたします。

Redmineバージョンアップ時の注意事項

  • トラッカー設定画面の「実開始日」「実終了日」がOFFの状態でRedmine3.4以上にアップデートすると、標準フィールドの「説明」がOFFになり「実終了日」がONになる問題があります。

    Redmineのバージョンアップ後、以下のコマンドを実行してください。 

    $ cd /var/rails/redmine
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lad:correct_fields_bits
  • Lycheeガントチャート「v3.9.5」以上をインストールした状態でRedmine4.0以上にアップデートすると、ガントチャートが表示できなくなる場合があります。 Redmineのバージョンアップ後、以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lgc:fix_lgc_options_type

1. 本マニュアルにつきまして

1-1. 本マニュアルの想定環境

本マニュアルでは以下の環境を想定したご説明をしております。
ご使用の環境に合わせて、適宜読み替えていただきますようお願いいたします。

  • 環境
    • Linux OS 64bit
  • Redmine ルートディレクトリ
    • /var/rails/redmine
  • Lychee Redmine 展開先
    • /tmp/LycheeRedmine

1-2. 各ファイルについて

  • 下記のディレクトリは、ご利用プラグインの種類に関係なく配置していただきますようお願いいたします。
    • rgloader
  • プラグインの種類によっては複数のディレクトリを配置する必要があります。
    以下をご参照いただき、ご購入内容に合わせてマニュアルを適宜読み替えてください。
    • Lycheeベーシック
      • alm
      • lychee_version_start_date
      • lychee_project_view
      • lychee_easy_assigned_user
      • lychee_workdays
      • lychee_issue_spread_sheet
      • lychee_status_color
      • lychee_profile_icon
      • lychee_notification
      • lychee_help
      • lychee_project_term
      • lychee_message_box
      • lychee_project_dashboard
      • lychee_issueform
    • Lycheeスケジュール管理(ガントチャート)
      • lgc
      • lgc_pro
    • Lycheeガントチャートプレα版 
      • lychee_gantt_chart
    • Lycheeスケジュール管理(カンバン)
      • lychee_kanban
    • Lycheeスケジュール管理(チケットセット)
      • lychee_issue_set
    • Lycheeスケジュール管理(プロジェクトテンプレート)
      • lpt
    • Lycheeスケジュール管理(アクチュアルデイト)
      • lad
    • Lycheeダッシュボード
      • lychee_project_dashboard
    • Lychee工数リソース管理(タイムマネジメント)
      • lychee_time_management
      • lychee_work_plan
    • Lychee工数リソース管理(リソースマネジメント)
      • lrm
    • Lycheeチケット関連図
      • lac
    • Lycheeコストマネジメント
      • lychee_cost
    • Lychee EVM
      • levm
      • lychee_issues_evm
    • Lycheeプロジェクトレポート
      • lychee_project_report
    • Lycheeカスタムフィールド
      • lychee_custom_field
    • Lychee SAML認証
      • lychee_saml_auth
    • Lychee CCPM
      • lychee_ccpm
      • lychee_remaining_estimate
    • Lycheeグループ
      • lychee_groups
    • Lychee機械管理
      • lychee_manufacturing

2. 評価版Lychee Redmineのアンインストール

2-1. 買取版で利用しないLychee Redmineプラグインのデータ初期化

  • 既に評価版を導入しているプラグインのうち、買取版で継続して使用しないプラグインのデータを初期化する必要があります。
  • 使用しないプラグインに対して、下記コマンドを実行してデータを初期化してください。
  • 評価版で追加したデータが消去されてしまうため、買取版で継続して使用するプラグインに対してはコマンドを実行しないようお願いいたします。

2-1-1. Lycheeベーシック(ステータスカラー)のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_status_color VERSION=0

2-1-2. Lycheeダッシュボードのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_dashboard VERSION=0

2-1-3. Lycheeスケジュール管理(ガントチャート)のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lgc VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lgc_pro VERSION=0

2-1-4. Lycheeスケジュール管理(カンバン)のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_kanban VERSION=0

2-1-5. Lycheeスケジュール管理(チケットセット)のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_set VERSION=0

2-1-6. Lychee工数リソース管理(タイムマネジメント)のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_time_management VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_work_plan VERSION=0

2-1-7. Lychee工数リソース管理(リソースマネジメント)のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lrm VERSION=0

2-1-8. Lycheeチケット関連図のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lac VERSION=0

2-1-9. Lycheeコストマネジメントのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_cost VERSION=0

2-1-10. Lychee EVMのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=levm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issues_evm VERSION=0

2-1-11. Lycheeプロジェクトレポートのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_report VERSION=0

2-1-12. Lycheeカスタムフィールドのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_custom_field VERSION=0

2-1-13. Lychee SAML認証のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_saml_auth VERSION=0

2-1-14. Lychee CCPMのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_ccpm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_remaining_estimate VERSION=0

2-1-15. Lycheeグループのデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_groups VERSION=0

2-1-16. Lychee機械管理のデータ初期化

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_manufacturing VERSION=0

2-2. 評価版の認証情報の削除

  • Railsコンソールを起動し、プロンプト（>）が表示されていることを確認してください。 
    $ cd /var/rails/redmine
    $ bundle exec rails console production

    *プロンプト表示例
    2.1.1 :001>
  • 以下のコマンドを実行し、認証情報を削除してください。 
    > Registration.delete_all
  • Railsコンソールを終了します。 
    > quit

2-3. 評価版Lychee Redmineのアンインストール

  • 下記コマンドを実行して、評価版Lychee Redmineをアンインストールしてください。
  • このコマンドを実行しても、データは削除されません。 
    $ cd /var/rails/redmine
    $ rm -rf plugins/{alm,lad,lpt,lychee_version_start_date,lychee_issue_form,lychee_project_view,lychee_easy_assigned_user,lychee_workdays,lychee_issue_spread_sheet,lychee_status_color,lychee_profile_icon,lychee_notification,lychee_project_term,lychee_message_box,lychee_help,lychee_project_dashboard,lgc,lgc_pro,lychee_gantt_chart,lychee_kanban,lychee_issue_set,lychee_time_management,lychee_work_plan,lrm,lac,lychee_cost,levm,lychee_issues_evm,lychee_project_report,lychee_custom_field,lychee_saml_auth,lychee_ccpm,lychee_remaining_estimate,lychee_groups,lychee_manufacturing}

3. 買取版Lychee Redmineの配置

3-1. 圧縮ファイルの配置/展開

  • ダウンロードした圧縮ファイルをインストールするマシン上に配置し、解凍してください。
    Linux用のファイルをWindows上で解凍すると、実行権限が失われてしまいます。
    ご注意ください。
  • 本マニュアルではローダーは /tmp に、プラグインは /tmp/LycheeRedmine に展開されているものと仮定します。

※ 補足 以下の各フォルダには、関連する複数のプラグインフォルダがまとめて格納されております。プラグインをインストールする際には、まとめフォルダ内の各プラグインフォルダを所定のフォルダに配置する必要があります。

  • Lycheeベーシックの場合
    • 解凍すると lychee_basic というフォルダが生成されます。
    • lychee_basic に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lycheeスケジュール管理(ガントチャート)の場合
    • 解凍すると lgc というフォルダが生成されます。
    • lgc に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lychee工数リソース管理(タイムマネジメント)の場合
    • 解凍すると lychee_time_management というフォルダが生成されます。
    • lychee_time_management に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lychee EVMの場合
    • 解凍すると levm というフォルダが生成されます。
    • levm に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lychee CCPMの場合
    • 解凍すると lychee_ccpm というフォルダが生成されます。
    • lychee_ccpm に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。

3-2. 買取版Lychee Redmineの配置

  • 以下のコマンドを実行してください。3-1.圧縮ファイルの配置/展開で展開した「LycheeRedmine」内のプラグインのデータを「plugins」ディレクトリに配置します。 
    $ cp -R /tmp/LycheeRedmine/* /var/rails/redmine/plugins
※ファイル展開/配置の際の注意点※

１．プラグインフォルダを適切に配置する。
下記プラグインは関連するプラグインが複数あるため、その情報をまとめるためのフォルダの中に各プラグインのフォルダが格納されています。プラグインのインストールの際には、まとめフォルダの中にあるプラグインフォルダをそれぞれ「/plugins」ディレクトリに配置する必要があります。

  • 　・lgc
  • 　・levm
  • 　・lychee_basic
  • 　・lychee_ccpm
  • 　・lychee_time_management

例）lychee_basicの場合
　　lychee_basicを配置するのではなく、その中にあるalmなどを/pluginsに配置する。

参考イメージ：Lycheeプラグインをplugins以下にすべて配置した場合

２．ファイルオーナーを適切にする。
plugins フォルダ配下が root になっているなどの場合は、適切な chwon -R コマンドを実行する必要があります。

参考イメージ：ファイルオーナーの状況

4. 買取版Lychee Redmineのインストール

4-1. 必要ライブラリのインストール

  • 以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ bundle install --without development test

4-2. プラグインのDBとリソースファイルのセットアップ

  • 以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ RAILS_ENV=production bundle exec rake redmine:plugins

4-3. Redmineインスタンスの再起動

  • ご使用の環境に合わせた、Redmineインスタンスの再起動手順を行ってください。
  • 起動する際は、必ず「production環境」として起動してください。

例

$ cd /var/rails/redmine
$ bundle exec rails server -e production

4-4. Lychee製品の有効化

  • 以下のプラグインはプロジェクトごとにモジュールの有効/無効を切り替えられるようになっております。
    • Lycheeスケジュール管理(ガントチャート)
    • Lycheeスケジュール管理(ガントチャート5.0 [プレα])
    • Lycheeスケジュール管理(カンバン)
    • Lycheeスケジュール管理(バックログ)
    • Lycheeスケジュール管理(チケットセット)
    • Lychee工数リソース管理(タイムマネジメント)
    • Lychee工数リソース管理(リソースマネジメント)
    • Lycheeチケット関連図
    • Lycheeコストマネジメント
    • Lychee EVM
    • Lycheeプロジェクトレポート
    • Lycheeカスタムフィールド
    • Lychee CCPM
    • Lycheeダッシュボード
  • 上記プラグインを有効化するには、プロジェクトの[設定]タブにある[モジュール]タブにおいて該当プラグインを有効にしてください。

以上で、評価版から買取版への移行は完了です。

補足. Lycheeガントチャート チケットステータスの表示色設定

  • チケットのステータスの表示色を自動で設定する場合は、Redmineのルートディレクトリにて下記のコマンドを実行してください。
  • 管理画面から手動で設定する場合は、下記の実行は不要です。 
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_status_color:set_default_status_colors

補足. Lychee EVM エクスポート時の外部サーバへの接続許可の設定

  • システム管理者でログインし、管理＞プラグイン＞Lychee EVM＞設定 画面から設定できます。
  • 設定をオフにした場合はエクスポートボタンが印刷ボタンになります。

補足. Lychee EVM スナップショット作成

  • Lychee EVMではスナップショットを取得しておくことで、現在と過去の状況を比較できます。
  • スナップショット機能を有効にする場合は、下記のコマンドを実行するようにcronタスクとして設定してください。
  • 業務に影響がおよばないよう、 一日一回以下 かつ 深夜 に実行することをおすすめいたします。
  • プロジェクト数やスナップショットを保存する頻度によっては、データベースの容量が大きくなるのでご注意ください。 
    $ RAILS_ENV=production bundle exec rake redmine:plugins:levm:snapshot:fixed

補足. Lycheeプロジェクトレポート 集計データの生成設定

  • プロジェクトレポートを生成する前に以下の設定が必要です。
  • 集計タスクの登録レポートに必要な集計データを生成するため、以下のコマンドを毎日一回実行するよう、cronタスクとして設定してください。
  • 業務に影響がおよばないよう、深夜 に実行することをおすすめいたします。 
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_project_report:daily_reporting

補足. Lycheeプロジェクトレポート 指標サンプルの作成

  • Lycheeプロジェクトレポートではインストール時に、使用例として指標のサンプルがいくつか作成されます。
  • 削除した場合は、以下のコマンドで再作成ができます。 
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_project_report:add_indice_settings

補足. Lychee CCPM フィーバーチャートの描画データの生成設定

  • Lychee CCPMではフィーバーチャートを描画するために以下の設定が必要です。
  • フィーバーチャートに必要な集計データを生成するため、以下のコマンドを毎日一回実行するよう、cronタスクとして設定してください。
  • 業務に影響がおよばないよう、深夜 に実行することをおすすめいたします。 
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_ccpm:aggregate_consumption_rates

補足. Lychee CCPM フィーバーチャートの期日の自動更新の設定

  • Lychee CCPMでは残工数からチケットの期日を自動で更新することができます。自動更新するには、以下の設定が必要です。
  • システム管理者でログインし、該当のプロジェクト＞設定＞CCPMタブ の「バッチ処理で残工数からチケットの期日を自動更新する」にチェックが必要です。
  • 業務に影響がおよばないよう、深夜 に実行することをおすすめいたします。 
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_ccpm:calculate_due_date_for_issues

    • 補足. Lycheeタイムマネジメント 予定の実績変換方法（カレンダー形式をご利用される場合のみ＊）

    ＊Lyheeタイムマネジメントの表示形式について、表形式とカレンダー形式の2種類があります。 デフォルトでは表形式ですが、カレンダー形式を選択した場合には以下の設定が必要です

    • 入力された作業予定を作業実績に変換するため、以下のコマンドを毎時間一回実行するよう、タスクスケジューラーで設定してください。
    • 設定中のタイムゾーンにより、コマンドが実行された時刻が深夜0時台となるユーザーの作業予定が作業実績に変換されます。
    • ユーザーのタイムゾーンが未設定の場合、Redmineが動作しているタイムゾーンが設定されているものとして扱われます。
    • サーバーの時計の時刻が実際の時刻とずれてしまう可能性を考え、毎時0分ではなく、毎時5分などに実行することをおすすめいたします。 
      $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_time_management:work_plans_to_time_entries

    補足. LycheeIssueForm チケット更新時のメール通知設定

    • IssueFormでチケットを更新した場合、更新内容はそのままではメール通知されません。
    • 更新内容がメール通知されるように、以下のコマンドを定期実行するよう、cronタスクとして設定してください。
    • 長い時間間隔に設定すると、更新をしてもメールがすぐにこない、または沢山の更新内容が一度のメールで来てしまい更新確認がし辛い恐れがあるため、毎時5分などに実行することをおすすめいたします。
    • なお、定期実行時に更新内容が複数ある場合は、チケットごとに複数の内容がメール本文にまとめて通知されます。 
      $ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_issue_form:send_notification_for_journals

    補足. Lychee Redmineのアンインストール

    • 以下のコマンドを実行してください。

      コマンドを実行することでDBから各プラグインで追加された項目が削除されLychee Redmineをインストールする前の状態に戻ります。
      また、各プラグインで追加された項目に入力したデータも削除されてしまいますのでご注意ください。

      $ cd /var/rails/redmine
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lad VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lpt VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_version_start_date VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_form VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_view VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_easy_assigned_user VERSION=0 
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_workdays VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_spread_sheet VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_status_color VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_profile_icon VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_notification VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_term VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_message_box VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_help VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_dashboard VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lgc VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lgc_pro VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_gantt_chart  VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_kanban VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_set VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_time_management VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_work_plan VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lrm VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lac VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_cost VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=levm VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issues_evm VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_report VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_custom_field VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_saml_auth VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_ccpm VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_remaining_estimate VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_groups VERSION=0 
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_manufacturing VERSION=0
      $ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=alm VERSION=0
      $ rm -rf rgloader
      $ rm -rf public/plugin_assets/{alm,lad,lpt,lychee_version_start_date,lychee_issue_form,lychee_project_view,lychee_easy_assigned_user,lychee_workdays,lychee_issue_spread_sheet,lychee_status_color,lychee_profile_icon,lychee_notification,lychee_project_term,lychee_help,lychee_project_dashboard,lgc,lgc_pro,lychee_gantt_chart,lychee_kanban,lychee_issue_set,lychee_time_management,lychee_work_plan,lrm,lac,lychee_cost,levm,lychee_issues_evm,lychee_project_report,lychee_custom_field,lychee_saml_auth,lychee_ccpm,lychee_remaining_estimate,lychee_message_box,lychee_groups,lychee_manufacturing}
      $ rm -rf plugins/{alm,lad,lpt,lychee_version_start_date,lychee_issue_form,lychee_project_view,lychee_easy_assigned_user,lychee_workdays,lychee_issue_spread_sheet,lychee_status_color,lychee_profile_icon,lychee_notification,lychee_project_term,lychee_help,lychee_project_dashboard,lgc,lgc_pro,lychee_gantt_chart,lychee_kanban,lychee_issue_set,lychee_time_management,lychee_work_plan,lrm,lac,lychee_cost,levm,lychee_issues_evm,lychee_project_report,lychee_custom_field,lychee_saml_auth,lychee_ccpm,lychee_remaining_estimate,lychee_message_box,lychee_groups,lychee_manufacturing}
    • 「4-3」と同じ手順で、Redmineインスタンスを再起動してください。

    目次

    TOP