Configuration

Files in the ~imu/config directory may be named as:

• common
• client
• local

and with a .php and / or .js suffix.

Common configuration files

Files that hold common IMu configuration values used across multiple customers will be in files named common. Typically, these will be standard default values to use (unless told otherwise). Axiell provides these files and they should not be changed by customers.

Warning

If customers do change values here, the changes will be overwritten by the system if the system is upgraded and thus will be lost.

Client configuration files

Files that hold customer specific configuration values are named client. Any values here will override similar values specified in common files. Examples may be what customer specific catalogue fields to use when displaying data. Axiell provides these files and they should not be changed directly by customers.

Warning

If customers do change values here, the changes will be overwritten by the system if the system is upgraded and thus will be lost.

Local configuration files

Files that are specific to this particular installation are named local. They override any similar values s specified in either the common or client files. Examples of settings here include the actual host and port connection values needed to access the database server from the web server.

Note: Axiell does NOT maintain any local files. This is where customers should make any local changes. Any changes made by a customer here will not be modified during an IMu upgrade.

To install a system you normally only need to add a local.php file to this directory. The common and client files should already be appropriately set up after the installation.

Database connection is normally the main thing that needs to be configured.

You should specify the hostname of the server that runs the IMu Server (typically but not necessarily this will be the EMu server). You should also specify the port number of the IMu server.

This is done by adding a local.php file in the imu/config directory.

An example would be:

<?php
   $config['server-host'] = 'manly.syd.kesoftware.com';
   $config['server-port'] = 40193;
?>

Below are examples of some local settings that you may encounter. Normally these would be set in the client file however there may be circumstances where a site may choose to override or add to the client settings.

To add (or restrict) the modules searched by default in Search objects:

// add a module to the list
$config['include-modules'][] = 'etrapevents';

// restrict the modules to search to the given list
$config['include-modules'] = [ 'ecatalogue', 'eparties' ];

To set the standard set of fields searched by a search object:

$config['search-aliases']['keywords']['ecatalogue'] = array
(
  'SumDescription',
  'SumTitle',
);

To set the fields returned by a search:

$config['fetch-sets']['lightbox']['etaxonomy'] = array
(
   'irn',
   'title=ClaScientificName',
   'SummaryData',
   'image'
);