Configuration

You must configure the CEC so that it works with your chosen applications and in the environment of your site. Please follow this sequence:

  1. Edit the CEC's "environment" to tell it where to find things.
  2. Edit the "registration-template" document.
  3. Preview the registration document.
  4. Restart the web application to pick up the changed configuration.

Instructions for each step are gven below.

Edit the CEC's environment

The CEC needs to be told where to find things in its operating environment. You do this by editing the "environment entries" (i.e. named properties) for your application server.

The method by which these environment entries are edited will depend on the application server that you are using.

The environment entries are described in more detail here.

When you have saved the changes in the configuration you will need to restart the web application for tomcat to pick up the new environment.

The CEC's working directories and configuration files

By default, the CEC uses a fixed directory-structure for its configuration and working files.

 
                  (base)/ 
                  (base)/temp 
                  (base)/records 
                  (base)/config
                  (base)/config/registration-template.xml
                  (base)/config/app-description.xml

In this structure, (base) is the directory you specify by setting the environment entry cea.base.dir . By changing this entry, you can move the directory structure anywhere you like. However, it is usually best to place the structure at the location outside the tomcat directory tree. That way, the the configuration will be saved when updating either the CEA CEC or Tomcat itself.

The file (base)/config/registration-template.xml is the registration-template document.

It is always possible to check the the configuration with the Show current configuration sidebar menu.

Edit the registration template

The CEC uses an XML document called a registration template to generate the registration documents that it submits to the IVO resource-registry. You need to edit this template.

To find the registration template, use the show current configuration link in the sidebar. You need to replace the copy at that location with a customized version.

To create a new registration document use this template. The template initialized by the CEC has extensive comments to tell you what to set; please read them. Note that this template is for the service registration, the applications are configured separately.

Preview the registration document

When you have the environment set, including the entry that leads the URL to your edited copy of the registration template, you should check that the registration documents are coming out satisfactorily. Use the "show registration document" link in the side-bar.

The registration document is what will eventually be sent to the IVO resource registry to identify your CEC and its applications. These documents are public and are read both by human users of your service and by machines. Therefore, they need to be both scientifically useful and technically correct. You need to check them at this stage before going on to registration.

The most important thing to check is the identifier element in the service description. This is the formal name for your service in the registry, and you can't change it once you've registered (changing the name creates a second registration; it doesn't rename the original one). Almost anything else can be patched up by registry updates, but you have to get the identifier right first time. Things to check:

  • Is the authority ID part of the identifier (e.g. the foo.bar in ivo://foo.bar/baz right for the registry where you're publishing? A given registry accepts registrations only under a limited, pre-agreed set of authorities.
  • Is the resource-key part (e.g. the baz in ivo://foo.bar/baz unique within the naming authority?
  • Is the resource key a sensible and memorable name for the service?

Application Configuration

In order for the CEC to have a useful function at least one application needs to be configured - This is covered in detail in the Application Configuration page

In addition to this documentation there are also examples of previous example configurations for a range of applications that can serve as a template for creating a suitable configuration for a new application.

Restart the web application

The CEC web-service needs to be restarted to pick up the changed configuration. This means that you have to restart the whole web-application. Either restart Tomcat itself, or use the Tomcat Manager application to restart the current web-application.

Using the CEC

Once you have restarted the CEC you may start to use it, or in the event of failures try further testing.