Ant 移行ツールガイド
jターゲットの作成
build.xml ファイルは、Ant で実行される一連のコマンドを指定します。build.xml ファイル内には、ターゲット名を持つ Ant の実行時に一連のコマンドを処理する指定ターゲットがあります。次のパラメータは、<sf:retrieve> ターゲットごとに設定できます。
| 項目 | 説明 |
|---|---|
| username | sessionId が指定されていない場合は必須です。ログインに使用する Salesforce ユーザ名。この接続に関連付けられるユーザ名には、「メタデータ API 関数を使用したメタデータを変更」権限が必要です。 |
| password | sessionId が指定されていない場合は必須です。このプロジェクトに関連付けられた組織にログインするために使用するパスワード。セキュリティトークンを使用している場合は、パスワードの最後に 25 桁のトークン値を貼り付けます。 |
| sessionId | username および password が指定されていない場合は必須です。有効な Salesforce セッションの ID または OAuth アクセストークン。セッションは、ユーザがユーザ名とパスワードを使用して正常に Salesforce にログインした後に作成されます。新しいセッションを作成するのではなく既存のセッションにログインする場合は、セッション ID を使用します。または、OAuth 認証のためのアクセストークンを使用します。詳細は、Salesforce ヘルプの「OAuth によるアプリケーションの認証」を参照してください。 |
| serverurl | 省略可能。Salesforce サーバの URL (空白の場合、デフォルトは login.salesforce.com)。Sandbox インスタンスに接続するには、この値を test.salesforce.com に変更します。 |
| retrieveTarget | 必須。メタデータファイルを取得する先のディレクトリ構造のルート。 |
| packageNames | unpackaged が指定されていない場合は必須です。取得するパッケージ名のカンマ区切りのリストです。packageNames または unpackaged のいずれかを指定しますが、両方は指定できません。 |
| apiVersion | 省略可能。取得したメタデータファイルに使用するメタデータ API バージョン。デフォルト値は 46.0 です。 |
| pollWaitMillis | 省略可能。デフォルトは 10000 です。取得要求の結果をポーリングする場合の試行間の待機時間 (ミリ秒単位) です。クライアントは、maxPoll で定義された制限に到達するまで引き続きポーリングします。 |
| maxPoll | 省略可能。デフォルトは 200 です。取得要求の結果を得るためにサーバをポーリングする回数です。連続するポーリング試行間の待機時間は、pollWaitMillis で定義されます。 |
| singlePackage | 省略可能。デフォルトは true です。複数のパッケージを取得する場合は、このパラメータを false に設定します。false に設定すると、パッケージごとに余分の最上位サブディレクトリが、取得された zip ファイルに含まれます。 |
| trace | 省略可能。デフォルトは false です。SOAP 要求と応答をコンソールに表示します。このオプションを選ぶと、ログイン時のユーザのパスワードがプレーンテキストで表示されます。 |
| unpackaged | packageNames が指定されていない場合は必須です。取得するコンポーネントを指定するファイルマニフェストのパスと名前です。unpackaged または packageNames のいずれかを指定しますが、両方は指定できません。 |
| unzip | 省略可能。デフォルトは true です。true に設定すると、取得されたコンポーネントが解凍されます。false に設定すると、取得されたコンポーネントが zip ファイルとして retrieveTarget ディレクトリに保存されます。 |