Attribute Editing Parameters
As end users are working within the application, they have the ability to edit certain fields for certain components. The ability to view and/or edit field varies by component type.
For example, the following image displays the Component pane for a support structure:
While the following image displays the Component pane for a tap:
To configure the ability to edit or view certain fields, set values to true or false in the Schema.xml. For example, below you can see that for the field PoleType, it is Editable, Viewable, and imported from the GIS into the DHFC application:
<Field CoaxName="PoleType" EsriName="PoleType" Editable="true" Viewable="true" Import="true" />
The following topics discuss components that bear fields specially handled by DHFC. Any field not appearing in these lists is considered editable by DHFC and does not have any additional special handling other than what is defined in the Schema.xml file.
-
Some system fields are explicitly hidden from the users in the Attribute Editor. These are typically fields that appear elsewhere in the interface or do not provide useful information to the user. For example, the InternalPowerMapping field has values, but they are presented to the user as an operable diagram, which is far more useful than the raw value itself. There is no attribute setting in the Schema.xml to change the hidden nature of these fields.
-
In string fields, angle brackets < > are not supported and result in errors when pushing a design back to the GIS. This is because surrounding text with angle brackets could inadvertently create an HTML tag, which uses angle brackets in its formatting. The push process then attempts to render the HTML tag, resulting in error. While it is possible to disable the web content filter on the published map service (which would stop the application from trying to render the HTML tag), this is not recommended as it creates a cross site scripting vulnerability. For more information about the HTML tags, see the esri support topic Feature Services and Client Applications > Entering HTML into Text Fields. For more information about the cross site scripting vulnerability, see the esri support topic Editor Permissions for Feature Services > Advanced Editing Options.
All tables use the following terminology:
-
Editable: This refers to the "Editable" attribute on a field in the Schema.xml. Set to “true” to allow users to edit that field in the Attribute Editor in the Component tab.
-
In the following topics, any field marked as “No” is a reserved system field and cannot be edited via the Attribute Editor. Changes to these reserved fields are ignored by the application. In other words, even if you set to “true,” reserved fields are not editable in the Attribute Editor.
-
Fields marked as editable are necessarily Viewable. In addition, the editable setting overrides the viewable setting. In other words, a field that is editable appears in the application, even if it is set to not viewable.
-
-
Viewable: This refers to the "Viewable" attribute in the Schema.xml. Set to "true" to allow users to see the value as a read-only field in the Attribute Editor.
-
Viewable fields that are not editable do need a specified DataType.
-
-
Requires Import: This refers to the "Import" attribute in the Schema.xml. Field values originating from the GIS or those that go to/from the GIS should have import set to “true.” Values marked as No in the subsequent tables are fields that DHFC supplies and are either ignored on import or are intended to be a one-way, to-GIS property that do not need to be imported. Fields marked as "true" in the Schema.xml file correspond to the Required Fields and Data Types in the documentation.
-
Data Type Attribute: This refers to the "DataType" attribute in the Schema.xml. This attribute is only relevant if the field is editable. If the attribute is omitted or unrecognized, the value in the field is treated as a string. The attribute value is not case sensitive, but must be one of the following supported types:
-
double
-
int
-
Int32
-
Int64
-
guid
-
boolean
-
Nullable types like double?, int?, etc. are not supported.
-
-
Validation Options: Validation options depend on the DataType specified for a given field. Currently, the following validation types are supported:
-
Range: This applies to int, int32, int64 and double data types.
-
Max Length: This applies to string data types only.
-
Required: This can be assigned to any field, but is really only valuable for the string data type, which has a null default value. All other data types provide a default value, so inherently have a value set.
-
-
Coded Domain Name: This refers to the "CodedDomainName" attribute in the Schema.xml. Fields that have well known coded domains (for example, are enumerations in DHFC) have the CoaxName of the commonly configured <CodedValueDomain> section in the Schema.xml listed. This varies among clients, but they are commonly the same.
-
Notes: There are a few exceptions to the above parameters found in the Notes column in the subsequent tables.