Documentation Index
Fetch the complete documentation index at: https://docs.box.com/llms.txt
Use this file to discover all available pages before exploring further.
注: 現在、Box Doc Genテンプレートタグでは、英語のみがサポートされています。 実稼働環境で使用する前に、テンプレートをテストして、言語の要件を満たしていることを確認してください。
1. テキストタグ
テキストタグは、文字列型、数値型、または日付型のデータフィールドです。 以下の例では、id、date、customerId、customerName、currency、amountをテキストタグに変換できます。
注Box Doc Genタグでは、タグ内のキーワード間のスペースやハイフンはサポートされていません。 例えば、
**{{first name}}** や **{{first-name}}** はサポートされません。| ドキュメントテンプレート | 出力ドキュメント |
|---|---|
| 請求書 請求書ID: {{invoice.id}}請求日: {{invoice.date}}顧客の詳細: 顧客ID: {{invoice.customerId}}顧客名: {{invoice.customerName}}支払い金額: {{invoice.currency}}{{invoice.amount}} | 請求書 請求書ID: Inv1203 請求日: 13-03-2023 顧客の詳細: 顧客ID: 90158 顧客名: Acme Inc 支払い金額: $5060.50 |
省略可能なタグ
| 入力形式 | 入力データ | 出力データ |
|---|---|---|
{{invoice.customerName}} | - | {{invoice.customerName}} |
{{invoice.customerName :: optional}} | - |
デフォルト値
| 入力形式 | 入力データ | 出力データ |
|---|---|---|
{{invoice.customerName}} | - | {{invoice.customerName}} |
{{invoice.customerName :: default(“Box Inc”)}} | - | Box Inc |
テキストタグの書式設定
| 入力形式 | 入力データ | 出力データ | スクリプトによるサポート | アドインによるサポート |
|---|---|---|---|---|
{{invoice.customerName :: uppercase}} | Acme Inc | ACME INC | 〇 | × |
{{invoice.customerName :: lowercase}} | Acme Inc | acme inc | 〇 | × |
{{invoice.date :: format(“dd-mm-yyyy”) }} | 13-03-2023 | 13-03-2023 | 〇 | × |
{{invoice.date :: format(“mm-dd-yyyy”) }} | 13-03-2023 | 03-13-2023 | 〇 | × |
{{invoice.date :: format(“dd-mmm-yy”) }} | 13-03-2023 | 13-Mar-23 | 〇 | × |
{{invoice.id :: format(“xxx-xxxx”) }} | Inv1203 | Inv-1203 | 〇 | × |
{{invoice.amount :: format(“EU-Number”) }} | 300000 | 300.000 | 〇 | × |
{{invoice.amount :: format(“US-Number”) }} | 300000 | 300,000 | 〇 | × |
リッチテキスト
Box Doc Genでは、リッチテキストを含むドキュメントを生成できます。 入力用のJSONデータにHTMLタグ (太字、斜体、下線、改行、段落、アンカー、画像など) が含まれている場合、Doc Genでは、自動的にそのタグがリッチテキストとして解釈され、関連する書式が適用されます。| HTMLタグ | JSONデータ | 出力 |
|---|---|---|
| 太字 | { “company”: “<b>Acme Inc.</b> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<b> 999-999-9999</b>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 斜体 | { “company”: “<i>Acme Inc.</i> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<i> 999-999-9999</i>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 下線 | { “company”: “<u>Acme Inc.</u> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<u> 999-999-9999</u>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 太字、斜体、下線 | { “company”: “<b><i><u>Acme Inc.</u></i></b>ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<b><i><u> 999-999-9999</u></i></b>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 強調 | { “company”: “<strong>Acme Inc.</strong> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<strong> 999-999-9999</strong>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 範囲 | { “company”: “<span>Acme Inc.</span> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<span> 999-999-9999</span>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 強調 (斜体) | { “company”: “<em>Acme Inc.</em> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話:<em> 999-999-9999</em>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 改行 | { “company”: “<b>Acme Inc.</b> \n ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 \n 電話:<b> 999-999-9999</b>” } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 段落 | { “company”: “<b>Acme Inc.</b> <p> ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 </p> <p> 電話:<b> 999-999-9999</b>”</p> } | Acme Inc. ロードランナーショーでお約束のギャグとして登場する有名な架空の会社。 電話: 999-999-9999 |
| 順序付きリスト | <ol><li>青</li><li>緑</li><li>赤</li></ol> | 1. 青 2. 緑 3. 赤 |
| 順序なしリスト | <ul><li>青</li><li>緑</li><li>赤</li></ul> | * 青 * 緑 * 赤 |
2. 画像タグ
画像タグを使用すると、画像を動的に追加して表示できます。 Box Doc GenはBase64形式の画像をサポートしています。 Box Doc Genテンプレートに画像タグを追加するには、以下の手順に従います。- プレースホルダ画像を挿入して、必要に応じて、位置を調整しサイズを変更します。
- 画像の [代替テキスト] に
$image-pathという変数を追加します。 この変数は、画像をBase64形式で保持するJSONデータ内の変数を参照します。
以下のサンプルJSONコードでは、Base64画像を保持する変数としてcontract.logoを参照しています。
ドキュメントテンプレート
出力
Box Doc Genは、このプレースホルダ画像を、指定されたキーに関連付けられているBase64値に置き換えます。 生成されたドキュメントでの出力は次のようになります。
3. 表タグ
入力データの配列を使用して、表を生成して動的に書式設定できます。 以下に例を示します。itemsは、動的な表として表示することができる配列です。id、name、quantity、price、amountは、配列内の変数であり、個々の列として動的な表に表示されます。
ドキュメントテンプレート
タグが挿入されたドキュメントテンプレートは次のようになります。| ID | 名前 | 数量 | 価格 |
|---|---|---|---|
{{tablerow item in invoice.items}} | |||
{{item.id}} | {{item.name}} | {{item.quantity}} | {{item.price}} |
{{endtablerow}} | |||
出力
Box Doc Genは、ドキュメントテンプレートに追加された表タグを自動的に識別して、入力JSONデータのフィールドと照合し、反復処理を数回実行して入力データに対応した表全体を生成します。 生成されたドキュメントに出力される表は次のようになります。| ID | 名前 | 数量 | 価格 |
|---|---|---|---|
| 1 | A4用紙 | 100 | 29 |
| 2 | インクカートリッジ | 40 | 39 |
| 3 | 接着テープ | 20 | 30 |
4. リストタグ
入力データの配列を使用して、順序付きリストまたは順序なしリストを動的に生成できます。 以下に例を示します。itemsは、動的なリストとして表示することができる配列です。id、name、quantity、price、amountは、配列内の変数であり、リスト内で繰り返されるフィールドとして表示されます。
| ユースケース | ドキュメントテンプレート | 出力ドキュメント |
|---|---|---|
| 箇条書きリストの追加 | 製品のリスト:{{ for item in invoice.items }} * {{item.name}} {{ endfor }} | 製品のリスト: * A4用紙 * インクカートリッジ * 接着テープ |
| 1つ以上の変数を含む箇条書きリストの追加 | 製品のリスト:{{ for item in invoice.items }} * {{item.name}}, {{item.quantity}} {{ endfor }} | 製品のリスト: * A4用紙, 100 * インクカートリッジ, 40 * 接着テープ, 20 |
| 1つ以上の変数を含む、行頭文字が四角形の箇条書きリストの追加 | 製品のリスト:{{ for item in invoice.items }} * {{item.name}}, {{item.quantity}} {{ endfor }} | 製品のリスト: * A4用紙, 100 * インクカートリッジ, 40 * 接着テープ, 20 |
| 1つ以上の変数を含む、行頭文字が白丸の箇条書きリストの追加 | 製品のリスト:{{ for item in invoice.items }} * {{item.name}}, {{item.quantity}} {{ endfor }} | 製品のリスト: * A4用紙, 100 * インクカートリッジ, 40 * 接着テープ, 20 |
| 1つ以上の変数を含む番号付きリストの追加 | 製品のリスト:{{ for item in invoice.items }} 1. {{item.name}}, {{item.quantity}} {{ endfor }} | 製品のリスト: 1. A4用紙, 100 2. インクカートリッジ, 40 3. 接着テープ, 20 |
| 1つ以上の変数を含むローマ数字付きリストの追加 | 製品のリスト:{{ for item in invoice.items }} 1. {{item.name}}, {{item.quantity}} {{ endfor }} | 製品のリスト: 1. A4用紙, 100 2. インクカートリッジ, 40 3. 接着テープ, 20 |
| 1つ以上の変数を含むアルファベット付きリストの追加 | 製品のリスト:{{ for item in invoice.items }} 1. {{item.name}}, {{item.quantity}} {{ endfor }} | 製品のリスト: 1. A4用紙, 100 2. インクカートリッジ, 40 3. 接着テープ, 20 |
リストの書式設定
Box Doc Genテンプレートは、ドキュメントテンプレートで使用できるさまざまなカスタムコードをサポートしています。 次のJSON入力データを参考に、さまざまな区切り記号や区切り文字を使用できます。| リストのタイプ | ドキュメントテンプレート | 出力ドキュメント |
|---|---|---|
| リスト - コンマ区切りを使用 | {{ items :: delimiter(“,”)}} | A4用紙, インクカートリッジ, 接着テープ |
| リスト - セミコロン区切りを使用 | {{ items :: delimiter(“;”)}} | A4用紙; インクカートリッジ; and 接着テープ |
| リスト - カスタム区切りを使用 | {{ items :: delimiter(“~”)}} | A4用紙~ インクカートリッジ~ 接着テープ |
| リスト - コンマ区切りと最後の区切り文字を使用 | {{ items :: delimiter(“,”) , lastdelimiter (“, and”)}} | A4用紙, インクカートリッジ, and 接着テープ |
| リスト - セミコロン区切りと最後の区切り文字を使用 | {{ items :: delimiter(“;”) , lastdelimiter (“; and”)}} | A4用紙; インクカートリッジ; and 接着テープ |
| リスト - カスタム区切りと最後の区切り文字を使用 | {{ items | delimiter(“ | A4用紙~ インクカートリッジ~ and 接着テープ |
5. 条件
条件を使用して、出力ドキュメントに入力を追加できます。 Box Doc Gen Template Creatorアドインは、ドキュメントテンプレート内でこれらの条件を定義するのに役立ちます。サポートされている条件と演算子
| タグの種類 | サポートされている条件 | 条件のつなぎとしてサポートされている演算子 |
|---|---|---|
| 文字列 | == (に等しい)、!= (に等しくない)、isPresent | AND、OR |
| 日付 | isPresent | AND、OR |
| 数値 | <、>、==、!=、>=、<= | AND、OR |
| ユースケース | ドキュメントテンプレート | 出力ドキュメント |
|---|---|---|
| 支払い方法と支払い条件に基づいたコンテンツの導入 | 支払い条件:{{ if invoice.paymentMethod == “オンライン送金” AND invoice.paymentTerms == “Net30” }} * 請求日から30日以内に請求書の金額をお支払いください。* 備考には参考として請求書番号をご記入ください。 {{ elseif invoice.paymentMethod == “小切手” AND invoice.paymentTerms == “Net60” }} * 請求日から60日以内に請求書の金額をお支払いください。* 備考には参考として請求書番号をご記入ください。 * 小切手の支払い先: Box Inc, 900 Jefferson Ave, Redwood City, CA 94063, United States. {{else}} * 請求日から7日以内に請求書の金額をお支払いください。 {{endif}} | 支払い条件: * 請求日から60日以内に請求書の金額をお支払いください。 * 備考には参考として請求書番号をご記入ください。 * 小切手の支払い先: Box Inc, 900 Jefferson Ave, Redwood City, CA 94063, United States. |
| 請求書の金額と支払い方法に基づいた処理手数料の追加 | 処理手数料:{{ if invoice.amount > 1000 AND invoice.amount < 5000 AND invoice.paymentMethod == “小切手” }} * お客様のアカウントに追加で1%の処理手数料が加算されます。* この処理手数料は次回の請求書に含まれます。 {{ elseif invoice.amount > 5000 AND invoice.paymentMethod == “小切手”}} * 請求金額は、追加の処理手数料なしで小切手またはオンライン送金でお支払いいただけます。 {{else}} * 請求日から7日以内に請求書の金額をお支払いください。 {{endif}} | 処理手数料: * 請求金額は、追加の処理手数料なしで小切手またはオンライン送金でお支払いいただけます。 |
| 請求書の納品日に基づいた納品条件の追加 | 納品条件:{{ if invoice.deliveryDate isPresent }} * ご注文の商品は、{{ invoice.deliveryDate}}にお届けいたします。* お届けした商品は、到着後10日以内であれば返品可能です。 {{else}} * ご注文の商品は、今から7日以内にお届けいたします。* お届けした商品は、到着後10日以内であれば返品可能です。 | 納品条件: * ご注文の商品は、23-03-2023にお届けいたします。 * お届けした商品は、到着後10日以内であれば返品可能です。 |
表を伴う条件
Doc Genでは、表や画像など、任意のコンテンツを条件に応じて表示できます。{{ if invoice.customerId isPresent }}
| ID | 名前 | 数量 | 価格 |
|---|---|---|---|
{{tablerow item in invoice.items}} | |||
{{item.id}} | {{item.name}} | {{item.quantity}} | {{item.price}} |
{{endtablerow}} | |||
{{ endif }}
表内の条件
Doc Genでは、表内の列で条件に応じてコンテンツを表示できます。 例| ID | 名前 | 数量 | 価格 |
|---|---|---|---|
{{ tablerow item in invoice.items }} | |||
{{ item.id}} | {{ item.name}} | {{ item.quantity}} | {{ if item.price isPresent}}{{item.price}}{{ else }}-{{ endif }} |
{{ endtablerow }} | |||
6. 計算
Box Doc Genテンプレートは動的な計算をサポートしています。 手動でタグ付け言語に計算コードを書き込むか、Box Doc Gen Template Creatorアドインを使用することができます。サンプルコードの計算は以下のようになります。
- 請求書: 個々の明細項目から正味請求額の合計を決定する。
例: Sum (請求書の個々の明細項目の金額) - 発注書: 最大調達額の上限を設定する。
例: 5% * 正味発注額 - 販売契約書: SLA違反に対する違約金を定義する。
例: 10% * 総販売額
| 算術演算 | 集約演算 |
|---|---|
| % | PERCENT |
| + | SUM |
| * | AVERAGE |
| - | COUNT |
| ユースケース | ドキュメントテンプレート | 出力ドキュメント |
|---|---|---|
| 指定の総額と税額から正味金額を計算する 算術計算 | 正味金額: {{ invoice.grossAmount + invoice.taxAmount}} | 正味金額: 5211.8 注釈: 5060 (grossAmount) + 151.8 (taxAmount) |
| 指定の総額、税額、送料から正味金額を計算する 算術計算 | 正味金額: {{ invoice.grossAmount + invoice.taxAmount + invoice.shippingCharge}} | 正味金額: 5226.8 注釈: 5060 (grossAmount) + 151.8 (taxAmount) + 15 (shippingCharge) |
| 指定の税率と総額から税額を計算する 算術計算 | 税額:{{ invoice.taxRate % * invoice.grossAmount}} | 税額: 151.8 注釈: 3% (taxRate) * 5060 (grossAmount) |
| 個々の明細項目の金額から総額を計算する 集約計算 | 総額:{{ $sum(invoice.items.amount) }} | 総額: 5060 注釈: Sum (2900+1560+600) |
| 明細項目の数を計算する カウント計算 | カウント:{{ $count(invoice.items.amount) }} | カウント: 3 |
| 明細項目の平均を計算する | 平均金額:{{ $average(invoice.items.amount) }} | 平均金額: 1686.66 |
| 指定の明細金額と税率から正味金額を計算する 算術計算 + 集約計算 | 正味金額:{{ sum(invoice.items.amount)}} | 正味金額: 5211,8 注釈: Sum (2900+1560+600) + 3% * Sum (2900+1560+600) |
7. Box Signテンプレートタグ
Box SignテンプレートタグをBox Doc Genテンプレートに追加することで、Box Doc Genによって作成された出力ドキュメントを電子サイン用に送信できます。 以下の表に、Box Doc Gen Template Creatorアドインとタグ付けスクリプトで利用できるタグを示します。| フィールド | Box Signのテンプレートコード | タグ付けスクリプトによるサポート | アドインによるサポート |
|---|---|---|---|
| テキストフィールド | [[t|0]] | 〇 | 〇 |
| 日付フィールド | [[d|0]] | 〇 | 〇 |
| チェックボックスフィールド | [[c|0]] | 〇 | 〇 |
| 署名フィールド | [[s|0]] | 〇 | 〇 |
| スタンプフィールド | [[st|0]] | 〇 | 〇 |
| イニシャルフィールド | [[i|0]] | 〇 | 〇 |
| 名前フィールド | [[n|0]] | 〇 | 〇 |
| 名フィールド | [[fn|0]] | 〇 | 〇 |
| 姓フィールド | [[ln|0]] | 〇 | 〇 |
| 会社フィールド | [[co|0]] | 〇 | 〇 |
| メールフィールド | [[e|0]] | 〇 | 〇 |
| タイトルフィールド | [[ti|0]] | 〇 | 〇 |
| 添付ファイルフィールド | [[a|0]] | 〇 | 〇 |