セットアップ手順

セットアップの準備

セットアップ実行手順の概略

SMP for Salesforce を利用するには、 Salesforce へのアプリケーションのインストールの他に、SMP の API キー情報の登録など、いくつかの設定が必要です。

  1. SMP for Salesforce のインストールURLを取得し、対象SFDC組織にインストールします

  2. SMP の API キーを取得し、SMP for Salesforce の SMP 接続設定 にてAPI キー情報を設定します

  3. SFDC のリモートサイトの設定に、 SMP のURLを追加します

  4. 連携ログ参照のためのレポートIDを設定します

  5. 連携停止検知のために必要な設定を追加します

以下で必要な要件を確認ください。

必要なもの

SMP for Salesforce のセットアップには以下の環境や情報が必要となります。

SFDC組織

データ連携対象となる SFDC 組織、すなわち、SMP for Salesforce をインストールする SFDC 組織が必要です。SMP for Salesforce は SFDC の各エディションにインストール可能です。
SMP for Salesforce を設定するため、インストールしたアプリケーションを利用する、あるいは特定のプロファイルで利用可能とするための設定が可能な権限を持つ管理者アカウントが必要です。
事前の検証などを行う場合は、対象組織の Sandbox やテスト組織を予め準備するとよいでしょう。

SFDC組織のユーザ

SFDC組織のシステム管理者、または、同等の権限を持つユーザが必要です。
注: オブジェクトマッピング機能にて、 SOQL を記述する機能を実行するためには、プロファイルの権限で「すべてのデータを参照」にチェックがついているユーザが必要です。これは、任意のオブジェクトへの参照が可能となるため、相応の権限を持つユーザが設定可能であることを保証するための制限です。

アプリケーションのインストールURL

SMP for Salesforce をインストールするためのURLです。最新バージョンをインストールするための具体的な URL は担当営業までお問い合わせ下さい。

インストール URL はたとえば、以下のような形式のものです。(実際のインストール URL とは異なります)
https://login.salesforce.com/packaging/installPackage.apexp?p0=04t990000999AAA

なお、サンドボックスをインストール先とする場合は、ドメイン名が test.salesforce.com となります。
https://test.salesforce.com/packaging/installPackage.apexp?p0=04t990000999AAA

SMP ドメイン

データ連携対象となる SMP ドメインが必要です。また、連携内容を確認するために、SMP 管理者アカウントを準備する必要があります。
こちらも事前検証などを行う場合は、予めサンドボックスドメインの作成をお勧めします。

対象 SMP ドメインの APIキー

データ連携対象となる SMP ドメインに対して発行された、有効な API キー、シークレット、パスワードの情報が必要です。
サンドボックスを利用する場合は、本番ドメイン用のものとは別に、サンドボックスドメイン用の API キー情報の発行が必要です。
API キーは、 SMP for Salesforce 専用に発行されたものをご利用ください。また、 SMP for Salesforce のために発行された API キーは他の用途にはご利用いただけませんので、予めご了承ください。
API キーの情報や発行等については、弊社担当営業へお問い合わせください。

セットアップの実施手順

アプリケーションのインストール

  1. ブラウザから、 SMP for Salesforce のインストールURLにアクセスします

  2. SFDC にログインしていない場合、アプリケーションをインストールする SFDC 組織のアカウントでログインします

  3. 画面右上の、Force.com アプリケーションメニューにて SMP for Salesforce が選択すると、各メニューが表示されます

image13.png
図 1. Force.com アプリケーションメニュー

SMP接続設定の登録

SMP に API 接続するため、対象 SMP の URL、API キー、API シークレット、パスワードを設定します。

  1. 画面右上の Force.com アプリケーションメニューで 「SMP for Salesforce」が選択されていない場合は選択します

  2. [SMP接続設定一覧] タブをクリックし、[新規作成] をクリックします

  3. 以下の項目を入力し、 [保存] をクリックします

    • 接続名

    • 対象となる SMP の URL (例: https://demo-example.smktg.jp )

    • API キー

    • API シークレット

    • API パスワード

    • 有効フラグ: この設定を有効にする場合は、チェックします

    • 説明 (オプション)

注意: 保存した API 情報は暗号化されます

設定した API キー、APIシークレット、APIパスワードは暗号化して保存されます。一度保存した内容は暗号化された文字列としてしか表示されず、暗号化前の具体的な値を確認することはできません。
暗号化された文字列を編集すると、 API キー情報が変更され、 SMP に API 接続できなくなります。暗号化された文字列は変更を一切加えずにそのまま保存するか、暗号化する前の文字列を入力してください。

SMP 接続設定の有効・無効の切り替え

一度保存した設定の有効・無効を切り替える場合は、以下の手順を実施します。

  1. [SMP接続設定一覧] タブをクリックします

  2. 対象の設定の [有効] 欄のチェックをつけて有効にします

    • 無効にする場合はチェックを外します

image03.png
図 2. SMP接続設定一覧
SMP 接続設定の削除

保存した設定を削除する場合は、以下の手順を実施します。

  1. [SMP接続設定] タブをクリックし、対象の設定の [編集] リンクをクリックします

  2. 内容を確認し、削除する場合は [削除] をクリックして設定を削除します

リモートサイトの設定

SFDC から SMP への接続を許可するため、リモートサイトの設定に SMP の URL を追加します。

  1. [設定] から左上のクイック検索で 「リモートサイトの設定」を検索し、サイドメニューから [リモートサイトの設定] をクリックします

  2. [新規リモートサイト] をクリックし、以下の項目を入力し、[保存] をクリックします

    • リモートサイト名: 任意の名前を入力します

    • リモートサイトの URL: 対象の SMP のURL (例: https://demo-example.smktg.jp )

image20.png
図 3. リモートサイトの設定

ログ保存期間の設定

連携処理を実行すると処理結果が「SMP_ログ」オブジェクトに連携ログとして保存されます。連携ログのデータは、ログ保存期間に設定した期間を経過すると削除されます。デフォルトは 5 日になっており、連携処理に問題があった場合に備えてなるべく長い期間残しておいたほうが無難ですが、データ量が多いほどデータ容量を消費するので、使用可能な容量の程度に応じて日数を設定します。(最大999日)

  1. [SMP接続設定一覧] タブをクリックします

  2. 「ログ保存期間:」の欄に日数を入力し、[更新] ボタンをクリックします

    1. [更新] ボタンをクリックしないとログ保存期間の設定が反映されないので、ご注意ください

SMPLogExpireSetting.png
図 4. ログ保存日数の設定

連携ログのデータ量は連携処理の内容と実際に連携するデータ量によって異なります。実際に連携処理の結果保存されるデータ量や消費されるデータ容量をみて、日数を調整してください。(連携対象データがない場合でも、1連携ジョブあたり最低 1~2KB 消費します)

データ容量の消費状況は、設定から「組織のディスク使用量」で確認できます。

  1. [設定] から左上のクイック検索で、「組織のディスク使用量」で検索し、サイドメニューから「組織のディスク使用量」をクリックします

  2. 「SMP_ログ」の消費データ量や全体に占める割合を確認します

CompanyResourceDisk.png
図 5. 組織のディスク使用量

連携ログレポートのレポートID設定

連携ログの内容は、Salesforce のレポート機能を利用して表示します。連携ジョブからログレポートを参照するためにインストール組織ごとの実際の ID を設定します。

  1. レポートIDの確認

    1. 「レポート」タブを開いて、SMP for Salesforce フォルダから 「SMPログレポート」を開きます

    2. 開いた画面の URL より、レポートIDを確認します

SMPLogReportID.png
図 6. レポートIDの確認
  1. レポートIDの設定

    1. [設定] → 左上のクイック検索より「カスタム設定」で検索、サイドメニューからカスタム設定へ

    2. カスタム設定「SMPログ設定」の [Manage] をクリックします

    3. [新規] ボタンをクリックし、「SMPログレポートID」に前段で確認したレポートIDを入力して保存します

SMPLogReportIDSetting.png
図 7. カスタム設定「SMPログ設定」へ
SMPLogReportIDSettingEdit.png
図 8. カスタム設定「SMPログ設定」レポートID設定

連携ジョブの停止検知機能のための設定

連携ジョブの停止検知機能について

定期実行するように設定した連携ジョブは可能な限り動作し続けるように実装されていますが、何らかの理由(たとえば、Salesforce のインフラ不具合等)により定期実行が停止してしまう可能性があります。 SMP for Salesforce では、連携ジョブを2つの機能により監視することで、停止した可能性を検知します。

  1. 連携ジョブ監視イベント (Apexジョブ方式)

    • 連携ジョブそのものと同じように、監視処理をジョブとして実行

    • 実行中にならないまま「次回実行日時」を一定時間経過してしまっているジョブを検知して、設定したメールアドレス(複数可)宛に通知

    • 指定の曜日・時間のバッチ実行による定期チェック

  2. 連携ジョブ監視ルール (ワークフロー方式)

    • Apexジョブのキューが詰まってしまった場合など、 Apex ジョブ方式も動作不可能なケースのために別の仕組みであるワークフローを利用

    • 「次回実行日時」を一定時間経過してしまっているジョブを検知して、対象連携ジョブの「エラー通知先」に通知

    • 「次回実行日時」からの相対時間で1回のみチェック

これらの監視機能を有効にするためにいくつか設定が必要です。

連携ジョブ監視機能のための設定 (Apexジョブ方式編)

Apexジョブによる検知のために必要な設定を説明します。

  • Apexジョブ方式 のために必要な設定

    1. カスタム設定の追加

      1. 通知先: 停止の可能性を検知した場合に通知するメールアドレス

      2. エラーメール送信先ID: 監視イベント自体が異常終了した場合の通知先となるユーザーのID

      3. 条件期間(時間): 何時間経過した場合に停止していると判断するか

    2. Apex クラスをスケジュール

      1. Apex クラス[RenkeiJobKanshiBatchScheduler]を任意の時刻に起動するように設定

Apex ジョブ方式の設定
  1. エラー時通知先ユーザの ID を確認

    1. 監視イベント自体が予期しないエラーで失敗した場合の通知先となるユーザを決定し、そのユーザIDを確認します

    2. [ユーザの管理]→[ユーザ] から対象ユーザの詳細を開き、URLに表示される 16桁の ID を確認

ApexJobErrorUserID.png
図 9. ユーザーIDの確認
  1. カスタム設定「連携ジョブ監視設定」

    1. 「SMP for Salesforce連携ジョブ監視設定」の「Manage」をクリックします

    2. 「編集」をクリックして、「デフォルトの組織レベルの値」を変更します

ApexJobCustomSetting.png
図 10. カスタム設定「連携ジョブ監視設定」
  1. 「エラーメール送信先ID」に 前段で確認したエラーメール送信先となるユーザの ID を入力

  2. 「条件期間(時間)」に、停止判断の基準となる時間を入力

    • 通常の連携処理にかかる想定時間よりも長い時間を設定します

    • 連携ジョブの「次回実行日時」が、ここで設定した時間以上経過している場合、通知します

ApexJobCustomSettingEdit.png
図 11. カスタム設定「連携ジョブ監視設定」の編集
  1. カスタム設定「連携ジョブ監視_メール送信先」

    1. 「SMP for Salesforce連携ジョブ監視設定_メール送信先」の「Manage」をクリックします

    2. 「新規」をクリックして、設定を追加します

ApexJobCustomSettingEmailTo.png
図 12. カスタム設定「連携ジョブ監視_メール送信先」
  1. Name に任意の名前を入力します

  2. 送信先に、停止している可能性のあるジョブを検知した場合に通知するメールアドレスを設定します

  3. 複数の送信先に送りたい場合は、さらに設定を追加します

ApexJobCustomSettingEmailToEdit.png
図 13. カスタム設定「連携ジョブ監視_メール送信先」の編集
  1. Apex をスケジュール

    1. [設定]→[開発]→[Apexクラス] から、「Apex をスケジュール」へ

ApexJobSchedule.png
図 14. Apexをスケジュール
  1. 任意のジョブ名を入力します

  2. Apex クラスに RenkeiJobKanshiBatchScheduler を指定します

  3. 監視チェックを実行したい曜日、期間、希望開始時刻を指定します

ApexJobScheduleEdit.png
図 15. Apexスケジュールを入力
  • Apexスケジュールを複数登録することで1日複数回チェックすることも可能

Apexジョブ方式 の設定の確認
  • 設定した Apex ジョブスケジュールは、「スケジュール済みジョブ」にて確認できます

    • 任意の連携ジョブを編集して、「次回実行日時」が過去でかつ「有効」の連携ジョブを作成すると、指定時刻にアラートが送信されます

  • 一度登録したスケジュールは編集できないので、内容を変更する場合は削除して新規登録します

    • なお、「SMP_SFDC_API_JOB」は連携ジョブ自体の定期実行スケジュールなので削除しないでください

連携ジョブ監視機能のための設定 (ワークフロー方式編)

続いて、ワークフロー方式の設定方法を説明します

  • ワークフロー方式による検知のための設定

    1. 連携ジョブを対象オブジェクトとしたワークフロールールを新規登録

      1. 対象のオブジェクト(連携ジョブ)を指定

      2. ルール名や条件等の設定

      3. タイムトリガを追加し、アクションに「連携ジョブ監視メール」を選択

    2. 登録したワークフローを有効化

ワークフローの設定
  1. ワークフローの新規登録

    1. [設定]→[作成]→[ワークフローと承認申請]→[ワークフロールール] から新規ルールを作成します

WorkFlow01NewWorkFlow.png
図 16. ワークフローの新規登録
  1. ワークフロールールを適用するオブジェクトとして「連携ジョブ」を選択して次へ進みます

WorkFlow02TargetObject.png
図 17. ワークフローの対象オブジェクト選択
  1. ワークフロールールを設定します

    1. ルール名は「連携ジョブ死活監視ルール」とし、説明の内容は任意で入力してください

    2. 評価条件に「作成されたとき、およびその後基準を満たすように編集されたとき」を選択します

    3. 「次の場合にこのルールを実行」で「数式の評価がtrueになる」を選択し、以下の数式を入力します。
      (SMPCOOPC_Job_Flagc = False || SMPCOOPC_Job_Flagc = True)&& SMPCOOPEnabledc = True

WorkFlow03RuleEdit.png
図 18. ワークフローのルール入力
  1. ワークフローにタイムトリガを追加します

    1. 「次回実行日時」よりどれだけ時間が経過したら異常とみなすかによって、時間を設定します。

    2. 図の例では、12時間を経過した場合にアラートを送信するようにしています

WorkFlow04AddTimeTrigger.png
図 19. ワークフローのタイムトリガの追加へ
WorkFlow05TimeTriggerEdit.png
図 20. ワークフローのタイムトリガを設定
  1. タイムトリガにアクションを設定する

    1. 追加したタイムトリガに、ワークフローアクションを設定します。「既存アクションの選択」を選択します

    2. アクション種別の選択で検索項目を「メールアラート」として、「メールアラート:連携ジョブ監視メール」を選択します。

WorkFlow06SetAction.png
図 21. ワークフローのアクションの設定
WorkFlow07SelectAction.png
図 22. ワークフローの既存アクションの選択
  1. ワークフロー作成の完了

    1. 「完了」をクリックしてワークフロー作成を終了します。

WorkFlow08RuleComplete.png
図 23. ワークフロー作成の完了
  1. 作成したワークフローを「有効化」します

WorkFlow09Enable.png
図 24. ワークフローの有効化
  1. デフォルトのワークフローユーザが未設定の場合

    • 「デフォルトのワークフローユーザ」が設定されていない場合、有効化のタイミングでその設定を促される可能性があります

    • [設定]→[作成]→[ワークフローと承認申請]→[プロセスの自動化設定] から、デフォルトユーザの設定状況を確認可能です

WorkFlow10DefaultUser.png
図 25. デフォルトのワークフローユーザーが未設定の場合
ワークフロー方式の設定の確認
  • 実際に連携ジョブが開始し、実行中フラグが立つと、「時間ベースのワークフロー」から予定されたメール送信アクションを確認することができます

  • 正常にジョブ終了して実行中フラグが外れた場合、キューからは削除されます

  • 設定した時間を経過した後もこのキューが残っている場合、設定した宛先にメールが送信されます

  • 動作確認のために、ダミーの連携ジョブをひとつ登録して、手動で実行中フラグを立ててみるとよいでしょう

WorkFlow11CheckWorkFlow.png
図 26. 時間ベースのワークフローの確認

バージョンアップ手順

正規の手続きでインストールされた SMP for Salesforce のアプリケーションは原則、バージョンアップに伴い最新版に強制アップデートされます。なんらかの理由でアップデートされなかったアプリケーションについては、以下の手順で更新することができます。

バージョンアップ手順

SMP for Salesforce の新しいバージョンのインストールURLにアクセスすることで、アプリケーションをアップデートすることができます。

  1. バージョンアップ対象の SFDC にシステム管理者としてログインします。

  2. 更新前に連携ジョブの一覧を表示し、既存のジョブが実行中でないこと(実行中フラグが立っていないこと)を確認します。

  3. 既存の連携ジョブ設定の「有効」フラグをすべて一時的に OFF にします。

  4. 新しいバージョンのインストールURLを開きます。

  5. インストール時と同様、ウィザードに従って新しいバージョンのアプリケーションをインストールします

  6. 実行する連携ジョブについて、再度「有効」フラグを立てます

注意
  • バージョンアップによって新しく追加された設定項目や選択肢などは、ページレイアウトへ追加したり、オブジェクトごとの設定で選択肢として追加する必要があります。[補足事項のバージョンごとの留意事項]を参照の上、必要な追加作業を実施してください。

  • ベータ版などをインストールしている場合は、アプリケーションをアップデートできません。一度アンインストールして再度、インストールする必要があります。この場合、設定データやアプリに追加した項目などは再登録する必要があります。

アンインストール手順

SMP for Salesforce の利用を停止する場合は、弊社担当営業までご連絡ください。停止手続き後、アプリケーションを以下の手順でアンインストールしてください。

アンインストール手順

  1. インストールしたアプリケーションを削除します

    1. [設定] → [インストール済みパッケージ] をクリックします

    2. 「SMP for Salesforce」のアクション列に表示されている [アンインストール] リンクをクリックします

    3. アンインストールされるコンポネント (Apex クラス、タブ、カスタムオブジェクト等) 一覧が表示されるので内容を確認し、データのコピーを保存するかどうかを選択し、[アンインストール] ボタンをクリックしてアンインストールを実行します

image25.png
図 27. インストール済みパッケージのアンインストール
  1. リモートサイトの設定に追加した SMP の設定を削除します

    1. [設定] → [リモートサイトの設定] をクリックします

    2. 連携対象の SMP の URL の設定を削除します

注意
  • SMP for Salesforce 以外で SMP へ接続しているプログラムが存在する場合、リモートサイトの設定は削除しないでください

検索結果 ""

    検索結果がありません ""