Force.com 移行ツールガイド
j取得ターゲットの作成
build.xml ファイルは、Ant で実行される一連のコマンドを指定します。build.xml ファイル内には、ターゲット名を持つ Ant の実行時に一連のコマンドを処理する指定ターゲットがあります。次のパラメータは、<sf:retrieve> ターゲットごとに設定できます。
| 項目 | 説明 |
|---|---|
| username | sessionId が指定されていない場合は必須です。ログイン用の Salesforce ユーザ名。この接続に関連付けられるユーザ名は、「すべてのデータの編集」権限を持っている必要があります。通常、これはシステム管理者のみに有効です。 |
| password | sessionId が指定されていない場合は必須です。このプロジェクトに関連付けられた組織にログインするために使用するパスワード。セキュリティトークンを使用している場合は、パスワードの最後に 25 桁のトークン値を貼り付けます。 |
| sessionId | username および password が指定されていない場合は必須です。有効な Salesforce セッションの ID。セッションは、ユーザがユーザ名とパスワードを使用して正常に Salesforce にログインした後に作成されます。新しいセッションを作成する代わりに既存のセッションにログインする場合に、セッション ID を使用します。 |
| serverurl | 省略可能。Salesforce サーバの URL (空白の場合、デフォルトは login.salesforce.com)。Sandbox インスタンスに接続するには、test.salesforce.com に変更します。 |
| retrieveTarget | 必須。メタデータファイルを取得する先のディレクトリ構造のルート。 |
| packageNames | unpackaged が指定されていない場合は必須です。取得するパッケージ名のカンマ区切りのリストです。packageNames または unpackaged のいずれかを指定する必要がありますが、両方は指定できません。 |
| apiVersion | 省略可能。取得したメタデータファイルに使用するメタデータ API バージョン。デフォルトは 35.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 ディレクトリに保存されます。 |
コンポーネントの一括取得
このターゲットは、カスタムレポートなど、1 つのメタデータ型の大量のコンポーネントを一連のローカルファイルにダウンロードするための最適な方法です。次のパラメータは、<sf:bulkRetrieve> ターゲットごとに設定できます。
| 項目 | 説明 |
|---|---|
| username | sessionId が指定されていない場合は必須です。ログイン用の Salesforce ユーザ名。この接続に関連付けられるユーザ名は、「すべてのデータの編集」権限を持っている必要があります。通常、これはシステム管理者のみに有効です。 |
| password | sessionId が指定されていない場合は必須です。このプロジェクトに関連付けられた組織にログインするために使用するパスワード。セキュリティトークンを使用している場合は、パスワードの最後に 25 桁のトークン値を貼り付けます。 |
| sessionId | username および password が指定されていない場合は必須です。有効な Salesforce セッションの ID。セッションは、ユーザがユーザ名とパスワードを使用して正常に Salesforce にログインした後に作成されます。新しいセッションを作成する代わりに既存のセッションにログインする場合に、セッション ID を使用します。 |
| serverurl | 省略可能。Salesforce サーバの URL (空白の場合、デフォルトは login.salesforce.com)。Sandbox インスタンスに接続するには、test.salesforce.com に変更します。 |
| retrieveTarget | 必須。メタデータファイルを取得する先のディレクトリ構造のルート。 |
| metadataType | 必須。取得するメタデータ型の名前は、カスタムオブジェクトの場合は CustomObject、カスタムレポートの場合は Report のようになります。有効な値の一覧は、「コンポーネントの種類」を参照してください。 |
| containingFolder | 省略可能。メタデータがフォルダに含まれている場合は、このパラメータを、コンテンツの取得元となるフォルダの名前にする必要があります。 |
| batchSize | 省略可能。デフォルトは 10 です。マルチパート取得の実行時に取得する項目数です。 |
| apiVersion | 省略可能。取得したメタデータファイルに使用するメタデータ API バージョン。デフォルトは 35.0 です。 |
| maxPoll | 省略可能。デフォルトは 200 です。取得要求の結果を得るためにサーバをポーリングする回数です。クライアントは、最初のポーリング試行の後、2 秒間待機します。連続するポーリング試行ごとに待機時間が 2 倍になります。ポーリング試行間の最大待機時間は 30 秒です。 |
| unzip | 省略可能。デフォルトは true です。true に設定すると、取得されたコンポーネントが解凍されます。false に設定すると、取得されたコンポーネントが zip ファイルとして retrieveTarget ディレクトリに保存されます。 |
カスタムレポートコンポーネントを一括取得するには、<sf:bulkRetrieve> を使用して build.xml ファイルでターゲットを指定します。
1<target name="bulkRetrieve">
2 <sf:bulkRetrieve
3 username="${sf.username}"
4 password="${sf.password}"
5 sessionId="${sf.sessionId}"
6 serverurl="${sf.serverurl}"
7 metadataType="Report"
8 retrieveTarget="retrieveUnpackaged"/>
9</target>