Table Field Properties

The following table describes properties for table fields. For guidelines about how to set property values, see Best Practices for Table Field Properties.

The following properties are related to report models that are used to add information to a report. For more information, see How to: Generate a Model for an Ad Hoc Report (MorphX Reporting Tools).

  • AnalysisDefaultTotal

  • AnalysisLabel

  • AnalysisTotaling

  • AnalysisUsage

  • AnalysisVisibility

  • CurrencyCode

  • CurrencyCodeField

  • CurrencyCodeTable

Property

Description

Adjustment

Determines whether the string field should be left or right aligned when it is stored in the database. For example, if the 11 character string "hello world" is stored in a right aligned field that has a StringSize setting of 40, then 29 space characters are stored as the prefix.

NoteNote
The Adjustment setting affects the search result when you search for a value in a table using the relational operators >, <, >=, or <=. It does not affect ==.

The Adjustment setting is ignored when the StringSize is (Memo).

AliasFor

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

AllowEdit

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

AllowEditOnCreate

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

AnalysisDefaultTotal

For report models, it 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 OLAP cubes, it specifies the aggregate function for a measure. Use this property when AnalysisUsage is set to Measure. You can specify one of the following values.

  • Sum - Returns the sum of all the values in a set.

  • Count - Returns the number of non-null items in a set.

  • CountDistinct - Returns the number of distinct non-null items in a set.

  • Min - Returns the minimum value in a set.

  • Max - Returns the maximum value in a set.

  • None - No aggregate function is applied.

  • Auto - Applies to derived extended data types. The value of the AnalysisUsage property for the parent extended data type is to be used.

AnalysisLabel

Specifies the label to use as a caption in a SQL Server Analysis Services (SSAS) cube for the table field. The label is applied to either a dimension attribute or a measure.

This property is intended for use when either of the following are true:

  • The Label property is not defined.

  • The Label property does not work as a caption for a dimension attribute or a measure in a SSAS cube.

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 or 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.

AnalysisUsage

Identifies the role of the field in a cube. You can specify one of the following values.

  • Attribute - The field is a dimension attribute.

  • Measure - The field is a measure.

  • Both - The field is both a dimension attribute and a measure.

  • None - The field is not a dimension attribute and not a measure.

  • Auto - The value of the AnalysisUsage property for the extended data type or enumeration that the field is based on is to be used.

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.

ConfigurationKey

Sets the configuration key for the field.

ExtendedDataType

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

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.

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.

HelpText

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

ID

Specifies the field ID generated by the system.

Label

Specifies a label for the field. This will appear in forms and reports. See also AnalysisLabel (in a previous row).

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 the validateWrite method on your table buffer variable (that extends the xRecord class).

Name

Specifies the name of the field.

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.

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.

Type

Specifies the base type of a field.

Visible

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

Community Additions

ADD
Show: