Ebase Initialization
Parameters
The Ebase Server has a single
parameter file named UFSSetup.properties which is in folder web application
root/Web-inf/classes. To implement changes, stop and restart the Ebase web
application or the application server. Startup parameters for the Ebase
Workflow system are documented here.
Ufs.cache.mapping.MaxDiskSpace
Ufs.cache.headless.MemorySpace
Ufs.cache.headless.MaxDiskSpace
Ufs.defaultPrintPageOrientation
Ufs.installationPreferencesFileName
Ufs.parameterSubstitutionString
Ufs.presentationBorderSurround
Ufs.skipBrowserAttributesCheck
Ufs.useUserManagerForDesignerAuthentication
Workflow.processAttributesCacheSize
The number of milliseconds to delay
before taking away a tooltip.
The number of milliseconds to delay
(after the cursor has paused) before displaying the tooltip.
The number of milliseconds before the user has
to wait initialDelay milliseconds before a tooltip will
be shown. That is, if the tooltip is hidden, and the user moves into a region
of the same Component that has a valid tooltip within the reshowDelay number of milliseconds the tooltip
will immediately be shown. Otherwise, if the user moves into a region with a
valid tooltip after the reshowDelay
number of milliseconds, the user will have to wait an
additional initialDelay milliseconds before the tooltip is
shown again.
Specifies
the absolute or relative directory where security audit log files are created.
(See Ufs.retainOldAuditLogs)
Specifies the name of the security audit log file. (See Ufs.retainOldAuditLogs)
Specifies the class to be used for the authorization manager component. (See Ebase Security Authorization for more
information)
Specifies the default setting for
browser back button support. Can have value true
or false. The default is false. See back button support for more details.
The URL of the
Batch server servlet.
The name of the
datasource in the J2EE application server for the Ebase repository database.
The default is UFSREPOSITORY.
The format that dates are entered and displayed in the Ebase
Designer. This format applies to all dates entered via the Ebase Designer
including default values, date constants in FPL scripts. Changing this
parameter may also entail changing forms and scripts if date values have been
used as default values or in scripts. At runtime, date fields are formatted
based on the formatting language (See date
fields for more information).
The following formats can be specified:
The default is dd/mm/yyyy and this will be applied if
a format other than those above is specified.
The JDBC driver for the Ebase
repository database if JDBC connection pooling is not used (parameter
Ufs.useConnectionPooling=false). Examples:
Ufs.dbDriver=org.gjt.mm.mysql.Driver
Ufs.dbDriver=oracle.jdbc.driver.OracleDriver
The password for the Ebase
repository database (parameter Ufs.useConnectionPooling=false).
The database URL for the Ebase repository
database if JDBC connection pooling is not used (parameter
Ufs.useConnectionPooling=false). Examples:
Ufs.dbURL= jdbc:mysql://localhost/ufs?autoReconnect=true
Ufs.dbURL= jdbc:oracle:thin:@ebt009:1521:ORCL
The User ID for the Ebase
repository database (parameter Ufs.useConnectionPooling=false).
This property has been
disabled. Set the
default language with Ebase Designer's internationalization
dialog.
This is the master page which will be used for all newly
created print forms. This can be overridden at the individual print form level
or at the print page level. For example:
Ufs.defaultMasterPageName=SCHOOLMEALS
This is the page orientation which will be used for all
newly created print forms. This can be overridden at the individual print form
level or at the print page level. For example:
Ufs.defaultPrintPageOrientation=Landscape
This is the page size which will be used for all newly
created print forms. This can be overridden at the individual print form level
or at the print page level. For example:
Ufs.defaultPrintPageSizeName=A5
Specifies the
hostname or IP address of the email SMTP server.
The base directory location into
which the system elements will be written to when using the directory export
facility. If the value is absent, the directory export and import functionality
will be disabled.
This is used by the remote file browser to specify the root
directory on the server that may be accessed from the Ebase Designer. This is
used to reference or upload images, PDF documents and other web resources. It
should normally be set to point to the root of the Ebase web application, for
example:
Ufs.fileAccessRoot=C:/ufs/UfsServer/tomcat/webapps/ufs
The directory
into which any saved files are written. The default is ‘=c:/ufs/UfsServer/generatedfiles’
Specifies ‘true’ or ‘false’ to
indicate whether the HTML form tag should include the Ebase form and all
included JSP and HTML included panels (true), or just the Ebase form (false).
This value acts as a system wide default and can be overridden for individual
forms by specifying an HTML form tag position in the General tab of the Form
Properties dialog box for the form. If not specified, the default is false.
The recommendation is to specify
true for this parameter, unless your installation uses JSP and/or HTML
panels that need to include their own <form> tags. The HTML specification
does not allow the nesting of <form> tags, so if your installation uses
JSP and/or HTML panels that include their own <form> tags, false
must be specified.
(See Interacting with an Ebase Form from a Panel
for more information)
Allows
configuration of the default holidays used by the organizational
calendar.
The prefix to
insert before the datasource name when performing a lookup using the naming
service. This parameter is only required if the application server uses
a non-standard naming convention. (See How Ebase Accesses Database for
more information)
Specifies the
file name of the installation preferences file. This file contains a
list of allowable fonts and colors which can be selected using the Ebase
Designer. Note that forward slashes must be used on a Windows system.
Backslashes should not be used. (See Setting
Installation Preferences for more information)
The prefix to
insert before the datasource name when performing a lookup using the naming
service. This parameter is only required if the application server uses
a non-standard naming convention. (See How Ebase Accesses Database for
more information)
=C:/ufs/Ufsserver/tomcat/webapps/ufs/preferences/ldap_attributes.xml
(See Extracting
LDAP Attributes for more information)
Specifies the URL that is used to complete relative URLs to retrieve images and stylesheets when generating PDF documents using outputpage or form.generatePdf(). This property should be set when the Ebase server is configured to run behind a firewall or webserver and PDFs are missing images or styles. See Designing Print Pages for more information regarding this property.
Specifies
the absolute or relative directory where log files are created. See also Ufs.retainOldLogs.
Specifies
whether or not Ebase error messages are written to the log. This should
always be set to true.
Specifies the name of the log file. See also Ufs.retainOldLogs.
Specifies
whether or not Ebase information messages are written to the log. This
should normally be set to false.
Specifies the
name of the login module entry. (See Ebase Security Authentication
for more information)
Specifies the relative URL of
the servlet or JSP used to handle logons. (See Ebase Security Authentication
for more information)
Specifies the maximum number of iterations
within an FPL loop/endloop construct (excluding loop at table). The default value is 10,000.
The FPL upload command and API WebForm.uploadFileFromBrowser() method allow files to be uploaded from
a user’s machine to the Ebase Server. This sets the maximum size of that file and the default is 1M
Specifies the hostname or IP address of the MQSeries server.
Specifies the
default MQSeries listener port.
Specifies the type and standard of the rendered browser output; this is included in DOCTYPE tag at the top of the generated output. This setting can be overridden for individual forms by setting the appropriate parameters in form properties (presentation tab). Specify one of the following:
|
HTML4_TRANS |
HTML output to the transitional standard of
HTML4. This is the default. |
|
HTML4_STRCT |
HTML output to the strict standard of HTML4 |
|
HTML5 |
HTML output to the HTML5 standard (may
give problems with older browsers) |
|
XHTM1_TRANS |
XHTML output to the transitional standard of
XHTML1 |
|
XHTM1_STRCT |
XHTML output to the strict standard of XHTML1 |
Specifies whether
or not the parameters entered in the security maintenance dialog encryption
panel are themselves further encrypted prior to being saved in the database.
Specifies the string
that Ebase recognizes as a substitutable variable in messages and external
resources. The default value is && and should not
normally be changed.
Ufs.pdfDirectoryName
The directory into which any saved PDF print forms
are written. This must be supplied if the PDFPRINT SAVE facility is to be used.
Starting from Ebase Version 4.0, this parameter is deprecated. An equivalent result can be achieved by adding style of “border:inset 1px;” to the page content property of the page control on a page. This styling can also be applied as a default by setting the same property in the presentation template.
The operating
system directory in which all system and user fonts are defined. In
Windows XP, this is typically C:/WINDOWS/fonts. This
is required for all print design activities. When multiple directories are
specified, these should be separated with a | character.
Specifies whether or not the proxy server requires authentication. Possible values are true or false; the default is false. If true is specified, Ufs.proxyUserName and Ufs.proxyPassword should also be specified. This is used for any HTTP requests initiated by the Ebase server, including Web Services and XML Resource operations. See also parameters Ufs.proxyHost, Ufs. proxyPort, Ufs.proxyUsername, Ufs.proxyPassword. Note that the corresponding proxy settings for the Ebase designer are configured from the Designer Preferences Dialog.
The hostname of the proxy server. This is used for any HTTP requests initiated by the Ebase server, including Web Services and XML Resource operations. See also parameters Ufs.proxyPort, Ufs.proxyAuthentication, Ufs.proxyUserName, Ufs.proxyPassword. Note that the corresponding proxy settings for the Ebase designer are configured from the Designer Preferences Dialog.
The port of the proxy server. This is used for any HTTP requests initiated by the Ebase server, including Web Services and XML Resource operations. See also parameters Ufs.proxyHost, Ufs.proxyAuthentication, Ufs.proxyUserName, Ufs.proxyPassword. Note that the corresponding proxy settings for the Ebase designer are configured from the Designer Preferences Dialog.
The user name used to authenticate against the proxy server. This is only used when Ufs.proxyAuthentication is true. This is used for any HTTP requests initiated by the Ebase server, including Web Services and XML Resource operations. See also parameters Ufs.proxyHost, Ufs. proxyPort, Ufs.proxyAuthentication, Ufs.proxyPassword. Note that the corresponding proxy settings for the Ebase designer are configured from the Designer Preferences Dialog.
The password used to authenticate against the proxy server. This is only used when Ufs.proxyAuthentication is true. This is used for any HTTP requests initiated by the Ebase server, including Web Services and XML Resource operations. See also parameters Ufs.proxyHost, Ufs. proxyPort, Ufs.proxyAuthentication, Ufs.proxyUsername. Note that the corresponding proxy settings for the Ebase designer are configured from the Designer Preferences Dialog.
Specifies true or false
to indicate whether or not old security audit log files are kept. If true, a new log file is
created each time the Ebase Server is started. A timestamp is appended to the
name of the log file specified for Ufs.auditLogFileName.
If false, a single log file is used as specified in Ufs.auditLogFileName.
Specifies true or false
to indicate whether or not old log files are kept. If true, a new log file is
created each time the application server is started. A timestamp is appended to
the name of the log file specified for Ufs.logFileName.
If false, a single log file is used as specified in Ufs.logFileName.
The number of seconds the
scheduler waits before re-activating its scan for executable tasks. The default
is 600.
When set to true, 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, cookies and
stylesheets. When set to true, the browser is presumed to have support
for all three of these, and if this is not the case, runtime errors will occur.
This setting can sometimes be used to resolve problems when
Ebase is being used within a CRM or CMS system where the Ebase 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.
Specifies the
Ebase Server operation mode. Supported values are:
Test: 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 diagnostic form runtime error messages.
Prod: use this
mode for production systems. The standard error HTML page for the Ebase web
application is displayed when a form execution error occurs – the diagnostic
runtime error message is not displayed.
Specifies the
name of the system. This is displayed in the title bar of the Ebase Designer.
The name used to look up a JTA UserTransaction from the application server’s naming service. The default is "java:comp/UserTransaction". This parameter is only required if the application server uses a non-standard naming convention.
Specifies the timeout period of the JTA UserTransaction in seconds. The default value is 0 which does
not override the UserTransaction timeout period. This parameter is only
required if the application server uses Jotm Transaction Manager and multiple
web applications are deployed within the application server.
Specifies the directory on the
Ebase Server used to store the xml files for data exported from the Ebase
Designer. Note that forward slashes must be used on a Windows system.
Backslashes should not be used.
Specifies the types of files 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. (See Working with Files for more information)
Specifies
whether or not to use JDBC2 connection pooling. This should be set to true in all but exceptional circumstances.
Specifies the class to be used for the authentication manager component. (See Ebase Security – User and Group Maintenance
for more information)
When set to
true (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.
When set to true, authentication of designer users
will be performed against the implemented UserManager component. This parameter
makes possible the scenario where runtime users are defined in an external user registry
system, but designer users are defined in the supplied Ebase Security
System. (See Ebase Security
Authentication for more information)
The URL of the XML client program used to process XML documents as part of batch processing.
The maximum number
of jobs whose process attribute values are cached in memory. Setting this to -1
disables the workflow process attributes cache. This cache can be an important
factor in maintaining consistently good responses for a workflow task list
application. See optimizing
workflow tasklist performance for more information.
This parameter acts as the master switch to
initiate an automatic upgrade between Ebase versions. Set to true
to initiate the upgrade. Otherwise set to false.