この記事では、配信する帳票のセットアップ方法と、配信設定方法についてご説明します。
🔰設定の流れ
💡 はじめて設定される方へ
設定を始める前に、下の動画で全体の流れをご確認いただくとスムーズです。
▶ [動画を見る]
✅目次
STEP1. 帳票セットアップ
帳票DXで帳票を作成します。
帳票DXで作成して送信できるファイルの種類は、PDF・office帳票(Excel/Word/PowerPoint)です。
⚠️既に送信したいファイルがお手元にある場合は、ファイルをアップロードして送信することができるので、こちらの設定は不要です。
1-1. 弊社で用意しているソアスク標準帳票を使用する場合
🚨ソアスクと帳票DX for Salesforceがインストールされていることを前提に説明します🚨
↳ソアスクインストール方法(手動でのインストールについて)
↳帳票DX for Salesforceインストール方法(【帳票DX for Salesforce セットアップガイド(1)】インストール&カスタム設定)
①ソアスク標準帳票を以下セットアップ手順より設定します。
記事:ソアスク標準帳票(帳票DX for Salesforce版)のセットアップ手順
1-2. ソアスク標準帳票を使用しない場合
🚨帳票DX for Salesforceがインストールされていることを前提に説明します🚨
①帳票DXのユーザガイドを参照して帳票を作成してください。
作成する帳票の形式に応じて、以下のガイドをご覧ください。
記事:ユーザガイド
| 形式 | 参照ガイド |
|---|---|
| ユーザガイド(3)帳票作成 / (4)PDFレイアウト作成 | |
| Excel | ユーザガイド(2)Document Designer / (3)帳票作成 / (5)Excelレイアウト作成 |
| Word | ユーザガイド(2)Document Designer / (3)帳票作成 / (6)Wordレイアウト作成 |
| PowerPoint | ユーザガイド(2)Document Designer / (3)帳票作成 / (7)PowerPointレイアウト作成 |
以上で、帳票のセットアップは完了です。
STEP2. 配信に関する設定
配信を行うための設定を「Agentファイル設定」で実施します。
Agentファイル設定では以下の設定を行います。
①アプリケーションランチャーから「Agentファイル設定」を表示します。
または、アプリケーション「Agentファイル」を開き[Agentファイル設定]タブから選択します。
🔻2-1. ドキュメント配信設定
2-1-1. ドキュメント配信設定
ドキュメント配信処理の詳細な設定を行います。配信したい設定は複数作成することができます。
①新規ボタンをクリックします。
②設定を行い保存します。
⚠️設定必須項目には「*」マークがついています。
⚠️ファイル送信先は「取引先責任者のメールアドレスを使用する」項目で決定します。詳しくは以下の設定箇所の説明をご覧ください。
📂 設定箇所の説明(クリックで開閉)
📘 表示ラベル:
ドキュメント配信設定の名前を設定します。
どんなファイルをどのように配信するか、分かりやすい名前を指定することを推奨します。
📘 カスタムメタデータレコード名:
アンダースコアと英数字のみで、ユニークな値を設定します。ほかの配信設定で使用しているメタデータレコード名は使用できません。
📘 有効:
デフォルトでチェックが入ります。
チェックを外すと無効化となり、作成・アップロード・配信ができなくなります。ダウンロードは可能です。
📘 ドキュメント配信オブジェクト名:
ドキュメント配信に使用するオブジェクトを指定します。
ドキュメント配信オブジェクト名を指定すると、「配信済反映項目名」と「ステータス反映項目名」が表示されます。
-
配信済反映項目名・・・ドキュメント配信メールが送信された後に、指定された項目にチェックがつきます。ドキュメント配信オブジェクトのチェックボックス型項目を指定します。
-
ステータス反映項目名・・・ドキュメント配信履歴レコードのステータスが、指定された項目に反映されます。ドキュメント配信オブジェクトの選択リスト値(グローバル選択リスト値セット[Document Delivery Status]を使用した)を指定します。
⚠️既存のリスト項目をステータス反映項目に指定すると、もともとの選択肢に加えてAgentファイルのステータス値が自動追加されます。
その結果、既存処理に影響が出る可能性があるため、ステータス反映用には必ず新しい専用のリスト値項目を作成してください。
📘 取引先参照項目名:
ドキュメント配信オブジェクトの中の、取引先オブジェクトを参照している項目(API参照名)を指定します。
配信オブジェクトの取引先を参照している項目を確認し(例:「取引先」項目)、API参照名を指定します。(例:appsfs__fs_Account2__c)
📘 取引先責任者のメールアドレスを使用する:
ファイルの送信先(To)を決める設定です。
☑️チェックをいれると、取引先参照項目名で指定した取引先の「取引先責任者のメールアドレス」をファイル送信に使用します。複数取引先責任者がいる場合は、作成日が一番新しい取引先責任者のメールアドレスを使用します。
🔲チェックを外すと「送信先メールアドレス項目名」が表示され、送信先を指定することが可能です。
- 送信先メールアドレス項目名・・・ドキュメント配信オブジェクトの項目か、参照先オブジェクトの項目の指定が可能です。対応するデータ型はメールのみになります。
参照先オブジェクトにある項目を指定する場合は以下のように入力してください。
入力内容: {参照先オブジェクトのAPI参照名}.{メールアドレス項目のAPI参照名}
📘 送信先CCメールアドレス項目名:
CCに送信するメールアドレスを取得する項目のAPI参照名を指定します。
ドキュメント配信オブジェクトまたは参照先オブジェクトの項目が対象です。
⚠️ メールアドレスを直接入力する箇所ではありません。API参照名を指定してください。
・対応データ型
テキスト/テキストエリア/ロングテキストエリア/メール/数式(テキスト)
複数アドレスを指定する場合は、項目値をカンマ区切りまたは改行で入力してください。
📘 配信メールテンプレート:
ドキュメント配信に使用するメールテンプレートを指定します。セットアップガイド(2)で設定したclassicメールテンプレートを使用します。
📘 配信メールサブテンプレート:
配信メールテンプレートで指定したテンプレート内に{SubTemplate}と記載した場合、指定した配信メールサブテンプレートを埋め込むことができます。セットアップガイド(2)で設定したclassicメールテンプレートを使用します。
📘 ユーザー登録メールテンプレート:
マイページへのユーザー登録メールに使用するメールテンプレートを指定します。セットアップガイド(2)で設定したclassicメールテンプレートを使用します。
📘 ユーザー登録メールに含まれるURLの有効期間(分):
ユーザー登録メールに含まれるURLの有効期間を分単位で指定します。
デフォルトは60分です。
📘 同じメールアドレスのコンテンツをまとめる:
チェックがついている場合は、異なるレコードから複数配信を行う際、ジョブスケジュール設定で設定した間隔内で同じメールアドレスに送信するジョブが複数ある場合、一通のメールにまとめて送信することが可能です。
その時、メールテンプレートは代表して一件のレコードの内容が反映されて、サブメールテンプレート部分はそれぞれのレコードの内容が繰り返し表示されます。
📘 配信メールに含まれるURLの有効期間(週):
ドキュメント配信メールに含めるURLの有効な週数を指定します。
デフォルトは2週間です。
📘 配信メールに含まれるURLの有効期間(日):
ドキュメント配信メールに含めるURLの有効な日数を指定します。
デフォルトは0日です。
📘 登録後に他の履歴レコードを無効化する:
ドキュメント配信履歴レコードを登録したとき、同じドキュメント配信設定のドキュメント配信履歴レコードを無効化します。
📘 作成後に配信予約する:
チェックをいれると、ドキュメント作成から配信まで一気に行います。
チェックを外すと、ドキュメント作成から配信までにドキュメントを確認して、配信可能になってからステータスを配信予約済みに変える動きをすることができます。
📘 帳票DXの設定名:
ドキュメント作成する際に使用する帳票DXの設定名を指定します。
ここで指定した帳票DXの設定を使って帳票を作成し、配信に使用します。
📘 ユーザー種別:
配信メールからユーザー登録したユーザーの「ユーザー種別」を指定します。
デフォルトは空で設定してください。
📘 詳細ページURL:
詳細ページURLは、ファイルを保存するマイページの環境によって異なるURLを指定します。
■詳細ページURL
検証環境 |
https://mypage-stg.soasc.net/テナントID/l/01_file_download/{historyID} |
本番環境 |
https://mypage.soasc.net/テナントID/l/01_file_download/{historyID} |
※テナントID部分にはオプロからご案内しているテナントIDを指定します。
2-1-2. ドキュメントダウンロード履歴項目
マイページ(ドキュメント管理アプリケーション)でのドキュメント表示・ダウンロード時に、ドキュメント配信レコードの項目を更新するための設定です。
⚠️本設定は任意です。不要な場合は省略できます。
例:ダウンロード日をドキュメント配信レコードの項目に反映させたい場合
①新規ボタンをクリックします。
②設定を行い、保存します。
📂 設定箇所の説明(クリックで開閉)
📘 表示ラベル:
ドキュメントダウンロード履歴項目の名前を設定します。
📘 カスタムメタデータレコード名:
アンダースコアと英数字のみで、ユニークな値を設定します。ほかの配信設定で使用しているメタデータレコード名は使用できません。
📘有効:
無効化すると、項目が更新されなくなります。
📘 データ型:
項目に反映するダウンロード履歴の形式が表示されます。
📘 設定項目名:
ダウンロード履歴を反映させる項目を指定します。
📘設定項目データ型:
設定項目のデータ型が表示されます。
📘 値:
データ型がテキストの際に表示されます。
ダウンロード履歴として書き込む値を入力することができます。Salesforceの数式も指定可能です。
2-1-3. 配信メールのパラメーター設定
classicメールテンプレートの {◯◯} に差し込む値を指定するための設定です。
使用するメールテンプレートを選択し、各パラメーターの値を設定してください。
例:メール文面に以下のように{Url}と{expiredat}と設定をした場合
①新規ボタンをクリックします。
②設定を行い、保存します。
・URLの場合
・有効期限の場合
📂 設定箇所の説明(クリックで開閉)
📘 表示ラベル:
配信メールのパラメーター設定の名前を設定します。
📘 カスタムメタデータレコード名:
アンダースコアと英数字のみで、ユニークな値を設定します。ほかの配信設定で使用しているメタデータレコード名は使用できません。
📘有効:
無効化すると、配信メールに値が反映されなくなります。
📘 メールテンプレート:
パラメーターを設定したいメールテンプレートを指定します。
📘 マッピング対象オブジェクト:
メールテンプレート内に埋め込んだ{◯◯}部分のマッピングに使用するオブジェクトを指定します。
📘項目名:
メールテンプレート内に埋め込んだ{◯◯}部分のマッピングに使用する項目のAPI参照名を指定します。
📘 マッピング名:
メールテンプレート内に埋め込んだ{◯◯}部分の○○部分を指定します。
2-1-4. 一括配信設定
一括配信機能を使用する場合に設定します。
一括配信画面の一覧表示項目および検索条件項目を指定してください。
詳細な説明はこちら「【Agentファイル】一括配信機能の使い方と画面解説」をご参照ください。
■一括配信画面検索条件項目
一括配信画面の「検索条件」に使用する項目を設定します。
①「一括配信画面検索条件項目」の「新規」ボタンをクリックします。
②設定を行い保存します。
📂 設定箇所の説明(クリックで開閉)
📘 表示ラベル:
一括配信画面の検索条件で、入力欄の上に表示するラベル名の設定を行います。
📘 カスタムメタデータレコード名:
アンダースコアと英数字のみで、ユニークな値を設定します。ほかの配信設定で使用しているメタデータレコード名は使用できません。
📘有効:
無効化すると、検索条件に表示されなくなります。
📘 項目名:
検索条件に使用する項目を、ドキュメント配信オブジェクトのAPI参照名で指定します。
参照関係項目を使用する場合は、以下の形式で設定してください。
| 設定内容 | 入力形式 |
|---|---|
| 参照関係項目 | {__cを__rに変更したAPI参照名}.{参照先項目のAPI参照名} |
入力例(請求オブジェクトの取引先項目を設定する場合)
使用可能なデータ型
| 対応状況 | 項目タイプ |
|---|---|
| ✅ 対応済み | テキスト、参照関係、主従関係、選択リスト、日付、日付/時間、メール、地理情報、電話、テキストエリア、URL |
| ⚠️ 一部制限あり | 通貨、数値、パーセント(少数を含む場合に想定通り動作しない) |
| ❌ 未対応 | チェックボックス、時間 |
| 🚫 Salesforce仕様上使用不可 | リッチテキストエリア、ロングテキストエリア |
📘表示順序:
検索条件に表示する項目の「並び順」を指定します。数値が小さいほど上に表示され、未入力の場合は下に表示されます。
入力できるのは 0〜99999 の範囲で、ほかの配信設定と同じ数字は使えません。
📘 デフォルト値:
入力した値をもとに、すでに絞り込まれた結果が表示されます。
選択リスト型項目を指定する場合、値のAPI参照名を指定してください。
■一括配信画面表示項目
一括配信画面の「検索結果」に使用する項目を設定します。
①「一括配信画面表示項目」の「新規」ボタンをクリックします。
②設定を行い保存します。
📂 設定箇所の説明(クリックで開閉)
📘 表示ラベル:
一括配信画面の検索結果に表示するラベル名の設定を行います。
📘 カスタムメタデータレコード名:
アンダースコアと英数字のみで、ユニークな値を設定します。ほかの配信設定で使用しているメタデータレコード名は使用できません。
📘有効:
無効化すると、検索結果に表示されなくなります。
📘 項目名:
検索条件に使用する項目を、ドキュメント配信オブジェクトのAPI参照名で指定します。
参照関係項目を使用する場合は、以下の形式で設定してください。
| 設定内容 | 入力形式 |
|---|---|
| 参照関係項目 | {__cを__rに変更したAPI参照名}.{参照先項目のAPI参照名} |
入力例(請求オブジェクトの取引先項目を設定する場合
📘表示順序:
検索条件に表示する項目の「並び順」を指定します。数値が小さいほど左に表示され、未入力の場合は右に表示されます。
入力できるのは 0〜99999 の範囲で、ほかの配信設定と同じ数字は使えません。
🔻2-2. テナント設定
マイページ(ドキュメント管理アプリケーション)とSalesforceを連携するためのテナント情報を設定します。
| 連携する環境 | 指定する情報 |
|---|---|
検証環境 |
検証環境のマイページのテナント情報 |
本番環境 |
本番環境のマイページのテナント情報 |
📂 設定箇所の説明(クリックで開閉)
📘 テナントID:
マイページのテナントIDを入力します。
📘 ログインID:
マイページのシステム管理者設定>API接続ユーザー設定で設定したログインIDを指定します。
📌確認方法
システム管理者でマイページにログインいただき、[API接続ユーザー設定]>「ユーザー情報を更新する」から確認することができます。
📘パスワード:
マイページの[システム管理者設定]>[API接続ユーザー設定]で設定したパスワードを指定します。
📌お忘れの場合
「パスワードを変更する」にチェックをいれていただくことで変更可能です。
⚠️編集モードではセキュリティ上の理由で実際の文字数とは異なる桁数で表示されます。
📘 アクセストークン:
マイページの[システム管理者設定]>[API接続ユーザー設定]で表示されるアクセストークンを入力します。
リセットすることも可能です。
⚠️編集モードではセキュリティ上の理由で実際の文字数とは異なる桁数で表示されます。
📘 CID:
オプロからご案内しているCID(CXから始まるもの)を設定してください。
📘ベースURL:
オプロからご案内しているベースURLを設定してください。
🔻2-3. ジョブスケジュール設定
バッチ処理のジョブスケジュールを設定します。
帳票作成処理と配信処理の実行間隔を設定します。
処理は設定した間隔の区切り時刻に実行されます(例:5分間隔 → 0, 5, 10…分)。 そのため、生成ボタンを押してもすぐには実行されず、次の実行タイミングまで待機します。
⚠️帳票作成と配信は別々のジョブとして動作します。
例1:9/25 10時00分に実行した場合(ジョブスケジュール設定はどちらも5分間隔)
10:00 ステータス「作成予約済」
10:05 帳票作成処理実行 → ステータス「作成中」
10:10 配信処理実行 → ステータス「配信中」
例2:9/26 10時19分に実行した場合(ジョブスケジュール設定はどちらも5分間隔)
10:19 ステータス「作成予約済」
10:20 帳票作成処理実行 → ステータス「作成中」
10:25 配信処理実行 → ステータス「配信中」📂 項目の説明(クリックで開閉)
📘ドキュメント作成ジョブ:
「ドキュメント配信履歴」のステータスが「作成予約済」となってから、実際にドキュメントの作成処理を実行するまでの処理間隔を指定します。
帳票DXでの1時間あたりのリクエスト制限数を超えないように動きます。
📘ドキュメント配信ジョブ:
「ドキュメント配信履歴」のステータスが「配信予約済」となってから、実際にドキュメントの配信処理を実行するまでの処理間隔を指定します。
📘ドキュメント配信履歴削除ジョブ:
「ドキュメント配信履歴」の保有期間を指定します。
配信に関する設定方法の説明は以上です。