データエンティティの列と仮想フィールドを計算する

[アーティクル]
06/19/2024

この記事では、計算されたフィールドと仮想フィールドに関する情報を提供します。これは、データエンティティが持つことができる 2 つのタイプのマッピングされていないフィールドです。この記事には、マップされていないフィールドのプロパティに関する情報と、それらの作成、使用、テストの方法を示す例が含まれています。

サンプルコードは、ユーザーが所有しているソリューションの一部であるエンティティの作成または変更を行う用途で使用します。既存のエンティティを拡張するには、若干の変更を加える必要があります。

概要

データエンティティは、データソースのフィールドに直接マップされているフィールド以外にマップされていないフィールドを追加で持つことができます。マップされていないフィールドの値を生成するメカニズムは次のとおりです。

カスタム X++ コード
Microsoft SQL Server で実行される SQL

マップされていない2種類のフィールドは、計算と仮想です。マップされていないフィールドは常に読み取り操作をサポートしますが、機能仕様では、書き込み操作をサポートするための開発作業は必要とされない場合があります。

計算フィールド

値は、SQL ビューの計算列によって生成されます。
読み取り中に、データは SQL によって計算され、ビューから直接フェッチされます。
書き込みについては、カスタム X++ コードは入力値を解析し、データエンティティの通常のフィールドに解析された値を書き込む必要があります。値はエンティティのデータソースの通常のフィールドに格納されます。
計算フィールドは主に読み取りに使用されます。
可能であれば、計算された列は SQL Server レベルで計算されている一方、仮想フィールドは、X++ の行ごとに計算された行であるため、可能な限り仮想フィールドではなく計算された列を使用することをお勧めします。

仮想フィールド

保持されないフィールドです。
カスタム X++ コードによって制御されます。
読み取り/書き込みは、カスタム X++ コードを通じて発生します。
仮想フィールドは通常X++ コードを使用して計算される入力値に使用され、計算された列に置き換わることはできません。
仮想フィールドでの検索およびフィルター処理はサポートされていません。

マップされていないフィールドのプロパティ

カテゴリ	氏名	種類	既定値	動作
データ	IsComputedField	NoYes	有	はい: - フィールドは、SQL ビューの計算済み列として同期されます。列の SQL 定義文字列を計算するために X++ メソッドが必要です。仮想列の定義は静的であり、エンティティが同期されているときに使用されます。その後は、 X++ メソッドは、実行時に呼び出されません。いいえ - フィールドは、入庫および出荷の値がカスタムコードによって完全に制御される真の仮想フィールドです。
データ	ComputedFieldMethod	文字列		フィールド定義を生成する SQL 式を構築するための X++ の静的 DataEntity メソッド。プロパティ IsComputedField がいいえに設定されている場合、このプロパティは無効で無関係です。このメソッドは、プロパティ IsComputedField がはいに設定されている場合に必要です。
データ	ExtendedDataType	文字列

例: 計算フィールドを作成

この例では、FMCustomerEntity エンティティに計算フィールドを追加します。読み取りについては、このフィールドは、顧客の名前と住所を適切な形式に結合します。書き込みについては、X++ コードは複合値を個別の名前および住所の値に解析し、それからコードが通常の名前や住所フィールドを更新します。

Microsoft Visual Studio で、プロジェクトを右クリックし、既存の FMCustomerEntity を追加します。
ソリューションエクスプローラーで、FMCustomerEntity ノードを右クリックしてから開くをクリックします。
FMCustomerEntity のデザイナービューで、Fields ノードを右クリックし、New > String Unmapped Field とクリックします。
新しいフィールドの名前を NameAndAddress に変更します。
次のスクリーンショットに示すように、マッピングされていない NameAndAddress フィールドのプロパティを更新します。
FMCustomerEntity > メソッドに移動します。 メソッド ノードを右クリックし、新規をクリックします。メソッド名が、マップされていない計算されたフィールドの DataEntityView方法 のプロパティ値と一致していることを、確認します。

次の X++ コードをメソッドに貼り付けます。このメソッドは、結合されて書式設定された NameAndAddress 値を返します。

private static str formatNameAndAddress()   // X++
{
    DataEntityName      dataEntityName= tablestr(FMCustomerEntity);
    List                fieldList = new List(types::String);
    ////Format name and address to look like following
    ////John Smith, 123 Main St, Redmond, WA 98052
    fieldList.addEnd(SysComputedColumn::returnField(DataEntityName, identifierstr(FMCustomer), fieldstr(FMCustomer, FirstName)));
    fieldList.addEnd(SysComputedColumn::returnLiteral(" "));
    fieldList.addEnd(SysComputedColumn::returnField(DataEntityName, identifierstr(FMCustomer), fieldstr(FMCustomer, LastName)));
    fieldList.addEnd(SysComputedColumn::returnLiteral("; "));
    fieldList.addEnd(SysComputedColumn::returnField(DataEntityName, identifierstr(FMAddressTable), fieldstr(FMAddressTable, AddressLine1)));
    fieldList.addEnd(SysComputedColumn::returnLiteral(", "));
    fieldList.addEnd(SysComputedColumn::returnField(DataEntityName, identifierstr(FMAddressTable), fieldstr(FMAddressTable, City)));
    fieldList.addEnd(SysComputedColumn::returnLiteral(", "));
    fieldList.addEnd(SysComputedColumn::returnField(DataEntityName, identifierstr(FMAddressTable), fieldstr(FMAddressTable, State)));
    fieldList.addEnd(SysComputedColumn::returnLiteral(", "));
    fieldList.addEnd(SysComputedColumn::cast(
        SysComputedColumn::returnField(DataEntityName, identifierstr(FMAddressTable), fieldstr(FMAddressTable, ZipCode)), "NVARCHAR"));
    return SysComputedColumn::addList(fieldList);
}

T-SQL for the computed column.

( Cast (( ( T1.firstname ) + ( N' ' ) + ( T1.lastname ) + ( N'; ' ) +
    ( T5.addressline1 )
    + ( N', ' ) + ( T5.city ) + ( N', ' ) + ( T5.state ) + (
    N', '
    ) +
    ( Cast(T5.zipcode AS NVARCHAR) ) ) AS NVARCHAR(100))
)
AS
NAMEANDADDRESS

ヒント

計算列のためにデータエンティティの同期にエラーが発生した場合、X++ で使用する前に、Microsoft SQL Server Management Studio (SSMS) で SQL 定義を用意することは簡単です。

プロジェクトをリビルドします。
データベースを同期させます。この手順を忘れないでください。 Dynamics 365 > データベースの同期 > 同期に移動することによりこれを実行することができます。

例: 仮想フィールドを作成

この例では、FMCustomerEntity エンティティに仮想フィールドを追加します。このフィールドには、姓と名の組み合わせとしてフルネームが表示されます。 X++ コードは複合値を生成します。

FMCustomerEntity エンティティのデザイナーで、フィールドノードを右クリックしてから、新規 > マップされていない文字列フィールドをクリックします。
マップされていないフィールドのプロパティウィンドウで、名前プロパティを FullName に設定します。
計算フィールドかどうか プロパティ いいえ に設定します。 DataEntityView メソッドが空のままであることを確認します。
FMCustomerEntity デザイナーで、メソッドノードを右クリックしてから、オーバーライド > postLoad とクリックします。このメソッドの X++ コードは、仮想フィールドの値を生成します。

次の X++ コードを postLoad オーバーライドに貼り付けます。 postLoad メソッドが void を返すことに注意します。

public void postLoad()
{
    super();
    //Populate virtual field once entity has been loaded from database
    //Format full name - "Doe, John"
    this.FullName = this.LastName + ", " + this.FirstName;
}

プロジェクトをコンパイルします。

例: 受信フィールドを受信および解析する仮想フィールドを使用

外部システムが、システムに送信する 1 つのフィールドに姓と名を組み合わせた複合値として人物の名前を送信する場合を考えてみましょう。ただし、システムは姓と名を個別に格納します。このシナリオでは、作成した FullName 仮想フィールド使用することができます。この例で、主要な追加は mapEntityToDataSource メソッドのオーバーライドです。更新が呼び出されると、各データソースごとに mapEntityToDataSource メソッドが呼び出されます。

FMCustomerEntity のデザイナーで、メソッドノードを右クリックしてから、オーバーライド > mapEntityToDataSource とクリックします。

次の X++ コードを mapEntityToDataSource メソッドに貼り付けます。

public void mapEntityToDataSource(DataEntityRuntimeContext entityCtx, DataEntityDataSourceRuntimeContext dataSourceCtx)
{
    super(entityCtx, dataSourceCtx);
    //Check if desired data source context is available
    if (dataSourceCtx.name() == "FMCustomer")
    {
        FMCustomer dsCustomer = dataSourceCtx.getBuffer();
        //Find position of "," to parse full name format "Doe, John"
        int commaPosition = strfind(this.FullName, ",",0,strlen(this.FullName));
        //Update FirstName and LastName in the data source buffer to update
        dsCustomer.LastName = substr(this.FullName,0,commaPosition-1);
        dsCustomer.FirstName = substr(this.FullName, commaPosition+1, strlen(this.FullName));
    }
}

計算フィールドと仮想フィールドのテスト

次の main メソッドは、計算フィールドと仮想フィールドをテストします。両方のフィールドは読み取りアクションでテストされ、仮想フィールドは更新アクションでテストされます。

この例では、フリート管理 (移行済)というデータセットがあることを確認します。データセットはブラウザーのダッシュボードから利用できます。右上隅にあるメニューアイコンをクリックし、アプリのリンク メニューをクリックしてスクロールし、フリート管理 (移行) という名前のデータセットを見つけます

次の X++ コードをプロジェクトのスタートアップオブジェクトに貼り付けます。プロジェクトを実行します。

public static void main(Args _args)   // X++
{
    FMCustomerEntity customer;
    //Using transactions to avoid committing updates to database
    ttsbegin;
    //SELECT single customer entity record from the database
    select customer
        where customer.Email == "phil.spencer@adatum.com";
    //Read full name (Virtual Field)
    info(customer.FullName);
    //Read formatted NameAndAddress(computed Field)
    info(customer.NameAndAddress);
    //UPDATE full name (virtual field)
    customer.FullName = "Doe, John";
    customer.update();
    //Reselect data from database to get updated information
    select customer
        where customer.Email == "phil.spencer@adatum.com";
    //Read full name (virtual field)
    info(customer.FullName);
    ttsabort;
}

計算列の生成に失敗した場合の注意事項

計算列の SQL を生成する X++ メソッドが例外をスローした場合、DbSync は例外をキャッチし、その列の値を NULL に設定して、警告を記録します。

開発者は、計算列のメソッドでコンフィギュレーションキーを手動でチェックして、生成に失敗した場合に NULL 値がヒットされないようにすることをお勧めします。

次の方法で共有

データエンティティの列と仮想フィールドを計算する

概要

計算フィールド

仮想フィールド

マップされていないフィールドのプロパティ

例: 計算フィールドを作成

例: 仮想フィールドを作成

例: 受信フィールドを受信および解析する仮想フィールドを使用

計算フィールドと仮想フィールドのテスト

計算列の生成に失敗した場合の注意事項

フィードバック

その他のリソース

次の方法で共有

データ エンティティの列と仮想フィールドを計算する

概要

計算フィールド

仮想フィールド

マップされていないフィールドのプロパティ

例: 計算フィールドを作成

例: 仮想フィールドを作成

例: 受信フィールドを受信および解析する仮想フィールドを使用

計算フィールドと仮想フィールドのテスト

計算列の生成に失敗した場合の注意事項

フィードバック

その他のリソース

データエンティティの列と仮想フィールドを計算する