Component Specific Properties

Props (optional)

This topic describes the optional component-specific properties that you can specify in components.xml on page 603

Since InternalRoot parameters are used for communications behind firewall we recommend:

•

Do not use the HTTPS protocol

•

Use localhost or an explicit IP address instead of host name of your web server These recommendations may help to improve system performance.

Important: if you change the default port 8080 or use a host name other than localhost, please name sure that InternalRoot values are properly adjusted for each component.

Important: For any edition other than Free Evaluation, ExternalRoot must contain the HostName parameter as specified in license.xml. Otherwise, your license will be invalid.You cannot deploy Rollbase on a different domain than it was licensed for.

Important: We recommend to use the HTTPS protocol for external URLs, and the HTTP protocol for internal.

Default Value Description

Property Component

Time (in hours) 8 between checks that customers do not exceed their limits on resources usage (number of records, etc)

ResChecker MASTER

Number of days for 30 Free Trail to SaaS customers (if 0, no

"Free Trail" box will be displayed in sidebar and trials will have no expiration date) ExpirationDays

MASTER

Decimal number 1.0 between 0.5 and 2.0 indicating relative computational power of Production Server.

Server with higher power will get higher load loaded on this server) IsDedicated

PROD N

If the interval between 15 requests from RSS reader is shorter this value (in minutes), a cached version of the RSS feed will be sent MinRequestIntervalMins

RSS

Interval in minutes 10 between checks of status for Production Servers

StatusCheckInterval ROUTER

Coefficient used in 3 formula to calculate load on a particular Production Server (only used in Multi-server Edition)

CustWeight ROUTER

Default Value Description

Property Component

Interval in minutes to 10 synchronize cached

If true, every 5 minutes true send HTTP request to login page and check whether it is accessible CheckLoginURL

Remove metadata from 60 cache if it is not being used for specified number of minutes CloseAfterMin

Timeout (in sec) to 30 obtain lock for index writing

LockTimeoutSec SEARCH

Size of RAM buffer (in 64 MB) for indexing operations RamBufferMB

Max number of search 200 results to bring back for a single full text search MaxSearchResults Directory to store log

files, if log files should be kept in separate location

LogDir STORAGE

[%d] %m%n log4j format of log

messages.

LogFormat STORAGE

Determines how many 1 backup files are kept before the oldest is erased

MaxBackupIndex STORAGE

Default Value Description

Property Component

Delete log and backup 0 files older than

specified number of days (if specified value

> 0) CleanupDays

STORAGE

Close log4j logger after 30 number of minutes of inactivity

CloseAfterMin STORAGE

300KB Maximum size of

particular log file, such as main.log

LogFileSize STORAGE

1: log only important 2 messages 2: log all users' activity LogLevel

STORAGE

Max number of system 7 backup files to keep per customer (system will delete older files if this number is

exceeded) MaxSystemBackups

STORAGE

Interval in minutes 5 between checks to run matured delayed triggers.

EventCheckMins WORKFLOW

databases.xml

This XML file requires a Database node for each database used by your Rollbase Private Cloud system. Each database node should contain the following child elements:

Note: The Evaluation Edition does not support multiple databases.

Description XML Node/Attribute

Symbolic name for database, used internally Default:RB

name (attribute)

Marks database used by default for new Customers Default: None

isDefault (attribute)

Marks database which contains External data tables Default: None

isExternal (attribute)

Description XML Node/Attribute

Number of database connections initially created in this pool Default:MinConnections from shared.properties MinConnections

(attribute)

Max number of database connections in this pool Default:MaxConnections from shared.properties MaxConnections

(attribute)

Max time (in minutes) allowed database connection to be in use, connection will be closed when time is up

Default:MaxInUseConnTimeMins from shared.properties MaxInUseConnTimeMins

(attribute)

Max time (in minutes) allowed database connection in a pool to be idle, connection will be closed when time is up

Default:MaxNotUsedConnTimeMins from shared.properties MaxNotUsedConnTimeMins

(attribute)

Max connection lifetime before closure (in minutes)

Default:MaxConnLifetimeMins from shared.properties MaxConnLifetimeMins

(attribute)

Timeout (in seconds) used when new database connection is created Default: None, uses database default

ConnTimeoutSec (attribute)

Consult your database manual regarding Transaction Isolation level, if not sure about this setting - do not use it (database default)

TxIsolation

Enables or disables the default connection pooling's transaction recovery and retry feature

Omit this attribute. When using Oracle or SQLServer databases and DataDirect drivers, Progress recommends that customers use the driver's retry feature instead.

useTxRecovery (attribute)

Class name for JDBC driver used for this database Default:com.mysql.jdbc.Driver

Driver

JDBC URL to database's service

jdbc:mysql://localhost:3306/RB_DBO Url

Number of times the driver retries connection attempts to the database server until a successful connection is established.

Default:0 ConnectionRetryCount

(attribute)

Number of seconds the driver waits between connection retry attempts when the ConnectionRetryCount attribute is set to a positive integer Default:3

ConnectionRetryDelay(attribute)

Description XML Node/Attribute

Database user Default: account root DbUser

Password for user account

Default: None (must be specified prior to installation) Password

events.xml

This system file contains definitions for trigger types available in the system. Rollbase can provide more information to paying customers regarding how to develop and enable your own types of triggers for integration, etc. Progress recommends you do not modify this file unless you develop custom triggers.

Note: Custom Triggers developed by Private Cloud customers must be registered in events.xml Please see Custom Development Kit for details.

fieldgroups.xml

This file contains definitions for object attributes, such as Location. Each attribute comes with a group of fields. Experienced Private Cloud administrators can add their own object attributes here.

legacyobjects.xml

This system file contains definitions for system tables, which can also be treated as object records for reporting purposes. Rollbase can provide more information to paying customers on how to integrat legacy database tables. Progress recommends that you do not modify this file.

listitems.xml

This file contains a list of shared Picklist Items (countries, states, etc.) to be added to each tenant during Customer creation. You can modify this file.

license.xml

Rollbase will send you this file when you purchaseservices. Store this file in the config directory and restart your application server.

Warning: Altering the contents of this file will cause a system error.

securitylevel.xml

This file defines available Security Levels (see Chapter 11 for details). You can feel free to modify this file: change default levels or add more levels according to your security needs.

Each Security Level is represented by a SecurityLevel XML node with the following attributes shown in the example below. No default values exist, so make sure to set a value for each property.

Example:

Numeric unique ID for this level Level

Display name Name

Expire user session after being idle for a number of minutes

inactiveSessionExpireMins

Expire user session after a number of minutes from login

loginSessionExpireMins

Temporary block user account after a number of unsuccessful login attempts

maxFailedLogins

Block user account after unsuccessful login attempts for a number of minutes

blockTimeMins

Expire record's lock after a number of minutes lockExpirationMins

Minimum number of characters in users' passwords

minPasswordLength

If set to "true" - users' passwords must include at least one non-alphabetical character nonLettersInPassword

If set to "true" - users' passwords are case-sensitive (case-insensitive otherwise) caseSensitivePassword

If set to "false" - sequential numbers of letters are not allowed in users' passwords.

sequentialCharsInPassword

servicelevel.xml

This file defines available Service Levels. Service level is assigned to each customer at creation time. You can modify this file: change default levels or add more levels according to your business needs.

Each Service Level is represented by XML node with the following attributes (no default values are used):

Note: Note: The following values defined in Service Level used only as default values and can be overridden per individual Customer: maxUsers, maxObjRecords, maxObjectDefs, maxFieldDefs, maxPortals, maxApplications.

Description XML Attribute

Numeric unique ID for this level Level

Display name Name

Maximum number of User accounts which can be created

maxUsers

Maximum number of Object records which can be created

maxObjRecords

Maximum number of Object definitions which can be created

maxObjectDefs

Maximum number of Field definitions which can be created

maxFieldDefs

Maximum number of Portals which can be created

maxPortals

Maximum number of Applications which can be created

maxApplications

Maximum number of API hits per 24 fours maxApiHitsDaily

Maximum size of locally stored files (in MB) maxStorageMB

Maximum number of foreign languages which can be assigned to customer (from 0 to 4) maxForeignLangs

Maximum number of delayed triggers for 24 hours

maxDelayedEvents

shared.properties

This file stores system-level properties to be shared among all Rollbase components. Each property is placed on a separate line in the following format:

key = value

The table below lists all available properties and their default values. A few important properties to note:

•

The HostName property defaults to localhost:8080To use a different host name or port, adjust this property accordingly, or your server will not start.

•

The shared.properties file uses ISO-8859-1 encoding. If you wish to include multi-byte characters in this file use Unicode \u notation such as: \u00A9 for a copyright symbol.

Description Property

Email address of the first Administrator user created during installation

Default: None (must be specified prior to installation) AdminEmail

Email address used as reply-to when no other address is provided

Default: same value as AdminEmail AutoReplyAddress

URL to Fusion Charts folder Default:../Charts/

Charts

Interval in minutes between cleanup operations on each component

Default:60 CleanupMins

Default: None Copyright

Index of date/time format used when no selection is made or available, use a type supported by Rollbase

Default: US date/time format DefaultDateFormat

ISO language code used by default (when no language selection is made or available)

Default:en (English) DefaultLangCode

URL to Documentation Page: if not set, "Documentation" menu is not displayed

Defalt: None DocumentationURL

Email address to receive emergency notifications when an system component is unavailable, number of threads or database connections exceeds a threshold, or another serious error occurs.

Default: copied from AdminEmail property EmergencyAddress

Directory where system fonts are stored, used by PDF Converter (see below)

Default: None FontDirectory

URL to Forum Page, if not set, "Forums" menu is not displayed Default: None

ForumURL

Description Property

Google Application name to access Google Calendar and Docs (Spreadsheets), preferably have the format

[company-id]-[app-name]-[app-version]

Default:{!SystemName}- {!SystemName}-1 GoogleApplicationName

Host name of your Master Server Default:localhost:8080 HostName

Time of user's inactivity (in minutes) before user session expires Default:240

InactiveSessionExpireMins

Link to "Privacy Statement" page on your website to be rendered at the bottom of each page

Default: None (no link is rendered in this case) LinkPrivacy

Link to "Security Statement" page on your website to be rendered at the bottom of each page

Default: None (no link is rendered in this case) LinkSecurity

Link to "Terms of Service" page on your website to be rendered at the bottom of each page

Default: None (no link is rendered in this case) LinkTerms

Time from user's login (in minutes) before user session expires.

Default:480 LoginSessionExpireMins

Host name of mail server used for outgoing emails Default: None, but requires a value

MailHost

Password for MailUser account Default: None

MailPassword

Port used to access mail server Default:25

MailPort

User name on mail server used for outgoing emails Default: Copied from AdminEmail, which is required MailUser

If true, use SSL to access mail server Default:false

MailUseSSL

Description Property

Max number of AJAX API calls per user login session 1000

MaxAjaxPerSession

The system will send a message to admin if number of database connections exceeds this value

Default:90 MaxAlarmConnections

The system will send a message to admin if number of Java threads exceeds this value.

Default:200 MaxAlarmThreads

Max size of email attachment in KB Default:2048

MaxAttachmentSizeKB

Max number of object records cached by servers. If set to 0, no caching is enabled.

Default:1000 MaxCachedEntities

Maximum number of columns displayed in charts Default:1000

MaxChartCols

Max number of database connections in each connection pool.

Default:100 MaxConnections

Max connection lifetime before closure (in minutes) Default:60

MaxConnLifetimeMins

Max size (in chars) of long text fields (CLOBs) to be stored in the database

Default:80000 MaxDbLongStrLength

Max number of triggers to be executed for delayed updates Default:20

MaxDelayedTriggers

Max number of email attachments.

Default:3 MaxEmailAttachments

Max size of email message body in KB Default:2048

MaxEmailBodyKB

Description Property

The maximum number of emails to enqueue and send asynchronously. When the emails in the queue reach

MaxEmailQueueSize, new emails will be sent synchronously and will not be enqueued. A value of 0 causes all emails to be sent synchronously.

Default: 100 MaxEmailQueueSize

Max number of report rows to be exported as spreadsheet and max number of items in drop-down lookup. Important: for Oracle database this value cannot exceed 1000

Default:1000 MaxExportRows

Max size in KB for upload files.

Default:5120 MaxFileSizeKB

Max number of filters for Views.

Default:5 MaxFilters

Max size (in characters) of parsed formula. This size is checked before sending formula to JavaScript Engine.

Default:10240 MaxFormulaSize

Max size (in chars) of HTTP parameters processed by the system.

Default:80000 MaxHTTPParamLength

Max time (in minutes) allowed database connection to be in use.

Connection will be forced to close after that.

Default:30 MaxInUseConnTimeMins

Max elapsed time for server-side JavaScript formula engine per formula in ms (formula will be aborted afterwards).

Default:3000 MaxJSTimeMs

Max number of columns with totals in Views and Reports Default:3

MaxListTotals

Max time (in minutes) allowed database connection in a pool to be idle. Connection will be closed after that.

Default:30 MaxNotUsedConnTimeMins

Maximum number of characters in query sent to Query API Default:2000

MaxQueryLength

Description Property

Maximum number of recurrent calendar events Default:300

MaxRecurrEvents

Maximum number of records which can be selected in View or fetched by SQL query

Default:20,000 MaxReqsInQuery

Max number of triggers to be executed for non-delayed updates.

Default:100 MaxRuntimeTriggers

Max number of conditions to be used in Detailed Search component.

Default:20 MaxSearches

Max time to run a group of triggers ON_AFTER_UPDATE etc.

Default:30000 (30 seconds) MaxTimeToRunTrigMS

Max time in minutes allowing database transaction to run (will be rolled back after that)

Default:10 MaxTransactionTime

Number of database connections initially created in each connection pool.

Default:1 MinConnections

Minimum allowed recursion interval for triggers and Batch Jobs:

•

1: day (24 hours)

•

4: hour

•

5: minute 1 Default:1 MinRecursType

Purge deleted records from the Recycle Bin after specified number of days

Default:30 PurgeAfterDays

Set this flag to true if you use server for development work only.

This will eliminate waiting time when deleting applications and objects.

Default:false ShowDebugInfo

Description Property

Do not send email messages but dump them on standard output instead. Use this option for development version when to outbound email is available.

Default:false SkipEmails

Interval in minutes between status checks on each component.

Default:5 StatusCheck

Displayed in upper-left corner of each page as a link to your web site.

Default: Rollbase SystemName

URL to be invoked when "Subscribe Now" button is clicked (this button is displayed on sidebar for trail customers)

Default: None ("Subscribe Now" will redirect to Support Portal if this setting is not filled)

SubscribeNowURL

Template for page's title. Can be overridden by ISV partners.

See Chapter 17 for more info.

Default:{!A} | {!S} | {!P}

TitleTemplate

Unload customer from cache after period of time (in minutes) Default:60

UnloadCustAfterMins

Use links to DOCX files from "Rollbase in Action"

Default:true UseDocxHelp

Enable search by distance from ZIP/Postal code. Enabling this setting requires that RB_ZIP_CODES table be populated with actual data - not supplied with Private Cloud

Default:false UseZipSearch

HTTP URL to root of your web site Default:http://HostName WebSiteHTTP

HTTPS URL to root of your web site Default:https://HostName WebSiteHTTPS

In document Installing and Configuring Private Cloud (Page 32-46)