メタデータ API 開発者ガイド
jDocumentGenerationSetting
パッケージマ��フェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
DocumentGenerationSetting コンポーネントのサフィックスは documentGenerationSetting で、documentGenerationSettings フォルダーに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
DocumentGenerationSetting コンポーネントは、API バージョン 52.0 以降で使用できます。
特別なアクセスルール
組織に DocGen プラットフォームライセンスおよび関連するアドオンとユーザーライセンスがある場合、DocumentGenerationSetting を使用できます。
サーバー側ドキュメント生成はデフォルトでは有効になっておらず、isServerSideDocGenEnabled の選択では不十分です。この機能を有効化するには、「Request Access to Server-Side Document Generation (サーバー側ドキュメント生成へのアクセス権の要求)」ナレッジ記事を参照してください。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| documentTemplateLibraryName | string | 必須。この設定を適用するドキュメントテンプレートを保存するライブラリの名前。 |
| generationMechanism | GenerationMechanism (string 型の列挙) | ドキュメントを生成する方法と場所を指定します。有効な値は、次のとおりです。
デフォルトは .ClientSide です。 |
| guestAccessNamedCredential | string | ゲストユーザーがドキュメントを生成できるようにする指定ログイン情報を指定します。 |
| isServerSideDocGenEnabled | boolean | 組織に前提条件ライセンスが存在する場合に、サーバー側ドキュメント生成を有効化します。 |
| masterLabel | string | 必須。設定の名前を指定します (「DocGen」 (ドキュメント生成) など)。 |
| previewType | PreviewType (string 型の列挙) | 生成されたドキュメントのプレビューの形式を指定します。有効な値は、次のとおりです。
デフォルトは PDF です。 |
宣言的なメタデータの定義のサンプル
DocumentGenerationSetting コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<DocumentGenerationSetting xmlns="http://soap.sforce.com/2021/10/metadata">
3 <documentTemplateLibraryName>DocgenDocumentTemplateLibrary</documentTemplateLibraryName>
4 <masterLabel>DocGen</masterLabel>
5</DocumentGenerationSetting>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2021/10/metadata">
3 <types>
4 <members>DocumentGeneration</members>
5 <name>Settings</name>
6 </types>
7 <version>53.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。