設定リファレンス.

Learn DXPR BuilderReferenceConfiguratie en API

DXPR Builderは設定をDrupalの設定システムに格納します。このページでは config/schema/dxpr_builder.schema.ymlで宣言する全キーを型、許容値、既定値と共に挙げます。各設定エンティティーのstatusキーと、スキーマ項目なしにコードが読む設定キーも挙げます。太字名はフォームラベルです。

モジュールはconfig/install/dxpr_builder.settings.ymlを出荷しません。既定値はdxpr_builder.installのhook_install()と更新フックで設定するか、キー欠落時にコードで適用します。どちらかはDefaultカラムの通りです。

一般設定

設定オブジェクト: dxpr_builder.settings

管理パス: /admin/dxpr_studio/dxpr_builder/settings (src/Form/DxprBuilderSettingsForm.php)

Key	Type	Allowed values	Default	Description
`json_web_token`	string	DXPRプロダクトキー (JWT)	empty	Product key。`api_key_storage`が`config`の場合だけです。キーをKeyモジュールに格納するとクリアします。更新9026は残った値をクリアします。
`api_key_storage`	string	`config` (Configuration storage)、`key` (Key module)	not set (`config`扱い)。`key`は`dxpr_builder_update_9020()`が既存キーを移動した後の値です	Storage methodはプロダクトキー用です。
`key_provider`	string	KeyエンティティーID	empty。更新9020が既存キー移動時に`dxpr_builder_jwt`を設定します	Keyエンティティーは`api_key_storage`が`key`の場合にプロダクトキーを保持します。
`bootstrap`	string	`0`, `bs5`	not set (Bootstrapファイルを読み込みません)	Sideload Bootstrap files。`0`はNone (theme provides Bootstrap)、`bs5`はBootstrap 5です。更新8040は削除済み`1`と`bs4`値を`bs5`に書き換えます。
`cke_stylesset`	string	1行に1つの`[label]=[element].[class]`項目	empty (エディターはDXPR Builder付属スタイルを使います)	Custom stylesはテキストエディター用です。例: `Sassy Title=h1.sassy-title`。
`editor_assets_source`	integer	`0`, `1`, `2`	not set (`0`)	Asset source。`0`はCloud、`1`はLocal (minified)、`2`はLocal (unminified)です。フィールドはモジュールの`dxpr_builder/`フォルダーにローカルビルドがある場合だけ現れます。`0`格納時もそのビルドを使い、非圧縮版を優先します。
`format_filters`	boolean	`true`、`false`	not set (off)	Apply text format filters to frontend contentです。
`media_browser`	string	`''` (Basic file upload)、`media_library` (Media Library)、`media_library_acquia_dam` (Media Library (Acquia DAM))、またはEntity Browser ID	`media_library`はMedia Libraryモジュールありの場合。なければ`dxpr_builder_media_modal` (`dxpr_builder_media`ありの場合)。それもなければ`''` (`hook_install()`設定)	Browser typeは画像フィールド用です。
`offset_selector`	string	CSSセレクター	`.dxpr-theme-header--sticky, .dxpr-theme-header--fixed` (空の場合に適用)	Scroll offset selectorは固定ヘッダー用です。
`controls_layout`	string	`element` (On each element)、`breadcrumb` (One row)	`element` (空の場合に適用)	Control barsは編集モード用です。各エレメントのバーか、指すエレメントの上の1行か。プロファイルとユーザー独自設定が上書きします。ユーザー設定は設定ではありません。ユーザーアカウントと共に格納します (`user.data`、モジュール`dxpr_builder`、名`controls_layout`)。

AI設定

同じdxpr_builder.settingsオブジェクトに格納します。

管理パス: /admin/dxpr_studio/dxpr_builder/ai_settings (src/Form/DxprBuilderAiSettingsForm.php)

Key	Type	Allowed values	Default	Description
`ai_enabled`	boolean	`true`、`false`	`true`は欠落時の値です。更新9008で設定	Enable text editing assistantです。
`ai_page_enabled`	boolean	`true`、`false`	`true`は欠落時の値です。更新9012で設定	Enable page creation assistantです。
`ai_image_enabled`	boolean	`true`、`false`	`true`は欠落時の値です。更新9015で設定	Enable image generationです。
`ai_user_model_selection`	boolean	`true`、`false`	`true`は欠落時の値です。更新9016で設定	Allow users to choose modelです。`ai_provider_dxpr`未導入時のみ表示します。
`ai_model`	string	`dxai_kavya_m1`、`dxai_kavya_m1_eu`、`dxai_kavya_m1_fast`	`dxai_kavya_m1` (`AiModelConstants::getDefaultModel()`)	Default modelです。API名は`kavya-m1`、`kavya-m1-eu`、`kavya-m1-fast`です。`ai_provider_dxpr`未導入時のみ表示・保存します。
`ai_provider_selection_mode`	string	`automatic` (Automatic)、`manual` (Manual priority)	`automatic`	Service providersモードです。`manual`は`ai_providers`の順序を使います。`ai_provider_dxpr`未導入時のみ保存します。
`ai_providers`	sequence of mappings keyed by provider id	キー: `anthropic`、`gemini`、`mistral`、`openai`、`xai`。各項目は`enabled` (真偽値)、`weight` (整数)、`region` (`enabled`または`disabled`) を持ちます	empty (フォームは5つすべて有効として挙げます)	プロバイダー優先表は`manual`モード用です。`region`は行の所属区分であり地理的地域ではありません。
`tone_of_voice_vocabulary`	string	タクソノミーボキャブラリーID	`ai_tone_of_voice` (Taxonomy有効時に`hook_install()`作成、更新9007作成)	Tone of voice vocabularyです。更新9025は格納ボキャブラリー消滅時に値を`ai_tone_of_voice`に戻します。
`enable_taxonomy_tones`	boolean	`true`、`false`	`true`はトーンボキャブラリー設定後の値です	ボキャブラリーと共に`true`を設定します。設定者は`hook_install()`、更新、フォームです。フォームフィールドなし、コードも読みません。
`commands_vocabulary`	string	タクソノミーボキャブラリーID	`ai_agent_commands` (Taxonomy有効時に`hook_install()`作成、更新9007作成。キー空時のみ)	Commands vocabularyです。
`enable_taxonomy_commands`	boolean	`true`、`false`	`true`はコマンドボキャブラリー設定後の値です	ボキャブラリーと共に`true`を設定します。設定者は`hook_install()`、更新9007、フォームです。フォームフィールドなし、コードも読みません。
`ai_output_allowed_domains`	text	1行1ドメイン (ワイルドカード可、例: `.wikipedia.org`)。``は全許可。空は全外部URL拒否	`unsplash.com`、`images.unsplash.com`、`pexels.com`、`images.pexels.com`、`pixabay.com`、`promptahuman.com` (`hook_install()`と更新9013で設定)	Allowed domainsです。フォームでFilter AI outputのチェックを外すと`*`を格納します。
`ai_output_allowed_tags`	text	1行1HTMLタグ名	一般的なテキスト、一覧、表、インライン、メディア、フォームタグの一覧 (`div`から`rp`)。キー欠落時にフォーム適用	Allowed HTML tagsです。未掲載タグはマークアップを失いテキストだけ残ります。
`ai_output_stripped_tags`	text	1行1HTMLタグ名	`script`、`style`	Blocked tagsです。中身ごと削除します。Filter AI outputのチェックを外すと既定の`script`と`style`を格納します。

フォームフィールドなしにコードが読むキー

このキーはスキーマにありませんが、モジュールはdxpr_builder.settingsから読みます。drush config:setかsettings.phpの設定上書きで設定します。

Key	Type	Default when missing	Description
`record_analytics`	boolean	`true`	trueの場合にエディター利用分析を`tuur.dxpr.com`へ送信します。
`notifications`	boolean	`true`	trueの場合にエディターでDXPR通知を表示します。
`cloud_url`	string	`https://cdn2.dxpr.com/VERSION/`	エディターアセットのCDN基準URLです。`VERSION`はモジュール版に置換します。
`license_endpoint`	string	`https://dxpr.com/api/central-user-storage/`	ライセンス済みユーザー同期のエンドポイントです。

ページテンプレート

設定オブジェクト: dxpr_builder.page_template.* (エンティティータイプdxpr_builder_page_template)

管理パス: /admin/dxpr_studio/dxpr_builder/page_template

Key	Type	Allowed values	Default	Description
`id`	string	マシン名	required	識別子です。
`label`	label	任意のテキスト	required	Label。テンプレート選択に表示する名です。
`status`	boolean	`true`、`false`	`true`	Enabledです。エディターは有効テンプレートだけ提供・読み込みします。
`category`	text	任意のテキスト	empty (フォーム必須)	Categoryはテンプレートの所属区分です。
`template`	string	DXPR Builder HTML	empty (フォーム必須)	Templateマークアップです。
`weight`	integer	任意の整数	empty (エディターは`0`として読みます)	Weight。並び順です。
`date`	integer	Unixタイムスタンプ	保存ごとに編集フォーム設定	最終更新時間です。
`image`	string	Base64エンコード画像内容	empty	Image。サムネイルです。
`uuid`	string	UUID	generated	世界一意のIDです。

モジュールはconfig/installに5つのページテンプレートを出荷します。 about_me、about_us、homepage_basic、 split_content_and_buttons、text_columnsです。

ユーザープロファイル

設定オブジェクト: dxpr_builder.dxpr_builder_profile.* (エンティティータイプdxpr_builder_profile)

管理パス: /admin/dxpr_studio/dxpr_builder/profile

新プロファイルではフォームが全エレメント、ブロック、ビューディスプレイ、有効ページテンプレート、有効グローバルユーザーテンプレート、アイコンセットにチェックを入れ、既定のテキストエディターボタン一式を付けます。下の既定値はエンティティー独自の値です。

Key	Type	Allowed values	Default	Description
`id`	string	マシン名	required	識別子です。
`label`	label	任意のテキスト	required	Label。プロファイル名です。
`uuid`	string	UUID	generated	世界一意のIDです。
`status`	boolean	`true`、`false`	`true`	User profile enabledです。無効プロファイルはユーザーロール照合で飛ばします。
`sidebar`	boolean	`true`、`false`	not stored	レガシーキーです。スキーマ宣言はありますがエンティティーが書き出さないため保存されません。
`dxpr_editor`	boolean	`true`、`false`	`true`。更新8008が既存プロファイルに設定	Start editor when page loadsです。`false`の場合、メインコンテナーコントロールの目のアイコンのクリック後にだけコントロールが現れます。
`controls_layout`	string	`default` (Same as the site)、`element` (On each element)、`breadcrumb` (One row)	`default`	Control barsはこのプロファイルの編集モード用です。ユーザー独自設定が上書きします。
`weight`	integer	`-10`から`10`まで (フォーム)	`0`	Weight。ユーザーロールが複数有効プロファイルに一致する場合、最小ウェイトが勝ちます。
`roles`	sequence of strings	ロールマシン名 (フォームは`anonymous`と`authenticated`を除きます)	empty	Rolesはプロファイル適用対象です。
`elements`	sequence of strings	エレメントマシン名 (`az_text`、`az_image`など)	empty	許可するElementsです。
`all_elements`	boolean	`true`、`false`	`false`	Check/Uncheck all Elementsです。`true`の場合、全エレメントを許可し`elements`を無視します。
`blocks`	sequence of strings	`az_block-<block plugin id>`値	empty	許可するBlocksです。
`all_blocks`	boolean	`true`、`false`	`false`	Check/Uncheck all Blocksです。`true`の場合、後追加分含め全ブロックを許可します。
`views`	sequence of strings	`az_view-<view id>-<display id>`値	empty	許可するViewsディスプレイです。
`all_views`	boolean	`true`、`false`	`false`	Check/Uncheck all Viewsです。`true`の場合、後追加分含め全ビューディスプレイを許可します。
`page_templates`	sequence of strings	ページテンプレートUUID	empty	許可するPage templatesです。
`all_page_templates`	boolean	`true`、`false`	`false`	Check/Uncheck all Page templatesです。`true`の場合、全ページテンプレートを許可します。
`user_templates`	sequence of strings	グローバルユーザーテンプレートUUID	empty	許可するGlobal user templatesです。
`all_user_templates`	boolean	`true`、`false`	`false`	Check/Uncheck all Global user templatesです。`true`の場合、全グローバルユーザーテンプレートを許可します。
`icon_sets`	sequence of strings	アイコンセットIDは`*.dxpr_icon_sets.yml`ファイル由来です	empty	許可するIcon setsです。
`all_icon_sets`	boolean	`true`、`false`	not set (`true`扱い)	Check/Uncheck all Icon setsです。`true`または欠落の場合、全アイコンセットを許可します。
`inline_buttons`	sequence of strings	CKEditor 5ボタン名	empty	Text editor buttons (inline editing)です。更新8036はこの一覧と`modal_buttons`のCKEditor 4名を移行しました。
`modal_buttons`	sequence of strings	CKEditor 5ボタン名	empty	Text editor buttons (modal editing)です。

ユーザーテンプレート

設定オブジェクト: dxpr_builder.user_template.* (エンティティータイプdxpr_builder_user_template)

管理パス: /admin/dxpr_studio/dxpr_builder/user_templates

Key	Type	Allowed values	Default	Description
`id`	string	マシン名	required	識別子です。
`label`	label	任意のテキスト	required	Label。テンプレート名です。
`status`	boolean	`true`、`false`	`true`	フォームフィールドなし。有効テンプレートだけエディター読み込みやページテンプレート複写ができます。
`type`	string	テンプレート保存元`data-azb`エレメントタイプです。例: `section`、`row`、`az_block`、`az_view`、`custom`	`custom`	Typeです。更新9021はマークアップから補填します。`az_block_`と`az_view_`値は`az_block`と`az_view`に畳みます。
`template`	string	DXPR Builder HTML	empty	Templateマークアップです。更新8013はユーザーテンプレートをDB表から設定へ移しました。
`uid`	integer	ユーザーID	フォーム必須	UID。所有者です。
`global`	boolean	`true`、`false`	`true` (エディターの保存リクエストが独自値を送信)	Global。`true`は全ユーザーにテンプレートを開放します (プロファイル対象)。`false`は所有者の私物にします。
`image`	string	Base64エンコード画像内容	empty	Image。サムネイルです。
`uuid`	string	UUID	generated	世界一意のIDです。

設定の書き出し

DXPR Builder設定をすべて書き出します。

drush config:export

設定、プロファイル、ページテンプレート、ユーザーテンプレートをYAMLファイルとして設定同期ディレクトリーに書き出します。api_key_storageがkeyの場合、プロダクトキーはdxpr_builder.settingsの一部ではありません。選択したKey エンティティーに存在し、そのキー独自のプロバイダー (設定、ファイル、環境変数など) に従います。

次はこちら

一般設定: 設定フォーム
ファイアウォールとデータレジデンシー: 送信接続を制御するキー
APIエンドポイント: この設定を読むルート