ドキュメントをレンダリングする

このピースでできること

  • CarboneのテンプレートにJSONデータを流し込んで、PDFやDOCX、XLSXなどのドキュメントを生成してダウンロードします。
  • 出力フォーマット、言語・タイムゾーン・通貨変換などの細かい設定を指定して、多様なドキュメントを自動生成できます。

Carbone の接続方法

workrun と Carbone を接続するには、Carbone の API キー が必要です。

ステップ 1:API キーを取得する

  1. Carbone アカウント にログインします。
  1. 画面右上のアカウントメニューから 「API keys」 を選択します。
  1. 表示された API キーをコピーするか、新しい API キーを作成してコピーします。
      • API キーは他者に共有しないように注意してください。
      • キーを紛失した場合は、Carbone の管理画面から新しいキーを発行できます。

ステップ 2:workrun に接続を追加する

  1. workrun で Carbone のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「API Key」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. テンプレートID(必須)

  • レンダリングに使用するCarboneテンプレートをドロップダウンから選択します。接続後にテンプレート一覧が自動的に表示されます。

2. データ (JSON)(必須)

  • テンプレートに挿入するデータをJSON形式で入力します。テンプレート内のに対応するキーを指定します。

3. 変換先(任意)

  • 出力フォーマットを指定します(例:)。省略した場合はテンプレートの元のフォーマットで出力されます。

4. 言語(任意)

  • 数値・日付の表示ロケールを指定します(例:)。デフォルトはです。

5. PDF Converter(任意)

  • PDFに変換する際のエンジンを選択します。LibreOffice(デフォルト)、OnlyOffice(Office文書向け)、Chromium(HTML→PDF向け)から選べます。

6. タイムゾーン(任意)

  • 日付の書式設定に使用するタイムゾーンを指定します。デフォルトはUTCです。

7. レポート名(任意)

  • 生成されるファイルのカスタムファイル名を指定します。のようなテンプレート変数も使えます。

8. 補完データ(任意)

  • テンプレートのプレフィックスで参照できる追加データをJSON形式で指定します。

9. 通貨ソース(任意)

  • 通貨変換の元となる通貨コードを指定します(例:)。通貨ターゲット・通貨レートと組み合わせて使用します。

10. 通貨ターゲット(任意)

  • 通貨変換後の通貨コードを指定します(例:)。

11. 通貨レート(任意)

  • 通貨変換に使用する為替レートをJSONオブジェクトで指定します。