この記事ではConfluenceからNotePMへ移行する方法と、プログラムの使い方を紹介します。
URL:ファイルをNotePMへ一括インポートするスクリプト
- データ移行スクリプト対応サービス
目次
Confluenceからのデータエクスポート
Confluenceのスペース設定にエクスポートタブがあります。エクスポートの形式はHTMLを選択してください。
次へを押すと、エクスポートオプションが出ます。これは通常のエクスポートを選択してください。
エクスポートボタンを押すと、データが作成されてダウンロードが実行できるようになります。ダウンロード形式はZipファイルになります。
エクスポートデータについて
エクスポートされたデータの形式は次のようになっています。
- ファイル
階層構造を記述したindex.html、スペースのHTMLファイル、各ページのHTMLファイルとなっています - attachments
添付ファイルが保存されています - images
Confluenceデフォルトの画像です - styles
HTML用のスタイル設定です
この内 images と styles は利用しません(あっても問題ありません)。
データのインポート
ではここからCSVファイルをNotePMへ取り込む手順を紹介します。まず、プログラムをインストールします。必要なものは次の通りです。
- Node.js
- プログラムのインストール
- アクセストークンの取得
- 設定ファイルの作成
Node.jsのインストール
Node.jsはここからダウンロードできます。ダウンロード後、インストールを実行してください。
プログラムのインストール
プログラムはNode.jsをインストールした環境であれば、次のコマンドでインストールできます。
npm install notepm_importer -g
プログラムはMIT Licenseで公開しています。コードはNotePMMania/notepm_importer: 各種ドキュメント共有サービスからNotePMへ移行するスクリプトにて公開しています。
アクセストークンの取得
NotePMのアクセストークンは個人設定のAPIアクセストークンから取得できます。
そしてアクセストークンを新規作成してください。スコープとして、読み込みと書き込みの両方にチェックを付けてください。
生成されたアクセストークンは、再確認する方法がありません。必ずコピーしたり控えておいてください。
設定ファイルの作成
Confluenceのエクスポートデータにはユーザ名(氏名)が一部しか記述されていません。そこで、Confluenceのユーザ名(氏名)とNotePMの紐付けを行います。ベースになる設定ファイルは次のように出力できます。
notepm-users -a ACCESS_TOKEN -t TEAM_DOMAIN
- ACCESS_TOKEN
先ほど作成したNotePMのアクセストークンです - TEAM_DOMAIN
NotePMのチームドメインです(例:notepm)
実行すると、次のようにYAMLファイルの内容が出力されます。
:-:: プロジェクト太郎: "0000000001"-:: プロジェクト花子: "0000000002"
この内容をたとえば users.yaml として保存します。その後 id
の後にConfluenceのユーザ名(氏名)を記入してください。たとえば次のような内容にします。
:-: 太郎鈴: プロジェクト太郎: "0000000001"-: 花子鈴: プロジェクト花子: "0000000002"
これで準備完了です。
インポートを実行する
ではインポートを実行します。コマンドは次のようになります。
notepm-confluence \-p PATH_TO_HTML \-a ACCESS_TOKEN \-t TEAM_DOMAIN \-u PATH_TO_SETTING_YAML
内容は次の通りです。
- PATH_TO_HTML
ConfluenceからエクスポートしたZipファイルを解凍(展開)したディレクトリのパスです - ACCESS_TOKEN
先ほど作成したNotePMのアクセストークンです - TEAM_DOMAIN
NotePMのチームドメインです(例:notepm) - PATH_TO_SETTING_YAML
先ほど作成した設定ファイル(YAML)のパスです
ノートについて
スペース名でノートが作成されます。内容は次の通りです。
項目 | 値 |
---|---|
ノート名 | スペース名 |
ノートの説明 | 固定「Confluenceからインポートしたノート」 |
スコープ | 固定「プライベート」 |
グループ | 設定しません |
アイコン | 設定しません |
ノートはプライベートで作成されます。調整後、公開してください。
ページについて
各HTMLファイルがページとして取り込まれます。Confluenceではページの下に子ページを追加できます。NotePM上ではページ名を使ってフォルダを作成し、その中に子ページを保存します。
注意点
取り込む際の注意点は次の通りです。
- ラベルは再現されません
- ノートへのアクセス権限は再現されません
- HTMLをMarkdown形式に変換する際、細かな装飾や表形式などは失われます
コード
URL:ファイルをNotePMへ一括インポートするスクリプト
おすすめの情報共有ツール
- NotePM :テレワーク時代のクラウド型ナレッジ共有ツール