...
| Table of Contents | ||||
|---|---|---|---|---|
|
application_settings
...
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.
| Time Zone | Value |
|---|---|
| Amsterdam | Europe/Amsterdam |
| Berlin | Europe/Berlin |
| Istanbul | Europe/Istanbul |
| London | Europe/London |
| Lisbon | Europe/Lisbon |
| Moscow | Europe/Moscow |
| Atlantic time | Canada/Atlantic |
| Eastern time | America/New_York |
| Central time | America/Chicago |
| Mountain time | America/Edmonton |
| Pacific time | America/Los_Angeles |
| Alaska time | America/Anchorage |
| Hawaiian time | America/Hawaii |
| India | Asia/Calcutta |
| China | Asia/Shanghai |
| Japan | Japan |
| Western Standard time | Australia/Perth |
| Central Standard time | Australia/North |
| Lord Howe Standard time | Australia/LHI |
...
| Note |
|---|
If you use a proxy, GX Software recommends that you always add the host names of the XperienCentral frontend and backend servers to this list. |
...
Specifies whether XperienCentral protects against CSRF attacks on its REST API.
| Note |
|---|
This setting should always be on (selected). |
...
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.
| Note |
|---|
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 URL |
...
backend_system_settings
| Property | Description |
|---|---|
ignore_backend_cookies | Specifies whether to ignore cookies relayed by a frontend 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. |
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. |
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). |
forms_config_set
| Property | Description |
|---|---|
forms_exportimport_dir | Specifies the directory used by the Interactive Forms component to store temporary import and export files. |
formsengine_config_set
| Property | Description |
|---|---|
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_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_session_cleaner_thread_interval | 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. |
...
| Property | Description |
|---|---|
allow_cache | Enables/disables caching in the XperienCentral frontend. |
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 frontend 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 frontend 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 | The extension to use for friendly URLs. See the XperienCentral online help topic Help > Traffic Management > SEO for complete information on XperienCentral's search engine optimization. |
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. |
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". |
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. |
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. |
sphtml_servlet_uri | Specifies the URI of the sphtml servlet. |
spring_mvc_controller_uri | Specifies the URI of the Spring MVC controller. |
website_settings
...
- Add the fully qualified path to the directory in the text field next to [Add value].
- Click [Add value]. The new directory is added.
- Click [Save Changes] to save the change.
...
- Add the fully qualified path to the directory in the text field next to [Add value].
- Click [Add value]. The new directory is added.
- Click [Save Changes] to save the change.
...
- Enter the link scheme in the text field next to the [Add value] button.
- Click [Add value]. The link scheme is added.
...
- Select the "Delete" check box to the right of the link scheme.
- Scroll to the bottom of the "General" tab and click [Save Changes]. The link scheme is deleted.
When you add or delete a link scheme, the change is effective immediately. No restart of XperienCentral or refresh of a browser is necessary.
| Note |
|---|
System Administrators and Application Managers: In general, it is a good idea to communicate to your users of XperienCentral which link schemes are acceptable. |
...
wmasolrsearch
...
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:
- Start XperienCentral.
- Create a new directory for the Solr configuration files.
- Copy the directory
<xperiencentral-root>/work/searchengine/conf/core0/confto the directory you created in the previous step. - Modify the configuration file(s) as desired in the new directory.
- Add the Solr directory that you created above to the property "config_directory" in the "wmasolrsearch" section (above).
- Click [Save Changes] in the Setup Tool.
- In the XperienCentral Workspace, navigate to the Plugins dialog (Configuration > Plugins).
- Stop and restart the plugin "wmasolrsearch".
If after performing the steps above you modify the override configuration files in the directory set as config_directory, you must perform the following steps for them to take effect:
- Modify the configuration file(s) as desired in the
config_directory. - In the XperienCentral Workspace, navigate to the Plugins dialog (Configuration > Plugins).
- Stop and restart the plugin "wmasolrsearch".
...
Profiling Overview
The Profile page shows data regarding how long it takes XperienCentral to render content elements and presentations and to handle Siteworks requests. This information is crucial for evaluating the performance of specific elements and presentations as well as the handling of requests. If it takes XperienCentral an unusually long time to render a specific presentation, it could be an indication that there are issues with the JSP. If the handling of Siteworks requests takes an unusually long time, it could be an indication that the system is experiencing an unusually high load or that the server is running near its maximum capacity. The Profiling Overview shows much more detailed information than the Performance Dashboard.
To view the Profile page, navigate to the following URL in a browser:
<domain>{context path}/admin/profile
For example:
http://gxsoftware.com/web/admin/profile
In this section
Overview
Searching in the Profile Overview
Updating and Clearing the Log
Overview
The Overview table contains the following columns:
| Column | Description |
|---|---|
| Thread | The name of the thread. |
| When | The time that the request was executed. The time zone shown is UTC. |
| Name | The action(s) that were executed by the request. |
| Total time (ms) | Shows the total time, in milliseconds, that the request took to complete, including overhead (name of the thread plus the details shown when the request is expanded). This is always larger than the "Self time". |
| Self time (ms) | Shows the total time, in milliseconds, that the specific action related to the thread took to complete. This is always smaller than the "Total time". |
The entries in the list can be expanded and collapsed. When expanded, the nested entries are shown in a hierarchy. The nested entries show the notable requests that are present in the main request shown at the topmost level.
Searching in the Profile Overview
You can perform searches in the Profile Overview for a specific entry or entries containing the same string. You can search for a string or using a string in combination with one or more regular expressions. To use a regular expression, select "RegEx". Only those entries matching what you searched for will appear in the log.
Updating and Clearing the Log
When you first load the Profile Overview, all the activity for the past x hours is shown where x is the value appearing in the "Min time" field. To update the log, click [Update]. To clear the log, click [Clear results].
Back to top
...
startup_settings
...