Field Formatting

The Field Formatting feature enables you to configure how dates, times, and numbers are formatted in the site's viewers. Field formatting ensures that data is displayed to end users using the format that you specified, localized to the user's locale. Essentials supports a number of common, predefined formats, as well as custom formats.

If you use the viewer's locale parameter in viewer launch URLs, it will override the user's locale, which is used to localize dates, times, and numbers in the viewer. All dates, times, and numbers will be in the locale that is specified in the URL parameter. For more information, see URL Parameters Reference.

Background

There are many different formats that can be used for presenting dates, times, and numbers. Different locales use different conventions. For example, the USA uses a period as the decimal mark and commas to group the digits in large numbers—12,345,678.9—whereas the Netherlands uses a comma as the decimal mark and periods to group digits—12.345.678,9. Similarly, USA dates are written in month, day, year order and time is written using the 12-hour clock—10/20/2015 8:45:07 PM—whereas in the Netherlands, dates are written in day, month, year order and time is written using the 24-hour clock—20-10-2015 20:45:07.

Within a particular locale, there are options for how dates, times, and numbers can be formatted. For example, you might want to write out the month—October 20, 2015 in the USA or 20 oktober 2015 in the Netherlands—or you might want to present numeric data as currency—$12,345,678.90 in the USA or US$12.345.678,90 in the Netherlands.

In some situations, the choice of formatting reflects what is significant in the context. For example, an application that maps major earthquakes through the ages might omit the day and time from dates—Oct. 1707 in the USA or okt. 1707 in the Netherlands.

Contexts Where Field Formatting Applies

Field formatting is applied to feature data, data from data links, and data from ArcGIS tables. It applies to nearly all contexts, for example, search and identify results, measurements, map tips, and feature details.

There are a few contexts in which viewers do not apply the formatting:

Field formatting also applies to contexts in which users enter values, such as Global Search, Query Builder, and workflow forms. The viewer assumes that values entered by the user are in the notation of the user's locale. For example, a viewer would interpret 8-11-2015 as August 11, 2015 in locales that place the month before the day, or as November 8, 2015 in locales that place the day first.

Interpretation of numeric data also depends on the locale. For example, suppose a user in the Netherlands is looking at land values in the USA. The user creates a query in Query Builder to search for parcels valued at less than ninety-two thousand dollars. The user enters value < 92.000. Because the user's locale is nl-NL, the viewer interprets the value as ninety-two thousand, not ninety-two point zero zero zero.

If the viewer cannot interpret the value in the user's locale, the viewer tries to interpret it in en-US notation. For example, if the user enters value < 92,000.00, the viewer would not be able to interpret the value in the standard nl-NL notation, so the viewer would interpret it in en-US notation (the "invariant" location).

About Configuring Field Formats

You can configure date/time and number formats at the map service level, the layer level, and the field level. By default, formatting is inherited from a higher level—fields inherit their formatting from the layer, and layers inherit their formatting from the map service.

You can use inheritance to reduce the amount of configuration you have to do. For example, suppose you have a Parcels layer with several fields related to the parcel's value—the assessed value, value of improvements, value at which the parcel last sold, and so on. Instead of configuring each field individually, you could configure the layer to use Currency formatting and let the fields inherit the formatting.

Initially, the formatting for map services, layers, and fields is set to Default, which inherits the formatting from a higher level. You can override inherited values by configuring a particular format at a lower level. For example, you could set a date format for a map service, but override it for a particular layer within the map service, and override it again for a particular date field in the layer.

If you leave the format for a field, its layer, and its map service all set to Default, the viewer uses the Fixed-point format with up to four decimal digits for numeric data and the Date and Time format for dates, adjusted for the user's locale.

Data links use the format that is configured for the layer that the data link belongs to—you cannot configure formatting for individual fields in data links.

Format Date/Time Fields

Essentials allows you to configure how date/time data is formatted in the site's viewers. This allows end users to see and enter date/time values in the notation of the user's locale. You can choose date/time formats from a list of predefined formats or you can define custom formats.

Predefined Date/Time Formats

The predefined date/time formats that Essentials supports are based on the .NET Framework Standard Date and Time Format Strings. These formats use the notation and language of the user's locale. For example, dates are written in month, day, year order in the en-US locale and day, month, year order in nl-NL. Words are written in English in en-US and in Dutch in nl‑NL.

The following table lists the predefined date/time formats and gives examples of how the different predefined formats display in three sample locales.

Examples of Predefined Date/Time Formats for 2015-03-11 22:37:15 in Different Locales

Format

User's Locale:
en-US
(USA)

User's Locale:
nl-NL
(Netherlands)

User's Locale:
pt-PT
(Portugal)

Date and Time: Uses an abbreviation to display the name of the month. Includes hours and minutes in the time, but omits the seconds.

Date and Time formatting is the default formatting for date/time fields. If the Date Format setting is set to Default for a field, its layer, and its map service, the viewer uses Date and Time formatting.

Example:

Mar 11, 2015 10:37 PM

11 mrt. 2015 22:37

11 de Mar de 2015 22:37

Date and Time (Long): Same as Date and Time, except it displays the full name of the month.

Example:

March 11, 2015 10:37 PM

11 maart 2015 22:37

11 de Marҫo de 2015 22:37

Date:Represents the month as a number, and omits the time.

Example:

03/11/2015

11-03-2015

11/03/2015

Date (Long): Same as Date, except it displays the full name of the month.

Example:

March 11, 2015

11 maart 2015

11 de Marҫo de 2015

Minutes, Hours: Displays the time without the seconds. Omits the date.

Example:

10:37 PM

22:37

22:37

Minutes, Hours, Seconds: Same as Minutes, Hours, but includes the seconds.

Example:

10:37:15 PM

22:37:15

22:37:15

Full: Displays the full date and time, including the day of the week., with the name of the day and month displayed in full.

Example:

Wednesday, March 11, 2015 10:37 PM

woensdag 11 maart 2015 22:37

Quarta-Feira, 11 de Março de 2015 22:37

Custom Date/Time Formats

Essentials supports the .NET Framework Custom Date and Time Format Strings, with the following exceptions:

For information about custom date and time format strings, refer to the .NET Framework documentation for Custom Date and Time Format Strings.

In custom date/time formats, the order of the format specifiers determines the order to display the day, month, and year—the order is not automatically localized. If your application may be viewed by users in locales that use a different order, make sure the format is unambiguous. You might want to use a format specifier that displays the name of the month, such as "MMM" or "MMMM".

Configure Date/Time Formatting

To save yourself from doing more configuration than necessary, configure date/time formatting by starting at the map service level and working down. First configure the map service to use the format that you want most of the date/time fields to use. Next, override the map service setting by configuring the layers that use a different format than the map service. Finally, override the layer setting by configuring the fields that use a different format than their layers.

To configure date/time formatting:

  1. Follow the instructions that apply to you:

    Configure the Map Service-Level Date/Time Format

    1. In Manager, edit the map service that you want to configure, and then click the Display Settings tab.

      The formatting settings are in the Field Formatting area.

    Configure the Layer-Level Date/Time Format

    1. In Manager, click Map in the side panel, click the Map Services tab, expand the map service that the layer belongs to, and then click the Edit icon next to the layer.

    2. Click the Fields tab.

      The layer-level formatting settings are in the Default Formatting area.

    Configure the Field-Level Date/Time Format

    1. In Manager, click Map in the side panel, click the Map Services tab, expand the map service that the layer belongs to, and then click the Edit icon next to the layer.

    2. Click the Fields tab.

    3. If you have not yet added the field, add the field.

      This allows you to configure the field separately from the other fields in the layer.

      1. Click Add/Remove Fields.

      2. To add one or more fields, select the fields in the Excluded Fields column, and then click the Include button that is between the two columns.

        To select multiple fields, hold the Ctrl key down while you select the fields.

      3. To remove fields that have been added, select the fields in the Included Fields column, and then click the Exclude button that is between the two columns.

        You can also exclude fields after you close the Add/Remove Fields dialog box by clicking the Remove icon beside the field that you want to exclude.

      4. Click OK.

        The Fields tab lists the fields that you have added. The <all other fields> item is at the top of the list. The <all other fields> item enables you to change the settings for the fields that you have not added.

      5. Click Submit Field Changes.

        You can now individually re-order and change the settings of any added field, and batch change the settings of the excluded fields.

    4. Click the Edit icon next to the field.

  2. In the Date Format box, select the format from the drop-down list.

  3. If you selected Custom Date Format in the Date Format box, enter the custom format string that you want to use.

    Do not put quotation marks around the custom format string.

  4. Apply your changes.

Format Number Fields

Essentials allows you to configure how numeric data is formatted in the site's viewers. This allows end users to see and enter numeric values in the notation of the user's locale. You can choose number formats from a list of predefined formats or you can define custom formats.

You do not need to configure formatting to fields with Esri's OID data type, such as ObjectID fields, Number formatting does not apply to OID fields, even though they have a numeric data type in Essentials.

Predefined Number Formats

The predefined number formats that Essentials supports are based on the .NET Framework Standard Numeric Format Strings. These formats use the notation and language for the user's locale. For example, the decimal mark is a period in the en-US locale and a comma in nl-NL. Words are written in English in en-US and Dutch in nl-NL.

The predefined number formats allow you to specify the number of decimal digits to show in the viewer. If a stored value has more decimal digits than the format displays, then the value is rounded—0.5 and greater is rounded up, and less than 0.5 is rounded down. For example, 0.2576 displays as 0.26 when the Decimal Places setting is set to 2. If a stored value has fewer decimal digits than the format displays, then the displayed value is padded with zeros. Setting the number of decimal places to 0 (zero) displays integers.

You do not have to configure the number of decimal digits to display. If you leave the Decimal Places setting blank for the Number, Fixed-point, or Percentage format, the viewer displays as many decimal digits as the stored value contains, to a maximum of four. For the Currency and Accounting formats, the viewer displays the conventional number of decimal digits for the specified currency, for example, two decimal digits for US dollars and euros, or zero decimal digits for Japanese yen.

The following table lists the predefined number formats and gives examples of how the different predefined formats display in three sample locales.

Examples of Predefined Number Formats in Different Locales

Format

Unformatted Value *

Decimal Places

Currency

User's Locale:
en-US
(USA)

User's Locale:
nl-NL
(Netherlands)

User's Locale:
pt-PT
(Portugal)

Number: Uses separators to separate groups of digits in large numbers.

Examples:

6431.5238

-104.123456

3

not specified

n/a

n/a

6,431.524

-104.1235

6.431,524

-104,1235

6.431,524

-104,1235

Fixed-point: The same as Number, except Fixed-point does not use separators in large numbers.

Fixed-point formatting is the default formatting for number fields. If the Number Format setting is set to Default for a field, its layer, and its map service, the viewer uses fixed-point formatting with up to four decimal digits.

Examples:

6431.5238

-0.91

3

not specified

n/a

n/a

6431.524

-0.91

6431,524

-0,91

6431,524

-0,91

Percentage: Multiplies the stored value by 100 and presents it as a percentage.

Examples:

0.19842

1.43

0

not specified

n/a

n/a

20%

143%

20%

143%

20%

143%

Currency: Displays the currency symbol, and, if necessary for disambiguation, the type of currency.

For example, if the data is in US dollars and the user's locale is en-CA (Canada), the viewer displays US before the value, as in US$42.99. This prevents the user from misinterpreting the value as being in Canadian dollars. If the user's locale is in the USA, the viewer does not display the currency type.

Examples:

-90871.5

1000000

4050.613

2

not specified

not specified

USD

EUR

JPY

-$90,871.50

€1,000,000.00

¥4,051

US$ -90.871,50

€ 1.000.000,00

JP¥ 4.051

-US$90.871,50

€1.000.000,00

JP¥4.051

Accounting: The same as Currency, except Accounting uses parentheses for negative values.

Examples:

-90871.5

1000

2

4

USD

EUR

($90,871.50)

€1,000.0000

(US$ 90.871,50)

€ 1.000,0000

(US$90.871,50)

€1.000,0000

* The Unformatted Value column uses periods "." to represent the decimal mark.

Essentials recognizes numbers in both locale-specific formats (1,234,567·89) and invariant format used by en locales (1234567.89). In locales where the invariant format and locale-specific format conflict, it recognizes only the locale's interpretation. For example, the de locale uses periods as group separators (100.000), so the invariant format (100000) cannot be interpreted reliably.

Custom Number Formats

Essentials supports the .NET Framework Custom Numeric Format Strings, with the following exceptions:

For information about custom numeric format strings, refer to the .NET Framework documentation.

Configure Number Formatting

To save yourself from doing more configuration than necessary, configure number formatting starting at the map service level and working down. First configure the map service to use the format that you want most of the number fields to use. Next, override the map service setting by configuring the layers that use a different format than the map service. Finally, override the layer setting by configuring the fields that use a different format than their layers.

To configure number formatting:

  1. Follow the instructions that apply to you:

    Configure the Map Service-Level Number Format

    1. In Manager, edit the map service that you want to configure, and then click the Display Settings tab.

      The formatting settings are in the Field Formatting area.

    Configure the Layer-Level Number Format

    1. In Manager, click Map in the side panel, click the Map Services tab, expand the map service that the layer belongs to, and then click the Edit icon next to the layer.

    2. Click the Fields tab.

      The layer-level formatting settings are in the Default Formatting area.

    Configure the Field-Level Number Format

    1. In Manager, click Map in the side panel, click the Map Services tab, expand the map service that the layer belongs to, and then click the Edit icon next to the layer.

    2. Click the Fields tab.

    3. If you have not yet added the field, add the field.

      This allows you to configure the field separately from the other fields in the layer.

      1. Click Add/Remove Fields.

      2. To add one or more fields, select the fields in the Excluded Fields column, and then click the Include button that is between the two columns.

        To select multiple fields, hold the Ctrl key down while you select the fields.

      3. To remove fields that have been added, select the fields in the Included Fields column, and then click the Exclude button that is between the two columns.

        You can also exclude fields after you close the Add/Remove Fields dialog box by clicking the Remove icon beside the field that you want to exclude.

      4. Click OK.

        The Fields tab lists the fields that you have added. The <all other fields> item is at the top of the list. The <all other fields> item enables you to change the settings for the fields that you have not added.

      5. Click Submit Field Changes.

        You can now individually re-order and change the settings of any added field, and batch change the settings of the excluded fields.

    4. Click the Edit icon next to the field.

  2. In the Number Format box, select the format from the drop-down list.

  3. Currency: If you selected the Currency or Accounting number format, enter the currency type of the stored data.

    For example, if the stored data is in euros, enter EUR. The default is USD (US Dollars).

    To see a complete list of currency codes, delete the default currency type—a drop-down list of currency codes will open. To find out what the codes stand for, refer to this list of ISO 4217 currency codes.

  4. Decimal Places: If you selected one of the predefined formats, enter the number of decimal digits that you want to display.

    Alternatively, leave the Decimal Places setting blank to display up to four decimal digits (Number, Fixed-point, and Percentage formats) or the conventional number of decimal digits for the specified currency (Currency and Accounting formats). To display integers, enter 0.

    This precision setting cannot exceed the maximum representable IEEE 754 floating point. This is specified in the IEEE 754 standard. See double-precision floating-point format and significant figures for more information.

  5. Custom Number Format: If you selected Custom Number Format in the Number Format box, enter the custom format string that you want to use.

    Do not put quotation marks around the custom format string.

  6. Apply your changes.

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 4.11