Field Names and IDs

Set Fields Names and IDs to identify fields in the CRM database.

The fields in the Aurea CRM database are identified by the following numbers/IDs:

 

XML Output

Description

Usage

Field number

fnr

Sequential field numbering in the data model

None

Field ID

fid

vertical-specific unique field ID

Used to reference fields in CRM.Designer: All Aurea CRM.Web and CRM.Designer widgets containing a field selection display the vertical-specific unique field IDs.

Base field ID

cid

Base field ID

Used for template development (base template)

When specifying fields, as in a parameter definition, you can either enter the unique field ID or the XML name. The XML name is vertical-independent.

Note: Aurea recommends using XML names.

Wherever JSON or JavaScript is used, you need to enclose strings in single or double quotes, e.g., {property1: "value"}. In JSON, property names need to be enclosed in quotes as well, e.g. {"property1": "value"}. Therefore when referencing XML names in JavaScript expressions, you should always enclose them in double quotes.

To output field IDs and XML names:

  • In CRM.Designer the Field Control Editor displays both XML name and ID for the selected field. For additional information, see Field Attributes.
  • Start mmba.exe with the parameters --writedbstr --xmlfieldnames. For further information, check the mmba.exe parameters in the CRM.Core Administrator Guide.

    The mm_dbstr.txt file in the ..\system\db folder lists all info areas and their fields. For example:

    2 ; Last Name; FName; character; 80; ; ; ; ; LastName

    • The XML name of the Last name field in KP is "LastName".
    • The field ID of this field is "2".
  • Alternatively, look up this information in the data model. Open Aurea CRM.Win and go to theMaintenance module). To display XML names, select the desired info area and click in the Text column. Select Display resource texts from the context menu on the Texts page.
Note: When adding fields or creating new info areas, make sure you enter XML names for your fields. For further information, see the Data Model in the CRM.Core Administrator Guide.