nulab/BacklogMigration-CybozuLive

Migrate your projects from CybozuLive to the Backlog.

Backlog Migration for CybozuLive

非推奨

本リポジトリの利用は非推奨となりました。

概要

CybozuLiveのグループをBacklogに移行するためのツールです。 (English document is described after Japanese)

テスト用プロジェクトに移行して内容を確認してから、正式なプロジェクトに使用してください。

• Backlog
  • https://backlog.com

必須要件

• Java 8
• Backlogの 管理者権限

ダウンロード

こちらのリンクからjarファイルをダウンロードし、以下のようにコマンドラインから実行します。

https://github.com/nulab/BacklogMigration-CybozuLive/releases

java -jar backlog-migration-cybozulive-[最新バージョン].jar

プロキシ経由で使用する場合は、以下のように実行します。

java -Djdk.http.auth.tunneling.disabledSchemes= -Dhttps.proxyHost=[プロキシサーバのホスト名] -Dhttps.proxyPort=[プロキシサーバのポート番号] -Dhttps.proxyUser=[プロキシユーザー名] -Dhttps.proxyPassword=[プロキシパスワード] -jar backlog-migration-cybozulive-[最新バージョン].jar

使い方

前準備

作業用のディレクトリを作成します。

$ mkdir work
$ cd work

jarファイルをダウンロードします。

データディレクトリを作成します。

$ mkdir backlog-migration

CybozuLiveからCSVファイルのエクスポート

1. 該当のグループを開き、[設定] > [エクスポート]をクリックする
2. 形式を標準、文字コードがUTF-8であることを確認し、[ダウンロード]をクリックする

CybozuLiveからエクスポートしたCSVファイルを、作成したbacklog-migrationディレクトリ内に配置します。

CybozuLiveからチャットデータのエクスポート

1. CybozuLiveホームから、[チャット]をクリックする
2. エクスポートしたいチャットをクリックする
3. [詳細を見る]から[テキストで出力する]をクリックする

CybozuLiveからエクスポートしたtxtファイルを、作成したbacklog-migrationディレクトリ内に配置します。

Init コマンド

[init]コマンドを実行し、CSVファイルの解析とマッピングファイルを準備する必要があります。 (マッピングファイルはCybozuLiveとBacklogのデータを対応付けるために使用します。)

java -jar backlog-migration-cybozulive-[latest version].jar \
  init \
  --backlog.key   [BacklogのAPIキー] \
  --backlog.url   [BacklogのURL] \
  --projectKey    [Backlogプロジェクトキー]

サンプルコマンド：

java -jar backlog-migration-cybozulive-[最新バージョン].jar \
  init \
  --backlog.key XXXXXXXXXXXXX \
  --backlog.url https://xxxxx.backlog.com \
  --projectKey BACKLOG_PROJECT

• backlog-migration/mappings/users.csv (ユーザー)
• backlog-migration/mappings/priorities.csv (優先度)
• backlog-migration/mappings/statuses.csv (状態)

マッピングファイルを修正

自動作成されるファイルは以下のようにCSV形式で出力されます。 Backlog側の空白の項目は自動設定できなかった項目になります。 以下のファイルからBacklog側の項目をコピーして、空白を埋める必要が有ります。

• backlog-migration/mappings/users_list.csv (ユーザー)
• backlog-migration/mappings/priorities_list.csv (優先度)
• backlog-migration/mappings/statuses_list.csv (状態)

Import コマンド

[import]コマンドを実行することでインポートを実行します。

java -jar backlog-migration-cybozulive-[latest version].jar \
  import \
  --backlog.key   [BacklogのAPIキー] \
  --backlog.url   [BacklogのURL] \
  --projectKey    [Backlogプロジェクトキー]

サンプルコマンド：

java -jar backlog-migration-cybozulive-[最新バージョン].jar \
  import \
  --backlog.key XXXXXXXXXXXXX \
  --backlog.url https://xxxxx.backlog.com \
  --projectKey BACKLOG_PROJECT

ログファイルはlogディレクトリ内に出力されます。

.
├── log
│   ├── backlog-migration-cybozulive-warn.log
│   └── backlog-migration-cybozulive.log
└── backlog-migration-cybozulive-[最新バージョン].jar

制限事項

実行できるユーザー

Backlogの 管理者権限 が必要になります。

プロジェクトについて

• テキスト整形のルール： markdown

チャットデータの移行について

• チャットとして移行された課題の状態は全て Open となります。
• 課題の作成者と作成日時は、最初にチャットルームで投稿したユーザと投稿日時になります。

CybozuLive側の制限について

• 掲示板/ToDoリスト
  • コメント数：最新から10,000件
• イベント
  • コメント数：最新から10,000件
• チャット
  • コメント数：最新から10,000件
• ToDoや掲示板、イベント、チャットの添付ファイルは移行できません
• ToDoのカテゴリは移行できません。
• CybozuLiveを退会したユーザーは、マッピングファイル(backlog-migration/mappings/users.csv)に(サービス退会者)としてエクスポートされます。

Backlog側の制限について

• 空のコメントは登録されません。

再インポートの仕様

Backlog側に同一プロジェクトキーがある場合は、以下の仕様でインポートされます。

※ 対象のプロジェクトに参加していない場合

対象プロジェクトはインポートされず以下のメッセージが表示されます。対象プロジェクトをインポートする場合は、対象プロジェクトに参加してください。[⭕️⭕️を移行しようとしましたが⭕️⭕️に参加していません。移行したい場合は⭕️⭕️に参加してください。]

項目	仕様
プロジェクト	同じプロジェクトキーのプロジェクトがある場合、プロジェクトを作成せず対象のプロジェクトに課題やWikiを登録します。
課題	件名、作成者、作成日が一致する課題は登録されません。

注意事項

マッピングファイルの編集

MacOSにおいて、テキストエディットアプリでマッピングファイルを編集するとダブルクオーテーションが変換されてしまいます。 「環境設定」→「スマート引用符」のチェックを外してください。

CybozuLiveのユーザー名

ユーザー名の前後に空白が含まれていると移行できません。

イベントの移行について

イベントとしてインポートされる課題の作成日は、 イベントの日時が設定されます。
未来のイベントの場合は作成日が未来になり、「最近の更新」に残り続けるのでご注意ください。

ライセンス

MIT License

• http://www.opensource.org/licenses/mit-license.php

お問い合わせ

お問い合わせは下記サイトからご連絡ください。

https://backlog.com/ja/contact/

Backlog Migration for CybozuLive

Deprecated

This repository has been deprecated.

Overview

Migrate your projects from CybozuLive to Backlog.

First import your data into a test project and verify the data before importing it into your project.

• Backlog
  • https://backlog.com

Requirements

• Java 8
• The Backlog Space's administrator roles.

Download

Please download the jar file from this link, and run from the command line as follows.

https://github.com/nulab/BacklogMigration-CybozuLive/releases

java -jar backlog-migration-cybozulive-[latest version].jar

To use via proxy server, run from the command line as follows.

java -Djdk.http.auth.tunneling.disabledSchemes= -Dhttps.proxyHost=[proxy host name] -Dhttps.proxyPort=[proxy port] -Dhttps.proxyUser=[proxy user] -Dhttps.proxyPassword=[proxy password] -jar backlog-migration-cybozulive-[latest version].jar

How to use

Preparation

Create a working directory.

$ mkdir work
$ cd work

Download jar file.

Create a data directory.

$ mkdir backlog-migration

Export CSV file from CybozuLive

1. Open the appropriate group and click [Settings] > [Export]
2. Confirm that the 形式 is 標準 and the 文字コード is UTF-8 and click [Download]

Put exported files into backlog-migration directory.

Export chat data from CybozuLive

1. Open CybozuLive Home and click [Chat].
2. Click on the chat you wish to export.
3. Click [Show description] and then [Output as text].

Put the exported files into the backlog-migration directory.

Put exported files into backlog-migration directory.

Init command

Execute the [** init **] command to initialize the application and collect CSV data. After that it will create a mapping file. (The mapping file is used to link data between Backlog and CybozuLive.)

java -jar backlog-migration-cybozulive-[latest version].jar \
  init \
  --backlog.key   [Backlog of API key] \
  --backlog.url   [URL of Backlog] \
  --projectKey    [Backlog project key]

Sample commands:

java -jar backlog-migration-cybozulive-[latest version].jar \
  init \
  --backlog.key XXXXXXXXXXXXX \
  --backlog.url https://xxxxxxx.backlog.jp \
  --projectKey BACKLOG_PROJECT

The mapping files are created as follows.

• backlog-migration/mappings/users.csv (user)
• backlog-migration/mappings/priorities.csv (priorities)
• backlog-migration/mappings/statuses.csv (status)

Fix the mapping file

A file in CSV format will be automatically created. The right side is Backlog item. For the assignable items, please refer to the following file by reference.

• backlog-migration/mappings/users_list.csv (user)
• backlog-migration/mappings/priorities_list.csv (priority)
• backlog-migration/mappings/statuses_list.csv (status)

Import command

Run the [import] command to import data.

java -jar backlog-migration-cybozulive-[latest version].jar \
  import \
  --backlog.key   [API key of Backlog] \
  --backlog.url   [URL of Backlog] \
  --projectKey    [Backlog project key]

     Sample commands:

java -jar backlog-migration-cybozulive-[latest version].jar \
  import \
  --backlog.key XXXXXXXXXXXXX \
  --backlog.url https://xxxxxxx.backlog.jp \
  --projectKey BACKLOG_PROJECT

Log files will be output in the log directory.

.
├── log
│   ├── backlog-migration-cybozulive-warn.log
│   └── backlog-migration-cybozulive.log
└── backlog-migration-cybozulive-[latest version].jar

Limitation

Backlog's user roles

This program is for the users with the Space's administrator roles.

About migrating chat data

• All issues that are created when migrating chats will have state Open.
• The user that first posted to the chat will be set as the issues Registered by and the first message post time will be set as the issues Created date.

About limitations in CybozuLive

• Forum/ToDo-list
  • Comments：10,000 from the latest
• Event
  • Comments：10,000 from the latest
• Chat
  • Comments：10,000 from the latest
• Can not migrate bulletin ToDo and forum, event, chat attachments.
• The ToDo category can not be migrated.
• Users who leave CybozuLive are output as (サービス退会者) in the mapping file (backlog-migration/mappings/users.csv).

About limitations in the Backlog

• Empty comments are not registered.

Re-importing

When the project key in the Backlog and CybozuLive matches, they will be considered as the same project and data will be imported as follows.

If the person migrating data is not in the project.

The project will not be imported and the following message will be shown. Join the project to migrate data. To migrate this project, you have to join. Join the project to add issues.

Item	Specifications
Project	The project will not be added when there is a project with the same project key. The issues and wikis will be added to the existing project.
Issues	Issues with matching subject, creator, creation date are not registered.

Important points

Edit mapping file

In MacOS, when you edit the mapping file with TextEdit application, double quotes will be converted. Please uncheck "Preferences" → "Smart quotes".

CybozuLive user name

Can not migrate if the user name contains spaces before and after it.

Migrating events

The creation date of issues imported from an event will be set to the same date as the event. If the date for an event is a future date, the creation date for the issue will also be set to the same future date and will therefor remain in "Recent Updates" until that date has passed.

License

MIT License

• http://www.opensource.org/licenses/mit-license.php

Inquiry

Please contact us if you encounter any problems during the CybozuLive to the Backlog migration.

https://backlog.com/contact/