Table Field Properties

The following table describes properties for table fields. For guidelines about setting property values, see Best Practice for field properties.

The following properties are related to report models that are used to add information to a report. For more information, see Create Reports Using Report Builder.

  • AnalysisDefaultTotal

  • AnalysisTotaling

  • AnalysisVisibility

  • CurrencyCode

  • CurrencyCodeField

  • CurrencyCodeTable

Property

Description

ID

Specifies the field ID generated by the system.

Type

Specifies the base type of a field.

Name

Specifies the name of the field.

Label

Specifies a label for the field. This will appear in forms and reports.

HelpText

Specifies the help string for the field. The help string is displayed when the field is used in a form.

GroupPrompt

Specifies a label for the field when it appears in a group.

TipTip
You can use this property to ensure that a field label does not repeat text that appears in a field group label. For example, if a field group on a form is labeled Customer, do not include this text in the GroupPrompt property for fields that are included in the group.

SaveContents

Determines whether the field data is saved in the database or is treated as virtual field data. Virtual field data is calculated at run time when the field is displayed, and has no physical representation in the database.

TipTip
Instead of virtual fields, you can use display and edit methods.

Mandatory

Indicates whether a user must add data to a field in a form.

If you set the property to Yes for an enum field, an enumeration value that has an integer value of 0 is not available to select in a form. The enumeration values associated with an enum field is based on the EnumType property setting.

When you use X++ code to set the property to Yes, you must call validateWrite.

AllowEditOnCreate

Determines whether users are allowed to enter data in the field when a new record is created from a form.

AllowEdit

Determines whether users are allowed to modify data in an existing record in a form.

Visible

Determines whether the field should be visible in the user interface.

ConfigurationKey

Sets the configuration key for the field.

AliasFor

Determines the table field for which the field is an alias.

To learn about alias fields, see Alias Fields.

AnalysisVisibility

Specifies the visibility of a field in Microsoft SQL Server Reporting Services report models, using the following property values:

  • DefaultField specifies that a field appears when you navigate to a table in a report and when the table is added to a report.

  • High specifies that a field appears at the top level in the field list for a table.

  • Low specifies that a field appears in a subfolder called Other Data.

If you set the property to None, the field does not appear in data analysis tools such as Report Builder.

For more information about report models, see Create an Ad Hoc Report Model.

AnalysisTotaling

Specifies which aggregates for a field will be available when you are using Microsoft SQL Server Reporting Services. The following values are possible:

  • Default specifies that one ore more of the following aggregates are available for Integer, Real, and Date fields: sum, minimum, maximum, and average.

  • DefaultAndStatistics specifies that one or more of the following aggregates are available for Integer, Real, String, Date, and Timeofday fields: sum, minimum, maximum, average, standard deviation, population standard deviation, variance, population variance, count, and count distinct.

For more information about report models, see Create an Ad Hoc Report Model.

AnalysisDefaultTotal

Specifies the method for aggregating field data when an automatic total for the table is displayed in a report built by using Microsoft SQL Server Reporting Services and report models.

The default value is No, which indicates that the field is not automatically shown as a total.

For more information about report models, see Create an Ad Hoc Report Model.

ExtendedDataType

Determines the extended data type to be used for this field.

StringSize

Sets the field length, in number of characters.

The maximum field length is database-dependent. The Memo value indicates that the field is unlimited in length.

Adjustment

Determines whether the field should be left or right aligned when stored in the database.

NoteNote
This affects the search result when searching for a value in a table using the relational operators >, <, >=, or <=.

FieldUpdate

Determines whether Microsoft Dynamics AX should use relative or absolute updating when updating field information in the database.

Absolute updating ensures that each modification is saved with the record in the database.

Relative updating combines each modification before the record is saved in the database.

CurrencyCode

Specifies the currency code for doing multicompany analysis. The following values are available:

  • SecondaryCurrency specifies that a field always contains values in the SecondaryCurrencyCode field in the CompanyInfo table, for the company associated with each record.

  • CurrencyCodeField specifies that the CurrencyCodeTable and CurrencyCodeField properties define the currency for values in a field.

For more information about report models, see Create an Ad Hoc Report Model.

CurrencyCodeTable

Specifies a related table containing a field that stores the currency codes for each value in a field. For information about related tables, see Defining relations between tables.

This property is available only when CurrencyCode is set to CurrencyCodeField.

CurrencyCodeField

Specifies the field that stores the currency codes for each value in a field.

This property is available only when CurrencyCode is set to CurrencyCodeField.

EnumType

Specifies the enum type that the field is based on.

Community Additions

ADD
Show: