Initiate Document Exportテンプレートにより、Workiva ドキュメントを HTTP 書式でエクスポートし、PDF または DOCX ファイルに変換することができます。この機能は、ドキュメントをバックアップしたり、オフライン編集を可能にしたり、ワークスペース外のユーザーと Workiva ドキュメントを共有したりするためによく使用されます。
要件
- 、OAuth2グラントを通じてクライアントIDとクライアントシークレットにアクセスする必要があります。
- 以下のコネクターをワークスペースに構成する必要があります:
テンプレートを作成
Initiate Document Exportテンプレートは、テンプレート画面の Workiva チェーンセクションにあります。
検索方法はこうだ:
- チェーンビルダーで、テンプレート タブに移動します。
- 上部のメニューからWorkiva チェーン を選択。
- 右上でInitiate Document Exportを検索し、テンプレートを開く。
テンプレートが見つかったら、以下の変数とランタイム入力を使ってワークスペース用に構成する。
メモ: テンプレートからチェーンを作成する詳細な手順については、チェーンの作成と管理 の記事を参照のこと。
変数
| 変数タイプ | 変数名称 | 説明 | 必要ですか? |
| ダイナミック・チェーン | dcv-exportStatus | ドキュメントのエクスポートステータスを取得するために使用されます。 | はい |
| ダイナミック・チェーン | dcv-resourceURL | ドキュメント名称またはID値。 | はい |
| ワークスペース | wsv-ClientID | Workiva コネクターの OAuth2 Grant から生成された ID。 | はい |
| ワークスペース | wsvシークレット | Workiva コネクターの OAuth2 Grant から生成されたシークレットトークン。 | はい |
| ワークスペース | wsv-IAMURL | IAM Host Override URL。 | はい |
| ワークスペース | wsv-PlatformURL | プラットフォームAPIホストのオーバーライドURL。 | はい |
考察
| ランタイム入力 | 説明 | オプション | 必要ですか? |
| エクスポートフォーマット | エクスポートの書式設定。 | .pdf または .docx | はい |
| エクスポートID | ドキュメントのID 。 | はい | |
| エクスポートファイル名 | アップロードやメール送信の際に、ファイルのデフォルト名称を置換するために使用できます。 | いいえ | |
| セクション | エクスポートするドキュメント内のセクションのID。ドキュメント全体をエクスポートする場合は、空白のままでもかまいません。 | いいえ | |
| Docx - エクスポートオプション | .docxにエクスポートする場合、エクスポートされたオブジェクトの仕様を提供します。 |
|
いいえ |
| PDFエクスポートオプション | .pdfにエクスポートするとき、これはエクスポートされたオブジェクトの仕様を提供します。 |
|
いいえ |
注: オプションフィールドが空白のままだと、指定が適用されずにオブジェクト全体がエクスポートされます。
メール配信通知のセットアップ
エクスポートされたファイルを受信するには、Get (Final Resource) コマンドにEメール通知を追加構成する必要があります:
- Initiate Document Export チェーンの編集中に、Get (Final Resource) コマンドを選択し、Edit
- 封筒アイコンをクリックして、通知画面を開きます。
-
+ 新規通知 ボタンをクリックします。
- 条件」のドロップダウン・メニューを開き、成功 を選択する。
- "Recipients"ドロップダウンメニューを開き、エクスポートされたオブジェクトを受け取るべきすべてのユーザーのEメールを選択します。
- 添付ファイル」メニューを開き、「取得(最終リソース)」コマンドから出力されたファイルを選択する。
このプロセスは、メールの受信者にHTTPファイルを送信する。その後、受信者は手動でファイルの拡張機能を希望の書式設定に変更する必要があります:
- File_name.txt. => file_name.pdf
- File_name.txt => file_name.docx
トラブルシューティング
チェーンがエラーを引き起こしたり、正しいデータの更新に失敗したりした場合は、以下が真であることを確認してください:
-
ワークスペース変数はすべて正しい。サンドボックスのワークスペースを使用している場合は、サンドボックス版のIAM/Platform URLを使用する。
-
プレゼンテーションやエクスポートIDなど、必要なランタイム入力をすべて含んでいる。
-
Get (Final Result) コマンドの電子メール通知設定を構成しました。