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.

From the Application Switcher > System Console > System > Shared Properties > General > Platform define, modify or view the below properties

Platform Property Description
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.

Note: This property appears as a Platform property for a Platform instance that has no licensing information and needs a restart. For a licensed Platform 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:{!A} | {!S} | {!P}

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

Default: en (English)

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

Default: 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: None

Encodings Encoding support for comma-separated list files.

Default: 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). Defaults to 3.
CustomClassFilter You can use custom Java objects (available on CLASSPATH) in Platform 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)

Default: 60

CloudType When set to AWS the cloud instance type information is retrieved and displyed in System Console > Servers Tab.
Note: You should set the value to AWS only if Platform is deployed on AWS.

Default: Default

When set to Default, the cloud instance type information is not fetched.

From the System Console > System > Shared Properties > General > Add/Remove Features define, modify or view the below properties.

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

Default: false

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

Note that 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.

Default: true

SupportCorticonService Support managing Corticon service integration in Platform. When set to false, the service is not supported. Default value is true.
SupportHDP Support for managing Hybrid Data Pipeline objects in Platform. When set to false, the service is not supported. Default value is true.
SupportOEService Support for managing OpenEdge service objects in Platform. When set to false, the service is not supported. Default value is true.
SupportRemoteDatabase Support for external tables in a remote database that is not used as the Platform 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 is true.
AllowMultipleRestSessions When set to true, this property enables multiple REST API sessions per user. That is, Platform can create multiple concurrent sessions for the same user and process the REST API calls from all the sessions.

Default: 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: 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 Platform 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: 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: 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: true

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

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

Default: true

Platform 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: 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: 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: 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: 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: false

LoadOnlyOnDedicatedServer

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

Default: false

From the System Console > System > Shared Properties > General > Security define, modify or view the below properties

Security Property Description
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 Platform services. Defaults to .*.(Progress|icenium|telerik).com$
IsSecureServer Determines the security protocol for all communications between your browser and the website.

Default: false

From the System Console > System > Shared Properties > General > System Jobs define, modify or view the below properties

System Jobs Property Description
CleanupMins Interval in minutes between cleanup operations on each component

Default:60

PurgeAfterDays Platform purges deleted records from the Recycle Bin after the specified number of days

Default: 30

PurgeRecordsBatchSize Indicates the batch size of records to be purged from the Recycle Bin in a single transaction.

Default: 100

StatsCollect The time frequency with Platform collects tenant statistics, stores them into backend and notifies about its execution.

Default: 3 minutes

StatusCheck Interval in minutes between status checks on each component.

Default:5 minutes

WebProxyStatusCheck Denotes the interval in seconds between status checks on each Web Proxy configured in Platform. A periodic thread runs during the configured interval and keeps pushing the current upstream topology to each of the configured Web Proxy.

Default: 30 seconds

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

Default: 1 minute

CleanupDays Delete log and backup files older than specified number of days (if specified value > 0).

Default: 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.

Default: 1

Max value: 50

Note: Configuring the BatchJobsExecutorThreadCount property to 50 is not recommended, as it might render the system unstable.

DelayedTriggersExecutorThreadCount Indicates the number of threads that need to be completed before triggering the subsequent thread.

Default: 1

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.

Default: 1

Max value: 10

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.

Default: 1

Max value: 10

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: 1

From the System Console > System > Shared Properties > General > Email define, modify or view the below properties

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

Default: None (must be specified prior to installation)

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

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

MailTimeoutSec The number of seconds before Platform 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: 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.

From the System Console > System > Shared Properties > General > Search define, modify or view the below properties

Search Property Description
MaxSearches Maximum number of conditions to be used in a Detailed Search component.

Default: 20

MaxSearchResults Max number of search results to bring back for a single full text search.

Default: 200

MaxClauseCount Maximum number of clauses permitted per lucene search query.

Default: 1024

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: false

IndexChangeSyncDelaySecs Max time (in seconds) between an index change and it being visible for search.

Default: 5 seconds

LockTimeoutSec

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

Default: 30 seconds

RAMBufferMB Size of RAM buffer, in MB, for indexing operations.

Default: 64MB

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

Default: 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: 1000

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: 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: [.?!][ ]|[,:;|_= -]

IncludeAppContextInSearchResults

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

Default: true

From the System Console > System > Shared Properties > General > Log define, modify or view the below properties.

Log Property Description
EnableCustomLogging

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

Default: false

LogFormat The log4j format for log messages.

Default: [%d] %m%n

LogFileSize Maximum size of particular log file, such as main.log.

Default: 2MB

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

Default: 5

From the System Console > System > Shared Properties > General > Database define, modify or view the below properties.

Database Property Description
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.

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

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

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

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

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

From the System Console > System > Shared Properties > General > Usage Analytics define, modify or view the below properties.

Usage Analytics Property Description
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: false

From the System Console > System > Shared Properties > General > API define, modify or view the below properties.

API Property Description
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: 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: 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.

From the System Console > System > Shared Properties > Customize > User Interface define, modify or view the below properties.

User Interface Property Description
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 Setup > Preferences.

Default: false

NewUIMobileUsesJqueryMobileUI Based on this property Platform renders different UI in mobile devices. If this property is set to true, Platform applications renders in classic jQueryMobileUI widgets. We are not doing any active development on this jQueryMobile UI, so Platform recommend customers to upgrade NewUI and set this property to false to have support for Responsive UI rendering in the mobile devices.

Default: 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 Platform support, Modern Blueprint and Vertical Blueprint. You can set this to true or false.

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

DisableNUIBanner Disable Banners shows for all evaluation users who had enabled NewUI support.

Default: false

PacificUIDisabled Disable Pacific theme UI from setup pages, classic UI and from Page designer.

Default: 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 Platform 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.

Note: 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 Platform 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 maxmimum 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.

Default number of records configured: 100

Minimum number of records that can be configured: 1

Mamixum number of records that can be configured: 1000

.
BootStrapVersion Choose a default bootstrap version for Platform 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: true

EnableUIConsoleLog On enabling this shared property, debug messages are logged in the browser console.

Default: true

EnableApplicationCustomScript On enabling this shared property, the application pages display the custom script/HTML.

Default: true

ShowNewBetaUITryoutLink On enabling this shared property, the application pages display the Try New Beta UI toggle.

Default: true

From the System Console > System > Shared Properties > Customize > HTML Editor define, modify or view the below properties.

HTML Editor Property Description
HideHtmlEditorMenu When set to true, this property hides the HTML editor menu bar.

Default: 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: 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: <blank>

From the System Console > System > Shared Properties > Customize > Images define, modify or view the below properties.

Images Property Description
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, Platform 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: 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, Platform generates various images for different devices. In this property, you can provide image size as pixel value in number format for smart phones.

Default: 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, Platform generates various images for different devices. In this property, you can provide image size as pixel value in number format for Tablets.

Default: 768

ImageWidthThumbnail This property applicable only when customer enables Dynamic Image resize Settings from the Preferences page. Platform 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: 50

From the System Console > System > Shared Properties > Customize > CDN define, modify or view the below properties.

CDN Property Description
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: false

BootstrapCdn CDN URL to load Bootstrap library files. This is applicable only when user enable UseCdnForNewUI property.

Default: Null

KendoCdn CDN URL to load kendo library files. This is applicable only when user enable UseCdnForNewUI property.

Default: Null

FontAwesomeCdn CDN URL to load FontAwesome files. This is applicable only when user enable UseCdnForNewUI property.

Default: Null

LatoFontCdn Google font URL to load Lato font css file. This is applicable only when user enable UseCdnForNewUI property.

Default: 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.

Note: 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

 

From the System Console > System > Shared Properties > Customize > White Label define, modify or view the below properties.

White Label Property Description
SystemName In the Platform 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 Platform Private Cloud licensed version, this property is configured in license.xml file.

Default: Rollbase

WebSiteURL URL to root of your web site

Default: http://HostName or https://HostName. The default value depends on the protocol decided based on IsSecureServer and host_name by HostName shared properties set.

Note: 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: None

ForumURL URL to forum page; if not set, the Platform Forum menu is not available in the Platform menu.

Default: None

LinkPrivacy Link to the Privacy 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 the Security Statement page on your website to be rendered at the bottom of each page

Default: 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: 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: 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 Platform Application Directory is enabled and Marketplace is disabled for your tenant. For information about publishing and distributing applications to Platform Application Directory and Marketplace, see Publishing and distributing applications.

Default: Null

Note: Starting with Platform 4.0, in Platform 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 Platform instance. Comment-out the property to hide the Support Tickets link. When left blank, the Support Tickets link navigates to a Infinite Blue Platform support page where users can raise a support ticket for the master tenant to acknowledge.

Default: <blank>

SupportURL Specifies the URL of the Support link in the footer of your Platform instance. Typically, you direct your users to a Web page where they can get product support.

Default: https://support.infiniteblue.com

SubscribeNowURL URL to be invoked when a user clicks Buy Now (this button is displayed in the banner for trial customers)

Default: None (Buy Now will redirect to the support portal if this setting is not filled)

 

From the System Console > System > Shared Properties > Customize > Documentation & Help define, modify or view the below properties.

Documentation & Help Property Description
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: true

ShowHelpTips When set to false, this property hides all the help tips and the Help Me button in the footer of your Platform instance.

Default: true

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

Default: https://www.youtube.com/watch?v=wGUAQjj7BQg

The Platform 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 Platform.

Default: https://www.youtube.com/watch?v=Y00amCl0W3E

The Platform 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 Platform application.
FastTrackPage Specifies the URL to the Platform 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 Platform application to end users.

Default: https://www.youtube.com/watch?v=aavOhyiAdZ0

The Platform 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 Platform webinars and videos.

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

 

From the System Console > System > Shared Properties > Limits > System define, modify or view the below properties.

System Property Description
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: 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: 1000

MaxAjaxPerSession Maximum number of AJAX API calls per user login session

Default: 1000

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

Default: 200

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

Default: 1000

MaxFileSizeKB Maximum size in KB for upload files.

Default: 5120

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

Default: 15 seconds

HttpConnKeepAliveMaxReq Indicates the maximum amount of requests that can be sent on a connection before closing it.

Default: 100 requests

Note: This property is not applicable if you are running Platform 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: 80000

MaxHttpRetryTimeoutInMins Specifies the maximum HTTP retry timeout value (Retry Interval * Number of retries).

Default: 1 min

RetryTaskTime Specifies the maximum FTP retry timeout value.

Default: 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: 100

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

 

From the System Console > System > Shared Properties > Limits > Views & Charts define, modify or view the below properties.

Views & Charts Property Description
MaxChartCols Maximum number of columns displayed in charts

Default: 1000

MaxFilters Max number of filters for views.

Default: 5

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

Default: 10240

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

Default: 3

MaxQueryLength Maximum number of characters in a query sent to Query API

Default: 2000

MaxReqsInQuery Maximum number of records which can be fetched by SQL query

Default: 20,000

 

From the System Console > System > Shared Properties > Limits > Import & Export define, modify or view the below properties.

Import & Export Property Description
MaxExportRows Maximum number of report rows to be exported as spreadsheet and max number of items in drop-down lookup.

Default: 10000

MaxRecordsAllowedInReporting Maximum number of records to be used in reporting.

Default: 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: 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.

Default: 20480

PDFExportMaxRecords Maximum number of report rows to be exported to a PDF.

Default: 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: 10000 records.

Note: 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.

 

From the System Console > System > Shared Properties > Limits > Backup & Restore define, modify or view the below properties.

Backup & Restore Property Description
MaxSystemBackups Max number of system backup files to keep per customer. The system will delete older files if this number is exceeded.

Default: 7

MaxBackupsPerMonth Maximum number of times a backup activity can be performed by a customer tenant per month. For information on using this property, see Backup and restore.

Default: 10

StorageUsageLimitForBkp Storage usage limit (in MB) of a full backup. For information on using this property, see Backup and restore. Default:20

 

From the System Console > System > Shared Properties > Limits > Triggers define, modify or view the below properties.

Triggers Property Description
MaxDelayedTriggers Maximum number of triggers to be executed for delayed updates

Default: 20

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

Default: 3000

MaxRecurrEvents Maximum number of recurrent calendar events

Default: 300

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

Default: 100

MaxTimeToRunTrigMS Maximum time to run a group of triggers ON_AFTER_UPDATE etc.

Default: 30000 (30 seconds)

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

Default: 1

 

From the System Console > System > Shared Properties > Limits > HTTP Client define, modify or view the below properties.

HTTP Client Property Description
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 Platform triggers. If this property is not present, its value is interpreted as 0, which means an indefinite timeout value.

Default: 20000milliseconds

Note: This property is not applicable if you are running Platform 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.
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.
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.
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.
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.
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.

 

From the System Console > System > Shared Properties > Limits > Database define, modify or view the below properties.

Database Property Description
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

This is a restartable shared property to configure as necessary.

Default: 3

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

This is a restartable shared property to configure as necessary.

Default: 5

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

Default: 90

MaxConnections Maximum number of database connections in each connection pool.

Default: 100

MinConnections Number of database connections initially created in each connection pool.

Default: 1

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: 30

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: 30

MaxConnLifetimeMins Maximum connection lifetime before closure (in minutes)

Default: 60

MaxTransactionTime Maximum time in minutes to allow a database transaction to run (will be rolled back after that)

Default: 10

MaxIntgFields Maximum number of BIGINT fields.

Default: 15

MaxStrFields Maximum number of VARCHAR(100) fields (in MySQL notation).

Default: 200

MaxDateFields Maximum number of DATETIME fields.

Default: 50

MaxDblFields Maximum number of DECIMAL(20,8) fields

Default: 50

MaxTxtFields Maximum number of LONGTEXT fields

Default: 50

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

Default: 80000 Maximum Value: 180000

 

From the System Console > System > Shared Properties > Limits > Email define, modify or view the below properties.

Email Property Description
MaxAttachmentSizeKB Maximum size of email attachment in KB

Default: 2048

MaxEmailAttachments Maximum number of email attachments.

Default: 3

MaxEmailBodyKB Maximum size of email message body in KB

Default: 2048

 

From Administration > Setup Home > Administration Setup > Authentication > Authentication Type > Password > Next define, modify or view the below Master Tenant Authentication properties.

Master Tenant Authentication Property Description
SecurityLevel Specifies the security level for the master tenant. See Setting and changing security levels for more information about security levels.

Default: 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: 0

 

From Administration > Setup Home > Administration Setup > Account Settings define, modify or view the below Master Tenant properties.

Master Tenant Property Description
MasterAdditionalLangCode Specifies a list of comma-separated language codes (based on ISO 631-1) for the Platform 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: None (must be specified prior to server start up)

MasterCloudStorageType Indicates the cloud storage type for master Tenant such as - Infinite Blue Platform Storage, Amazon S3 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 or Microsoft Azure) for your customer tenants. Cloud storage is used on a tenant by tenant basis

Default: String.valueOf(ICloudConst.CLOUD_ROLLBASE

MasterCloudStorageDir The S3 bucket to use for this customer tenant.For Microsoft Azure, this will be empty.

Default: Null

MasterCloudStorageUser The Access Key ID assigned to your AWS account or the name of your Azure account.

Default: Null

MasterCloudStoragePassword The Secret Access Key associated with the Access Key ID for AWS or the Account Key for your Azure account.

Default: Null