Custom Properties

On This Page

This page describes custom properties in a self-managed Appian environment.

What are custom properties?

Custom properties are settings that enable you to customize Appian in your self-managed environment.

You can configure custom properties for your self-managed environment in the .spec.customProperties field of the Appian CR configuration file.

Many custom properties can safely be left at their default settings, but certain properties are required enable Appian in your self-managed environment. Learn more about required configurations.

How to edit custom properties

You edit custom properties by editing the Appian CR configuration file.

Most custom properties can be edited on a running site. However, changes to certain custom properties require that you restart the Application Server (webapp).

Available custom properties

The sections below list the custom properties available for configuration in your Appian environment.

Each custom property consists of the following elements:

Prefix: See the section headings below.
Name: See the Name column in the tables below.
Value: See the Value column in the tables below.

You can construct the full property by combining these elements as follows:

<prefix>.<name>: "<value>"

For example:

conf.mailhandler.mail.smtp.host: "mail.example.com:80"

ads.adb.systemConfig__

Name	Value	Purpose	Default	Webapp Restart?
rts.memory_limit	GB	Specifies limit on the amount of memory available for each real-time store to process real-time queries to the data service.	–	Yes
rts.threads	number	Specifies the number of threads available for each real-time store to process real-time queries to the data service.	`1`	Yes

appian.feature

The properties in the following table allow you to enable certain Appian features.

Name	Value	Purpose	Default	Webapp Restart?
ae.databases-and-search.types-outdated-metrics-log	`true`/`false`	Enables the health check for outdated/incompatible data type references.	`false`	Yes
ae.studio.control-panel	`true`/`false`	Enables the Control Panel in Case Management Studio.	`false`	Yes
ae.studio.control-panel.record-hierarchy-metadata	`true`/`false`	Enables the Control Panel in Case Management Studio.	`false`	Yes
isProcessHistoryInKafkaEnabled	`true`/`false`	Enables archived processes in Process Activity	`false`	Yes

conf.aiplatform

Name	Value	Purpose	Default	Webapp Restart?
autoDisabledModelProviders	`anthropic`	Disables all Anthropic models in your self-managed environment.	–	Yes

conf.appserver

Name	Value	Purpose	Default	Webapp Restart?
maxHeapSize	MB	Specifies the size of the application server heap.	`2048m`	Yes

conf.content

Name	Value	Purpose	Default	Webapp Restart?
download.byId	`true`/`false`	Allows numeric IDs in custom download links.	`false`	Yes
download.inline	`true`/`false`	Enables inline document display.	`false`	Yes

conf.data

Name	Value	Purpose	Default	Webapp Restart?
load.infile.paths	list of paths	Specifies the directories that contain files to be loaded by the `LOAD DATA LOCAL INFILE` command. See also: `mysql.loaddata.enabled`	–	Yes
mysql.loaddata.enabled	`true`/`false`	Enables developers to run the `LOAD DATA LOCAL INFILE` command against a MySQL/MariaDB database from a Query Database smart service. See also: `load.infile.paths`	`false`	Yes
query.memory.limit	bytes	Specifies how much memory a single query can consume before the query is halted.	`5242880`	Yes
query.timeout	seconds	Specifies a timeout limit for external database queries.	`10`	Yes

conf.executeStoredProcedure

Name	Value	Purpose	Default	Webapp Restart?
limits.maxRowsPerResultSet	number of rows	Specifies the number of rows per result set that a stored procedure call returns.	`1000`	Yes
limits.maxTimeout	seconds	Specifies the maximum time a stored procedure call can take before it times out.	`3600`	Yes
limits.maxTotalRows	number of rows	Specifies the default maximum value of the collective number of rows for stored procedures with multiple result sets.	`10000`	Yes
SLOW_PROCEDURE_THRESHOLD_MS	milliseconds	Specifies the threshold at which the system logs slow calls to execute stored procedures in the database.	`15000`	Yes

conf.iam

Name	Value	Purpose	Default	Webapp Restart?
pm.unifiedMiningPmRedirectUri	URI	Enables Appian to connect to the process insights service.	`http://appian-process-insights-janus.<namespace>.svc.cluster.local`	Yes
pm.unifiedMiningPmAudience	Service name	Enables Appian to connect to the process insights service.	`process-mining-janus.us-east-1`	Yes

conf.integrations

Name	Value	Purpose	Default	Webapp Restart?
threadPoolSize	number of threads	Specifies the number of threads in the threadpool that Connected System plug-ins use to execute integration objects.	`30`	Yes

conf.mfa

Name	Value	Purpose	Default	Webapp Restart?
default.enabled	`true`/`false`	Specifies whether multi-factor authentication (MFA) is enabled by default for users in the Appian environment. This default behavior is sometimes referred to as "MFA enforcement". Admin Console settings for MFA are enabled or disabled depending on the setting of this property.	`false`	Yes

Note: Appian recommends enforcing MFA for all users across your self-managed environment to neutralize stolen passwords and defend against common attacks on user accounts.

conf.mailhandler

Name	Value	Purpose	Default	Webapp Restart?
alias	recipient name	Specifies a routing alias	–	No
email.domain	domain	Specifies the domain for the From email address for addresses created via functions and for alert emails when `conf.mailhandler.ntf_sndr_addr` is not set.	your-appian-instance.com	–	No
mail.smtp.auth	`true`/`false`	Enable authentication for the SMTP server that Appian uses to send mail. Use with `mail.user` to Specifies the username for authentication.	`false`	No
mail.smtp.host	IP address, hostname, or fully qualified domain name, and port if not port 25	Specifies the SMTP host of the mail server that Appian uses to send mail.	–	No
mail.smtp.starttls.enable	`true`/`false`	Enables STARTTLS with SMTP.	`false`	No
mail.smtp.starttls.required	`true`/`false`	Requires STARTTLS with SMTP.	`false`	No
mail.transport.protocol	`smtp` or `smtps`	Specifies the protocol the mail server uses to send email.	`smtp`	No
mail.user	username	Specifies a username when providing credentials to connect to the mail server. Use with `mail.smtp.auth`.	–	No
ntf_sndr_addr	email address	Sets a default notification email.	`conf.mailhandler.email.domain` value	No

conf.mailhandler.poller.EmailHandlerBean

The properties in the following table allow you to configure Appian to poll an email server.

Name	Value	Default	Webapp Restart?
debug	`true`/`false`	`false`	No
forceImapLogin	`true`/`false`	`false`	No
mailFolder	The folder from which new messages should be read.	`INBOX`	No
mailServer	Hostname, IP address, or fully qualified domain name	–	No
partialFetch	`true`/`false`	`false`	No
pollingInterval	milliseconds	`300000`	No
port	port number	`143`	No
starttls	`true`/`false`	`true`	No
storeProtocol	lowercase protocol (pop3, imap, or imaps)	`imap`	No
userName	username	–	No

conf.monitoring

Name	Value	Purpose	Default	Webapp Restart?
rdbms.SLOW_QUERY_THRESHOLD_MS	milliseconds	Specifies the threshold criteria for what the system logs as a slow query.	`3000`	Yes

conf.node.webservice

See Web service connections.

conf.notifications

Name	Value	Purpose	Default	Webapp Restart?
MAX_RECIPIENTS	number	Specifies the maximum number of notification recipients.	`100`	Yes

conf.plugins

Name	Value	Purpose	Default	Webapp Restart?
poll-interval	seconds	Specifies the interval at which Appian reads changes to the Plug-ins directory.	–	Yes

conf.suite

Name	Value	Purpose	Webapp Restart?
ANONYMOUS_ACCESS	`true`/`false`	Enables anonymous user access to the Appian environment.	Yes
bookstrapCalendar	calendar code	Configures the default language and timezone for the Appian environment	Yes
bootstrapLocale	locale code	Configures the default language and timezone for the Appian environment	Yes
bootstrapTimeZone	time zone name	Configures the default language and timezone for the Appian environment	Yes
DISABLE_STRICT_DOMAIN_SECURITY	`true`/`false`	Disables strict domain security to allow a non-standard top-level domain in static and content URLs.	Yes
MAIL_APPLICATION_CONTEXT	URL context	Specifies an alternate email body source for emails Appian sends	Yes
MAIL_SCHEME	URL scheme	Specifies an alternate email body source for emails Appian sends	Yes
MAIL_SERVER_AND_PORT	fully-qualified domain name and port	Specifies an alternate email body source for emails Appian sends	Yes
USER_ACCOUNT_LIMIT	number of users	Sets the user account limit.	Yes

conf.task

Name	Value	Purpose	Default	Webapp Restart?
accessibleById	`true`/`false`	Allows numeric IDs in custom links, instead of opaque URLs.	`false`	No

conf.timezones.locales

Name	Value	Purpose	Webapp Restart?
	list of time zones	Overrides the default list of time zones.	Yes

kfk

Name	Value	Purpose	Default	Webapp Restart?
trunc.buffer.seconds	seconds	Specifies how long transactions in the data service persist.	`3600`	Yes

resources.appian.ag.constants

Name	Value	Purpose	Default	Webapp Restart?
ag.fn.maxsize	characters	Specifies the maximum length of a user's first name.	`35`	No
ag.ln.maxsize	characters	Specifies the maximum length of a user's last name.	`35`	No
ag.mn.maxsize	characters	Specifies the maximum length of a user's middle name.	`35`	No

resources.appian.analytics.application

Name	Value	Purpose	Default	Webapp Restart?
resources.appian.analytics.application.maxreportrows	calculated maximum	Specifies the maximum number of items that can be loaded into application server memory when processing a report.	`30000`	Yes

resources.appian.ap.application

Name	Value	Purpose	Default	Webapp Restart?
appian.ap.appianName	text	Specifies the copyright holder listed in the application footer.	`Appian Corporation`	No
appian.ap.copyrightYear	text	Specifies the span of years for copyright listed in the Appian footer.	–	No

resources.appian.process.email-expressions

The properties in the following table allow you to configure the From field for emails from processes and process models.

Name	Value	Webapp Restart?
email.domain	your-appian-instance.com	No
email.prefix.process	`process`	No
email.prefix.processmodel	`processmodel`	No

server.conf

Name	Value	Purpose	Default	Webapp Restart?
exec.AUTOARCHIVE_DELAY	days	Specifies the auto-archive interval.	`7`	No
exec.CHAINED_EXECUTION_NODE_LIMIT	node instances	Specifies the max number of nodes that can be unattended during activity-chaining.	`50`	No
MAX_ADDRESSES_PER_EMAIL	number	Specifies the maximum number of recipients for a notification.	`100`	No
notifications.default_ntf_ttl	days	Specifies how long the system keeps notifications before automatic deletion.	`10`	No

server.conf.processcommon

Name	Value	Purpose	Default	Webapp Restart?
MAX_EXEC_ENGINE_LOAD_METRIC	calculated metric	Specify the load metric limit.	`120`	No
MAX_NODE_INSTANCES	number	Specifies the total number of times that the same activity can be launched within a process.	`1000`	No
MAX_REPEATS	number	Specifies repeat function limits.	`50000`	No
MAXIMUM_REPORT_MS	milliseconds	Specifies how long a process engine server can take to process and return report data.	`2000`	No
NOTES_SRC_DIR	directory	Specifies the directory that stores process notes.	`<APPIAN_HOME>/_admin/process_notes/`	No

servicemanager.topology

Name	Value	Purpose	Default	Webapp Restart?
mirrorMetricsPort	port number	Specifies the port used by the optional MirrorMaker tool for Kafka.	–	Yes

Feedback

Was this page helpful?