Table of Contents
Note
This is the lowest level configuration. In almost all cases, higher level configuration tools exist within Ambience to set all these items. You should use the higher level tools which enforce consistency and the correct type of content. For example some values must contain JSON, others must contain XML, others must contain just plain text. The higher level tools enforce this. The low level editors trust that you know what you are doing. If you make a mistake, you can easily render the system unusable. Therefore use this low-level editing ability with extreme caution.The Configuration tab allows you to configure the domain. The configuration items are displayed as a tree. Click each item and enter its configuration
in the pane on the right.
To add a child item, click the Add Child link and enter the name of the child item. For example, within the admin item on the tree, you can have mail and output
formats as the child items, with each item having its own configuration.
Any number of child items can be added to any of the main items, as per your requirements.
To rename an item, click Rename.
To delete an item, click Delete.
The configuration tree is as follows:
Note
Configuration options are often altered with each releases as new features are exposed. Therefore, the configuration tree you see may not match exactly those seen in the screen shots.Table 2.1. Configuration Tree
| Tree Node | Description |
|---|---|
| admin/user | This holds the credentials of the domain administrator. Use the Domain > admin option from the left panel to add or alter these values. Only the domain administrators are defined here. Regular users are defined in the authentication module. |
| admin/mail/from | Indicates the mail address from which emails are sent. |
| config/ | This holds common configurations that will apply across all Ambience modules.
For example, you can set the uniform formats for date, datepicker, time, timepicker
and timestamp. When a date is displayed by Java, it will use the /config/format/date/
settings. When JavaScript is used, it will use the /config/format/datepicker settings
by default, unless there is a local override. Web-based modules will reflect the
changes immediately, while other modules may show the changes after they are restarted.
Preferably, you can configure these settings in Repertoire > Administration Tools
> System > Configuration. |
| host/ | This lists the hosts that have connected to the Ambience system. |
| job/constraints | Lists the constraints for jobs. Constraints include the time to wait for the job to start and the number of retries, for instance. |
| licence/ | This is where the licence information for the domain is stored. To install a licence, use the Domain > Licence option, which will populate the license. |
| module/ | This is where the additional modules store their configuration data. |
| module/domain-man | This holds Domain Manager configuration. |
| module/eikon | Elixir Ambience AdHoc Dashboard configuration is stored here. |
| module/filetype | The filetype child tree records known file types, and identifies the mime type strings, the icons to use and the actions that can be invoked, for each file type. |
| module/identity | Contains the domain realm. |
| module/jdbc | Holds the JDBC driver configuration for connection to various databases. |
| module/logging | Contains the path where the log files are stored. |
| module/metro | Provides metrics gathering. Used when Elixir Ambience is hosted as a SAAS application. |
| module/queue-map | Stores the configuration of the various queues such as the email queue, the print queue and the job queue. |
| module/repository | Contains the repository paths and file system configuration. Adding a file to the repository causes its properties to be automatically added to the configuration. |
| module/rml | Contains the configuration of the report module. Configuration items include callback and font specifications for PDF output. |
| module/scheduler | Stores the triggers for the scheduled jobs. Creating a scheduled job causes its configuration to be stored here. |
| module/store | Contains the stores that hold the file systems mentioned in the Repository. These stores can either be local file systems, Samba shares, NFS shares, or Amazon S3 stores. |
| module/support | Contains the email of Elixir Support to which logs are to be sent for analysis and resolution. |
| module/universe | Contains the access rights for universes. |
| module/usergroupdb | Stores the configuration of users. Configuration items include password policy and access rights. |
| module/web | Contains the configuration of the web interface. CSS and JS file paths, and the paths for the various theme files are stored here. Adding a CSS, JS or theme file causes the file configuration to be automatically stored under this entry in the tree. |
| process/job-engine | The parameters of the various job engines are stored here. |
| queue | Contains the settings for the queues defined in the queue-map. |
| session | The details of all active sessions within the domain are stored here. |
| shutdown/control | This is used to coordinate shutdown of the entire domain and should not be modified except by the shutdown process. |
| target | Contains the configuration for the output targets such as printers, browsers and email. Configuration items include SMTP servers, mime types and printer names. |
| version | The version tree is where modules record their installation status - which versions of which modules are installed. This enables easy migration as new modules are released. |