ドキュメントの検索
karat

+

K

APIリファレンス ↗

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

テンプレートからドキュメントを生成し、エクスポートする

他の人がユーザーのテンプレートに基づいて新しいドキュメントを生成できるようにするには、Notepad:Template Button ウィジェットを使用します。また、必要に応じて、生成されたドキュメントをPDFとしてエクスポートすることも可能です。

Notepad:Template Buttonウィジェット

Notepad:Template Button をユーザーの Workshop アプリケーションに追加した後、+ Select をクリックしてファイルを参照し、ドキュメントテンプレートを選択します。これにより、テンプレートが Document templates リストに追加されます。

次に、新しいテンプレートエントリをクリックして、その設定を開きます。まず、Template Version を選択します。バージョンがない場合は、新しいタブでテンプレートを開き、テンプレートバージョンを公開します。バージョンを選択すると、テンプレートの必要な 入力パラメーターTemplate Inputs の下に自動的に読み込まれます。

ユーザーが Templates list に複数のテンプレートを追加した場合、テンプレートの Menu display name を指定することができます。表示名を設定しない場合、Button display 設定の Custom text が使用されます。

workshop_notepad_template_button_config

保存オプション

  • Allow users to choose save location:ユーザーはドキュメントが生成される前に自分の保存場所とファイル名を選択できます。事前に定義された Default save location は無視されます。
  • Default save name:新しく生成されたドキュメントのデフォルトのファイル名を定義します。この値は、Export generated notepad as PDF が設定されている場合のPDFファイル名にも使用されます。
  • Default save location:新しいドキュメントが保存される場所を調整します。これは、手動でフォルダーを選択するか、Workshop の文字列変数を介してCompass RIDを渡すことで設定できます。デフォルトでは、ドキュメントはそれを生成するユーザーのホームフォルダーに保存されます。

テンプレートの入力

テンプレートとそのバージョンによりますが、ユーザーの Notepad テンプレートは複数のテンプレート入力を消費する場合があります。これらの入力のそれぞれに、テンプレートの入力として使用したい同じデータ型(文字列、数値、日付、タイムスタンプ、オブジェクト、オブジェクトセット)の Workshop 変数 をリンクします。これらの変数の現在の値は、Notepad:Template Button が選択されるたびに、テンプレートからドキュメントを生成するために使用されます。

入力パラメーターが単一のオブジェクトを必要とする場合は、1つのオブジェクトを含むWorkshopオブジェクトセット変数にリンクしてください。

クリック時のオプション

クリック時のオプションにより、ユーザーが Notepad:Template Button を使用したときの動作を変更できます:

  • Export generated Notepad as PDF: ドキュメントは、生成された後、自動的にPDFとしてダウンロードされます。デフォルトでは、生成された Notepad ドキュメントは Foundry に永続化されません。したがって、Default save name を除くすべての保存オプションは無視されます。
    • Save Notepad from PDF export: 設定すると、PDFにエクスポートするために使用された生成された Notepad ドキュメントが Compass に保存されます。
  • Open generated Notepad in new tab: ドキュメントは新しいタブで開きます。

さらに、ドキュメントが作成されたときに実行すべき Workshop イベントアクション を指定できます。たとえば、これを使用して、新しく生成されたドキュメントのRIDを Notepad:Template ButtonCreated document 出力変数を使用してオブジェクトプロパティとして保持することができます。