X++ Computed Columns and Virtual Fields in Data Entities

Computed columns and virtual fields in
data entities
• 20/06/2017
• Tiempo de lectura: 6 minutos
•
o
This article provides information about computed and virtual fields, which are the two
types of unmapped fields that a data entity can have. The article includes information
about the properties of unmapped fields, and examples that show how to create, use,
and test them.
The sample code is targeted towards creating or modifying an entity that is a part of
solution that you own. Extending an existing entity requires slight modifications.
Overview
A data entity can have additional unmapped fields beyond those that are directly
mapped to fields of the data sources. There are mechanisms for generating values for
unmapped fields:
• Custom X++ code

• SQL executed by Microsoft SQL Server
The two types of unmapped fields are computed and virtual. Unmapped fields always
support read actions, but the feature specification might not require any development
effort to support write actions.
Computed field
• Value is generated by an SQL view computed column.
• During read, data is computed by SQL and is fetched directly from the view.
• For writes, custom X++ code must parse the input value and then write the parsed values
to the regular fields of the data entity. The values are stored in the regular fields of the
data sources of the entity.
• Computed fields are used mostly for reads.
• If possible, it's a good idea to use computed columns instead of virtual fields, because
they are computed at the SQL Server level, whereas, virtual fields are computed row by
row in X++.
Virtual field
• Is a non-persisted field.
• Is controlled by custom X++ code.
• Read and write happens through custom X++ code.
• Virtual fields are typically used for intake values that are calculated by using X++ code and
can't be replaced by computed columns.
Properties of unmapped fields
PROPERTIES OF UNMAPPED FIELDS
Category Name Type Default Behavior

value
Data IsComputedField NoYes Yes • Yes – The field is synchronized as a SQL view computed
column. Requires an X++ method to compute the SQL
definition string for the column. The virtual column definition is
static and is used when the entity is synchronized. After that,
the X++ method is not called at run time.
• No – The field is a true virtual field, where inbound and
outbound values are fully controlled through custom code.
PROPERTIES OF UNMAPPED FIELDS
Category Name Type Default Behavior

value
Data ComputedFieldMethod String A static DataEntity method in X++ to build the SQL expression that
will generate the field definition. This property is disabled and
irrelevant if the property IsComputedField is set to No. The method
is required if the property IsComputedField is set to Yes.
Data ExtendedDataType String
Example: Create a computed field
In this example, you add a computed field to the FMCustomerEntity entity. For reads,
the field combines the name and address of the customer into a nice format. For writes,
your X++ code parses the combined value into its separate name and address values,
and then the code updates the regular name and address fields.
1. In Microsoft Visual Studio, right-click your project, and add the

existing FMCustomerEntity.
2. In Solution Explorer, right-click the FMCustomerEntity node, and then click Open.
3. In the designer for FMCustomerEntity, right-click the Fields node, and then
click New > String Unmapped Field.
4. Rename the new field NameAndAddress.

5. Update properties of the NameAndAddress unmapped field, as shown in the
following screenshot.
6. Go to FMCustomerEntity > Methods. Right-click the Methods node, and then
click New. Ensure that the method name matches the DataEntityView
Method property value of the unmapped computed field.
7. Paste the following X++ code into the method. The method returns the combined
and formatted NameAndAddress value.
Nota
The server keyword is required.
X++Copiar
private static server 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(" "));
identifierstr(FMCustomer), fieldstr(FMCustomer, LastName)));
fieldList.addEnd(SysComputedColumn::returnLiteral("; "));
identifierstr(FMAddressTable), fieldstr(FMAddressTable, AddressLine1)));
fieldList.addEnd(SysComputedColumn::returnLiteral(", "));
identifierstr(FMAddressTable), fieldstr(FMAddressTable, City)));
identifierstr(FMAddressTable), fieldstr(FMAddressTable, State)));
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
Sugerencia
If you receive error in data entity synchronization because of computed columns,

it's easier to come up with the SQL definition in Microsoft SQL Server Management
Studio (SSMS) before using it in X++.
8. Rebuild the project.

9. Synchronize the database. Don't forget this step. You can do this by going
to Dynamics 365 > Synchronize database > Synchronize.
Example: Create a virtual field
In this example, you add a virtual field to the FMCustomerEntity entity. This field
displays the full name as a combination of the last name and first name. X++ code
generates the combined value.
1. In the designer for the FMCustomerEntity entity, right-click the Fields node, and
then click New > String Unmapped Field.
2. In the properties pane for the unmapped field, set the Name property
to FullName.
3. Set the Is Computed Field property to No. Notice that you leave
the DataEntityView Method empty.
4. In the FMCustomerEntity designer, right-click the Methods node, and then

click Override > postLoad. Your X++ code in this method will generate the values
for the virtual field.
5. Paste the following X++ code in for the postLoad override. Notice that
the postLoad method returns void.
X++Copiar
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;
}
6. Compile your project.
Example: Use a virtual field to receive and parse an inbound field
Imagine that an external system sends the name of a person as a compound value that
combines the last and first names in one field that comes into our system. However, our
system stores the last and first names separately. For this scenario, you can use
the FullName virtual field that you created. In this example, the major addition is an
override of the mapEntityToDataSource method. When update is
called, mapEntityToDataSource methods are invoked for each data source.
1. In the designer for the FMCustomerEntity, right-click the Methods node, and
then click Override > mapEntityToDataSource.
2. Paste the following X++ code in for the mapEntityToDataSource method.
X++Copiar
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));
}
}
Test the computed and virtual fields
The following main method tests your computed and virtual fields. Both fields are
tested in a read action, and the virtual field is tested in an update action.
1. For this example, ensure that you have the data set named Fleet Management
(migrated). The data set is available from the dashboard in the browser. Click the
menu icon in the upper-right corner, click the APP LINKS menu, and then scroll to
find the data set named Fleet Management (migrated).
2. Paste the following X++ code into the startup object of your project. Run your
project.
X++Copiar
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 == "[email protected]";
//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 == "[email protected]";
//Read full name (virtual field)
info(customer.FullName);
ttsabort;
}

X++ Computed Columns and Virtual Fields in Data Entities

Uploaded by

Copyright:

Available Formats

X++ Computed Columns and Virtual Fields in Data Entities

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

X++ Computed Columns and Virtual Fields in Data Entities

Uploaded by

Copyright:

Available Formats

Computed columns and virtual fields in

• Custom X++ code

Category Name Type Default Behavior

Category Name Type Default Behavior

Data ExtendedDataType String

Example: Create a computed field

1. In Microsoft Visual Studio, right-click your project, and add the

4. Rename the new field NameAndAddress.

The server keyword is required.

private static server str formatNameAndAddress() // X++

T-SQL for the computed column.

( Cast (( ( T1.firstname ) + ( N' ' ) + ( T1.lastname ) + ( N'; ' ) +

If you receive error in data entity synchronization because of computed columns,

8. Rebuild the project.

4. In the FMCustomerEntity designer, right-click the Methods node, and then

public void postLoad()

6. Compile your project.

Example: Use a virtual field to receive and parse an inbound field

public void mapEntityToDataSource(DataEntityRuntimeContext entityCtx,

public static void main(Args _args) // X++

You might also like