Registering a Custom Field Editor

Once you have deployed your field editor you must register it with the Content Engine. To do this, create a file called configuration-root/com/escenic/resolver/NamedServiceResolver.properties in one of your configuration layers (if it does not already exist) and add a definition like this to it:

service.editor-name=editor-url

where:

  • editor-name is a name that you will use to refer to the editor when configuring fields in your content-type resource.

  • editor-url is the URL of the location to which you deployed the field editor. If you deployed it to a location in your local domain then you can omit the domain name component of the URL. If you deployed it in some other domain, then you must specify an absolute URL including the http: prefix.

If, for example, you deployed the field editor to the standard location in your own domain - http://your-domain.com/webservice-extensions/slider.html - and you want to call it slider, then you would add the following to NamedServiceResolver.properties:

service.slider=/webservice-extensions/slider.html

If for some reason you had deployed the editor to a different domain than your Content Engine, then you would need to enter:

service.slider=http://some-other-domain/field-editors/slider.html

NamedServiceResolver.properties can contain many such entries, so you can register all your field editors in the same file.

You are recommended to always deploy your field editors to http://content-engine-domain/webservice-extensions. If for some reason you need to use a field editor that is deployed elsewhere outside the local domain, then you should consider setting up a Content Engine proxy service and access the field editor via the proxy service. This is likely to simplify firewall configuration and ultimately be more secure. For detailed information about Content Engine proxy services and how to create them, see Content Engine Proxy Services.