テンプレートタグのリファレンス

テンプレートタグを使用すると、データが自動的に入力されるドキュメントテンプレートを作成できます。 ドキュメントの生成時に、Box Doc Genは、テンプレート内のタグを探し、それらをJSON入力のフィールドと照合して、各タグを対応する値に置き換えます。

動的に生成するには、以下のテンプレートタグを使用します。

1. テキスト
2. 画像
3. 表
4. リスト
5. 条件
6. 計算
7. Box Signテンプレートタグ

1. テキストタグ

テキストタグは、文字列型、数値型、または日付型のデータフィールドです。 以下の例では、id、date、customerId、customerName、currency、amountをテキストタグに変換できます。

{
  "invoice":{
    "id": "Inv1203",
    "date": "13-03-2023",
    "customerId": "90158",
    "customerName": "Acme Inc",
    "currency": "$",
    "amount": 5060.50
  }
}

生成される出力ドキュメントでは、すべてのテンプレートタグが入力データに置き換えられます。

テキストタグの書式設定

リッチテキスト

Box Doc Genでは、リッチテキストを含むドキュメントを生成できます。 入力用のJSONデータにHTMLタグ (太字、斜体、下線、改行、段落、アンカー、画像など) が含まれている場合、Doc Genでは、自動的にそのタグがリッチテキストとして解釈され、関連する書式が適用されます。

2. 画像タグ

Doc Genでは、Box内の任意の画像ファイルを、生成されたドキュメントに埋め込むことができます。 そのためには、以下の手順に従う必要があります。

1. 画像ファイルをBoxにアップロードする

ドキュメント生成に使用される画像ファイルは、Boxにアップロードする必要があります。

APIによるドキュメントの生成
APIを使用してドキュメントを生成する際にサービスアカウントを使用している場合は、そのサービスアカウントでファイルにアクセスできることを確認してください。

2. Doc Genテンプレートを作成する

Doc Genでは、以下の方法で、画像を使用したドキュメントの生成が可能です。

• プレースホルダ画像からドキュメントを生成する
• HTML画像を使用してドキュメントを生成する

プレースホルダ画像からドキュメントを生成する:

Microsoft Word用アドインを使用したDoc Genテンプレートの作成

アドインを使用して画像タグを挿入するには、以下の手順に従います。

1. Box Doc Gen Template Creatorアドインで、希望するプレースホルダ画像を使用して画像タグを作成します。
2. [ドキュメントタグ] > [画像タグ] に移動します。
3. ドキュメント内で、画像タグを挿入する領域を選択します。
4. 画像タグをダブルクリックして挿入します。

これにより、プレースホルダ画像が挿入されます。この画像は、Box Doc Gen APIやその他の上流システムによる入力データに動的に置き換えられます。

プレースホルダ画像のサイズと配置は、Microsoft Wordの機能を使用して変更でき、 これらのプロパティは出力ドキュメントで維持されます。

プレースホルダ画像の「代替テキスト」には次のコードが追加されています。 これを表示するには、画像を選択して、右クリックし、代替テキストを表示します。

{
  "image-path": "singleImage",
  "alt-text": ""
}

forループ内で画像を反復処理する:

forループで複数の画像を含むドキュメントを生成するには、以下のように、画像がFor関数でラップされていることを確認してください。

{{ for item in multipleImages }}

{{ endfor }}

tableループ内で画像を反復処理する:

tableループで複数の画像を含むドキュメントを生成するには、以下のように、画像がTable関数でラップされていることを確認してください。

注: 画像のALT TEXTセクションに必ず画像パスを含めるようにしてください。
{
"image-path": "singleImage",
"alt-text": ""
}

HTML画像を含むドキュメントを生成する:

JSONペイロードからHTML画像を含むドキュメントを生成するには、テンプレートにテキストタグを含めます。

例: {{htmlImage}}

3. ドキュメントを生成するためのJSONペイロードを作成する

プレースホルダ画像からドキュメントを生成する:

Box内の画像ファイルを含むドキュメントを生成するには、以下のスキーマを使用します。

1. プレースホルダ画像で使用されるキー (例: singleImage)
2. id - Box内の画像ファイルのファイルIDを渡すため
3. type - これがドキュメントに埋め込む画像ファイルであることを示すため

 {
 "singleImage": {
  "id": "1948600448426",
  "type": "image",
  "name": "Title for image 1"
 }

{
  "image-path": "singleImage",
  "alt-text": ""
}

複数の画像を含むプレースホルダからドキュメントを生成する

Box内の複数の画像ファイルを含むドキュメントを生成するには、以下に示すように、画像スキーマの配列を実行します。

{
 "multipleImages": [
                    {
                      "id": "1948600448426",
                      "type": "image",
                      "name": "Title for image 2"
                    },
                    {
                      "id": "1948600448427",
                      "type": "image",
                      "name": "Title for image 3"
                    },
                    {
                      "id": "1948600448428",
                      "type": "image",
                      "name": "Title for image 4"
                    }
                  ]
}

HTML画像を含むドキュメントを生成する:

HTML画像タグを使用してBox内の画像をドキュメントに含めるには、次の形式でJSONスキーマを定義します。

{
 "htmlImage": "<img src='file://2097093405102' alt='here is a sample image' height='500' width='500'/>"
}

この例では、以下のように定義されています。

• file://2097093405102は、Boxに保存されている画像のファイルIDを指します
• heightとwidthでは、画像の表示サイズを定義します
• altでは、画像の代替テキストを指定します

4. ドキュメント生成リクエストを作成する

Doc Genを使用すると、Boxから直接取得した画像が埋め込まれたドキュメントを作成できます。 生成されたドキュメントに画像を含めるには、以下のいずれかの方法を使用できます。

• Box Doc Gen API – 画像を含むドキュメントをプログラムで生成します。 手順を説明するガイダンスについては、Box Doc Gen APIのドキュメントを参照してください。
• Box Doc Genウェブアプリ – ウェブインターフェースを使用して、画像が埋め込まれたドキュメントを作成します。 手順の詳細については、ドキュメントを参照してください。

Salesforce統合 – BoxファイルIDを参照して、画像を含むドキュメントを生成します。 必要なJSONスキーマパターンに従っていることを確認してください。 設定や使用方法については、Salesforce統合のドキュメントを参照してください。

3. 表タグ

入力データの配列を使用して、表を生成して動的に書式設定できます。

以下に例を示します。

• itemsは、動的な表として表示することができる配列です。
• id、name、quantity、price、amountは、配列内の変数であり、個々の列として動的な表に表示されます。

{
  "invoice":{
    "number": "Inv1203",
    "date": "13-03-2023",
    "customerId": "90158",
    "currency": "$",
    "amount": 5060.50,
    "items": [
      {
        "id": 1,
        "name": "A4用紙",
        "quantity": 100,
        "price": 29,
        "amount": 2900
      },
      {
        "id": 2,
        "name": "インクカートリッジ",
        "quantity": 40,
        "price": 39,
        "amount": 1560
      },
      {
        "id": 3,
        "name": "接着テープ",
        "quantity": 20,
        "price": 30,
        "amount": 600.50
      }
    ]
  }
 }

ドキュメントテンプレート

タグが挿入されたドキュメントテンプレートは次のようになります。

出力

Box Doc Genは、ドキュメントテンプレートに追加された表タグを自動的に識別して、入力JSONデータのフィールドと照合し、反復処理を数回実行して入力データに対応した表全体を生成します。

生成されたドキュメントに出力される表は次のようになります。

4. リストタグ

入力データの配列を使用して、順序付きリストまたは順序なしリストを動的に生成できます。

以下に例を示します。

• itemsは、動的なリストとして表示することができる配列です。
• id、name、quantity、price、amountは、配列内の変数であり、リスト内で繰り返されるフィールドとして表示されます。

{
  "invoice":{
    "number": "Inv1203",
    "date": "13-03-2023",
    "customerId": "90158",
    "currency": "$",
    "amount": 5060.50,
    "items": [
      {
        "id": 1,
        "name": "A4用紙",
        "quantity": 100,
        "price": 29,
        "amount": 2900
      },
      {
        "id": 2,
        "name": "インクカートリッジ",
        "quantity": 40,
        "price": 39,
        "amount": 1560
      },
      {
        "id": 3,
        "name": "接着テープ",
        "quantity": 20,
        "price": 30,
        "amount": 600.50
      }
    ]
  }
 }

入力データを使用して、さまざまな種類のリストを生成できます。

リストの書式設定

Box Doc Genテンプレートは、ドキュメントテンプレートで使用できるさまざまなカスタムコードをサポートしています。 次のJSON入力データを参考に、さまざまな区切り記号や区切り文字を使用できます。

{
  "items": ["A4用紙", "インクカートリッジ", "接着テープ"]
}

5. 条件

条件を使用して、出力ドキュメントに入力を追加できます。 Box Doc Gen Template Creatorアドインは、ドキュメントテンプレート内でこれらの条件を定義するのに役立ちます。

サポートされている条件と演算子

以下のJSONを、Box Doc Genテンプレートの条件を定義するための入力とします。

{
  "invoice":{
    "number": "Inv1203",
    "date": "13-03-2023",
    "customerId": "90158",
    "currency": "$",
    "amount": 5060.50,
    "paymentMethod": "小切手",
    "paymentTerms": "Net60",
    "deliveryDate": "23-03-2023",
    "items": [
      {
        "id": 1,
        "name": "A4用紙",
        "quantity": 100,
        "price": 29,
        "amount": 2900
      },
      {
        "id": 2,
        "name": "インクカートリッジ",
        "quantity": 40,
        "price": 39,
        "amount": 1560
      },
      {
        "id": 3,
        "name": "接着テープ",
        "quantity": 20,
        "price": 30,
        "amount": 600.50
      }
    ]
  }
 }

表を伴う条件

Doc Genでは、表や画像など、任意のコンテンツを条件に応じて表示できます。

{{ if invoice.customerId isPresent }}

{{ endif }}

表内の条件

Doc Genでは、表内の列で条件に応じてコンテンツを表示できます。

例

6. 計算

Box Doc Genテンプレートは動的な計算をサポートしています。 手動でタグ付け言語に計算コードを書き込むか、Box Doc Gen Template Creatorアドインを使用することができます。
サンプルコードの計算は以下のようになります。

• 請求書: 個々の明細項目から正味請求額の合計を決定する。
  例: Sum (請求書の個々の明細項目の金額)
• 発注書: 最大調達額の上限を設定する。
  例: 5% * 正味発注額
• 販売契約書: SLA違反に対する違約金を定義する。
  例: 10% * 総販売額

サポートされている演算

以下のJSONを、ドキュメントテンプレートに計算を追加するための入力とします。

{
  "invoice":{
    "number": "Inv1203",
    "invoiceDate": "13-03-2023, 12:10 PM",
    "deliveryDate": "23-03-2023",
    "customerId": "90158",
    "currency": "$",
    "taxRate": 3,
    "taxAmount": 151.8,
    "shippingCharge": 15,
    "grossAmount": 5060,
    "penaltyRate": 10,
    "billCap": 25,
    "items": [
      {
        "id": 1,
        "name": "A4用紙",
        "quantity": 100,
        "price": 29,
        "amount": 2900
      },
      {
        "id": 2,
        "name": "インクカートリッジ",
        "quantity": 40,
        "price": 39,
        "amount": 1560
      },
      {
        "id": 3,
        "name": "接着テープ",
        "quantity": 20,
        "price": 30,
        "amount": 600
      }
    ]
  }
}

例:

7. Box Signテンプレートタグ

Box SignテンプレートタグをBox Doc Genテンプレートに追加することで、Box Doc Genによって作成された出力ドキュメントを電子サイン用に送信できます。

以下の表に、Box Doc Gen Template Creatorアドインとタグ付けスクリプトで利用できるタグを示します。