サポーターさん

突然ですが、皆さんはSalesforce workbench（ワークベンチ）を使ったことがありますか？

Salesforceの開発に携わった方は、開発者コンソールを使うことは多いと思いますが、リリースや運用保守でメタデータのバックアップを行うなどの機会がない方は使ったことがないという場合も多いと思います。

Workbenchには様々な機能があり、管理者や開発者にとっては開発者コンソール同様、非常に便利なツールとなります。

ワークベンチはWebブラウザから簡単にアクセスすることができ、Salesforce組織ともAPIで簡単に接続できます。さらにブラウザ上から直接クエリを発行したり、メタデータを取得（Retrieve）したり、デプロイ（Deploy）することもできます。

※Bulk、Rest ストリーミング、メタデータなどもサポートしています。

またよく利用されるパターンとして、本番環境で不要となったプログラムを削除するような場合にも利用されています。

1 Workbench概要

1-1. Workbenchとは

Salesforce Workbenchは、Salesforceプラットフォームのメタデータ管理やApexコードの実行、Salesforce APIを使ったデータへのアクセスなどを行う機能が提供されたWebベースのツール（サービス）です。

Workbench（ワークベンチ）を使うことで、システム管理者や開発者はプログラムコードを書くことなく、Webブラウザ上からの操作で簡単にメタデータを取得したり、APIを実行したりすることができます。

公式サイトのURLはこちら「Workbenchサイト（https://workbench.developerforce.com/login.php）」

1-2. 機能一覧

ワークベンチ（workbench）が現時点で提供している機能は以下の通りです。

以上のように、非常に実用性の高い機能が用意されています。

2.Workbenchの使い方

2-１． Workbenchへの接続方法

手順①Workbenchへログインするために以下の公式サイトへブラウザでアクセスします。

Workbenchサイト（https://workbench.developerforce.com/login.php）

• Environment（接続環境）を選択：Production（本番）、またはSandboxを選択します。
• API Version：利用したいAPIのバージョンを指定します。　※バージョンによって利用可能な機能が異なりるため注意

手順②「I agree to terms of service」にチェックを入れて、Login with Salesforceのボタンをクリックします。

手順③Salesforce組織にログインするためのユーザ名とパスワードを入力してログインを行います。

※すでにSalesforce組織にログインしているブラウザでWorkbenchを実行している場合は自動的に接続されます。

手順④Salesforce組織に接続後は、以下ワークベンチのメニューが表示されます。

各機能の利用方法は次の章で紹介します。

3. 機能紹介

3-1. メタデータ照会機能

①Standard ＆Custom Objects（標準＆カスタムオブジェクト）

指定したオブジェクトに関するメタデータ情報を参照することができます。※以下はユーザオブジェクトを照会した例

照会できる情報は以下の通り

• 属性
• 子リレーション
• フィールド（項目）
• レイアウト名

②Metadata Types & Components（メタデータタイプ＆コンポーネント）

メタデータタイプの確認やコンポーネントについての詳細情報（ID、名称、作成者/作成日、最終更新者/最終更新日など）の情報を確認することができます。

上記は、フローのメターデータを照会した例

③Session Information（セッション情報）

接続しているSalesforceインスタンスのセッション情報（サービスのエンドポイントなど）を確認することができます。

取得可能な情報

• APIのバージョン
• クライアントID
• エンドポイント

（ユーザ情報）

• プロファイル
• ロール
• ユーザ名
• ユーザID
• タイムゾーン、ユーザタイプなど

（組織）

• 添付ファイルの上限など

3-2. クエリ実行機能

①SOQL Query（SOQLクエリ実行）

SOQLを直接実行することができます。表示形式やソート順の指定が可能またフィルタ条件や取得レコードの上限の指定も可能です。そのほか、削除済み、アーカイブレコードを含めるかなどの指定もできます。

SOQL実行結果

②Async SOQL Query

非同期のSOQL(Insert/Upsert）の実行ができます。

③SOSL Search

SOSL（Salesforce Object Search Language) の実行が可能です。※Salesforceのレコード内のテキスト検索を実行

SOSLの実行結果（CCLTという文字列での検索を実行）

④Streaming Push Topics

本機能は、Salesforceのレコードを監視し、本機能で登録したSOQLクエリに該当した場合に、あらかじめ購読（Subscribe登録）されたクライアントに対して、プッシュ通知を実現するものとなります。

以下のメッセージが表示される場合は、Salesforce組織のストリーミングAPIの有効化がされていないため、先に設定しておく必要があります。また本機能を使う場合には、事前にSalesforce側でプッシュ通知の各種設定が必要となります。

PushTopicに関しては、少し古いですが、テラスカイさんの以下の記事がわかりやすいかと思います。

3-３. データ操作（DML）機能

①Insert

指定オブジェクトに対して1つまたは複数のレコードを登録することができます。

以下の画面で登録するための項目の値を指定して実行

実行結果を表示（成功すると以下のように表示されます）

②Update

指定オブジェクトに対して1つまたは複数のレコードを更新することができます。

以下の画面で更新レコードのIDを指定して、変更後の値をセットしたら実行

実行結果の画面

③Upsert

指定オブジェクトに対して1つまたは複数のレコードを登録＆更新することができます。

更新の場合はIDを指定して、変更後の値をセットして実行（新規の場合はID指定なし）

実行結果

④Delete

指定オブジェクトに対して1つまたは複数のレコードを（ごみ箱に）削除することができます。

削除対象レコードのIDを指定して実行

実行結果

⑤Undelete

指定オブジェクトに対して1つまたは複数の削除されたレコードを復元することができます。

UndeleteしたいレコードのIDを指定して実行

Undeleteの実行結果

⑥Purge

指定オブジェクトに対して1つまたは複数の削除されたレコードをごみ箱から完全に削除することができます。

Purgeしたいレコードを指定して実行

Purge（パージ）の実行結果

3-４. マイグレーション機能

①Retrieve（取得）

指定されたマニフェストファイル（Package.xml）に定義されたメタデータをdownloadすることができます。

Package.xmlファイルを指定します。

全てのメタデータ取得用のファイルが欲しい方は、以下からダウンロードしてご利用いただけます。

参考

全メタデータ取得用のマニフェストファイル（Package.xml）のサンプルダウンロード

本記事では、Creative Content Lab Tokyo（クリエイティブ…

続きを読む

Retriveを実行した結果

上記のDownload ZIP Fileをクリックするとメタデータのファイルをダウンロードすることができます。

ダウンロードしたメタデータはデプロイして元に戻すことができます。

②Deploy（デプロイ）

指定されたメタデータをSalesforce組織にデプロイすることができます。

オプションで、チェックだけを行う、ワーニングを無視、テストレベルやテストの実行指定などができます。

あらかじめ取得しておいたメタデータファイル（ZIP形式）を指定して実行します。

実行中の画面

実行結果の確認画面

3-５. その他ユーティリティ

①Rest Explorer

WorkbenchからSalesforce組織に対して直接REST APIを実行することができます。

利用可能なメソッドは、GET、POST、PUT、PATCH、DELETE、HEADとなります。

②Apex Execute

Apexコードを直接実行することができます。※開発コンソールと同様

実行すると以下のようなデバッグログが表示されます。

③Password Management（パスワード管理）

ユーザのパスワードを設定したりリセットすることができます。

パスワードを設定/変更したいユーザIDと新しいパスワードを指定してChange Passwordを実行します。

④Bulk API Job Status

DataloaderやWorkbenchなどから実行されたBulk APIのジョブステータスを確認することができます。

一括データ読み込みジョブのIDを指定して実行

ジョブの実行状況（結果）が表示されます。

⑤Metadata API Process Status

メタデータAPIの処理プロセスのステータス（実行状況）を確認することができます。

確認したいIDを指定して実行します。

Salesforce workbenchの概要説明資料のダウンロード

資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。

一般公開資料

参考

要件定義_ユーザ説明資料_Salesforce Workbench（ワークベンチ）機能概要説明」ダウンロード

本記事では、Creative Content Lab Tokyo（クリエイティブ…

続きを読む

まとめ

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村

第三回の今回は、CircleCI を DevHub に接続から最後のCircleci での自動ビルドまでの設定して、動かしてみましょう。

前回の記事はこちら

参考

CircleCIを使った継続的インテグレーション（Continuous Integration）第2回

第一回では、GuthubのセットアップからCircleCIのセットアップ、そして…

続きを読む

CircleCI を DevHub に接続

CircleCI を認証して接続アプリケーション経由でコンテンツを Dev Hub に転送できるようにします。

手順①コマンドプロンプトを起動し、server.key ファイルがあるフォルダから JWT ベース認証を実行できることを確認します。

以下のコマンドを実行

</p>
<p>>sfdx auth:jwt:grant –clientid <your_consumer_key> –jwtkeyfile server.key –username <your_username> –setdefaultdevhubusername</p>
<p>

【実行例】

</p>
<p>>sfdx auth:jwt:grant –clientid 3MVG95mg0lk4batiP7Q5f8gZVROjIpEdZT… –jwtkeyfile server.key –username cclt.sfdc@mail.com –setdefaultdevhubusername</p>
<p>

以下のようなメッセージが表示されれば認証成功です。

Successfully authorized<ユーザ名> with org ID 00D5h000004bs…

ローカルにsfdx-circleci リポジトリをフォーク

手順①ブラウザで以下のURLへアクセスしsfdx-circleci のリポジトリを表示します。

手順②GitHubを開いたら画面右上の【Fork（フォーク）】リンクをクリックします。

手順③GitHubのログイン画面が表示される場合は、IDとパスワードを入力してログインします。

手順④Create forkを実行して、sfdx-circleciリポジトリをコピーします。

手順⑤フォークが完了すると自分のGitHubに以下の内容が表示されます。

手順⑥次にCircleCIにログインして、プロジェクトメニューを表示します。

すると先ほどフォークしたsfdx-circleciのリポジトリが表示されているので、リポジトリ名のリンクをクリックします。

手順⑦config.ymlファイル選択画面が表示されます。sfdx-circleciに用意されているconfig.ymlをそのまま利用してSet up Projectを実行します。

手順⑧新規プロジェクトが作成されPipelineが実行されます。

手順⑨初回（環境設定を行っていない状態）では、実行結果がFailedとなります。

ビルドにエラーの原因が表示されます。※環境設定などを実施しない限り必ずエラーとなります。

手順⑩続いて環境設定を行います。実行結果の右側に表示されている・・・ボタンをクリックして、プロジェクト設定（Project Settings）メニューを表示します。

手順⑪プロジェクト設定画面で環境変数の設定（Environment Variables）メニューを実行します。

手順⑫以下の環境変数設定画面で、Add Environment Variableをクリックします。

手順⑬環境変数の登録画面で、以下4つのパラメータを指定します。

【登録する環境変数と値】

1. [HUB_CONSUMER_KEY]：作成したSFDCの接続アプリケーション画面で生成されたコンシューマ鍵を指定します。
2. [HUB_SFDC_USER]：組織に接続するユーザ名を指定します。
3. [DECRYPTION_KEY]：server.keyファイルの暗号化の際に生成したkeyを指定します。
4. [DECRYPTION_IV]：server.keyファイルの暗号化の際に生成したivを指定します。

※2番目のパラメータについて、Salesforceの説明サイトでは、HUB_SFDX_USERとなっていますが、sfdx-circleciから取得したconfig.ymlを確認すると正しくは、$HUB_SFDC_UESRとなっているので、間違えないように注意してください。

手順⑭続いて、server.key.encファイルを更新します。

コマンドプロンプトを起動して以下のコマンドを実行します。sfdx-circleciリポジトリをローカル環境へクローンします。

</p>
<p>> cd C:\Users\e\dev\jdoe\JWT   ※JWTフォルダへ移動（※Git専用のフォルダがあればそちらへ移動してもよいです）</p>
<p>>git clone https://github.com/<GitHubのユーザ名>/sfdx-circleci.git<br />
Cloning into ‘sfdx-circleci’…<br />
remote: Enumerating objects: 90, done.<br />
remote: Counting objects: 100% (24/24), done.<br />
remote: Compressing objects: 100% (21/21), done.<br />
remote: Total 90 (delta 9), reused 2 (delta 0), pack-reused 66<br />
Receiving objects: 100% (90/90), 357.09 KiB | 13.73 MiB/s, done.<br />
Resolving deltas: 100% (28/28), done.</p>
<p>

手順⑮ローカルのgitへクローンが作成されたら..\sfdx-circleci\assets\配下にエンコードした[server.key.enc]ファイルをコピーします。

</p>
<p>>copy server.key.enc sfdx-circleci\assets\</p>
<p>

手順⑯リポジトリを作成したら次はgit addコマンドでファイルをインデックスに追加します。

</p>
<p>>cd sfdx-circleci\assets\</p>
<p>>git add server.key.enc</p>
<p>

手順⑰追加されたかステータスを確認

</p>
<p>>git status</p>
<p>On branch master<br />
Your branch is up to date with ‘origin/master’.</p>
<p>Changes to be committed:<br />
(use “git restore –staged <file>…” to unstage)<br />
new file: server.key.enc</p>
<p>

手順⑱追加されていることを確認したらコミットします

</p>
<p>>git commit -m “update server.key.end” -v</p>
<p>[master 827e48b] update server.key.end<br />
1 file changed, 37 insertions(+)<br />
create mode 100644 assets/server.key.enc</p>
<p>

手順⑲最後にgitにプッシュします。

</p>
<p>>git push</p>
<p>info: please complete authentication in your browser…<br />
Enumerating objects: 6, done.<br />
Counting objects: 100% (6/6), done.<br />
Delta compression using up to 8 threads<br />
Compressing objects: 100% (4/4), done.<br />
Writing objects: 100% (4/4), 2.13 KiB | 2.13 MiB/s, done.<br />
Total 4 (delta 1), reused 0 (delta 0), pack-reused 0<br />
remote: Resolving deltas: 100% (1/1), completed with 1 local object.<br />
To https://github.com/creativecontentlabtokyo/sfdx-circleci.git<br />
94c267b..827e48b master -> master</p>
<p>

※GitHubへのログイン認証が必要な場合はIDとパスワードを入力します。最後にリポジトリにserver.key.encファイルが登録されていることを確認します。

手順⑳CircleCIの画面に戻り、プロジェクト[sfdx-circleci]のConfigurationを実行します。

手順㉑config.ymlについて、以下2点の修正を行いSave＆Runを実行します。

1. –setdefaultdevhubusername -a hub　⇒　今回は[my-hub-org]というエイリアスを使っていたのでこちらに修正します。
2. force:org:createの　–waitはデフォルト2ですが、3にしたほうがよいと記載があったので3に修正します。

</p>
<p>sfdx force:auth:jwt:grant –clientid $HUB_CONSUMER_KEY –jwtkeyfile assets/server.key –username $HUB_SFDC_USER –setdefaultdevhubusername -a <span style="color: #ff0000;">my-hub-org</span><br />
sfdx force –help<br />
sfdx force:org:create -s -f ~/ci_app/config/project-scratch-def.json -a circle_build_$CIRCLE_BUILD_NUM –wait <span style="color: #0000ff;">3</span></p>
<p>

手順㉒CircleCIの画面に戻って、再実行されたWorkflowの結果を確認しましょう

以下のSetup Orgの箇所で、Successfully Authorized ord ID ….と表示されていれば組織認証までは成功しています。

手順㉓Setup Orgで以下のエラーが発生していたので修正していきます。

</p>
<p><span style="color: #ff0000;">WARNING: Warning: If you’re using Contacts to Multiple Accounts, beginning with the Spring ’21 release, the feature isn’t automatically enabled. You must manually enable the setting for new scratch orgs. Enable the setting in one of these ways: update the Account Settings page in Setup, add the enableRelateContactsToMultipleAccounts setting to your scratch org definition file, or enable it via Metadata API.</span></p>
<p>ERROR running force:org:create: We’ve deprecated OrgPreferences. Update the scratch org definition file to replace OrgPreferences with their corresponding settings.</p>
<p><span style="color: #ff6600;">Replace the orgPreferences section:</span><br />
<span style="color: #ff6600;">{</span><br />
<span style="color: #ff6600;">“orgPreferences”: {</span><br />
<span style="color: #ff6600;">“enabled”: [</span><br />
<span style="color: #ff6600;">“S1DesktopEnabled”</span><br />
<span style="color: #ff6600;">]</span><br />
<span style="color: #ff6600;">}</span><br />
<span style="color: #ff6600;">}</span><br />
<span style="color: #ff6600;">With their updated settings:</span><br />
<span style="color: #ff6600;">{</span><br />
<span style="color: #ff6600;">“settings”: {</span><br />
<span style="color: #ff6600;">“lightningExperienceSettings”: {</span><br />
<span style="color: #ff6600;">“enableS1DesktopEnabled”: true</span><br />
<span style="color: #ff6600;">}</span><br />
<span style="color: #ff6600;">}</span><br />
<span style="color: #ff6600;">}</span><br />
For more info on configuring settings in a scratch org definition file see: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs.htm.’</p>
<p>Exited with code exit status 1<br />
CircleCI received exit code 1</p>
<p>

手順㉓GitHubの[project-scratch-def.json]ファイルを以下のように修正します。

ファイルパス：sfdx-circleci/config/project-scratch-def.json

</p>
<p><span style="color: #ff6600;">{</span><br />
<span style="color: #ff6600;">“orgName”: “Sample Org”,</span><br />
<span style="color: #ff6600;">“edition”: “developer”,</span><br />
<span style="color: #ff6600;">“settings”: {</span><br />
<span style="color: #ff6600;">“lightningExperienceSettings”: {</span><br />
<span style="color: #ff6600;">“enableS1DesktopEnabled”: true</span><br />
<span style="color: #ff6600;">}</span><br />
<span style="color: #ff6600;">}</span><br />
<span style="color: #ff6600;">}</span></p>
<p>

手順㉔最後にもう一度CircleCIの画面からsfdx-circleciプロジェクトのworkflowを再実行してみます。

Run Apex Tests

Setup Org

Uploading test results / Delete Useless Scratch Org

Parallel runs

全てSign up envirnmentから最後まですべて正常終了しました。

まとめ

今回の記事では、sfdx（CLI） と CircleCI を使って CI環境を作る手順について記しました。

GitHubの使い方やCircleCIなどのCI/DIツールについての基本知識がないと難しく感じる内容だったと思います。これを気に関係するツールや機能について学習することをお勧めします。

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村

第二回の今回は、Salesforceの組織とCircleCI間の認証に関する設定をしていきます。

前回の記事はこちら

参考

CircleCIを使った継続的インテグレーション（Continuous Integration）第1回

Salesforceの大型プロジェクトやアジャイル開発方式を採用したプロジェクト…

続きを読む

Dev Hub組織に対してJWTベースフローを使用した組織の認証を実行

Dev Hub組織に対してJWTベースフローを使用した組織の認証を実行します。※CircleCIからSalesforce組織に対する認証の設定

継続的インテグレーション（CI）の環境は自動化されており、OAuth2.0Webサーバ認証フローのユーザインタラクションはサポートされていないため、代替手段としてJWT（Json Web トークン）ベアラーフローを使用して組織を認証する必要があります。

非公開鍵と自己署名デジタル証明書の作成

OAuth 2.0 JWT ベアラー認証フローでは、証明書の署名に使用されるデジタル証明書と非公開鍵が必要になります。デジタル証明書をカスタム接続アプリケーションにアップロードします。このカスタム接続アプリケーションも JWT ベアラー認証フローで必要になります。認証機関で発行された独自の非公開鍵と証明書を使用できます。または、OpenSSL を使用して鍵と自己署名デジタル証明書を作成することもできます。

【Open SSLをインストール（未インストールの場合）】

手順①以下のサイトにWindows用にビルドされたインストーラがあるので、ダウンロードします。

Webサイト「Shining Light Productions（Win32/Win64 OpenSSL）」　※実行時点の最新版で構いません。

今回は、Win64 OpenSSL v1.1.1oのMSIをダウンロードします。

※Win64 OpenSSL v3.0.3の場合、最後のsfdxでの認証でエラーになることがわかっているので間違えないようにしてください。Issue（https://developer.salesforce.com/forums?id=9062I000000BmNHQA0）

ERROR running auth:jwt:grant: We encountered a JSON web token error, which is likely not an issue with Salesforce CLI. Here’s the error: error:25078067:DSO support routines:win32_load:could not load the shared library

Windows以外の場合は、Opensslのサイトよりダウンロードしてください。

「openssl.org：https://www.openssl.org/」

手順②ダウンロードしたインストーラ（MSIファイル）を実行します。

以下の警告メッセージが表示されるので、詳細情報のリンクをクリックします。

手順③実行ボタンが表示されるためクリックしてインストールを実行します。

手順④インストーラが起動されます。同意にチェックをして次に進みます。

手順⑤Opensslのインストール先フォルダを選択します。※デフォルトのままで大丈夫です。

手順⑥ショートカット名を指定します。※デフォルトのままで大丈夫です。

手順⑦OpenSSL DLLについては、二つ目のオプション（OpenSSL binaries(/bin)directory）を選択してください。

手順⑧最終確認後、Installボタンをクリックします。

手順⑨最後に寄付の画面が表示されますが、チェックを外してそのまま終了します。※寄付したい場合は任意のオプションを選択

手順⑩続いて、インストールしたOpensslのパスを設定します。システムのプロパティから詳細設定を開きます。環境変数のボタンをクリックします。

手順⑪環境変数の画面にて、ユーザ環境変数の編集ボタンをクリックします。

手順⑫新規ボタンをクリックして、Opensslをインストールしたフォルダのフルパスを登録します。

手順⑬以下のように新規パスが追加されていることを確認して終了します。

手順⑬パスが通っているか確認するためコマンドプロンプトを起動して、以下のコマンドを実行します。

>openssl version

バージョンの情報が表示されていれば成功です。

OpenSSL を使用して非公開鍵と自己署名デジタル証明書の作成

つぎにOpensslを使って自己署名デジタル証明書を作成していきます。（以下2つのファイルを生成します）

・server.key — 非公開鍵。auth:jwt:grant コマンドで組織を認証するときにこのファイルを指定します。
・server.crt — デジタル証明書。JWT ベアラーフローで必要な接続アプリケーションを作成するときにこのファイルをアップロードします。

手順①コマンドプロンプトを起動して、非公開鍵を生成するワークフォルダを作成します。

>　mkdir 任意のワークフォルダ（フルパスで指定）　※システム管理者権限が必要なフォルダ階層はやめたほうが良いです。

例：mkdirコマンドを使って以下のフォルダを作成して、cdコマンドで作成したフォルダへ移動します。

</p>
<p>> mkdir C:\Users\e\dev\jdoe\JWT</p>
<p>> cd C:\Users\e\dev\jdoe\JWT</p>
<p>

※エクスプローラからフォルダを作成しても構いません。

手順②以下のコマンドを実行して非公開鍵を生成し、server.key というファイルに保存します。

</p>
<p>> openssl genrsa -des3 -passout pass:SomePassword -out server.pass.key 2048</p>
<p>> openssl rsa -passin pass:SomePassword -in server.pass.key -out server.key</p>
<p>

手順③上記コマンド実行後、作業用フォルダに以下2つのファイルが生成されているため[server.pass.key]のほうを削除します。

・server.key

・server.pass.key

手順④server.key ファイルを使用して、証明書署名要求を生成します。（server.csr というファイルに証明書署名要求を保存）

以下のコマンドを実行します。

</p>
<p>> openssl req -new -key server.key -out server.csr</p>
<p>

以下、会社情報などの情報入力が求められるため適宜ご自身の情報を入力してください。

</p>
<p>>openssl req -new -key server.key -out server.csr<br />
You are about to be asked to enter information that will be incorporated<br />
into your certificate request.<br />
What you are about to enter is what is called a Distinguished Name or a DN.<br />
There are quite a few fields but you can leave some blank<br />
For some fields there will be a default value,<br />
If you enter ‘.’, the field will be left blank.<br />
—–</p>
<p><span style="color: #99ccff;">Country Name (2 letter code) [AU]:JP</span><br />
<span style="color: #99ccff;">State or Province Name (full name) [Some-State]:TOKYO</span><br />
<span style="color: #99ccff;">Locality Name (eg, city) []:KOTO-KU</span><br />
<span style="color: #99ccff;">Organization Name (eg, company) [Internet Widgits Pty Ltd]:CCLT</span><br />
<span style="color: #99ccff;">Organizational Unit Name (eg, section) []:IT</span><br />
<span style="color: #99ccff;">Common Name (e.g. server FQDN or YOUR name) []:CCLT</span><br />
<span style="color: #99ccff;">Email Address []:cclt@mail.com</span></p>
<p><span style="color: #99ccff;">Please enter the following ‘extra’ attributes</span><br />
<span style="color: #99ccff;">to be sent with your certificate request</span><br />
<span style="color: #99ccff;">A challenge password []:　※パスワードを設定</span><br />
<span style="color: #99ccff;">An optional company name []:CCLT</span></p>
<p>

手順⑤以下のcsrファイルが生成されていることを確認します。

server.csr

手順⑥以下のコマンドを実行し、server.key および server.csr ファイルから自己署名デジタル証明書を生成します。

※server.crt というファイルに証明書を保存します。

</p>
<p>> openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out server.crt</p>
<p>（実行結果）<br />
Certificate request self-signature ok<br />
subject=C = JP, ST = TOKYO, L = KOTO-KU, O = CCLT, OU = IT, CN = CCLT, emailAddress = cclt@mail.com</p>
<p>

※非公開鍵： server.key とデジタル証明書： server.crt が存在することを確認します。

接続アプリケーションを作成して Salesforce DX 用に設定

OAuth 2.0 JWT ベアラー認証フローを使用して、Dev Hub 組織にCircleCI用の接続アプリケーションを作成します。

Dev Hub 組織用の接続アプリケーションの作成

手順①Dev Hubを有効化したSalesforce組織にログインして、[設定] から、アプリケーションマネージャを実行します。

手順②接続アプリケーション名などの情報を入力して、OAuth 設定の有効化にチェックを入れます。

※OAuth にチェックを入れるとOAuthの設定情報を入力できるようになります。

• コールバックURL：「http://localhost:1717/OauthRedirect」を入力します。
• デジタル署名を使用：JWT認証の場合こちらをチェック
• 証明書ファイルのアップロード：ローカル環境で生成したserver.crt をアップロードします。

手順③OAuthの範囲は以下を選択します。

• API を使用してユーザデータを管理 (api)
• Web ブラウザを使用してユーザデータを管理 (web)
• いつでも要求を実行 (refresh_token, offline_access)

上記を設定後、保存をクリックします。

手順④保存後の画面に表示されるコンシューマ鍵をコピーしてテキストに張り付けておきます。※後で利用するため

手順⑤manageボタンをクリックして、ポリシーの編集画面にて、[ポリシーを編集] をクリックします。

手順⑥ [OAuth ポリシー]の許可されているユーザで [管理者が承認したユーザは事前承認済み] を選択します。

以下の警告メッセージが表示されるためOKをクリックします。

手順⑦上記の設定が完了したら保存します。

手順⑧プロファイルを管理するのメニューを実行します。

手順⑨この接続アプリケーションを許可するプロファイルを選択して保存します。

※プロファイルの選択の代わりに権限セットを作成して、ユーザへ付与しても構いません。

手順⑩認証する組織が https://login.salesforce.com でホストされていない場合、プロジェクトの設定ファイル (sfdx-project.json) を更新する必要があります。

sfdx-project.jsonファイルは、Salesforce CLIをインストールしたフォルダ内にあります。

C:\Program Files\Salesforce CLI\client\node_modules\@salesforce\templates\lib\templates\project\sfdx-project.json

sfdx-project.jsonファイルを開いて、URLを書き換えて保存します。

https://test.salesforce.comの場合、sfdcLoginUrlの箇所を”sfdcLoginUrl”: “”とする。

手順⑪コマンドプロンプトを起動して以下のコマンドを実行し、接続アプリケーションのクライアント ID (コンシューマ鍵)、非公開鍵ファイル (server.key) へのパス、および JWT 認証ユーザ名を指定します。

>sfdx auth:jwt:grant –clientid （手順④でコピーしておいたコンシューマ鍵を指定） –jwtkeyfile （server.keyをフルパスで指定） –username （SalesforceへのログインユーザIDを指定） –setdefaultdevhubusername –setalias （エイリアス名を指定）my-hub-org

実行例：

</p>
<p>>sfdx auth:jwt:grant –clientid 3MVG95mg0lk4batiP7Q5f8gZVROjIpEdZT –jwtkeyfile C:\Users\e\dev\jdoe\JWT\server.key –username cclt.sfdc@mail.com –setdefaultdevhubusername –setalias my-hub-org</p>
<p>

※ –setdefaultdevhubusername パラメータを指定するとDev Hub 組織を認証するときにデフォルトに設定されます。

サーバキーの暗号化

続いては、server.keyファイルの暗号化を実施します。※鍵と初期化ベクトル (iv) を生成して server.key ファイルを暗号化する。

CircleCI 側では、ここで利用する鍵と vi を使ってビルド環境でサーバキーの復号化を行います。

手順①コマンドプロンプトを起動して、server.keyファイルを生成したフォルダへ移動します。

</p>
<p>>cd \server.keyファイルがあるディレクトリのフルパスを指定</p>
<p>

手順②以下のコマンドを実行します。※<passphrase> は、一意の鍵を作成するためのフレーズを指定します。

</p>
<p>> openssl enc -aes-256-cbc -k <passphrase> -P -md sha1 -nosalt</p>
<p>

実行すると生成された鍵（key)とivベクトルが表示されるので、テキストに張り付けて保存しておきます。

</p>
<p>C:\Users\e\dev\jdoe\JWT>openssl enc -aes-256-cbc -k <password> -P -md sha1 -nosalt<br />
*** WARNING : deprecated key derivation used.<br />
Using -iter or -pbkdf2 would be better.<br />
key=6431BAAE651D440343874873ADE64EB02B5311DAAF550BDD67A8C9892…<br />
iv =3F8DB47ADD8BF92D751EE0B2BEF…</p>
<p>

手順③上記手順②で生成されたkeyとivを使ってserver.keyファイルを暗号化します。

コマンドプロンプトで以下のコマンドを実行します。※フォルダは上記鍵を生成したところで実行すること。

>openssl enc -nosalt -aes-256-cbc -in server.key -out server.key.enc -base64 -K <key> -iv <iv>

<key>は、手順②で生成してkeyを指定し、<iv>は、手順②で生成したivを指定

実行例

</p>
<p>C:\Users\e\dev\jdoe\JWT>openssl enc -nosalt -aes-256-cbc -in server.key -out server.key.enc -base64 -K 6431BAAE651D440343874873ADE64EB02B5311DAAF550BDD67A8C9892… -iv 3F8DB47ADD8BF92D751EE0B2BEF…</p>
<p>

まとめ

今回の記事では、JWTベースフローを使用した組織の認証で、非公開鍵と自己署名デジタル証明書の作成からサーバーキーの暗号化までの手順について説明しました。

次回は、CircleCI を DevHub に接続から最後のCircleci での自動ビルドまで説明していきます。もう一息ですね。

参考

CircleCIを使った継続的インテグレーション（Continuous Integration）第3回

第二回では、JWTベースフローを使用した組織の認証で、非公開鍵と自己署名デジタル…

続きを読む

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村

これらの作業を自動化することで、作業工数の削減や品質の向上（手作業によるミスの低減）を実現することができます。

以前は、Salesforceの継続的インテグレーションの実現方法が、Jenkinsを使ったCIが主流でしたが、最近ではほかにもいくつか推奨されるものが出てきています。

• CircleCI + Salesforce
• Jenkins + Salesforce
• Travis CI + Salesforce

詳細は、以下Salesforce公式サイトを参照ください。

今回は、これらの中からCircleCIを使った環境構築手順についてご説明していきたいと思います。

作業手順

まずは、簡単に全体の流れを説明します。

GitHubのサインアップ

本記事をご覧になっている方のほとんどは、おそらくGithubをすでに使っている方ばかりだと思いますが、初めての方もいらっしゃるかもしれませんので、GitHubのセットアップ手順について説明させてい頂きます。

GitHub（ギットハブ）とは、プログラムのソースコードなどのリソースファイルをバージョン管理（保存）したり、公開するためのクラウドサービスとなります。もちろん非公開として自分だけやプロジェクトメンバーだけアクセスさせるような利用も可能です。

現在では、世界中のエンジニアの方が自身が作成したプログラムを公開していて、自分のスキルを証明するための資産として利用している側面もあります。Salesforce関連の非常に有用なソースコードも多数公開されているため、新しい機能を作るときには一度探してみるのもよいかもしれません。

セットアップ手順

手順①以下のサイトへアクセスします。

手順②公式サイトから「Sign up」ボタンをクリックします。

手順③アカウント作成画面にて以下の情報を登録する。

• ユーザ名（Username）
• Email address（メールアドレス）
• Password（パスワード）
• Verify your account（指定の画像を選択する）
• Create Accountボタンをクリックして完了

手順④登録したメールアドレスに以下のメールが届くため、メール内のリンクをクリックして認証を行います。

手順⑤認証が完了するとログイン後の画面が表示されます。

手順⑥新規リポジトリ（リソースを登録するスペースのこと）を作成します。※すでにお持ちの場合は省略

画面右上の＋メニューから「New repository」をクリックします。

手順⑦以下の内容を入力して、Create Repositoryボタンをクリックします。

• Repository name:リポジトリ名
• Description（説明）
• 公開設定：Public（公開）/Private（非公開）
• Add a README File：Readmeファイルを作成するかどうか

手順⑧リポジトリが作成されると以下のように表示されます。

この後は、リポジトリにソースコードを登録する作業がありますが、CircleCIの環境セットアップを先に実施します。

※CircleCIはGitHubやGitBucketなどと連携できますが、今回はGithubを利用します。

CircleCIの環境構築（CircleCI で GitHub リポジトリを設定）

まずは、CircleCIのサインアップから行っていきます。

手順①以下、ブラウザでCircleCIの公式HPを開きます。

手順②ホーム画面トップメニューにある「Sign up」ボタンをクリックします。

手順③サインアップ画面では、以下3種類の認証が用意されています。

今回は先ほどセットアップしたGithubの認証を使うので、「Sign up with GitHub」を選択してください。

手順④GitHubのログイン画面が表示されるため、セットアップしたアカウントでログインします。

手順⑤Autorize CircleCIの画面が表示されます。リポジトリのアクセス権限や個人データ（メールアドレス）に対するアクセス権限を求められるため問題なければ「Authorize CircleCI」をクリックします。

手順⑥セットアップ画面では以下の内容を登録して、Setup Projectを実行します。

• Select Organization：GitHub組織を選択
• Select Repository：リポジトリを選択
• Select your config.yml file：config.ymlファイルを選択（存在しない場合は2番目のオプションを選択します。）

手順⑦セットアップが完了すると以下の画面が表示されます。

GitHubを確認するとCircleCIから作成されたBranchが確認できます。

Salesforce CLIのインストール

Salesforceのコマンドラインインタフェース（CLI）については、インストールが必要となりますので、ご利用中のOSに合わせて

公式サイトからダウンロードしてインストールを実行してください。

詳細な手順はこちらの記事を参照ください。

参考

Salesforce CLI（Command Line Interface）の利用ガイド

本記事では、Salesforceが提供するCLI（Command Line In…

続きを読む

Dev Hub の有効化

Dev Hubを有効化するとスクラッチ組織の作成と管理、第二世代パッケージの作成と管理、Einstein 機能が利用可能となります。

注意：Sandbox で Dev Hub を有効にすることはできません。そのほか制約事項や注意点は、Salesforce公式HELPサイト「組織のDev Hub機能の有効化」を参照してください。

ではDev Hubを有効化していきましょう。

手順①Salesforceにシステム管理者でログインして、設定->Dev Hubを実行します。

手順②Dev Hubの設定画面にて、Dev Hubを有効化を実行します。

注意: 一度有効化すると元に戻す（無効化）することができないので注意！

まとめ

今回は、GuthubのセットアップからCircleCIのセットアップ、そしてGitHubとの連携と、DevHubの有効化までの手順をご説明しました。

次回は残りの手順についてご説明していきます。Salesforceの組織とCircleCIの認証に関する設定をしていくことになりますが、内容としてはこれまでよりも難しい内容となりますが、頑張って設定していきましょう。

参考

CircleCIを使った継続的インテグレーション（Continuous Integration）第2回

第一回では、GuthubのセットアップからCircleCIのセットアップ、そして…

続きを読む

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村

RPF（提案依頼書）などでも、バックアップとリカバリについて提案することを求められる場合もあるため、本記事を参考に対応方針をご検討ください。

データバックアップの必要性について

Salesforceなどのクラウドサービスに限らず、各種システムでは様々な理由（H/W障害、災害、人的ミスなど）によりデータを損失する可能性があります。データの損失によりビジネスや業務に与える影響は非常に大きいものとなります。

そのため、これらのリスクを回避するためにこれらの事象が発生した場合に、データを損失する前の状態に戻すためにバックアップを取得しておくことが必要となります。

Salesforceのトランザクションは、地理的に異なるデータセンターに対してリアルタイムで複製されているため、ある地域で災害が発生しても、業務が継続できるような仕組みが用意されています。

しかし、ディザスタリカバリー以外の原因（操作ミスなど人的原因）により、データを削除・変更してしまった場合に元に戻すための方法はユーザ自身が用意する必要があります。

誤って一時的にレコードを削除してしまった場合については、ごみ箱の機能で復元するという方法もありますが、ごみ箱はいくつか制限もあるため、全体のバックアップとリカバリーとしては利用できません。

ごみ箱を使ったデータの復元について

Salesforceではレコードを削除した場合には、一時的に「ごみ箱」に格納され、15日間以内であれば「ごみ箱」から復元することができます。

しかし、ごみ箱の利用については、制約事項もあるため、以下の内容は理解しておく必要があります。

Salesforce Classic と Lightning Experienceで異なります。詳細な内容を確認したい場合は、以下の公式サイトよりご確認ください。

データ損失防止について

データを損失してしまう最大の原因は、人的ミスによるものです。Salesforceではデフォルトのシステム管理者では、全てのデータを編集したり削除する権限があります。運用で誤って、データを更新・削除してしまったりすることもあります。

また一般ユーザであっても、例えばデータのインポート処理で誤ったデータを一括で取り込んでしまい復元が不可能な状態となってしまったような事例があります。これらを抑止するための仕組みもSalesforceでは用意されています。データのバックアップと合わせて、対策を講じるとよいでしょう。

バックアップ対象と方式

バックアップ対象は、大きく以下の２種類があります。

Salesforceのバックアップ対象

• メタデータ（オブジェクト定義、カスタム項目、ページレイアウト、カスタムレポート、ダッシュボード、Apex などのカスタムコード、ワークフローなど）
• レコード（標準オブジェクト・カスタムオブジェクトのレコード）

Salesforceは、ノーコード（またはローコード）での開発が可能なサービスであり、メタデータ駆動型の開発モデルが採用されています。

オブジェクトや項目も画面上から設定だけで作成されますが、これらはメタデータとしてサーバ上に保存されています。Apexプログラムなどもメタデータとして保存されます。

そのため、これらのメタデータについても、レコードと同様にバックアップ管理対象とする必要があります。

※メタデータ駆動型の開開発について知りたい方は、以下、公式サイトを参照ください。

バックアップ方式

Salesforceでは、バックアップ方式として以下の方式が提供されています。

上記のほかには、ETLツールを使ってデータやメタデータを取得するような開発を行うことも可能です。

扱うデータの重要度や複雑性、またはバックアップ処理にかけられるコストなどを鑑みて、どの方法を採用するべきか検討するのがよいでしょう。

データのリストア（リカバリー）

データのリカバリーについては、少し複雑な手順が必要となります。

１．レコードの復元

レコードを復元する際には、以下の事項を理解しておく必要があります。

標準機能を使ってレコードを復元する場合には、データインポートウィザード、もしくはDataloaderを利用する方法があります。

どちらの場合も、復元のためのCSVファイルを用意しておき、インポートをしてデータの復元を行います。

ただし、リレーションオブジェクトの場合には、先に親オブジェクトを登録して、登録時に採番されたSalesforce IDを使って、子オブジェクトのリレーションIDを変更しておく必要があります。

以下の図を使って説明します。

まず、取引先と取引先責任者のレコードをそれぞれCSVファイルにエクスポートしておきます。

※復元対象のデータは誤って削除されてしまったという前提（シナリオ）とします。

次に、Dataloader等を使って、親オブジェクトである取引先（Account）のレコードをインポートします。※新規登録する場合は、新しいSalesforceIDが採番されるため、SalesforceIDには既存のレコードのIDをマッピングすることはできません。

取引先のレコードを復元のため再度インポートすると新しいSalesforceIdが採番されます。

（旧ID）0015h00000Ue04LAAR　→　（新ID）0015h00000Ue04LXXX

つづいては、子オブジェクトのインポートとなりますが、その前に、親レコードのリレーションを再構築する必要があります。

エクスポートした取引先責任者（Contact）のCVSファイルを編集して、元のAccountIDから新しいAccountIDへ振り替えを行います。

※紐づけにはVlookup関数などを利用して紐づけを特定するため、検索キーとなる項目については必ず一意になる値とする必要があります。

重複する値がある項目を利用しないように注意しましょう。

新しい親レコードへのリレーションへ振り替えが完了したら、編集したCVSファイルを使ってインポート処理を行います。

外部IDを使ったインポート

親オブジェクトに外部ID項目を設定しておき、SalesforceIDを旧IDとして保存しておくことで、子オブジェクトから外部IDをキーにした参照関係を構築することができます。

以下のように親オブジェクト（取引先Account）に外部IDの項目を用意しておくことで、子オブジェクトは元のAccountIDを使ってそのまま紐づけをすることができます。

この方式を利用する場合には、あらかじめ外部ID項目を使って、レコード作成時にSalesforceIDを項目にセットするような項目自動更新などを合わせて設定しておく必要があります。

２．メタデータの復元

メタデータの復元は、以下のように行います。

• 変更セットを利用してバックアップを作成している場合は、変更セットを本番環境へリリースする。
• VisualStudioCodeやCLIでバックアップしている場合には、最新のバックアップファイルを使って、本番環境へメタデータをデプロイする。

本番リリース作業手順書などに、障害発生時の切り戻し手順など記載する場合には、メタデータの復元方法についても記述しておきましょう。

バックアップ・リカバリに関する公式サイトの情報

まとめ

セールスフォースのデータバックアップとリストアについてご理解いただけましたでしょうか。

具体的な設定や作業手順なども今後記事にしていく予定です。

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村