IDX Workbench を探索する

学習の目的

この単元を完了すると、次のことができるようになります。

• IDX Workbench で使用できるさまざまなダッシュボードを挙げる。
• IDX Workbench を使用して 2 つの Salesforce 組織間でメタデータを移行する方法を説明する。

IDX Workbench の紹介

Vijay Lahiri は OmniStudio 開発者です。彼のチームは現在、いくつかの OmniStudio コンポーネントを使用するクライアントプロジェクトに取り組んでいます。 

開発フェーズが完了し、マネージャーは Vijay に IDX Workbench を使用して、テストのために プロジェクトメタデータを開発組織から QA 組織に移行するように依頼しました。ただし、Vijay はこのツールを使用したことがなく、プロジェクトデータを QA 組織にデプロイできるように早く学習しなくてはならないため、少し心配しています。Vijay は自分のラップトップに IDX Workbench をインストールしました。これで学習の旅を始める準備が整いました。 

さっそく、Vijay が IDX Workbench に慣れるのを手伝いましょう。 

ソースからターゲットへ

IDX Workbench は、OmniStudio DataPack と Salesforce メタデータをある環境から別の環境へ移行するために使用できるデスクトップアプリケーションです。メタデータ移行は常にソース環境からターゲット環境へという一方向に行われます。

IDX Workbench は次のソースとターゲットの間の移行をサポートしています。 

先に進む前に、4 つのダッシュボードで構成されている IDX Workbench の UI を見てみましょう。 

[Migration (移行)] ダッシュボード

最初に [Migration (移行)] ダッシュボードを見ていきましょう。このダッシュボードを使用すると、データをすばやく設定して移行できます。

デスクトップから IDX Workbench を開くと、デフォルトで [Migration (移行)] タブが選択されます。[Edit (編集)] アイコン (2) をクリックして [Configure Workspace (ワークスペースの設定)] (3) ダイアログを開きます。ここで、ソース環境、ターゲット環境、移行するコンポーネントを定義します。

その他のダッシュボード

メタデータの移行以外にも IDX Workbench には便利な機能がいくつかあります。

次の表は各ダッシュボードの説明です。

各ダッシュボードには [Options (オプション)] (4) パネルと結果 (5) パネルがあります。 

• [Options (オプション)] パネルは各ダッシュボードで使用できるさまざまなオプションの設定と定義を行うために使用します。
• 結果パネルは検索結果の出力を確認するために使用します。

Vijay は見た内容に満足しています。IDX Workbench の UI を一通り把握できたため、次に知りたいのはメタデータを定義して 2 つの Salesforce 組織間で移行する方法です。では始めましょう。

メタデータを設定して移行する

メタデータを移行する前に、[Configure Workspace (ワークスペースの設定)] ダイアログを使用して、ソース組織、ターゲット組織、移行するオブジェクトを指定する必要があります。また、ソースとターゲットの両方が組織であっても、プロジェクトのリポジトリを作成する必要があります。リポジトリには、関連する設定や移行されるプロジェクト項目などが保存されます。

では、手順を見てみましょう。

最初にリポジトリを設定しましょう。

1. [Repository (リポジトリ)] (1) ドロップダウンリストを使用して [New Repository (新規リポジトリ)] (2) を選択します。
2. [New Repository (新規リポジトリ)] ダイアログで [Name (名前)] (3) と [Repository Folder (リポジトリフォルダー)] (4) を指定します。フォルダーが存在しない場合は、IDX Workbench によって作成されます。
3. 新しいリポジトリの詳細を保存します。

次に、ソース環境とターゲット環境を設定します。

1. [Source (ソース)] (1) ドロップダウンリストで、[New Environment (新規環境)] (2) を選択します。この例では、ソース環境は Salesforce 組織です。
2. 表示された [New Salesforce Org (新規 Salesforce 組織)] ダイアログで、[Name (名前)] (3) を指定します。
3. [Organization Type (組織種別)] (4) ドロップダウンリストで、適切な URL を選択します。たとえば、ソースが Sandbox 組織であれば、[Organization Type (組織種別)] を [https://test.salesforce.com] に設定します。そうでない場合は、[https://login.salesforce.com] を選択します。
4. [Log in using OAuth (OAuth を使用してログイン)] (5) をクリックします。これにより Salesforce 組織のログインページが開きます。
5. ログイン情報を使用して認証し、ソース組織にログインします。
6. この手順を繰り返してターゲットを設定し、ターゲット環境に合わせて構成設定を調整します。

これでリポジトリ、ソース、対象を設定できました。次は、プロジェクトを設定し、移行するコンポーネントを選択します。Vijay にとってこの作業は、何が移行され、何が移行されないかを決める重要なステップです。Vijay は上司をがっかりさせたくありません。

プロジェクトを設定していきましょう。

1. [Project (プロジェクト)] (1) ドロップダウンリストで、[New Project (新規プロジェクト)] (2) を選択します。[New Project (新規プロジェクト)] ダイアログが開きます。
2. [New Project (新規プロジェクト)] ダイアログでプロジェクトの [Name (名前)] (1) を指定します。次に、移行する OmniStudio オブジェクトまたは Salesforce オブジェクトのすべての種別 (2) を選択します。完了したら [Fetch DataPacks (DataPack を取得)] (3) をクリックします。これによって、選択した種別の DataPack のすべての名前がソース組織から取得されます。
3. 必要に応じて [Pick datapacks for project (プロジェクトの DataPack を選択)] (4) で、取得したオブジェクトの名前を絞り込むテキストを入力できます。移行するオブジェクトを [All datapacks (すべての DataPack)] リストから選択して [Selected datapacks (選択された DataPack)] リスト (5) に移動します。いずれかのリストで複数の項目を選択するには、Shift キーを使用します。
4. 依存オブジェクトを移行から除外するには、[Ignore Dependencies (依存関係を無視する)] (6) をクリックします。
5. 新しいプロジェクトを確認して保存します。[Configure Workspace (ワークスペースの設定)] ダイアログが開きます。
6. すべての変更が反映されていることを確認してからワークスペースを保存します。

これで設定が完了しました。それでは、このメタデータを移行する方法を Vijay に示しましょう。

メタデータを移行する

IDX Workbench は、移行するすべてのメタデータを処理して取得し、左側のパネルにコンポーネントのリストを表示します。 

メタデータをターゲット組織に移行するには、移行する各オブジェクトの横にあるチェックボックス (1) を選択します。次に、[Actions (アクション)] > [Migrate with Dependencies (依存関係を含めて移行)] (2) をクリックします。これによって、選択されたすべてのオブジェクトがソース組織からターゲット組織へ移行されます。

移行を検証する

移行プロセスが完了すると、IDX Workbench 画面は次のようになります。 

メタデータ移行の成功を確認するには、リストされている各オブジェクトの横にある [Migrated (移行済み)] (1) ラベルをチェックします。オブジェクトの横にラベルが表示されている場合は、移行が成功しています。また、移行されたオブジェクトの詳細な情報は [Comparison (比較)] (2) タブと [Migration] (3) タブに表示されます。

[Comparison (比較)] タブには移行されたオブジェクトと以前にデプロイされていたバージョンとの違いがまとめられています。ソース組織の項目は緑で強調表示され (1)、ターゲット組織の項目は赤で強調表示されています (2)。 

移行された各オブジェクトの左側には、次の 3 つの円形アイコンのいずれかが表示されます。 

• 白のアイコン (3) は、現在オブジェクトが両方の組織で同じバージョンであることを示します。
• 黄色のアイコン (4) は、オブジェクトがソース組織とターゲット組織の両方にあるが、組織間でオブジェクトバージョンが異なることを示しています。
• 緑のアイコン (5) は、オブジェクトが新しく、ターゲット組織に移行される最初のバージョンであることを示しています。

ソース組織の各コンポーネントの JSON コードを表示するには、[View Source (ソースを表示)] (6) をクリックします。 

すべての手順を見てきた Vijay は自分のメタデータ移行作業に IDX Workbench を使えることを確信しつつあり、ここまでの進捗に満足しています。 

そのとき、同僚が IDX Workbench と一緒に OmniStudio Project Explorer を使用すればさらにデータ移行が簡単になると教えてくれました。Vijay は興味をそそられ、Project Explorer について良く知りたいと考えました。次の単元では、OmniStudio Project Explorer を紹介しましょう。

リソース

• Salesforce ヘルプ: Install IDX Workbench (IDX Workbench のインストール)
• PDF: Data Migration Between Different Source/Target Environments (異なるソース/ターゲット組織間でのデータ移行)