Configuration of ProtonWS
ProtonWS is a web application that interacts directly with the analytical engine. This component publishes the web services that provide access and perform repository management.
After installing the ProtonWS application, the administrator can access the configuration.xml file in the following folder in a default Windows installation to change the configuration:
C:\Program Files (x86)\Apache Software Foundation\Tomcat 7.0\webapps\protonws\WEB-INF\settings
In a Linux installation, the default location for the configuration.xml file is the following folder:
/usr/share/tomcat6/webapps/protonws/WEB-INF/settings
Listing 2‑1 shows the default code for the Windows version of configuration.xml.
Listing 2‑1 ProtonWS configuration.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<cacheFolder>
C:\\Program Files\\Actuate\\BIRTAnalytics\\Proton\\CacheFolder
</cacheFolder>
<importFolder>
C:\\Program Files\\Actuate\BIRTAnalytics\\Proton\\ImportFolder
</importFolder>
<exportFolder>
C:\\Program Files\\Actuate\BIRTAnalytics\\Proton\\ExportFolder
</exportFolder>
<iWorkflowFolder>
C:\\Program Files\\Actuate\\BIRTAnalytics\\Proton
\\iworkflowfolder
</iWorkflowFolder>
<IporName>127.0.0.1</IporName>
<port>8105</port>
<sslPort>5555</sslPort>
<ignoreDangerous>false</ignoreDangerous>
<secure>false</secure>
<maxConnection>5</maxConnection>
<maxPoolEntries>5</maxPoolEntries>
<maxPageSizeReadingTransactionsForAssociationRuleAnalysis>
10000
</maxPageSizeReadingTransactionsForAssociationRuleAnalysis>
<maxTransactionsAllowedForAssociationRuleAnalysis>
10000000
</maxTransactionsAllowedForAssociationRuleAnalysis>
<maxItemsAllowedForAssociationRuleAnalysis>
10000000
</maxItemsAllowedForAssociationRuleAnalysis>
<maxRulesAllowedForAssociationRuleAnalysis>
1000
</maxRulesAllowedForAssociationRuleAnalysis>
<campaignWorkflowRetryWaitTimeInSeconds>
20
</campaignWorkflowRetryWaitTimeInSeconds>
<campaignWorkflowRetryMaxAttempts>3</campaignWorkflowRetryMaxAttempts>
</configuration>
Table 2‑1 lists the ProtonWS configuration.xml parameters shown in the code listing and describes their function.
Table 2‑1 ProtonWS configuration.xml parameters
Parameter
Description
cacheFolder
Location of the folder used temporarily by the application to cache data during a data retrieval process. The user running the process must have permission to write to this location.
importFolder
Location of the folder used temporarily by the application during an import process. The user running the process must have permission to write to this location.
exportFolder
Location of the folder used temporarily by the application during an export process. The user running the process must have permission to write to this location.
iWorkflowFolder
Location of the folder used temporarily by the application for workflow processing. The user running the process must have permission to write to this location.
IporName
Internet Protocol (IP) address or logical name of the analytical engine process, which by default is localhost or 127.0.0.1.
port
Port where the analytical engine listens, which by default is 8105.
sslPort
Secure Sockets Layer (SSL) port where the analytical engine listens, which by default is 8106.
ignoreDangerous
Ignore SSL errors. Specify true or false. Default is false.
secure
Use Secure Sockets Layer (SSL) security to access the analytical engine. Specify true or false. Default is false.
user
Administrator username for establishing a connection to the analytical engine.
pwd
Administrator password for establishing a connection to the analytical engine.
maxConnection
Maximum number of active connections by an application to the analytical engine. An open connection to the engine is not considered in use until the application initiates an action.
maxPoolEntries
Maximum connections that an application can keep open to the analytical engine. This value can be the same or more than the connections specified by maxConnection and the same or less than the number of connections accepted by the analytical engine.
maxPageSizeReading
TransactionsForAssociation
RuleAnalysis
Maximum pages for reading transactions in association rule analysis that an application can keep open to the analytical engine. Default is 10000.
maxTransactionsAllowed
ForAssociationRule
Analysis
Maximum transactions allowed for association rule analysis that an application can keep open to the analytical engine. Default is 10000000.
maxItemsAllowedFor
AssociationRuleAnalysis
Maximum items allowed for association rule analysis that an application can keep open to the analytical engine. Default is 10000000.
maxRulesAllowedFor
AssociationRuleAnalysis
Maximum rules allowed for association rule analysis that an application can keep open to the analytical engine. Default is 1000.
campaignWorkflowRetry
WaitTimeInSeconds
The amount of time that ProtonWS waits before trying again to append records to the campaign history or response table in the event a lock exists on the table.
campaignWorkflowRetry
MaxAttempts
Maximum number of times that ProtonWS can try to append records to the campaign history or response table in the event a lock exists on the table. If the lock is not released after the maximum retries occurs, then an exception is thrown advising the user to try again later.