Configuring Server Properties - General
See also: Server Administration Application Home Page
Transaction
Manager Properties
Properties are divided into sections; click on a section header to open it to display the properties. Click the Save button at the bottom of the page to save the properties. These properties are saved to file server.properties in the ebaseConf folder of the web application e.g. UfsServer/tomcat/webapps/ufs/ebaseConf/server.properties.
The icon 
shown to the left of a property indicates that
the server must be restarted before a property change is activated. Changes to
all other properties are effective immediately.
Click More Info.. at the right-hand side of each property to display help for that property.
General Properties
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.systemName |
No |
Specifies the name of the system. This is displayed on the Server Info page of the Server Administration Application. |
|
|
Ufs.dateFormat |
No |
The format that date literals are entered and displayed in the Ebase Xi Designer. This format applies to all dates entered via the designer including field default values and date literals in FPL scripts. Changing this parameter may also entail changing forms and scripts if date literals have been used as default values or in scripts. This parameter should have the same value as the Date Literal Format designer preference. Note that this
property does not affect the format
of date fields displayed at runtime; these are formatted based on the runtime
language (Click here
for more information). The following formats can be specified:
The default is mm/dd/yyyy. |
|
|
Ufs.secureSocket |
No |
SSL port number used when users are redirected to an SSL URL as a result of the secure form property of a form. |
|
|
Ufs.callUrlMethod |
No |
The default method used for call URL and goto URL script commands. If not specified the default is GET. |
|
|
Ufs.productionMode |
No |
Specifies whether a detailed message is displayed to users when a failure occurs: ·
Checked:
the standard error HTML page for
the Ebase web application is displayed when a form execution error occurs –
the detailed diagnostic runtime error message is not displayed, but is
logged. ·
Unchecked:
use this mode when developing forms with the Ebase Designer. If a form
execution error occurs, the standard error
HTML page for the Ebase web application is displayed followed by detailed
diagnostic form runtime error messages. Checking this property is recommended for production systems as it denies potential hackers access to detailed failure information. |
|
|
Ufs.fileAccessRoot |
No |
This is used by the Ebase Xi Designer remote file browser
to specify the root directory on the server that may be accessed from the designer.
This is used to navigate to web resources. It should normally be set to point
to the root of the Ebase web application e.g. C:/ufs/UfsServer/tomcat/webapps/ufs. |
|
|
Ufs.useSystemTimezone |
No |
When checked (the recommended setting), specifies that fields of type TIME, DATETIME and DATE support timezones. The timezone specified for the Java system will be used. Click here for further details. |
|
|
Ufs.timeZone |
No |
Specifies
a particular timezone to use for fields of type TIME, DATETIME and DATE and
applies only when the previous parameter Use
System Timezone is unchecked. Click here for further details. |
|
|
Ufs.defaultFocusToFirstField |
No |
When
checked, the system will focus to the first field of each page when moving to
a new page unless this has been overridden by a script. See Controlling Focus for more information. |
|
|
browser.no.popups |
No |
The
system will not popup new windows. Instead “popup” windows are displayed
inline and the user must click the browser back button to return to a form. If
this option is used in conjunction with suppression of the browser back button for a
form, popups will be displayed as popups, not inline i.e. this property
setting is ignored. This
setting applies to:
|
|
|
Ufs.HolidayClassNames |
Yes |
One or more
Java classes that implement the calendar Holiday interface separated by a
commma. Click here for details. |
|
|
Ufs.skipBrowserAttributesCheck |
No |
When checked, the system will bypass the check of browser
capability that is normally performed each time a new browser connects. This
checking mechanism consists of the transmission of a test HTML page from the
server to the client which is then immediately posted back to the server.
This check determines
whether the client browser supports Javascript and cookies. When this option
is checked, the browser is presumed to support both Javascript and cookies,
and if this is not the case, runtime errors will occur. Checking this property can sometimes resolve problems when the Ebase Xi Server is being used within a CRM or CMS system where an Ebase form frame is displayed as part of a larger page. Consider using this option with CRM or CMS systems if message “This web page requires cookies to be enabled in your Web Browser” is being issued yet support for cookies is enabled in the browser. |
|
|
Ufs.sessionTimeout |
No |
Specifies the session inactivity timeout interval in minutes. If no user input is received for this period of time the session is removed. When specified, this parameter overrides the timeout parameter in the web.xml file. Caution! this parameter has a major impact on the amount of memory required for the server. Session state is retained in memory until this inactivity timeout is reached so specifying large values can lead to out of memory problems. Session state memory and session age can be monitored by clicking the Show user sessions link on the Server Administration App home page. |
|
|
Ufs.executableDir |
No |
Specifies the directory where external executables are stored. This includes the wkhtmltopdf PDF generator. |
Logging Properties
These properties apply to the log files created by the Ebase Xi system. The properties that apply to audit logs relate to logging of security authorizations when the Ebase Security System is used.
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.logDirName |
Yes |
Specifies the absolute or relative directory where log files are created. |
|
|
Ufs.logFileName |
Yes |
Specifies
the name of the log file. |
|
|
Ufs.logInfo |
Yes |
Specifies whether or not Ebase information messages are written to the log. When FPL scripts are executed this includes logging the execution of each statement. For a production system, this should normally be unchecked. |
|
|
Ufs.logError |
Yes |
Specifies whether or not Ebase error messages are written to the log. This should normally be checked. |
|
|
Ufs.retainOldLogs |
Yes |
Specifies
whether or not old log files are kept. If checked, a new log file is created each time the Ebase Xi
Server is started. A timestamp is appended to the name of the log file
specified for property Ufs.logFileName.
If unchecked, a single log file is used. This property is deprecated from V5.3 and is
ignored. |
|
|
Ufs.retainOldAuditLogs |
Yes |
Specifies
whether or not old security audit log files are kept. If checked, a new security audit log file
is created each time the Ebase Xi Server is started. A timestamp is appended
to the name of the log file specified for property Ufs.auditLogFileName. If unchecked, a single log file is used. This property is deprecated from V5.3 and is
ignored. |
|
|
Ufs.auditLogFileName |
Yes |
Specifies the name of the security audit log file. |
|
|
Ufs.auditLogDirName |
Yes |
Specifies
the absolute or relative directory where security audit log files are
created. |
Transaction Manager Properties
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.transactionTimeout |
No |
Specifies
the transaction timeout period in seconds. This overrides the value set with
parameter jotm.timeout in the web
application config file in UfsServer/tomcat/conf. This
value should be large enough to accommodate the longest running transaction
that occurs in normal processing. It may be necessary to specify a higher
value if long running scheduled tasks are used. Note that when multiple web applications are deployed within the application server, transaction timeout should be set using this property and not jotm.timeout. |
Scheduler Properties
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.schedulerWakeupInterval |
No |
The number of seconds the scheduler waits before re-activating its scan for executable tasks. The default is 60 seconds. If your system contains scheduled tasks which execute at short repeat intervals i.e. every n minutes or seconds, this parameter should be reduced accordingly e.g. if a task is scheduled to run every minute, this property might have a value of 10 (wakes up every 10 seconds to check for work). |
Upload Properties
These
properties configure upload behavior using the FPL upload command or the Javascript form.uploadFileFromBrowser() method. For FPL these properties apply
to all uploads and can’t be overridden. For Javascript these properties can be
overridden by using the form.uploadFileFromBrowser(uploadOptions)
method. See Working with Files for more
information.
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.fileDirectoryName |
No |
The directory into which any uploaded and saved files are written. This can be overridden – see comments at the top of this section. |
|
|
Ufs.maxUploadFileSize |
No |
Sets the
maximum size for a file uploaded using the FPL upload command or API form.uploadFileFromBrowser()
method. Specify a number ending with either K (kilobytes) or M
(megabytes) e.g. 500K, 10M. The
default if not specified is 1M. This can be overridden – see comments
at the top of this section. |
|
|
Upload File Types |
Ufs.uploadFileTypes |
No |
A comma delimited list of file types that can be uploaded i.e.
file extensions doc, txt etc. These file types are case insensitive e.g.
specifying pdf allows the upload of
types pdf, PDF, Pdf etc. The default is all. This
can be overridden – see comments at the top of this section. |
PDF Properties
These properties
apply to the generation of PDFs using the FPL outputpage or pdfprint
commands are any of the Javascript form.generatePdf()
methods. See Printing for more information.
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.printDirectoryName |
No |
The default directory into
which any PDF documents created via script statements are saved. This can be
overridden with each script statement. |
|
|
Ufs.printFontsDirectory |
No |
The
operating system directory in which all system and user fonts are defined.
This is required to use legacy print forms.
In Windows XP, this is typically C:/WINDOWS/fonts. When multiple directories
are specified, these should be separated with a | character. |
|
|
Ufs.localBaseUrl |
No |
Specifies a local base URL that is used to complete relative URLs to resolve images and style sheets included in PDF documents generated using FPL outputpage or Javascript form.generatePdf() .
This property should be set when the server is configured to run behind a firewall or web server and PDFs are generated with missing images or styles; this problem can occur when the Ebase Xi Server has been unable to resolve the URL to access the image or style sheet e.g http://localhost:3030/ebase/. See Designing Print Pages for more information regarding this property. |
|
|
PDF Engine |
Ufs.pdfEngine |
No |
Specifies the PDF engine used to generate a PDF document when using the Javascript form.generatePdf() or FPL outputpage command. · The wkhtmltopdf PDF engine supports HTML5 and CSS3. It uses the WebKit rendering engine. · The flying saucer PDF engine is legacy and supports HTML4 and CSS2. The default is wkhtmltopdf.Please note that small changes to existing print pages can result from changing this property. |
|
DPI |
Ufs.pdfDPI |
No |
This property applies only when the wkhtmltopdf PDF engine is used and influences the text and image scaling when generating a PDF on the server and can also affect the size of the PDF document produced. Windows and Linux systems should be OK with the default value. A Mac server system may require a change to this property. |
|
JavaScript Delay |
Ufs.pdfJavaScriptDelay |
No |
This property applies only when the wkhtmltopdf PDF engine is used and sets the time waiting for JavaScript to load in milliseconds. This setting will slow down the speed the page renders but depending on the environment maybe required to allow time for the JavaScript to finish loading. The default is 200. |
Scripting Properties
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.maxLoopCount |
No |
Specifies the maximum number
of iterations within an FPL loop/endloop construct (excluding loop at table). The default value is
10,000. |
Resource Properties
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.mqHostId |
No |
Specifies the hostname or IP address of the MQSeries server. |
|
|
Ufs.mqPort |
No |
Specifies the default MQSeries listener port. |
Proxy Properties
These properties apply only when the Ebase Xi Server is communicating via a proxy e.g. a web service is called. Note that the corresponding proxy settings for the Ebase Xi Designer are configured from the Designer Preferences Dialog.
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.proxyHost |
No |
The
hostname of the proxy server. This property overrides –Dhttp.proxyHost Java parameter if specified. |
|
|
Ufs.proxyPort |
No |
The port of the proxy server. This property overrides –Dhttp.proxyPort Java parameter if specified. |
|
|
Ufs.nonProxyHosts |
No |
The host name or ip address of any servers which should not be routed through the proxy. Multiple host names/ip addresses should be separated by a | character. This property overrides –Dhttp.nonProxyHosts Java parameter if specified. |
|
|
Ufs.proxyUsername |
|
The user name if the proxy server requires authentication. This property overrides –Dhttp.proxyUser Java parameter if specified. |
|
|
Ufs.proxyPassword |
|
The password if the proxy server requires authentication. This property overrides –Dhttp.proxyPassword Java parameter if specified. |
Caching Properties
Ebase uses Ehcache to maintain caches of Ebase objects. There are two distinct caches:
- Entities Cache is a cache
containing designed Ebase entity objects e.g. forms, scripts, resources,
lists, presentation templates etc.
- Runtime Headless Cache contains internal Ebase runtime form objects. Caching these objects avoids the overhead of recreating them for each new form invoked by a user. This cache should be large enough to contain all commonly used forms.
|
Label |
Property Name |
Requires Restart |
Description |
|
Entity Memory Cache size |
Ufs.cache.entity.MemorySpace |
Yes |
The maximum number of Ebase designer entity objects contained within the Entities Cache in memory. When the number of loaded designer objects exceeds this number, the oldest objects are discarded from the cache. An initial value of 2000 is recommended for this parameter. A value of 0 indicates that the cache size is unlimited i.e. all objects are cached. This number may need to be increased on large systems. The default value is 0. |
|
Runtime Memory Cache size |
Ufs.cache.headless.MemorySpace |
Yes |
The maximum number of runtime objects contained within the Runtime Headless Cache in memory. Runtime objects are created to run forms and integration services and they are the objects which are actually executed when a URL request is received from a user. Each runtime object will contain all the individual entities that are required to execute the form or integration service. When this number is exceeded, the oldest objects are discarded from the cache – if a runtime object is subsequently required e.g. a URL request for it is received, it will be reloaded from database. The system is distributed with an initial value of 100. The default value is 0 which indicates that the cache size is unlimited i.e. all objects are cached. Guidelines for setting this parameter: runtime objects can be quite large (e.g. 2MB is typical for a fairly large form) and Java heap memory is used for this cache, so large values for this parameter can take up a substantial amount of memory e.g. a value of 400 might use 800MB of memory which would be excessive in most cases. The intention should be to have as many commonly used forms and integration services cached as possible but not to allow this cache to exceed 25% of the available heap memory. Please note that when set template is used to dynamically change the presentation template used by a form, more runtime objects are required. The number of runtime objects for each form will then be (1 + n) where n is the number of different templates used. |
Batch Properties
|
Label |
Property Name |
Requires Restart |
Description |
|
Ufs.batchServlet |
No |
The URL of
the Batch server servlet. See Batch System. |
|
|
Ufs.XMLClientServlet |
No |
The URL of the XML client program used to process XML documents as part of batch processing. See Batch System. |