Appian uses .properties
and .xml
files to set or modify standard configuration settings. This page describes how to set custom parameters in these files so that your customizations are retained whenever Appian is updated.
Most system settings can be centrally managed by configuring a single properties file called custom.properties
located at <APPIAN_HOME>/conf/
. In multiple server environments, the contents of this file must be identical on all Appian servers.
custom.properties
file you create is not overwritten when an upgrade occurs.A custom.properties.example
file is installed in the same directory to provide you with general examples. Be sure you are familiar with each setting in the example file before implementing its settings.
Most properties can safely be left at their default settings. For any properties that must be set for the system to work correctly, see also: Required Configurations.
Once the custom.properties file is created and Appian is running, some properties can be read dynamically while others require the application server to restart.
The table below lists the various property prefixes and whether or not changes to them require the Application Server to be restarted to have the changes take effect.
Property Prefix | Application Server Restart Needed |
---|---|
conf.forms.* | No |
conf.mailhandler.* | No |
conf.node.webservice.* | No |
conf.security.* | No |
resources.appian.ag.application.* | No |
resources.appian.ag.constants.* | No |
resources.appian.applications.applications.* | No |
resources.appian.km.file_icons.* | No |
resources.appian.process.email-expressions.* | No |
server.conf.* | No |
All other prefixes | Yes |
The filenames, locations, and content of log files can be configured using appian_log4j.properties
file.
See also: Modifying Log Output
Appian allows you to manage server configurations using a custom topology file. An example file named appian-topology.xml.example
is included in the following location:
<APPIAN_HOME>/conf/
Common uses for a custom topology configuration file include:
To set XML file properties, you need to create a custom version of each modified property file. The benefit of having a custom version is that it does not need to be merged on each upgrade of Appian.
The tables in this section list Appian XML files supported for customization and configuration and provide the following information:
To partially override the XML files listed in this section, complete the following:
jms-topics.xml
, create a file named jms-topics-custom.xml
.For example, you could add the following elements and attributes:
<topics>
<topic name="CustomQueueOrTopic"> CustomValue </topic>
</topics>
When customizing the XML files in the table below, the following rules apply:
XML File | Custom XML File Name Pattern | Required Elements and Attributes |
---|---|---|
/WEB-INF/conf/process/priority-config-process.xml |
/WEB-INF/conf/process/priority-config-process-*.xml |
/priority-config/priorities/priority id= |
/WEB-INF/conf/process/rdbms/driver-config.xml |
/WEB-INF/conf/process/rdbms-driver-config-*.xml |
/drivers/driver |
/WEB-INF/conf/process/message-types.xml |
/WEB-INF/conf/process/message-types-*.xml |
/messageTypes/messageType id= |
/WEB-INF/conf/process/jms-topics.xml |
/WEB-INF/conf/process/jms-topics-*.xml |
/topics/topic name= |
The following rules apply when customizing the locale-config.xml
:
XML File | Custom XML File Name Pattern | Required Element or Attribute |
---|---|---|
/WEB-INF/conf/locale-config.xml |
/WEB-INF/conf/ - /locale-config*.xml |
/locales (<locale-code>) |
Generally, configuration settings cannot be deleted. Cache settings can be disabled by adding an override XML file.
To do so, complete the following:
/cache-configurations/cache-configuration@key
enabled='false'
/palette-categories/palette-category@name
/palette-categories/palette-category@name/palette@name
/palette-categories/palette-category@name/palette@name/item@name
<tt>enabled='false'</tt>
For example, to disable the Palette with the <tt><name>Events</name></tt>
, add a file named palette-config-disable-events.xml
with the following content:
1
2
3
4
5
6
7
8
9
<palette-categories xmlns:xsi="<a href="http://www.w3.org/2001/XMLSchema-instance" class="external free" title="http://www.w3.org/2001/XMLSchema-instance" rel="nofollow">http://www.w3.org/2001/XMLSchema-instance</a>" xsi:noNamespaceSchemaLocation="/process/conf/xmlvalidation/palette.xsd">
<palette-category name="Standard Nodes">
<palettes>
<palette enabled="false">
<name>Events</name>
</palette>
</palettes>
</palette-category>
</palette-categories>
On This Page