What Is a Field Code?

Article Number:040504

A field code is a string used for specifying a field in formulas and APIs.
Each field comes with a default field code. You can change the field code to a value of your choice.

Characters that can be used for field codes

Characters that can be used for field codes are as follows.

  • Hiragana
  • Katakana (half-width and full-width)
  • Kanji
  • Alphanumeric characters (half-width and full-width)
  • The following special characters:
    • Half-width underscore (_)
    • Full-width underscore (_)
    • Half-width middle dot (·)
    • Full-width middle dot (・)
    • Full-width currency symbols (e.g., $, ¥)

Points to note when setting a field code

If the field code you have entered contains any characters that cannot be used for a field code, an error message will appear when you click the save button located at the right of the input field for the field code or the save button on the field setting dialog.

The following describes the details of the points to note when you set a field code.

  • A field code must be between 1 and 128 characters long.
    The field setting cannot be saved if the input field for the field code is empty.

  • Set a field code that is not yet used for other fields on the app form.
    If you enter a field code that is already used for another field on the app form, the field code is suffixed with "_number" (e.g., "string_0") when you save the setting.

  • A field code cannot begin with a number.
    If you enter a field code that begins with a number, a half-width underscore (_) is prefixed to the field code when you save the setting.

  • The following special characters cannot be used.

    • Brackets like () (parentheses), 「」(corner brackets), [] (square brackets), 【】(black lenticular brackets), {} (curly brackets)
    • Special characters like @ + ~ # % & ' = | ^ * ; : ?
      Invalid half-width special characters are replaced with half-width underscores (_) when you save the setting. (For instance, the field code "A&B" will be converted into "A_B".)

  • A field code cannot contain space(s).
    When you save the setting, leading and trailing spaces are removed and other spaces are replaced with half-width underscores (_).

  • The following strings cannot be set as a field code.

    • Status
    • Assignee
    • Categories
    • __ROOT__
    • not

  • When you place a field on the app form, the value of the field name is automatically set as the field code.
    As for the following fields, the field codes are preset before they are placed on the app form. The preset field code is the value of the field name.
    Record number, Created datetime, Updated datetime, Created by, Updated by

    If you want to use the field name value of the aforementioned fields as the field code of another field on the app form, you need to change the preset field code to a different one, since it is not possible to set the same field code to multiple fields on the app form.

    Example: Steps to use the field code of the "Record number" field as that of a field of your choice

  1. Place the "Record number" field on the app form and change the field code to a different one (e.g., "Record_number_1").

  2. Place a field of your choice on the app form and change the field code to "Record_number".

  3. Save the app form.

  4. Delete the "Record number" field, which you have placed on the app form in step 1.

Steps to set field codes

Described below are the steps to check and set a field code.

  1. Click the app settings button Settings button at the upper right of the "View" screen and select the Form tab.
    Screenshot: The app settings button

  2. Hover over the setting button Setting button for the field whose field code you want to set, and click Settings. Screenshot: Hovering over the setting button

  3. Check the string displayed in the Field Code section.
    If you want to change the field code, click the edit button Edit button , enter a new field code, and then click Save.

    Screenshot: The "Calculated" field setting dialog

  4. Click Save Form at the upper left of the form setting screen.

  5. Click Update App (or Activate App) at the upper right of the app settings screen.

If an error appears

Field code error

If an error message appears when you set a field code and click the save button, check if the field code you have set does not contain any invalid characters that are explained in the "Points to note when setting a field code" section.