Cycle Web Properties

Properties Mandatory Data Type Format Size Default Allowed Values Description

application.buildversion

   NUMBER nn.nn.nn.nn 11  

 

Defines the build version of the application on the login screen

application.databaseType

 YES Alphabetic Fixed List <=10  

Value:

SqlServer, Oracle, DB2

The system-wide default database type. Used for multiple query support functionality and JDBC interaction.

application.default.buildversion

   NUMBER nn.nn.nn.nn 11  

 

Only used if the property, application build version, is set and begins with ${.

Defines the build version of the application on the login screen.

application.defaultCurrencyCode

 YES        

Value :

https://www.currency-iso.org/en/home/tables.html

The default currency should be added as a CurrencyCode in the AsCurrency table.

application.enablePlanGroup

   Boolean   2 No

Value:

No

If included, should be set to No.

application.enablePostAssignmentValidation

   Boolean   <=3 No

Value:

Yes, No

Determines whether or not to execute the PostAssignmentValidateExpressions business rule during activity processing.

application.enableProduct

   Boolean   <=3 No

Optional Value:

Yes, No

Allows application to use the Products hierarchy in configuration.

System default is No.

application.mathApplicationCallbackBll

 YES AlphaNumeric Java Class FQN <=255  

Value:

com.adminserver.pas.bll.PasCallBackBll

Warning:

Internal PAS property. Class used to carry DataRetriever and RateRetriever to be used by the Math engine.

application.mode

 YES Alphabetic Fixed List <=15  

Value:

DEVELOPMENT, PRODUCTION

Development mode is where configuration changes are allowed. Configuration data is not cached. Production mode is where configuration change is a new release and JVM is restarted when it is changed. Configuration data is cached.

application.refreshMasks

   Positive Integer nnnnnn <=6 0

 

Note: For use in application.mode = DEVELOPMENT

Time in milliseconds to refresh mask configuration Value <= 0 will never refresh.

application.resourceCacheTimeout

   Integer +/-nnnnn <=6 -1

 

Time to cache translations, in minutes, before checking data source for updates. For value < 0, never check for updates. For value = 0, always check for updates. For value > 0, check for updates after specified minutes have passed.

Warning:

Should be set to -1 in a Production environment.

database.nlscomp

   Alphabetic Fixed List <=15 LINGUISTIC

Info:

Refer to https://docs.oracle.com for the version of Oracle used for a current listing of values you can specify for this parameter.

 

It applies when the system is using the Oracle database.

It provides the NLS_COMP setting that the system should use in the database session in order to perform Case/Accent insensitive search.

Default value if not specified is LINGUISTIC.

The DBA should setup appropriate indexes for this property and suggest the setting value to use based on the client installation's language preference.

database.nlssort

   Alphabetic Fixed List <=25 BINARY_CI

Info:

Refer to Database Globalization Support Guide and other related documents at https://docs.oracle.com or a current listing of values you can specify for this parameter

It applies when the system is using the Oracle database.

It provides the NLS_SORT setting that the system should use in the database session in order to perform Case/Accent insensitive search.

Default value if not specified is BINARY_CI.

The DBA should setup appropriate indexes for these properties and suggest the setting value to use based on the client installation's language preference.

dataIntake.enabled

 YES Boolean   <=5  

Value:

true or false

Determines whether or not data intake background process for processing data intake files should be created.

dataIntake.gridCapacity

   Positive Integer nnnn <=4 500

 

Maximum number of record groups that can be processing simultaneously in the grid for DataIntake processing.

Note: Currently this property value is not used by the system.

dataIntake.recordGroupSize

   Positive Integer nnnnn <=5 10

 

The number of individual intake records to bundle together for processing as a single task in the grid for DataIntake processing.

dataIntake.userName

 YES AlphaNumeric   <=255  

 

The primary company used for processing data intake related rules and transactions is the primary company of this user.

datasource.type

 YES Alphabetic   4  

Value:

jndi

The data source type. jndi relies on jndi names ADMINSERVERDS, ADMINSERVERRESOURCEDS ADMINSERVERSEARCHDS and ADMINSERVERREADONLYDS in the application server for a datasource connection..

debug.identifyTranslator

   Boolean   <=3 No

Value:

Yes, No

Writes comments for every line identifying the translator (line number) that generated that part of code. debug.SaveGeneratedClass needs to be set to Yes.

Note: Only use in a Non-Production environment.

debug.SaveGeneratedClass

   Boolean   <=3 No

Value:

Yes, No

Generated source code while processing will be saved in the directory specified.

Note: Only use in a Non-Production environment.

debug.SaveGeneratedClassDirectory

   AlphaNumeric File Path <=255  

 

Directory where the generated source code should be saved.debug.SaveGeneratedClass needs to be set to Yes.

Note: Only use in a Non-Production environment.

document.crystalConnectionCount

   Positive Integer nnnn <=4  

 

Only valid for generating Crystal documents. Sets allowable connections. Should be set to a number not greater than the number of CR licenses.

document.documentGeneratorUrl

   AlphaNumeric URL <=255  

 

The url for the DocumentGenerator webservice url for generating documents.

document.documentPath

   AlphaNumeric File Path <=255  

 

Directory where report templates are stored.

document.generatedDocumentRootPath

   AlphaNumeric File Path <=255  

 

Directory where generated documents are saved.

entityLock.enabled

   Boolean   <=3 No

Value:

Yes, No

Determines whether or not business entities should be locked while processing activities in sequence during DataIntake.

System Default is No

entityLock.timeout

   Positive Integer nnnnnnnn <=8 500

 

Time in milliseconds to wait before trying to reacquire lock on a business entity.

entityLock.tryCount

   Positive Integer nn <=2 5

 

Number of attempts made to acquire a lock

extensions.config

   AlphaNumeric File Path <=255  

 

Directory where extensions.xml for extension configuration is stored.

grid.taskSubmissionThreadPoolSize

 YES Positive Integer nnnnn <=5  

 

The number of threads dedicated to submit tasks to the grid for processing. Increasing this number can speed up how quickly tasks are distributed to the grid.

See cycle documentation for additional details.

jndi.connectionFactoryName

 YES AlphaNumeric   <=50    

ConnectionFactory JNDI name to connect JMS server.

Recommended Value: IntakeConnectionFactory.

See Data Intake document for additional details.

jndi.queueName

 YES AlphaNumeric   <=50  

 

Queue JNDI name to send message to JMS server destination. Recommended Value: DIQueue.

See Data Intake document for additional details.

jpa.databasePlatform

 YES Alphabetic Fixed List <=255  

Value:

org.eclipse.persistence.platform.database.SQLServerPlatform org.eclipse.persistence.platform.database.OraclePlatform org.eclipse.persistence.platform.database.DB2Platform

Property that determines which JPA DatabasePlatform to use with EclipseLink.

jpa.showSql

   Boolean   <=5 False

Optional Value:

True, False

Shows information in the application's log/console for all SQLs executed using JPA.

Warning:

Only use in a Non-Production environment.

NamedStoredProceduresRateBll.config.filePath

   AlphaNumeric File Path <=255  

 

XML file that specifies the stored procedure to be execute for specific rate groups. If using this, leave rateRetriever.className blank.

rateRetriever.className

   AlphaNumeric Java Class FQN <=255  

 

Fully qualified extension class name to retrieve rates for all rate groups. If using this, leave NamedStoredProceduresRateBll.config.filePath blank.

scheduledValuation.batchSize

 YES Positive Integer nnnnnn <=6  

 

This is the batch size for processing scheduled valuation.

See cycle documentation for additional details.

scheduledValuation.period

 YES Positive Integer nnnnn <=5  

 

This is the number of seconds that the scheduled valuation monitor task will sleep before waking up and checking on the status of queued tasks.

See cycle documentation for additional details.

scheduledValuation.groupSize

 YES Positive Integer nnnnn <=5  

 

Determines the number of Scheduled valuation items to group together and execute on a single thread in the cluster.

search.field.text.caseInsensitive

   Boolean   <=5 False

 

Info:

For use when the system is running on the DB2 database platform.

Search screens have the ability to perform their search in a case insensitive manner. A value of True makes the system use case insensitive searches. .

transaction.manager

 YES Alphabetic Fixed 3  

Value:

jpa

Data source transaction manager.

webservice.allowHashedPassword

   Boolean   <=3 No

Value:

Yes, No.

Determines if web services can be invoked with hashed passwords.

System Default is No.

workManagerName

 YES AlphNumeric   <=50  

 

A Work Manager defines a set of request classes and thread constraints that manage work performed by Server instances

Recommended Value: wm/default.

See Data Intake document for additional details.

WriteValuationXML

   Boolean   <=3 Yes

Value:

Yes, No

Determines whether or not to write valuation XML to the AsValuationXml table for activities that run valuation.

System Default is Yes.

application.enableProduct

   Boolean   <=3 No

Value:

Yes, No

Allows application to use the Products hierarchy in configuration.

System default is No.

application.configurationCacheTimeout

   Positive Integer nnnnn <=5  

 

Time to cache business rules, in minutes, before checking data source for updates.

For value = 0, never check for updates.

For value > 0, check for updates after specified minutes have passed.

application.encryptDecryptFilePath

 YES AlphaNumeric File Path <=255  

Required Value:

Text (AbsolutePath With File Name)

Value of this property should be absolute path with file name, where EDKeyValue.dat exists.

This .dat file holds the partial Encrypt/Decrypt Key for encryption/decryption of the data.

This file comes as part of distribution zip. File should have read permissions.
cycle.cleanup YES Boolean     true

Value:

true or false

Cycle Clean UP - Clean the preexisting cycle information for the OIPA Schema.
cycleworkflow.enabled   Boolean     No

Value:

Yes or No

This property derives the workflow feature. This must be set to Yes if one wants to enable the workflow.
errorReporting.verbose   Boolean      

Value:

true or false

verbose reporting

This property allows verbose reporting.
metrics.timing   Boolean     Yes

Value:

Yes, No

This property will track high lever timing for activity processing.
dataIntake.period   Positive Integer nnnnn       The number of seconds to delay between polling the database for records that require processing.
dataIntake.reProcessingLimit   Positive Integer nnnnn   50  

Defines reprocessing limit

- Used by addRecord, completeLoading and processMessage, to check whether beginLoading for the given fileID is processed or saved to the database.

- Used by completeLoading, to wait and check if addRecords are actively being processed.
dataIntake.yieldTimePeriod   Positive Integer   <=4 1000  

Defines DI Task thread yield time limit

- Used by addRecord, completeLoading and processMessage to check whether beginLoading for the given fileID is processed or saved to the database.

- Used by completeLoading to wait and check if addRecords are actively being processed.
dataIntake.addRecordCorePoolSize YES Positive Integer nnnn   50   This property defines the number of threads created by the pool to save add records.
rateCriteriaConfiguration.enabled   Boolean     No

Value:

Yes, No

This property allows Rate Criteria Columns Configuration.
requirement.service.corePoolSize YES Integer         Thread pool size to perform a task in parallel. Don't remove this even if your not using this property.
cycle.batchSize YES Positive Integer nnnnn <=5 50   The maximum number of Cycle tasks that are processed in the Cycle Grid.
cycle.period YES Positive Integer nnnnn <=5 5   The number of seconds that the Cycle web will wait before checking for additional work.
cycle.groupSize YES Positive Integer nnnnn <=5 10   Determines the number of Cycle work items to be grouped together and run on a single thread in the cluster.
cycle.updateStatsRun   Boolean     No

Value:

Yes, No

 Specifies whether statistics should be updated.
cycle.updateStatsDegree   Positive Integer nnnnn nnnnn 0 >=1 Specifies the degree of parallelism. Applies only to Oracle.
application.X-Frame-Options   AlphaNumeric Fixed List / Free text Parameter <=255 DENY

Value:

DENY,

SAMEORIGIN,

ALLOW-FROM <url>

To support against CSRF attacks. Applies only to IE8 and above. If this property is not specified, no system protection against CSRF is offered.

DENY => Any application page is not allowed to be framed.

SAMEORIGIN => Application is allowed to be framed in any page coming from the same root url. SAMEORIGIN means same root URL.

ALLOW-FROM <url> => Application is allowed to be framed from any page coming from the root URL specified in the property.
application.AccessControlAllowOrigin No AlphaNumeric Fixed List / * <=255 No

Value:

<url>,*

To enable the web server for making the cross domain requests.

<url> => list of allowed domains, which are making service calls.

* => This allows access to all domains, but using this wildcard character is considered overly permissive policy.
jmx.notification.entities   AlphaNumeric      

Values:

cycle,

activity,

activityprofiling,

outboundeventpush,

serviceauditlogging

Here we can have one or more values define. Each value must be comma separated.
dataIntake.corePoolSize Yes NUMBER     50

Value:

50

 The number of threads configured for Message Listener to submit in parallel.
cors.allowGenericHttpRequests No Boolean     true

Value:

true or false

 If property value is to true generic HTTP requests will be allowed to pass through the filter else only valid CORS requests will be allowed.
cors.allowOrigin No Alphanumeric Fixed List / *     * (asterisk) * or Origin list separated with space By Default, all origins are allowed. This property allows to provide list of origins allowed to make cross domain requests. Using * (asterisk) means allowing any origin.
cors.allowSubdomains No Boolean     false

Value:

true or false

 If this property value is set to true, allow requests from any origin which is a subdomain origin of the allowed origins ( cors.allowOrigin ).
cors.supportedMethods No Alphanumeric Fixed List, Comma separated   GET, POST, HEAD, OPTIONS, PUT, DELETE GET, POST, HEAD, OPTIONS, PUT, DELETE HTPP supportedMethods This property defines through Access-Control-Allow-Methods header, list of HTTP methods allowed for the request. for Example, if GET is added in supportedMethods then only GET cross-origin requests is allowed.
cors.supportedHeaders No Alphanumeric     * (asterisk)   This is any custom header set by the application through XMLHttpRequest.setRequestHeader() for example Content-Type, X-Requested-With
cors.exposedHeaders No Alphanumeric     empty list   This is list of headers which are safe to be exposed in the response and this information is sent through Access-Control-Expose-Headers for example , Custom-Exposed-Header-1 , Custom-Exposed-Header-2
cors.supportsCredentials No Boolean     true

Value:

true or false

 This property value identifies in constructing Access-Control-Allow-Credentials header. 
cors.maxAge No Integer     -1   This property indicates how long the preflight request can be cached by the web browser; this value is mentioned in seconds. for example, if the value is mentioned as 3600 means browsers should cache preflight request for 1 hour.
isSharedCluster YES Boolean     false

Value:

false

Specifies if Cycle and OIPA are configured to run on the same Coherence ClusterDefault value is false.

Set it to true if they share the same Coherence Cluster
oipa.url YES AlphaNumeric       http://localhost:9090/PASJava/ This Property is used to connect to OIPA server from Cycle.
application.archivalInUse YES       Yes 'Yes' or 'No' This property determines whether the archival functionality is in use by the user.