imported>Jason.nicholls: 1 revision

2014-07-10T05:08:59Z

1 revision

← Older revision	Revision as of 05:08, 10 July 2014
(No difference)

imported>Mylene.stolpe at 01:24, 7 February 2014

2014-02-07T01:24:54Z

New page

[[Category:enPortal 5.5]]
{{DISPLAYTITLE:Configuration Files}}

enPortal provides various files to assist with configuring many aspects of the system to the needs of a specific deployment. This article details the various configuration files that are provided.

__TOC__

== Configuration Files Location ==

enPortal maintains configuration files primarily in the following directory:
: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config</tt>

== Configuration Files Description ==

The following table summarizes each configuration file and the information it provides:

{| class="wikitable" border="1" style="background-color:#eeeeee;
|+ align="bottom"|''enPortal Configuration Files''
|-
!Configuration File
!Description
|-
| activation.properties
| Contains information used to start the enPortal processes.
|-
| appboard.properties
| Master configuration file containing various AppBoard system configurations.
|-
| appboard-shim.properties
| Defines the default SHIM nodes that are defined in AppBoard.
|-
| config.properties
| Master configuration file containing various enPortal system configurations as well as the various include tags for many of the other configuration (.properties) files.
|-
| crs.properties
| Content Retrieval Service (CRS) configuration settings.
|-
| crs-handlermap.properties
| Maps CRS processes to the associated class files. This file should not typically be modified.
|-
| crs-shim.properties
| Defines the default SHIM nodes that are defined in enPortal.
|-
| crs-subs.properties
| Maps CRS substitutions to the associated class files. This file should not typically be modified.
|-
| crs-xml.properties
| Maps CRS XML nodes to the associated class files. This file should not typically be modified.
|-
| custom.properties
| Recommended location for overriding the defaults specified in many of the configuration files detailed in this matrix, including <tt>config.properties</tt>, <tt>export.properties</tt>, and <tt>activation.properties</tt>
|-
| export.properties
| Export properties files configure the use of the FilesExport command to preserve customization files during a portal system upgrade.
The default export properties file is included in the base enPortal installation as <tt>export.properties</tt>.
This includes commands for preserving all of the custom directories and files.
This file defines categories and subcategories of files that are combined to form useful “file sets” that can be exported by the FilesExport process to a JAR file.
|-
| export-appboard.properties
| An extension of <tt>export.properties</tt>, which details the additional files to be included for preserving AppBoard content.
|-
| hosts.properties
(enPortal 4.x only)
| Used for storing the host and port information of enPortal's internal Portal Server and JSP Server.
In custom installations where a separate Apache Web Server is used, this file also configures the port setting for accessing that Web Server.
This file should be modified directly, or by using the Host Configuration GUI (if generating a redundant system configuration file).
Settings in <tt>custom.properties</tt> will not override settings in this file.
|-
| license.properties
| License file enabling the system to run.
|-
| local.properties
(enPortal 4.x only)
| Used for storing the location of certain external applications, such as the JDK, that are referenced by enPortal.
This file should be modified directly, or by using the <tt>portal setup</tt> command line utility.
Settings in <tt>custom.properties</tt> will not override settings in this file.
|-
| logger-crs.properties
| Configures the various logs that are generated by the CRS process. Configures filters (severity based) of the log messages being generated.
Defines what events should be logged and the location to which the information is saved.
Any modifications should be made in the <tt>logger-crs-custom.properties</tt> file.
|-
| logger-crs-custom.properties
| Overrides the default settings specified in <tt>logger-crs-custom.properties</tt>. 
|-
| logger-crs-old.properties
| This file is no longer used.
|-
| logger-def.properties
| Stores the various base system logger definitions. This file should not typically be modified.
|-
| logger-portal.properties
| Configures the various logs that are generated by the enPortal processes. Configures filters (severity based) of the log messages being generated.
Defines what events should be logged and the location to which the information is saved.
Any modifications should be made in the <tt>logger-portal-custom.properties</tt> file.
Should only be edited for enPortal 4.x versions. For AppBoard and later enPortal versions, see [[enportal/5.5/admin/system_administration/Log_Files|Log Files]]
|-
| logger-portal-custom.properties
| Overrides the default settings specified in <tt>logger-portal.properties</tt>
|-
| persist.properties
| Used for turning database persistence on or off, and for configuring the connection string to a database for storing enPortal/AppBoard component and user definitions.
This file should be modified directly, or by using the database configuration utility (<tt>portal dbsetup</tt> command line utility).
Settings in <tt>custom.properties</tt> will not override settings in this file.
|-
| tables.txt
| A list of tables used for populating the H2 database that is used by default for storing information about enPortal/AppBoard users and components.
This file should not typically be modified.
|-
| vendor.properties
| Modifications to this file are prohibited
|-
| xmlupgrade.properties
| Information used by the system during an upgrade to ensure that system components are migrated properly.
This file should not typically be modified.
|}

== Configuration Files Customization==

Some of the enPortal configuration files can be customized. Perform the following steps to customize an item in one of the configuration files.

# Open the file <tt>custom.properties</tt> in a text editor. (Create the file if it does not already exist).
# Enter the modified setting, along with a comment detailing the item. Example:
#: <tt><nowiki>#</nowiki>Change automated session timeout to 10 minutes</tt>
#: <tt>session.defaultSeconds=600</tt>
# Save the file.
# Re-start the system.

The above steps place the modification in the file <tt>custom.properties</tt>, rather than directly modifying the original configuration file.
This approach is recommended, so that any customizations will be preserved.
To reduce the number of merge files during an upgrade, you should generally avoid making direct customizations to system files unless absolutely necessary.
For example, to avoid creating a merge file in <tt>PORTAL_HOME/config/export.properties</tt>, you must enter your changes into the merge free file <tt>PORTAL_HOME/config/custom.properties</tt>. If placing a customization in custom.properties does not show the intended effect, you may need to make that change directly to the raw configuration file.

Enportal/5.5/admin/system administration/Configuration Files - Revision history

imported>Jason.nicholls: 1 revision

imported>Mylene.stolpe at 01:24, 7 February 2014