Custom Properties

Custom properties are arbitrary name/value pairs that provide a means to pass values from the server to the client application. For example, you might define a property for the site administrator's email address so the web application can display the address to the end user. Or you might define a property for the base URI of stored images so the client application can construct the full URIs for images on the fly.

One use of custom properties is to provide metadata about server-side objects. For example, if you configure a Boolean CanSelect property for a layer, the developer can use the property in an application to determine whether or not users can select the layer using a custom selection tool.

Because custom properties do not have any logic associated with them, no development work is required to create custom properties. Custom properties are configured in Geocortex Essentials Manager. Every object that can have custom properties configured for it has a Properties hyperlink in Manager. For example, to create a custom property for a map service, edit the map service—the Properties hyperlink is at the bottom of the Details tab.

Create a Custom Property

To create a custom property:

  1. In Geocortex Essentials Manager, edit the site that you want to configure and navigate to the object that you want to define a custom property for.

  2. Click the Properties hyperlink.

  3. Click Add Property.

  4. Type a name for the new property.

    If the property name begins with an underscore (_), the property will not be published by the REST API. It will only be accessible to server-side components.

  5. Type the property's value.

  6. Click OK.

  7. Click Save Site.