フローでOffice File Creatorを使用(OFC Ver.1用)

画面フローでOffice File Creatorによりファイルを出力します。

※フロー作成の知識が必要となります。フローの作成方法、フローエラー等のSalesforce標準機能については、お問い合わせサポート対象外です。

※本手順はOffice File Creator ver.1用の手順です。Ver.1Ver.2では設定方法が異なります。Ver.2のご利用者様はVer.2用を参照してください。

 

画面フローでの使用方法

  • officeFileCreatorForFlowコンポーネントをフロー画面に配置します。コンポーネントを画面に配置しますが、役割はアクションと同じで処理のみを行います。officeFileCreatorForFlowコンポーネントを配置したフロー画面へ遷移すると即座に帳票作成が実行され、完了すると自動で次のフロー画面および処理へ遷移します。
  • officeFileCreatorForFlowコンポーネントは、isSuccess、errorMessageなどの各種戻り値を返します。
  • officeFileCreatorForFlowコンポーネントを配置した画面フローは、ユーザーがofficeFileCreatorForFlowの実行中に「次へ」や「前へ」のボタンをクリックしないようにフッターを非表示にしてください。
  • officeFileCreatorForFlowコンポーネントを配置した画面フローの後ろ(直後)の画面フローは、「前へ」のボタンを非表示にしてください。ユーザーが「前へ」をクリックすると、再度帳票出力が実行されてしまいます。
  • officeFileCreatorForFlowコンポーネントは、出力失敗時にも次のフロー処理へ進みます。エラーを検知するためにisSuccessパラメータの戻り値を取得し、エラー時はエラーメッセージを表示するエラー処理を含めてください。

 

画面のプロパティ: 「フッターを表示」をチェックオフ

 

officeFileCreatorForFlowプロパティ画面

 

officeFileCreatorForFlowコンポーネント パラメータ一覧

パラメータ名 設定内容
recordId レコードId

※カンマ区切りで複数のレコードIdを設定することはできません。

save ファイルの出力方法を設定します。

  • ファイルを出力(ダウンロード)する場合・・・空欄
  • ファイル(File)に保存する場合・・・file
  • 添付ファイル(Attachment)に保存する場合・・・att
template OFC_TemplateレコードのテンプレートAPI

 

officeFileCreatorForFlowコンポーネント 戻り値一覧

パラメータ名 戻り値
isSuccess ファイル出力結果の成功・エラーを返します。

  • True・・・成功
  • False・・・失敗
errorMessage isSuccessFalseの場合、エラー内容を返します。
filename ファイル名(拡張子あり)
fileNameWithoutExtension ファイル名(拡張子なし)
fileExtension ファイル拡張子
contentDocumentId パラメータのsaveが”file”の場合、ContentDocumentオブジェクトのレコードIdを返します。
contentDocumentVesionId パラメータのsaveが”file”の場合、ContentVersionオブジェクトのレコードIdを返します。
attachmentId パラメータのsaveが”att”の場合、AttachmentオブジェクトのレコードIdを返します。

 

 

トラブルシューティング

フローの実行後、ファイルが出力されずフローが終了する

フローの実行後、ファイルが出力されずフローが終了する場合、エラー処理が適切に実装されていないことが考えられます。必ずOFCフローコンポーネントの戻り値の「isSuccess」と「errorMessage」を取得し、「isSuccess」の値によって処理を分岐してください。「isSuccess」が"false"の場合は「errorMessage」の値を画面に表示するなど、エラー時の処理を実装してください。

 

 

フローの実行後、ファイル出力処理が開始しない

フローの実行後、ファイル出力処理が開始しない場合、変数「recordId」または「ids」が適切にOFCフローコンポーネントに渡されていない可能性があります。「recordId」、「ids」の変数の値がOFCフローコンポーネントの実行前に正しくセットされているかご確認ください。

確認方法

  • 新規でテキスト型の一時変数「tempRecordId」を作成します。
  • ofcフローコンポーネントの前にフローの「割り当て」を追加し、「tempRecordId」に「recordId」の値を割り当てます。idsの場合はループ処理で割り当てます。
  • デバッグ画面の「割り当て」を確認し、「tempRecordId」に「recordId」が割り当てられていることを確認します。

 

tempRecordId」に「recordId」が正しく割り当てられていても出力されない場合は、「tempRecordId」をOFCフローコンポーネントのレコードIdにセットしてください。

 

 

「静的リソースOFC_Zipの読み取りに失敗しました。」のエラーメッセージが表示される

ブラウザのキャッシュをクリアし、再試行してください。ブラウザのキャッシュをクリアしても解消しない場合は、ブラウザを閉じ再起動してください。フローでリストビューから出力時、またはフローデバッグ画面より出力時、Lightning Webセキュリティが有効の場合、バージョンアップ後にエラーメッセージが表示される場合があります。

 

 

備考・制限事項

  • Office File Creatorをレコードトリガフローで使用することはできません。
  • レコード画面(標準)、リストビュー以外のカスタム開発を含む画面からの出力はサポート対象外です。
  • フロー作成の知識が必要となります。フローの作成方法、フローエラー等のSalesforce標準機能については、お問い合わせサポート対象外です。

 

 

参考

Salesforceのフローで帳票出力と商談を更新する(OFC ver.1用) – Office File Creator応用編 –

Salesforceのリストビューからフローで帳票作成+商談更新を一括実行する(OFC Ver.1用) – Office File Creator応用編 –