Skip to main content
Version: 7.8

Blueprint Configuration

Blueprint File

Each Resolve Actions Pro component is configurable and has to be customized according to the specific architecture and environment. Actions Pro components are managed through a Blueprint file which contains configuration settings for all components:

  • Each core server with Actions Pro installed has its own Blueprint file located in <actions-pro-home>/rsmgmt/config/blueprint.properties with a symlink to it in <actions-pro-home>/bin/.
    The properties of this file are detailed in the current document.
  • Each standalone RSRemote deployment has its own Blueprint file located in <actions-pro-home>/rsmgmt/config/blueprint.properties.
    The properties of this file are detailed in ::title.

The Blueprint file contains configuration settings for all Actions Pro components. The first section of the Blueprint contains installation parameters that need to be set before installing Actions Pro. After installation, you may need to modify the Blueprint file to optimize or customize Actions Pro for your particular environment.

In a clustered deployment, the connection settings need to be the same between Blueprint files. Other settings, such as gateway configurations, may be set individually between Blueprint files.

Blueprint Syntax

The following is special syntax used in the blueprint.properties file. They are mostly used to change the value of properties before being applied to the local Actions Pro environment (i.e., encrypting values or referencing other property values).

Reserved Variables

The following Variables are reserved by the Blueprint and cannot be overwritten.

  • ${DIST}—Installation Directory of Actions Pro

Syntax

The following table describes the syntax of the Blueprint.

ItemDescription
#Used at the start of a line to add a comment.
${}Reference to other parameters in the Blueprint; for example, ${PRIMARY} will reference the value of PRIMARY.
ENC:Deprecated. A value encrypted with an older encryption method.
ENC1:An encrypted value; by default, all non-reference, plain text password fields will be encrypted after running config.sh/config.bat.
NO_ENC:Used to leave a password field unencrypted or as plain text; for example, DB_PASSWORD=NO_ENC:resolve will be left as is after config, even though it is a password field.
TO_ENC:Used to specify a value that needs to be encrypted after running config.sh/config.bat which is not normally encrypted; for example, rsmq.username=TO_ENC:resolve after config.sh/config.bat is run becomes rsmq.username=ENC1:encrypted text.

Modifying the Blueprint and Re-configuring RSRemote

The file is named blueprint.properties and is located in the <installPath>/rsmgmt/config directory. In UNIX environments, there is a softlink to this file in the bin directory.

caution

Do not remove the blueprint.properties file located in the rsmgmt/config directory! Your Actions Pro installation will not operate without this file.

When setting up the blueprint file, use a forward slash / instead of a backslash \. If you do use a backslash, double it \\ because Java treats the single backslash as an escape.

If you make a mistake configuring the JAVA_HOME variable, it can not be fixed.

Modifying the Blueprint

You can edit the Blueprint file using any text editor. The Blueprint file contains simple name=value pairs. These configuration options are described in detail in other sections.

Applying the Blueprint Configuration

Actions Pro must be reconfigured using the modified Blueprint before changes will take effect.

  1. Stop all Actions Pro processes whose configurations are being changed.
  2. Modify the blueprint.properties file for the new configuration.
  3. Run the config.sh file, located in <installPath>/bin/ by using the following:
    bin/config.sh
  4. After the configuration script completes, restart Actions Pro.

Required Settings

The following settings are required for the Actions Pro installation. For standalone systems, the loopback address of 127.0.0.1 can be used, but if the standalone instance will be clustered at a later date, then it is better to use a valid IP or hostname.

PropertyDescriptionDefault Value
PRIMARYWhether the machine is the Primary machine. The Primary machine creates DB tables and RSSearch indices and gathers Reporting metrics.

When doing a standalone installation, ensure that this is set to true.
true
CLUSTERNAMEName of the RSSearch cluster. Set it to be the same between all machines.

Must be unique for a deployment (e.g., PRODUCTION, DEVELOPMENT, TESTING).
RESOLVE
SERVER_IDThe ID for the local server.1
LOCALHOSTThe hostname or IP address of the local server.

Change to the actual IP address or hostname of the machine.

The value is automatically set to the output of the hostname OS command if left blank.
127.0.0.1
RSVIEW_NODESComma-separated list of the hostnames or IP addresses of all nodes running RSView, including the local machine if the component runs on it.

Preferably, keep the list order the same between each node’s Blueprint.

For standalone installations, set to the IP of the local machine.
127.0.0.1
RSSEARCH_NODESComma-separated list of the hostnames or IP addresses of all nodes running RSSearch, including the local machine if the component runs on it.

Preferably, keep the list order the same between each node’s Blueprint.

For standalone installations, set to the IP of the local machine.
${RSVIEW_NODES}
RSCONTROL_NODESComma-separated list of the hostnames or IP addresses of all nodes running RSControl, including the local machine if the component runs on it.

Preferably, keep the list order the same between each node’s Blueprint.

For standalone installations, set to the IP of the local machine.
127.0.0.1
DB_TYPEThe type of the SQL database that you prepared to work with Actions Pro. Possible values: mysql, oraclemysql
DB_HOSTHost name or IP of the machine where the SQL database is running.127.0.0.1
DB_USERNAMEUsername for Actions Pro to use to connect to and write in the SQL DB.resolve
DB_PASSWORDPassword for DB_USERNAME.resolve
DB_NAMEThe name of the SQL database for Actions Pro to use.resolve
DB_SCHEMAThe name of the SQL database schema to use. Leave blank to automatically use the DB_NAME (for MySQL) or DB_USERNAME (for Oracle).
DB_URLJDBC URL to use to connect to the database. If left blank (not recommended), it will be generated from the DB_HOST and DB_NAME based on the DB_TYPE. For more complex cases, such as when enabling SSL, ensure that you have entered the full connection string.No default

Example:
jdbc:oracle:thin:@//127.0.0.1:1521/resolve or jdbc:mysql://mysql.example.com:3306/my_database?useSSL=true&serverTimezone=UTC
RSMQ_PRIMARY_HOSTThe hostname or IP address of the RSMQ machine. For standalone installations, set to the IP of the local machine.127.0.0.1
RSMQ_PRIMARY_PORTPort used by the RSMQ service.4004
RSMQ_BACKUP_HOSTClustered installations only. The hostname or IP address of the Backup RSMQ node.
RSMQ_BACKUP_PORTClustered installations only. Port used by the Backup RSMQ service.4004
# Installed Components resolve.<component>Choose which Actions Pro components to install on the current machine. You don’t need to change this section for a single-machine installation.

Components set to true will install on the current machine; components set to false will not. The reference to another property (e.g. ${PRIMARY}, ${resolve.rslog}) will take the value of that property.

Components with *_NODES list properties are automatically set to false if the LOCALHOST property value is not found in the respective *_NODES list.
resolve.rscontrol=true
resolve.rsremote=true
resolve.rsview=true
resolve.rsmq=true
resolve.rsconsole=true
resolve.rsmgmt=true
resolve.rssearch=true
resolve.rssync=false
resolve.rslog=${PRIMARY}
resolve.logstash=${resolve.rslog}
resolve.kibana=${PRIMARY}
resolve.rsvault=false
resolve.rskeyservice=false

Optional Settings

The following settings are optional to the configuration. These settings can be used to configure the resources available to the different components installed on this server.

PropertyDescriptionDefault Value
resolve.userLinux user that Actions Pro will run under.resolve
rsmq.XmsRSMQ minimum memory allocated in MB.256
rsmq.XmxRSMQ maximum memory allocated in MB.512
rscontrol.run.XmsRSControl minimum memory allocated in MB.256
rscontrol.run.XmxRSControl maximum memory allocated in MB.1024
rsview.run.XmsRSView minimum memory allocated in MB.256
rsview.run.XmxRSView maximum memory allocated in MB.1024
rsremote.run.XmsRSRemote minimum memory allocated in MB.256
rsremote.run.XmxRSRemote maximum memory allocated in MB.512
rsremote.esb.queue.name.1Queue name that RSRemote will listen to. The queue will be created if it doesn’t exist.

You can add multiple RSRemote queues by duplicating the property with an increasing number (rsremote.esb.queue.name.2, rsremote.esb.queue.name.3, ...) and setting it to a different value. This can be useful if RSRemote needs to be targeted by specific tasks.

Alternatively, you can remove all queues if you want the RSRemote to only perform gateway functions.
RSREMOTE
rsmgmt.run.XmsRSMgmt minimum memory allocated in MB.64
rsmgmt.run.XmxRSMgmt maximum memory allocated in MB.512
rssearch.run.XmsRSSearch minimum memory allocated in MB.4096
rssearch.run.XmxRSSearch maximum memory allocated in MB.4096
rssync.run.XmsRSSync maximum memory allocated in MB.1024
rssync.run.XmxRSSync maximum memory allocated in MB.1024
logstash.run.XmsRSLogstash maximum memory allocated in MB.1024
logstash.run.XmxRSLogstash maximum memory allocated in MB.1024
rsremote.run.ld_library_pathFull path to a .so library file needed for an ActionTask in RSRemote.
search.ttlHow long does Elasticsearch store files, in seconds.7776000

The following table shows the recommeded database-related settings.

Database PropertyRecommended Value
rscontrol.jta.max_actives500
rsview.jta.max_actives1500
rscontrol.sql.maxpoolsize200
rsview.sql.maxpoolsize400
rsview.general.maxthread200
rscontrol.general.maxthread100
rsremote.general.maxthread500
rsmgmt.general.maxthread100

RSRemote Queue Names

RSRemote can be configured to listen to different AMQP queues. This allows tasks to target a specific RSRemote or sets of RSRemotes when necessary. For example, if a task needs to connect to a router that is only available to a certain RSRemote, that RSRemote can be configured to listen to a ROUTER queue. Or, if a task must be executed on a Windows machine, it can target only RSRemotes listening to the WINDOWS queue.

All RSRemote instances listen to the RSREMOTE queue (rsremote.esb.queue.name=RSREMOTE) by default. This is the queue used by all tasks that do not explicitly set a target queue. Also, any gateways set up on the RSRemote will listen on a specified queue.

Additional queues can be added to target specific RSRemotes with tasks by:

  • Copying the rsremote.esb.queue.name.1 property and changing the value and number (e.g. rsremote.esb.queue.name.2=WINDOWS)
  • Configuring gateways (Blueprint File - Gateways).
  • Optionally, the value rsremote.esb.queue.name.1 can also be removed so the RSRemote will only listen to queues that are added automatically by gateways.

Multiple RSRemote queues can be added by:

  1. Copying the rsremote.esb.queue.name.1 property line.
  2. Incrementing the number (e.g. rsremote.esb.queue.name.2=NEWQUEUE).

This can be useful if the RSRemote needs to be targeted by specific tasks. Alternatively, all queues can be removed if the RSRemote should only perform gateway functions.

Encrypted Password Fields

Any field that is a password field is automatically encrypted after running the config.sh/config.bat file to apply the blueprint.properties file. The following syntax can be used to either force or skip encryption of properties in the Blueprint file:

SyntaxDescription
#NO_ENCLeaves the password field unencrypted, for example, DB_PASSWORD=NO_ENC:resolve
#TO_ENCSpecifies a value that needs to be encrypted after running config.sh/config.bat; for example, rsmq.username=TO_ENC:resolve

Reserved and Reference Variables

The following variables are reserved within Actions Pro and provide the values shown below. These variables cannot be set by the user or used as user-defined values.

The following table lists the Preprocessor variables.

NameDescription
LOGLog object used to append to RSControl log
DBDatabase connection object
ESBObject used to send Messages through RSMQ
PROCESSIDProcess ID of Runbook execution
PROBLEMIDWorksheet ID
WIKIName of the Runbook wiki document page
PARAMSPARAM parameter map
FLOWSFLOW parameter map
INPUTSINPUT parameter map
OUTPUTSOUTPUT parameter map that contains OUTPUT variables set in the Assessor of previous task in the Runbook sequence
GLOBALSObject used to get and set GLOBAL variables

The following table lists the Content (RSRemote) variables.

NameDescription
LOGLog object used to append to RSControl log
REFERENCEExternal System Reference, for example, Netcool ServerName:ServerSerial:Serial
PARAMSPARAM parameter map
FLOWSFLOW parameter map
INPUTSINPUT parameter map
PROBLEMIDWorksheet ID
WIKIName of Runbook wiki document page
SESSIONSObject used to persist a connection in a Runbook

The following table lists the Assessor variables.

NameDescription
ACTIONNAMEName of ActionTask
RAWRaw results from an ActionTask
DATAParsed raw data from the Parser
DATATYPEType of parsed data (STRING, XML, MAP, LISTMAP)
LOGLog object used to append to RSControl log
DBDatabase connection object
ESBObject used to send messages through RSMQ
PROCESSIDProcess ID of Runbook execution
EXECUTEIDExecute ID of an ActionTask
PROBLEMIDWorksheet ID
REFERENCEExternal System Reference, for example, Netcool ServerName:ServerSerial:Serial
WIKIName of the Runbook wiki document
INPUTSINPUT parameter map
PARAMSPARAM parameter map
FLOWFLOW parameter map
RESULTResults object that contains the ActionTask completion, condition, severity, summary, and detail
OUTPUTOUTPUT parameter map, for assessor it will be empty
RECORDWorksheet field hashmap to allow worksheet fields to be set
GLOBALSObject used to get and set GLOBAL variables

Blueprint File Advanced Settings

The Blueprint file contains additional settings and values beyond those described in the Installation Guides. These values are listed here for reference.

caution

Do not modify unless specifically instructed to by support.

RSMQ Settings

Property NameDescriptionDefault Value
rsmq.userUser to match against specified user during update and installation.${resolve.user}
rsmq.primary.ipaddressPrimary ipaddress used by rsmq.${RSMQ_EXTERNAL_PRIMARY_HOST}
rsmq.primary.portPrimary port used by rsmq.${RSMQ_EXTERNAL_PRIMARY_PORT}
rsmq.backup.ipaddressBackup ip address used by rsmq.${RSMQ_EXTERNAL_BACKUP_HOST}
rsmq.backup.portBackup port used by rsmq.${RSMQ_EXTERNAL_BACKUP_PORT}
rsmq.usernameUsername set for rabbitmq.admin
rsmq.passwordPassword set for rabbitmq.resolve
rsmq.management.portPort that RabbitMQ's management plugin runs on.15672
rsmq.epmd.portPort used by epmd.4369
rsmq.inet.portPort used by inet.35197
rsmq.productProduct used byrs.RABBITMQ
rsmq.primary.nameName of the primary erlang node-and-machine combination.${rsmq.primary.ipaddress}
rsmq.backup.nameName of the backup erland node-and-machine combination.${rsmq.backup.ipaddress}
rsmq.vhost/

RSSearch Settings

Data Management RSSearch Settings

Blueprint PropertyDefault ValueDescription
rssearch.shardsConfigures the number of Elasticsearch shards per index. It is highly recommended that this value is set to 1.1
rssearch.lsm.rolloversizeHot Phase setting. How many days old an index must be before rolling over. The value should be set such that the largest index (usually task results) never goes above 20GB before rolling over.  The value may also be set to a size rollover by removing the “d” from the configuration (e.g. rssearch.lsm.rolloversize=20).
note

For high volume environments, this value may need to be adjusted. See Considerations for High-Volume Environments for more information.

7d
rssearch.lsm.readonlydaysWarm Phase setting.  How long, in days, after the index has rolled over before it is marked as read-only.  If there are any runbooks using events that may go over 1 day this would need to be increased.  May be set to 0 to turn off this phase.
note

If using automation that takes longer than

1
rssearch.lsm.freezedaysCold Phase setting. How long, in days, after the previous phase the index is frozen.  A frozen index will not be searched using an alias thereby reducing memory usage.  Freezing the index requires a close and reopen during which the cluster will be “red”.  So on high volume systems this may need to be turned off by setting the value to 0.30
rssearch.lsm.deletedaysAbsolute Retention. How long, in days, after the previous phase the index is deleted.
note

This is our recommended value. If a longer retention period is required, see Considerations for Longer Retention Period.

365

Other RSSearch Settings

Property NameDescriptionDefault Value
rssearch.run.R_USERName of the Actions Pro user in Elasticsearch.${resolve.user}
rssearch.run.terminatetimeoutHow long does it take to an Elasticsearch request to timeout.30
rssearch.serverlistList of all servers that have RSSearch installed on them.${RSSEARCH_NODES}
rssearch.clienttypeSet whether clients should be node or transport.transport
rssearch.indexthreadsdeprecаted
rssearch.indextimoutHow long does it take to an index request to timeout. In seconds.120
rssearch.indexretriesNumber of attempts to read or write to an index.5
rssearch.yml.network.bind_hostHost that the ES node will bind on.${LOCALHOST}
rssearch.yml.network.hostHost that the ES node will bind and publish.${LOCALHOST}
rssearch.yml.transport.tcp.portPort that ES will bind for communication between nodes.9300
rssearch.yml.cluster.namename used to discover and auto-join nodes${CLUSTERNAME}
rssearch.yml.node.namename used by ES to identify the name${LOCALHOST}
rssearch.yml.http.portport ES binds for http use9200
rssearch.yml.discovery.zen.ping.unicast.hostsarray or comma delimited, in the form of host:port or host, t${RSSEARCH_NODES}
rssearch.yml.bootstrap.mlockallset to true to lock the process address space into ram preventing elasticsearch memory from being swapped outtrue
rssearch.yml.cluster.initial_master_nodes${RSSEARCH_NODES}
rssearch.yml.bootstrap.memory_locktrue
rssearch.yml.reindex.remote.whitelist${LOCALHOST}:*, localhost:*
rssearch.unicast.hosts_portdeprecаted
rssearch.yml.discovery.zen.minimum_master_nodesSets the minimum number of master eligible nodes that are needed for an election to complete, If -1, will default to N/2 + 1 where N is the number of RSSEARCH_NODES.1
rssearch.yml.shield.http.sslSet to 'true' to enable ssl on communications between http clients and the cluster.false
rssearch.yml.shield.ssl.keystore.pathFull path to the node keystore file.${rsview.tomcat.connector.https.keystoreFile}
rssearch.yml.shield.ssl.keystore.passwordPassword used to decrypt the keystore.${rsview.tomcat.connector.https.keystorePass}
rssearch.yml.shield.ssl.keystore.key_passwordPassword entered at the end of the keytool -genkey command.
rssearch.yml.shield.transport.sslSet to 'true' to ensure encrypted communication between the nodes.false
rssearch.replicasNumber of copies owned by a shard. Set to -1 for each shard to have a copy on each node.If -1, will default to N/2 + 1where N is the number of RSSEARCH_NODES1
rssearch.syncSet to 'true' to sync RSSearch nodes.false
rssearch.syncclusterName of the remote cluster used for discovery.${RSSEARCH_SYNC_CLUSTERNAME}
rssearch.syncserverlistList of server nodes to sync.${RSSEARCH_SYNC_NODES}
rssearch.syncserverlistPort to sync RSSearch nodes over.9300

RSControl Settings

The following lists shows the logical groups of RSControl properties and their default values.

  • RSControl config.xml general information
    rscontrol.general.home=${DIST}
    rscontrol.general.clustername=${CLUSTERNAME}
    rscontrol.general.configfileversion=1.0
    rscontrol.general.configrevisions=2
    rscontrol.general.saveconfigonstart=true
    rscontrol.general.saveconfigonexit=true
    rscontrol.general.savecrononexit=false
    rscontrol.general.cronoffset=0
    rscontrol.general.scheduledpool=200
    rscontrol.general.taskExecutor.executorAlarmThreadLimit=800
    #groovy thread pool max size
    rscontrol.general.scriptpool.scriptPoolAlarmThreadLimit=800
    #we don't need results in the case where we want to get maximum performance
    rscontrol.general.logActionResults=true
    rscontrol.general.snmptraphost=
    rscontrol.general.snmptrapport=162
    rscontrol.general.threadkeepalive=30
    rscontrol.general.perfdebug=false
    rscontrol.general.executorbusyratio=0.9
    rscontrol.general.sysexecutorbusyratio=0.9
    rscontrol.general.startexecutorbusyratio=0.9
    rscontrol.general.dbpoolbusyratio=0.9
    rscontrol.general.maxrunbooklimit=400
    rscontrol.general.minrunbooklimit=1
    rscontrol.general.userunbookcount=false
    rscontrol.general.mcpmode=${MCPMODE}
    rscontrol.general.environment=${ENVIRONMENT}
    rscontrol.general.runbookmetrics=false
    rscontrol.general.enablerunbookstatcounters=true
    rscontrol.general.isDcsEnabled=${resolve.dcs}
  • RSControl Log4j configuration
    rscontrol.log4j.Loggers.Root.level=WARN
    rscontrol.log4j.Loggers.Root.appender-ref.ref=RSCONTROL
    rscontrol.log4j.Loggers.Logger.com.resolve.rscontrol.level=${rscontrol.log4j.loglevel}
    rscontrol.log4j.Loggers.Logger.com.mchange.v2.level=INFO
    rscontrol.log4j.Loggers.Logger.org.quartz.level=ERROR
    rscontrol.log4j.Loggers.Logger.syslog.level=ERROR
    rscontrol.log4j.Loggers.Logger.syslog.additivity=false
    rscontrol.log4j.Appenders.RollingFile.RSCONTROL.fileName=rscontrol/log/rscontrol.log
    rscontrol.log4j.Appenders.RollingFile.RSCONTROL.filePattern=rscontrol/log/$\${date:yyyy-MM}/rscontrol-%d{MM-dd-yyyy}-%i.log.zip
    rscontrol.log4j.Appenders.RollingFile.RSCONTROL.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rscontrol.log4j.Appenders.RollingFile.RSCONTROL.SizeBasedTriggeringPolicy.size=32MB
    rscontrol.log4j.Appenders.RollingFile.RSCONTROL.DefaultRolloverStrategy.max=30
  • RSControl config.xml ESB information
    rscontrol.esb.product=${rsmq.product}
    rscontrol.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
    rscontrol.esb.username=${rsmq.username}
    rscontrol.esb.password=${rsmq.password}
    rscontrol.esb.domain=domain1
    rscontrol.esb.brokername=router1
    rscontrol.esb.mgmtaddr=
    rscontrol.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
    rscontrol.esb.createqueueretry=30
    rscontrol.esb.createqueuewait=10
    rscontrol.esb.keepalive=0
    rscontrol.esb.maxfailed=10
    rscontrol.esb.cachesize=500
    scontrol.esb.flowcontrolstartqueuesize=400
    rscontrol.esb.maxmessages=-1
    rscontrol.esb.messagettl=1200000
    rscontrol.esb.vhost=${rsmq.vhost}
  • RSControl config.xml SQL information
    rscontrol.sql.dbtype=${DB_TYPE}
    rscontrol.sql.dbname=${DB_NAME}
    rscontrol.sql.host=${DB_HOST}
    rscontrol.sql.username=${DB_USERNAME}
    rscontrol.sql.password=${DB_PASSWORD}
    rscontrol.sql.url=${DB_URL}
    rscontrol.sql.maxpoolsize=200
    rscontrol.sql.minpoolsize=${rscontrol.sql.maxpoolsize}
    rscontrol.sql.maxidletime=60
  • RSControl key service configuration
    rscontrol.keyservice.proto=${KEYSERVICE_PROTO}
    rscontrol.keyservice.host=${KEYSERVICE_HOST}
    rscontrol.keyservice.port=${KEYSERVICE_PORT}
    rscontrol.keyservice.username=${KEYSERVICE_USERNAME}
    rscontrol.keyservice.pwd=${KEYSERVICE_PWD}
  • RSControl registration information
    rscontrol.id.group=default
    rscontrol.id.description=RSCONTROL
    rscontrol.id.location=${LOCALHOST}
  • Location of RSControl Groovy Scripts, executable from RSConsole commands
    rscontrol.gse.path=${DIST}/RSControl/service
  • RSControl Central registration configuration
    rscontrol.registration.logheartbeat=true
  • RSControl ehcache configuration
    rscontrol.ehcache.defaultCache.maxElementsInMemory=10000
    rscontrol.ehcache.defaultCache.eternal=true
    rscontrol.ehcache.defaultCache.maxElementsOnDisk=10000000
    rscontrol.ehcache.defaultCache.diskExpiryThreadIntervalSeconds=120
  • RSControl Atomikos configuration
    rscontrol.jta.log=${DIST}/RSControl/log
    rscontrol.jta.timeout=600000
    rscontrol.jta.max_actives=500
  • RSControl hibernate configuration
    rscontrol.hibernate.dbtype=${hibernate.dbtype}
    rscontrol.hibernate.hibernate.default_schema=${hibernate.default_schema}
  • RSControl archive settings
    rscontrol.archive.active=false
    rscontrol.archive.schedule=0 0 2 * * ?
    rscontrol.archive.expiry=86400
    rscontrol.archive.cleanup=604800
    rscontrol.archive.sleeptime=300
    rscontrol.archive.instantinsert=false
    #if true, inserts into archive_execute_request, archive_execute_result and archive_execute_result_lob
    rscontrol.archive.archiveexecutedata=false
    #number of records to be inserted/deleted as a block.
    rscontrol.archive.blocksize = 50000
    #sleep time in seconds between a block operation.
    rscontrol.archive.blocksleeptime = 120
    #currently for resolve_process_request and worksheet tables.
    rscontrol.archive.smalltableblocksize = 20000
    rscontrol.archive.smalltableblocksleeptime = 10
  • RSControl Social configuration
    rscontrol.social.active=true
    rscontrol.social.archive=0 0 3 * * ?
    rscontrol.social.dailyemail=0 0 4 * * ?
  • User that owns RSControl installation
    rscontrol.run.R_USER=${resolve.user}
  • Additional java_option when rscontrol is run
    rscontrol.run.java_opts=
  • RSControl Elasticsearch configuration
    rscontrol.search.active=true
    rscontrol.search.serverlist=${rssearch.serverlist}
    rscontrol.search.shards=${rssearch.shards}
    rscontrol.search.replicas=${rssearch.replicas}
    rscontrol.search.indexthreads=${rssearch.indexthreads}
    rscontrol.search.indextimout=${rssearch.indextimout}
    rscontrol.search.indexretries=${rssearch.indexretries}
    rscontrol.search.serverport=${rssearch.yml.transport.tcp.port}
    rscontrol.search.cluster=${rssearch.yml.cluster.name}
    rscontrol.search.clienttype=${rssearch.clienttype}
    rscontrol.search.http=${rssearch.yml.http.enabled}
    rscontrol.search.httpport=${rssearch.yml.http.port}
    rscontrol.search.analytics=false
    rscontrol.search.embedded=false
    rscontrol.search.datadir=${DIST}/tmp/es
    #TTL is in seconds, default is 3 months (60*60*24*30*3)
    #ES removes system and rss posts based on this
    rscontrol.search.ttl=7776000
  • RSControl selfcheck configuration
    rscontrol.selfcheck.db.interval=300
    rscontrol.selfcheck.db.active=false
    rscontrol.selfcheck.db.timeout=5
    rscontrol.selfcheck.es.active=false
    rscontrol.selfcheck.es.interval=300
    rscontrol.selfcheck.es.retry=5
    rscontrol.selfcheck.es.retrydelay=10
    rscontrol.selfcheck.ping.active=false
    rscontrol.selfcheck.ping.threshold=5
    rscontrol.selfcheck.ping.interval=300
    rscontrol.selfcheck.threadpool.interval=300
    rscontrol.selfcheck.rbexec.active=false
    rscontrol.selfcheck.rbexec.interval=300
    rscontrol.selfcheck.rbexec.runbook=Mesh.Test100

RSControl General Properties

Property NameDescriptionDefault Value
rscontrol.general.homeLocation of the RSControl folder.${DIST}
rscontrol.general.clusternameName of the Actions Pro cluster.${CLUSTERNAME}
rscontrol.general.configfileversionVersion of the config file.1.0
rscontrol.general.configrevisionsNumber of backups of the config file to store.2
rscontrol.general.saveconfigonstartSet to 'true' to save the rscontrol config.xml on start.true
rscontrol.general.saveconfigonexitSet to 'true' to save the rscontrol config.xml on exit.true
rscontrol.general.savecrononexitSave the cron.ini file on exit.false
rscontrol.general.cronoffsetPeriod of time by which to offset cron jobs.0
rscontrol.general.waitingtaskthresholdMaximum amount of tasks that can wait on the queue.15
rscontrol.general.maxthreadMaximum number of threads RSControl can spin up.200
rscontrol.general.maxsystemthreadMaximum number of system threads that can be spun up.100
rscontrol.general.snmptraphostHost to send snmp traps over.
rscontrol.general.snmptrapportPort to send snmp traps over.162
rscontrol.general.timezoneTimezone of the RSControl component.
rscontrol.general.threadkeepaliveIf the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.30
rscontrol.general.perfdebugSet to 'true' to enable performance debugging.false
rscontrol.general.executorbusyratioAmount of busy threads to non busy threads for the executor to be considered busy.0.9
rscontrol.general.sysexecutorbusyratioAmount of busy threads to non busy threads for the sysexecutor to be considered busy.0.9
rscontrol.general.startexecutorbusyratioAmount of busy threads to non busy threads for the startexecutor to be considered busy.0.9
rscontrol.general.dbpoolbusyratioAmount of in use connections to non in use connections for the database connection to be considered busy.0.9
rscontrol.general.maxrunbooklimitMaximum number of running runbooks allowed.400
rscontrol.general.minrunbooklimitMinimum number of running runbooks allowed.1
rscontrol.general.userunbookcountSet to 'true' to use the active runbook count.false
rscontrol.general.mcpmodeSet the mcp mode${MCPMODE}

RSControl Log4j Properties

Property NameDescriptionDefault Value
rscontrol.log4j.Loggers.Root.levelDefines common log level.WARN
rscontrol.log4j.Loggers.Root.appender-ref.refRSCONTROL
rscontrol.log4j.Loggers.Logger.com.resolve.rscontrol.level${rscontrol.log4j.loglevel}
rscontrol.log4j.Loggers.Logger.com.mchange.v2.levelINFO
rscontrol.log4j.Loggers.Logger.org.quartz.levelERROR
rscontrol.log4j.Loggers.Logger.syslog.levelERROR
rscontrol.log4j.Loggers.Logger.syslog.additivityfalse
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.fileNamerscontrol/log/rscontrol.log
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.filePatternrscontrol/log/$\\${date:yyyy-MM}/rscontrol-%d{MM-dd-yyyy}-%i.log.zip
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.SizeBasedTriggeringPolicy.size32MB
rscontrol.log4j.Appenders.RollingFile.RSCONTROL.DefaultRolloverStrategy.max30
rscontrol.log4j.logger.atomikosThis log level should not be changed unless advised by support.ERROR
rscontrol.log4j.logger.com.atomikosThis log level should not be changed unless advised by supportWARN, Atomikos
rscontrol.log4j.appender.AtomikosFile appender used.org.apache.log4j.RollingFileAppender
rscontrol.log4j.appender.Atomikos.FileThe log file used by atomikosrscontrol/log/tm.out
rscontrol.log4j.appender.Atomikos.MaxFileSizemax file size of the atomikos file100KB
rscontrol.log4j.appender.Atomikos.AppendSet to 'true' to have log4j append to the rootlogger as well as its own log file.false
rscontrol.log4j.appender.Atomikos.layoutclass used to configure how log4j prints to the fileorg.apache.log4j.PatternLayout
rscontrol.log4j.appender.Atomikos.layout.ConversionPatternpattern that the log are printed on the log file to, e.g. <path> <time> <category> - <message><line separator>%p %t %c - %m%n

RSControl ESB Properties

Property NameDescriptionDefault Value
rscontrol.esb.productName of the messaging application used, do not change unless advised by support.${rsmq.product}
rscontrol.esb.brokeraddrAddress used by the rabbitmq broker in the host:port format.${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rscontrol.esb.usernameUsername for the rsmq client.${rsmq.username}
rscontrol.esb.passwordPassword for the given rsmq username.${rsmq.password}
rscontrol.esb.domaindeprecated*domain1
rscontrol.esb.brokernamedeprecated*router1
rscontrol.esb.mgmtaddrdeprecated*
rscontrol.esb.brokeraddr2Address of the rabbitmq backup broker in the host:port format.${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rscontrol.esb.createqueueretryTime period before retrying to create a queue.30
rscontrol.esb.createqueuewaitTime period to wait before creating a queue.10
rscontrol.esb.keepaliveAfter how long time to send a keep alive message.0
rscontrol.esb.maxfailedMaximum number of failed messages allowed.10
rscontrol.esb.cachesizeMax number of messages cached.500
rscontrol.esb.flowcontrolstartqueuesizeNumber of messages allowed before flow control activates.400
rscontrol.esb.maxmessagesMaximum number of messages store, a value of -1 means unlimited messages.1
rscontrol.esb.messagettlTime period in which a message has to live, in milliseconds.600000
rscontrol.esb.sslprotocolName of the encryption protocol used by rabbitmq, should be at least TLSv1.1.TLSv1.2
rscontrol.esb.vhost${rsmq.vhost}

RSControl SQL Properties

Property NameDescriptionDefault Value
rscontrol.sql.dbtypeType of database used by MySQL.${DB_TYPE}
rscontrol.sql.dbnameName of the database used.${DB_NAME}
rscontrol.sql.hostAddress of the database.${DB_HOST}
rscontrol.sql.usernameUsername for a user with access to the database.${DB_USERNAME}
rscontrol.sql.passwordPassword for the given username.${DB_PASSWORD}
rscontrol.sql.urlThe url of the database including the driver, the host, the port, and the database name.${DB_URL}
rscontrol.sql.maxpoolsizeMaximum size of the connection pool.100
rscontrol.sql.minpoolsizeMinimum size of the connection pool.${rscontrol.sql.maxpoolsize}
rscontrol.sql.maxidletimeMaximum period of time for a connection to remain idle.60
rscontrol.sql.perfdebugSet to 'true 'to use perfomance schema to debugfalse
rscontrol.sql.usexadatasourceSet to 'true' to use xdatasource instead of datasource.false

RSControl ID Properties

Property NameDescriptionDefault Value
rscontrol.id.groupName of the Actions Pro cluster.${CLUSTERNAME}
rscontrol.id.descriptionDescription of the component.RSCONTROL
rscontrol.id.locationLocation and address of Actions Pro.${LOCALHOST}
rscontrol.gse.pathPath to the groovy service scripts.${DIST}/rscontrol/service
rscontrol.registration.expirationPeriod of time before the registration is set to inactive.10080
rscontrol.registration.discardPeriod of time to discard an inactive registration.43200
rscontrol.registration.electionPeriod of time inbetween elections of a master node.30
rscontrol.registration.intervalSet the interval between each heartbeat in minutes.5
rscontrol.registration.logheartbeatSet to 'true' to log each heartbeat.true

RSControl Ehcache Properties

Property NameDescriptionDefault Value
rscontrol.ehcache.defaultCache.maxElementsInMemorySet the max amount of mappings that can be stored in cache.10000
rscontrol.ehcache.defaultCache.eternalSet to 'true' to forbid to mappings in cache to expire.true
rscontrol.ehcache.defaultCache.maxElementsOnDiskThe maximum object to be held in the disk store.10000000
rscontrol.ehcache.defaultCache.diskExpiryThreadIntervalSecondsInterval in seconds between runs of the disk expiry thread.120

RSControl Jta Properties

Property NameDescriptionDefault Value
rscontrol.jta.logPath to the log folder.${DIST}/rscontrol/log
rscontrol.jta.timeoutPeriod of time needed by a transaction to timeout.600000
rscontrol.jta.max_activesMaximum amount of transactions that can be active simultaneously.500

RSControl Hibernate Properties

Property NameDescriptionDefault Value
rscontrol.hibernate.dbtypeType of database used.${hibernate.dbtype}
rscontrol.hibernate.hibernate.default_schemaSchema of the database used.${hibernate.default_schema}

RSControl Archive Properties

Property NameDescriptionDefault Value
rscontrol.archive.activeSet to 'true' to active archiving.false
rscontrol.archive.scheduleTime at which Actions Pro starts the archiving process.0 0 2 * * ?
rscontrol.archive.expiryHow long until a worksheet expires, in seconds.86400
rscontrol.archive.cleanupTime until the cleanup process begins.604800
rscontrol.archive.sleeptimeTime for the archive process to sleeps between long SQL execution.300
rscontrol.archive.instantinsertIf 'true', system will instantly insert data into archive table.false
rscontrol.archive.archiveexecutedataIf 'true', inserts into archive_execute_request, archive_execute_result and archive_execute_result_lobfalse
rscontrol.archive.blocksizeNumber of records to be inserted/deleted as a block.20000
rscontrol.archive.blocksleeptimeSleep time in seconds between block operations.600
rscontrol.archive.smalltableblocksizeCurrently for resolve_process_request and worksheet tables.10000
rscontrol.archive.smalltableblocksleeptimeSleep time in seconds between block delete for small table.60

RSControl Social Properties

Property NameDescriptionDefault Value
rscontrol.social.activeSet to 'true' to use social.true
rscontrol.social.activeAt what time an archive process runs everyday, default is 3am.0 0 3 * * ?
rscontrol.social.dailyemailAt what time a daily email is sent out, default is 4am.0 0 4 * * ?

RSControl Run Properties

Property NameDescriptionDefault Value
rscontrol.run.R_USERName of the Actions Pro Linux user.${resolve.user}
rscontrol.run.java_optsAny extra java options to add to the component start up.
rscontrol.run.terminatetimeoutTime period for rscontrol run to timeout.600
note

These properties should mirror the rs search properties.

RSControl Search Properties

Property NameDescriptionDefault Value
rscontrol.search.activedeprecated*true
rscontrol.search.serverlistList of the nodes used by RSSearch.${rssearch.serverlist}
rscontrol.search.shardsNumber of shards per index.${rssearch.shards}
rscontrol.search.replicasNumber of replicas per shard.${rssearch.replicas}
rscontrol.search.indexthreadsdeprecated*${rssearch.indexthreads}
rscontrol.search.indextimoutThe time need by a request of an index to timeout, in seconds.${rssearch.indextimout}
rscontrol.search.indexretriesHow many times a read or write to an index should be attempted.${rssearch.indexretries}
rscontrol.search.serverportPort RSSearch listens on for http requests.${rssearch.yml.transport.tcp.port}
rscontrol.search.clusterName used to discover and auto-join nodes.${rssearch.yml.cluster.name}
rscontrol.search.clienttypeSet whether clients should be node or transport.${rssearch.clienttype}
rscontrol.search.httpSet to 'true' to enable http.${rssearch.yml.http.enabled}
rscontrol.search.httpportPort ES binds for http use.${rssearch.yml.http.port}
rscontrol.search.ttlFor how long does Elasticsearch stores files.${search.ttl}
rscontrol.syncSet to 'true' to sync RSSearch nodes.false
rscontrol.syncclusterName of the remote cluster used for discovery.${RSSEARCH_SYNC_CLUSTERNAME}
rscontrol.syncserverlistList of server nodes to sync.${RSSEARCH_SYNC_NODES}
rscontrol.syncserverportPort to sync RSSearch nodes over.9300

RSControl Self Properties

Property NameDescriptionDefault Value
rscontrol.selfcheck.db.intervalInterval between selfchecks.300
rscontrol.selfcheck.db.activeSet to 'check' for the status of the database.false
rscontrol.selfcheck.db.timeoutPeriod of time in seconds needed by a selfcheck of the database to timeout.5
rscontrol.selfcheck.es.activeSet to 'true' to activate selfchecks for Elasticsearch.false
rscontrol.selfcheck.es.intervalIntervals between selfchecks to Elasticsearch.300
rscontrol.selfcheck.es.retryHow many times to retry sending a selfcheck message to Elasticsearch.5
rscontrol.selfcheck.es.retrydelayPeriod of time to wait in between retries.10
rscontrol.selfcheck.ping.activeSet to 'true' to ping RSRemote and check its status.false
rscontrol.selfcheck.ping.thresholdPeriod of time needed by a ping to timeout.5
rscontrol.selfcheck.ping.intervalInterval between pings to RSRemote.300
rscontrol.selfcheck.threadpool.activeSet to 'true' to check if the RSCONTROL threadpool is at its max.false
rscontrol.selfcheck.threadpool.intervalInterval in between checks for the threadpool health.300
rscontrol.selfcheck.threadpool.timePeriod of time to wait before rechecking threadpool count after a threadpool count exceeds the maximum allowed number.10
rscontrol.selfcheck.rbexec.activeSet to 'true' to selfcheck the health of the runbook executor.false
rscontrol.selfcheck.rbexec.intervalPeriod of time in between the checks to the runbook executor.300
rscontrol.selfcheck.rbexec.runbookRunbook used to test the status of the runbook executor.Mesh.Test100

RSView Settings

All RSView Settings

The following lists shows the logical groups of RSView properties and their default values.

  • RSView config.xml GENERAL information
    rsview.general.primary=${PRIMARY}
    rsview.general.home=${DIST}
    rsview.general.clustername=${CLUSTERNAME}
    rsview.general.heartbeat=20
    rsview.general.failover=60
    rsview.general.configrevisions=1
    rsview.general.threadkeepalive=30
    rsview.general.perfdebug=false
    rsview.general.mcpmode=${MCPMODE}
    rsview.general.saveusercredentials=false
    rsview.general.environment=${ENVIRONMENT}
    rsview.general.gatewayhealthcheckintervalinminutes=10
    rsview.general.scheduledpool=100
    rsview.general.taskExecutor.executorAlarmThreadLimit=1000
    rsview.general.cachecontrolmaxage=31536000
    #comma separated list of addresses
    #example:
    #rsview.general.reportingInstances=http://localhost:19098,http://10.50.0.109:9999
    rsview.general.reportingInstances=${RSVIEW_RSREPORTING_INSTANCES}
    rsview.general.sslEnabled=${RSVIEW_SSL_ENABLED}
    rsview.general.sslVerify=${RSVIEW_SSL_VERIFY}
    rsview.general.trustStore=${RSVIEW_TRUSTSTORE_PATH}
    rsview.general.trustStorePassword=${RSVIEW_TRUSTSTORE_PASSWORD}
    rsview.general.dcsAuthenticationInstance=${RSREMOTE_RSDATALOADER_URL}/login
    rsview.general.dcsAuthenticationUsername=rsview
    rsview.general.dcsAuthenticationPassword=Resolve1
    rsview.general.isDcsEnabled=${resolve.dcs}
  • RSView Log4j configuration
    rsview.log4j.Loggers.Root.level=WARN
    rsview.log4j.Loggers.Root.appender-ref.ref=TOMCAT
    rsview.log4j.Loggers.Logger.com.resolve.rsview.level=${rsview.log4j.loglevel}
    rsview.log4j.Loggers.Logger.com.resolve.rsview.additivity=false
    rsview.log4j.Loggers.Logger.com.resolve.rsview.appender-ref.ref=RSVIEW
    rsview.log4j.Loggers.Logger.syslog.level=INFO
    rsview.log4j.Loggers.Logger.syslog.additivity=false
    rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.level=INFO
    rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.appender-ref.ref=RSVIEW
    rsview.log4j.Loggers.Logger.net.sf.ehcache.level=INFO
    rsview.log4j.Loggers.Logger.net.sf.ehcache.appender-ref.ref=EHCACHE
    rsview.log4j.Loggers.Logger.com.resolve.auth.level=INFO
    rsview.log4j.Loggers.Logger.com.resolve.auth.additivity=false
    rsview.log4j.Loggers.Logger.com.resolve.auth.appender-ref.ref=AUTH
    rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.level=INFO
    rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.additivity=false
    rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.appender-ref.ref=SYSTEMWORKSHEETS
    rsview.log4j.Loggers.Logger.org.hibernate.cache.ehcache.AbstractEhcacheRegionFactory.level=INFO
    rsview.log4j.Appenders.RollingFile.EHCACHE.fileName=${DIST}/tomcat/logs/ehcache.log
    rsview.log4j.Appenders.RollingFile.EHCACHE.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/ehcache-%d{MM-dd-yyyy}-%i.log.zip
    rsview.log4j.Appenders.RollingFile.EHCACHE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsview.log4j.Appenders.RollingFile.EHCACHE.SizeBasedTriggeringPolicy.size=32MB
    rsview.log4j.Appenders.RollingFile.EHCACHE.DefaultRolloverStrategy.max=6
    rsview.log4j.Appenders.RollingFile.RSVIEW.fileName=${DIST}/tomcat/logs/rsview.log
    rsview.log4j.Appenders.RollingFile.RSVIEW.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/rsview-%d{MM-dd-yyyy}-%i.log.zip
    rsview.log4j.Appenders.RollingFile.RSVIEW.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsview.log4j.Appenders.RollingFile.RSVIEW.SizeBasedTriggeringPolicy.size=32MB
    rsview.log4j.Appenders.RollingFile.RSVIEW.DefaultRolloverStrategy.max=6
    rsview.log4j.Appenders.RollingFile.TOMCAT.fileName=${DIST}/tomcat/logs/catalina.out
    rsview.log4j.Appenders.RollingFile.TOMCAT.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/catalina-%d{MM-dd-yyyy}-%i.log.zip
    rsview.log4j.Appenders.RollingFile.TOMCAT.PatternLayout.pattern=%p %t %c - %m%n
    rsview.log4j.Appenders.RollingFile.TOMCAT.SizeBasedTriggeringPolicy.size=32MB
    rsview.log4j.Appenders.RollingFile.TOMCAT.DefaultRolloverStrategy.max=6
    rsview.log4j.Appenders.RollingFile.AUTH.fileName=${DIST}/tomcat/logs/auth.log
    rsview.log4j.Appenders.RollingFile.AUTH.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/auth-%d{MM-dd-yyyy}-%i.log.zip
    rsview.log4j.Appenders.RollingFile.AUTH.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.interval=1
    rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.modulate=true
    rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.fileName=${DIST}/tomcat/logs/RSSystemWorksheets.log
    rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.filePattern=${DIST}/tomcat/logs/$\${date:yyyy-MM}/RSSystemWorksheets-%d{MM-dd-yyyy}-%i.log.zip
    rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.SizeBasedTriggeringPolicy.size=32MB
    rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.DefaultRolloverStrategy.max=100
  • RSView config.xml ESB information
    rsview.esb.product=${rsmq.product}
    rsview.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
    rsview.esb.username=${rsmq.username}
    rsview.esb.password=${rsmq.password}
    rsview.esb.domain=domain1
    rsview.esb.brokername=router1
    rsview.esb.mgmtaddr=
    rsview.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
    rsview.esb.createqueueretry=30
    rsview.esb.createqueuewait=10
    rsview.esb.keepalive=0
    rsview.esb.maxfailed=10
    rsview.esb.cachesize=500
    rsview.esb.flowcontrolstartqueuesize=400
    rsview.esb.maxmessages=-1
    rsview.esb.messagettl=1200000
    rsview.esb.vhost=${rsmq.vhost}
  • RSView registration information
    rsview.registration.logheartbeat=true
  • RSview JDK environment
    rsview.env.RSVIEWJDK=${resolve.java_home}
  • RSView keyservice configuration
    rsview.keyservice.proto=${KEYSERVICE_PROTO}
    rsview.keyservice.host=${KEYSERVICE_HOST}
    rsview.keyservice.port=${KEYSERVICE_PORT}
    rsview.keyservice.username=${KEYSERVICE_USERNAME}
    rsview.keyservice.pwd=${KEYSERVICE_PWD}
  • RSView config.xml SQL information
    rsview.sql.dbtype=${DB_TYPE}
    rsview.sql.dbname=${DB_NAME}
    rsview.sql.host=${DB_HOST}
    rsview.sql.username=${DB_USERNAME}
    rsview.sql.password=${DB_PASSWORD}
    rsview.sql.url=${DB_URL}
    rsview.sql.maxpoolsize=200
    rsview.sql.minpoolsize=${rsview.sql.maxpoolsize}
    rsview.sql.maxidletime=60
  • RSControl config.xml ESB information
    rsview.search.active=true
    rsview.search.serverlist=${rssearch.serverlist}
    rsview.search.shards=${rssearch.shards}
    rsview.search.replicas=${rssearch.replicas}
    rsview.search.indexthreads=${rssearch.indexthreads}
    rsview.search.indextimout=${rssearch.indextimout}
    rsview.search.indexretries=${rssearch.indexretries}
    rsview.search.serverport=${rssearch.yml.transport.tcp.port}
    rsview.search.cluster=${rssearch.yml.cluster.name}
    rsview.search.clienttype=${rssearch.clienttype}
    rsview.search.http=${rssearch.yml.http.enabled}
    rsview.search.httpport=${rssearch.yml.http.port}
    rsview.search.analytics=false
    rsview.search.embedded=false
    rsview.search.datadir=${DIST}/tmp/es
    #TTL is in seconds, default is 3 months (60*60*24*30*3)
    #ES removes system and rss posts based on this
    rsview.search.ttl=7776000
    #Set value to specify a full URL enpoint for RSSearch's kibana and big desk app tools.
    #If left blank it will be calculated from the rsview.search fields
    #The calculated URL will be in the form "http://192.168.0.1:9200".
    rsview.search.endpoint=
  • RSView registration information
    rsview.id.group=default
    rsview.id.description=RSVIEW
    rsview.id.location=${LOCALHOST}
  • Location of RSView Groovy scripts, executable from RSConsole commands
    rsview.gse.path=${DIST}/tomcat/webapps/resolve/WEB-INF/service
  • Location of RSView logs
    rsview.log=${DIST}/tomcat/logs
  • RSView ehcache configuration
    rsview.ehcache.defaultCache.maxElementsInMemory=10000
    rsview.ehcache.defaultCache.eternal=true
    rsview.ehcache.defaultCache.maxElementsOnDisk=10000000
    rsview.ehcache.defaultCache.diskExpiryThreadIntervalSeconds=120
  • Configuration information for Atomikos
    rsview.jta.log=${DIST}/tomcat/logs
    rsview.jta.timeout=600000
    rsview.jta.max_actives=1500
  • Tomcat connection configuration.
    For further details refer to Tomcat Settings in Architecture Overview.
    sview.tomcat.server.port=8005
    rsview.tomcat.connector.ajp.port=8009
    rsview.tomcat.connector.ajp.redirectport=8443
    rsview.tomcat.http=false
    rsview.tomcat.connector.http.port=8080
    rsview.tomcat.connector.http.redirectport=8443
    rsview.tomcat.https=true
    rsview.tomcat.connector.https.port=8443
    #For Keystore Password Encryption Change protocol to custom class com.resolve.tomcat.connector.ResolveHttp11Protocol
    rsview.tomcat.connector.protocol=HTTP/1.1
    #keystore file is a relative path to DIST location to ensure location always have write permission
    rsview.tomcat.connector.https.keystoreFile=/home/resolve/.keystore
    rsview.tomcat.connector.https.keystorePass=resolve
    rsview.tomcat.connector.https.sslEnabledProtocols=TLSv1.2
    rsview.tomcat.connector.https.ciphers=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
    TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,
    TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,
    TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,SSL_RSA_WITH_RC4_128_SHA,
    TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
    rsview.tomcat.connector.maxthreads=500
    rsview.tomcat.connector.compression=on
    rsview.tomcat.connector.compressionMinSize=2048
    rsview.tomcat.connector.noCompressionUserAgents=gozilla, traviata
    rsview.tomcat.connector.compressableMimeType=text/html,text/xml,text/javascript,text/css,text/plain,text/json,application/javascript,application/json,application/xml
  • RSView Ajax2/Web Service configuration
    rsview.axis2.http=${rsview.tomcat.http}
    rsview.axis2.connector.http.port=${rsview.tomcat.connector.http.port}
    rsview.axis2.https=${rsview.tomcat.https}
    rsview.axis2.connector.https.port=${rsview.tomcat.connector.https.port}
  • RSView set http to https forwarding on or off
    rsview.web.httpsForward=false
  • RSView hibernate configuration
    rsview.hibernate.dbtype=${hibernate.dbtype}
    rsview.hibernate.hibernate.default_schema=${hibernate.default_schema}
  • RSView reporting dashboard configuration
    rsview.dashboard.dbtype=${DB_TYPE}
    rsview.dashboard.dbname=${DB_NAME}
    rsview.dashboard.defaultDB=${DB_SCHEMA}
    rsview.dashboard.host=${DB_HOST}
    rsview.dashboard.user=${DB_USERNAME}
    rsview.dashboard.password=${DB_PASSWORD}
    rsview.dashboard.url=${DB_URL}
  • RSView selfcheck configuration
    rsview.selfcheck.es.active=false
    rsview.selfcheck.es.retrydelay=10
    rsview.selfcheck.es.interval=300
    rsview.selfcheck.es.retry=5
    rsview.selfcheck.ping.active=false
    rsview.selfcheck.ping.threshold=5
    rsview.selfcheck.ping.interval=300
    rsview.selfcheck.db.active=false
    rsview.selfcheck.db.interval=300
    rsview.selfcheck.db.timeout=5
    rsview.selfcheck.ldapadsc.active=false
    rsview.selfcheck.ldapadsc.interval=300
    rsview.selfcheck.http.active=false
    rsview.selfcheck.http.interval=300
  • User that owns RSView installation
    rsview.run.R_USER=${resolve.user}
  • Additional java_option when RSView is run
    rsview.run.java_opts=
  • The only URL which does not require CSRF protection is Login URL.
    Add additional values by copying this property and incrementing the .N count Values must be in the form of <Key>=<URL>.
    rsview.csrfguard.unprotected.1=

RSVeiw Authentication

Actions Pro has two different methods to authenticate against Active Directory (AD) and Lightweight Directory Access Protocol (LDAP). For Active Directory, a user can further enable the Single Sign-On, allowing users to be automatically signed into Actions Pro using their Desktop session.

RSVeiw LDAP Authentication
Property NameDescriptionDefault Value
rsview.auth.ldap.activeSet to 'true' to activate LDAP authentication for Actions Pro.false
rsview.auth.ldap.ipaddressThe IP address for lDAP authentication.
rsview.auth.ldap.portThe port used by Actions Pro for LDAP authentication.389
rsview.auth.ldap.sslSet to 'true' to use ssl with LDAP.false
rsview.auth.ldap.syncSet to 'true' to sync LDAP properties file with LDAP server.true
rsview.auth.ldap.fallbackSet to 'true' to fallback to result authentication if LDAP auth fails.true
rsview.auth.ldap.basedn.dn.1The base point for the server to search for a user.o=resolve,c=us
rsview.auth.ldap.default_domainThe default domain to add to the user, if they do not specify a domain.
rsview.auth.ldap.modeThe way Actions Pro authenticates user: BIND, binds using user account: BIND_UID binds using user account but with specified user id:COMPARE, binds using bind_dn account and compares passwords locally:COMPARE_LDAP binds using bind_dn account and compares through ldap compare call.BIND
rsview.auth.ldap.uid_attributeThe u_id used to bind with.u_id
rsview.auth.ldap.bind_dnThe account to bind with, if mode is set to COMPARE or COMPARE_LDAPo=resolve,c=us
rsview.auth.ldap.bind_passwordThe password to bind with, if mode is set to COMPARE or COMPARE_LDAPresolve
rsview.auth.ldap.password_attributeThe field where the password is stored when mode is set to COMPARE or COMPARE_LDAPuserPassword
rsview.auth.ldap.crypt_typeEncryption method used to encrypt password when comparing locally.CLEAR
rsview.auth.ldap.crypt_prefixPrefix to prepend to bind_password.DEFAULT
rsview.auth.ldap.versionLDAP version that is in use.3
rsview.auth.ldap.grouprequiredIf 'true' then the user logging into Actions Pro should have at least 1 LDAP group assigned.false
Authenticate via LDAP/Active Directory

Actions Pro can have more than one RSRemote. For the authentication to more than one LDAP/Active Directory follow these steps:

  1. Set the "unearth" to true for user authentication uses.
  2. Review LDAP configuration and Active Directory configuration under the User Administration main menu.
  3. Set the active flag to true to enable the LDAP/Active Directory for RSRemote.
rsremote.receive.ldap.active=true  
rsremote.receive.ldap.queue=LDAP

#if userauth=true this gateway may be used for Actions Pro user authentication
rsremote.receive.ldap.userauth=true

#if this flag is true, than for user loging in Actions Pro, should have at least 1 LDAP group assigned
rsremote.receive.ldap.grouprequired=true

rsremote.receive.ad.active=true
rsremote.receive.ad.queue=AD

#if userauth=true this gateway may be used for Actions Pro user authentication
rsremote.receive.ad.userauth=true

#if this flag is true, than for user loging in Actions Pro, should have at least 1 AD group assigned
rsremote.receive.ad.grouprequired=true
RSVeiw Active Directory Authentication
Property NameDescriptionDefault value
rsview.auth.active_directory.activeSet to 'true' to activate Active Directory authentication for Actions Pro.false
rsview.auth.active_directory.ipaddress=The IP address for AD authentication.
rsview.auth.active_directory.portThe port used by Actions Pro for AD authentication.389
rsview.auth.active_directory.sslSet to 'true' to use ssl with ADfalse
rsview.auth.active_directory.syncSet to 'true' to sync AD properties file with AD server.true
rsview.auth.active_directory.fallbackSet to 'true' to fall back to result authentication if AD auth fails.true
rsview.auth.active_directory.default_domainThe default domain to add to the user, if they do not specify a domain.
rsview.auth.active_directory.basedn.dn.1=dc=resolve,c=com
rsview.auth.active_directory.modeThe way Actions Pro authenticates user: BIND, binds using user account: BIND_UID binds using user account but with specified user id: COMPARE, binds using bind_dn account and compares passwords locally: COMPARE_AD binds using bind_dn account and compares through AD compare call.BIND
rsview.auth.active_directory.uid_attributeThe u_id used to bind with.sAMAccountName
rsview.auth.active_directory.bind_dnThe base point for the server to search for a user.
rsview.auth.active_directory.bind_passwordPrefix to prepend to bind_password.
rsview.auth.active_directory.versionActive Directory version that is in use.3
#if this flag is true, than for user loging in Actions Pro, should have atleast 1 AD group assignedrsview.auth.active_directory.grouprequiredIf 'true' then the user logging into Actions Pro should have at least 1 LDAP group assigned.false

RSView General

Property NameDescriptionDefault Value
rsview.general.primaryIf 'true' then this RSView instace is the primary RSView.${PRIMARY}
rsview.general.homeParent directory of the tomcat directory.${DIST}
rsview.general.clusternameName of the Actions Pro cluster.${CLUSTERNAME}
rsview.general.heartbeatdeprecated*20
rsview.general.failoverdeprecated*60
rsview.general.maxthreadMaximum amount of allowed threads.200
rsview.general.maxsystemthreadMaximum amount of allowed concurrent active system threads allowed.100
rsview.general.configrevisionsNumber of backup config.xml's to keep.1
rsview.general.threadkeepaliveIf the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.30
rsview.general.perfdebugSet to 'true' to enable performance debugging.false
rsview.general.mcpmodeThe mcp mode.${MCPMODE}
rsview.general.saveusercredentialsSet to 'true' to save user credentials in the session info.false
rsview.csrfguard.unprotected.1The only URL which does not require CSRF protection is Login URL.Add additional values by copy ting this property and incrementing the .N countValues must be in the form of <Key>=<URL>

RSView Log4j

Property NamеDescriptionDefault Value
rsview.log4j.Loggers.Root.levelWARN
rsview.log4j.Loggers.Root.appender-ref.refTOMCAT
rsview.log4j.Loggers.Logger.com.resolve.rsview.level${rsview.log4j.loglevel}
rsview.log4j.Loggers.Logger.com.resolve.rsview.additivityfalse
rsview.log4j.Loggers.Logger.com.resolve.rsview.appender-ref.refRSVIEW
rsview.log4j.Loggers.Logger.syslog.levelINFO
rsview.log4j.Loggers.Logger.syslog.additivityfalse
rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.levelINFO
rsview.log4j.Loggers.Logger.org.apache.struts.util.RequestUtils.appender-ref.refRSVIEW
rsview.log4j.Loggers.Logger.net.sf.ehcache.levelINFO
rsview.log4j.Loggers.Logger.net.sf.ehcache.appender-ref.refENCACHE
rsview.log4j.Loggers.Logger.com.resolve.auth.levelINFO
rsview.log4j.Loggers.Logger.com.resolve.auth.additivityfalse
rsview.log4j.Loggers.Logger.com.resolve.auth.appender-ref.refAUTH
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.levelINFO
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.additivityfalse
rsview.log4j.Loggers.Logger.com.resolve.services.schedules.SystemWorksheetRemover.appender-ref.refSYSTEMWORKSHEETS
rsview.log4j.Loggers.Logger.org.hibernate.cache.ehcache.AbstractEhcacheRegionFactory.levelINFO
rsview.log4j.Appenders.RollingFile.EHCACHE.fileName${DIST}/tomcat/logs/ehcache.log
rsview.log4j.Appenders.RollingFile.EHCACHE.filePattern${DIST}/tomcat/logs/$\\${date:yyyy-MM}/ehcache-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.EHCACHE.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.EHCACHE.SizeBasedTriggeringPolicy.size32MB
rsview.log4j.Appenders.RollingFile.EHCACHE.DefaultRolloverStrategy.max6
rsview.log4j.Appenders.RollingFile.RSVIEW.fileName${DIST}/tomcat/logs/rsview.log
rsview.log4j.Appenders.RollingFile.RSVIEW.filePattern{DIST}/tomcat/logs/$\\${date:yyyy-MM}/rsview-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.RSVIEW.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.RSVIEW.SizeBasedTriggeringPolicy.size32MB
rsview.log4j.Appenders.RollingFile.RSVIEW.DefaultRolloverStrategy.max6
rsview.log4j.Appenders.RollingFile.TOMCAT.fileName${DIST}/tomcat/logs/Catalina.out
rsview.log4j.Appenders.RollingFile.TOMCAT.filePattern${DIST}/tomcat/logs/$\\${date:yyyy-MM}/catalina-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.TOMCAT.PatternLayout.pattern%p %t %c - %m%n
rsview.log4j.Appenders.RollingFile.TOMCAT.SizeBasedTriggeringPolicy.size32MB
rsview.log4j.Appenders.RollingFile.TOMCAT.DefaultRolloverStrategy.max6
rsview.log4j.Appenders.RollingFile.AUTH.fileName${DIST}/tomcat/logs/auth.log
rsview.log4j.Appenders.RollingFile.AUTH.filePattern${DIST}/tomcat/logs/$\\${date:yyyy-MM}/auth-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.AUTH.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.interval1
rsview.log4j.Appenders.RollingFile.AUTH.Policies.TimeBasedTriggeringPolicy.modulatetrue
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.fileName${DIST}/tomcat/logs/RSSystemWorksheets.log
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.filePattern${DIST}/tomcat/logs/$\\${date:yyyy-MM}/RSSystemWorksheets-%d{MM-dd-yyyy}-%i.log.zip
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.SizeBasedTriggeringPolicy.size32MB
rsview.log4j.Appenders.RollingFile.SYSTEMWORKSHEETS.DefaultRolloverStrategy.max100
rsview.log4j.logger.com.atomikosSet the log level for the atomikos package class and the log file to append to. 'loglevel','log file'WARN, Atomikos
rsview.log4j.appender.AtomikosFile appender for atomikos to use.org.apache.log4j.RollingFileAppender
rsview.log4j.appender.Atomikos.FileFile for the atomikos appender to append to.${DIST}/tomcat/logs/tm.out
rsview.log4j.appender.Atomikos.MaxFileSizeMaximum file size for the atomikos log file.100KB
rsview.log4j.appender.Atomikos.AppendSet to 'true' to append to the log file on start up instead of overwriting it.false
rsview.log4j.appender.Atomikos.layoutClass to use for log layout.org.apache.log4j.PatternLayout
rsview.log4j.appender.Atomikos.layout.ConversionPatterPattern for the atomikos logging%p %t %c - %m%n
rsview.log4j.appender.RSVIEW.layoutClass used for the layout of the RSVIEW logs.org.apache.log4j.PatternLayout
rsview.log4j.appender.RSVIEW.layout.ConversionPatternPattern used to log into the RSVIEW log file.%d %5p [%t] (%F:%L) - %m%n
rsview.log4j.appender.AUTH.layoutClass used for the layout of the AUTH logs.org.apache.log4j.PatternLayout
rsview.log4j.appender.AUTH.layout.ConversionPatternPattern used to log into the AUTH log file.%d %5p [%t] (%F:%L) - %m%n
rsview.log4j.appender.EHCACHE.layoutClass used for the layout of the EHCACHE logs.org.apache.log4j.PatternLayout
rsview.log4j.appender.EHCACHE.layout.ConversionPatternPattern used to log into the EHCACHE log file%d %5p [%t](%F:%L) - %m%n
rsview.log4j.loggerFactoryClass used for the log4j logger factory.org.owasp.esapi.reference.Log4JLoggerFactory

RSView ESB

Property NameDescriptionDefault Value
rsview.esb.productProduct used for the esb system.${rsmq.product}
rsview.esb.brokeraddrAddress and port, used by esb for messaging.${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsview.esb.usernameUsername to connect to rsmq.${rsmq.username}
rsview.esb.passwordPassword used to connect to rsmq.${rsmq.password}
rsview.esb.domaindeprecated*domain1
rsview.esb.brokernamedeprecated*router1
rsview.esb.mgmtaddrdeprecated*
rsview.esb.brokeraddr2Backup address and port used by the esb.${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsview.esb.createqueueretryPeriod of time before retrying to create a queue.30
rsview.esb.createqueuewaitPeriod of time to wait before creating a queue.10
rsview.esb.keepaliveAfter how long to send a keep alive message.0
rsview.esb.maxfailedMaximum number of failed messages allowed.10
rsview.esb.cachesizeMax number of messages cached.500
rsview.esb.flowcontrolstartqueuesizeNumber of messages allowed before flow control activates.400
rsview.esb.maxmessagesMaximum number of messages store, a value of -1 means unlimited messages.1
rsview.esb.messagettlPeriod of time a message has to live, in milliseconds.600000
rsview.esb.sslprotocolName of the encryption protocol used by rabbitmq, should be at least TLSv1.1TLSv1.2
rsview.esb.vhost${rsmq.vhost}

RSView Registration

Property NameDescriptionDefault Value
rsview.registration.expirationPeriod of time until a registration expires.10080
rsview.registration.discardPeriod of time until registration is discarded.43200
rsview.registration.intervalPeriod of time in minutes in between each heartbeat.5
rsview.registration.logheartbeatSet to 'true' to log each heartbeat.true

RSView SQL

Property NameDescriptionDefault Value
rsview.sql.dbtypeType of database connected to Actions Pro.${DB_TYPE}
rsview.sql.dbnameName of the database${DB_NAME}
rsview.sql.hostAddress of the database${DB_HOST}
rsview.sql.usernameUsername used to connect to the database.${DB_USERNAME}
rsview.sql.passwordPassword used to connect to the database.${DB_PASSWORD}
rsview.sql.urlThe url used to connect to the database.${DB_URL}
rsview.sql.maxpoolsizeMaximum size of the connection pool.100
rsview.sql.minpoolsizeMinimum size of the connection pool.${rsview.sql.maxpoolsize}
rsview.sql.maxidletimeMaximum idle time.60
rsview.sql.perfdebugSet to 'true' to enable performance debugging.false
rsview.sql.usexadatasourceSet to 'true' to use xadatasource.false

RSView SQL

Property NameDescriptionDefault Value
rsview.search.activedeprecated*true
rsview.search.serverlistList of the nodes used by rssearch${rssearch.serverlist}
rsview.search.shardsNumber of shards per index${rssearch.shards}
rsview.search.replicasNumber of replicas per shard${rssearch.replicas}
rsview.search.indexthreadsdeprecated*${rssearch.indexthreads}
rsview.search.indextimoutThe time needed by a request of an index to timeout, in seconds.${rssearch.indextimout}
rsview.search.indexretriesHow many times a read or write to an index should be attempted.${rssearch.indexretries}
rsview.search.serverportPort rssearch listens on for http requests.${rssearch.yml.transport.tcp.port}
rsview.search.clusterName used to discover and auto-join nodes.${rssearch.yml.cluster.name}
rsview.search.clienttypeSet whether clients should be node or transport.${rssearch.clienttype}
rsview.search.httpSet to 'true' to enable http.${rssearch.yml.http.enabled}
rsview.search.httpportPort ES binds for http use.${rssearch.yml.http.port}
rsview.search.ttlHow long does Elasticsearch stores files.${search.ttl}
rsview.search.syncSet to 'true' to sync rssearch nodes.${rssearch.sync}
rsview.search.sync clusterName of the remote cluster used for discovery.${rssearch.sync cluster}
rsview.search.syncserverlistList of server nodes to sync.${rssearch.syncserverlist}
rsview.search.syncserverportPort to sync rssearch nodes over.${rssearch.syncserverport}
rsview.search.synctaskSet to 'true' in one RSView for the intelligent synchronizer task.false
rsview.search.synctaskintervalInterval between sync tasks.600
rsview.search.log.removeOldLogFiles.enabledSet to 'true' to clean up old log files.false
rsview.search.log.removeOldLogFiles.cronTaskIntervalTypeType of interval cron tasks run.DAYS
rsview.search.log.removeOldLogFiles.cronTaskIntervalValuePeriod of time in-between removal of old in cronTaskIntervalType.30
rsview.search.log.removeOldLogFiles.fileDateThresholdMaximum age of a file before being marked for removal.30
rsview.search.endpointSet value to specify a full URL enpoint for research's kibana and big desk app tools.

RSView ID

Property NameDescriptionDefault Value
rsview.id.groupName of the cluster.${CLUSTERNAME}
rsview.id.descriptionDescription used for license registration.RSVIEW
rsview.id.locationIP used for license registration.${LOCALHOST}

RSView GSE

Property NameDescriptionDefault Value
rsview.gse.pathPath to groovy script${DIST}/tomcat/webapps/resolve/WEB-INF/service

RSView SQL

Property NameDescriptionDefault Value
rsview.ehcache.defaultCache.maxElementsInMemoryMaximum number of the mappings that can be held is earache memory.10000
rsview.ehcache.defaultCache.eternalSet to 'true' to ensure that earache mappings never expire.true
rsview.ehcache.defaultCache.maxElementsOnDiskMaximum number of mappings that can be stored on disk.10000000
rsview.ehcache.defaultCache.diskExpiryThreadIntervalSecondsThe interval in seconds between runs of the disk expiry thread.120

RSView JTA

Property NameDescriptionDefault Value
rsview.jta.logPath to the parent directory of the jta logs.${DIST}/tomcat/logs
rsview.jta.timeoutPeriod of time needed for a transaction to timeout.600000
rsview.jta.max_activesmaximum number of active transactions allowed.1500

RSView Tomcat

Property NameDescriptionDefault Value
rsview.tomcat.server.portPort for tomcats use.8005
rsview.tomcat.connector.ajp.portPort used by tomcat to connect via the ajp protocol.8009
rsview.tomcat.connector.ajp.redirectportIf this Connector is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, Catalina will automatically redirect the request to the port number.8443
rsview.tomcat.httpSet to 'true' to use http as opposed to https.true
rsview.tomcat.connector.http.portPort used by the tomcat http connector.8080
rsview.tomcat.connector.http.redirectportIf this Connector is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, Catalina will automatically redirect the request to the port number specified here8443
rsview.tomcat.httpsSet to true if https access is available on this RSView, if true a keystore with a certificate for the RSView must be set up.false
rsview.tomcat.connector.https.portPort used for https connections.8443
rsview.tomcat.connector.https.keystoreFileLocation of the keystore to use with secure communications/home/resolve/.keystore
rsview.tomcat.connector.https.keystorePassPassphrase used to decrypt the keystore fileresolve
rsview.tomcat.connector.https.sslEnabledProtocolsThe ssl protocol to be used with https.TLSv1.2
rsview.tomcat.connector.https.ciphersCiphers used with https.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,SSL_RSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
rsview.tomcat.connector.maxthreadsMaximum amount of active Tomcat threads allowed.500
rsview.tomcat.connector.compressionSet to 'on' to enable compression set to false to disable compression.on
rsview.tomcat.connector.compressionMinSizeMinimum amount of data necessary before output is compressed.2048
rsview.tomcat.connector.noCompressionUserAgentsAgents with dissabled compression.Godzilla, traviata
rsview.tomcat.connector.compressableMimeTypeThe value is a comma separated list of MIME types for which HTTP compression may be used.text/html,text/xml,text/javascript,text/css,text/plain,text/json,application/javascript,application/json,application/xml
rsview.axis2.httpSet to 'true' to use http for SOAP.${rsview.tomcat.http}
rsview.axis2.connector.http.portThe port number for http connections.${rsview.tomcat.connector.http.port}
rsview.axis2.httpsSet to 'true' to use https for SOAP.${rsview.tomcat.https}
rsview.axis2.connector.https.portThe port number for https SOAP connections.${rsview.tomcat.connector.https.port}
rsview.web.httpsForwardIf 'true' any http connections will be forwarded to httpsfalse

RSView Web

Property NameDescriptionDefault Value
rsview.web.httpsForwardSet to 'true' to use https forwarding for requests.false

RSView Hibernate

Property NameDescriptionDefault Value
rsview.hibernate.dbtypeType of database used by Actions Pro.${hibernate.dbtype}
rsview.hibernate.hibernate.default_schemaSchema of the database used.${hibernate.default_schema}

RSView Run

Property NameDescriptionDefault Value
rsview.run.R_USERUser to run RSView.${resolve.user}
rsview.run.java_optsJava options to use when starting up.
rsview.run.terminatetimeoutPeriod of time until run timesout and is terminated.30

RSView Selfcheck

Property NameDescriptionDefault Value
rsview.selfcheck.es.activeSet to 'true' to check the health of Elasticsearch (ES).false
rsview.selfcheck.es.retrydelayPeriod of time to wait before retrying the ES check.10
rsview.selfcheck.es.intervalInterval between selfchecks to ES.300
rsview.selfcheck.es.retryPeriod of time for RSView to retry a failed check.5
rsview.selfcheck.ping.activeSet to 'true' to ping RSRemote from RSView to check its health.false
rsview.selfcheck.ping.thresholdPeriod of time for a check to RSRemote to timeout.5
rsview.selfcheck.ping.intervalInterval between pings to RSRemote.300
rsview.selfcheck.db.activeSet to 'true' to check the health of the database from RSView.false
rsview.selfcheck.db.intervalInterval between checks to the database.300
rsview.selfcheck.db.timeoutPeriod of time until a check to the database to timeout.5
rsview.selfcheck.ldapadsc.activeSet to 'true' to check the health of LDAP, AD, or SC.false
rsview.selfcheck.ldapadsc.intervalInterval between checks to LDAP, AD, SC.300
rsview.selfcheck.http.activeSet to 'true' to check the health of tomcat.false
rsview.selfcheck.http.intervalInterval between checks to tomcat.300

RSConsole Settings

All RSConsole Settings

The following lists shows the logical groups of RSConsole properties and their default values.

  • RSConsole config.xml general configuration
    rsconsole.general.home=${DIST}
    rsconsole.general.clustername=${CLUSTERNAME}
    rsconsole.general.configfileversion=1.0
    rsconsole.general.configrevisions=2
    rsconsole.general.saveconfigonstart=true
    rsconsole.general.saveconfigonexit=true
    rsconsole.general.threadkeepalive=30
    rsconsole.general.perfdebug=false
    rsconsole.general.mcpmode=${MCPMODE}
    rsconsole.general.environment=${ENVIRONMENT}rsconsole.general.scheduledpool=100
    rsconsole.general.taskExecutor.executorAlarmThreadLimit=1000
  • RSConsole Log4j configuration
    rsconsole.log4j.Loggers.Root.level=WARN
    rsconsole.log4j.Loggers.Root.appender-ref.ref=RSCONSOLE
    rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.level=${rsconsole.log4j.loglevel}
    rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.level=INFO
    rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.additivity=false
    rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.appender-ref.ref=HISTORY
    rsconsole.log4j.Loggers.Logger.org.quartz.level=INFO
    rsconsole.log4j.Loggers.Logger.syslog.level=INFO
    rsconsole.log4j.Loggers.Logger.syslog.additivity=false
    rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.fileName=rsconsole/log/rsconsole.log
    rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.filePattern=rsconsole/log/$\${date:yyyy-MM}/rsconsole-%d{MM-dd-yyyy}-%i.log.zip
    rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.SizeBasedTriggeringPolicy.size=32MB
    rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.DefaultRolloverStrategy.max=6
    rsconsole.log4j.Appenders.RollingFile.HISTORY.fileName=rsconsole/log/history.log
    rsconsole.log4j.Appenders.RollingFile.HISTORY.filePattern=rsconsole/log/$\${date:yyyy-MM}/history-%d{MM-dd-yyyy}-%i.log.zip
    rsconsole.log4j.Appenders.RollingFile.HISTORY.PatternLayout.pattern=%d %m%n
    rsconsole.log4j.Appenders.RollingFile.HISTORY.SizeBasedTriggeringPolicy.size=32MB
    rsconsole.log4j.Appenders.RollingFile.HISTORY.DefaultRolloverStrategy.max=6
  • RSConsole config.xml ESB information
    rsconsole.esb.product=${rsmq.product}
    rsconsole.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
    rsconsole.esb.username=${rsmq.username}
    rsconsole.esb.password=${rsmq.password}
    rsconsole.esb.domain=domain1
    rsconsole.esb.brokername=router1
    rsconsole.esb.mgmtaddr=
    rsconsole.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
    rsconsole.esb.createqueueretry=30
    rsconsole.esb.createqueuewait=10
    rsconsole.esb.keepalive=0
    rsconsole.esb.maxfailed=10
    rsconsole.esb.cachesize=500
    rsconsole.esb.flowcontrolstartqueuesize=400
    rsconsole.esb.maxmessages=-1
    rsconsole.esb.messagettl=1200000
    rsconsole.esb.vhost=${rsmq.vhost}
  • RSConsole config.xml database information
    rsconsole.connection.dbtype=${DB_TYPE}
    rsconsole.connection.dbname=${DB_NAME}
    rsconsole.connection.host=${DB_HOST}
    rsconsole.connection.username=${DB_USERNAME}
    rsconsole.connection.password=${DB_PASSWORD}
    rsconsole.connection.url=${DB_URL}
  • RSConsole users
    rsconsole.users.user.username.1=admin
    rsconsole.users.user.password.1=resolve
  • RSControl JDK environment
    rsconsole.env.RSCONSOLEJDK=${resolve.java_home}

RSConsole General

Property NameDescriptionDefault Value
rsconsole.general.homeHome directory of RSConsole.${DIST}
rsconsole.general.clusternameName of the Actions Pro cluster.${CLUSTERNAME}
rsconsole.general.configfileversionDefault version of the configfile.1.0
rsconsole.general.configrevisionsNumber of backups to keep of the config file.2
rsconsole.general.saveconfigonstartSet to 'true' to save the config file on start.true
rsconsole.general.saveconfigonexitSet to 'true' to save the config file on exit.true
rsconsole.general.maxthreadMaximum number of threads rsconsole can run.10
rsconsole.general.maxsystemthreadMaximum number of system threads rsconsole can start.100
rsconsole.general.timezoneTTime zone for the RSConsole to use.
rsconsole.general.threadkeepaliveIf the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.30
rsconsole.general.perfdebugSet to 'true' to enable performance debugging.false
rsconsole.general.mcpmodeThe MCP mode for RSControl.${MCPMODE}

RSConsole Log4j

Property NameDescriptionDefault Value
rsconsole.log4j.Loggers.Root.levelDefines common log level.WARN
rsconsole.log4j.Loggers.Root.appender-ref.refRSCONSOLE
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.level${rsconsole.log4j.loglevel}
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.levelINFO
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.additivityfalse
rsconsole.log4j.Loggers.Logger.com.resolve.rsconsole.history.appender-ref.refHISTORY
rsconsole.log4j.Loggers.Logger.org.quartz.levelINFO
rsconsole.log4j.Loggers.Logger.syslog.levelINFO
rsconsole.log4j.Loggers.Logger.syslog.additivityfalse
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.fileNamersconsole/log/rsconsole.log
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.filePatternrsconsole/log/$\\${date:yyyy-MM}/rsconsole-%d{MM-dd-yyyy}-%i.log.zip
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.SizeBasedTriggeringPolicy.size32MB
rsconsole.log4j.Appenders.RollingFile.RSCONSOLE.DefaultRolloverStrategy.max6
rsconsole.log4j.Appenders.RollingFile.HISTORY.fileNamersconsole/log/history.log
rsconsole.log4j.Appenders.RollingFile.HISTORY.filePatternrsconsole/log/$\\${date:yyyy-MM}/history-%d{MM-dd-yyyy}-%i.log.zip
rsconsole.log4j.Appenders.RollingFile.HISTORY.PatternLayout.pattern%d %m%n
rsconsole.log4j.Appenders.RollingFile.HISTORY.SizeBasedTriggeringPolicy.size32MB
rsconsole.log4j.Appenders.RollingFile.HISTORY.DefaultRolloverStrategy.max6

RSConsole ES

Property NameDescriptionDefault Value
rsconsole.esb.productProduct used for RSConsole esb.${rsmq.product}
rsconsole.esb.brokeraddrAddress and port, used by esb for messaging.${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsconsole.esb.usernameUsername used to connect to the esb product.${rsmq.username}
rsconsole.esb.passwordPassword used to connect to the esb product.${rsmq.password}
rsconsole.esb.domaindeprecated*domain1
rsconsole.esb.brokernamedeprecated*router1
rsconsole.esb.mgmtaddrdeprecated*
rsconsole.esb.brokeraddr2Backup address and port, used by esb for messaging.${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsconsole.esb.createqueueretryPeriod of time to wait before retrying to create a queue.30
rsconsole.esb.createqueuewaitPeriod of time to wait before creating a queue.10
rsconsole.esb.keepaliveAfter how long time to send a keep alive message.0
rsconsole.esb.maxfailedMaximum number of failed messages allowed.10
rsconsole.esb.cachesizeMaximum number of messages that can be cached.500
rsconsole.esb.flowcontrolstartqueuesizeNumber of messages allowed before flow control activates.400
rsconsole.esb.maxmessagesMaximum number of messages store, a value of -1 means unlimited messages.1
rsconsole.esb.messagettlPeriod of time to keep a message alive.600000
rsconsole.esb.sslprotocolName of the encryption protocol used by rabbitmq, needs to be atleast TLSv1.1.TLSv1.2
rsconsole.esb.vhost${rsmq.vhost}

RSConsole User

Property NameDescriptionDefault Value
rsconsole.users.user.username.1Username to connect to the RSConsole (default settings).admin
rsconsole.users.user.password.1Password used to connect to the RSConsole (default settings).resolve

RSConsole Connection

Property NameDescriptionDefault Value
rsconsole.connection.dbtypeThe type of database RSConsole connect to.${DB_TYPE}
rsconsole.connection.dbnameName of the database RSConsole is connecting to.${DB_NAME}
rsconsole.connection.hostAddress of the database RSConsole in connecting to.${DB_HOST}
rsconsole.connection.usernameUsername used to connect to the database.${DB_USERNAME}
rsconsole.connection.passwordPassword used to connect to the database.${DB_PASSWORD}
rsconsole.connection.urlThe url used connect to the database.${DB_URL}

RSMgmt Settings

All RSMGMT Settings

The following lists shows the logical groups of RSMgmt properties and their default values.

  • User that owns RSMgmt installation

    rsmgmt.run.R_USER=${resolve.user}
  • Additional java_option when RSMgmt is run

    rsmgmt.run.java_opts=
  • RSMgmt config.xml general information

    rsmgmt.general.home=${DIST}
    rsmgmt.general.clustername=${CLUSTERNAME}
    rsmgmt.general.configfileversion=1.0
    rsmgmt.general.configrevisions=2
    rsmgmt.general.saveconfigonstart=true
    rsmgmt.general.saveconfigonexit=true
    rsmgmt.general.threadkeepalive=30
    rsmgmt.general.perfdebug=false
    rsmgmt.general.mcpmode=${MCPMODE}
    rsmgmt.general.environment=${ENVIRONMENT}
  • RSMgmt Log4j configuration

    rsmgmt.log4j.Loggers.Root.level=WARN
    rsmgmt.log4j.Loggers.Root.appender-ref.ref=RSMGMT
    rsmgmt.log4j.Loggers.Logger.com.resolve.rsmgmt.level=${rsmgmt.log4j.loglevel}
    rsmgmt.log4j.Loggers.Logger.com.resolve.update.level=INFO
    rsmgmt.log4j.Loggers.Logger.com.resolve.update.additivity=false
    rsmgmt.log4j.Loggers.Logger.com.resolve.update.appender-ref.ref=UPDATE
    rsmgmt.log4j.Loggers.Logger.syslog.level=ERROR
    rsmgmt.log4j.Loggers.Logger.syslog.additivity=false
    rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName=rsmgmt/log/rsmgmt.log
    rsmgmt.log4j.Appenders.RollingFile.RSMGMT.filePattern=rsmgmt/log/$\${date:yyyy-MM}/rsmgmt-%d{MM-dd-yyyy}-%i.log.zip
    rsmgmt.log4j.Appenders.RollingFile.RSMGMT.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsmgmt.log4j.Appenders.RollingFile.RSMGMT.SizeBasedTriggeringPolicy.size=32MB
    rsmgmt.log4j.Appenders.RollingFile.RSMGMT.DefaultRolloverStrategy.max=6
    rsmgmt.log4j.Appenders.RollingFile.UPDATE.fileName=rsmgmt/log/update.log
    rsmgmt.log4j.Appenders.RollingFile.UPDATE.filePattern=rsmgmt/log/$\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
    rsmgmt.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval=1
    rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate=true
  • Deprecated. License validation configuration

    rsmgmt.license.active=true
    #License Master election interval in seconds
    rsmgmt.license.election=30
    rsmgmt.license.failover=90
  • RSMgmt config.xml

    rsmgmt.esb.product=${rsmq.product}
    rsmgmt.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
    rsmgmt.esb.username=${rsmq.username}
    rsmgmt.esb.password=${rsmq.password}
    rsmgmt.esb.domain=domain1
    rsmgmt.esb.brokername=router1
    rsmgmt.esb.mgmtaddr=
    rsmgmt.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
    rsmgmt.esb.createqueueretry=30
    rsmgmt.esb.createqueuewait=10
    rsmgmt.esb.keepalive=0
    rsmgmt.esb.maxfailed=10
    rsmgmt.esb.cachesize=500
    rsmgmt.esb.flowcontrolstartqueuesize=400
    rsmgmt.esb.maxmessages=-1
    rsmgmt.esb.sslprotocol=TLSv1.2
    rsmgmt.esb.connectionTimeout=5000
    rsmgmt.esb.vhost=${rsmq.vhost}
  • RSMgmt queue name

    rsmgmt.esb.queue.name.1=RSMGMT
  • RSMgmt database settings.
    You can set rsmgmt.sql.active=true if database testing is not required (RSRemote standalone system), or the local RSMgmt is not the primary RSMgmt.

    rsmgmt.sql.active=true
    rsmgmt.sql.dbtype=${DB_TYPE}
    rsmgmt.sql.dbname=${DB_NAME}
    rsmgmt.sql.host=${DB_HOST}
    rsmgmt.sql.username=${DB_USERNAME}
    rsmgmt.sql.password=${DB_PASSWORD}
    rsmgmt.sql.url=${DB_URL
  • Deprecated. Metric configuration.
    The RSMgmt is responsible for receiving metric data gathered by the various other Actions Pro components, and writing it to the database so it can be reported on later. Only the Primary RSMgmt gathers these metrics, so if the Primary RSMgmt is down, then no new reporting data will be gathered (rsmgmt.metric.active=${PRIMARY}). Advanced RSMgmt metrics configuration from blueprint.properties file is deprecated.

    rsmgmt.metric.queue=METRIC
    rsmgmt.metric.active=${PRIMARY}
    rsmgmt.metric.group.units.1=thread_count,mem_free
    rsmgmt.metric.group.name.1=jvm
    rsmgmt.metric.group.init.1=true
    rsmgmt.metric.group.drop.1=false
    rsmgmt.metric.group.type.1=default
    rsmgmt.metric.group.units.2=aborted,completed,gcondition,bcondition,ucondition,gseverity,cseverity,wseverity,sseverity,useverity,duration
    rsmgmt.metric.group.name.2=runbook
    rsmgmt.metric.group.init.2=true
    rsmgmt.metric.group.drop.2=false
    rsmgmt.metric.group.type.2=default
    rsmgmt.metric.group.units.3=transaction,latency
    rsmgmt.metric.group.name.3=transaction
    rsmgmt.metric.group.init.3=true
    rsmgmt.metric.group.drop.3=false
    rsmgmt.metric.group.type.3=default
    rsmgmt.metric.group.units.4=active
    rsmgmt.metric.group.name.4=users
    rsmgmt.metric.group.init.4=true
    rsmgmt.metric.group.drop.4=false
    rsmgmt.metric.group.type.4=default
    rsmgmt.metric.group.units.5=load1,load5,load15
    rsmgmt.metric.group.name.5=server
    rsmgmt.metric.group.init.5=true
    rsmgmt.metric.group.drop.5=false
    rsmgmt.metric.group.type.5=default
    rsmgmt.metric.group.units.6=wiki,wikiresponsetime,social,socialresponsetime
    rsmgmt.metric.group.name.6=latency
    rsmgmt.metric.group.init.6=true
    rsmgmt.metric.group.drop.6=false
    rsmgmt.metric.group.type.6=default
    rsmgmt.metric.group.units.7=free_space,size,percentage_used,response_time,query_count,percentage_wait
    rsmgmt.metric.group.name.7=database
    rsmgmt.metric.group.init.7=true
    rsmgmt.metric.group.drop.7=false
    rsmgmt.metric.group.type.7=default
    rsmgmt.metric.group.units.8=status
    rsmgmt.metric.group.name.8=cr
    rsmgmt.metric.group.init.8=true
    rsmgmt.metric.group.drop.8=false
    rsmgmt.metric.group.type.8=default
    rsmgmt.metric.group.units.9=node_cnt,tot_cnt,tot_time,status:string(20),dtnamespace:string(100)
    rsmgmt.metric.group.name.9=dt
    rsmgmt.metric.group.init.9=true
    rsmgmt.metric.group.drop.9=false
    rsmgmt.metric.group.type.9=decisiontree
    rsmgmt.metric.group.units.10=endUsers,adminUsers
    rsmgmt.metric.group.name.10=licensedusers
    rsmgmt.metric.group.init.10=true
    rsmgmt.metric.group.drop.10=false
    rsmgmt.metric.group.type.10=default
  • Deprecated. The RSMgmt can send out automatic alerts for various Actions Pro failures through the email gateway, Actions Pro database, the database gateway, and/or snmp traps. Alerts are sent for FATAL level errors (e.g. component is unexpectedly down).
    Advanced RSMgmt alerts configuration from blueprint.properties file is deprecated.

    rsmgmt.alert.active=true
    rsmgmt.alert.snmp.active=false
    rsmgmt.alert.snmp.community=public
    rsmgmt.alert.snmp.traphost=127.0.0.1
    rsmgmt.alert.snmp.trapport=162
    rsmgmt.alert.dblog.active=${rsmgmt.sql.active}
    rsmgmt.alert.gateway.active=true
    rsmgmt.alert.email.active=false
    #Email subject in the form "Resolve alert message: $MESSAGE with Severity $SEVERITY."
    #where #$MESSAGE and $SEVERITY will be replaced with actual message and severity.
    #There are $CODE and $COMPONENT parameters as well and all parameters are optional.
    rsmgmt.alert.email.subject=Resolve Alert
    rsmgmt.alert.email.body=Severity: $SEVERITY, Component: $COMPONENT, Type: $CODE, Message: $MESSAGE.
    rsmgmt.alert.email.to=
    rsmgmt.alert.email.cc=
    rsmgmt.alert.email.bcc=
  • RSMgmt registration configuration

    rsmgmt.registration.parentguid=RSCONTROL
    rsmgmt.registration.expiration=10080
    rsmgmt.registration.discard=43200
    rsmgmt.registration.interval=5
    rsmgmt.registration.logheartbeat=true
  • RSMgmt Elasticsearch configuration

    rsmgmt.search.active=false
    rsmgmt.search.serverlist=${rssearch.serverlist}
    rsmgmt.search.shards=${rssearch.shards}
    rsmgmt.search.replicas=${rssearch.replicas}
    rsmgmt.search.indexthreads=${rssearch.indexthreads}
    rsmgmt.search.indextimout=${rssearch.indextimout}
    rsmgmt.search.indexretries=${rssearch.indexretries}
    rsmgmt.search.serverport=${rssearch.yml.transport.tcp.port}
    rsmgmt.search.cluster=${rssearch.yml.cluster.name}
    rsmgmt.search.clienttype=${rssearch.clienttype}
    rsmgmt.search.http=${rssearch.yml.http.enabled}
    rsmgmt.search.httpport=${rssearch.yml.http.port}
    rsmgmt.search.analytics=false
    rsmgmt.search.embedded=false
    rsmgmt.search.datadir=${DIST}/tmp/es
    #TTL is in seconds, default is 3 months (60*60*24*30*3)
    #ES removes system and rss posts based on this
    rsmgmt.search.ttl=7776000
  • RSMgmt ID configuration

    rsmgmt.id.group=default
    rsmgmt.id.description=RSMGMT
    rsmgmt.id.location=${LOCALHOST}
  • MCP Web Service configuration

    rsmgmt.restwebservice.active=true
    rsmgmt.restwebservice.username=resolve
    rsmgmt.restwebservice.password=resolve
    rsmgmt.restwebservice.httpport=8082
    rsmgmt.restwebservice.httpsport=8083
    rsmgmt.restwebservice.ssl=true
    rsmgmt.restwebservice.keystore=${DIST}/rsmgmt/config/restcerts.jks
    rsmgmt.restwebservice.keystorepassword=changeit
    rsmgmt.restwebservice.keypassword=changeit
  • MCP configuration

    rsmgmt.mcp.active=true
    #when component status is asked, wait for these many
    #seconds to give up
    rsmgmt.mcp.statusrequestexpiration=60

    rsmgmt.mcp.registration.enabled=false
    rsmgmt.mcp.registration.password=
    rsmgmt.mcp.registration.port=
    rsmgmt.mcp.registration.protocol=
    rsmgmt.mcp.registration.username=
    rsmgmt.mcp.registration.uri=

RSMgmt Run

Property NameDescriptionDefault Value
rsmgmt.run.R_USERThe name of the user to run the RSMgmt component.${resolve.user}
rsmgmt.run.java_optsJava options used when starting up the component.
rsmgmt.run.terminatetimeoutPeriod of time before a run is timed out and terminated.30

RSMgmt General

Property NameDescriptionDefault Value
rsmgmt.general.homeHome directory of the RSMgmt component.${DIST}
rsmgmt.general.clusternameName of the Actions Pro cluster.${CLUSTERNAME}
rsmgmt.general.configfileversionDefault version of the config.xml.1.0
rsmgmt.general.configrevisionsNumberof backup config.xmls to keep.2
rsmgmt.general.saveconfigonstartSet to 'true' to save config.xml on start.true
rsmgmt.general.saveconfigonexitSet to 'true' to save config on exit.true
rsmgmt.general.maxthreadMaximum number of active threads RSMgmt can have up.100
rsmgmt.general.maxsystemthreadMaximum number of system threads RSMgmt can use.100
rsmgmt.general.timezoneTime zone of the RSMgmt component.
rsmgmt.general.threadkeepaliveIf the number of threads is greater than the core, this is the maximum timethat excess idle threads will wait for new tasks before terminating.30
rsmgmt.general.perfdebugSet to 'true' to enable performance debugging.false
rsmgmt.general.mcpmodeThe mcp mode of the RSMgmt component.${MCPMODE}

RSMgmt Log4

Property NameDescriptionDefault Value
rsmgmt.log4j.Loggers.Root.levelDefines common log level.WARN
rsmgmt.log4j.Loggers.Root.appender-ref.refRSMGMT
rsmgmt.log4j.Loggers.Logger.com.resolve.rsmgmt.level{rsmgmt.log4j.loglevel}
rsmgmt.log4j.Loggers.Logger.com.resolve.update.levelINFO
rsmgmt.log4j.Loggers.Logger.com.resolve.update.additivityfalse
rsmgmt.log4j.Loggers.Logger.com.resolve.update.appender-ref.refUPDATE
rsmgmt.log4j.Loggers.Logger.syslog.levelERROR
rsmgmt.log4j.Loggers.Logger.syslog.additivityfalse
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileNamersmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.filePatternrsmgmt/log/$\\${date:yyyy-MM}/rsmgmt-%d{MM-dd-yyyy}-%i.log.zip
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.SizeBasedTriggeringPolicy.size32MB
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.DefaultRolloverStrategy.max6
rsmgmt.log4j.Appenders.RollingFile.UPDATE.fileNamersmgmt/log/update.log
rsmgmt.log4j.Appenders.RollingFile.UPDATE.filePatternrsmgmt/log/$\\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
rsmgmt.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval1
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulatetrue

RSMgmt ESB

Property NameDescriptionDefault Value
rsmgmt.esb.productName of the messaging application used, do not change unless advised by support.${rsmq.product}
rsmgmt.esb.brokeraddrAddress used by the rabbitmq broker in the host:port format.${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsmgmt.esb.usernameUsername for the rsmq client.${rsmq.username}
rsmgmt.esb.passwordPassword for the given rsmq username.${rsmq.password}
rsmgmt.esb.domaindeprecated*domain1
rsmgmt.esb.brokernamedeprecated*router1
rsmgmt.esb.mgmtaddrdeprecated*
rsmgmt.esb.brokeraddr2Address of the rabbitmq backup broker in the host:port format${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsmgmt.esb.createqueueretryPeriod of time before retrying to create a queue.30
rsmgmt.esb.createqueuewaitPeriod of time to wait before creating a queue.10
rsmgmt.esb.keepaliveAfter how long time to send a keep alive message.0
rsmgmt.esb.maxfailedMaximum number of failed messages allowed.10
rsmgmt.esb.cachesizeMaximum number of messages cached.500
rsmgmt.esb.flowcontrolstartqueuesizeNumber of messages allowed before flow control activates.400
rsmgmt.esb.maxmessagesMaximum number of messages store, a value of -1 means unlimited messages.1
rsmgmt.esb.messagettlPeriod of time for a message to live in milliseconds.600000
rsmgmt.esb.sslprotocolName of the encryption protocol used by rabbitmq, needs to be atleast TLSv1.1TLSv1.2
rsmgmt.esb.queue.name.1Queue name for the RSMgmt component.RSMGMT
rsmgmt.esb.vhost${rsmq.vhost

RSMgmt SQL

Property NameProperty NameDescription
rsmgmt.sql.activeSet to 'true' to activate the database for this component.true
rsmgmt.sql.dbtypeThe type of database Actions Pro is connected to.${DB_TYPE}
rsmgmt.sql.dbnameName of the database RSMgmt will connect to.${DB_NAME}
rsmgmt.sql.hostAddress of the database RSMgmt is connecting to.${DB_HOST}
rsmgmt.sql.usernameUsername used to connect to the database.${DB_USERNAME}
rsmgmt.sql.passwordPassword used to connect to the database.${DB_PASSWORD}
rsmgmt.sql.urlThe url of the database.${DB_URL}
rsmgmt.sql.perfdebugSet to 'true' to enable performace debugging.false

RSMgmt Monitor

Property NameDescriptionDefault Value
rsmgmt.monitor.local.activeWhether to monitor the local components for UP/DOWN/HANGING status.true
rsmgmt.monitor.local.intervalHow often to check on the local components (in seconds)300
rsmgmt.monitor.local.restartWhether to restart the local components if a HANGING (unexpectedly DOWN) status is detectedfalse
rsmgmt.monitor.db.activeWhether to monitor the connection to the Actions Pro database for unavailable or slow connections.true
rsmgmt.monitor.db.intervalHow often to check the database connectivity (in seconds)300
rsmgmt.monitor.db.timeoutHow long the test query has to take before alerting on a slow connection (in seconds).5
rsmgmt.monitor.esb.activeWhether to monitor the AMQP connectivity for unavailable or undelivered messagestrue
rsmgmt.monitor.esb.intervalHow often to check the AMQP connectivity in seconds.300
rsmgmt.monitor.stdout.activeWhether to monitor the local connections stdout files (catalina.out for RSView).true
rsmgmt.monitor.stdout.intervalHow often to check the stdout files for error messages in seconds.60
rsmgmt.monitor.stdout.fileA file containing the messages that, if in the stdout files, will trigger an alertstdoutMonitor.txt
rsmgmt.monitor.rsremote.intervalHow often to send AMQP messages to the local RSRemote(s) to check if they are busy.300
rsmgmt.monitor.rsremote.timeoutHow long without a response from the RSRemote before its status is set to inactive, in seconds.60
rsmgmt.monitor.diskspace.activeSet to 'true' to activate monitoring of diskspace.true
rsmgmt.monitor.diskspace.intervalInterval between checking of the available diskspace.300
rsmgmt.monitor.ping.rsremoteSet to 'true' to enable pinging of rsremote.false
rsmgmt.monitor.ping.rscontrolSet to 'true' to enable pinging of rscontrol.false
rsmgmt.monitor.ping.rsviewSet to 'true' to enable pinging of RSView.false
rsmgmt.monitor.ping.intervalInterval between pinging of other components.300
rsmgmt.monitor.ping.thresholdPeriod of time until a ping to other components to timeout.5
rsmgmt.monitor.es.activeSet to 'true' to activate monitoring of Elasticsearch.false
rsmgmt.monitor.esb.intervalInterval between checks to Elasticsearch.300
rsmgmt.monitor.es.osmemthresholdprcntElasticsearch maximum ram threshold.80
rsmgmt.monitor.es.fsmemthresholdprcntElasticsearch maximum hard disk threshold.80
rsmgmt.monitor.es.jvmheapthresholdprcntElasticsearch maximum java virtual memory threshold.80
rsmgmt.monitor.es.gcfreqthresholdpersecTime in between consecutive garbage collection on old objects.10
rsmgmt.monitor.http.activeSet to 'true' to activate monitoring of http.false
rsmgmt.monitor.http.intervalInterval between http checks.300
rsmgmt.monitor.dbtps.activeSet to 'true' to activate checking of database TPS.false
rsmgmt.monitor.dbtps.intervalInterval between checking of database TPS.60
rsmgmt.monitor.dbtps.thresholdMaximum transactions per second allowed.50

RSMgmt Registration

Property NameDescriptionDefault Value
rsmgmt.registration.parentguidGuide of parent.RSCONTROL
rsmgmt.registration.expirationPeriod of time until component registration expires.10080
rsmgmt.registration.discardPeriod of time after registration until a registration is discarded.43200
rsmgmt.registration.intervalInterval between registration checks.5
rsmgmt.registration.logheartbeatLog heartbeat.true
Property NameDescriptionDefault Value
rsmgmt.search.activeSet to 'true' to give rsmgmt access to Elasticsearch.true
rsmgmt.search.serverlistList of Elasticsearch nodes.${rssearch.serverlist}
rsmgmt.search.shardsNumber of shards per index in Elasticsearch.${rssearch.shards}
rsmgmt.search.replicasNumber of Elasticsearch replicas.${rssearch.replicas}
rsmgmt.search.indexthreadsdeprecated*${rssearch.indexthreads}
rsmgmt.search.indextimoutPeriod of time it takes for a request to in index times out.${rssearch.indextimout}
rsmgmt.search.indexretriesPeriod of time to retry making a request to an index${rssearch.indexretries}
rsmgmt.search.serverportPort that Elasticsearch uses.${rssearch.yml.transport.tcp.port}
rsmgmt.search.clusterName of the Elasticsearch cluster.${rssearch.yml.cluster.name}
rsmgmt.search.clienttypeSet whether clients should be node or transport.${rssearch.clienttype}
rsmgmt.search.httpSet to 'true' to enable http.${rssearch.yml.http.enabled}
rsmgmt.search.httpportPort Elasticsearch uses for http.${rssearch.yml.http.port}
rsmgmt.search.ttlPeriod of time for an index to live.${search.ttl}
rsmgmt.id.groupName of the Actions Pro cluster.${CLUSTERNAME}
rsmgmt.id.descriptionDescription of this component.RSMGMT
rsmgmt.id.locationAddress of this component.${LOCALHOST}

RSMgmt Restwebservice

Property NameDescriptionDefault Value
rsmgmt.restwebservice.activeSet to 'true' to activate restwebservice.false
rsmgmt.restwebservice.usernameUsername used to connect to the restwebservice.resolve
rsmgmt.restwebservice.passwordPassword used to connect to the restwebservice.resolve
rsmgmt.restwebservice.httpportPort used by the restwebservice for http.8082
rsmgmt.restwebservice.httpsportPort used by the restwebservice for https.8083
rsmgmt.restwebservice.sslSet to 'true' to use ssl with the restwebservice.true
rsmgmt.restwebservice.keystorePath to the keystorefile.${DIST}/rsmgmt/config/restcerts.jks
rsmgmt.restwebservice.keystorepasswordPassword needed to use the keystore.changeit
rsmgmt.restwebservice.keypasswordPassword used by the key.changeit

RSMgmt MCP

Property NameDescriptionDefault Value
rsmgmt.mcp.registration.enabledSet to 'true' to enable mcp registration.false
rsmgmt.mcp.registration.passwordPassword used for mcp registration.
rsmgmt.mcp.registration.portPort used for mcp registration.
rsmgmt.mcp.registration.protocolProtocol used with mcp registration.
rsmgmt.mcp.registration.usernameUsername user for mcp registration.
rsmgmt.mcp.registration.uriThe Uri used when registering with mcp.

RSRemote Settings

All RSRemote Settings

The following lists shows the logical groups of RSRemote properties and their default values.

  • Specify RSRemote installation information: please consult with Resolve Systems on full procedure for setting up multiple RSRemotes on a single server.
    rsremote.instance.count=1
    rsremote.instance1.name=rsremote
  • RSRemote general configuration
    rsremote.general.home=${DIST}
    rsremote.general.cluster=false
    rsremote.general.configfileversion=1.0
    rsremote.general.configrevisions=2
    rsremote.general.saveconfigonstart=true
    rsremote.general.saveconfigonexit=true
    rsremote.general.cronoffset=0
    rsremote.general.maxthread=500
    rsremote.general.maxsystemthread=500
    rsremote.general.timezone=
    rsremote.general.threadkeepalive=30
  • RSRemote Log4j
    rsremote.log4j.Loggers.Root.level=WARN
    rsremote.log4j.Loggers.Root.appender-ref.ref=RSREMOTE,amqp
    rsremote.log4j.Loggers.Logger.com.resolve.rsremote.level=${rsremote.log4j.loglevel}
    rsremote.log4j.Loggers.Logger.com.resolve.dcs.httplogappender.level=INFO
    rsremote.log4j.Loggers.Logger.DCS.level=INFO
    rsremote.log4j.Loggers.Logger.DCS.appender-ref.ref=DCS
    rsremote.log4j.Loggers.Logger.syslog.level=ERROR
    rsremote.log4j.Loggers.Logger.syslog.additivity=false
    rsremote.log4j.Appenders.RollingFile.name=RSREMOTE
    rsremote.log4j.Appenders.RollingFile.fileName=rsremote/log/rsremote.log
    rsremote.log4j.Appenders.RollingFile.filePattern=rsremote/log/$\${date:yyyy-MM}/rsremote-%d{MM-dd-yyyy}-%i.log.zip
    rsremote.log4j.Appenders.RollingFile.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsremote.log4j.Appenders.RollingFile.SizeBasedTriggeringPolicy.size=32MB
    rsremote.log4j.Appenders.RollingFile.DefaultRolloverStrategy.max=6
    rsremote.log4j.Appenders.AmqpAppender.name=amqp
    rsremote.log4j.Appenders.AmqpAppender.threshold=WARN
    rsremote.log4j.Appenders.AmqpAppender.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] %X{context} %X{filter} (%F:%L) - %m%n
    rsremote.log4j.Appenders.HttpLogAppender.name=DCS
    rsremote.log4j.Appenders.HttpLogAppender.charset=utf-8
    rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance=update-me
    rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername=update-me
    rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword=update-me
    rsremote.log4j.Appenders.HttpLogAppender.hostAddresses=${RSREMOTE_RSDATALOADER_URL}
    rsremote.log4j.Appenders.HttpLogAppender.httpConnectionTimeout=5000
    rsremote.log4j.Appenders.HttpLogAppender.httpSOTimeout=1000
    rsremote.log4j.Appenders.HttpLogAppender.maxConnections=100
    rsremote.log4j.Appenders.HttpLogAppender.templatesToEndpointsMapping=data-collector-template:/api/v1/data/collected,incident-events-template:/api/v1/data/incident/events
    rsremote.log4j.Appenders.HttpLogAppender.threadCount=10
    rsremote.log4j.Appenders.HttpLogAppender.PatternLayout.pattern=%m
    rsremote.log4j.Appenders.HttpLogAppender.enabled=false
    rsremote.log4j.Appenders.HttpLogAppender.sslEnabled=${RSREMOTE_SSL_ENABLED}
    rsremote.log4j.Appenders.HttpLogAppender.sslVerify=${RSREMOTE_SSL_VERIFY}
    rsremote.log4j.Appenders.HttpLogAppender.trustStore=${RSREMOTE_TRUSTSTORE_PATH}
    rsremote.log4j.Appenders.HttpLogAppender.trustStorePassword=${RSREMOTE_TRUSTSTORE_PASSWORD}
    rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance=${RSREMOTE_RSDATALOADER_URL}/login
    rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername=rsremote
    rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword=
  • RSRemote config.xml ESB information
    rsremote.esb.product=${rsmq.product}
    rsremote.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
    rsremote.esb.username=${rsmq.username}
    rsremote.esb.password=${rsmq.password}
    rsremote.esb.domain=domain1
    rsremote.esb.brokername=router1
    rsremote.esb.mgmtaddr=
    rsremote.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
    rsremote.esb.createqueueretry=30
    rsremote.esb.createqueuewait=10
    rsremote.esb.keepalive=0
    rsremote.esb.maxfailed=10
    rsremote.esb.cachesize=500
    rsremote.esb.flowcontrolstartqueuesize=400
    rsremote.esb.maxmessages=-1
    rsremote.esb.messagettl=1200000
    rsremote.esb.vhost=${rsmq.vhost}
  • RSRemote registration configuration
    rsremote.registration.logheartbeat=true
  • RSRemote ID configuration
    rsremote.id.group=default
    rsremote.id.description=RSREMOTE
    rsremote.id.location=${LOCALHOST}
  • RSRemote Elasticsearch configuration
    rsremote.search.active=false
    rsremote.search.serverlist=${rssearch.serverlist}
    rsremote.search.shards=${rssearch.shards}
    rsremote.search.replicas=${rssearch.replicas}
    rsremote.search.indexthreads=${rssearch.indexthreads}
    rsremote.search.indextimout=${rssearch.indextimout}
    rsremote.search.indexretries=${rssearch.indexretries}
    rsremote.search.serverport=${rssearch.yml.transport.tcp.port}
    rsremote.search.cluster=${rssearch.yml.cluster.name}
    rsremote.search.clienttype=${rssearch.clienttype}
    rsremote.search.http=${rssearch.yml.http.enabled}
    rsremote.search.httpport=${rssearch.yml.http.port}
    rsremote.search.analytics=false
    rsremote.search.embedded=false
    rsremote.search.datadir=${DIST}/tmp/es
    #TTL is in seconds, default is 3 months (60*60*24*30*3)
    #ES removes system and rss posts based on this
    rsremote.search.ttl=7776000
  • User that owns RSRemote installation
    rsremote.run.R_USER=${resolve.user}
  • Additional java option when RSRemote is run
    rsremote.run.java_opts=

RSRemote Instance

Property NameDescriptionDefault Value
rsremote.instance.countNumber of rsremote instances1

RSRemote Instance1

Property NameDescriptionDefault Value
rsremote.instance1.nameName of the rsremote instance onersremote

RSRemote General

Property NameDescriptionDefault Value
rsremote.general.homeHome directory of the rsremote component.${DIST}
rsremote.general.clusternameName of the Actions Pro cluster.${CLUSTERNAME}
rsremote.general.clusterSet to 'true' to enable clustering in rsremote.false
rsremote.general.configfileversionDefault version of the rsremote config.xml.1.0
rsremote.general.configrevisionsNumber of backup to keep of the config.xml.2
rsremote.general.saveconfigonstartSave the config.xml on start-up.true
rsremote.general.saveconfigonexitSave the config.xml on exit.true
rsremote.general.cronoffsetPeriod of time to offset cron jobs.0
rsremote.general.maxthreadMaximum number of threads rsremote can have active at one time.500
rsremote.general.maxsystemthreadMaximum number of system threads rsremote can have active.500
rsremote.general.timezoneRSRemote's time zone.
rsremote.general.threadkeepaliveIf the number of threads is greater than the core, this is the maximum timethat excess idle threads will wait for new tasks before terminating.30
rsremote.general.perfdebugSet to 'true' to enable performance debugging.false
rsremote.general.mcpmodeThe mcp mode of the rsremote component.${MCPMODE}

RSRemote Log4j

Property NameDescriptionDefault Value
rsremote.log4j.Loggers.Root.levelDefines common log level.WARN
rsremote.log4j.Loggers.Root.appender-ref.refRSREMOTE,amqp
rsremote.log4j.Loggers.Logger.com.resolve.rsremote.level${rsremote.log4j.loglevel}
rsremote.log4j.Loggers.Logger.com.resolve.dcs.httplogappender.levelINFO
rsremote.log4j.Loggers.Logger.DCS.levelINFO
rsremote.log4j.Loggers.Logger.DCS.appender-ref.refDCS
rsremote.log4j.Loggers.Logger.syslog.levelERROR
rsremote.log4j.Loggers.Logger.syslog.additivityfalse
rsremote.log4j.Appenders.RollingFile.nameREMOTE
rsremote.log4j.Appenders.RollingFile.fileNamersremote/log/rsremote.log
rsremote.log4j.Appenders.RollingFile.filePatternrsremote/log/$\\${date:yyyy-MM}/rsremote-%d{MM-dd-yyyy}-%i.log.zip
rsremote.log4j.Appenders.RollingFile.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsremote.log4j.Appenders.RollingFile.SizeBasedTriggeringPolicy.size32MB
rsremote.log4j.Appenders.RollingFile.DefaultRolloverStrategy.max6
rsremote.log4j.Appenders.AmqpAppender.nameamqp
rsremote.log4j.Appenders.AmqpAppender.thresholdWARN
rsremote.log4j.Appenders.AmqpAppender.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] %X{context} %X{filter} (%F:%L) - %m%n
rsremote.log4j.Appenders.HttpLogAppender.nameDCS
rsremote.log4j.Appenders.HttpLogAppender.charsetutf-8
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword
rsremote.log4j.Appenders.HttpLogAppender.hostAddresses${RSREMOTE_RSDATALOADER_URL}
rsremote.log4j.Appenders.HttpLogAppender.httpConnectionTimeout5000
rsremote.log4j.Appenders.HttpLogAppender.httpSOTimeout1000
rsremote.log4j.Appenders.HttpLogAppender.maxConnections100
rsremote.log4j.Appenders.HttpLogAppender.templatesToEndpointsMappingdata-collector-template:/api/v1/data/collected,incident-events-template:/api/v1/data/incident/events
rsremote.log4j.Appenders.HttpLogAppender.threadCount10
rsremote.log4j.Appenders.HttpLogAppender.PatternLayout.pattern%m
rsremote.log4j.Appenders.HttpLogAppender.enabledfalse
rsremote.log4j.Appenders.HttpLogAppender.sslEnabled${RSREMOTE_SSL_ENABLED}
rsremote.log4j.Appenders.HttpLogAppender.sslVerify${RSREMOTE_SSL_VERIFY}
rsremote.log4j.Appenders.HttpLogAppender.trustStore${RSREMOTE_TRUSTSTORE_PATH}
rsremote.log4j.Appenders.HttpLogAppender.trustStorePassword${RSREMOTE_TRUSTSTORE_PASSWORD}
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance${RSREMOTE_RSDATALOADER_URL}/login
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsernamersremote
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword

RSRemote ESB

Property NameDescriptionDefault Value
rsremote.esb.productProduct used for the rsremote esb.${rsmq.product}
rsremote.esb.brokeraddrAddress and port used for messaging.${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsremote.esb.usernameUsername used to connect to the esb product.${rsmq.username}
rsremote.esb.passwordPassword used to connect to the esb product.${rsmq.password}
rsremote.esb.domaindeprecated*domain1
rsremote.esb.brokernamedeprecated*router1
rsremote.esb.mgmtaddrdeprecated*
rsremote.esb.brokeraddr2Backup address and port used for messaging.${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsremote.esb.createqueueretryPeriod of time to retry creating a queue.30
rsremote.esb.createqueuewaitPeriod of time to wait before creating a queue.10
rsremote.esb.keepaliveAfter how long time to send a keep alive message.0
rsremote.esb.maxfailedMaximum amount of failed messaged allowed.10
rsremote.esb.cachesizeMaximum number of messages that can be cached.500
rsremote.esb.flowcontrolstartqueuesizeMaximum number of messages allowed before flow control starts.400
rsremote.esb.maxmessagesMaximum number of messages allowed -1 means unlimited.1
rsremote.esb.messagettlThe message time to live.600000
rsremote.esb.sslprotocolThe ssl protocol used must be atleast TLSv1.1.TLSv1.2
rsremote.esb.vhost${rsmq.vhost}

RSRemote Registration

Property NameDescriptionDefault Value
rsremote.registration.parentguidGuide of rsremotes parent component.RSCONTROL
rsremote.registration.expirationPeriod of time until component registration expires.10080
rsremote.registration.discardPeriod of time to wait until an expired registation is discarded.43200
rsremote.registration.intervalInterval in minutes for sending of heartbeats.5
rsremote.registration.logheartbeatThe log each heartbeat sent.true
Property NameDescriptionDefault Value
rsremote.search.activeSet to 'true' to activate use of Elasticsearch in rsremote.false
rsremote.search.serverlistList of each elasticsearch node.${rssearch.serverlist}
rsremote.search.shardsNumber of shards in each index.${rssearch.shards}
rsremote.search.replicasNumber of replicas kept by elasticsearch.${rssearch.replicas}
rsremote.search.indexthreadsdeprecated*${rssearch.indexthreads}
rsremote.search.indextimoutPeriod of time it takes for a request to an index takes to timeout.${rssearch.indextimout}
rsremote.search.indexretriesPeriod of times to retry a request to an index.${rssearch.indexretries}
rsremote.search.serverportPort used by elasticsearch.${rssearch.yml.transport.tcp.port}
rsremote.search.clusterName of the elasticsearch cluster.${rssearch.yml.cluster.name}
rsremote.search.clienttypeSet whether clients should be node or transport.${rssearch.clienttype}
rsremote.search.httpSet to 'true' to enable http in elasticsearch.${rssearch.yml.http.enabled}
rsremote.search.httpportPort elasticsearch uses for http calls.${rssearch.yml.http.port}
rsremote.search.ttlPeriod of time for an index to live.${search.ttl}

RSRemote ID

Property NameDescriptionDefault Value
rsremote.id.groupName of the Actions Pro cluster.${CLUSTERNAME}
rsremote.id.descriptionDescription of the rsremote component.RSREMOTE
rsremote.id.locationAddress of the rsremote.${LOCALHOST}

RSRemote Run

Property NameDescriptionDefault Value
rsremote.run.R_USERUser to run rsremote.${resolve.user}
rsremote.run.java_optsExtra java options used when running rsremote.
rsremote.run.terminatetimeoutPeriod of time before a run is timedout and terminated.600

RSSync Settings

All RSSync Settings

The following lists shows the logical groups of RSSync properties and their default values.

  • User that owns RSSync installation

    rssync.run.R_USER=${resolve.user}
  • Additional java option when RSSync is run

    rssync.run.java_opts=
    rssync.run.terminatetimeout=30
  • RSSync JDK environment

    rssync.env.RSSYNCJDK=${resolve.java_home}
  • RSRemote general configuration

    rssync.general.home=${DIST}
    rssync.general.clustername=${CLUSTERNAME}
    #this is used when multiple RSSyncs are deployed to balance load. In that case this list will be divided among the RSSync.
    #DO NOT list same item in multiple RSSyncs.
    rssync.general.synclogs=synclog_misc,synclog_socialpost,synclog_systempost,synclog_tag,synclog_worksheet,synclog_processrequest,synclog_taskresult,synclog_pbnotes,synclog_pbauditlog,synclog_pbartifacts,synclog_pbattachment,synclog_pbactivity
    rssync.general.syncinterval=10000
    rssync.general.syncsize=1000
    rssync.general.mcpmode=${MCPMODE}
    rssync.general.environment=${ENVIRONMENT}
  • RSRemote Log4j configuration

    rssync.log4j.Loggers.Root.level=${rssync.log4j.loglevel}
    rssync.log4j.Loggers.Root.appender-ref.ref=UPDATE
    rssync.log4j.Loggers.Logger.com.resolve.rssync.level=${rssync.log4j.loglevel}
    rssync.log4j.Loggers.Logger.com.resolve.rssync.additivity=false
    rssync.log4j.Loggers.Logger.com.resolve.rssync.appender-ref.ref=RSSYNC
    rssync.log4j.Loggers.Logger.com.resolve.update.level=INFO
    rssync.log4j.Loggers.Logger.syslog.level=ERROR
    rssync.log4j.Loggers.Logger.syslog.additivity=false
    rssync.log4j.Appenders.RollingFile.RSSYNC.fileName=rssync/log/rssync.log
    rssync.log4j.Appenders.RollingFile.RSSYNC.filePattern=rssync/log/$\${date:yyyy-MM}/rssync-%d{MM-dd-yyyy}-%i.log.zip
    rssync.log4j.Appenders.RollingFile.RSSYNC.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rssync.log4j.Appenders.RollingFile.RSSYNC.SizeBasedTriggeringPolicy.size=32MB
    rssync.log4j.Appenders.RollingFile.RSSYNC.DefaultRolloverStrategy.max=6
    rssync.log4j.Appenders.RollingFile.UPDATE.fileName=rssync/log/update.log
    rssync.log4j.Appenders.RollingFile.UPDATE.filePattern=rssync/log/$\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
    rssync.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval=1
    rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate=true
  • RSSync config.xml ESB information

    rssync.esb.product=${rsmq.product}
    rssync.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
    rssync.esb.username=${rsmq.username}
    rssync.esb.password=${rsmq.password}
    rssync.esb.domain=domain1
    rssync.esb.brokername=router1
    rssync.esb.mgmtaddr=
    rssync.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
    rssync.esb.createqueueretry=30
    rssync.esb.createqueuewait=10
    rssync.esb.keepalive=0
    rssync.esb.maxfailed=10
    rssync.esb.cachesize=500
    rssync.esb.maxmessages=-1
    rssync.esb.sslprotocol=TLSv1.2
    rssync.esb.connectionTimeout=5000
    rssync.esb.vhost=${rsmq.vhost}
  • RSSync Elasticsearch configuration

    rssync.search.active=true
    rssync.search.serverlist=${rssearch.serverlist}
    rssync.search.shards=${rssearch.shards}
    rssync.search.replicas=${rssearch.replicas}
    rssync.search.indexthreads=${rssearch.indexthreads}
    rssync.search.indextimout=${rssearch.indextimout}
    rssync.search.indexretries=${rssearch.indexretries}

    rssync.search.serverport=${rssearch.yml.transport.tcp.port}
    rssync.search.compress=${rssearch.yml.transport.tcp.compress}
    rssync.search.cluster=${rssearch.yml.cluster.name}
    rssync.search.clienttype=${rssearch.clienttype}
    rssync.search.http=${rssearch.yml.http.enabled}
    rssync.search.httpport=${rssearch.yml.http.port}
    rssync.search.scrollctxkeepalivedurationinminutes=${rssearch.scrollctxkeepalivedurationinminutes}

    #site to site replication config
    rssync.search.sync=${rssearch.sync}
    rssync.search.synccluster=${rssearch.synccluster}
    rssync.search.syncserverlist=${rssearch.syncserverlist}
    rssync.search.syncserverport=${rssearch.syncserverport}
  • RSSync database settings

    rssync.sql.active=true
    rssync.sql.dbtype=${DB_TYPE}
    rssync.sql.dbname=${DB_NAME}
    rssync.sql.host=${DB_HOST}
    rssync.sql.username=${DB_USERNAME}
    rssync.sql.password=${DB_PASSWORD}
    rssync.sql.url=${DB_URL}
    rssync.sql.perfdebug=false
  • RSSync keyservice configiration

    rssync.keyservice.proto=${KEYSERVICE_PROTO}
    rssync.keyservice.host=${KEYSERVICE_HOST}
    rssync.keyservice.port=${KEYSERVICE_PORT}
    rssync.keyservice.username=${KEYSERVICE_USERNAME}
    rssync.keyservice.pwd=${KEYSERVICE_PWD}

RSSync General

Property NameDescriptionDefault Value
rssync.general.homeHome directory of the rssync component.${DIST}
rssync.general.clusternameName of the RSSEARCH cluster.${CLUSTERNAME}
rssync.general.syncintervalInterval between syncs.10000
rssync.general.synclogsIndecies that this rssync instance should sync with in elasticsearch. Do not list the same item in multiple rssyncs.synclog_misc,synclog_socialpost,synclog_systempost,synclog_tag,synclog_worksheet,synclog_processrequest,synclog_taskresult
rssync.general.syncsizeMaxmimum number of entryies that can be synced in one batch.1000
rssync.general.mcpmodeMcpmode of the rssync component.${MCPMODE}

RSSync Log4j

Property NameDescriptionDefault Value
rssync.log4j.Loggers.Root.level${rssync.log4j.loglevel}
rssync.log4j.Loggers.Root.appender-ref.refUPDATE
rssync.log4j.Loggers.Logger.com.resolve.rssync.level${rssync.log4j.loglevel}
rssync.log4j.Loggers.Logger.com.resolve.rssync.additivityfalse
rssync.log4j.Loggers.Logger.com.resolve.rssync.appender-ref.refRSSYNC
rssync.log4j.Loggers.Logger.com.resolve.update.levelINFO
rssync.log4j.Loggers.Logger.syslog.levelERROR
rssync.log4j.Loggers.Logger.syslog.additivityfalse
rssync.log4j.Appenders.RollingFile.RSSYNC.fileNamerssync/log/rssync.log
rssync.log4j.Appenders.RollingFile.RSSYNC.filePatternrssync/log/$\\${date:yyyy-MM}/rssync-%d{MM-dd-yyyy}-%i.log.zip
rssync.log4j.Appenders.RollingFile.RSSYNC.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rssync.log4j.Appenders.RollingFile.RSSYNC.SizeBasedTriggeringPolicy.size32MB
rssync.log4j.Appenders.RollingFile.RSSYNC.DefaultRolloverStrategy.max6
rssync.log4j.Appenders.RollingFile.UPDATE.fileNamerssync/log/update.log
rssync.log4j.Appenders.RollingFile.UPDATE.filePatternrssync/log/$\\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
rssync.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval1
rssync.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulatetrue
Property NameDescriptionDefault Value
rssync.search.activeSet to 'true' to activate elasticsearch in rssync.true
rssync.search.serverlistList of elasticsearch nodes.${rssearch.serverlist}
rssync.search.shardsNumber of shards per index.${rssearch.shards}
rssync.search.replicasNumber of replicas in elasticsearch.${rssearch.replicas}
rssync.search.indexthreadsdeprecated*${rssearch.indexthreads}
rssync.search.indextimoutPeriod of time it takes for a request to an index to timeout${rssearch.indextimout}
rssync.search.indexretriesPeriod of time to retry a request to an index.${rssearch.indexretries}
rssync.search.serverportPort used by elasticsearch for tcp transport.${rssearch.yml.transport.tcp.port}
rssync.search.clusterName of the elasticsearch cluster.${rssearch.yml.cluster.name}
rssync.search.clienttypeSet whether clients should be node or transport.${rssearch.clienttype}
rssync.search.httpSet to 'true' to enable http in elastic search.${rssearch.yml.http.enabled}
rssync.search.httpportPort used by elastic search for http.${rssearch.yml.http.port}
rssync.search.ttlTime for each index to live.${search.ttl}
rssync.search.syncSet to 'true' to sync rssearch nodes.${rssearch.sync}
rssync.search.syncclusterName of the remote cluster used for discovery.${rssearch.synccluster}
rssync.search.syncserverlistName of each node to sync.${rssearch.syncserverlist}
rssync.search.syncserverportPort used when syncing elasticsearch nodes.${rssearch.syncserverport}
rssync.esb.vhost${rsmq.vhost}

RSArchive Settings

All RSArchive Settings

The following lists shows the logical groups of RSARchive properties and their default values.

  • User that owns RSSync installation
    rsarchive.run.R_USER=${resolve.user}
  • Additional java option when RSArchive is run
    rsarchive.run.java_opts=
  • RSArchive JDK environment
    rsarchive.env.RSARCHIVEJDK=${resolve.java_home}
  • RSArchive general configuration
    rsarchive.general.home=${DIST}
    rsarchive.general.clustername=${CLUSTERNAME}
    rsarchive.general.configfileversion=1.0
    rsarchive.general.configrevisions=2
    rsarchive.general.saveconfigonstart=true
    rsarchive.general.saveconfigonexit=true
    rsarchive.general.savecrononexit=false
    rsarchive.general.cronoffset=0
    rsarchive.general.snmptraphost=
    rsarchive.general.snmptrapport=162
    rsarchive.general.threadkeepalive=30
    rsarchive.general.perfdebug=false
    rsarchive.general.executorbusyratio=0.9
    rsarchive.general.sysexecutorbusyratio=0.9
    rsarchive.general.startexecutorbusyratio=0.9
    rsarchive.general.dbpoolbusyratio=0.9
    rsarchive.general.maxrunbooklimit=400
    rsarchive.general.minrunbooklimit=1
    rsarchive.general.userunbookcount=false
    rsarchive.general.mcpmode=${MCPMODE}
  • RSArchive Log4j configuration
    rsarchive.log4j.Loggers.Root.level=WARN
    rsarchive.log4j.Loggers.Root.appender-ref.ref=RSARCHIVE
    rsarchive.log4j.Loggers.Logger.com.resolve.rsarchive.level=${rsarchive.log4j.loglevel}
    rsarchive.log4j.Loggers.Logger.com.mchange.v2.level=INFO
    rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.fileName=rsarchive/log/rsarchive.log
    rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.filePattern=rsarchive/log/$\${date:yyyy-MM}/rsarchive-%d{MM-dd-yyyy}-%i.log.zip
    rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
    rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.SizeBasedTriggeringPolicy.size=32MB
    rsarchive.log4j.Appenders.RollingFile.RSARCHIVE.DefaultRolloverStrategy.max=6
  • RSArchive database settings
    rsarchive.sql.dbtype=${DB_TYPE}
    rsarchive.sql.dbname=${DB_NAME}
    rsarchive.sql.host=${DB_HOST}
    rsarchive.sql.username=${DB_USERNAME}
    rsarchive.sql.password=${DB_PASSWORD}
    rsarchive.sql.url=${DB_URL}
    rsarchive.sql.maxpoolsize=100
    rsarchive.sql.minpoolsize=${rsarchive.sql.maxpoolsize}
    rsarchive.sql.maxidletime=60
    rsarchive.sql.perfdebug=false
    rsarchive.sql.usexadatasource=true
  • RSArchive key service configuration
    rsarchive.keyservice.proto=${KEYSERVICE_PROTO}
    rsarchive.keyservice.host=${KEYSERVICE_HOST}
    rsarchive.keyservice.port=${KEYSERVICE_PORT}
    rsarchive.keyservice.username=${KEYSERVICE_USERNAME}
    rsarchive.keyservice.pwd=${KEYSERVICE_PWD}
  • RSArchive ID configuration
    rsarchive.id.group=${CLUSTERNAME}
    rsarchive.id.description=RSARCHIVE
    rsarchive.id.location=${LOCALHOST}
  • RSArchive hibernate configuration
    rsarchive.hibernate.dbtype=${hibernate.dbtype}
    rsarchive.hibernate.hibernate.default_schema=${hibernate.default_schema}
  • RSArchive archival configuration
    rsarchive.archive.active=true
    rsarchive.archive.schedule=0 0 2 * * ?
    rsarchive.archive.expiry=30
    rsarchive.archive.cleanup=60
    #number of records to be inserted/deleted as a block.
    rsarchive.archive.blocksize = 10000
    #currently for resolve_process_request and worksheet tables.
    rsarchive.archive.smalltableblocksize = 2000
  • RSArchive Elasticsearch configuration
    rsarchive.search.active=true
    rsarchive.search.serverlist=${rssearch.serverlist}
    rsarchive.search.shards=${rssearch.shards}
    rsarchive.search.replicas=${rssearch.replicas}
    rsarchive.search.indexthreads=${rssearch.indexthreads}
    rsarchive.search.indextimout=${rssearch.indextimout}
    rsarchive.search.indexretries=${rssearch.indexretries}
    rsarchive.search.serverport=${rssearch.yml.transport.tcp.port}
    rsarchive.search.compress=${rssearch.yml.transport.tcp.port}
    rsarchive.search.cluster=${rssearch.yml.cluster.name}
    rsarchive.search.clienttype=${rssearch.clienttype}
    rsarchive.search.http=${rssearch.yml.http.enabled}
    rsarchive.search.httpport=${rssearch.yml.http.port}
    rsarchive.search.searchguard=${rssearch.searchguard}
    rsarchive.search.sgkeystore=${rssearch.sgkeystore}
    rsarchive.search.sgkeystorepwd=${rssearch.sgkeystorepwd}
    rsarchive.search.sgtruststore=${rssearch.sgtruststore}
    rsarchive.search.sgtruststorepwd=${rssearch.sgtruststorepwd}

Actions Pro Imports

Property NameDescriptionDefault Value
resolve.importdefault imports to import upon installusers, system, social, default, resolvex, content, gateway, cr, rsutil, reports, rx-customercare, rx-home, doc, automationbuilder

ESAPI Control

Property NameDescription
.ESAPI.AccessControlorg.owasp.esapi.reference.DefaultAccessController

ESAPI Authenticator

Property NameDefault Value
.ESAPI.Authenticatororg.owasp.esapi.reference.FileBasedAuthenticator
.ESAPI.Authenticator.AllowedLoginAttempts3
.ESAPI.Authenticator.MaxOldPasswordHashesENC1:EEI2QIlq5xRidWB+DTcv9A==
.ESAPI.Authenticator.UsernameParameterNameusername
.ESAPI.Authenticator.PasswordParameterNameENC1:XyBuox2SKKzdSIQR6QsxTg==
.ESAPI.Authenticator.RememberTokenDuration14
.ESAPI.Authenticator.IdleTimeoutDuration20
.ESAPI.Authenticator.AbsoluteTimeoutDuration120

ESAPI Encoder

Property NameDefault Value
.ESAPI.Encoderorg.owasp.esapi.reference.DefaultEncoder
.ESAPI.Encoder.AllowMultipleEncodingfalse
.ESAPI.Encoder.DefaultCodecListHTMLEntityCodec,PercentCodec,JavaScriptCodec

ESAPI Encryptor

Property NameDefault Value
.ESAPI.Encryptor.PreferredJCEProvider
.ESAPI.Encryptor.EncryptionAlgorithmAES
.ESAPI.Encryptor.CipherTransformationAES/CBC/PKCS5Padding
.ESAPI.Encryptor.cipher_modes.combined_modesGCM,CCM,IAPM,EAX,OCB,CWC
.ESAPI.Encryptor.cipher_modes.additional_allowedCBC
.ESAPI.Encryptor.EncryptionKeyLength128
.ESAPI.Encryptororg.owasp.esapi.reference.crypto.JavaEncryptor
.ESAPI.Encryptor.ChooseIVMethodrandom
.ESAPI.Encryptor.fixedIV0x000102030405060708090a0b0c0d0e0f
.ESAPI.Encryptor.CipherText.useMACtrue
.ESAPI.Encryptor.PlainText.overwritetrue
.ESAPI.Encryptor.HashAlgorithmSHA-512
.ESAPI.Encryptor.HashIterations1024
.ESAPI.Encryptor.DigitalSignatureAlgorithmSHA1withDSA
.ESAPI.Encryptor.DigitalSignatureKeyLength1024
.ESAPI.Encryptor.RandomAlgorithmSHA1PRNG
.ESAPI.Encryptor.CharacterEncodingUTF-8
.ESAPI.Encryptor.KDF.PRFHmacSHA256

ESAPI Executor

Property NameDefault Value
.ESAPI.Executororg.owasp.esapi.reference.DefaultExecutor
.ESAPI.Executor.WorkingDirectoryC:\WindowsTemp
.ESAPI.Executor.ApprovedExecutablesC:\Windows\System32\cmd.exe,C:\Windows\System32runas.exe

ESAPI

Property NameDefault Value
.ESAPI.HTTPUtilitiesorg.owasp.esapi.reference.DefaultHTTPUtilities
.ESAPI.HttpUtilities.UploadDirC:\ESAPItestUpload
.ESAPI.HttpUtilities.UploadTempDirC:temp
.ESAPI.HttpUtilities.ForceHttpOnlySessionfalse
.ESAPI.HttpUtilities.ForceSecureSessionfalse
.ESAPI.HttpUtilities.ForceHttpOnlyCookiesfalse
.ESAPI.HttpUtilities.ForceSecureCookies${rsview.tomcat.https}
.ESAPI.HttpUtilities.MaxHeaderSize4096
.ESAPI.HttpUtilities.ApprovedUploadExtensions.zip,.pdf,.doc,.docx,.ppt,.pptx,.tar,.gz,.tgz,.rar,.war,.jar,.ear,.xls,.rtf,.properties,.java,.class,.txt,.xml,.jsp,.jsf,.exe,.dll,.conf,.cfg,.bak,.1,.2,.log,.lic,.png,.jpg,.ico,.csv,.json,.css,.vm,.maint,.groovy,.cons
.ESAPI.HttpUtilities.MaxUploadFileBytes500000000
.ESAPI.HttpUtilities.ResponseContentTypetext/html, charset=UTF-8
.ESAPI.HttpUtilities.HttpSessionIdNameJSESSIONID

ESAPI Intrusion

Property NameDefault Value
ESAPI.IntrusionDetector.Disabletrue
ESAPI.IntrusionDetectororg.owasp.esapi.reference.DefaultIntrusionDetector
ESAPI.IntrusionDetector.event.test.actionsdisable
ESAPI.IntrusionDetector.event.test.count2
ESAPI.IntrusionDetector.event.test.interval10
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionslog,disable,logout
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count10
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval5
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionslog,disable,logout
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count1
ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval1
ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count2
ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval10
ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionslog,logout

ESAPI Logger

Property NameDefault Value
.ESAPI.Loggerorg.owasp.esapi.reference.Log4JLogFactory
.ESAPI.Logger.ApplicationNameResolve
.ESAPI.Logger.LogApplicationNametrue
.ESAPI.Logger.LogEncodingRequiredfalse
.ESAPI.Logger.LogFileNameESAPI_logging_file
.ESAPI.Logger.MaxLogFileSize10000000
.ESAPI.Logger.LogServerIPtrue

ESAPI Printproperty

Property NameDefault Value
ESAPI.printPropertiestrue

Randomizer

Property NameDefault Value
ESAPI.Randomizerorg.owasp.esapi.reference.DefaultRandomizer

ESAPI Validator

Property NameDefault Value
.ESAPI.Validatororg.owasp.esapi.reference.DefaultValidator
.ESAPI.Validator.AcceptLenientDatesfalse
.ESAPI.Validator.AccountName^[a-zA-Z0-9]{3,20}$
.ESAPI.Validator.ConfigurationFilevalidation.properties
.ESAPI.Validator.DirectoryName^.*$
.ESAPI.Validator.FileName^.*$
.ESAPI.Validator.HTTPContextPath^\/?[a-zA-Z0-9.\-\/_]*$
.ESAPI.Validator.HTTPCookieName^[a-zA-Z0-9\-_]{1,32}$
.ESAPI.Validator.HTTPCookieValuea-zA-Z0-9\-\/+=_\.: \\@]*$
.ESAPI.Validator.HTTPHeaderName^.*$
.ESAPI.Validator.HTTPHeaderValue^.*$
.ESAPI.Validator.HTTPJSESSIONID^[A-Z0-9]{10,30}$
.ESAPI.Validator.HTTPParameterName^[a-zA-Z0-9_]{1,32}$
.ESAPI.Validator.HTTPParameterValue^[a-zA-Z0-9.\-\/+=@_ \\]*$
.ESAPI.Validator.HTTPPath^[a-zA-Z0-9.\-_]*$
.ESAPI.Validator.HTTPQueryString^[a-zA-Z0-9()\-=\*\.\?;,+\/:&_ %\\@]*$
.ESAPI.Validator.HTTPServletPath^[a-zA-Z0-9.\-\/_]*$
.ESAPI.Validator.HTTPScheme^(http
.ESAPI.Validator.HTTPServerName^[a-zA-Z0-9_.\-]*$
.ESAPI.Validator.HTTPURI^.*$
.ESAPI.Validator.HTTPURL^.*$
.ESAPI.Validator.Redirect^.*$
.ESAPI.Validator.RoleName^[a-z]{1,20}$
.ESAPI.Validator.SystemCommand^[a-zA-Z\-\/]{1,64}$

ESAPI Authentification

Property NameDefault Value
rsconsole.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rsconsole.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attempt.
rsconsole.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rsconsole.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator.
rsconsole.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rsconsole.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rsconsole.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before timeout.
rsconsole.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token is times out.

RSConsole ESAPI

Property NameDefault Value
rsconsole.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider

RSConsole ESAPI

Property NameDefault Value
rsconsole.ESAPI.AccessControlClass used for access control

RSConsole ESAPI Encryptor

Property NameDefault Value
rsconsole.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rsconsole.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rsconsole.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rsconsole.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rsconsole.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsconsole.ESAPI.EncryptorClass used for encryption.
rsconsole.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rsconsole.ESAPI.Encryptor.fixedIVIinitialization vector to use if fixed IV method is chosen.
rsconsole.ESAPI.Encryptor.CipherText.useMACIf 'true' compute and store the MAC.
rsconsole.ESAPI.Encryptor.PlainText.overwriteFirst overwrite the bytes of plaintext with the character.
rsconsole.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rsconsole.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rsconsole.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature.
rsconsole.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsconsole.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rsconsole.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rsconsole.ESAPI.Encryptor.KDF.PRFPseudo random function used in KDF.

RSConsole ESAPI Executor

Property NameDefault Value
rsconsole.ESAPI.ExecutorClass used to execute os commands.
rsconsole.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed.
rsconsole.ESAPI.Executor.ApprovedExecutablesList of approved executable files.

RSConsole ESAPI HTTPutilities

Property NameDefault Value
rsconsole.ESAPI.HTTPUtilitiesClass used for securing http requests,responses,sessions, cookies, headers, and logging.
rsconsole.ESAPI.HttpUtilities.UploadDirDirectory where files are uploaded.
rsconsole.ESAPI.HttpUtilities.UploadTempDirDirectory where temporary files are uploaded.
rsconsole.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rsconsole.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rsconsole.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rsconsole.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rsconsole.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rsconsole.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rsconsole.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rsconsole.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and it's character encoding.
rsconsole.ESAPI.HttpUtilities.HttpSessionIdNameThe name of the http session.

RSConsole ESAPI Intrusion Detector

Property NameDefault Value
rsconsole.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rsconsole.ESAPI.IntrusionDetectorClass used for intrusion detection.
rsconsole.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rsconsole.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rsconsole.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rsconsole.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.
rsconsole.ESAPI.LoggerLogger factory used to create a logger.
rsconsole.ESAPI.Logger.ApplicationNameName of the application being logged for.
rsconsole.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name
rsconsole.ESAPI.Logger.LogEncodingRequiredSet to true to require log data to be encoded.
rsconsole.ESAPI.Logger.LogFileNameName of file to log into
rsconsole.ESAPI.Logger.MaxLogFileSizeMax log file size.
rsconsole.ESAPI.Logger.LogServerIPLog the server ip when logging.

RSConsole ESAPI print Properties

Property NameDefault Value
rsconsole.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded

RSConsole ESAPI Randomizer

Property NameDefault Value
rsconsole.ESAPI.RandomizerClass used for creating random numbers

RSConsole ESAPI Validator

Property NameDefault Value
rsconsole.ESAPI.ValidatorClass used for validation.
rsconsole.ESAPI.Validator.AcceptLenientDatesSet to 'true' to accept lenient dates.
rsconsole.ESAPI.Validator.AccountNameregex for allowed characters and length for an account name
rsconsole.ESAPI.Validator.ConfigurationFileName of the config file for validation.
rsconsole.ESAPI.Validator.DirectoryNameregex for a valid directory name
rsconsole.ESAPI.Validator.FileNameregex for a valid file name
rsconsole.ESAPI.Validator.HTTPContextPathregex for a valid http context path
rsconsole.ESAPI.Validator.HTTPCookieNameregex for a valid cookie name
rsconsole.ESAPI.Validator.HTTPCookieValueregex for a valid cookie value
rsconsole.ESAPI.Validator.HTTPHeaderNameregex for a valid http header name
rsconsole.ESAPI.Validator.HTTPHeaderValueregex for a valid http header value
rsconsole.ESAPI.Validator.HTTPJSESSIONIDregex for a valid http JSESSIONID
rsconsole.ESAPI.Validator.HTTPParameterNameregex for a valid http parameter name
rsconsole.ESAPI.Validator.HTTPParameterValueregex for a valid http parameter value
rsconsole.ESAPI.Validator.HTTPPathregex for a valid http path.
rsconsole.ESAPI.Validator.HTTPQueryStringregex for a valid http query string
rsconsole.ESAPI.Validator.HTTPServletPathregex for a valid http servlet path
rsconsole.ESAPI.Validator.HTTPSchemeregex for a valid http scheme
rsconsole.ESAPI.Validator.HTTPServerNameregex for a valid http server name
rsconsole.ESAPI.Validator.HTTPURIregex for a valid http uri
rsconsole.ESAPI.Validator.HTTPURLregex for a valid http url
rsconsole.ESAPI.Validator.Redirectregex for a valid redirect
rsconsole.ESAPI.Validator.RoleNameregex for a valid rolename
rsconsole.ESAPI.Validator.SystemCommandregex for a valid System Command

RSControl ESAPI AccesControl

Property NameDefault Value
rscontrol.ESAPI.AccessControlClass used for access control.

RSControl ESAPI Authentication

Property NameDefault Value
rscontrol.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rscontrol.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attemps.
rscontrol.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rscontrol.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator
rscontrol.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rscontrol.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rscontrol.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before timeout.
rscontrol.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token is times out.

RSControl ESAPI Encoder

Property NameDefault Value
rscontrol.ESAPI.EncoderClass used for encoding.
rscontrol.ESAPI.Encoder.AllowMultipleEncodingSet to 'true' to allow multiple encoding.
rscontrol.ESAPI.Encoder.DefaultCodecListList of encoders used by default.
rscontrol.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider.
rscontrol.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rscontrol.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rscontrol.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rscontrol.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rscontrol.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rscontrol.ESAPI.EncryptorClass used for encryption.
rscontrol.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rscontrol.ESAPI.Encryptor.fixedIVInitialization vector to use if fixed IV method is chosen.
rscontrol.ESAPI.Encryptor.CipherText.useMACIf 'true' compute and store the MAC
rscontrol.ESAPI.Encryptor.PlainText.overwriteFirst overwrite teh bytes of plaintext with the character
rscontrol.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rscontrol.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rscontrol.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature.
rscontrol.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rscontrol.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rscontrol.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rscontrol.ESAPI.Encryptor.KDF.PRFPseudo random function used in KDF.

RSControl ESAPI Executor

Property NameDefault Value
rscontrol.ESAPI.ExecutorClass used to execute os commands.
rscontrol.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed.
rscontrol.ESAPI.Executor.ApprovedExecutablesList of approved executable files.

RSControl ESAPI HTTUtilties

Property NameDefault Value
rscontrol.ESAPI.HTTPUtilitiesClass used for securing http requests,responses,sessions, cookies, headers, and logging.
rscontrol.ESAPI.HttpUtilities.UploadDirDirectory for files upload.
rscontrol.ESAPI.HttpUtilities.UploadTempDirDirectory for temporary files upload.
rscontrol.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rscontrol.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rscontrol.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rscontrol.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rscontrol.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rscontrol.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rscontrol.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rscontrol.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and its character encoding.
rscontrol.ESAPI.HttpUtilities.HttpSessionIdNameName of the http session.

RSControl ESAPI Intrsuin Detector

Property NameDefault Value
rscontrol.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rscontrol.ESAPI.IntrusionDetectorClass used for intrusion detection.
rscontrol.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rscontrol.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rscontrol.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rscontrol.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.

RSControl ESAPI Logger

Property NameDefault Value
rscontrol.ESAPI.LoggerLogger factory used to create a logger.
rscontrol.ESAPI.Logger.ApplicationNameName of the application being logged for.
rscontrol.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name.
rscontrol.ESAPI.Logger.LogEncodingRequiredSet to 'true' to require log data to be encoded.
rscontrol.ESAPI.Logger.LogFileNameName of file to log into.
rscontrol.ESAPI.Logger.MaxLogFileSizeMax log file size.
rscontrol.ESAPI.Logger.LogServerIPLog the server ip when logging.

RSControl ESAPI Encryptor

Property NameDefault Value
rscontrol.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded.

RSControl ESAPI Randomizer

Property NameDefault Value
rscontrol.ESAPI.RandomizerClass used for creating random numbers.

RSmgmt ESAPI AccessControl

Property NameDefault Value
rsmgmt.ESAPI.AccessControlClass used for access control.

RSmgmt ESAPI Authentification

Property NameDefault Value
rsmgmt.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rsmgmt.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attemps.
rsmgmt.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rsmgmt.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator.
rsmgmt.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rsmgmt.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rsmgmt.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before time out.
rsmgmt.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token times out

RSmgmt ESAPI Encoder

Property NameDefault Value
rsmgmt.ESAPI.EncoderClass used for encoding.
rsmgmt.ESAPI.Encoder.AllowMultipleEncodingSet to 'true' to allow multiple encoding.
rsmgmt.ESAPI.Encoder.DefaultCodecListList of encoders used by default.

RSmgmt ESAPI Encryptor

Property NameDefault Value
rsmgmt.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider.
rsmgmt.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rsmgmt.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rsmgmt.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rsmgmt.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rsmgmt.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsmgmt.ESAPI.EncryptorClass used for encryption.
rsmgmt.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rsmgmt.ESAPI.Encryptor.fixedIVInitialization vector to use if fixed IV method is chosen.
rsmgmt.ESAPI.Encryptor.CipherText.useMACIf 'true' compute and store the MAC.
rsmgmt.ESAPI.Encryptor.PlainText.overwriteFirst overwrite the bytes of plaintext with the character.
rsmgmt.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rsmgmt.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rsmgmt.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature.
rsmgmt.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsmgmt.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rsmgmt.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rsmgmt.ESAPI.Encryptor.KDF.PRFPsuedo random function used in KDF.

RSmgmt ESAPI Executor

Property NameDefault Value
rsmgmt.ESAPI.ExecutorClass used to execute os commands.
rsmgmt.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed.
rsmgmt.ESAPI.Executor.ApprovedExecutablesList of approved executable files.

RSmgmt HTTPUtilities

Property NameDefault Value
rsmgmt.ESAPI.HTTPUtilitiesClass used for securing http requests, responses, sessions, cookies, headers, and logging.
rsmgmt.ESAPI.HttpUtilities.UploadDirDirectory for files upload.
rsmgmt.ESAPI.HttpUtilities.UploadTempDirDirectory for temporary files upload.
rsmgmt.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rsmgmt.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rsmgmt.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rsmgmt.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rsmgmt.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rsmgmt.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rsmgmt.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rsmgmt.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and its character encoding.
rsmgmt.ESAPI.HttpUtilities.HttpSessionIdNameName of the http session.

RSmgmt ESAPI Intrusion Detector

Property NameDefault Value
rsmgmt.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rsmgmt.ESAPI.IntrusionDetectorClass used for intrusion detection.
rsmgmt.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rsmgmt.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rsmgmt.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.

RSmgmt ESAPI Logger

Property NameDefault Value
rsmgmt.ESAPI.LoggerLogger factory used to create a logger.
rsmgmt.ESAPI.Logger.ApplicationNameName of the application being logged for.
rsmgmt.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name.
rsmgmt.ESAPI.Logger.LogEncodingRequiredSet to 'true' to require log data to be encoded.
rsmgmt.ESAPI.Logger.LogFileNameName of file to log into.
rsmgmt.ESAPI.Logger.MaxLogFileSizeMax log file size.
rsmgmt.ESAPI.Logger.LogServerIPLog the server IP when logging.

RSmgmt printProperteis

Property NameDefault Value
rsmgmt.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded.

RSmgmt ESAPI Randomizer

Property NameDescriptionDefault Value
rsmgmt.ESAPI.RandomizerClass used for creating random numbers.org.owasp.esapi.reference.DefaultRandomizer

RSmgmt ESAPI Validation

Property NameDefault Value
rsmgmt.ESAPI.ValidatorClass used for validation.
rsmgmt.ESAPI.Validator.AcceptLenientDatesSet to 'true' to accept lenient dates.
rsmgmt.ESAPI.Validator.AccountNameregex for allowed chracters and length for an account name
rsmgmt.ESAPI.Validator.ConfigurationFileName of the config file for validation.
rsmgmt.ESAPI.Validator.DirectoryNameregex for a valid directory name
rsmgmt.ESAPI.Validator.FileNameregex for a valid file name
rsmgmt.ESAPI.Validator.HTTPContextPathregex for a valid http context path
rsmgmt.ESAPI.Validator.HTTPCookieNameregex for a valid cookie name
rsmgmt.ESAPI.Validator.HTTPCookieValueregex for a valid cookie value
rsmgmt.ESAPI.Validator.HTTPHeaderNameregex for a valid http header name
rsmgmt.ESAPI.Validator.HTTPHeaderValueregex for a valid http header value
rsmgmt.ESAPI.Validator.HTTPJSESSIONIDregex for a valid http JSESSIONID
rsmgmt.ESAPI.Validator.HTTPParameterNameregex for a valid http parameter name
rsmgmt.ESAPI.Validator.HTTPParameterValueregex for a valid http parameter value
rsmgmt.ESAPI.Validator.HTTPPathregex for a valid http path
rsmgmt.ESAPI.Validator.HTTPQueryStringregex for a valid http query string
rsmgmt.ESAPI.Validator.HTTPServletPathregex for a valid http servlet path
rsmgmt.ESAPI.Validator.HTTPSchemeregex for a valid http scheme
rsmgmt.ESAPI.Validator.HTTPServerNameregex for a valid http server name
rsmgmt.ESAPI.Validator.HTTPURIregex for a valid http uri
rsmgmt.ESAPI.Validator.HTTPURLregex for a valid http url
rsmgmt.ESAPI.Validator.Redirectregex for a valid redirect
rsmgmt.ESAPI.Validator.RoleNameregex for a valid rolename
rsmgmt.ESAPI.Validator.SystemCommandregex for a valid System Command

RSproxy ESAPI Acces Control

Property NameDefault Value
rsproxy.ESAPI.AccessControlClass used for access control.

RSproxy ESAPI Authentication

Property NameDefault Value
rsproxy.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rsproxy.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attemps.
rsproxy.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rsproxy.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator.
rsproxy.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rsproxy.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rsproxy.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before time out.
rsproxy.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token times out.

RSproxy ESAPI Encoder

Property NameDefault Value
rsproxy.ESAPI.EncoderClass used for encoding.
rsproxy.ESAPI.Encoder.AllowMultipleEncodingSet to 'true' to allow multiple encoding.
rsproxy.ESAPI.Encoder.DefaultCodecListList of encoders used by default.

RSproxy ESAPI Encryptor

Property NameDefault Value
rsproxy.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider.
rsproxy.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rsproxy.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rsproxy.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rsproxy.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rsproxy.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsproxy.ESAPI.EncryptorClass used for encryption.
rsproxy.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rsproxy.ESAPI.Encryptor.fixedIVInitialization vector to use if fixed IV method is chosen.
rsproxy.ESAPI.Encryptor.CipherText.useMACIf 'true' compute and store the MAC.
rsproxy.ESAPI.Encryptor.PlainText.overwriteFirst overwrite the bytes of plaintext with the character.
rsproxy.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rsproxy.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rsproxy.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature.
rsproxy.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by. a cryptographic algorithm.
rsproxy.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rsproxy.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rsproxy.ESAPI.Encryptor.KDF.PRFPsuedo random function used in KDF.

RSproxy ESAPI Executor

Property NameDefault Value
rsproxy.ESAPI.ExecutorClass used to execute os commands.
rsproxy.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed.
rsproxy.ESAPI.Executor.ApprovedExecutablesList of approved executable files.

RSproxy ESAPI HTTPUtilities

Property NameDefault Value
rsproxy.ESAPI.HTTPUtilitiesClass used for securing http requests,responses,sessions, cookies, headers, and logging.
rsproxy.ESAPI.HttpUtilities.UploadDirDirectory for files upload.
rsproxy.ESAPI.HttpUtilities.UploadTempDirDirectory for temporary files upload.
rsproxy.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rsproxy.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rsproxy.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rsproxy.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rsproxy.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rsproxy.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rsproxy.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rsproxy.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and its character encoding.
rsproxy.ESAPI.HttpUtilities.HttpSessionIdNameName of the http session.

RSproxy ESAPI Intrusion Detector

Property NameDefault Value
rsproxy.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rsproxy.ESAPI.IntrusionDetectorClass used for intrusion detection.
rsproxy.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rsproxy.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rsproxy.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rsproxy.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.

RSproxy ESAPI Logger

Property NameDefault Value
rsproxy.ESAPI.LoggerLogger factory used to create a logger.
rsproxy.ESAPI.Logger.ApplicationNameName of the application being logged for.
rsproxy.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name.
rsproxy.ESAPI.Logger.LogEncodingRequiredSet to 'true' to require log data to be encoded.
rsproxy.ESAPI.Logger.LogFileNameName of file to log into.
rsproxy.ESAPI.Logger.MaxLogFileSizeMax log file size.
rsproxy.ESAPI.Logger.LogServerIPLog the server ip when logging.

RSproxy ESAPI printProperties

Property NameDefault Value
rsproxy.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded.

RSproxy ESAPI Randomizer

Property NameDefault Value
rsproxy.ESAPI.RandomizerClass used for creating random numbers.

RSproxy ESAPI

Property NameDefault Value
rsproxy.ESAPI.ValidatorClass used for validation.
rsproxy.ESAPI.Validator.AcceptLenientDatesSet to 'true' to accept lenient dates.
rsproxy.ESAPI.Validator.AccountNameregex for allowed chracters and length for an account name
rsproxy.ESAPI.Validator.ConfigurationFileName of the config file for validation.
rsproxy.ESAPI.Validator.DirectoryNameregex for a valid directory name
rsproxy.ESAPI.Validator.FileNameregex for a valid file name
rsproxy.ESAPI.Validator.HTTPContextPathregex for a valid http context path
rsproxy.ESAPI.Validator.HTTPCookieNameregex for a valid cookie name
rsproxy.ESAPI.Validator.HTTPCookieValueregex for a valid cookie value
rsproxy.ESAPI.Validator.HTTPHeaderNameregex for a valid http header name
rsproxy.ESAPI.Validator.HTTPHeaderValueregex for a valid http header value
rsproxy.ESAPI.Validator.HTTPJSESSIONIDregex for a valid http JSESSIONID
rsproxy.ESAPI.Validator.HTTPParameterNameregex for a valid http parameter name
rsproxy.ESAPI.Validator.HTTPParameterValueregex for a valid http parameter value
rsproxy.ESAPI.Validator.HTTPPathregex for a valid http path
rsproxy.ESAPI.Validator.HTTPQueryStringregex for a valid http query string
rsproxy.ESAPI.Validator.HTTPServletPathregex for a valid http servlet path
rsproxy.ESAPI.Validator.HTTPSchemeregex for a valid http scheme
rsproxy.ESAPI.Validator.HTTPServerNameregex for a valid http server name
rsproxy.ESAPI.Validator.HTTPURIregex for a valid http uri
rsproxy.ESAPI.Validator.HTTPURLregex for a valid http url
rsproxy.ESAPI.Validator.Redirectregex for a valid redirect
rsproxy.ESAPI.Validator.RoleNameregex for a valid rolename
rsproxy.ESAPI.Validator.SystemCommandregex for a valid System Command

RSremote ESAPI Access Control

Property NameDefault Value
rsremote.ESAPI.AccessControlClass used for access control.

RSremote ESAPI Authentification

Property NameDefault Value
rsremote.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rsremote.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attemps.
rsremote.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rsremote.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator.
rsremote.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rsremote.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rsremote.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before time out.
rsremote.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token is times out.

RSremote ESAPI Authentification

Property NameDefault Value
rsremote.ESAPI.EncoderClass used for encoding.
rsremote.ESAPI.Encoder.AllowMultipleEncodingSet to 'true' to allow multiple encoding.
rsremote.ESAPI.Encoder.DefaultCodecListList of encoders used by default.

RSremote ESAPI Encryptor

Property NameDefault Value
rsremote.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider.
rsremote.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rsremote.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rsremote.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rsremote.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rsremote.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsremote.ESAPI.EncryptorClass used for encryption.
rsremote.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rsremote.ESAPI.Encryptor.fixedIVInitialization vector to use if fixed IV method is chosen.
rsremote.ESAPI.Encryptor.CipherText.useMACIf 'true' compute and store the MAC.
rsremote.ESAPI.Encryptor.PlainText.overwriteFirst overwrite the bytes of plaintext with the character.
rsremote.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rsremote.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rsremote.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature.
rsremote.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsremote.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rsremote.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rsremote.ESAPI.Encryptor.KDF.PRFPsuedo random function used in KDF.

RSproxy ESAPI Executor

Property NameDefault Value
rsremote.ESAPI.ExecutorClass used to execute os commands.
rsremote.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed
rsremote.ESAPI.Executor.ApprovedExecutablesList of approved executable files.

RSproxy ESAPI

Property NameDefault Value
rsremote.ESAPI.HTTPUtilitiesClass used for securing http requests, responses, sessions, cookies, headers, and logging.
rsremote.ESAPI.HttpUtilities.UploadDirDirectory for files upload.
rsremote.ESAPI.HttpUtilities.UploadTempDirDirectory for temporary files upload.
rsremote.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rsremote.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rsremote.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rsremote.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rsremote.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rsremote.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rsremote.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rsremote.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and its character encoding.
rsremote.ESAPI.HttpUtilities.HttpSessionIdNameName of the http session.

RSproxy ESAPI Intrusion

Property NameDefault Value
rsremote.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rsremote.ESAPI.IntrusionDetectorClass used for intrusion detection.
rsremote.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rsremote.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rsremote.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rsremote.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.
rsremote.ESAPI.LoggerLogger factory used to create a logger.
rsremote.ESAPI.Logger.ApplicationNameName of the application being logged for.
rsremote.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name.
rsremote.ESAPI.Logger.LogEncodingRequiredSet to 'true' to require log data to be encoded.
rsremote.ESAPI.Logger.LogFileNameName of file to log into.
rsremote.ESAPI.Logger.MaxLogFileSizeMax log file size.
rsremote.ESAPI.Logger.LogServerIPLog the server ip when logging.

RSproxy ESAPI printProperties

Property NameDefault Value
rsremote.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded.

RSproxy ESAPI Randomizer

Property NameDefault Value
rsremote.ESAPI.RandomizerClass used for creating random numbers

RSproxy ESAPI Validators

Property NameDefault Value
rsremote.ESAPI.ValidatorClass used for validation.
rsremote.ESAPI.Validator.AcceptLenientDatesSet to 'true' to accept lenient dates.
rsremote.ESAPI.Validator.AccountNameregex for allowed chracters and length for an account name
rsremote.ESAPI.Validator.ConfigurationFileName of the config file for validation.
rsremote.ESAPI.Validator.DirectoryNameregex for a valid directory name
rsremote.ESAPI.Validator.FileNameregex for a valid file name
rsremote.ESAPI.Validator.HTTPContextPathregex for a valid http context path
rsremote.ESAPI.Validator.HTTPCookieNameregex for a valid cookie name
rsremote.ESAPI.Validator.HTTPCookieValueregex for a valid cookie value
rsremote.ESAPI.Validator.HTTPHeaderNameregex for a valid http header name
rsremote.ESAPI.Validator.HTTPHeaderValueregex for a valid http header value
rsremote.ESAPI.Validator.HTTPJSESSIONIDregex for a valid http JSESSIONID
rsremote.ESAPI.Validator.HTTPParameterNameregex for a valid http parameter name
rsremote.ESAPI.Validator.HTTPParameterValueregex for a valid http parameter value
rsremote.ESAPI.Validator.HTTPPathregex for a valid http path
rsremote.ESAPI.Validator.HTTPQueryStringregex for a valid http query string
rsremote.ESAPI.Validator.HTTPServletPathregex for a valid http servlet path
rsremote.ESAPI.Validator.HTTPSchemeregex for a valid http scheme
rsremote.ESAPI.Validator.HTTPServerNameregex for a valid http server name
rsremote.ESAPI.Validator.HTTPURIregex for a valid http uri
rsremote.ESAPI.Validator.HTTPURLregex for a valid http url
rsremote.ESAPI.Validator.Redirectregex for a valid redirect
rsremote.ESAPI.Validator.RoleNameregex for a valid rolename
rsremote.ESAPI.Validator.SystemCommandregex for a valid System Command

RSsync ESAPI Access Control

Property NameDefault Value
rssync.ESAPI.AccessControlClass used for access control.

RSsync ESAPI Authenticator

Property NameDefault Value
rssync.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rssync.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attempts.
rssync.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rssync.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator.
rssync.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rssync.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rssync.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before timeout.
rssync.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token times out.

RSsync ESAPI Enco

Property NameDefault Value
rssync.ESAPI.EncoderClass used for encoding.
rssync.ESAPI.Encoder.AllowMultipleEncodingSet to 'true' to allow multiple encoding.
rssync.ESAPI.Encoder.DefaultCodecListList of encoders used by default.

RSsync ESAPI Encryptor

Property NameDefault Value
rssync.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider.
rssync.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rssync.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rssync.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rssync.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rssync.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rssync.ESAPI.EncryptorClass used for encryption.
rssync.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rssync.ESAPI.Encryptor.fixedIVInitialization vector to use if fixed IV method is chosen
rssync.ESAPI.Encryptor.CipherText.useMACIf 'true 'compute and store the MAC.
rssync.ESAPI.Encryptor.PlainText.overwriteFirst overwrite the bytes of plaintext with the character.
rssync.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rssync.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rssync.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature
rssync.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rssync.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rssync.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rssync.ESAPI.Encryptor.KDF.PRFPsuedo random function used in KDF.

RSsync ESAPI Executor

Property NameDefault Value
rssync.ESAPI.ExecutorClass used to execute os commands.
rssync.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed.
rssync.ESAPI.Executor.ApprovedExecutablesList of approved executable files.

RSsync ESAPI HTTPUtilities

Property NameDefault Value
rssync.ESAPI.HTTPUtilitiesClass used for securing http requests, responses, sessions, cookies, headers, and logging.
rssync.ESAPI.HttpUtilities.UploadDirDirectory for files upload.
rssync.ESAPI.HttpUtilities.UploadTempDirDirectory for temporary files upload.
rssync.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rssync.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rssync.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rssync.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rssync.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rssync.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rssync.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rssync.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and its character encoding.
rssync.ESAPI.HttpUtilities.HttpSessionIdNameName of the http session.

RSsync ESAPI Intrusion Detector

Property NameDefault Value
rssync.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rssync.ESAPI.IntrusionDetectorCClass used for intrusion detection.
rssync.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rssync.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rssync.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rssync.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.

RSsync ESAPI Logger

Property NameDefault Value
rssync.ESAPI.LoggerLogger factory used to create a logger.
rssync.ESAPI.Logger.ApplicationNameName of the application being logged for.
rssync.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name.
rssync.ESAPI.Logger.LogEncodingRequiredSet to 'true' to require log data to be encoded.
rssync.ESAPI.Logger.LogFileNameName of file to log into.
rssync.ESAPI.Logger.MaxLogFileSizeMax log file size.
rssync.ESAPI.Logger.LogServerIPLog the server IP when logging.

RSsync ESAPI printProperties

Property NameDefault Value
rssync.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded.

RSsync ESAPI Randomizer

Property NameDefault Value
rssync.ESAPI.RandomizerClass used for creating random numbers.

RSsync ESAPI Validator

Property NameDefault Value
rssync.ESAPI.ValidatorClass used for validation.
rssync.ESAPI.Validator.AcceptLenientDatesSet to 'true' to accept lenient dates'
rssync.ESAPI.Validator.AccountNameregex for allowed chracters and length for an account name
rssync.ESAPI.Validator.ConfigurationFileName of the config file for validation'
rssync.ESAPI.Validator.DirectoryNameregex for a valid directory name
rssync.ESAPI.Validator.FileNameregex for a valid file name
rssync.ESAPI.Validator.HTTPContextPathregex for a valid http context path
rssync.ESAPI.Validator.HTTPCookieNameregex for a valid cookie name
rssync.ESAPI.Validator.HTTPCookieValueregex for a valid cookie value
rssync.ESAPI.Validator.HTTPHeaderNameregex for a valid http header name
rssync.ESAPI.Validator.HTTPHeaderValueregex for a valid http header value
rssync.ESAPI.Validator.HTTPJSESSIONIDregex for a valid http JSESSIONID
rssync.ESAPI.Validator.HTTPParameterNameregex for a valid http parameter name
rssync.ESAPI.Validator.HTTPParameterValueregex for a valid http parameter value
rssync.ESAPI.Validator.HTTPPathregex for a valid http path
rssync.ESAPI.Validator.HTTPQueryStringregex for a valid http query string
rssync.ESAPI.Validator.HTTPServletPathregex for a valid http servlet path
rssync.ESAPI.Validator.HTTPSchemeregex for a valid http scheme
rssync.ESAPI.Validator.HTTPServerNameregex for a valid http server name
rssync.ESAPI.Validator.HTTPURIregex for a valid http uri
rssync.ESAPI.Validator.HTTPURLregex for a valid http url
rssync.ESAPI.Validator.Redirectregex for a valid redirect
rssync.ESAPI.Validator.RoleNameregex for a valid rolename
rssync.ESAPI.Validator.SystemCommandregex for a valid System Command

RSview ESAPI Access Contro

Property NameDefault Value
rsview.ESAPI.AccessControlClass used for access control.

RSview ESAPI Authentification

Property NameDefault Value
rsview.ESAPI.AuthenticatorClass used for ESAPI authenticator.
rsview.ESAPI.Authenticator.AllowedLoginAttemptsMaximum allowed login attempts.
rsview.ESAPI.Authenticator.MaxOldPasswordHashesMaximum amount of old password hashes allowed.
rsview.ESAPI.Authenticator.UsernameParameterNameParameter name for the username in the ESAPI authenticator.
rsview.ESAPI.Authenticator.PasswordParameterNameParameter name for the password in the ESAPI authenticator.
rsview.ESAPI.Authenticator.RememberTokenDurationPeriod of time to remember an authentication token.
rsview.ESAPI.Authenticator.IdleTimeoutDurationPeriod of time a user can be idle before time out.
rsview.ESAPI.Authenticator.AbsoluteTimeoutDurationPeriod of time until a token times out.

RSview ESAPI Encoder

Property NameDefault Value
rsview.ESAPI.EncoderClass used for encoding.
rsview.ESAPI.Encoder.AllowMultipleEncodingSet to 'true' to allow multiple encoding.
rsview.ESAPI.Encoder.DefaultCodecListList of encoders used by default.

RSview ESAPI Encryptor

Property NameDefault Value
rsview.ESAPI.Encryptor.PreferredJCEProviderPreferred JCEProvider.
rsview.ESAPI.Encryptor.EncryptionAlgorithmEncryption algorithmn used.
rsview.ESAPI.Encryptor.CipherTransformationCipher transformation used to encrypt.
rsview.ESAPI.Encryptor.cipher_modes.combined_modesModes that support confidentiality and authenticity.
rsview.ESAPI.Encryptor.cipher_modes.additional_allowedCiphers allowed in addition to the ones in combined_modes.
rsview.ESAPI.Encryptor.EncryptionKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsview.ESAPI.EncryptorClass used for encryption.
rsview.ESAPI.Encryptor.ChooseIVMethodMethod of generating initialization vector.
rsview.ESAPI.Encryptor.fixedIVInitialization vector to use if fixed IV method is chosen.
rsview.ESAPI.Encryptor.CipherText.useMACIf 'true' compute and store the MAC.
rsview.ESAPI.Encryptor.PlainText.overwriteFirst overwrite teh bytes of plaintext with the character.
rsview.ESAPI.Encryptor.HashAlgorithmAlgorithm used to generate the encryption hash.
rsview.ESAPI.Encryptor.HashIterationsNumber of steps to take when hashing.
rsview.ESAPI.Encryptor.DigitalSignatureAlgorithmAlgorithm used to generate a digital signature.
rsview.ESAPI.Encryptor.DigitalSignatureKeyLengthThe number of bits in a key used by a cryptographic algorithm.
rsview.ESAPI.Encryptor.RandomAlgorithmAlgorithm used to generate a random number.
rsview.ESAPI.Encryptor.CharacterEncodingCharacter encoding used.
rsview.ESAPI.Encryptor.KDF.PRFPsuedo random function used in KDF.

RSview ESAPI Executor

Property NameDefault Value
rsview.ESAPI.ExecutorClass used to execute os commands.
rsview.ESAPI.Executor.WorkingDirectoryDirectory in which commands are executed.
rsview.ESAPI.Executor.ApprovedExecutablesLis of approved executable files.

RSview ESAPI HTTPUtilities

Property NameDefault Value
rsview.ESAPI.HTTPUtilitiesClass used for securing http requests, responses, sessions, cookies, headers, and logging.
rsview.ESAPI.HttpUtilities.UploadDirDirectory to uploaded files.
rsview.ESAPI.HttpUtilities.UploadTempDirDirectory to upload temporary files.
rsview.ESAPI.HttpUtilities.ForceHttpOnlySessionSet to 'true' to force the http only flag be set on the session.
rsview.ESAPI.HttpUtilities.ForceSecureSessionSet to 'true' to force the secure session only flag to be set the session.
rsview.ESAPI.HttpUtilities.ForceHttpOnlyCookiesSet to 'true' to force the http only flag to be set on cookies.
rsview.ESAPI.HttpUtilities.ForceSecureCookiesSet to 'true' to force the secure only flag to be set on cookies.
rsview.ESAPI.HttpUtilities.MaxHeaderSizeMaximum size of header.
rsview.ESAPI.HttpUtilities.ApprovedUploadExtensionsExtensions allowed for upload.
rsview.ESAPI.HttpUtilities.MaxUploadFileBytesMaximum upload size for a file in bytes.
rsview.ESAPI.HttpUtilities.ResponseContentTypeThe content type of the response and its character encoding.
rsview.ESAPI.HttpUtilities.HttpSessionIdNameName of the http session.
rsview.ESAPI.IntrusionDetector.DisableSet to 'true' to disable intrusion detection.
rsview.ESAPI.IntrusionDetectorClass used for intrusion detection.
rsview.ESAPI.IntrusionDetector.event.test.actionsAction to take if an intrusionexception fires.
rsview.ESAPI.IntrusionDetector.event.test.countFire off intrusion exception if count events are received within an interval.
rsview.ESAPI.IntrusionDetector.event.test.intervalInterval in which count actions are allowed.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actionsAction to take if an integrityException fires.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.countFire off IntegrityException if count events are received within an interval.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.intervalInterval in which count actions are allowed.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actionsAction to take if an IntrusionException fires.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.countFire off intrusion exception if count events are received within an interval.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.intervalInterval in which count actions are allowed.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.countFire off AuthenticationHostException if count events are received within an interval.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.intervalInterval in which count actions are allowed.
rsview.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actionsAction to take if an AuthenticationHostException fires.

RSview ESAPI Logger

Property NameDefault Value
rsview.ESAPI.LoggerLogger factory used to create a logger.
rsview.ESAPI.Logger.ApplicationNameName of the application being logged for.
rsview.ESAPI.Logger.LogApplicationNameDetermines whether ESAPI should log the application name.
rsview.ESAPI.Logger.LogEncodingRequiredSet to 'true' to require log data to be encoded.
rsview.ESAPI.Logger.LogFileNameName of file to log into.
rsview.ESAPI.Logger.MaxLogFileSizeMax log file size.
rsview.ESAPI.Logger.LogServerIPLog the server ip when logging.

RSview ESAPI printProperties

Property NameDefault Value
rsview.ESAPI.printPropertiesIf 'true' print all ESAPI properties when loaded.

RSview ESAPI Randomizer

Property NameDefault Value
rsview.ESAPI.RandomizerClass used for creating random numbers.

RSview ESAPI Validator

Property NameDefault Value
rsview.ESAPI.ValidatorClass used for validation.
rsview.ESAPI.Validator.AcceptLenientDatesSet to 'true' to accept lenient dates.
rsview.ESAPI.Validator.AccountNameregex for allowed chracters and length for an account name
rsview.ESAPI.Validator.ConfigurationFileName of the config file for validation.
rsview.ESAPI.Validator.DirectoryNameregex for a valid directory name
rsview.ESAPI.Validator.FileNameregex for a valid file name
rsview.ESAPI.Validator.HTTPContextPathregex for a valid http context path
rsview.ESAPI.Validator.HTTPCookieNameregex for a valid cookie name
rsview.ESAPI.Validator.HTTPCookieValueregex for a valid cookie value
rsview.ESAPI.Validator.HTTPHeaderNameregex for a valid http header name
rsview.ESAPI.Validator.HTTPHeaderValueregex for a valid http header value
rsview.ESAPI.Validator.HTTPJSESSIONIDregex for a valid http JSESSIONID
rsview.ESAPI.Validator.HTTPParameterNameregex for a valid http parameter name
rsview.ESAPI.Validator.HTTPParameterValueregex for a valid http parameter value
rsview.ESAPI.Validator.HTTPPathregex for a valid http path
rsview.ESAPI.Validator.HTTPQueryStringregex for a valid http query string
rsview.ESAPI.Validator.HTTPServletPathregex for a valid http servlet path
rsview.ESAPI.Validator.HTTPSchemeregex for a valid http scheme
rsview.ESAPI.Validator.HTTPServerNameregex for a valid http server name
rsview.ESAPI.Validator.HTTPURIregex for a valid http uri
rsview.ESAPI.Validator.HTTPURLregex for a valid http url
rsview.ESAPI.Validator.Redirectregex for a valid redirect
rsview.ESAPI.Validator.RoleNameregex for a valid rolename
rsview.ESAPI.Validator.SystemCommandregex for a valid System Command

Groovy Sandboxing Parameters

Detailed usage description and configurations steps to be found in Security Considerations.

Property NameDescriptionDefault value
rscontrol.groovy.sandbox.enableWhen set to true it is enabledfalse
rscontrol.groovy.sandbox.location{DIST}/rscontrol/config
rsremote.groovy.sandbox.enableWhen set to true it is enabledfalse
rsremote.groovy.sandbox.location{DIST}/rsremote/config
rsview.groovy.sandbox.enableWhen set to true it is enabledfalse
rsview.groovy.sandbox.location{DIST}/tomcat/webapps/resolve/WEB-INF
rsconsole.groovy.sandbox.enableWhen set to true it is enabledfalse
rsconsole.groovy.sandbox.location{DIST}/rsconsole/config
rsmgmt.groovy.sandbox.enableWhen set to true it is enabledfalse
rsmgmt.groovy.sandbox.location{DIST}/rsmgmt/config
rssync.groovy.sandbox.enableWhen set to true it is enabledfalse
rssync.groovy.sandbox.location{DIST}/rssync/config
rsarchive.groovy.sandbox.enableWhen set to true it is enabledfalse
rsarchive.groovy.sandbox.location{DIST}/rsarchive/config

Persistent Connections and the SESSIONS Object

Most data can be transferred from the RSRemote back to the RSControl. INPUTS can be used to move lists, maps, or other non-string objects between the Content and the Assessor. However, connections and other non-serializable objects cannot be moved between components. Actions Pro provides a SESSIONS object that allows an object to be "saved" or "persisted" on an RSRemote. Follwoing tasks that need to access this object will be executed on that RSRemote.

Persisting a Connection

The SESSIONS object is employed to retain an open connection (a "session") that is used by multiple tasks. This way is evaded the need to open and close the
connection in each task, and improves modularity and reusability of Action Tasks. The workflow for persisting a connection is:

  1. Open a connection and save it to SESSIONS
  2. Execute commands using saved connection.
  3. Close the connection and clear the SESSIONS.

The SESSIONS binding is only available during automation execution. If you try to execute a task using SESSIONS outside of a Runbook (for example, while testing), then an exception will be thrown. Also, note that SESSIONS is a reserved variable name. The mechanics for persisting a connection are:

  1. Place an object (named "conn" in this example) into SESSIONS using the following SESSIONS.put() code. The object is kept in memory on the JVM and sets a session affinity for that RSRemote.
    SESSIONS.put(conn);
  2. Later tasks using the SESSIONS object will execute on the same RSRemote. Retrieve the object using SESSIONS.get(). The affinity is stored in FLOWS. SESSIONS are unique to an execution path, and may no longer be available after a merge. If not working correctly, check FLOWS values in rscontrol.log.
    Def conn = SESSIONS.get();
  3. When you are finished, remove the affinity with SESSIONS.remove():
    SESSIONS.remove()

Other Uses

The use of the SESSIONS object is not restricted to Actions Pro Connectors. It can be used with other Groovy objects that are not serializable. Web and database connections are good candidates, although using SESSIONS witch HTMLUnit, depending on the target page, can sometimes cause errors.

The SESSIONS object can also be used in cases where an object does not need to be persisted, but tasks need to be executed on the same RSRemote. Such situations may occur when the task needs to access a particular file on the file system.

To establish a session affinity without an object, call:

SESSIONS.setAffinity();

Note that only tasks that contain the string "SESSIONS" will use the affinity, so be sure to add the string in a comment.

//SESSIONS

Always remember to clear the session when affinity is no longer needed. Also remember that the SESSIONS object, since it is maintained using FLOWS, mightnotpersist after a merge.