開発環境 (.env) ファイルのコンフィギュレーション

[アーティクル]
03/08/2023

この記事では、Microsoft Dynamics 365 Commerce で開発環境に使用する .env ファイルを構成する方法について説明します。

Dynamics 365 Commerce オンラインソフトウェア開発キット (SDK) の一部として提供される .env ファイルは、単純なコンフィギュレーションテキストファイルです。開発環境で実行される Node アプリで使用される一連の変数を定義します。

既定の .env ファイル

オンライン SDK に用意されている既定の .env ファイルは次の例のようになります。

### Environment File ##################################################################
# This is a simple configuration 
# Online documentation for this file is available at 
# https://learn.microsoft.com/dynamics365/commerce/e-commerce-extensibility/configure-env-file
########################################################################################

# MSDyn365_APP_TYPE variable is required. It can be set only to the value partner.

MSDyn365_APP_TYPE=partner

# PORT variable is required. It defines the port number that is used to preview your Node 
#   application when the Node server is started by using the yarn start command. The default value is 4000

PORT=4000

# MSDyn365_HOST variable defines the domain name of your customer-facing e-Commerce site. 
#   When this variable is set, if the URL https://localhost:4000/ is opened in a development environment, 
#   your e-Commerce site will be rendered locally. If your site is protected through Azure Active Directory 
#   (Azure AD) credentials, a prompt for a user name and password will appear.

MSDyn365_HOST=

# MSDyn365Commerce_BASEURL variable defines the URL of the Microsoft Dynamics 365 Retail Server. 
#   When this variable is set, local development and testing can be done against Dynamics 365 Retail Server
#   application programming interfaces (APIs). If you set this variable, you must also set the 
#   MSDyn365Commerce_CHANNELID, MSDyn365Commerce_OUN, and MSDyn365Commerce_CATALOGID variables.
# MSDyn365Commerce_OUN variable defines the operating unit number for the channel.
# MSDyn365Commerce_CATALOGID variable defines the catalog ID for the online store that you're connecting to. 
#   Currently, only the value 0 (zero) is supported.
# MSDyn365Commerce_CHANNELID variable defines the online channel that you're connecting to.

MSDyn365Commerce_BASEURL=
MSDyn365Commerce_CHANNELID=
MSDyn365Commerce_CATALOGID=
MSDyn365Commerce_OUN=

# MSDyn365Commerce_BASEIMAGEURL variable defines the URL for a website's image assets. 
#   The URL follows a pattern and must be manually generated. For more information, 
#   see online product documentation.

MSDyn365Commerce_BASEIMAGEURL=

.env ファイルである MSDyn365_APP_TYPE と PORT の 2 つの変数は必須であり、事前設定された値があります。すべての他の変数はオプションです。オプションの変数を使用すると、開発環境が有効となり、実稼働環境からデータを取得できます。このデータは、ローカル開発 Node サーバーに表示されます。

次のセクションでは、.env ファイルの変数について説明します。

MSDyn365_APP_TYPE

MSDyn365_APP_TYPE 変数が必要です。値パートナーのみ設定できます。

PORT

PORT 変数が必要です。 Node サーバーが yarn 開始コマンドを使い開始される場合、Node アプリケーションをプレビューするために使用されるポート番号を定義します。既定値は 4000 です。

次の例では、この変数の構文を示します。

PORT=4000

ポート番号を含む開発環境 URL の例を次に示します。

https://localhost:4000/version

MSDyn365_HOST

MSDyn365_HOST 変数は、顧客向け e コマースサイトのドメイン名を定義します。この変数が設定されている際、URL https://localhost:4000/ が開発環境で開かされている場合は、e コマースサイトがローカルに表示されます。サイトが Azure Active Directory (Azure AD) 資格情報と通して保護されている場合、ユーザー名とパスワードのプロンプトが表示されます。

次の例では、この変数の構文を示します。

MSDyn365_HOST=demo.fabrikam.com

MSDyn365Commerce_BASEURL

MSDyn365Commerce_BASEURL 変数は、Microsoft Dynamics 365 Commerce Scale Unit URL を定義します。この変数を設定すると、アプリケーションプログラミングインターフェイス (APIs) に対してローカルの開発とテストを行える必要があります。この変数を設定する場合は、MSDyn365Commerce_CHANNELID、MSDyn365Commerce_OUN、および MSDyn365Commerce_CATALOGID 変数も設定する必要があります。

次の例では、この変数の構文を示します。

MSDyn365Commerce_BASEURL=https://fabrikamb1de06d29165320bret.cloud.retail.dynamics.com/

MSDyn365Commerce_OUN

MSDyn365Commerce_OUN 変数は、チャンネルの操作単位番号を定義します。

チャンネルの操作単位番号を検索するには、次の手順に従います。

コマース Web サイトに移動します。
ページの上部にある検索フィールドで、オンラインチャンネルと入力し、使用するチャンネルを選択します。次の図に示すように、操作単位番号列が表示されます。

次の例では、この変数の構文を示します。

MSDyn365Commerce_OUN=128

MSDyn365Commerce_CATALOGID

MSDyn365Commerce_CATALOGID 変数は、接続するオンライン店舗のカタログ ID を定義します。現在、値 0 (ゼロ) のみがサポートされています。

MSDyn365Commerce_CHANNELID

MSDyn365Commerce_CHANNELID 変数は、接続するオンラインチャンネルを定義します。

チャンネル ID を検索するには、これらの手順に従います。

Dynamics 365 Commerce の Web サイトに移動します。
ページの上部にある検索フィールドで、オンラインチャンネルと入力し、使用するチャンネルを選択します。
オプションタブのアクションウィンドウの、ページオプショングループで、レコード情報を選択します。
レコード情報ダイアログボックスでは、レコード ID フィールドの値がチャンネル ID です。値をコピーします。

次の例では、この変数の構文を示します。

MSDyn365Commerce_CHANNELID=68719478279

MSDyn365Commerce_BASEIMAGEURL

MSDyn365Commerce_BASEIMAGEURL 変数は、Web サイトの画像資産の URL を定義します。 URL はパターンに従い、手動で生成する必要があります。次の手順のいずれかを実行します。

評価サイトでは、URL の形式は次のとおりです。

https://images-us-sb.cms.commerce.dynamics.com/cms/api/{CMS_TENANT_ID}/imageFileData/search?fileName=/
生産サイトでは、URL の形式は次のとおりです。

https://img-prod-cms-mr-microsoft-com.akamaized.net/cms/api/{CMS_TENANT_ID}/imageFileData/search?fileName=/

両方の URL でも、{CMS_TENANT_ID} を使用中のサイトに割り当て済みのコンテンツ管理システム (CMS) テナント ID に置き換える必要があります。

Dynamics 365 Commerce の CMS テナント ID を取得するには、次の手順に従います。

サイトで、使用中のサイトを選択します。
左のナビゲーションウィンドウで、資産を選択します。
タイプを選択フィールドで、画像を選択します。
最初の画像を選択します。
右側のプロパティウィンドウで、公開 URL フィールドの URL を検索します。 CMS テナント ID は、/cms/api/ と /imageFileData の間の文字列です。たとえば、URL ../cms/api/fabrikam/imageFileData/.. で、CMS テナント ID は fabrikam です。