ISVforce ガイド
jメタデータ API を使用した第一世代管理パッケージのインストール
ユーザインターフェースの代わりにメタデータ API を使用して、管理パッケージをインストール、アップグレード、およびアンインストールできます。このような繰り返し実行するタスクを自動化すると、効率的に作業でき、アプリケーションの開発速度が向上します。
パッケージをインストール、アップグレード、またはアンインストールするには、標準メタデータ API の deploy() コールと InstalledPackage メタデータ型を使用します。次の操作がサポートされています。
- 組織で InstalledPackage をリリースすると、パッケージがその組織にインストールされます。
- 現在インストールされているパッケージの新バージョンをリリースすると、パッケージがアップグレードされます。
- package.xml の代わりに destructiveChanges.xml というマニフェストを使用して InstalledPackage をリリースすると、組織からパッケージがアンインストールされます。
インストールしたパッケージにすべてのユーザがアクセスできるのか、それともシステム管理者のみがアクセスできるのかを指定するには、InstalledPackage メタデータ型の securityType 項目を使用します。デフォルト値は AllUsers です。この項目は、API バージョン 57.0 以降で使用できます。
次に、パッケージインストール用の典型的なプロジェクトマニフェスト (package.xml) を示します。マニフェストには、fullName または namespacePrefix 要素を含めないようにします。
パッケージは、MyNamespace.installedPackage というファイルで指定されます。このとき、MyNamespace は、パッケージの名前空間プレフィックスです。このファイルは、installedPackages というディレクトリに置く必要があり、その内容は次の形式にする必要があります。
securityType 項目は省略可能です。指定されていない場合、デフォルトのセキュリティ種別は AllUsers です。
API バージョン 43.0 以降の InstalledPackage には、次のいずれかの値に設定された activateRSS 項目を含める必要があります。
- true
- パッケージのリモートサイトの設定 (RSS) またはコンテンツセキュリティポリシー (CSP) の isActive の状態を保持します。
- false
- パッケージの RSS または CSP の isActive の状態を上���きし、false に設定します。
retrieve() コールを使用して InstalledPackage を取得すると、組織にインストールされたパッケージの XML 表現が作成されます。インストールされたパッケージにパスワードまたはセキュリティ種別が指定されている場合、その情報は取得されません。取得したファイルを別の組織にリリースすると、パッケージがその組織にインストールされます。
deploy() コマンドおよび retrieve() コマンドの詳細は、『メタデータ API 開発者ガイド』を参照してください。