Notices

RSuite is a registered trademark and the RSuite CMS logo is a trademark of Orbis Technologies, Inc.

This is a confidential document only to be shared with current RSuite^® customers and others designated by Orbis Technologies, Inc.

For more information on RSuite or Orbis Technologies, visit these Web sites:

Orbis Technologies, Inc. (www.orbistechnologies.com)
RSuite CMS Community (https://support.rsuitecms.com/support/home)

The PDF version of this document is created with the RenderX XEP FO engine integrated with the DITA Open Toolkit. See www.renderx.com for product details.

About this book

RSuite^® CMS is a robust content management application, especially suited to loading, storing, managing, transforming, and exporting XML documents within the context of a publishing enterprise.

This book contains reference information for configuring and administering the RSuite CMS server and the MarkLogic database.

Authentication settings

These properties define tokens for authenticating RSuite users. Property names are case-sensitive.

rsuite.auth.ldap.username

rsuite.auth.ldap.username=username

Use rsuite.auth.ldap.username to specify the user name for binding the pooled connections to the LDAP server.

Usage notes

The default LDAP user name is rsuite-server.
Prior to RSuite 3.2.9, the property was called ldap_username. The RSuite server uses the value of ldap_username if rsuite.auth.ldap.username is not defined.

Examples

rsuite.auth.ldap_username=rsuite-server
rsuite.auth.ldap_username=jsmith
rsuite.auth.ldap_username=rsuite

rsuite.auth.ldap.password

rsuite.auth.ldap.password = password

Use rsuite.auth.ldap.password to specify the password used for binding the pooled connections to the LDAP server.

Usage notes

The default value is plain:password.
Passwords are assumed to be encrypted. To specify the password in clear text, prefix it with "plain:".
Prior to 3.2.9, the property was called ldap_password. The RSuite server uses the value of ldap_password if rsuite.auth.ldap.password is not defined.

Examples

rsuite.auth.ldap.password=plain:simplepassword
rsuite.auth.ldap.password=encrypteddrowssap

rsuite.auth.ldap.protocol

rsuite.auth.ldap.protocol=protocol

Use rsuite.auth.ldap.protocol to specify the protocol used in the LDAP URL.

Usage notes

The default value is ldap.

Examples

rsuite.auth.ldap.protocol=ldap
rsuite.auth.ldap.protocol=ldaps

rsuite.auth.ldap.host

rsuite.auth.ldap.host = address

Use rsuite.auth.ldap.host to specify the host name or IP address of the LDAP server.

Usage notes

The default value is localhost.
Prior to RSuite 3.2.9, the property was called ldap_host. The RSuite server uses the value of ldap_host if rsuite.auth.ldap.host is not defined.

Examples

rsuite.auth.ldap.host=192.168.1.14
rsuite.auth.ldap.host=yourhostname.yourdomain.com
rsuite.auth.ldap.host=localhost
rsuite.auth.ldap.host=127.0.0.1

rsuite.auth.ldap.port

rsuite.auth.ldap.port=port

Use rsuite.auth.ldap.port to specifies the port number for the LDAP server.

Usage notes

The default value is 389.
Prior to RSuite 3.2.9, the property was called ldap_port. The RSuite server uses the value of ldap_port if rsuite.auth.ldap.port is not defined.

Examples

rsuite.auth.ldap.port=389
rsuite.auth.ldap.port=636

rsuite.auth.ldap.root-dn

rsuite.auth.ldap.root-dn = root-string

Use rsuite.auth.ldap.root-dn to specify the root distinguished name (DN) for the LDAP server. The root DN is the container for all entries at the server.

Usage notes

root-string is a comma-delimited list of domain component (dc) specifications. E.g., the URL pride&prejudice.themovie.net is decomposed to "dc=pride&prejudice,dc=themovie,dc=net".
The default value is the empty string, without quotation marks.
Prior to RSuite 3.2.9, the property was called ldap_dc. The RSuite server uses the value of ldap_dc if rsuite.auth.ldap.root-dn is not defined.

Examples

rsuite.auth.ldap.root-dn=dc=rsidomain,dc=rsi,dc=com
rsuite.auth.ldap.root-dn=dc=YOURCOMPANY,dc=com

rsuite.auth.ldap.pool.max-connections

rsuite.auth.ldap.pool.max-connections = integer

Use rsuite.auth.ldap.pool.max-connections to set the maximum number of pool connections that are opened to the LDAP server.

Usage notes

integer can be any positive integer.
The default value is 5.

rsuite.auth.ldap.secure

rsuite.auth.ldap.secure = { TRUE | FALSE }

Use rsuite.auth.ldap.secure to specify whether the connection to the LDAP server is over an SSL.

Usage notes

The default is FALSE.
When rsuite.auth.ldap.secure=TRUE, rsuite.auth.ldap.keystore and rsuite.auth.ldap.keystorepass must be defined.
The use of SSL can be inferred from the port or protocol, but the inference is not completely reliable; hence the explicit property.

rsuite.auth.ldap.keystore

rsuite.auth.ldap.keystore = path

Use rsuite.auth.ldap.keystore to specify the absolute path to the Java Keystore used for encrypting communication between RSuite and the LDAP server.

Usage notes

rsuite.auth.ldap.keystore is required when rsuite.auth.ldap.secure is TRUE.
There is more information on Java Security and the Java Key and Certificate management tool at http://docs.oracle.com/javase/6/docs/technotes/tools/windows/keytool.html.

Examples

rsuite.auth.ldap.keystore=c:\\keystores\\rsuitekeystore.jks
rsuite.auth.ldap.keystore=/opt/keystores/rsuitekeystore.jks

rsuite.auth.ldap.keystorepass

rsuite.auth.ldap.keystorepass = password

Use rsuite.auth.ldap.keystorepass to specify the password to the Java Keystore specified by the rsuite.auth.ldap.keystore property.

Usage notes

rsuite.auth.ldap.keystorepass is required when rsuite.auth.ldap.secure is TRUE.

Examples

rsuite.auth.ldap.keystorepass=key5t0reOpen

rsuite.auth.providers

rsuite.auth.providers = auth-types-list

Use rsuite.auth.providers to specify the types of authentication to be used.

Usage notes

auth-types-list is a comma-delimited list of authentication providers. Authentication types are not case sensitive.
The current built-in authentication providers are File, Local, Active Directory (activedirectory), and LDAP. Built-in types may change.
Local is the default provider. However, if rsuite.auth.providers is used, and the list does not include Local, Local is not available.
rsuite.auth.providers superseded rsuite.auth.type as of RSuite 5.1.

Examples

rsuite.auth.providers=ldap,activedirectory

Trouble-shooting rsuite.auth.providers

Not configuring rsuite.auth.providers or not enabling an authentication type can result in certain user IDs being unavailable:

If rsuite.auth.providers is specified in a properties file, then for any authorization type not enabled, users of that type are not accessible:
- they are not visible in the admin UI
- they cannot log in. Attempting to log in raises a "user does not exist" message
- they cannot be created—
  - In the case of Local users, which are created through the RSuite UI, the response is "There are no authentication providers configured that can create a new user"
  - In the case of the REST API, the response is a null result
If the rsuite.auth.providers property is nowhere specified:
- Local users can be created and can log in, because Local is the default authentication type
- File, Active Directory, and LDAP users are not accessable
If a single user ID is created to use both Active Directory authentication and Local authentication, the user ID is not able to log in. Even if the user ID is deleted from the Local authentication store and Local authentication is disabled by removing it from the rsuite.auth.providers list, the user ID cannot log in with Active Directory authentication.
Because LDAP installations vary, test how this property affects LDAP before you implement it in your production system.

rsuite.server.logininfo.expiration.days

rsuite.server.logininfo.expiration.days = days

Use rsuite.server.logininfo.expiration.days to set the interval for which RSuite keeps a list of users who have logged into the system. Users who logged in before the start of the intervel are dropped from the list.

Usage notes

days is an integer, the number of days RSuite keeps a user in the list after he has logged in.
The list is currently used in the Task Management list in the Tasks window.

Examples

rsuite.server.logininfo.expiration.days=90

Content settings

These properties define how RSuite deals with content. Property names are case-sensitive.

rsuite.content.treat-as-xml.ext

rsuite.content.treat-as-xml.ext = ext1,ext2,...

Use rsuite.content.treat-as-xml.ext to specify which files are to be processed as XML content—instead of non-XML content—when they are uploaded through the RSuite CMS UI.

Usage notes

File types are specified as a comma-delimited list of file type extensions.
The default is rsuite.content.treat-as-xml.ext=xml,nxml,dita,ditamap.
Prior to RSuite 3.3.1, this property was called XML.FILE.EXT; its default is xml. The RSuite Server uses the value of XML.FILE.EXT if rsuite.content.treat-as-xml.ext is not defined.

dita-ot.default.path

dita-ot.default.path= filepath

Use dita-ot.default.path to specify the location of the DITA Open Toolkit.

Usage notes

RSuite is delivered with dita-ot.default.path pointing to DITA OT 1.8.5:
rsuite-home/integration/DITA-OT1.8.5.
You can set dita-ot.default.path to point to another version. RSuite is not compatible with all versions of DITA.
For more information, see the RSuite CMS 5.0 DITA Configuration Guide 1.0 (sign-in required) or contact RSuite Support.

Examples

dita-ot.default.path=C:\RSuite_5\integration\DITA-OT1.8.5

rsuite.nonxml.textextract

rsuite.nonxml.textextract = { TRUE | FALSE }

Use rsuite.nonxml.textextract to specify whether text is extracted from non-XML objects when they are loaded and updated.

Usage notes

The default is FALSE.

rsuite.api.maxuploadsize.mb

rsuite.api.maxuploadsize.mb = size

Use rsuite.api.maxuploadsize.mb to specify the maximum size of a file that can be uploaded through the Web UI by functions like Replace, Upload, and Attach.

Usage notes

size is an integer indicating the maximum size in megabytes of a file that can be uploaded.
The default maximum size is 100MB.

Examples

rsuite.api.maxuploadsize.mb=75

rsuite.nonxml.textextract.filesize.max

rsuite.nonxml.textextract.filesize.max = { 100 | | | filesize }

filesize: An integer specifying file size, in megabytes.

In RSuite 5.3 and later, use the rsuite.nonxml.textextract.filesize.max property to change the maximum file size for which RSuite performs text extraction on non-XML files—e.g., PDF or ZIP—when it uploads them.

Usage notes

Uploading a large file with the Add content action can exhaust the available memory, causing the operation to fail. The out-of-memory condition occurs when text is extracted in order to create a non-XML object.
If rsuite.nonxml.textextract.filesize.max is not declared, the default size limit for text extraction is 100MB. The example sets the limit to 75MB.

Example

rsuite.nonxml.textextract.filesize.max=75

Directory and file settings

These properties define the location of system directories and alternate properties files used by RSuite. Property names are case-sensitive.

rsuite.nonxml.dir

rsuite.nonxml.dir = filepath

Use rsuite.nonxml.dir to specify a location for the permanent storage of non-XML files managed by RSuite.

Usage notes

The default value is rsuite-home/binarycache.
During installation, the non-XML location is created as a subdirectory under the specified data directory.
Prior to release 3.2.4, the property was called BINARY.DATA.FOLDER. The RSuite server uses the value of BINARY.DATA.FOLDER if rsuite.nonxml.dir is not defined.

Examples

rsuite.nonxml.dir=C:\RSuite-data\nonxml
rsuite.nonxml.dir=/opt/RSuite-data/nonxml

rsuite.temp.dir

rsuite.temp.dir = filepath

Use rsuite.temp.dir to specify the directory for temporary files created by the RSuite server, such as:

files uploaded by the Servlet API
files created during the extraction of text from PDF files, DOCX files, etc.
XML files created during validation of DTDs and XML schemas

Usage notes

The default file path is rsuite-home/temp.
The directory must exist and be writable and readable by RSuite Server. If the specified directory does not exist, the RSuite server configures its temporary directory to the default location and notes the change in the server log.
Prior to release 3.2.2, the property was called TEMPORARY.FILEPATH. The RSuite server uses the value of TEMPORARY.FILEPATH if rsuite.nonxml.dir is not defined.

Examples

rsuite.nonxml.dir=C:\temp
rsuite.nonxml.dir=/tmp

rsuite.var.dir

rsuite.var.dir = filepath

Use rsuite.var.dir to specify where the server puts var files, such as the last log-in file, which the server creates to store data outside of the XML repository.

Usage notes

The default file path is rsuite-home/var.
The directory must exist and be writable and readable by the RSuite server. If the directory does not exist, the RSuite server creates the var directory in the default location and notes the change in the server log.

Examples

rsuite.var.dir=C:\rsuite\var
rsuite.var.dir=/opt/rsuite/var

rsuite.plugins.dir

rsuite.plugins.dir = filepath

Use rsuite.plugins.dir to specify the folder in which plug-ins are stored.

Examples

rsuite.plugins.dir=/opt/RSuite-plugins
rsuite.plugins.dir=c:\temp\rsuite-plugins

rsuite.workflow.baseworkfolder

rsuite.workflow.baseworkfolder = filepath

Use rsuite.workflow.baseworkfolder to specify the directory in which the server creates working folders for workflow instances.

Usage notes

The default file path is c:\temp.
Prior to RSuite 3.0, this property was called base.folder. The RSuite server uses the value of base.folder if rsuite.workflow.baseworkfolder is not defined.

Examples

rsuite.workflow.baseworkfolder=c:\tempload
rsuite.workflow.baseworkfolder=/opt/RSuite-data/

rsuite.report.generated.base.dir

rsuite.report.generated.base.dir = filepath

Use rsuite.report.generated.base.dir to specify where RSuite writes reports.

Usage notes

The default value is rsuite-home/logs/reports
The folder must be writable by RSuite.

Examples

rsuite.report.generated.base.dir=c:\tempgenerated-reports
rsuite.report.generated.base.dir=/opt/RSuite-data/logs/reports

rsuite.conf.alternate.dir

rsuite.conf.alternate.dir = filepath

Use rsuite.conf.alternate.dir to specify the local configuration directory. Typically, role mappings are loaded from the role-mappings.properties file in this directory.

Examples

rsuite.conf.alternate.dir=/opt/rsuite-data/yourcompany/local_conf
rsuite.conf.alternate.dir=c:\temp\local_conf

rsuite.conf.auxiliary.file.list

rsuite.conf.auxiliary.file.list = { { ../ } [ filepath / ] filename . properties [ , ] }

Use rsuite.conf.auxiliary.file.list to specify a comma-delimited list of additional properties files.

Usage notes

Each properties file is specified as a file path below rsuite-home/conf/.
The complete file path below rsuite-home/conf/ does not need to be specified explicitly. Intervening levels can be indicated by a matching number of ../.

Examples

rsuite.conf.auxiliary.file.list=more-rsuite.properties,even_more-rsuite.properties
,../../special-users/editors/editing-rsuite.properties

Editor settings

These properties configure the various built-in text editors.

oxygen.server.webapp

oxygen.server.webapp = rsuite_server_url / web_app_name

Use oxygen.server.webapp to specify the URL of the oXygen Web Editor application.

rsuite_server_url: part of the RSuite URL, http://rsuite_server_url/rsuite-cms
web_app_name: part of the identifier of the oXygen Web App plug-in, rsuite-home/tomcat/webapps/web_app_name.war.

Usage notes

web_app_name.war is downloaded as web_app_name-v.r.m.war. The property was introduced with the oXygen Web Editor plug-in 1.1.

Example:

oxygen.server.webapp=rsuite_server_url/rsuite-oxygen-webapp-integration

oxygen.server.webapp.autoSaveInterval

oxygen.server.webapp.autoSaveInterval = interval

Use oxygen.server.webapp.autoSaveInterval to specify how frequently the oXygen Web Editor app saves the text being edited.

Usage note

interval is an integer, the length of the interval in seconds.

rsuite.edit.admin.userid

rsuite.edit.admin.userid = userid

Use rsuite.edit.admin.userid to identify the RSuite Edit administrator who receives an alert when an attempt to save an edited document fails.

Usage notes

The property was introduced with release 1.1 of the RSuite Edit plug-in

Example

rsuite.edit.admin.userid=userid

Logging settings

These properties set logging levels for the various kinds of logs used by RSuite; the server log and individual workflow logs are the most used. Logs can also be created and maintained by custom plug-ins. Property names are case-sensitive.

rsuite.logs.dir

rsuite.logs.dir = filepath / log

Use the rsuite.logs.dir property to specify the base directory for RSuite server logs.

Usage notes

The RSuite server must be able to write to the directory.
The default directory is rsuite-home/logs.
If the specified directory does not exist when the server starts, the server uses the default location. It does not try to create the directory.
Some logs have their own individual settings that can override this setting, for example, rsuite.workflow.logs.base.dir.

Examples

rsuite.logs.dir=C:\RSuite-logs
rsuite.logs.dir=/opt/RSuite-logs/

rsuite.repository.logging.enabled

rsuite.repository.logging.enabled = { TRUE | FALSE }

Use rsuite.repository.logging.enabled to specify whether to log XQuery transactions with the XML repository.

Usage notes

The log file can be verbose, so the default is FALSE. It is mostly useful for debugging. Using this log in a production environment is not recommended.
When the property is TRUE, RSuite creates a log file, rsuite_home/logs/repository.log.
The log file records each successful XQuery executed against the repository.

rsuite.search.logging.enabled

rsuite.search.logging.enabled = { TRUE | FALSE }

Use rsuite.search.logging.enabled to specify whether to log XQuery transactions, RSuite XPath Search (RXS), and full-text search.

Usage notes

The log file can be verbose, so the default is FALSE. It is mostly useful for debugging. Using this log in a production environment is not recommended.
When the property is TRUE, RSuite creates a log file, rsuite_home/logs/rsuite-server-search.log.
The log file records each successful XQuery executed against the repository. It also logs the original user's query in RXS and full-text search.

rsuite.workflow.logs.base.dir

rsuite.workflow.logs.base.dir = filepath

Use rsuite.workflow.logs.base.dir to specify the folder for all workflow instance logs.

Usage notes

The RSuite server must be able to write to the directory.
The default is rsuite.workflow.logs.base.dir=rsuite-home/logs/workflow.

Examples

rsuite.workflow.logs.base.dir=c:tempworkflow-logs
rsuite.workflow.logs.base.dir=/opt/RSuite-data/logs/workflow

Mail settings

These properties define settings for the e-mail server used by RSuite. Property names are case-sensitive.

rsuite.mail.auth.enabled

rsuite.mail.auth.enabled = { TRUE | FALSE }

Use rsuite.mail.auth.enabled to specify whether authentication—user name and password— is enabled for the e-mail server.

Usage notes

The default is FALSE.

rsuite.mail.host

rsuite.mail.host = address

Use rsuite.mail.host to specify the host name or IP address of the e-mail server.

Usage notes

address must be a DNS-resolvable host name or an IP address. The assignments
rsuite.mail.host=localhost

and

rsuite.mail.host=127.0.0.1
are not valid.
RSuite does not presume a default address for the e-mail server.

Examples

rsuite.mail.host=smtp.gmail.com 
rsuite.mail.host=smtp.mail.yahoo.com

rsuite.mail.password

rsuite.mail.password = password

Use rsuite.mail.password to specify the password used to bind to the e-mail server.

Usage notes

The default value of password is null.
Passwords can be encrypted.

rsuite.mail.port

rsuite.mail.port= port

Use rsuite.mail.port to specify the port number for the e-mail server.

Usage notes

The default port number is 25.

rsuite.mail.protocol

rsuite.mail.protocol= protocol

Use rsuite.mail.protocol to specify the protocol used for e-mail.

Usage notes

The default protocol is SMTP.

Examples

rsuite.mail.protocol=smtp
rsuite.mail.protocol=smtps

rsuite.mail.ssl.enable

rsuite.mail.ssl.enable = { TRUE | | | FALSE }

Use rsuite.mail.ssl.enable to specify whether the connection to the e-mail server is over an SSL.

Usage notes

The default is TRUE.

rsuite.mail.starttls.enable

rsuite.mail.starttls.enable = {TRUE | FALSE}

Use rsuite.mail.starttls.enable to specify whether the SMTP service uses transport layer security (TLS).

Usage notes

The default is TRUE.

rsuite.mail.user

rsuite.mail.user = username[@domain]

Use rsuite.mail.user to specify the user name used to bind to the e-mail server.

Usage notes

The default value is null.
The value can be either a local user name or a full Internet e-mail address.

Examples

rsuite.mail.user=companyname.rsicms@gmail.com
rsuite.mail.user=jsmith

MySQL server settings

These properties define tokens for connecting to and managing the MySQL database that RSuite uses to store workflow data and reporting data. Property names are case-sensitive.

rsuite.commands.mysql

rsuite.commands.mysql = filepath

Use rsuite.commands.mysql to specify the path to the MySQL command.

Usage notes

The default command is mysql.

Examples

rsuite.commands.mysql=/usr/local/mysql/bin/mysql

rsuite.commands.mysql-dump

rsuite.commands.mysql-dump = filepath

Use rsuite.commands.mysql-dump to specify the path to the MySQL data base backup command.

Usage notes

The default command is mysqldump.

Examples

rsuite.commands.mysql-dump=/usr/local/mysql/bin/mysqldump

hibernate.connection.url

hibernate.connection.url = jdbc : mysql :// host : port / databaseName

Use hibernate.connection.url to specify the JDBC URL of the MySQL server.

Usage notes

The default is shown in the example.

Example: Default URL

hibernate.connection.url=jdbc:mysql://127.0.0.1:3306/rsuite

hibernate.connection.username

hibernate.connection.username = username

Use hibernate.connection.username to specify the MySQL user name that RSuite uses to connect to MySQL.

Usage notes

Log into MySQL with this user name and the password specified by hibernate.connection.password.
The recommended practice is to create a MySQL user name for the exclusive use of RSuite.
The default user name is root.

Examples

hibernate.connection.username=rsuite_server

hibernate.connection.password

hibernate.connection.password= password

Use hibernate.connection.password to specify the password RSuite uses when it connects to MySQL using the user ID designated by hibernate.connection.usename.

Usage notes

In a development environment, the password can be prefixed with "plain:" to indicate that it has not been encrypted.
At the installation wizard's prompt for the MySQL password, the user enters the password in plain text; the wizard adds the "plain:" prefix.
Contact RSuite Support about options for encrypting the password.

Examples

hibernate.connection.password=plain:c0ffeeMug

Search settings

These RSuite properties configure searches. Property names are case-sensitive.

rsuite.search.bucketSize

rsuite.search.bucketSize = results

Use rsuite.search.bucketSize to specify the number of results to be requested from MarkLogic and submitted to filtering by the requesting Java class.

Usage notes

The bucket size can be used to optimize searches by limiting results from MarkLogic to enough to satisfy a search request (e.g., results 1 - 10 or 11 - 20) without returning many more than the user is likely to access (e.g., results 1 - 200).
The default bucket size is 600. This might be more than your operation needs. However:
- If users typically navigate to subsequent pages, then a bucket size should return enough to support multiple pages. Filters, customer handlers, and larger paging sizes are other reasons to have a larger bucket size.
- Column sorting is performed on the first rsuite.search.bucketSize search results. When the number of search results is greater than rsuite.search.bucketSize, sorting may not work well. One remedy is to set rsuite.search.bucketSize equal to rsuite.search.hits.max, so all results are sorted.
As of RSuite 3.7, content security is incorporated in the MarkLogic query, thereby reducing the need for larger bucket sizes.
This setting applies to both RSuite XPath Searches (RXS) and full-text searches.
- RXS supports only custom filters.
- Full text search supports custom filters, "reference by CA" filters, and "reference with contextual layered metadata" filters.

rsuite.search.estimate.usemarklogic

rsuite.search.estimate.usemarklogic = { TRUE | FALSE }

Use rsuite.search.estimate.usemarklogic to set RSuite to use MarkLogic's estimate of the total number of search results.

Usage notes

The estimate is used in the user interface, e.g., the "3476" in "30 results of 3476". Estimates are used because determining the actual total number of results can be prohibitively expensive.
The default is TRUE.
When rsuite.search.estimate.usemarklogic is FALSE, RSuite bases the estimate on the results retrieved as determined by the rsuite.search.hits.max setting.

rsuite.search.hits.max

rsuite.search.hits.max = results_max

Use rsuite.search.hits.max to limit the number of search results RSuite returns.

Usage notes

The default is 3000.
This property applies to all content searches including RSuite XPath Searches, API-level searches, full-text searches, filtered searches, and SmartFolders.
rsuite.search.hits.max makes rsuite.search.fulltext.hits.max obsolete.
When the number of results is greater than the value of the rsuite.search.bucketSize property, the search results may not sort properly. See rsuite.search.bucketSize.

Server settings

These properties define server identification settings used by RSuite. Property names are case-sensitive.

rsuite.server.host

rsuite.server.host = host_address

Use rsuite.server.host to specify the host name or IP address of RSuite. RSuite uses this property to generate URLs back to itself for schemas, images, and so on.

Usage notes

The default value is localhost.
The default value, localhost, is rarely a suitable value; it can be useful for evaluating RSuite CMS on a single machine or a development environment. When users access RSuite on a network, the value should be a DNS-resolvable host name or IP address of the server.
Prior to 3.1, this property was called RSUITE.IP. The RSuite server uses the value of RSUITE.IP if rsuite.server.host is not defined.

Examples

rsuite.server.host=foo.domain.com
rsuite.server.host=555.867.530.900

rsuite.server.port

rsuite.server.port = port-num

Use rsuite.server.port, in conjunction with rsuite.server.host, to specify the port at which the server listens.

Usage notes

The default value is 8080.
Prior to 3.1, this property was called RSUITE.PORT. The RSuite server uses the value of RSUITE.PORT if rsuite.server.port is not defined.

rsuite.server.session.timeout.secs

rsuite.server.session.timeout.secs = interval

Use rsuite.server.session.timeout.secs to override the default interval before an idle user session times out.

Usage notes

The interval is specified in seconds. The default is 14,400 seconds (4 hours).
rsuite.server.session.timeout.secs must be defined in rsuite_home/conf/rsuite.properties.xml. It is ignored if it appears in an auxiliary configuration file listed in the rsuite.conf.auxiliary.file.list property.

Examples

Set the timeout interval to 3 hours

rsuite.server.session.timeout.secs=10800

User Interface settings

These properties define user interface settings used by RSuite. Property names are case-sensitive.

rsuite.cms.icons.download.disabled

rsuite.cms.icons.download.disabled = TRUE

Use rsuite.cms.icons.download.disabled to suppress the display of the download icon for content items in RSuite v5.5 and later. By default, the icon is displayed.

Usage notes

Put rsuite.cms.icons.download.disabled=true in rsuite.properties to suppress the display of the download icon. To have the icon displayed and enabled, remove the property or comment it out.

Example

To suppress the download icon, add this to the rsuite.properties file:

rsuite.cms.icons.download.disabled=true

rsuite.image.auto.thumbnail.height

rsuite.image.auto.thumbnail.height= pixels

Use rsuite.image.auto.thumbnail.height to specify the height of automatically generated thumbnails.

Usage notes

The height is measured in pixels.
The default height is 170 pixels.

Examples

rsuite.image.auto.thumbnail.height=210

rsuite.image.auto.thumbnail.width.max

rsuite.image.auto.thumbnail.width.max= pixels

Use rsuite.image.auto.thumbnail.width.max to specify the maximum width of automatically generated thumbnails.

Usage notes

The width is measured in pixels.
The default maximum width is 255 pixels.

Examples

rsuite.image.auto.thumbnail.width.max=300

rsuite.image.auto.thumbnail.enabled

suite.image.auto.thumbnail.enabled = { TRUE | FALSE}

Use suite.image.auto.thumbnail.enabled to specify whether thumbnails for non-XML objects are displayed in the user interface.

Usage notes

The default setting is FALSE.

rsuite.image.auto.thumbnail.types

suite.image.auto.thumbnail.types = filetype , [ filetype ... ]

Use rsuite.image.auto.thumbnail.types to specify file types that can be used for thumbnails of non-XML objects in the user interface.

Usage notes

File types are specified in a comma-delimited list.
The default file type is eps.
Valid file types are:
- gif
- png
- jpg
- tif
- tiff
- psd
- eps

rsuite.inspect.icons.enabled

rsuite.inspect.icons.enabled = {TRUE|FALSE}

Use rsuite.inspect.icons.enabled to suppress the display and function of these buttons on the Inspect panel: Added to, Aliases, Contextual Metadata, and Permissions.

Usage notes

The default is TRUE. To suppress the display and function of the buttons, set the property to FALSE, rsuite.inspect.icons.enabled=false.
The property was introduced in RSuite 5.4.0.

rsuite.integration.imagemagick.home

rsuite.integration.imagemagick.home = filepath

Use rsuite.integration.imagemagick.home to specify the location of the subdirectory that contains the ImageMagick executable file.

Usage notes

Use ImageMagick to convert bitmap images to other types of bitmap images or to adjust bitmap size to create thumbnails or lower resolution images.
ImageMagick is not installed with RSuite. You can download it from http://www.imagemagick.org.

rsuite.integration.imagemagick.home=C:\Program Files\ImageMagick-7.0.4-6-Q16-x64
rsuite.integration.imagemagick.home=usr/local/imagemagick/bin

rsuite.locale.enabled

rsuite.locale.enabled = token [ , token [ , token ]]

Use rsuite.locale.enabled configuration to limit which languages can be used for messages.

Usage notes

The default is to enable all languages.

Languages are specified in a comma-delimited list of tokens:

Language	Token
English	`en`
German/Deutsch	`de`
Spanish/Espanol	`es`

Examples

rsuite.locale.enabled=en,de

rsuite.search.iconPageSize

rsuite.search.iconPageSize = item_count

Use rsuite.search.iconPageSize to set the number of items displayed per page in the icon view of content search results.

Usage notes

The default for item_count is rsuite.search.pageSize.

rsuite.search.pageSize

rsuite.search.pageSize= item_count

Use rsuite.search.pageSize to specify the number of items displayed on a page in the content search results.

Usage notes

The default for item_count is 24.

rsuite.semantics.enabled

rsuite.semantics.enabled = { FALSE | TRUE }

Use rsuite.semantics.enabled to turn on semantic features in RSuite v5.3 and later.

Usage notes

The default is FALSE. Set the value to TRUE to:
- turn triple stores on
- add the Link Types, Semantic Metadata Definitions, and Taxonomy pages to the navigation panel in the Admin view
- show the semantics menu in the Content view
The isSemanticsEnabled() method in the RSuiteServerConfiguration class also provides access to this property.

Example

rsuite.semantics.enabled=true

Workflow settings

In addition to these properties, the directory, log, and MySQL properties affect workflows. Property names are case-sensitive.

rsuite.graphviz.dot.executable.path

rsuite.graphviz.dot.executable.path = filepath

Use rsuite.graphviz.dot.executable.path to specify the location of the GraphicViz executable file.

Usage notes

The rsuite-workflow-visualizer plug-in uses the open-source Graphviz tool to generate pictures of workflow process definitions. It provides a custom report from which you can request workflow diagrams.
Download Graphviz from http://www.graphviz.org/Download.php.
Download the plug-in from the RSuite Support download site.

Examples

rsuite.graphviz.dot.executable.path=usr/local/graphicviz/bin

rsuite.workflow.execution.locktimemillis

rsuite.workflow.execution.locktimemillis = lock-time

lock-time: an integer expressing the lock time in milliseconds. Once a workflow task is started, no asynch job executor can acquire and restart it during the lock time.

Use rsuite.workflow.execution.locktimemillis to override the value of LockTimeInMillis in the Activiti Workflow Engine. LockTimeInMillis specifies the interval before the JobExecutor restarts a workflow task.

Usage notes

When several instances of a workflow run concurrently, tasks may repeatedly time out without finishing and then be restarted. This can happen, for example, if a workflow definition contains service task definitions with activiti:async="true", and the number of instances exceeds the pool size.
Use rsuite.workflow.execution.locktimemillis to increase LockTimeInMillis to give long-running tasks time to finish.
When rsuite.workflow.execution.locktimemillis is not specified in rsuite.properties, the value of LockTimeInMillis in Activiti is used.
LockTimeInMillis can also be reset by setting up a lifecycle listener and executing
```
rsuiteWorkflowEngine.getProcessEngineConfiguration().getJobExecutor()
         .setLockTimeInMillis(maxDuration)
```
This property was introduced with RSuite 5.4.0.

Example: Set lock time to 15 seconds

rsuite.workflow.execution.locktimemillis=15000

rsuite.workflow.execution.pool.pool_name.maxactive

rsuite.workflow.execution.pool . pool_name . maxactive = thread_count

Use rsuite.workflow.execution.pool.pool_name.maxactive to define the maximum number of concurrent threads a workflow pool can have active.

Usage notes

The default thread_count is 10.
Use this property to regulate the demand that a workflow pool places on the system.

Examples

rsuite.workflow.execution.pool.load.maxactive=10
rsuite.workflow.execution.pool.publish.maxactive=3
rsuite.workflow.execution.pool.default.maxactive=1

rsuite.workflow.execution.pools

rsuite.workflow.execution.pools = pool_name1 [ , pool_name2 [ , pool_name3 [ ... ] ] ]

Use rsuite.workflow.execution.pools to specify the names of the workflow pools.

Usage notes

By default, there is a single workflow pool named default. The default workflow pool is available even if rsuite.workflow.execution.pools names additional pools and does not name default.
The specified workflow pools share the allocated portion of memory.
The workflow manager assigns threads to jobs on a first-come–first-served basis, without regard to pools.
Pools can be configured differently to match the requirents of different groups of workflow definitions. E.g., pools can be configured with different numbers of threads to match the differing anticipated demands by instances of the workflow definitions associated with each pool.
To distribute jobs among several pools, extend the DefaultWorkflowExecutionAdvisor and register the new advisors in the plug-in descriptor. E.g., within AcmeWorkflowExecutionAdvisor#adviseBeforeExecution(), WorkflowExecutionAdvisorBeforeExecutionContext#setPreferredPoolName() can be used to route an inbound job to a specific pool.
```
<extensionProvider id="rsuite.Workflow">

  <workflowExecutionAdvisor 
    id="acme:workflowExecutionAdvisor"
    label="Acme Workflow Execution Advisor"
    handler="com.acme.rsuiteplugin.advisors.AcmeWorkflowExecutionAdvisor">
    <description>Sort incoming workflow jobs to the appropriate workflow pool</description>
  </workflowExecutionAdvisor>
  
  ...

</extensionProvider>
```
Figure 1. Example plug-in descriptor

rsuite.workflow.execution.pools=load,publish,default

rsuite.workflow.required.memory.available.percent

rsuite.workflow.required.memory.available.percent = threshold_avail_memory

Use rsuite.workflow.required.memory.available.percent to establish a check that there is a minimum portion of memory available before a new workflow instance is executed. If the specified threshold (a percentage) is 0, no check is made.

Usage notes

threshold_avail_memory can be any integer from 0 to 100. The default is 30.
If available memory is below this threshold, workflow instances are queued and executed as memory becomes available.
RSuite CMS deployments with large files (10MB or more) need to check available memory to prevent thrashing. Processing a large XML file can require 10 times the file size in memory (RSuite server uses a DOM internally), and so concurrent workflows processing large XML files can leave too little memory for an additional workflow to work effectively.

Examples

The example is appropriate for an RSuite installation where the typical large XML file is 20MB and the RSuite server has 1GB of RAM.

rsuite.workflow.required.memory.available.percent=25

rsuite.workflow.search.default.filters

rsuite.workflow.search.default.filters = { filter-list | none }

filter-list: A comma-delimited list of built-in filters to be displayed. A space after a comma is optional. The default list is "My Tasks,Available Tasks, My Completed Tasks,My Overdue Tasks, My Critical Tasks, My Imminent Tasks,My High Priority Tasks"
none: Default. No built-in filters are displayed on the UI. The value is case-independent; quotation marks are optional: e.g., None, "none".

In RSuite 5.3.3 and later, use rsuite.workflow.search.default.filters to configure the list of built-in filters that are displayed on the navigation panel of the Workflow tab.

The first example limits the displayed filters to "My Overdue Tasks" and "My Critical Tasks".

Examples

rsuite.workflow.search.default.filters="My Overdue Tasks, My Critical Tasks"
rsuite.workflow.search.default.filters=none
rsuite.workflow.search.default.filters="NONE"

rsuite.workflow.search.maxResultSet

rsuite.workflow.search.maxResultSet= number

Use rsuite.workflow.search.maxResultSet to limit the number of workflow search results that are displayed.

Usage notes

Adjust the value of rsuite.workflow.search.maxResultSet so workflow searches return results within an acceptable time. Search results can be delayed if there is a large number of results to display, as can happen when there are many workflow instances running. Response time is not very sensitive to the number of tasks or the total number of the results.
The default is rsuite.workflow.search.maxResultSet=600.

XML repository settings

These properties define the XML repository (MarkLogic) settings used by RSuite. Property names are case-sensitive.

rsuite.repository.server

rsuite.repository.server = address

Use rsuite.repository.server to specify the host name or IP address of the XML repository.

The address defaults to localhost.
Prior to 3.0, the property was called server. The RSuite server uses the value of server if rsuite.repository.server is not defined.

Examples

rsuite.repository.server=127.0.0.1
rsuite.repository.server=foo.domain.com

rsuite.repository.port

rsuite.repository.port= port

Use rsuite.repository.port to specify the port value (TCP) where the XML repository is located.

Usage notes

The default value of port is 8002
Prior to RSuite 3.0, the property was called port. The RSuite Server uses the value of port if rsuite.repository.port is not defined.

Examples

rsuite.repository.port=9000

rsuite.repository.user

rsuite.repository.user= user_name

Use rsuite.repository.user to specify the user name portion of the credentials for connecting to the XML repository.

The default user name is admin.
Prior to 3.0, the property was called user. The RSuite Server uses the value of user if rsuite.repository.user is not defined.

Examples

rsuite.repository.user=jsmith

rsuite.repository.password

rsuite.repository.password = { plain: pw | encryptedpassword }

Use rsuite.repository.password to specify the password portion of the credentials for connecting to the XML repository.

Usage notes

The default value is an empty string.
During installation, the user enters a plain text value. The installer adds the "plain:" prefix. Contact RSuite Support if you want to encrypt this value.
Prior to RSuite 3.0, the property was called password. The RSuite Server uses the value of password if rsuite.repository.password is not defined.

rsuite.repository.password=plain:admin
rsuite.repository.password=fafd09ufdsa3099dvnj3ckjdfHHE

rsuite.repository.impl

rsuite.repository.impl = java_class

Use rsuite.repository.impl to specify the Java implementation class of the XML repository, currently MarkLogic Server.

Usage notes

"MarkLogic" is an alias for com.reallysi.rsuite.system.repository.MarkLogic.

Examples

rsuite.repository.impl=com.reallysi.rsuite.system.repository.MarkLogic
rsuite.repository.impl=MarkLogic

Other settings

These are miscellaneous settings. Property names are case-sensitive.

rsuite.commands.lsof

rsuite.commands.lsof = filepath

Use rsuite.commands.lsof to specify the path to the Unix lsof command, which is used to determine whether a file is open.

Usage notes

The default file path is rsuite.commands.lsof=/usr/sbin/lsof.
This property has no effect when the RSuite server is running on Windows.

COMPANY.NAME

COMPANY.NAME = name

name: An ID token provided with the RSuite license. It is specific to the RSuite instance and generally reflects the company name and system configuration.

Use the COMPANY.NAME property to expose the company ID token you received with your RSuite license.

Usage notes:

The COMPANY.NAME property should be specified at the top of the rsuite.properties file.
RSuite displays the company name token as the Licensee name on the License view of the Admin tab.

Example

COMPANY.NAME=XYZ-test
LICENSE.KEY=PxkK8ZoEWVoQSS3SGoCbtQ==

LICENSE.FILE

LICENSE.FILE = file-path

file-path: The path to the RSuite license key file. The license key file can be placed anywhere.

In RSuite 5.0.3 and later, use the LICENSE.FILE property to identify the text file that contains the license key for the RSuite instance.

Usage notes:

Place the LICENSE.FILE property at the top of the rsuite.properties file, after the COMPANY.NAME property, as shown in the example.
The licence file is a text file. It must be used for v2-type license keys, which are long and might be multi-line.
V1-type license keys can be supplied in a license file. They can also be specified with the license key property; see LICENSE.KEY. One or the other of the LICENSE.KEY property or the LICENSE.FILE property is required.

Example

COMPANY.NAME=XYZ-test
LICENSE.FILE=rsuite-home/conf/rsuite.license

LICENSE.KEY

LICENSE.KEY = v1-type-key

v1-type-key: A v1-type license key, supplied by Orbis.

Use the LICENSE.KEY property to declare a v1-type licence key for the RSuite instance.

Usage notes:

Place the LICENSE.KEY property at the top of the rsuite.properties file, after the COMPANY.NAME property, as shown in the example.
V1-type license keys can also be declared with a license key file; see LICENSE.FILE. One or the other of the LICENSE.KEY property or the LICENSE.FILE property is required.

Example

COMPANY.NAME=XYZ-test
LICENSE.KEY=PxkK8ZoEWVoQSS3SGoCbtQ==

rsuite.security.inheritContentAssemblyACL.enabled

rsuite.security.inheritContentAssemblyACL.enabled = { TRUE | FALSE }

Use rsuite.security.inheritContentAssemblyACL.enabled to specify whether, when a new object is loaded into the system, it inherits the Access Control List (permission settings) of the container or container node to which it is attached.

Usage notes

The default value is TRUE.

Element range indexes

Configure element range indexes to take advantage of MarkLogic's universal index in RSuite to speed faster searches.

Element range indexes speed the return of results from:

Full text searches on search fields that use a date or datetime type
RSuite XPath Search (RXS) searches
Custom XQuery searches
Searches using inequality constraints

Another advantage of element range indexes is iyou can ncorporate enhanced sorting in search results. On the other hand, indexing slows document loading and requires additional memory and storage. See the MarkLogic documentation for information about a procedure and query for evaluating the memory and storage costs of index configurations.

For example. element range indexes are useful:

For retrieving system metadata for the created date
When you use inequality constraints to compare two values—results are returned faster if one value is based on an element range index
To speed returning a list of XQuery values—the index is maintained in memory, so the search is faster than if the data have to be fetched from disk

Inherent metadata

Defining a element range index for inherent metadata (the customer's XML data model) requires the namespace URIs, local names, and scalar type. An element-attribute range index may be best.

MarkLogic requires that in inherent metadata all the values within a qualified name be of the same scalar type. If the values in the index cannot be cast to a single scalar type, clean up the data or denormalize it in a new element or attribute.

When data sets use the same qualified name, as a workaround create unique qualified names by modifying the existing markup or denormalizing in new elements or attributes.

Inequality comparisons

Use the following information to create the element range indexes for inequality comparisons with RSuite XPath Search (RXS).

Inequality constraints can be performed without element range indexes. This requires that MarkLogic pull candidate fragments from disk before performing the comparison. Range indexes speed this operation as it is performed in memory. See the MarkLogic documentation for a procedure and query to compare the memory and storage cost of two index configurations.

Different predicates should be used depending on the element range index configuration. If an element range index for the specified piece of metadata is not available, use this technique. It will not use element range indexes, even if there is one.

value1 operator value2

Figure 2. Without range index

For example:

/book[rmd:get-lmd-value(., 'subscription-ends') <=xs:gYearMonth('2011-10-05:00')]

When element range indexes are available, use this technique. An error occurs if this technique is used and the element range index is not available.

cts:contains(., cts:element-range-query(qname, operator, value))

Figure 3. With range index

For example

/book[cts:contains(., cts:element-range-query(xs:QName(
            'mv-lmd:subscription-ends'), '<=', xs:gYearMonth(
            '2011-10-05:00')))]

This technique requires that the namespace prefix be included. For more information, see Default namespace prefixes.
When using element range indexes, all values in the index must be cast to the specified scalar type. Otherwise, an XDMP-CAST exception may be thrown.

Default namespace prefixes

RSuite XPath Search (RXS) expressions usually use RXS functions to search for layered, system, and variant metadata without knowing the RSuite markup for this information. However, there may be instances where you use these namespace prefixes instead.

The default namespace prefixes that are typically used include:

r provides access to reference markup in the http://www.rsuitecms.com/rsuite/ns/metadata namespace, specifically non-XML managed objects (r:nonxml) and the RSuite ID (r:rsuiteid).
rmd provides access to RSuite's metadata RXS extensions

These namespace prefixes can be used to refer to an element range index.

mv provides access to system metadata
mv-lmd provides access to layered metadata range indexes for inequality constraints
mv-vmd provides access to variant metadata

For more information about creating element range indexes, see Element range indexes.

System metadata indexes

You can use the following element range indexes to define system metadata using the MarkLogic Admin Console. Define the subset of indexes that will be used by inequality constraints. These indexes can also be created in support of other functions requiring indexes, such as cts:element-values().

All system metadata elements are in the materialized view namespace, URI: http://www.rsuitecms.com/rsuite/ns/materialized-view.

System Metadata Indexes
Description	Local Name	Scalar Type	RXS Function
Date object was created. Well-suited for inequality constraints. The index may be used to select assets created before, after, or within two dates.	date-created	dateTime	rmd:get-date-created
Date object was last modified. Well-suited for inequality constraints. The index may be used to select assets modified before, after, or within two dates.	last-modified	dateTime	rmd:get-date-modified
Display name of object. Does not apply to XML managed objects.	display-name	string	rmd:get-display-name
MIME type of object.	mime-type	string	rmd:get-mime-type
Target ID of a container or managed object reference.	target-id	string	rmd:get-target-id

Variant metadata indexes

You can use element range indexes to define variant metadata using the MarkLogic Admin Console. Variant metadata is applicable only to binary managed objects. Define the subset of indexes that are used by inequality constraints. These indexes can also be created in support of other functions requiring indexes, such as cts:element-values().

All variant metadata elements are in the variant metadata namespace, URI: http://www.rsuitecms.com/rsuite/ns/materialized-view/variant-metadata.

Variant metadata indexes
Description	Local Name	Scalar Type	RXS Function
Date variant was created. Well-suited for inequality constraints. The index is used to select variants created before, after, or within two dates.	date-created	dateTime	rmd:get-vmd-dates-created
Date variant was last modified. Well-suited for inequality constraints. The index is used to select variants modified before, after, or within two dates.	last-modified	dateTime	rmd:get-vmd-dates-modified
MIME type of variant.	mime-type	string	rmd:get-vmd-mime-types
File name of variant.	filename	string	rmd:get-vmd-filenames
File extension of variant.	file-ext	string	rmd:get-vmd-file-extensions
File size. Well-suited for inequality constraints. The index isused to select variants with sizes greater than, less than, or between two specified sizes.	size	int	rmd:get-vmd-file-sizes

Layered metadata indexes

You can create element range indexes to define layered metadata. Unlike system and variant metadata, layered metadata is not predefined. When introducing layered metadata to the system that you want to index, ensure each instance of that metadata is cast to the scalar type defined for the index. Otherwise, an XDMP-CAST exception might be thrown when attempting to access the index.

All layered metadata elements are in the layered metadata namespace, URI: http://www.rsuitecms.com/rsuite/ns/materialized-view/layered-metadata. The local name must match the layered data name. The same local name can be submitted to rmd:get-lmd-value* functions within the context of RXS search.

Configuring element range indexes

Stop RSuite.
Open the MarkLogic administration center: StartAll ProgramsMarkLogic ServerAdmin MarkLogic Server
Seklect ConfigureDatabasesyour database nameElement Range IndexesAdd tab.
To create an index for selecting system and variant metadata created before, after, or within two dates, enter these parameters:

scalar type

dateTime

namespace URI

http://www.rsuitecms.com/rsuite/ns/materialized-view

localname

date-created

range value positions

Set to false (the default).
To create an index for selecting system and variant metadata modified before, after, or within two dates, click more items and enter these parameters:.

scalar type

dateTime

namespace uri

http://www.rsuitecms.com/rsuite/ns/materialized-view

localname

last-modified

range value positions

False (the default).
Add as many index definitions as your environment requires.
Click OK to save the new index definitions.

Configuring wildcard searching

Use wildcards to represent unknown XML elements or attributes in RSuite XPath Search (RXS) search.

Stop RSuite.
In the MarkLogic administration center, configure word query settings for your environment.
1. Got to ConfigureDatabaseyour database nameWord Query.
2. Select the checkboxes:
  - stemmed searches
  - trailing wildcard searches
  - trailing wildcard word positions
  Refer to the MarkLogic help for further details about the impact of these settings.
3. Click OK to save the new wildcard settings.

Notices​

About this book ​

Authentication settings ​

rsuite.auth.ldap.username ​

Usage notes

Examples

rsuite.auth.ldap.password ​

Usage notes

Examples

rsuite.auth.ldap.protocol ​

Usage notes

Examples

rsuite.auth.ldap.host ​

Usage notes

Examples

rsuite.auth.ldap.port ​

Usage notes

Examples

rsuite.auth.ldap.root-dn ​

Usage notes

Examples

rsuite.auth.ldap.pool.max-connections ​

Usage notes

rsuite.auth.ldap.secure ​

Usage notes

rsuite.auth.ldap.keystore ​

Usage notes

Examples

rsuite.auth.ldap.keystorepass ​

Usage notes

Examples

rsuite.auth.providers ​

Usage notes

Examples

Trouble-shooting rsuite.auth.providers

rsuite.server.logininfo.expiration.days ​

Usage notes

Examples

Content settings ​

rsuite.content.treat-as-xml.ext ​

Usage notes

dita-ot.default.path ​

Usage notes

Examples

rsuite.nonxml.textextract ​

Usage notes

rsuite.api.maxuploadsize.mb ​

Usage notes

Examples

rsuite.nonxml.textextract.filesize.max ​

Usage notes

Example

Directory and file settings ​

rsuite.nonxml.dir ​

Usage notes

Examples

rsuite.temp.dir ​

Usage notes

Examples

rsuite.var.dir ​

Usage notes

Examples

rsuite.plugins.dir ​

Examples

rsuite.workflow.baseworkfolder ​

Usage notes

Examples

rsuite.report.generated.base.dir ​

Usage notes

Examples

rsuite.conf.alternate.dir ​

Examples

rsuite.conf.auxiliary.file.list ​

Usage notes

Examples

Editor settings ​

oxygen.server.webapp ​

Usage notes

Example:

oxygen.server.webapp.autoSaveInterval ​

Notices

About this book

Authentication settings

rsuite.auth.ldap.username

rsuite.auth.ldap.password

rsuite.auth.ldap.protocol

rsuite.auth.ldap.host

rsuite.auth.ldap.port

rsuite.auth.ldap.root-dn

rsuite.auth.ldap.pool.max-connections

rsuite.auth.ldap.secure

rsuite.auth.ldap.keystore

rsuite.auth.ldap.keystorepass

rsuite.auth.providers

rsuite.server.logininfo.expiration.days

Content settings

rsuite.content.treat-as-xml.ext

dita-ot.default.path

rsuite.nonxml.textextract

rsuite.api.maxuploadsize.mb

rsuite.nonxml.textextract.filesize.max

Directory and file settings

rsuite.nonxml.dir

rsuite.temp.dir

rsuite.var.dir

rsuite.plugins.dir

rsuite.workflow.baseworkfolder

rsuite.report.generated.base.dir

rsuite.conf.alternate.dir

rsuite.conf.auxiliary.file.list

Editor settings

oxygen.server.webapp

oxygen.server.webapp.autoSaveInterval

rsuite.edit.admin.userid

Logging settings

rsuite.logs.dir

rsuite.repository.logging.enabled

rsuite.search.logging.enabled

rsuite.workflow.logs.base.dir

Mail settings

rsuite.mail.auth.enabled

rsuite.mail.host

rsuite.mail.password

rsuite.mail.port

rsuite.mail.protocol

rsuite.mail.ssl.enable

rsuite.mail.starttls.enable

rsuite.mail.user

MySQL server settings

rsuite.commands.mysql

rsuite.commands.mysql-dump

hibernate.connection.url

hibernate.connection.username

hibernate.connection.password

Search settings

rsuite.search.bucketSize

rsuite.search.estimate.usemarklogic

rsuite.search.hits.max

Server settings

rsuite.server.host

rsuite.server.port

rsuite.server.session.timeout.secs

User Interface settings

rsuite.cms.icons.download.disabled