Shared Properties

This file stores system-level properties to be shared among all Platform 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:8080 To use a different host name or port, adjust this property accordingly, or your server will not start.

Access the Shared Properties tab from the Application Switcher > System Console > System define, modify or view the below properties

Alternatively, you can use the below search box to find more details on any shared property.

Shared Property Description
Generaltop
Platform Property
HostName Host name of your master server.
  • Default for Tomcat: localhost:8080

  • Default for PAS: localhost:8830

To use HTTPS for access, the default port numbers are 8081 and 8831, respectively.

This property appears as a property for a instance that has no licensing information and needs a restart. For a licensed instance, the HostName appears in the Control Panel > General > License and Usage
TitleTemplate The template for a page's title. Can be overridden by ISV partners. See Creating and managing customer tenants for more information.
  • Default value:{!A} | {!S} | {!P}

DefaultLangCode ISO language code used by default (when no language selection is made or available)
  • Default value: en (English)

DefaultDateFormat Index of date/time format used when no selection is made or available, use a type supported by
  • Default value: US date/time format

TimeZones A comma-separated list of time zones. If required, add to this list any TimeZone IDs which are a part of TimeZone.getAvailableIDs().
  • Default value: None

Encodings Encoding support for comma-separated list files.
  • Default value: ISO-8859-1,US-ASCII,UTF-8

CustWeight

The coefficient to be used in a formula to calculate load on a particular production server (only used in multi-server edition).

  • Default value: 3.

HazelcastBackupCount

The number of synchronous backup copies made for MASTER/PROD data cache entries across other members of the master/prod cluster members. Set this to 0 if performance is a priority and no backup is required.

  • Minimum value: 0
  • Maximum value: 3
  • Default value: 1

Any changes to this shared property requires a Platform cluster restart.
HazelcastGlobalBackupCount

The number of synchronous backup copies made for global cache entries across other members of the global cluster members. Set this to 0 if performance is a priority and no backup is required.

  • Minimum value: 0
  • Maximum value: 6
  • Default value: 1

Any changes to this shared property requires a Platform cluster restart.
CustomClassFilter

You can use custom Java objects (available on CLASSPATH) in formulas. This property lets you specify the classes to allow in formulas. Specify a RegEx expression that matches classes you want to allow. For example, if you want to use a variable of the type java.util.ArrayList(), you would include the entry CustomClassFilter=java.util.ArrayList.

See http://www.w3schools.com/jsref/jsref_obj_regexp.asp for more information about RegEx expressions.

JSOptimizationLevel Optimization makes the compiler attempt to improve the performance and/or code size at the expense of compilation time and possibly the ability to debug the program.

Simple data and type flow analysis is performed to determine which JavaScript variables can be allocated to Java VM registers, and which variables are used only as Numbers. Local common sub-expressions are collapsed (currently this only happens for property lookup, but in the future more expressions may be optimized). All local variables and parameters are allocated to Java VM registers. Function call targets are speculatively pre-cached (based on the name used in the source) so that dispatching can be direct, pending runtime confirmation of the actual target. Arguments are passed as Object/Number pairs to reduce conversion overhead.

See https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Optimization for detailed information.

UnloadCustAfterMins Unloads the customer from the cache after period of time (in minutes).
  • Minimum value: 30
  • Maximum value: 2147483647
  • Default value: 60

CloudType When set to AWS the cloud instance type information is retrieved and displyed in System Console > Servers Tab.
  • Default value: Default

  • You should set the value to AWS only if is deployed on AWS.
  • When set to Default, the cloud instance type information is not fetched.

Add/Remove Features
AllowAdminLessTenant When set to true, this property enables tenants without administrative users. Does not apply to the master tenant.
  • Default value: false

GettingStartedEnabled

When set to false, this property makes the Getting Started component unavailable in the page editor.

  • Default value: true

If any of your pages use the Getting Started component, you must manually remove the component and save the page using the page editor for the Getting Started component.
SupportCorticonService

Support managing Corticon service integration in . When set to false, the service is not supported.

  • Default value: true.

SupportHDP

Support for managing Hybrid Data Pipeline objects in . When set to false, the service is not supported.

  • Default value: true.

SupportOEService

Support for managing OpenEdge service objects in . When set to false, the service is not supported.

  • Default value: true.

SupportRemoteDatabase

Support for external tables in a remote database that is not used as the database. When set to false, the service is not supported.

  • Default value is true

SupportProgressDataCatalog

Support for managing Progress Data Catalog for Telerik/Mobile app integration. When set to false, the service is not supported.

  • Default value: true.

AllowMultipleRestSessions When set to true, this property enables multiple REST API sessions per user. That is, can create multiple concurrent sessions for the same user and process the REST API calls from all the sessions.
  • Default value: false

IsPDFAnnotationEnabled When set to true, the Enable PDF Annotation checkbox associated with the File Upload field is visible to enable the PDF editor function on the PDF files.
  • Default value: true

AppInstallOverridesChanges At customer tenant creation, controls whether conflicting application changes will be ignored or will override the existing component. The Customer record contains a list of applications that will install automatically. These applications are installed in the order in which they appear in that list. If an application contains a component that already exists, this property determines whether conflicting changes will be applied(true) or ignored (false). Additive changes are always applied. For more information, see Installing applications in new tenants automatically.
  • Default value: false

SkipEmails

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

  • Default value: false

EmailSettingsOverrideAtCustomer When set to true, this property enables you to set up a custom email server for your tenant. This property makes available Email Server Settings in the Administration setup page.
  • Default value: true

CheckLoginURL Enables system health check and sends status emails to admin if health check fails.

If set to false, the system health check is disabled.

  • Default value: true

server code pings itself on its login URL, periodically, to monitor the system's health. That is, it checks the accessibility of the login page.

For this, you must ensure that the router component's external URL is accessible from master component and firewall/network settings are configured to allow this health check.

SysRepGeneration Generates a usage report for all the customers. If unchecked, user's data is not collected.
  • Default value: true

IsAsposeDocParserEnabled Enables you to use Aspose Parser for all Word documents with doc extension. This shared property is accessible only if aspose jars are available in the Rollbase lib directory.
  • Default value: false

See Working with customer records for more information.

IsAsposeDocxParserEnabled Enables you to use Aspose Parser for all Word documents with docx extension. This shared property is accessible only if aspose jars are available in the Rollbase lib directory.
  • Default value: false

See Working with customer records for more information.

IsMaxStorageCheckEnabled Checks for the storage used by the customer(s) against the maximum storage allotted on performing Update Usage Stats operation. This restricts further file uploads if the storage limit exceeds the maximum storage allotted.
  • Default value: true

ShowPaginationControlAtTop

Shows a pagination control in the List View at the top for all tenants. As this property is managed by the System Administrator, if enabled, all the Tenant Administrators and USERS cannot disable this property at their instance.

  • Default value: false

LoadOnlyOnDedicatedServer

Enables the customer(s) to be loaded only on a dedicated production server.

  • Default value: false

UseGraalJS

Enable/Disable Graal JS engine in the . This is a boolean (checkbox) property.

  • If checked or set to true, Graal JS support is enabled at level and tenant administrators can choose the JS engine to run their java script against.

  • If unchecked or set to false, Graal JS support is disabled at level and forces the java script to run against Rhino JS engine.

  • Default value: false.

SkipUniquePicklistCodesCheck

Skips validating duplicate integration codes as Labels or picklist values remain unique within picklist fields.

When set to true, any code or values associated with the picklist are no longer reiterated and thus no error is thrown for duplicate or improper entries.

See Picklist Field for more information.

  • Default value: false

RateLimitSettingsOverrideAtCustomer

Allows tenants to access the Rate Limits Settingssection only if the shared property.

  • Default value: true

Security Property
PasswordActivationLinkExpiry Set the password expiration time in hours for reset password link for existing users request to reset password.
  • Default expiry time of the link: 2 hours

NewUserPasswordActivationLinkExpiry Set the password expiration time in hours for new user activation link to expire.

Minimum: 1

  • Default expiry time of the link: 2

.
DataServiceCORSHost

Specifies the online address of the Progress Telerik host. This enables Telerik applications to access services.

  • Defaults to .*.(Progress|icenium|telerik).com$

IsSecureServer Determines the security protocol for all communications between your browser and the website.
  • Default value: false

Any changes to this shared property requires a Platform cluster restart.
EnableSecureServerHSTS

Enables the HSTS setting at the instance level.

  • Default value: max-age=15811200; includeSubDomains"

This setting works alongside the IsSecureServer option and should only be enabled when the Platform instance does not have the capability, instead set the HSTS option via any load balancer.
Any changes to this shared property requires a Platform cluster restart.
System Jobs Property
CleanupMins

Interval in minutes between cleanup operations on each component

  • Minimum value: 10
  • Maximum value: 180
  • Default value: 60

Any changes to this shared property requires a Platform cluster restart.

 

PurgeAfterDays Purges deleted user login records from the Recycle Bin after the specified number of days
  • Default value: 30

PurgeRecordsBatchSize Indicates the batch size of records to be purged from the Recycle Bin in a single transaction.
  • Default value: 100

StatsCollect The time frequency with collects tenant statistics, stores them into backend and notifies about its execution.
  • Default value: 3 minutes

Any changes to this shared property requires a Platform cluster restart.
StatusCheck Interval in minutes between status checks on each component.
  • Default value:5 minutes

Any changes to this shared property requires a Platform cluster restart.
WebProxyStatusCheck Denotes the interval in seconds between status checks on each Web Proxy configured in . A periodic thread runs during the configured interval and keeps pushing the current upstream topology to each of the configured Web Proxy.
  • Default value: 30 seconds

  • Any change to this shared property requires a cluster restart.
  • For example, a Web Proxy is an NGINX server added in .
Any changes to this shared property requires a Platform cluster restart.
EventCheckMins Interval in minutes between checks to run matured delayed triggers.
  • Default value: 1 minute

Any changes to this shared property requires a Platform cluster restart.
CleanupDays Delete log and backup files older than specified number of days (if specified value > 0).
  • Default value: 0

BatchJobsExecutorThreadCount

Enables multiple threads to process batch jobs for different customers. While only one job for any given customer will be running at any point of time, multiple jobs for different customers can run in parallel based on the number of threads configured. Set a value (1 to 50) for the thread count for the Executor Service that runs the batch jobs.

  • Minimum value: 1
  • Maximum value: 50
  • Default value: 1

Configuring the BatchJobsExecutorThreadCount property to 50 is not recommended, as it might render the system unstable.
Any changes to this shared property requires a Platform cluster restart.

 
DelayedTriggersExecutorThreadCount

Indicates the number of threads that are available for concurrent processing of delayed (matured) triggers from the queue.

  • Minimum value: 1
  • Maximum value: 30
  • Default value: 1

Any changes to this shared property requires a Platform cluster restart.

 

ImportJobsExecutorThreadCount

Enables the customers to set the thread count of the import job scheduler that runs import jobs simultaneously. Set a value (1 to 10) for the thread count for the import job scheduler that runs the import jobs.

  • Minimum value: 1
  • Maximum value: 10
  • Default value: 1

Any changes to this shared property requires a Platform cluster restart.
StorageJobsExecutorThreadCount

Enables the customers to set the thread count of the storage job scheduler that runs storage jobs simultaneously. Set a value (1 to 10) for the thread count for the storage job scheduler that runs the storage jobs.

  • Minimum value: 1
  • Maximum value: 10
  • Default value: 1

Any changes to this shared property requires a Platform cluster restart.
LargeDataReadJobsExecutorThreadCount

Enables the customers to set the thread count to execute large data read jobs simultaneously. Set a value (1 to 10) for the thread count to execute large data read jobs.

  • Minimum value: 1
  • Maximum value: 10
  • Default value: 1

For more information, see Multi-threaded Report/Export Jobs.

Any changes to this shared property requires a Platform cluster restart.
ResourcesCheck The amount of time (in hours) to wait between checking that customers have not exceeded their limits on resource usage (number of records, etc).

Default value: 1

Any changes to this shared property requires a Platform cluster restart.
MonitoringTablePurge

Clean up background job processing history records after the given nummber of days from completion day of the records.

No limitations on minimum and maximum values.

If value is > 0 then cleanup process for the records is initiated, else no cleanup is initiated.

  • Default value: 30

MonitoringStoragePurge

Clean up background job processing history files after the given number of days from the creation day the file in storage.

No limitations on minimum and maximum values.

If value is > 0 then cleanup process for the stored files is initiated, else no cleanup is initiated.

  • Default value: 7

Email Property
AdminEmail Email address of the first administrator user created during installation

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

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

Default value: same value as AdminEmail

EmergencyAddress 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 value: copied from AdminEmail property

MailTimeoutSec The number of seconds before gives up when trying to connect to the mail server. This property is only valid for SMTP and Gmail. The value will be ignored for Exchange.

Default value: 5 seconds

EmailEncodings Determines the supported email encodings. Its value is a comma-separated list of encodings with the default encoding as the first item in the list. Defaults to UTF-8,ISO-8859-1,US-ASCII, with UTF-8 as the default encoding. To override the default, set the value to a comma-separated list of encodings with the encoding you want as the default as the first item in the list, for example, ISO-8859-1,UTF-8,US-ASCII.
Search Property
MaxSearches Maximum number of conditions to be used in a Detailed Search component.
  • Default value: 20

MaxSearchResults Max number of search results to bring back for a single full text search.
  • Default value: 200

MaxClauseCount Maximum number of clauses permitted per lucene search query.
  • Minimum value: 1
  • Maximum value: 2147483647
  • Default value: 1024

Any changes to this shared property requires a Platform cluster restart.
UseZipSearch 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 value: false

IndexChangeSyncDelaySecs Max time (in seconds) between an index change and it being visible for search.
  • Default value: 5 seconds

LockTimeoutSec

Timeout, in seconds, to obtain a lock for index writing.

  • Default value: 30 seconds

RAMBufferMB Size of RAM buffer, in MB, for indexing operations.
  • Default value: 64MB

CloseAfterMin Remove metadata from cache if it is not being used for specified number of minutes.
  • Default value: 60 mins

ElasticBulkIndexSize Number of records processed in each batch within an elastic server. This shared property is not applicable for lucene based search engine.
  • Default value: 1000

ElasticIndexBufferSize Size of Index buffer in each batch within an elastic server. This shared property is not applicable for lucene based search engine.
  • Default value: 100mb

Any changes to this shared property requires a Platform cluster restart.
ElasticRequestConfigTimeout Sets socketTimeout and MaxRetryTimeoutMillis of communication with the elastic server. See https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/_timeouts.html for more information on Timeouts.
  • Default value: 30000 ms

ElasticAnalyzerSplitTokenRegex Holds the regex to split the text fields whenever:
  • any of the following token is followed by a space
    .,?,!
  • any of the following token is present in the text field
    ,:;|_= -
  • Default value: [.?!][ ]|[,:;|_= -]

ElasticIndexAllFields

When enabled, non-indexable fields are also indexed on the elastic server.

  • Default value: false

IncludeAppContextInSearchResults

When enabled, includes application specific context for the data in the search results.

  • Default value: true

Log Property
EnableCustomLogging

When enabled, logging preferences can be configured by MASTER and TENANT administrators. See Logging Preferences for more details.

  • Default value: false

LogFormat The log4j format for log messages.
  • Default value: [%d] %m%n

Any changes to this shared property requires a Platform cluster restart.
LogFileSize Maximum size of particular log file, such as main.log.
  • Default value: 2MB

Any changes to this shared property requires a Platform cluster restart.
MaxBackupIndex Determines how many backup files are kept before the oldest is erased.
  • Default value: 5

Any changes to this shared property requires a Platform cluster restart.
Database Propertytop
HDP_URL Specifies the Hybrid Data Pipeline URL where all objects of type Hybrid Data reside. You can enable HDP integration on the provision of HDP URL in the formats mentioned below:
  • Default URL for Non-SSL:

jdbc:datadirect:ddhybrid://<host>:<port>;hybridDataPipelineDataSource
=<datasourcename>;encryptionMethod=noEncryption
  • Default URL for SSL:

jdbc:datadirect:ddcloud://<host>:<port>;hybridDataPipelineDataSource
=<datasourcename>;encryptionMethod=SSL;TrustStore=
<ddcloudTrustStore_jksfilelocation>
SQLSpecialChars A comma-separated list of SQL special characters of your database.

recommends that you verify and add any special characters in this property before generating SQL queries for external objects.

  • Default value: All the terms identified by SQL as a special character.

SQLKeywords It is a comma-separated SQL keywords of your database.

recommends that you verify and add any reserved keywords in this property before generating SQL queries for external objects.

  • Default value: All the terms identified by SQL as a keyword.

SQLBlacklistFunctions_MySQL

List of blacklisted MySQL Database functions that need to be restricted via SQL queries from Platform. The list can be extended and reduced by editing this shared property.

The function names must be specified as comma separated values, and no parentheses '()' must be used.
  • Default values: collation, database, current_user, current_role, system_user, and session_user.

  • Example: 'connection_id()' can be blacklisted by specifying it as connection_id in the list.

SQLBlacklistFunctions_MSSQL

List of blacklisted SQL Server Database functions that need to be restricted via SQL queries from Platform. The list can be extended and reduced by editing this shared property.

The function names must be specified as comma separated values, and no parentheses '()' must be used.
  • Default values: host_name, host_id, system_user, user_name, user_id, and original_db_name.

  • Example: 'connection_id()' can be blacklisted by specifying it as connection_id in the list.

SQLBlacklistFunctions_POSTGRE

List of blacklisted POSTGRE Database functions that need to be restricted via SQL queries from Platform. The list can be extended and reduced by editing this shared property.

The function names must be specified as comma separated values, and no parentheses '()' must be used.
  • Default values: current_database, current_query, current_user, and session_user

  • Example: 'connection_id()' can be blacklisted by specifying it as connection_id in the list.

Usage Analytics Propertytop
AnalyticsLogEnabled Creates an analytics log file at the default location:
<TOMCAT_HOME>/rollbase/log
It also prints additional information like Client IP, User Name, Customer ID, Customer Type, etc., around specific flows like Login, CREATE_CUSTOMER REST API, CLIENT_API_USAGE, METADATA SEARCH, ALL_OBJECTS SEARCH, SPECIFIC_OBJECT SEARCH etc. You can set this to true or false.
  • Default value: false

API Propertytop
UseISODateFormatInRESTJSON Enables all the REST API requests with JSON output format to return the date or date/time values in ISO format. You can set this to true or false.
  • Default value: true

For example:

  • If the date and time value is Mon Jul 30 00:01:00 IST 2018 its equivalent ISO formatted value 2018-07-29T18:31:00Z- is returned.
  • If the date value is Mon Jul 30 2018, its equivalent ISO formatted value 2018-07-30 is returned.
UseISODateFormatInRESTXMLQuery Enables all the REST SELECT query API requests with XML output format to return the date or date/time values in ISO format. You can set this to true or false.
  • Default value: true

For example:

  • If the date and time value is Mon Jul 30 00:01:00 IST 2018 its equivalent ISO formatted value 2018-07-29T18:31:00Z- is returned.
  • If the date value is Mon Jul 30 2018, its equivalent ISO formatted value 2018-07-30 is returned.
WhiteListForServerSideRESTV2

Enable users to add end points which are accessible by Server-Side API - rbv_api.invokeSystemRESTV2(). Users can add in two patterns category name and full endpoint url. Users can also add white listing endpoints on a new line.

For example:

/meta/* & /meta/roles

  • If user adds /meta/*, it allows all the endpoints in this meta category.

  • If the user adds only /meta/roles, the invokeSystemRESTV2() API allows only the /meta/roles endpoint for invocation.

Customizetop
User Interface Property
EnableNUIForAll Switches all tenants/customers to the new UI.

The new UI is not enabled for all tenants/customers by default. If an administrator wants to enable the new UI for all tenants/customers, this property must be added from Administration Set up > Preferences.

  • Default value: false

DefaultUIBlueprint Default UI blueprint use for Application during Application creation or for old Applications Blueprint is not set. There are two types of Blueprint support, Modern Blueprint and Vertical Blueprint. You can set this to true or false.

Default value: String.valueOf(UITemplates.UI_TEMPLATE_MODERN_VERTICAL.getType()

DisableNUIBanner Disable Banners shows for all evaluation users who had enabled NewUI support.
  • Default value: false

PacificUIDisabled Disable Pacific theme UI from setup pages, classic UI and from Page designer.
  • Default value: false

PdfFontFamily Add and configure more fonts to support different languages (For eg- Droid Sans Fallback for Chinese). You can update the value of 'PdfFontFamily' field with desired fonts in Setup Home > Administration Setup > Preferences. If a preferred font value is specified, it will be used to generate the pdf. Alternatively, if a preferred font value is not specified, then the value of the shared property will be used.

The font-family mentioned in this field is considered as the defualt font. Lato, Helvetica, Arial, Tahoma and sans-serif are available as default fonts.

IncludeShortCutIcons Check this option to include Fav, Touch & Tile icons for Desktop, Android & iOS touch devices. These icons will be displayed when user adds pages as Add to Desktop, Add to Home , Add to Favorites, Add to Bookmarks, Pin to Start Menu (Windows 10). By default, this option is disabled.

When you enable the IncludeShortCutIcons shared property on private cloud, ensure to copy the below icons in the <ROLLBASE_HOME>/personalize/images folder. These icons will be included for Application pages, Setup pages, Portal Pages, Market place & login pages.

As the name implies, the dimension for the icons ( width X height ) is suffixed to the icon name. Private cloud customers must design the icons according to the dimension of the icon name to ensure for a good quality image when pages are added as mentioned above.
  • favicon-16x16.png
  • favicon-32x32.png
  • favicon-96x96.png
  • favicon-160x160.png
  • favicon-192x192.png
  • mstile-150x150.png
  • apple-touch-icon-57x57.png
  • apple-touch-icon-114x114.png
  • apple-touch-icon-72x72.png
  • apple-touch-icon-114x114.png
  • apple-touch-icon-60x60.png
  • apple-touch-icon-120x120.png
  • apple-touch-icon-76x76.png
  • apple-touch-icon-152x152.png
  • apple-touch-icon-180x180.png
MSTileIconBGColor Microsoft Tiles color for Windows 10 and Windows phone. This shared property is applicable only when the IncludeShortCutIcons shared property option is enabled. Provide the value in a hexa-decimal format.
  • Default value: #da532c

MaxRecordsInSelector Configure the maximum number of records for selection based on the business need. The configured changes will be reflected in the ListView, Grid Control, Multi-select pick-list, record attach, ListView filters, Custom report filter fields of the New, Edit, Mass update, Quick Create and Status change pages.
  • Minimum value: 1
  • Maximum value: 99
  • Default value: 99

BootStrapVersion Choose a default bootstrap version for Application Pages. This bootstrap version can be changed at the application level in the App Setting Page.
  • Default value: v4.x

ShowAttachButtonForGridControl On enabling this shared property, Attach and Detach buttons are displayed in grid control. You can then select and deselect the records from the related object.
  • Default value: true

EnableUIConsoleLog On enabling this shared property, debug messages are logged in the browser console.
  • Default value: true

EnableApplicationCustomScript On enabling this shared property, the application pages display the custom script/HTML.
  • Default value: true

ShowNewBetaUITryoutLink On enabling this shared property, the application pages display the Try New Beta UI toggle.
  • Default value: true

EnableFusionTheme

When set to true, charts and gauges are rendered in fusion theme. If set to false, no theme is applied.

  • Default : false

EnableQuickFiltering

When set to true, enables the users to instantly filters the data using the fields in the list view of application runtime page.

  • Default : false

EnableAjaxFormSubmit

When set to true, enables submit object form page (Object Create/Edit, Mass Update, and Status Change) using Ajax.

When set to false, normal HTML form submit is invoked and the page is reloaded.

  • Default : false

HTML Editor Property
HideHtmlEditorMenu When set to true, this property hides the HTML editor menu bar.
  • Default value: false

HtmlEditorButtonRow1 Specifies the shortcut options of the first toolbar row (of the HTML editor) and its formatting. When this property is not set, this toolbar is disabled.
  • Default value: bold,italic,underline,

|,forecolor,backcolor,|

alignleft,aligncenter,

alignright,alignjustify,|,

bullist,numlist,|,outdent,

indent,blockquote,|

,undo,redo,|,link,unlink,|

,image,|,table,emoticons,

|,fontselect,fontsizeselect,

|,code,fullscreen,preview

HtmlEditorButtonRow2 Specifies the shortcut options of the second toolbar row (of the HTML editor) and its formatting. When this property is not set, this toolbar is disabled.
  • Default value: <blank>

Images Property
ImageWidthFormFactorLaptop This property is applicable only when customer enables Dynamic Image resize Settings from the Preferences page. When a user uploads image for ImageUpload field, generates various images for different devices on demand. This property applies to laptop or higher resolution devices. This property is expressed in pixels unit.
  • Default value: 992

ImageWidthFormFactorMobile This property applicable only when a customer enables Dynamic Image resize Settings from the Preferences page. When a user uploads image for ImageUpload field, generates various images for different devices. In this property, you can provide image size as pixel value in number format for smart phones.
  • Default value: 480

ImageWidthFormFactorTab This property is applicable only when a customer enables Dynamic Image resize Settings from the Preferences page. When a user uploads an image for ImageUpload field, generates various images for different devices. In this property, you can provide image size as pixel value in number format for Tablets.
  • Default value: 768

ImageWidthThumbnail This property applicable only when customer enables Dynamic Image resize Settings from the Preferences page. generates a thumbnail image for the uploaded image to render it in ListView Grid column. You can provide the size of image as pixel value in number format.
  • Default value: 50

CDN Propertytop
UseCdnForNewUI To enable CDN support in the NewUI and portal pages. When this property is enabled, user should provide a valid URL for KendoCdn, BootstrapCdn, FontAwesomeCdn, LatoFontCdn properties.
  • Default value: false

BootstrapCdn CDN URL to load Bootstrap library files. This is applicable only when user enable UseCdnForNewUI property.
  • Default value: Null

KendoCdn CDN URL to load kendo library files. This is applicable only when user enable UseCdnForNewUI property.
  • Default value: Null

FontAwesomeCdn CDN URL to load FontAwesome files. This is applicable only when user enable UseCdnForNewUI property.
  • Default value: Null

LatoFontCdn Google font URL to load Lato font css file. This is applicable only when user enable UseCdnForNewUI property.
  • Default value: Null

List of CDN Servers

As long as the CDN URL follows the expected pattern, you should be able to use it without any problems. The typical pattern is a base url followed by a version and then followed by the library name.

See CDN Support for more information.

The shared property contains only the base URL (ending with /) because several files can be served from this path for all CDNs except in the case of LatoFontCdn. You may choose to use any other CDN server(s) apart from the ones listed in this document.

Here's a list of tested CDNs:

Lato Font

http://fonts.googleapis.com/css?family=Lato:300,400,700&subset=latin,latin-ext

Kendo

Kendo CDN - http://docs.telerik.com/kendo-ui/intro/installation/cdn-service

The minified versions of all JavaScript files are available at:

Bootstrap

MaxCDN:

Cloudflare:

jsDelivr

JQuery

Google

MaxCDN

CloudFlare

jsDelivr

Microsoft

Yandex:https://yastatic.net/jquery/1.12.3/jquery.min.js

FontAwesome

MaxCDN:https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css

CloudFlare:https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css

jsDelivr:https://cdn.jsdelivr.net/fontawesome/4.7.0/css/font-awesome.min.css

White Label Property
SystemName In the Private Cloud evaluation version, this property sets the link displayed in the upper-left corner of each page. Typically, this link is set to navigate to your web site.

In the Private Cloud licensed version, this property is configured in license.xml file.

  • Default value: Rollbase

WebSiteURL URL to root of your web site
  • Default value: http://HostName or https://HostName. The default value depends on the protocol decided based on IsSecureServer and host_name by HostName shared properties set.

The WebSiteHTTP and WebSiteHTTPS shared properties have been replaced by the WebSiteURL shared property. Therefore, you must now use WebSiteURL for usecases such as redirecting to a website, custom header/footer link, and powered by button in portals.
Copyright Copyright string displayed on the bottom of each page.
  • Default value: None

ForumURL URL to forum page; if not set, the Forum menu is not available in the menu.
  • Default value: None

LinkPrivacy Link to the Privacy Statement page on your website to be rendered at the bottom of each page
  • Default value: None (no link is rendered in this case)

LinkSecurity Link to the Security Statement page on your website to be rendered at the bottom of each page
  • Default value: None (no link is rendered in this case)

LinkTerms Link to the Terms of Service page on your website to be rendered at the bottom of each page
  • Default value: None (no link is rendered in this case)

ServiceAgreement Link to the Service Agreement page on your website to be rendered at the bottom of each page
  • Default value: None (no link is rendered in this case)

MarketplaceFreeTrialURL Specifies the URL of the page to which a user is redirected if the user clicks "Free Trial" for an app on the Marketplace. Further instructions to install the app are available on that page.
MarketplaceURL Specifies the URL for the Marketplace homepage, which is installed separately.

To enable the Marketplace, specify http(s)://$HTTP_PORT$/master/marketplace/ as the property value. For example, if your HTTP port is, private.company.com, your Marketplace URL will be, http://private.company.com:80/master/marketplace/.

If this property is commented out or if there is no value, the Application Directory is enabled and Marketplace is disabled for your tenant. For information about publishing and distributing applications to Application Directory and Marketplace, see Publishing and distributing applications.

  • Default value: Null

Starting with 4.0, in Private Cloud, Marketplace is provided as an alternative to Application Directory. The new Marketplace provides more features and a better user experience for publishing and distributing applications.
SupportTicketURL Specifies the URL of the Support Tickets link in the footer of your instance. Comment-out the property to hide the Support Tickets link. When left blank, the Support Tickets link navigates to a support page where users can raise a support ticket for the master tenant to acknowledge.
  • Default value: <blank>

SupportURL Specifies the URL of the Support link in the footer of your instance. Typically, you direct your users to a Web page where they can get product support.
SubscribeNowURL URL to be invoked when a user clicks Buy Now (this button is displayed in the banner for trial customers)
  • Default value: None (Buy Now will redirect to the support portal if this setting is not filled)

Documentation and Help Property
NewOnlineHelpBaseUrl Specifies the base URL that will be appended to context-sensitive Learn More links in the UI for users. If you change this URL, you must also supply content in WebWorks Reverb Help format (with context IDs), or the links will not work.
UseDocxHelp The property used to hide/show the Learn Morelinks throughout the product.
  • Default value: true

ShowHelpTips When set to false, this property hides all the help tips and the Help Me button in the footer of your instance.
  • Default value: true

CreateNewAppVideoURL Specifies the URL to a user assistance video on how to create an application using quick create wizard.

The Getting Started page contains a link to this video. To substitute your own video, you should supply a valid URL to an embeddable video.

CustomizeAppVideoURL Specifies the URL to a user assistance video on how to customize an application using .

The Getting Started page contains a link to this video. To substitute your own video, you should supply a valid URL to an embeddable video.

NavAppVideoURL Video URL that explains how to customize the application.
FastTrackPage Specifies the URL to the Fast Track page which contains the Quick Start tutorial, companion videos, and online help links.
ShareYouAppVideoURL Specifies the URL to a user assistance video on how to expose a application to end users.

The Getting Started page contains a link to this video. To substitute your own video, you should supply a valid URL to an embeddable video.

VideosWebinarsURL

Specifies the URL to webinars and videos.

The Getting Started page contains a link to this video. To substitute your own video, you should supply a valid URL to an embeddable video.

Limitstop
System Property
ExpirationDays Number of days for free trial to SaaS customers (if 0, the Free Trial box will not be displayed in the sidebar and trials will have no expiration date).
  • Default value: 30

NextIDBatchSize Determines the batch size or how many IDs must be reserved for the next batch of IDs so that throughput is high. It accesses the database each time it gets another batch of IDs, and is best for performance purposes to make batch sizes comparatively large but unused IDs are lost forever. Generates IDs for records and metadata.
  • Default value: 1000

MaxAjaxPerSession Maximum number of AJAX API calls per user login session
  • Default value: 1000

MaxAlarmThreads The system will send a message to admin if number of Java threads exceeds this value.
  • Default value: 200

Any changes to this shared property requires a Platform cluster restart.
MaxCachedEntities Maximum number of object records cached by servers. If set to 0, no caching is enabled.
  • Default value: 20000

Any changes to this shared property requires a Platform cluster restart.
MaxFileSizeKB Maximum size in KB for upload files.
  • Minimum value: 0
  • Maximum value: 2097152
  • Default value: 5120

MaxHostedFileLength

Maximum length of characters allowed per hosted file. Files larger than the prescribed size are silently ignored and not read.

  • Minimum value: 0
  • Maximum value: 2147483647
  • Default value: 100000

HttpConnKeepAliveTimeout Indicates the minimum amount of time an idle connection has to be kept open (in seconds).
  • Default value: 15 seconds

HttpConnKeepAliveMaxReq Indicates the maximum amount of requests that can be sent on a connection before closing it.
  • Default value: 100 requests

This property is not applicable if you are running in Apache. You will have to directly configure keep-alive settings in Apache.
MaxHTTPParamLength Maximum size (in chars) of HTTP parameters processed by the system.
  • Default value: 80000

MaxHttpRetryTimeoutInMins Specifies the maximum HTTP retry timeout value (Retry Interval * Number of retries).
  • Default value: 1 min

RetryTaskTime Specifies the maximum FTP retry timeout value.
  • Default value: 3000 ms

MaxRecordsForSyncActions

Specifies the maximum number of records that can be processed synchronously for any large data operations like List view export, Tabular report export, Mass update or Status update. If records selection for any of these operation exceeds this value, the entire operation is processed asynchronously in the background.

  • Default value: 100

For an optimal performance, it is recommended to avoid increasing the value to very large numbers beyond the system recommended default value.
AjaxFormSubmitTimeout

Timeout value for the Ajax request on object form page submit.

  • Default value is 90000ms. If the value is set to 0ms, there will not be any timeout.

MaxRateLimitProfiles

Species the number of rate limit profiles used for restricting customers.

  • Default maximum value set to 20.

MaxL1CachedEntities

Species the maximum number of L1 Cached Entities.

  • Minimum value: 60
  • Maximum value: 2147483647
  • Default value: 60000

Any changes to this shared property requires a Platform cluster restart.
Views and Chartstop
MaxChartCols Maximum number of columns displayed in charts
  • Default value: 1000

MaxFilters Max number of filters for views.
  • Default value: 5

MaxFormulaSize Maximum size (in characters) of parsed formula. This size is checked before sending formula to JavaScript Engine.
  • Default value: 10240

MaxListTotals Maximum number of columns with totals in views and reports
  • Minimum value: 0
  • Maximum value: 5
  • Default value: 3

Any changes to this shared property requires a Platform cluster restart.
MaxQueryLength Maximum number of characters in a query sent to Query API
  • Default value: 2000

MaxReqsInQuery Maximum number of records which can be fetched by SQL query
  • Default value: 20,000

Import and Export Propertytop
MaxExportRows Maximum number of report rows to be exported as spreadsheet and max number of items in drop-down lookup.
  • Default value: 10000

MaxRecordsAllowedInReporting Maximum number of records to be used in reporting.
  • Default value: 10000

MaxSeedRecords Maximum number of object records that can be attached to an application. This property is not present in the shared.properties file by default. You can add this if required.
  • Default value: 15000

MaxSyncImportFileSize

When importing data from an Excel or CSV file, the maximum size, in bytes, for which the import will be in synchronous mode. Files above this size will be imported in asynchronous mode.

  • Minimum value: 20480
  • Maximum value: 1048576
  • Default value: 20480

Any changes to this shared property requires a Platform cluster restart.
PDFExportMaxRecords Maximum number of report rows to be exported to a PDF.
  • Default value: 1500

TabularReportLayeringLimit The maximum number of layers allowed in a tabular report.
  • Defaults to 7.

MaxLoopItems

You can configure this field value for "Max number of records to iterate through in a loop for Templates and Reports".

  • Default value: 10000 records.

Setting a very high value may affect the template/report processing at the backend. So, the value for this shared property should be carefully configured.
Backup and Restore Propertytop
MaxSystemBackups Maximum system backups are to be kept in the storage for a customer at any given point in time.
  • Default value: 7

This property ensures system backups are managed efficiently by automatically replacing the oldest backup with the newest one when the storage limit is reached. This eliminates manual intervention, enabling seamless nightly upgrades and system operations.

StorageUsageLimitForBkp Storage usage limit (in MB) of a full backup. For information on using this property, see Backup and restore. Default value:20
Triggers Propertytop
MaxDelayedTriggers Maximum number of triggers to be executed for delayed updates
  • Default value: 20

MaxJSTimeMs Maximum elapsed time for the server-side JavaScript formula engine per formula in ms (formula will be aborted afterwards). Currently, this property is only applicable for Rhino engine.
  • Default value: 3000

MaxRecurrEvents Maximum number of recurrent calendar events
  • Default value: 300

Any changes to this shared property requires a Platform cluster restart.
MaxRuntimeTriggers Maximum number of triggers to be executed for non-delayed updates.
  • Default value: 100

MaxTimeToRunTrigMS Maximum time to run a group of triggers ON_AFTER_UPDATE etc.
  • Default value: 30000 (30 seconds)

MinRecursType Minimum allowed recursion interval for triggers and batch jobs:
  • 1: day (24 hours)
  • 4: hour
  • 5: minute
  • Default value: 1

This shared property is no longer available since 6.4 release as all the recursion interval options are exposed in triggers and batchjobs by default.
MaxJSStatements

Controls the maximum number of script statements that are allowed as per the context. This new shared property has been added to work around setting the max time for java script execution in Graal JS engine. This property is applicable only for Graal JS engine.

  • Default value: 10000

HTTP Client Propertytop
HTTPConnectTimeOut The default socket timeout in milliseconds which is the timeout for waiting for data in a given request. A timeout value of zero is interpreted as an infinite timeout. Default value 15 seconds.
HTTPReadTimeOut Specifies the length of the HTTP read timeout, in milliseconds, in triggers. If this property is not present, its value is interpreted as 0, which means an indefinite timeout value.
  • Default value: 20000milliseconds

This property is not applicable if you are running in Apache. You will have to directly configure keep-alive settings in Apache.
InternalCommsHTTPTimeOut

Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets in a socket. Default value 60 mins and is applicable to Internal component communications.

  • Minimum value: 20
  • Maximum value: 60
  • Default value: 60

Any changes to this shared property requires a Platform cluster restart.
InternalCommsMaxConnections

Maximum number of client connections in the pool to service connection requests from multiple execution threads. Default value 2000 and is applicable to Internal component communications.

Any changes to this shared property requires a Platform cluster restart.
InternalCommsMaxPerRoute Maximum number of client connections in the pool per route to service connection requests from multiple execution threads.

This is a restartable shared property to configure as necessary.

  • Default value 200 and is applicable to Internal component communications.

Any changes to this shared property requires a Platform cluster restart.
ProxyCommsMaxConnections Maximum number of client connections in the pool to service connection requests from multiple execution threads.

This is a restartable shared property to configure as necessary.

  • Default value 200and is applicable to REST, SOAP, WSDL & JSDO servlet communications.

Any changes to this shared property requires a Platform cluster restart.
ProxyCommsMaxPerRoute Maximum number of client connections in the pool per route to service connection requests from multiple execution threads.

This is a restartable shared property to configure as necessary.

  • Default value 100 and is applicable to REST, SOAP, WSDL & JSDO servlet communications.

Any changes to this shared property requires a Platform cluster restart.
ProxyCommsHTTPTimeOut Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets in a socket.

This is a restartable shared property to configure as necessary.

  • Default value 60 mins and is applicable to REST, SOAP, WSDL & JSDO servlet communications.

Any changes to this shared property requires a Platform cluster restart.
SSEReconnectionTime

Defines the client-server communication interval for real-time updates.

  • Default value: 30000ms

If set to "0", then client connection is closed and real-time update does not occur until the next page reload.

Database Propertytop
HDP_ConnIdleTimeInMins Specifies the duration in minutes until which an existing Hybrid Data Pipeline connection can stay idle. If a connection is found idle for the specified duration, a new connection is created and used.The property takes values between one to five.
  • Minimum value: 1
  • Maximum value: 5
  • Default value: 3

Any changes to this shared property requires a Platform cluster restart.
HDP_ConnPoolSize

Specifies the number of connections to be cached and reused in order to avoid creating new connections to the datasources in Hybrid Data Pipeline (HDP) frequently. The property takes values between two to ten.

  • Minimum value: 2
  • Maximum value: 10
  • Default value: 5

Any changes to this shared property requires a Platform cluster restart.
MaxAlarmConnections The system will send a message to admin if number of database connections exceeds this value
  • Default value: 90

Any changes to this shared property requires a Platform cluster restart.
MaxConnections Maximum number of database connections in each connection pool.
  • Default value: 100

Any changes to this shared property requires a Platform cluster restart.
MinConnections Number of database connections initially created in each connection pool.
  • Default value: 1

Any changes to this shared property requires a Platform cluster restart.
MaxNotUsedConnTimeMins Maximum time (in minutes) allowed database connection in a pool to be idle. The connection will be closed after that amount of time has elapsed.
  • Default value: 30

Any changes to this shared property requires a Platform cluster restart.
MaxInUseConnTimeMins Maximum time (in minutes) allowed for a database connection to be in use. The connection will be forced to close after the amount of time elapses..
  • Default value: 30

Any changes to this shared property requires a Platform cluster restart.
MaxConnLifetimeMins Maximum connection lifetime before closure (in minutes)
  • Default value: 60

Any changes to this shared property requires a Platform cluster restart.
MaxTransactionTime Maximum time in minutes to allow a database transaction to run (will be rolled back after that)
  • Default value: 10

MaxIntgFields Maximum number of BIGINT fields.
  • Default value: 150

MaxStrFields Maximum number of VARCHAR(100) fields (in MySQL notation).
  • Default value: 200

MaxDateFields Maximum number of DATETIME fields.
  • Default value: 50

MaxDblFields Maximum number of DECIMAL(20,8) fields
  • Default value: 50

MaxTxtFields Maximum number of LONGTEXT fields
  • Default value: 50

MaxDbLongStrLength Maximum size (in chars) of long text fields (CLOBs) to be stored in the database.
  • Minimum value: 0
  • Maximum value: 1073741823
  • Default value: 80000

Any changes to this shared property requires a Platform cluster restart.
Email Property
MaxAttachmentSizeKB Maximum size of email attachment in KB
  • Default value: 2048

MaxEmailAttachments Maximum number of email attachments.
  • Default value: 3

MaxEmailBodyKB Maximum size of email message body in KB
  • Default value: 2048

Othertop
Master Tenant Authentication Property
SecurityLevel Specifies the security level for the master tenant. See Setting and changing security levels for more information about security levels.
  • Default value: 1

ExpirationPolicy The number of days after which a user's password expires on the master tenant. You can leave this setting blank if you want to keep the password from expiry.
  • Default value: 0

Master Tenant Property
MasterAdditionalLangCode Specifies a list of comma-separated language codes (based on ISO 631-1) for the Master tenant. Setting this property ensures that the Master tenant supports full language translation to the additional language from the default base language (English). For more information about language support, refer Language support.
  • Default value: None (must be specified prior to server start up)

MasterCloudStorageType Indicates the cloud storage type for master Tenant such as - Storage, Amazon S3, S3 Compatible Storage, or Microsoft Azure. As an alternative to local storage, you (an ISV or a Private Cloud user) can purchase and enable a third-party cloud storage (Amazon S3, S3 Compatible Storage, or Microsoft Azure) for your customer tenants. Cloud storage is used on a tenant by tenant basis
  • Default value: String.valueOf(ICloudConst.CLOUD_ROLLBASE

MasterCloudStorageDir The S3 bucket to use for this customer tenant. For Microsoft Azure, this will be empty.
  • Default value: Null

MasterCloudStorageUser The Access Key ID assigned to your AWS account or the name of your Azure account.
  • Default value: Null

MasterCloudStoragePassword The Secret Access Key associated with the Access Key ID for AWS or the Account Key for your Azure account.
  • Default value: Null