出力日時、エラー情報、ユーザー情報などのログを保存します。ログはOFC_ログオブジェクトに保存されます。
※本機能はOffice File Creator Proで使用可能です。
OFC_Templateレコードの設定
OFC_Templateレコード画面を開き、「(Pro) ログ」セクション内を入力します。
ログ保存: チェックオンでOFC_Logレコードを保存します。テスト出力は含まれません。
テスト出力のログ保存: チェックオンでテスト出力時、OFC_Logレコードを保存します。
OFC_ログの確認
ログは、OFC_Templateレコード画面の「ログ」タブより、または「OFC_ログ」タブのリストビューより確認することができます。
OFC_Templateレコード画面
「OFC_ログ」タブのリストビュー
ログ一覧
| 項目名 | 内容 |
| 情報 | |
| ログ番号 | ログ番号 |
| 結果 | "成功"、"失敗"、"結果なし"のいずれかがセットされます。
PDFプレビュー時は、出力結果を返しません。出力条件除外エラー以外は"結果なし"がセットされます。 |
| エラー種別 | 各エラー種別がセットされます。
|
| テスト出力 | 以下の値がセットされます。
|
| エラーメッセージ | エラーメッセージ |
| 処理詳細 | |
| 開始日時 | 開始日時 |
| 終了日時 | 終了日時 |
| 処理時間(秒) | 処理時間(秒) |
| 実行方法 | "カスタムボタン"、"Lightningコンポーネントボタン"、"フロー"のいずれかがセットされます。 |
| リクエストId | リクエストId。複数ファイル一括出力時、1実行で同一のリクエストIdがセットされます。Apexで以下の実行結果をセットします。
Request.getCurrent().getRequestId() |
| 親リクエストId | 親リクエストId |
| Quiddity | Quiddity |
| 出力ファイル数(1実行あたり) | 1実行あたりの出力ファイル数 |
| APIコール数 | APIコール数。Excel、Wordのリッチテキストエリア項目の画像レコード出力時、APIコール数を消費します。
※PDFの画像レコード出力時、Html上に生成された画像リンクがPDFで画像に変換されるため、画像ファイル数としてカウントされません。 |
| 画像出力数 | 画像レコード出力時、Excel、Wordに埋め込まれて出力される画像ファイル数。画像を右クリックで「画像として保存」で画像が取り出し可能な画像。
※PDFの画像レコード出力時、Html上に生成された画像リンクがPDFで画像に変換されるため、画像ファイル数としてカウントされません。 ※テンプレートに含まれる画像はカウントされません。 |
| Apex | |
| Apexクラス名 | Apexクラス名 |
| 実行名 | Apexクラス実行時の実行名 |
| ユーザー情報 | |
| ユーザー | 実行ユーザー |
| ユーザー種別 | ユーザー種別。Apexによる以下の実行結果をセットします。
UserInfo.getUserType() |
| セッションタイプ | セッションタイプ。Apexによる以下の実行結果をセットします。
Auth.SessionManagement.getCurrentSession().get('SessionType') |
| UIテーマ | UIテーマ。Apexによる以下の実行結果をセットします。
UserInfo.getUiThemeDisplayed() |
| テンプレート & ファイル | |
| OFC_Template | OFC_TemplateレコードId |
| テンプレートAPI名 | テンプレートApi名 |
| オブジェクトAPI名 | オブジェクトApi名 |
| ファイル形式 | ファイル形式 |
| 出力方法 | 以下の値がセットされます。
|
| ダウンロード | 以下の値がセットされます。
|
| レコードId(リンク) | 出力対象のレコードId |
| ファイル名 | ファイル名 |
| ContentDocument Id | ContentDocument Id。出力方法が"file"のとき、値が設定されます。 |
| ContentVersion Id | ContentVersion Id。出力方法が"file"のとき、値が設定されます。 |
| Attachment Id | Attachment Id。出力方法が"att"のとき、値が設定されます。 |
| システム情報 | |
| 作成者 | 作成者 |
| 最終更新者 | 最終更新者 |
| 所有者 | 所有者 |
考慮事項
- OFC_Templateレコードの権限不足など、OFC_Templateレコード取得エラー時、ログ保存設定がチェックオン・チェックオフに関わらずログは保存されます。
- PDFプレビュー時は、出力結果を返しません。出力条件除外エラー以外は「結果」に"結果なし"がセットされます。
- OFC_ログレコードは組織のデータ容量を消費します。組織の容量オーバー時、ログレコードの作成に失敗します。
- ログレコードの作成に失敗した場合、ファイル出力後、出力ユーザーにログ保存エラーのメッセージが表示されます。