1. 環境管理

環境変数

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

!重要環境変数を変更するには、変更が適用されるために環境の 再構築や再デプロイ が必要です。

SitecoreAI Deployでは、Deployアプリ内で環境変数を直接作成することで、個別の環境に適用される設定を管理できます。

環境変数は、環境のソースコード外で作成されるキーと値のペアで、各値は環境に応じて変化します。環境変数を作成すると、それは環境のソースコードで参照可能です。

環境変数は、ソースコードを変更する必要がないため、設定変更を簡素化します。

例えば、SitecoreAIの本番環境では、OrderCloudの本番製品カタログに接続するための環境変数をAPIのURLや認証キーを作成できます。SitecoreAIのステージング環境では、環境変数の値を変更してステージング製品カタログに接続することができます。

プラグインと組み合わせたSitecoreコマンドラインインターフェース(CLI)を使って、環境変数の作成、更新、削除も可能です。

SitecoreAI環境には、以下のあらかじめ定義された環境変数が付属しています:

  • SITECORE_SPE_ELEVATION - Sitecore PowerShell拡張(SPE)モジュールのユーザーアカウント制御アクションを指定します。
  • Sitecore_GraphQL_ExposePlayground - 遊び場 GraphQL API Sitecore作成・管理 へのアクセスを有効・無効化する。
  • LOG_LEVEL_VALUE - 一般ログの対数レベルを設定します。
  • PUBLISHING_LOG_LEVEL_VALUE - 公開プロセスのログレベルを設定します。
  • PAGES_PERSONALIZE_SCOPE - 同じテナント上で異なる環境ごとに異なるパーソナライズルールを適用できる。

SitecoreAI環境は他にも特別な変数をサポートしています:

  • PAGES_ENABLE_NEW_RTE_EDITOR - ページビルダーの改良版リッチテキストエディタを有効にする。
  • Sitecore_dot_HtmlEditor_dot_WrapVideoTag - HTMLビデオタグに追加される幅ゼロの文字を除去します。

SITECORE_SPE_ELEVATION

SITECORE_SPE_ELEVATION環境変数は、インスタンス内でPowerShellスクリプトを実行するなどの活動にSPEモジュールを使った際、システムがどのように応答するかを指定します。

セキュリティ上の理由から、SPEのセッション高位アクション値のデフォルト値はBlockedです。したがって、以下のアプリケーションや活動がブロックされます。

  • スクリプト環境(ISE)です。
  • コマンドライン(CLI)です。
  • アイテムセーブ。

SITECORE_SPE_ELEVATION環境変数の値を変更することで、ブロックされたタスクを完了するために権限を上げたいときにデフォルトのブロック動作を上書きできます。

利用可能な値は以下の通りです:

価値

概要

Block

デフォルトの値です。ユーザーに許可を求めずに、常にセッションが昇格で実行されるのをブロックします。

Confirm

セッションをエレベートで実行する前にユーザーに確認を求めるプロンプト。

Allow

ユーザーに許可を求めることなくセッションを実行させてください。

> [!危険]
> SITECORE_SPE_ELEVATION値を「ローカル環境のみ許容」に設定してください。

!注値は大文字・文字を区別しています。

Sitecore_GraphQL_ExposePlayground

Sitecoreのオーサリング&マネジメントGraphQL APIを使うと、Sitecore_GraphQL_ExposePlayground環境変数の助けを借りてGraphQLプレイグラウンドを公開できます。GraphQLのプレイグラウンドはデフォルトで無効化されています。プレイ グラウンドAPI GraphQL作成および管理を有効化し、承認 しなければ使用できません。

LOG_LEVEL_VALUE

この変数を使って一般的なログのログレベルを設定でき、Deployアプリのプロジェクトタブの「 Projects 」から環境を選択することでアクセスできます。

Environment logs in the Deploy app

利用可能な値は詳細の降順で以下の通りです:

価値

概要

ALL

利用可能なすべての情報。

DEBUG

非常に詳細なイベント情報。

INFO

デフォルト価値。一般的なイベント情報。

WARN

潜在的に有害または失敗した出来事。

ERROR

エラーイベント。

FATAL

致命的な出来事。

OFF

ログもありません。

PUBLISHING_LOG_LEVEL_VALUE

この変数を使って公開プロセスのログレベルを設定できます。

利用可能な値は詳細の降順で以下の通りです:

価値

概要

ALL

利用可能なすべての情報。

DEBUG

非常に詳細なイベント情報。

INFO

デフォルト価値。出版プロセスの進行に関する一般的な情報。

WARN

潜在的に有害または失敗した出来事。

ERROR

エラーイベント。

FATAL

出版プロセスを停止させる致命的な出来事。

OFF

ログもありません。

PAGES_PERSONALIZE_SCOPE

SitecoreAI Personalizeを使うと、パーソナライズフローや分析を実行するためにユニークなページ識別子が使われます。場合によっては、サイトシリアライズによって作成されたページなど、異なる環境間で同一のページ識別子が作成されることもあります。

このような環境間でパーソナライズデータを分離するには、PAGES_PERSONALIZE_SCOPE環境変数を使用します。現在の環境においてパーソナライズされたページの一意識別子を作成します。

変数を使わない場合、Personalizeでページを識別するデフォルトの構造は以下の通りです:

embedded_{pageID}_{language}

例えば、myEnvの値を持つPAGES_PERSONALIZE_SCOPE変数を加えた後、そのIDは次のように変更されます。

embedded_myEnv_{pageID}_{language}

パーソナライズと分析はページ識別子に基づいています。パーソナライズルールが作成された後にPAGES_PERSONALIZE_SCOPE値を変更または追加すると、既存のルールは機能しなくなり、ページビルダーに表示されなくなります。これはページ識別子が再計算されるためで、以前の識別子が新しい値と一致しないためです。したがって、実装の初期段階でこの変数を適用し、その後設定を変更しないことを推奨します。

!注許可されているのは英数字の文字(文字と数字)のみです。値は大文字に区別されます。

PAGES_ENABLE_NEW_RTE_EDITOR

!注アプリのJSS v21.5.2以降が搭載されているか確認してください。Next.jsアプリケーションで使われているJSSバージョンはpackage.jsonとpackage-lock.jsonファイルで確認できます。

以前のJSSバージョンを使用している場合は、まずJSS 21.5のNext.jsアプリをバージョン21.6にアップグレードする必要があります。

CKEditorは、ページビルダーのリッチテキストコンポーネント内で利用可能で、表の追加、テキストの検索・置換、画像の多様なスタイル付けなど、いくつかの新機能を提供します。

非ローカル環境で新しいエディタを有効にするには、PAGES_ENABLE_NEW_RTE_EDITORという環境変数を作成します。この変数はフラグ変数です。割り当てられた値に関わらず、新しいエディタを有効にします。古いエディタに戻るには、変数を削除してください。

ローカルインスタンスに接続されたページビルダーで新しいCKEditorを有効にするには、CMコンテナにPAGES_ENABLE_NEW_RTE_EDITOR環境変数を追加してください。

Sitecore_dot_HtmlEditor_dot_WrapVideoTag

コンテンツエディターのリッチテキストフィールドを使って

この記事を改善するための提案がある場合は、 お知らせください!