【Salesforce】Ant移行ツールを使用する準備

f:id:recrox:20190821235616j:plain

この記事の目的

Salesforce関連のツールであるAnt移行ツールを使うための準備をする。

はじめに

今回は、Windows環境で、Salesforceを使う上で便利なAnt移行ツールの導入準備について書いていきたいと思います。

Ant移行ツールとは?

Ant移行ツールとは、Apatch Antベースで動作する、Salesforce環境からメタデータを取得・適用するためのツールです。 公式サイトではAnt上で動作するビルドツールと書かれています。 詳しくは以下の公式サイトを確認してください。

https://developer.salesforce.com/docs/atlas.ja-jp.daas.meta/daas/meta_development.htm

構成イメージ

Java 1.7.X以降
  +Apache Ant 1.6 以降
    +Ant移行ツール

Ant移行ツールは簡単に書くと上記のイメージで動作します。

Java 1.7.X以降をインストールする

書いてある通りJava 1.7.X以降をインストールすれば動きますが、最新のSalesforceのデータローダーがZulu OpenJDKで作成されているので、そちらを入れたほうが良いです。すでにJava 1.7.X以降がインストールされている場合はそのままそれを使用すれば良いです。

データローダーについての記載は以下を参照。

https://help.salesforce.com/articleView?id=000317204&language=ja&type=1&mode=1

Javaが動作するかコマンドプロンプトで確認する

コマンドプロンプトを起動し、以下のコマンドを入力してください。

java -version

次の様な結果が返されたら問題ありません。

java version "1.8.0_211"
Java(TM) SE Runtime Environment (build 1.8.0_211-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.211-b12, mixed mode)

もし、~~~認識されていません。というようなメッセージが返ってきたら次のシステム環境変数Pathを確認してください。

システム環境変数Pathが設定されているか確認する

通常、インストーラーからJavaを入れればシステム環境変数PathにJavaインストールパスが設定されます。Apache Antが動作しない原因にもなりますので、念の為確認しておきましょう。

Apache Ant 1.6以降をインストールする

下記のサイトから最新のApache Antをダウンロードします。

https://ant.apache.org/bindownload.cgi

少々わかり難いですが、1.XX.X release - requires minimum of Java 8 at runtimeと書いてある部分からzipファイルのリンクを選択すればダウンロードできます。

ダウンロードが完了したら、zipファイルを展開して任意の場所に配置します。配置した場所を仮にAntインストールパスと呼びます。

システム環境変数PathにAntインストールパスを追加する

Apache Antはzipファイルを展開して配置しただけなので、システム環境変数Pathへの追加は行われません。そのままでは、WindowsがApache Antを認識できないので、システム環境変数PathにAntインストールパスを追加します。

Apache Antが動作するかコマンドプロンプトで確認する

コマンドプロンプトを起動し、以下のコマンドを入力してください。

ant -version

次のような結果が返されれば問題ありません。

C:\Users\u1689.AD>ant -version
Apache Ant(TM) version 1.10.5 compiled on July 10 2018

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

https://developer.salesforce.com/docs/atlas.ja-jp.daas.meta/daas/forcemigrationtool_install.htm

公式サイトからAnt移行ツールのzipファイルをダウンロードして展開します。その中の、ant-salesforce.jarファイルをAntインストールパスのlibフォルダに配置します。 Ant移行ツールのインストールはこれで完了です。 ちなみに、このzipファイルにはサンプルも含まれていますが、設定を行う際の良い土台になるので取っておいてください。

まとめ

Java 1.7.X以降
  +Apache Ant 1.6 以降
    +Ant移行ツール

構成イメージでも示したように、Ant移行ツールを使用するためにはJavaとApache Antを入れればOKなので簡単です。 Salesforceの移行作業に使用する場合、むしろこの後の設定作業が重要です。それについては、また記事に起こしたいと思います。