Ant 移行ツールガイド
jコンポーネントの一括取得
このターゲットは、カスタムレポートなど、1 つのメタデータ型の大量のコンポーネントを一連のローカルファイルにダウンロードするための最適な方法です。次のパラメータは、<sf:bulkRetrieve> ターゲットごとに設定できます。
| 項目 | 説明 |
|---|---|
| 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 | 必須。メタデータファイルを取得する先のディレクトリ構造のルート。 |
| metadataType | 必須。取得するメタデータ型の名前は、カスタムオブジェクトの場合は CustomObject、カスタムレポートの場合は Report のようになります。有効な値の一覧は、「コンポーネントの種類」を参照してください。 |
| containingFolder | 省略可能。メタデータがフォルダに含まれている場合は、このパラメータを、コンテンツの取得元となるフォルダの名前にする必要があります。 |
| batchSize | 省略可能。デフォルトは 10 です。マルチパート取得の実行時に取得する項目数です。 |
| apiVersion | 省略可能。取得したメタデータファイルに使用するメタデータ API バージョン。デフォルトは、58.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>