セットアップ手順

セットアップ手順セットアップの準備セットアップの実施手順バージョンアップ手順アンインストール手順セットアップの準備セットアップ実行手順の概略SMPforSalesforceを利用するには、Salesforceへのアプリケーションのインストールの他に、SMPのAPIキー情報の登録など、いくつかの設定が必要です。SMPforSalesforceのインストールURLを取得し、対象SFDC組織にインストールしますSMPのAPIキーを取得し、SMPforSalesforceのSMP接続設定にてAPIキー情報を設定しますSFDCのリモートサイトの設定に、SMPのURLを追加します連携ログ参照のためのレポートIDを設定します連携停止検知のために必要な設定を追加します必要な要件は、次のとおりです。必要なものSMPforSalesforceのセットアップには環境や情報が必要となります。次をご確認ください。SFDC組織データ連携対象となるSFDC組織、すなわち、SMPforSalesforceをインストールするSFDC組織が必要です。SMPforSalesforceはSFDCの各エディションにインストール可能です。SMPforSalesforceを設定するため、インストールしたアプリケーションを利用する、あるいは特定のプロファイルで利用可能とするための設定が可能な権限を持つ管理者アカウントが必要です。事前の検証などを行う場合は、対象組織のSandboxやテスト組織を予め準備するとよいでしょう。SFDC組織のユーザSFDC組織のシステム管理者、または、同等の権限を持つユーザが必要です。注意オブジェクトマッピング機能にて、SOQLを記述する機能を実行するためには、プロファイルの権限で「すべてのデータを参照」にチェックがついているユーザが必要です。これは、任意のオブジェクトへの参照が可能となるため、相応の権限を持つユーザが設定可能であることを保証するための制限です。アプリケーションのインストールURLSMPforSalesforceをインストールするためのURLです。最新バージョンをインストールするための具体的なURLは担当営業までお問い合わせ下さい。インストールURLはたとえば、以下のような形式のものです(実際のインストールURLとは異なります)。なお、サンドボックスをインストール先とする場合は、ドメイン名がtest.salesforce.comとなります。ドメインデータ連携対象となるSMPドメインが必要です。また、連携内容を確認するために、SMP管理者アカウントを準備する必要があります。こちらも事前検証などを行う場合は、予めサンドボックスドメインの作成をお勧めします。対象SMPドメインのAPIキーデータ連携対象となるSMPドメインに対して発行された、有効なAPIキー、シークレット、パスワードの情報が必要です。サンドボックスを利用する場合は、本番ドメイン用のものとは別に、サンドボックスドメイン用のAPIキー情報の発行が必要です。APIキーは、SMPforSalesforce専用に発行されたものをご利用ください。また、SMPforSalesforceのために発行されたAPIキーは他の用途にはご利用いただけませんので、予めご了承ください。APIキーの情報や発行等については、弊社担当営業へお問い合わせください。セットアップの実施手順アプリケーションのインストールブラウザから、SMPforSalesforceのインストールURLにアクセスしますSFDCにログインしていない場合、アプリケーションをインストールするSFDC組織の管理者アカウントでログインしますインストール対象ユーザーを選択して[インストール]をクリックしますインストール対象には通常、[管理者のみのインストール]を選択しますここではSMPforSalesforceを操作して連携設定や連携ログの参照を行うユーザーを指定します対象Salesforce組織で権限管理について特別の制約がある場合は、組織のポリシーに従ってインストール対象ユーザーまたはプロファイルを選択してください。不明点がある場合は、組織のSalesforceを管轄している担当者にお問い合わせくださいインストール処理が進むのでしばらく待ちますインストールが完了すると、完了画面が表示され、インストール実行した管理者のメールアドレス宛に完了を通知するメールが送信されますインストールに時間がかかる場合、完了通知メールの到着を待ってインストールされたことを確認してくださいインストール済みパッケージ一覧にSMPforSalesforceが表示されますインストール直後は状況が「トライアル」となる場合がありますが、利用開始の手続きが正しく処理されると、状況が「有効」となり、利用期限も無期限となりますインストール完了後、画面右上のForce.comアプリケーションメニューにてSMPforSalesforceを選択すると、各メニューが表示されます(SalesforceClassicの画面の場合)LightningExperienceの場合、アプリケーションランチャーから同様にSMPforSalesforceを選択しますSMP接続設定の登録SMPにAPI接続するため、対象SMPのURL、APIキー、APIシークレット、パスワードを設定します。画面右上のForce.comアプリケーションメニューで「SMPforSalesforce」が選択されていない場合は選択します[SMP接続設定一覧]タブをクリックし、[新規作成]をクリックします次の項目を入力し、[保存]をクリックします接続名対象となるSMPのURL(例:キーAPIシークレットAPIパスワード有効フラグ:この設定を有効にする場合は、チェックします説明(オプション)注意設定したAPIキー、APIシークレット、APIパスワードは暗号化して保存されます。一度保存した内容は暗号化された文字列としてしか表示されず、暗号化前の具体的な値を確認することはできません。暗号化された文字列を編集すると、APIキー情報が変更され、SMPにAPI接続できなくなります。暗号化された文字列は変更を一切加えずにそのまま保存するか、暗号化する前の文字列を入力してください。SMP接続設定の有効・無効の切り替え一度保存した設定の有効・無効を切り替える場合は、次の手順を実施します。[SMP接続設定一覧]タブをクリックします対象の設定の[有効]欄のチェックをつけて有効にします無効にする場合はチェックを外しますSMP接続設定の削除保存した設定を削除する場合は、次の手順を実施します。[SMP続設定]タブをクリックし、対象の設定の[編集]リンクをクリックします内容を確認し、削除する場合は[削除]をクリックして設定を削除しますリモートサイトの設定SFDCからSMPへの接続を許可するため、リモートサイトの設定にSMPのURLを追加します。[設定]から左上のクイック検索で「リモートサイトの設定」を検索し、サイドメニューから[リモートサイトの設定]をクリックします[新規リモートサイト]をクリックします次の項目を入力し、[保存]をクリックしますリモートサイト名:任意の名前を入力しますリモートサイトのURL:対象のSMPのURL(例:ログ保存期間の設定連携処理を実行すると処理結果が「SMP_ログ」オブジェクトに連携ログとして保存されます。連携ログのデータは、ログ保存期間に設定した期間を経過すると削除されます。デフォルトは5日になっており、連携処理に問題があった場合に備えてなるべく長い期間残しておいたほうが無難ですが、データ量が多いほどデータ容量を消費するので、使用可能な容量の程度に応じて日数を設定します。(最大999日)[SMP接続設定一覧]タブをクリックします「ログ保存期間：」の欄に日数を入力し、[更新]ボタンをクリックします注意「更新」ボタンをクリックしないとログ保存期間の設定が反映されないのでご注意ください連携ログのデータ量は連携処理の内容と実際に連携するデータ量によって異なります。実際に連携処理の結果保存されるデータ量や消費されるデータ容量をみて、日数を調整してください。連携対象データがない場合でも、１連携ジョブあたり最低1~2KB消費します。データ容量の消費状況は、設定から「組織のディスク使用量」で確認できます。[設定]から左上のクイック検索で、「組織のディスク使用量」で検索し、サイドメニューから[組織のディスク使用量]をクリックします「SMP_ログ」の消費データ量や全体に占める割合を確認します連携ログレポートのレポートID設定連携ログの内容は、Salesforceのレポート機能を利用して表示します。連携ジョブからログレポートを参照するためにインストール組織ごとの実際のIDを設定します。レポートIDを確認します「レポート」タブを開いて、SMPforSalesforceフォルダから[SMPログレポート]を開きます開いた画面のURLより、レポートIDを確認しますレポートIDを設定します[設定]→左上のクイック検索より「カスタム設定」で検索、サイドメニューからカスタム設定へ遷移しますカスタム設定「SMPログ設定」の[Manage]をクリックします[新規]ボタンをクリックします「SMPログレポートID」に前段で確認したレポートIDを入力して保存します連携ジョブの停止検知機能のための設定連携ジョブの停止検知機能について定期実行するように設定した連携ジョブは可能な限り動作し続けるように実装されていますが、何らかの理由（例えば、Salesforceのインフラ不具合等）により定期実行が停止してしまう可能性があります。SMPforSalesforceでは、連携ジョブを２つの機能により監視することで、停止した可能性を検知します。連携ジョブ監視イベント(Apexジョブ方式)連携ジョブそのものと同じように、監視処理をジョブとして実行実行中にならないまま「次回実行日時」を一定時間経過してしまっているジョブを検知して、設定したメールアドレス（複数可）宛に通知指定の曜日・時間のバッチ実行による定期チェック補足詳細設定方法は「連携ジョブ監視機能のための設定(Apexジョブ方式編)」をご参照ください。連携ジョブ監視ルール(ワークフロー方式)Apexジョブのキューが詰まってしまった場合など、Apexジョブ方式も動作不可能なケースのために別の仕組みであるワークフローを利用「次回実行日時」を一定時間経過してしまっているジョブを検知して、対象連携ジョブの「エラー通知先」に通知「次回実行日時」からの相対時間で１回のみチェックこれらの監視機能を有効にするためにいくつか設定が必要です。補足詳細設定方法は「連携ジョブ監視機能のための設定(ワークフロー方式編)」をご参照ください。連携ジョブ監視機能のための設定(Apexジョブ方式編)Apexジョブによる検知のために必要な設定を説明します。Apexジョブ方式のために必要な設定カスタム設定の追加通知先:停止の可能性を検知した場合に通知するメールアドレスエラーメール送信先ID:監視イベント自体が異常終了した場合の通知先となるユーザーのID条件期間(時間):何時間経過した場合に停止していると判断するかApexクラスをスケジュールApexクラス[RenkeiJobKanshiBatchScheduler]を任意の時刻に起動するように設定Apexジョブ方式の設定エラー時通知先ユーザのIDを確認監視イベント自体が予期しないエラーで失敗した場合の通知先となるユーザを決定し、そのユーザIDを確認します[ユーザの管理][ユーザ]から対象ユーザの詳細を開き、URLに表示される16桁のIDを確認カスタム設定「連携ジョブ監視設定」「SMPforSalesforce連携ジョブ監視設定」の[Manage]をクリックします[編集]をクリックします「デフォルトの組織レベルの値」を変更します「エラーメール送信先ID」に前段で確認したエラーメール送信先となるユーザのIDを入力「条件期間(時間)」に、停止判断の基準となる時間を入力通常の連携処理にかかる想定時間よりも長い時間を設定します連携ジョブの「次回実行日時」が、ここで設定した時間以上経過している場合、通知しますカスタム設定「連携ジョブ監視_メール送信先」「SMPforSalesforce連携ジョブ監視設定_メール送信先」の[Manage]をクリックします[新規]をクリックします設定を追加しますNameに任意の名前を入力します送信先に、停止している可能性のあるジョブを検知した場合に通知するメールアドレスを設定します複数の送信先に送りたい場合は、さらに設定を追加しますApexをスケジュール[設定][開発][Apexクラス]から、「Apexをスケジュール」へ任意のジョブ名を入力しますApexクラスにRenkeiJobKanshiBatchSchedulerを指定します監視チェックを実行したい曜日、期間、希望開始時刻を指定しますApexスケジュールを複数登録することで１日複数回チェックすることも可能Apexジョブ方式の設定の確認設定したApexジョブスケジュールは、「スケジュール済みジョブ」にて確認できます任意の連携ジョブを編集して、「次回実行日時」が過去でかつ「有効」の連携ジョブを作成すると、指定時刻にアラートが送信されます一度登録したスケジュールは編集できないので、内容を変更する場合は削除して新規登録しますなお、「SMP_SFDC_API_JOB」は連携ジョブ自体の定期実行スケジュールなので削除しないでください連携ジョブ監視機能のための設定(ワークフロー方式編)続いて、ワークフロー方式の設定方法を説明しますワークフロー方式による検知のための設定連携ジョブを対象オブジェクトとしたワークフロールールを新規登録対象のオブジェクト(連携ジョブ)を指定ルール名や条件等の設定タイムトリガを追加し、アクションに「連携ジョブ監視メール」を選択登録したワークフローを有効化ワークフローの設定ワークフローの新規登録[設定][作成][ワークフローと承認申請][ワークフロールール]から新規ルールを作成しますワークフロールールを適用するオブジェクトとして「連携ジョブ」を選択して次へ進みますワークフロールールを設定しますルール名は「連携ジョブ死活監視ルール」とし、説明の内容は任意で入力してください評価条件に「作成されたとき、およびその後基準を満たすように編集されたとき」を選択します「次の場合にこのルールを実行」で「数式の評価がtrueになる」を選択し、以下の数式を入力します。(SMPCOOP__C_Job_Flag__c=False||SMPCOOP__C_Job_Flag__c=True)&&SMPCOOP__Enabled__c=Trueワークフローにタイムトリガを追加します「次回実行日時」よりどれだけ時間が経過したら異常とみなすかによって、時間を設定します。図の例では、12時間を経過した場合にアラートを送信するようにしていますタイムトリガにアクションを設定する追加したタイムトリガに、ワークフローアクションを設定します。「既存アクションの選択」を選択しますアクション種別の選択で検索項目を「メールアラート」として、「メールアラート：連携ジョブ監視メール」を選択します。ワークフロー作成の完了「完了」をクリックしてワークフロー作成を終了します。作成したワークフローを「有効化」しますデフォルトのワークフローユーザが未設定の場合「デフォルトのワークフローユーザ」が設定されていない場合、有効化のタイミングでその設定を促される可能性があります[設定][作成][ワークフローと承認申請][プロセスの自動化設定]から、デフォルトユーザの設定状況を確認可能ですワークフロー方式の設定の確認実際に連携ジョブが開始し、実行中フラグが立つと、「時間ベースのワークフロー」から予定されたメール送信アクションを確認することができます正常にジョブ終了して実行中フラグが外れた場合、キューからは削除されます設定した時間を経過した後もこのキューが残っている場合、設定した宛先にメールが送信されます動作確認のために、ダミーの連携ジョブをひとつ登録して、手動で実行中フラグを立ててみるとよいでしょうバージョンアップ手順正規の手続きでインストールされたSMPforSalesforceのアプリケーションは原則、バージョンアップに伴い最新版に強制アップデートされます。なんらかの理由でアップデートされなかったアプリケーションについては、以下の手順で更新することができます。バージョンアップ手順SMPforSalesforceの新しいバージョンのインストールURLにアクセスすることで、アプリケーションをアップデートすることができます。バージョンアップ対象のSFDCにシステム管理者としてログインします。更新前に連携ジョブの一覧を表示し、既存のジョブが実行中でないこと(実行中フラグが立っていないこと)を確認します。既存の連携ジョブ設定の「有効」フラグをすべて一時的にOFFにします。新しいバージョンのインストールURLを開きます。インストール時と同様、ウィザードに従って新しいバージョンのアプリケーションをインストールします実行する連携ジョブについて、再度「有効」フラグを立てます注意・バージョンアップによって新しく追加された設定項目や選択肢などは、ページレイアウトへ追加したり、オブジェクトごとの設定で選択肢として追加する必要があります。「補足事項のバージョンごとの留意事項」を参照の上、必要な追加作業を実施してください。・ベータ版などをインストールしている場合は、アプリケーションをアップデートできません。一度アンインストールして再度、インストールする必要があります。この場合、設定データやアプリに追加した項目などは再登録する必要があります。アンインストール手順SMPforSalesforceの利用を停止する場合は、弊社担当営業までご連絡ください。停止手続き後、アプリケーションを以下の手順でアンインストールしてください。アンインストール手順インストールしたアプリケーションを削除します[設定][インストール済みパッケージ]をクリックします「SMPforSalesforce」のアクション列に表示されている[アンインストール]リンクをクリックしますアンインストールされるコンポネント(Apexクラス、タブ、カスタムオブジェクト等)一覧が表示されるので内容を確認し、データのコピーを保存するかどうかを選択し、[アンインストール]ボタンをクリックしてアンインストールを実行しますリモートサイトの設定に追加したSMPの設定を削除します[設定][リモートサイトの設定]をクリックします連携対象のSMPのURLの設定を削除します注意ベータ版などをインストールしている場合は、アプリケーションをアップデートできません。一度アンインストールして再度、インストールする必要があります。この場合、設定データやアプリに追加した項目などは再登録する必要があります。