SalesforceのAnt移行ツールのインストール、メタデータ取得の方法をご紹介

SalesforceのAnt移行ツールとは

SalesforceのAnt移行ツールは、ローカルディレクトリとSalesforce組織の間でのメタデータのやりとりを、Java/Antベースのコマンドラインで実行するツールです。

Ant移行ツールでできること

Ant移行ツールでは、メタデータの取得と指定した場所へのメタデータのコピーができます。例えば、SandBoxからSalesforceの本番リリースへのデプロイや、パッチ処理による定刻実行などを行うこともできます。

Ant移行ツールの活用例

Salesforceの開発および運用で、Ant移行ツールの活用が効果的です。活用例をご紹介します。 ・テスト環境構築の際、設定変更などの入力項目が多い。 →Webインタフェースからの入力を省略できる。 ・複数フェーズのリリースプロセスを同時に行いたい。 →コンポーネントの取得とリリースをスクリプト化できる。 ・同じパラメータで反復してリリースしたい。 →メタデータの取得、変更、コンポーネントのサブセットのリリースを、再度のコールで反復できる。 ・ユーザへの影響が少ない深夜などの時間帯にリリースを実行したい。 →バッチリリースを定刻実行できる。

Ant移行ツールのインストール

Ant移行ツールをダウンロードとインストールの手順を紹介します。 Ant移行ツールを使用する環境には、Java（推奨：ver.11以降）とApache Ant (推奨：ver.1.6以降)がインストールされている必要があります。

Ant移行ツールのインストール準備①　Javaのバージョン確認

はじめに、コマンドプロンプトからJavaのバージョンを確認します。インストールされているJavaのバージョンが、ver.11より前のバージョンの場合は、最新バージョンのインストールをお奨めします。 ①コマンドプロンプトを開き、「java -version」と入力する。 ②Javaのバージョンを示す、openjdk versionの後の“数字”を確認する。下のサンプルでは、”11.0.8″となっているので、ver.11であることを確認できる。

openjdk version "11.0.8" 2020-07-14
OpenJDK Runtime Environment AdoptOpenJDK (build 11.0.8+10)
OpenJDK 64-Bit Server VM AdoptOpenJDK (build 11.0.8+10, mixed mode)

Ant移行ツールのインストール準備②　Antのバージョン確認

続いて、Antのバージョンを確認します。Javaと同じく、コマンドプロンプトからバージョンを確認できます。Antバージョンが1.5.xより前だった場合は、最新バージョンをダウンロードします。 ①コマンドプロンプトを開き、「ant -version」と入力する。 ②Apache Ant versionの後の数字で、Antのバージョンを確認する。下のサンプルの”1.7.0″が、ver.1.7.0を示している。

Apache Ant version 1.7.0 compiled on December 13 2006

Ant移行ツールのインストール準備③　Antのインストール

Antがインストールされていない場合は、Antのインストールと設定を行います。 ①Apache Ant（ver.1.6以降）をダウンロードし、任意のディレクトリ（これがANT_HOMEとなる） に保存する。 ②Antの実行に必要なbinディレクトリをパスに追加する。 ＜インストールする環境がWindows OSの場合＞ ③ANT_HOMEの環境変数を作成し、値をAntのインストール場所に設定する。 ④JAVA_HOMEの環境変数を作成し、値をJDKの場所に設定する。

Ant移行ツールをインストールする

JavaとAntの準備ができたら、Ant移行ツールをインストールします。 インストールファイルのダウンロードには、Salesforceの認証は不要です。ダウンロードリンクにアクセスする前に、Salesforceからログアウトしておきましょう。

インストールファイルをダウンロードする

①Ant移行ツールのインストールファイルをダウンロードする。 ＜Ant移行ツールのインストールファイル＞ salesforce_ant_50.0.zip（Winter ’21 Ant Migration Tool） salesforce_ant_51.0.zip（Spring ’21 Ant Migration Tool、プレビューバージョンを含む）

インストールファイルを実行する

ダウンロードしたzipファイルをローカルで実行します。 ②ディレクトリを選択して解凍する。 ③指定したディレクトリに、次のフォルダとファイルが書き込まれていることを確認する。 ＜保存されるファイルの名称と内容＞ ・Readme.html：ツールの使用方法を説明するファイル ・ant-salesforce.jar：Antタスクを定義したJarファイル ・sample：build.properties、build.xml、SampleFailingTestClass.cls、SampleAccountTrigger.triggerなどのサンプルファイルを含むフォルダ ④過去に、古いバージョンをインストールしていた場合は、以前のjarファイルを削除する。

Ant移行ツールでSalesforceのメタデータを取得する方法

ここではAnt移行ツールを使って、Salesforceからメタデータを取得する手順を紹介します。Ant移行ツールを使用すると、ローカルディレクトリと Salesforce組織間で、メタデータの移行が簡単にできます。

（1）build.propertiesに、Salesforce組織のログイン・接続情報を入力する

コピー元になるSalesforce組織にログインするため、build.propertiesを編集します。 ①Ant移行ツールのフォルダにある、sampleサブディレクトリを開く。 ②テキストエディタでbuild.propertiesを開く。 ③ログイン方法に応じて、次項のいずれかを実行する。 ・ユーザ名とパスワードによるログインの場合 有効なSalesforceユーザ名とパスワードを入力する ・セキュリティトークンを使用する場合 パスワードの最後に25桁のトークン値を入力する ・有効なSalesforceセッションを使用する場合 sf.sessionIdプロパティのコメントを解除し、有効なセッションIDに入力する。 sf.usernameとsf.passwordプロパティのコメントの解除を確認する。 ・ OAuthアクセストークンを使用する場合 sf.sessionIdプロパティのコメントを解除し、アクセストークンを指定する。 f.usernameおよびsf.passwordプロパティのコメントの解除を確認する。

（2）build.xmlでターゲットを作成する

build.xmlファイルで、Antで実行する一連のコマンドを定義します。build.xmlファイル内のターゲット名を持つAntを実行すると、指定ターゲットが一連のコマンドを処理します。ターゲットごとにパラメータを設定できます。

（3）package.xmlでコンポーネントを指定する

package.xmlファイルで、1回の要求により取得またはリリースするコンポーネントを指定します。一度の処理で、1つずつパッケージの取得またはリリースができます。 package.xmlで、リリース先となるサーバ側パッケージの名前、コンポーネントの完全名、種類などが定義される場合があります。

（4）Salesforceからメタデータを取得する

Ant移行ツールを実行して、Lightning Platform コンポーネントを取得します。 build.xmlには、retrieve() および deploy() などのターゲットが含まれています。必要に応じて改修して使用できます。コマンドラインに「ant -p」と入力すると指定ターゲットをすべて表示できます。 ①コマンドプロンプトを開く。 ②build.xmlで対象名を指定して、Antを実行する。 ＜Antを初めて実行する場合＞ メタデータを取得するant retrieveUnpackagedを使用して、package.xmlで定義されたパッケージ化されていないコンポーネントを取得します。

SalesforceのAnt移行ツールを活用する

SalesforceのAnt移行ツールについて、インストールからメタデータ取得の手順を紹介しました。 Ant移行ツールは、メタデータの取得とコピー、デプロイなど、さまざまな場面で役立つツールです。Ant移行ツール活用のため、ここで紹介した基本的な知識から身につけていきましょう。]]>