EDITROOMをご利用いただき、誠にありがとうございます。使い始める前に、少しだけお時間を頂き、基本的な部分を説明をさせていただきます。
まず、今ご利用いただいているクライアント・アプリケーションは、EDITROOMの設定を行ったり、EDITROOMで用いるデータを保存したりするためのものです。
このクライアント・アプリケーションで設定した後、Web APIを使ってデータを追加したり、ドキュメントを生成したりすることができます。
EDITROOMではデータをプロジェクトと呼ぶ単位で分割して管理します。スタンダード・プランやエンタープライズ・プランでは複数のプロジェクトを扱うことができます。
このクライアント・アプリケーションでは編集したいデータのあるプロジェクトをPCにダウンロードしておき、編集したデータのみをアップロードするようになっています。このプロジェクトのデータをPCにダウンロードすることをプロジェクトのセットアップと呼びます。
EDITROOMクライアント上で追加・変更・削除したデータをサーバーに反映させる（アップロードする）ことをコミットと呼びます。
「ワークスペース」と書いてあるタブを選ぶとワークスペースViewが表示され、プロジェクトに登録されているフォルダやファイルなどが表示されます。
一方、「変更点」タブを選ぶと変更点Viewが表示され、EDITROOMクライアント上で追加・変更・削除したデータが表示されます。
変更点Viewに表示されているものをまとめてサーバーにコミットするには「一括コミット」ボタンを押します。なお変更点Viewから特定のファイルやフォルダを選択してコミットすることも可能です。
他のユーザがコミットした内容は、「アップデート」ボタンを押すとダウンロードされ、取り込まれます。
ワークスペースViewで対象物を選んで右クリックをするとメニューが表示され、そこから「新規作成」メニューを選ぶとフォルダやファイルなどを選んで作成することができます。
なおExcelやWordなどのファイルはWindowsのエクスプローラーなどからドラッグ＆ドロップ、もしくはコピー＆貼り付けでEDITROOMクライアントに取り込みことができます。
EDITROOMで作成する文書のひな型をベースドキュメントと呼びます。
ベースドキュメントにはcrossnoteドキュメントを用います。新規作成メニューにある「一般文章」などがcrossnoteドキュメントです。
流し込みたい文章や図、表などをあらかじめベースドキュメント中に配置しておきましょう。部品の挿入には右クリックメニューを使います。
なおそれらの部品にはわかりやすい名前を付けておくと良いでしょう。ワークスペースViewで部品を選び、F2キーを押すと部品名を変更することができます。
文中に属性キーワードを含めることができます。
属性キーワードはWeb APIでドキュメント作成の際、APIで指定することのできるパラメータで、文中で使うだけでなく、入力データの取得方法を決めたり、出力するファイル名に含めたりなど、様々な使い方をすることができます。
文中で使うためには、あらかじめDocFlow定義で属性キーワードを作成しておき、そのDocFlowファイルを属性キーワードの選択画面内の「DocFlowファイル」ボタンを押してDocFlowファイルを指定します。
DocFlow定義エディタを使って、どのようにデータを集め、部品化し、どのベースドキュメントのどの位置に流し込むかについて定義します。
まず属性キーワードを定義します。
次に入力ドキュメントとしてどのファイルからデータを取り込むのかを定義します。その際、属性キーワードを使ってパス名を決めたり、選択したりすることができます。
最後に生成ドキュメントとして、どのベースドキュメントを使い、どの入力ドキュメントをどの部品に差し込むかを定義します。
上記で作成したベースドキュメントやDocFlow定義ファイルはもちろん、DocFlowに必要な入力データで、あらかじめ用意しておくものなどはサーバーにコミットしておきましょう。
サーバーにコミットしたDocFlow定義ファイルをEDITROOMへ登録します。
EDITROOMを実行するためのAPIキーを生成します。
このAPIキーはWeb APIを実行する際、リクエストのヘッダー(X-EDITROOM-API-KEY)の値としてセットする必要があります。
ドキュメントを生成するためのAPIはgenerateです。
各Web APIの仕様はこちらのマニュアル「EDITROOM API リファレンス」をご参照ください。
テストにはcurlなどのプログラムを用いてWeb APIを実行すると良いでしょう。
下記にWindowsのcurlを用いてgenerateを実行する例を示します。Windowsのcurlでは日本語が化けてしまう問題があるため、POSTする中身のデータはファイルで指定すると良いでしょう。
まずPOSTする中身をファイル(data.json)としてUTF-8で保存します。
下記の例ではdocflow1という名前のDocFlowを実行しています。出力する形式はPDF、そして属性キーワード「今晩のおかず」の値として、「さんま」を指定しました。
{
"docflow_name" : "docflow1",
"export_type" : "pdf",
"records" : {
"今晩のおかず" : "さんま"
}
}
コマンドプロンプトを開き、ファイルdata.jsonを置いてある同じディレクトリで以下のコマンドを実行します。なお折り返して表示されていると思いますが、1行です。
あなたのAPI Keyには生成したAPIキーを指定します。あなたのEDITROOMドメインにはEDITROOMのユーザIDの@以降の部分(@は含まず)を指定します。
curl -X POST -H "X-EDITROOM-API-KEY:あなたのAPI Key" -H "Content-Type:application/json" -d "@data.json" "https://e1.updateit.jp/editroom/bw/あなたのEDITROOMドメイン/v1/generate"
サーバー側が正常に受け付けると以下のような結果が返されます。
{
"result": "SUCCESS",
"request_id": "i5saqr1hf3kh979fha81rrcr16"
}
EDITROOMのファイルリスト画面から生成されたドキュメントを確認できます。
「公開」となっていれば、外部からアクセス可能な状態になっています。
