General
Some of the default values for settings configurable on the General tab should not be changed. If you are unsure what the value for a specific setting should be, contact your GX Software consultant. In a multi-channel configuration, each channel has its own configuration set with the name <configuration_set_name> (name) where "name" is the ID of the channel.
In This Topic
application_settings
Property | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
add_csrf_token_header_to_external_responses | This setting was introduced in XperienCentral version R33. When enabled, an X-CSRF-Token header is included in the response to GET requests from external domains, which must be used in a subsequent POST or PUT request. The | ||||||||||||||||||||||||||||||||||||||||
authorization_lockout_ip_whitelist | A list of IP's that can not be locked out of XperienCentral's Edit environment. Enter a valid IPv4 or IPv6 address. | ||||||||||||||||||||||||||||||||||||||||
channels_using_fallback | Specifies the channel(s) that use the default design configuration when no custom JSP can be found for it. | ||||||||||||||||||||||||||||||||||||||||
check_url_signature | If this option is turned on, URL's containing a presentation ID and/or an SSI object ID are suffixed with a sign parameter when they are rendered, which contains a hash of the parameters in the URL. When the URL is called, the value of the sign parameter is checked versus a newly calculated hash based on that URL. If the value of the sign parameter does not match that of the newly calculated hash, that means that the URL has been tampered with and the request will be refused. | ||||||||||||||||||||||||||||||||||||||||
clusternode_eventlistener_heartbeat_ms | This setting was introduced in XperienCentral version 10.22.1. Specifies how often, in milliseconds, the cluster event service listens for events on other servers in the cluster. | ||||||||||||||||||||||||||||||||||||||||
clusternode_registration_heartbeat_ms | This setting was introduced in XperienCentral version 10.22.1. Specifies how often, in milliseconds, the cluster event service checks for multiple active sessions for the same XperienCentral user. See Active Sessions for more information, | ||||||||||||||||||||||||||||||||||||||||
company_name | This setting was introduced in XperienCentral version R42. This setting allows you to add your company name (or another string) to the XperienCentral Login page. See Customizing the Login Page for complete information. | ||||||||||||||||||||||||||||||||||||||||
contentindex_index_readonly_nodes | This setting was introduced in XperienCentral version R37. If the Search & Retrieve API is used on a clustered environment, this setting should be enabled, otherwise the API will not return any results. When this setting is enabled, the content index must be rebuilt. | ||||||||||||||||||||||||||||||||||||||||
content_item_lock_poll_interval | A content locking poll thread that checks whether a content item lock is expired. If so, the lock is removed. The value is in milliseconds. | ||||||||||||||||||||||||||||||||||||||||
content_item_lock_timeout | Specifies the number of milliseconds that have to elapse after a lock on a content item has been claimed before the lock is closed. | ||||||||||||||||||||||||||||||||||||||||
contentindex_location | The directory where the content index and its configuration are stored. | ||||||||||||||||||||||||||||||||||||||||
contentindex_optimize_schedule | The Crontab schedule that dictates when the content index is optimized. This should be set to happen at least once a day, preferably at the time that website activity is at its lowest (typically at night).The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
contentindex_queue_database_entries_schedule | The Crontab schedule that dictates when to put database entities in the queue for the search indexing. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
contentindex_queue_empty_reindex | Specifies whether to disable the regeneration of the full background index when the queue is empty. Because a full index regeneration is performed regularly according to the contentindex_queue_reindex_schedule , you might want to block a full index generation at other times for performance reasons. | ||||||||||||||||||||||||||||||||||||||||
contentindex_queue_iteration_limit | The maximum batch size for each poller iteration. The default is 100. The larger the number, the greater the impact is on performance. | ||||||||||||||||||||||||||||||||||||||||
contentindex_queue_janitor_schedule | The Crontab schedule that dictates when the index journal is cleaned up. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
contentindex_queue_poller_schedule | The Crontab schedule that dictates when the index journal is polled for changes. The more frequently this is performed, the more up to date the index will be. Note that each cycle must be able to finish before the next begins. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
contentindex_queue_reindex_schedule | The Crontab schedule that dictates the triggering of a full background index. This should happen no more then once a day, preferably at the time that website activity is at its lowest (typically at night). The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
context_static | This setting was removed from XperienCentral in version R36. Use the setting The root URL of the static web application. In XperienCentral versions R36 and higher, use the setting | ||||||||||||||||||||||||||||||||||||||||
| This setting was introduced in XperienCentral version R29. Specifies whether XperienCentral automatically creates revisions of content items. See Reverting a Content Item for more information. See also the settings | ||||||||||||||||||||||||||||||||||||||||
| This setting was introduced in XperienCentral version R33.1. Specifies the URL paths that are not checked for CSRF vulnerabilities. Define the excluded URLs using a Regular Expressions that matches the URL path, excluding the context path. For example, to disable the protection for all requests to "myservlet" (https://mydomain.com/web/myservlet/foo/bar?q=xxx), add an expression like the following:
Exempting URLs from the CSRF checks weakens the security of your channel(s), therefore you should exercise caution with this setting. | ||||||||||||||||||||||||||||||||||||||||
current_rollover_detector_schedule | The Crontab schedule that dictates when the rollover detector service runs. The detector service detects changes in the outcome of ContentItem.getCurrent(Language) and if any is detected, it updates the caching timestamps and friendly URLs. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
date_format | The format in which dates are represented (for example, dd-MM-yyyy). | ||||||||||||||||||||||||||||||||||||||||
default_timezone | Specify the default time zone for the XperienCentral installation. The time zone you specify is the absolute time upon which all timestamps in XperienCentral are based (creation date, publication date, expiration date, etc.). When users select their own time zone in My Settings, the time zone they select is calculated as an offset based on the default XperienCentral time zone. The following are the most commonly used time zones. For the full list of acceptable time zones, see http://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
| ||||||||||||||||||||||||||||||||||||||||
disable_unused_content_schedule | Schedule in cron format for the disable unused content job. The Crontab schedule for disabling unused content. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning.For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
enable_non_jndi_database_configuration | Select this option if you are using a non-JNDI database for your XperienCentral project. | ||||||||||||||||||||||||||||||||||||||||
form_handler_base | Specifies the URL where the definitions for Interactive Forms are located. | ||||||||||||||||||||||||||||||||||||||||
google_sitemap_automatic_upload | This setting was introduced in XperienCentral version R33. Specifies whether XperienCentral automatically uploads generated sitemaps to Google. When enabled, if a Google sitemap is generated, it is automatically uploaded according to the schedule configured in the setting | ||||||||||||||||||||||||||||||||||||||||
google_sitemap_generator_schedule | The Crontab schedule that dictates when the Google sitemap will be generated. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
http_non_proxy_hosts | Specifies the hosts that should be directly contacted for requests via HTTP and HTTPS (not through the proxy server). You can enter multiple host names separated by the pipe character (|) and also use wildcards. For example: Notes
| ||||||||||||||||||||||||||||||||||||||||
http_proxy_host | The name of the HTTP proxy host server to use to send requests to the XperienCentral server. | ||||||||||||||||||||||||||||||||||||||||
http_proxy_password | The password to use to log in to the proxy host via HTTP. If no password is required, leave this field blank. | ||||||||||||||||||||||||||||||||||||||||
http_proxy_port | The port number to connect to on the HTTP proxy host. | ||||||||||||||||||||||||||||||||||||||||
http_proxy_username | The username to use on the HTTP proxy host. | ||||||||||||||||||||||||||||||||||||||||
http_use_proxy | Specifies whether to use one or more proxy servers to log in to the XperienCentral server. Beginning in XperienCentral R26, proxy system properties set outside of XperienCentral are no longer overwritten when this setting is clear (false). | ||||||||||||||||||||||||||||||||||||||||
https_proxy_host | This setting was introduced in XperienCentral version R26. The name of the HTTPS proxy host server to use to send requests to the XperienCentral server. | ||||||||||||||||||||||||||||||||||||||||
https_proxy_password | This setting was introduced in XperienCentral version R26. The password to use to log in to the proxy host via HTTPS. If no password is required, leave this field blank. | ||||||||||||||||||||||||||||||||||||||||
https_proxy_port | This setting was introduced in XperienCentral version R26. The port number to connect to on the HTTPS proxy host. | ||||||||||||||||||||||||||||||||||||||||
https_proxy_username | This setting was introduced in XperienCentral version R26. The username to use on the HTTPS proxy host. | ||||||||||||||||||||||||||||||||||||||||
https_use_http_page_links | This setting was introduced in XperienCentral version R26. When this setting is enabled, a visitor will use HTTP to link to a page even if the Use HTTPS setting for that page is enabled. | ||||||||||||||||||||||||||||||||||||||||
https_use_proxy | This setting was introduced in XperienCentral version R26. Specifies whether to use one or more proxy servers to log in to the XperienCentral server. Proxy system properties set outside of XperienCentral are not overwritten when this setting is clear (false). | ||||||||||||||||||||||||||||||||||||||||
internal_backend_address | For use with IBM WebSphere. Contact your GX Software consultant for more information. | ||||||||||||||||||||||||||||||||||||||||
internal_frontend_address | For use with IBM WebSphere. Contact your GX Software consultant for more information. | ||||||||||||||||||||||||||||||||||||||||
internal_http_authentication_password | The password to use in conjunction with the username (below) for connections XperienCentral makes with itself through the front- or backend. | ||||||||||||||||||||||||||||||||||||||||
internal_http_authentication_username | The username to use for connections XperienCentral makes with itself through the front or backend. | ||||||||||||||||||||||||||||||||||||||||
internal_http_use_authentication | Specifies whether to use a username/password combination for authenticating connections that XperienCentral makes with itself through the front or backend. | ||||||||||||||||||||||||||||||||||||||||
internal_http_use_form_authentication | Specifies whether internal HTTP connections use HTTP form | ||||||||||||||||||||||||||||||||||||||||
internal_http_use_form_authentication_session_expiration | The configuration entry for the expiration of the session cookie used for HTTP form authentication | ||||||||||||||||||||||||||||||||||||||||
jcr_datastore_cleaner_schedule | The Crontab schedule that dictates when the JCR datastore cleaner runs. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. Beginning in version R28, XperienCentral no longer uses the Apache Jackrabbit JCR indexing solution by default. This setting is only relevant to users of XperienCentral versions R27 and lower. See the XperienCentral upgrades notes for version R28 for more information. | ||||||||||||||||||||||||||||||||||||||||
languagelabels_cache_size | This setting determines the maximum size of the language label cache. Ideally the maximum size should be equal or slightly higher than the number of language labels across all channels. The default is 10000. | ||||||||||||||||||||||||||||||||||||||||
limboelement_cleanup_schedule | The Crontab schedule that dictates when limbo elements are cleaned up. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
limboelement_expiration_interval | The Crontab schedule that dictates when limbo elements expire and are deleted. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. | ||||||||||||||||||||||||||||||||||||||||
password_banned_words | Specifies the string(s) that may not be used as passwords. To add a new value, enter the string in the text field and click [Add value]. | ||||||||||||||||||||||||||||||||||||||||
password_min_distance | Password minimum distance. Specifies the extent to which a string to be used as a password must differ from any of the banned passwords. Take the following example: the string "Administrator" is banned as a password. If the minimum distance is 2, then the allowed strings to be used as a password must differ in at least two ways from "Administrator". The password "Administrat0r" (using a zero "0" instead of an "o") is unacceptable because it differs in only one way from "Administrator". | ||||||||||||||||||||||||||||||||||||||||
password_min_entropy | Specifies how complicated a password must be. The allowed values are between 50 and 100, 100 being the most strict setting. | ||||||||||||||||||||||||||||||||||||||||
profiler_entry_children_limit | Specifies the limit of child entries for a profiler. | ||||||||||||||||||||||||||||||||||||||||
render_threads | Specifies the number of parallel threads to use when rendering content on the website front-end. If the content on your website does not change at a high rate, it is recommended that you do not set this value too high. | ||||||||||||||||||||||||||||||||||||||||
render_threads_incontext | Specifies the number of parallel threads to use when rendering content on the website backend. Using multiple threads can significantly increase the performance of rendering content in the Editor. | ||||||||||||||||||||||||||||||||||||||||
| This setting was introduced in XperienCentral version R36. Specifies one or more context paths that are reserved in XperienceCentral. Reserving a context path is necessary if a website's friendly URLs have no extension and one or more external applications are running on the same host as XperienCentral and you want to avoid a friendly URL being created that matches the internal path of an external application. Enter a context path (without slashes) in the field and click [Add value]. If you run XperienCentral without friendly URL extensions, add the following values:
See also Running XperienCentral without a Friendly URL Extension. | ||||||||||||||||||||||||||||||||||||||||
secret_key | The key used to sign configuration. | ||||||||||||||||||||||||||||||||||||||||
secure_rest_against_csrf | Specifies whether XperienCentral protects against CSRF attacks on its REST API. This setting should always be on (selected). | ||||||||||||||||||||||||||||||||||||||||
session_tracking_cookie_name | The name of the cookie used for tracking XperienCentral user sessions. | ||||||||||||||||||||||||||||||||||||||||
smtp_host | The host name of the SMTP-server. | ||||||||||||||||||||||||||||||||||||||||
smtp_start_tls | Specifies whether TLS should be used when XperienCentral sends emails. | ||||||||||||||||||||||||||||||||||||||||
stale_cluster_lock_retry_time | The amount of time, in seconds, that indicates that a lock that a server in a clustered environment has for a particular item is no longer valid. | ||||||||||||||||||||||||||||||||||||||||
static_files_url | The URL where static files from plugins are stored. In XperienCentral versions R36 and higher, this setting is used instead of the old setting application_settings.context_static . The value can be either a relative or an absolute path. This is especially useful to configure a CDN URL to serve the statics from. | ||||||||||||||||||||||||||||||||||||||||
statistics_cycle_duration | Specifies the number of milliseconds into the past that the XperienCentral performance statistics are saved. The minimum value is 10000. The default is 7200000 (2 hours). GX Software advises that you do not set the cycle duration to a value lower than the default value. Setting this property to a high value, such as 6 hours or more, will naturally have an effect on how long the page takes to load. The statistics can be viewed by navigating to the Statistics Administrative Page. | ||||||||||||||||||||||||||||||||||||||||
streaming_file_directory | The folder where streaming files are stored. | ||||||||||||||||||||||||||||||||||||||||
strict_servlet_api | Specifies whether to use the content-type header set by the first included JSP for the entire request. | ||||||||||||||||||||||||||||||||||||||||
url_cache_clean | Specifies the age (in milliseconds) that items can become before they are deleted from the cache. | ||||||||||||||||||||||||||||||||||||||||
url_cache_timeout | Specifies the amount of time (in milliseconds) between cache cleanups. | ||||||||||||||||||||||||||||||||||||||||
url_encoding | The encoding to use for encoding URLs, "UTF-8" for example. | ||||||||||||||||||||||||||||||||||||||||
urlsign_key | The key used to sign URLs. | ||||||||||||||||||||||||||||||||||||||||
weblogging_logfile_location | The location of the web logging log file. | ||||||||||||||||||||||||||||||||||||||||
xss_allowlist_siteworks_expressions | This setting was introduced in XperienCentral version R29.3. /wiki/spaces/PD/pages/24707222 (login required). | ||||||||||||||||||||||||||||||||||||||||
xss_allowlist_siteworks_qs_parameters | This setting was introduced in XperienCentral version R29.3. /wiki/spaces/PD/pages/24707222 (login required). |
backend_system_settings
Property | Description |
---|---|
frontendxssfilter_class_parameters | This setting was introduced in XperienCentral version R29.3. Specifies the parameter(s) that cause a request to be blocked if they do not conform to a valid Java class name. /wiki/spaces/PD/pages/24707222 (login required). |
frontendxssfilter_integer_parameters | This setting was introduced in XperienCentral version R29.3. Specifies the parameter(s) that cause a request to be blocked if they do not contain a valid integer. /wiki/spaces/PD/pages/24707222 (login required). |
frontendxssfilter_uuid_parameters | This setting was introduced in XperienCentral version R29.3. Specifies the parameter(s) that cause a request to be blocked if they do not contain a valid UUID. /wiki/spaces/PD/pages/24707222 (login required). |
ignore_backend_cookies | Specifies whether to ignore cookies relayed by a front-end proxy to the backend server. |
max_char | Specifies the code of the highest ASCII character that XperienCentral will output. The default is "127" (all standard ASCII characters). |
max_includes_depth | Specifies the maximum number of includes allowed in a config. |
max_includes_per_request | Specifies the maximum number of includes that are allowed during a single request. |
max_recursion_depth | Specifies the maximum depth of includes recursion. |
ntlm_auth_domain_controller | Specifies the IP address of the NTLM authentication server. |
ntlm_auth_enabled | Enables/disables NTLM authorization. |
ntlm_auth_ignore_hosts | Specifies the names of the hosts from which requests will be ignored. Separate multiple host names using a comma (,). |
ntlm_auth_ignore_user_agents | Specifies the user agents that will be ignored. |
package_image_url | Specifies the location where XperienCentral menu-related images are stored. |
presentation_jsps_url | The relative URL of the XperienCentral design config JSPs. In XperienCentral versions R43 and higher, you must add the location /WEB-INF/project/nl.gx.product.wmpbasepresentation for all projects. |
replicate_uploads_on_readonly | Specifies whether to replicate uploaded files on read-only servers in a cluster. |
static_files_location | Specifies the directory where static files are stored (relative to the XperienCentral installation). |
user_profiles_export_max | Specifies the maximum number of user profiles that can be exported in one export file. |
xssfilter_get_ignore_parameters | This setting was introduced in XperienCentral version R29.3. Specifies the parameters that are checked for forbidden characters in GET requests. Add the parameters to check in a comma-separated list. The forbidden characters are |
xssfilter_post_check_urls_for_parameters | This setting was introduced in XperienCentral version R29.3. Specifies the URL expressions to block. /wiki/spaces/PD/pages/24707222 (login required). |
xssfilter_post_ignore_urls_for_parameters | This setting was introduced in XperienCentral version R29.3. Specifies the URLs that are ignored in POST requests. The default ignored URLs (for Layout editing and Persona editing) are:
/wiki/spaces/PD/pages/24707222 (login required). |
xssfilter_url_check_ignore | This setting was introduced in XperienCentral version R29.3. Specifies the trusted URLs. This filter blocks a request if the request URI (the URL path) contains the characters |
connector
Property | Description |
---|---|
ajaxrefreshrate | Specifies, in milliseconds, how often to refresh the Ajax progress bar. Setting this to a lower setting may cause lock contention in the JCR and thereby reduce performance for jobs that write intensively to the JCR. |
log_retention_days | Specifies the number of days that logs will be retained. |
logdir | Specifies the local directory where the log history files are written. |
maxlogentries | Specifies the maximum number of log entries to keep. Once the limit is reached, the first log entries will be overwritten and eventually all entries will be overwritten in looping fashion. |
retentionjob_crontabschedule | The Crontab schedule that dictates when the retained logs will be deleted. All logs older than the number of days specified by log_retention_days (above) will deleted according to the defined schedule. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. |
username | Select the system user account from the list that will execute the job(s). For more information, see System User. |
version | Specifies the version of the Connector API plugin. |
website | Specifies the internal ID of the website on which the Connector API is running. |
corsfilter
Property | Description |
---|---|
allowed_http_headers | Specifies which HTTP headers are allowed. |
allowed_http_methods | Specifies which HTTP methods are allowed. |
allowed_origins | Specifies which origin(s) are allowed in an HTTP request. |
exposed_headers | Specifies which response headers should be made available to scripts running in the browser in response to a cross-origin request. |
preflight_max_age | Specifies how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached. |
support_credentials | Specifies whether credentials can be used by the filter. |
development_settings
Property | Description |
---|---|
enable_debug_messages | Specifies whether to log debug information. |
enable_view_resolve_cache | Specifies whether to cache the views of the Workspace. Caching the views improves performance. |
file_distribution_settings
Property | Description |
---|---|
max_file_size_mb | Specifies the maximum allowed size of a static file, in megabytes for files added to an XperienCentral deployment (Download element, etc.). |
forms_config_set
Property | Description |
---|---|
forms_exportimport_dir | Specifies the directory used by the /wiki/spaces/GXW/pages/25020132component to store temporary import and export files. |
formsengine_config_set
formsengine_autotrim_values | Specifies whether to strip any leading or trailing white space from values entered in forms. |
formsengine_check_referrer | Specifies whether forms can be submitted from unrecognized servers. GX Software recommends that this option be selected as an extra safeguard against CSRF attacks. |
formsengine_clear_errors_on_back | This setting was introduced in XperienCentral version 10.22.0. Specifies whether to clear error messages from a form session if the visitor clicks the [Back] button. For example, consider the following scenario:
With this option enabled, the visitor will not see an error message on step 2. With this option disabled, the visitor will see the error message upon returning to step 2. |
formsengine_enable_sanitation | Enables sanition for Interactive Forms. |
formsengine_prehandling_cachetimeout | To ensure good performance for interactive forms, a cache is maintained that defines where they are located. This setting defines the number of seconds that the interactive forms cache lasts. |
formsengine_prehandling_check_blocks | Specifies whether to prehandle forms on page sections. Because the creation of the prehandling cache can have a negative effect on performance, GX Software recommends that this setting be switched off unless you need to prehandle forms on page sections. |
formsengine_prehandling_check_mediaitems | Specifies whether to prehandle Content Repository items on page sections. Because the creation of the prehandling cache can have a negative effect on performance, GX Software recommends that this setting be switched off unless you need to prehandle Content Repository items on page sections. |
formsengine_prehandling_check_pages | Specifies whether to prehandle forms on pages. Because the creation of the prehandling cache can have a negative effect on performance, GX Software recommends that this setting be switched off unless you need to prehandle forms on pages. |
formsengine_sanitation_attributes | Specifies which HTML attributes are allowed in any HTML element within an interactive form value. For example, adding the attribute id would allow a <div id="99"> if div is also an allowed attribute. |
formsengine_sanitation_elements | Specifies which HTML elements are allowed within an interactive form value. For example, if you add "p" then that allows the HTML
For example,
allows |
formsengine_sanitation_protocol | Specifies which HTML protocols are allowed within any HTML element within an interactive form value. For example, if you add "href", then <a href="https://www.cnn.com"> would be allowed if "a" is also allowed as a protocol. |
formsengine_session_cleaner_schedule | Specifies the number of seconds between which a check will be done to see whether there are any timed out form sessions. This setting is tied to the following setting (forms_session_timeout ). |
formsengine_session_timeout | Specifies the amount of time, in minutes, after which an Interactive Forms session will time out if a website visitor remains idle. For example, if a website visitor starts filling out a form and proceeds through one or more steps and then does nothing, the session will time out after the specified number of minutes. The visitor will be redirected to a "session expired" page when he or she attempts to proceed further after a timeout has occurred. |
formsengine_uploaddir | Specifies the temporary directory where uploads in Interactive Forms are stored. |
frontend_system_settings
Property | Description |
---|---|
allow_cache | Enables/disables caching in the XperienCentral front-end. |
cache_cacheable_response_codes | A comma-separated list of cacheable response codes. The default is "200" (successful response from the server). Only codes that denote an immediate successful response should be entered. |
cache_directory | The folder where the files containing cached content is stored. |
cache_directory_depth | The maximum depth that the folder tree used for caching can reach. The recommended value is 3. |
cache_max_stale_time | The number of seconds that the front-end will serve an old version of a page from the cache while the page is being regenerated by the backend. The recommended value is 0. |
cache_number_of_directories | The maximum number of subfolders that will be created for the caching directory structure. The recommended value is 30. |
cache_statement_timeout | Specifies the number of seconds between queries from the front-end to ensure the validity of cached content. |
cache_timestamp_expire | The maximum number of seconds that a query to the Timestamp database is allowed to take. If there is no response from the database within this time period, the cached version of the page is returned. The recommended value is 2. |
crawler_useragent | Contact your GX Software consultant for information on setting this property. |
definition_url_base | The base URL of the forms definitions. |
form_upload_directory | The folder where uploads are temporarily stored. |
friendly_url_datasource | The datasource to use for friendly URLs. |
friendly_url_extension | This setting was removed from XperienCentral in version R36. Specifies the extension to use for friendly URLs (".htm" or ".html"). |
ignore_user_agent | Indicates whether the user agent should be ignored. |
log_event_type_factory | For internal use only. Do not change the default value. |
log_file_charset | Specifies the character set used to encode log files (UTF-8 for example). |
max_upload_size | The maximum allowed file size, in bytes, for uploads. The default is 10 MB. |
proxy_cached_read_timeout | The number of milliseconds that the proxy waits for a response from the backend. If the backend doesn't respond within the specified time, the cached version of the page is returned. The recommended value is 10000. |
proxy_connect_timeout | The number of milliseconds that the proxy waits for a successful connection to the backend. If the connection cannot be made within the specified time, the cached version of the page will be returned. The recommended value is 30000. |
proxy_ip_number | For internal use only. Do not change the default value. |
proxy_max_concurrent_requests | The maximum allowable number concurrent requests to the proxy server. |
proxy_number_of_threads | This property is not used. |
proxy_read_timeout | The number of milliseconds the proxy waits for an HTTP response. The recommended value is 120000. |
proxy_retry_timeout | Determines the number of milliseconds that the proxy will wait after retrying a page request. The recommended value is 10000. |
redirect_disallowed | Specifies whether to allow redirects. |
redirect_encoding | The encoding to use for redirects (UTF-8, for example). |
registration_forwardbase | The base URI for registration forms. |
timestampfetcher_classname | Specifies the name of the alternative class to use to fetch timestamps. |
graphqlservice
Property | Description |
---|---|
| Specifies the expiration time, in minutes, of the GraphQL cache. |
enable_api | Specifies whether to enable the GraphQL API. |
max_query_complexity | Specifies the maximum number of characters allowed in a query. |
rate_limit_call_limit | Specifies the maximum number of calls that may be processed from the same IP address. |
rate_limit_enabled | Specifies whether rate limiting is enabled. |
rate_limit_ignored_ips | Specifies the IP address that are not subject to rate limiting. To enter an IP address, type the string in the field and then click [Add value]. |
rate_limit_time_frame_in_minutes | Specifies the time window, in minutes, that is used by the setting rate_limit_call_limit. |
require_authentication | Specifies whether an API key is required when communicating with the XperienCentral GraphQL API. |
headless_search_retrieve
Property | Description |
---|---|
channel | Specifies the channel where the headlesss search/retrieve is running. |
default_search_result_amount | Specifies the default number of results that will be returned by a search query. |
max_items_in_result | Specifies the maximum number of results that can be returned by a search query. |
search_retrieve_enabled | Specifies whether headless search/retrieve is enabled. |
jcrindex
The option to run XperienCentral front-end nodes without a JCR index was introduced in R28.
XperienCentral versions R27 and lower use the Apache Jackrabbit implementation of the JCR index to perform queries for locating resources. In R28, GX switched to an XperienCentral-optimized solution that uses a database in order to speed up the addition of front-end nodes in cloud deployments. In R29, XperienCentral no longer runs Apache Jackrabbit parallel with its own search index implementation. To enable and use Apache Jackrabbit, see The XperienCentral JCR Index.
Property | Description |
---|---|
autorepair | Specifies whether corruptions in the index are automatically detected and repaired. "True" enables this feature and "false" disables it. GX recommends that you set this setting to "true". |
mode | Specifies the mode in which XperienCentral performs queries. The options are:
|
removebatchsize | |
wmidcachethreshold | Specifies the number of internal UUIDs to cache in order to improve performance. The default is 1000. Contact your GX consultant before modifying this value. |
sanitation_config_set
| Enables the Sanitation service. |
| Specifies which HTML attributes are allowed in any HTML element within an interactive form value. For example, adding the attribute id would allow a <div id="99"> if div is also an allowed attribute. |
elements | Specifies which HTML elements are allowed within an interactive form value. For example, if you add "p" then that allows the HTML
For example,
allows |
| Specifies which HTML protocols are allowed within any HTML element within an interactive form value. For example, if you add "href", then <a href="https://www.cnn.com"> would be allowed if "a" is also allowed as a protocol. |
| Some text within a form value are HTML-like but are not balanced meaning they do not contain both an open and close tag ("<GX>" for example). Such text can be excluded from sanitation and as such will be left untouched. To exclude "<GX>" for example, add "gx" or "GX" - the list is case insensitive. |
search_settings
Property | Description |
---|---|
date_format_parameter | Specifies the format to use for dates (dd-MM-yyyy, for example). |
from_parameter | Specifies the "from" parameter to use when results are shown (for example, "From x to y"). |
max | Specifies the maximum number of results to show. |
order_by_parameter | Specifies how results are ordered. |
query_parameter | Specifies the name of the query to use for searches. |
scope | Specifies the location where the XperienCentral internal search engine temporarily stores search results. The valid values are "session" and "request". "Session" means that the search results are stored for the duration of the user's XperienCentral session or until the results have been overwritten by a subsequent search. "Request" means that the search results are only stored for the duration of the current request. For best performance results, you should use "Session" for search results that return multiple pages for a limited number of sessions. If the server handles multiple requests over time, "Request" should be used. |
search_service | The RMI URL for the Search Service. |
to_parameter | Specifies the "to" parameter to use when results are shown (for example "From x to y". |
startup_settings
Property | Description |
---|---|
base_directory | Specifies the base folder for application data. |
config_filename | Specifies the location of the XperienCentral configuration file that determines which license components you have purchased. |
context | Specifies the context path. This is the path that appears directly after the base URL of the home page of the website, /web for example. |
seo_path | Specifies the path that appears in a friendly URL after the context path. For example, if the context path is "/web" and the SEO path is "seo", then the friendly URLs will all follow the pattern |
use_distributed_siteworks | Specifies whether to use distributed Siteworks. |
wcb_directory | Specifies the folder to use for deploying plugins. |
system_constants
Property | Description |
---|---|
cleansite_location | Specifies the location of the "clean" website that is initially imported when XperienCentral is first run. |
config_filename | Specifies the location of the configuration.xml file that contains XperienCentral settings. |
discussion_handler_uri | Specifies the URI of the discussion handler. |
element_controller_uri | For internal use only. Do not change the default value. |
file_controller_uri | Specifies the URI of the file controller. |
form_handler_uri | Specifies the URI of the form handler. |
gettext_uri | Specifies the URI of the gettext servlet. |
login_redirect_uri | Specifies the URI of the login redirect. |
mediaitem_controller_uri | Specifies the URI of the mediaitem controller. |
page_controller_uri | Specifies the URI of the page controller. |
panel_controller_uri | Specifies the URI of the panel controller. |
redirect_servlet_uri | Specifies the URI of the redirect servlet. |
registration_code_servlet_uri | Specifies the URI of the registration code servlet. |
search_filter_uri | Specifies the URI of the search filter. |
show_servlet_uri | Specifies the URI of the show servlet. |
showobject_servlet_uri | Specifies the URI of the showobject servlet. |
showobject_servlet_uri_closed_area | Specifies the URI of the showobject servlet for closed area. *** wat in godsnaam is dit? |
sphtml_servlet_uri | Specifies the URI of the SPHTMLservlet. |
spring_mvc_controller_uri | Specifies the URI of the Spring MVC controller. |
webmanager-csp-wcb
Property | Description |
---|---|
crontabschedule | The Crontab schedule that dictates when how often the internal CSP report receiver endpoint bids accumulated reports on a CSP report handler for further handling. For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. |
webmanager_revision_bundle
The settings in this section were introduced in XperienCentral version R29.
Property | Description |
---|---|
| Specifies the maximum age, in hours, that a revision will be kept. All revisions older than the specified age will be deleted according to the cleanup schedule (see the following setting). |
| The Crontab schedule that dictates when revisions older than that specified by |
See Reverting a Content Item for complete information on using the revisions functionality. See also create_content_revisions
.
website_settings
Property | Description |
---|---|
allow_public_access_languagelabels | When this setting is disabled, a check is done if the language label maintain permission is enabled when communicating with the language label servlet |
allowed_link_prefixes | Determines which prefixes are allowed in the X-Forwarded-Prefix header.To add a prefix, enter the string in the field and click [Add value]. |
application_filter_definition_url_base | Specifies the URL where the configuration for external application integration is located. |
backend_base_url | Specifies the base URL for the backend system. |
backend_hostname | Specifies the hostname for the backend system. |
backend_server_alias | The name of the server alias used to reach the XperienCentral back-end. |
csp_disabled | Enables or disables the /wiki/spaces/PD/pages/24719467 functionality in XperienCentral. |
default_contenttype | Specifies the default content type. |
default_encoding | Specifies the default encoding, for example, UTF-8. |
default_language | Specifies the default language. |
default_mail_sender | Specifies the default e-mail sender. |
default_mail_subject | Specifies the default e-mail subject. |
disable_unused_content | When selected, the disable unused content job that depublishes unused content items is run according to the Crontab schedule. |
disable_unused_content_whitelisted_extensions | Download media items with these extensions are disabled.To add an extension, enter a string in the field and click [Add value]. |
disable_unused_content_whitelisted_media_types | Media items with these content types are disabled. To add a media type, enter a string in the field and then click [Add value]. |
| Specifies whether to allow an application server backend container to authenticate users who want to log in to XperienCentral. See also Backend Container-based Authentication. |
enable_dynamic_user_creation | Specifies whether to create new users in XperienCentral who log in from an application server backend container who don't already exist in XperienCentral. See also Backend Container-based Authentication. |
enable_email_two_factor_authentication | This setting was introduced in XperienCentral version R24.2. Specifies whether XperienCentral's two factor authentication is enabled. |
enable_external_role_synchronization | Specifies whether to synchronize the roles assigned to a user in an application server backend container with their role(s) in XperienCentral. See also Backend Container-based Authentication. |
export_directory | Specifies the folder to use for exports. |
file_backup_directory | Specifies the folder to use for backups. |
file_browser_directories | Specifies the directories that you can browse through using the File Browser tab (Configuration > System Utilities). To add a directory, follow these steps:
|
file_download_valid_mime_types | Lists the allowed MIME types for the different types of download files which can be uploaded in the Edit environment. This setting is also used for other uploads in the Edit environment. This setting is not used for uploaded images. Note that these MIME types are not configurable. |
file_upload_directory | Specifies the folder to use for uploads. |
file_upload_mm_directory | Specifies the folder to use for uploaded multimedia items. |
file_upload_mm_url | Specifies the URI of the file upload multimedia folder. |
file_upload_url | Specifies the URI of the file upload folder. |
| Specifies the local directories where files uploaded by the Interactive Forms Upload form element may be stored. To add a directory, follow these steps:
|
friendly_url_cache_clear | Specifies the number of milliseconds that transpire before the friendly URL cache is cleared. |
friendly_url_extension | Specifies the extension to use for friendly URLs (".htm" or ".html"). In XperienCentral versions R36 and higher, you can also leave this field blank which results in friendly URLs that have no extension. See SEO for complete information about search engine optimization in XperienCentral. See also Running XperienCentral without a Friendly URL Extension. |
friendly_url_google_news_id | Specifies whether to assign a Google News ID to the friendly URL of Content Repository articles. |
friendly_url_lowercase | Specifies whether uppercase characters are allowed in friendly URLs. When this setting is selected, all friendly URLs are converted to lowercase. |
friendly_url_prefix | Specifies the prefix to use for friendly URLs. See SEO for complete information about search engine optimization in XperienCentral. |
friendly_url_separator | Specifies the separator to use for friendly URLs. The allowed values are dash (-), underscore (_) or empty. If you configure an invalid character it will be converted to a dash (-). See SEO for complete information about search engine optimization in XperienCentral. |
friendly_url_setting | Specifies which of the three possible titles that a page/content item can have that will be looked at first and used in the friendly URL "urltitle", "navigationtitle", or "title". The default is "navigationtitle". |
frontend_hostname | Specifies the host name of the front-end. |
frontend_https_portnr | Specifies the HTTPS port number for the front-end. |
frontend_portnr | Specifies the HTTP port number for the front-end. |
frontend_server_alias | Specifies the aliases to use for the front-end host name. |
frontend_use_https | This setting was introduced in XperienCentral version R29. Enables the HTTPS protocol for front-end servers. This setting is especially useful for the preview functionality introduced in XperienCentral R29. |
generate_https_sitemap_urls | Specifies whether to generate HTTPS URLs for the website's sitemap. |
handler_url_base | For internal use only. Do not change the default value. |
identifier | Specifies the identifier for this website. |
max_image_upload_size | This setting was introduced in XperienCentral version R29. Specifies the maximum allowable size for uploaded images (backend). |
oEmbed_enabled | Specifies whether the features of oEmbed that XperienCentral supports are enabled. |
presentation_jsps_url | Specifies the URL to the design config JSPs for this website. You can add multiple paths to this setting. If you add more than one path, the order from top to bottom as they appear in the list is important. The first matching ID that is found beginning at the top of the list is the one that is used. |
| This setting was introduced in XperienCentral R29. Specifies the amount of time, in minutes, that the preview URL for an unpublished content item remains valid. See also Previewing a Content Item. |
productcatalog_name | Specifies the name of the catalog used by the Product Maintenance component. |
projectid | For internal use only. Do not change the default value. |
redirect_base_url | Only to be used for backward comparability with older versions of XperienCentral. Contact your GX Software consultant for more information. |
redirect_basedirectory | Specifies the redirect base folder. |
render_form_name_and_id | Specifies whether the name as well as the attribute ID for <form/> tags is rendered. This property is used for web guideline compliance. |
| Personalization markers were introduced in XperienCentral version 10.15.0. Enables XperienCentral to send visitor statistics related to personalizations to Google Analytics. This functionality requires the XperienCentral Insights Platform. When enabled, this setting adds hidden |
search_redirect_base | Specifies whether the name as well as the attirbute-ID for <form/>> tags is rendered. This property is used for web guideline compliance. |
searchresult_replacement | This property is not used. |
sitestat_url | Specifies the URL for Sitestat. |
start_object_id | Specifies the identifier of the homepage for this website. |
static_files_url | Specifies the URI to the static files for this website. |
use_absolute_urls | Specifies whether to use absolute URLs. |
use_inline_environment | Specifies whether to use the inline environment. |
use_languagelabels_inheritance | Determines whether inheritance is used when retrieving language labels. |
valid_link_schemes | Specifies the link prefixes that are allowed in hyperlinks in content in XperienCentral. The default prefixes are "http", "https" and "mailto". If your website uses other URL prefixes, you can add them to the allowed link schemes. A link scheme is everything that comes before the colon (:) in a URL (https://www.gxsoftware.com, for example). To add a link scheme, follow these steps:
When you add or delete a link scheme, the change is effective immediately. No restart of XperienCentral or refresh of a browser is necessary. System Administrators and Application Managers: In general, it is a good idea to communicate to your users of XperienCentral which link schemes are acceptable. |
www_root_directory | Specifies the www root directory. |
wmasolrsearch
Property | Description |
---|---|
clearrest | Specifies whether to clear all "remaining URLs" from the search index. This means that all results not indexed in the current run will be removed. Use this option only if fullindex is also enabled. |
config_directory | Specifies the name of the directory where the Solr search directories are located. Note: You can override the default XperienCentral Solr configuration. Perform the following steps in order for the modifications to the Solr configuration files to be applied and saved:
If after performing the steps above you modify the override configuration files in the directory set as
|
crontabschedule | The Crontab schedule that dictates when the search index will be generated. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning.For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. |
fullindex | Specifies whether to generate the entire index instead of just the pages that have been added/changed. If clearrest is enabled, enable this option as well. |
wmaxmfapi
Property | Description |
---|---|
db_cleanup_delete_after_x_days | Deletes records from wmaxmf_indicatorvalues that are at least x days old. |
db_cleanup_job_cronexpression | The Crontab schedule that specifies when the database cleanup job runs. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning.For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. |
exclude_url_paths | Requests containing these URL paths are not executed. To add a path, enter a string in the field and click [Add value]. |
log_measurements | Specifies whether to write measurements to the log. |
measurement_job_cronexpression | The Crontab schedule for the XMF measurements tasks. The Crontab schedule used is a variant of the standard UNIX Crontab scheduler with a "seconds" field prefixed to the beginning.For complete information on scheduling jobs in XperienCentral, see Scheduling Jobs. |
wmpuserprofilesformlogic_set
Property | Description |
---|---|
confirmation_code_valid_for_number_of_days | Determines how long (in days) a user confirmation code is valid. |
confirmation_required | Specifies whether a confirmation code is required. |
exclude_profile_provider_from_generic_processing | Specifies which profile provider(s) are to be exluded from generic processing. To add a provider, enter a string in the field and click [Add value]. |