Versions Compared

Old Version 1

changes.mady.by.user Matthew Wagner

Saved on

compared with

New Version Current

changes.mady.by.user Matthew Wagner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

...

Table of Contents
maxLevel2
minLevel2

 

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 ZoneValue
AmsterdamEurope/Amsterdam
BerlinEurope/Berlin
IstanbulEurope/Istanbul
LondonEurope/London
LisbonEurope/Lisbon
MoscowEurope/Moscow
Atlantic timeCanada/Atlantic
Eastern timeAmerica/New_York
Central timeAmerica/Chicago
Mountain timeAmerica/Edmonton
Pacific timeAmerica/Los_Angeles
Alaska timeAmerica/Anchorage
Hawaiian timeAmerica/Hawaii
IndiaAsia/Calcutta
ChinaAsia/Shanghai
JapanJapan
Western Standard timeAustralia/Perth
Central Standard timeAustralia/North
Lord Howe Standard timeAustralia/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 <website-root-URL>/web/admin/statistics.

...

 

Back to top

 

backend_system_settings

 

PropertyDescription
ignore_backend_cookiesSpecifies whether to ignore cookies relayed by a frontend proxy to the backend server.
max_charSpecifies the code of the highest ASCII character that XperienCentral will output. The default is "127" (all standard ASCII characters).
max_includes_depthSpecifies the maximum number of includes allowed in a config.
max_includes_per_requestSpecifies the maximum number of includes that are allowed during a single request.
max_recursion_depthSpecifies the maximum depth of includes recursion.
ntlm_auth_domain_controllerSpecifies the IP address of the NTLM authentication server.
ntlm_auth_enabledEnables/disables NTLM authorization.
ntlm_auth_ignore_hostsSpecifies the names of the hosts from which requests will be ignored. Separate multiple host names using a comma (,).
ntlm_auth_ignore_user_agentsSpecifies the user agents that will be ignored.
package_image_urlSpecifies the location where XperienCentral menu-related images are stored.
presentation_jsps_urlThe relative URL of the XperienCentral design config JSPs.
replicate_uploads_on_readonlySpecifies whether to replicate uploaded files on read-only servers in a cluster.
static_files_locationSpecifies the directory where static files are stored (relative to the XperienCentral installation).
user_profiles_export_maxSpecifies the maximum number of user profiles that can be exported in one export file.

 

Back to top

 

development_settings

 

PropertyDescription
enable_debug_messagesSpecifies whether to log debug information.
enable_view_resolve_cacheSpecifies whether to cache the views of the Workspace. Caching the views improves performance.

 

Back to top

 

file_distribution_settings

 

PropertyDescription
max_file_size_mbSpecifies the maximum allowed size of a static file (in megabytes).

 

Back to top

 

forms_config_set

 

PropertyDescription
forms_exportimport_dirSpecifies the directory used by the Interactive Forms component to store temporary import and export files.

 

Back to top

 

formsengine_config_set

 

PropertyDescription
formsengine_autotrim_valuesSpecifies whether to strip any leading or trailing white space from values entered in forms.
formsengine_check_referrerSpecifies 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_cachetimeoutTo 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_blocksSpecifies 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_mediaitemsSpecifies 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_pagesSpecifies 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_intervalSpecifies 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_timeoutSpecifies 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_uploaddirSpecifies the temporary directory where uploads in Interactive Forms are stored.

 

Back to top

 

...

 

PropertyDescription
allow_cacheEnables/disables caching in the XperienCentral frontend.
cache_cacheable_response_codesA 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_directoryThe folder where the files containing cached content is stored.
cache_directory_depthThe maximum depth that the folder tree used for caching can reach. The recommended value is 3.
cache_max_stale_timeThe 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_directoriesThe maximum number of subfolders that will be created for the caching directory structure. The recommended value is 30.
cache_statement_timeoutSpecifies the number of seconds between queries from the frontend to ensure the validity of cached content.
cache_timestamp_expireThe 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_useragentContact your GX Software consultant for information on setting this property.
definition_url_baseThe base URL of the forms definitions.
form_upload_directoryThe folder where uploads are temporarily stored.
friendly_url_datasourceThe datasource to use for friendly URLs.
friendly_url_extensionThe 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_agentIndicates whether the user agent should be ignored.
log_event_type_factoryFor internal use only. Do not change the default value.
log_file_charsetSpecifies the character set used to encode log files (UTF-8 for example).
max_upload_sizeThe maximum allowed file size, in bytes, for uploads. The default is 10 MB.
proxy_cached_read_timeoutThe 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_timeoutThe 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_numberFor internal use only. Do not change the default value
proxy_max_concurrent_requestsThe maximum allowable number concurrent requests to the proxy server.
proxy_number_of_threadsThis property is not used.
proxy_read_timeoutThe number of milliseconds the proxy waits for an HTTP response. The recommended value is 120000.
proxy_retry_timeoutDetermines the number of milliseconds that the proxy will wait after retrying a page request. The recommended value is 10000.
redirect_disallowedSpecifies whether to allow redirects.
redirect_encodingThe encoding to use for redirects (UTF-8, for example).
registration_forwardbaseThe base URI for registration forms.
timestampfetcher_classnameSpecifies the name of the alternative class to use to fetch timestamps.

 

Back to top

 

search_settings

 

PropertyDescription
date_format_parameterSpecifies the format to use for dates (dd-MM-yyyy, for example).
from_parameterSpecifies the "from" parameter to use when results are shown (for example, "From x to y").
maxSpecifies the maximum number of results to show.
order_by_parameterSpecifies how results are ordered.
query_parameterSpecifies the name of the query to use for searches.
scopeSpecifies 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_serviceThe RMI URL for the search service.
to_parameterSpecifies the "to" parameter to use when results are shown (for example "From x to y".

 

Back to top

 

system_constants

 

PropertyDescription
cleansite_locationSpecifies the location of the "clean" website that is initially imported when XperienCentral is first run.
config_filenameSpecifies the location of the configuration.xml file that contains XperienCentral settings.
element_controller_uriFor internal use only. Do not change the default value.
file_controller_uriSpecifies the URI of the file controller.
form_handler_uriSpecifies the URI of the form handler.
gettext_uriSpecifies the URI of the gettext servlet.
login_redirect_uriSpecifies the URI of the login redirect.
mediaitem_controller_uriSpecifies the URI of the mediaitem controller.
page_controller_uriSpecifies the URI of the page controller.
panel_controller_uriSpecifies the URI of the panel controller.
redirect_servlet_uriSpecifies the URI of the redirect servlet.
registration_code_servlet_uriSpecifies the URI of the registration code servlet.
search_filter_uriSpecifies the URI of the search filter.
show_servlet_uriSpecifies the URI of the show servlet.
showobject_servlet_uriSpecifies the URI of the showobject servlet.
showobject_servlet_uri_closed_areaSpecifies the URI of the showobject servlet for closed area.
sphtml_servlet_uriSpecifies the URI of the sphtml servlet.
spring_mvc_controller_uriSpecifies the URI of the Spring MVC controller.

 

Back to top

 

website_settings

 

...

  1. Add the fully qualified path to the directory in the text field next to [Add value].
  2. Click [Add value]. The new directory is added.
  3. Click [Save Changes] to save the change.

...

  1. Add the fully qualified path to the directory in the text field next to [Add value].
  2. Click [Add value]. The new directory is added.
  3. Click [Save Changes] to save the change.

...

  1. Enter the link scheme in the text field next to the [Add value] button.
  2. Click [Add value]. The link scheme is added.

...

  1. Select the "Delete" check box to the right of the link scheme.
  2. 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.

 

 

...

 

Back to top

 

wmasolrsearch

 

PropertyDescription
clearrestSpecifies whether to clear all "remaining URLs" from the search index.
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:

  1. Start XperienCentral.
  2. Create a new directory for the Solr configuration files.
  3. Copy the directory <xperiencentral-root>/work/searchengine/conf/core0/conf to the directory you created in the previous step.
  4. Modify the configuration file(s) as desired in the new directory.
  5. Add the Solr directory that you created above to the property "config_directory" in the "wmasolrsearch" section (above).
  6. Click [Save Changes] in the Setup Tool.
  7. In the XperienCentral Workspace, navigate to the Plugins dialog (Configuration > Plugins).
  8. 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:

  1. Modify the configuration file(s) as desired in the config_directory.
  2. In the XperienCentral Workspace, navigate to the Plugins dialog (Configuration > Plugins).
  3. Stop and restart the plugin "wmasolrsearch".
crontabscheduleThe 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 the Crontab format, see Crontab.
fullindexSpecifies whether to generate the entire index instead of just the pages that have been added/changed.

 

Back to top

 

startup_settings

 

PropertyDescription
base_directorySpecifies the base folder for application data.
config_filenameSpecifies the location of the XperienCentral configuration file that determines which license components you have purchased.
contextSpecifies the context path. This is the path that appears directly after the base URL of the home page of the website, /web for example.
use_distributed_siteworksSpecifies whether to use distributed Siteworks.
wcb_directorySpecifies the folder to use for deploying plugins.

 

Back to top

 

 

 The Threads administrative page shows the threads that are currently active or in a waiting state. By default, all active threads are shown but you can also filter the list in order to only show the threads that you are interested in. Viewing the XperienCentral application's threads makes it possible to debug problems.

To view the Threads page, navigate to the following URL in a browser:

<domain>/{context path}/admin/threads

For example:

http://www.gxsoftware.com/web/admin/threads


...

Filtering Threads

In the "Filtering" section, you can filter the threads that are shown in the list according to various criteria. You can filter the threads list as descrobed below. If you specify more than one filtering rule, the rules have an "AND" relationship with each other.


Filter CriteriaDescription
Minimum stack sizeSpecifies the minimum number of rules (thread dumps) to display.
Thread name patternDisplays only the threads that match the specified pattern. The format of the pattern is the thread name that appears between the square brackets, for example, "ActiveFetcherThread" and "CachedUrlBuilderCacheCleaner". You can add wildcards to display all threads that match a specific pattern, for example "FelixFrameworkWiring*".
Method name patternDisplays only methods that match the specified pattern. The format of the pattern is the method name that appears after the "at" declaration with periods (.) escaped with a backslash (\), for example "sun\.misc\.Unsafe\.park.*".
StateThe state of the thread. The possible states are:
  • New — The thead is scheduled but has not yet started.
  • Runnable — The thread is currently being executed in the Java virtual machine (JVM).
  • Blocked — The thread is currently blocked and is waiting for another condition to become true.
  • Waiting — The thread is waiting for another thread to perform a particular action.
  • Timed_waiting — The thread is waiting for a specific amount of time for another thread to perform a particular action.
  • Terminated — The thread has completed its task and exited.
Minimum stack sizeThe minimum size of the stacks to render. The threads that are shown as a result are only those that are no larger than the minimum size specified.
Maximum stack sizeThe maximum size of the stacks to render. The threads that are shown as a result are only those that are smaller than the maximum size specified.