Web Determinations configuration files

Web Determinations configuration files

The following provides details of the configuration options provided in Web Determinations. All configuration files can be found at the following locations:

 

Some important points to note are:

Go to:

application.properties

appearance.properties

messages.<locale>.properties

See also:

Example: Configuration for Classpath-based loading (Java)

Example: Configuration for File System-based loading (Java and .NET)

application.properties

These are the core application properties that are used to configure the application and are not available templates.

Click on the appropriate link:
General properties:

 

Name Description
default.locale this is the default locale to use for screens that are not tied to a locale such as the rulebase and locale selection screens. For information on locale formats see Input and Output Codes.
enable.debugger set to true if you want to enable debugging from the debugger, otherwise false

 

Rulebase Loading properties:

 

Name Description
load.rulebase.from.classpath Java only. Set to true if you want the rulebases to be loaded from the classpath rather than the file system. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic
rulebase.path the path to the directory to containing the rulebases. If load.rulebase.from.classpath = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.
cache.loaded.rulebases If true rulebases will be cached and the server will required to be re-started in order to pick up rulebase changes. Otherwise it will operate in hot swapping mode which allows rulebase updates to be picked up without a server re-start. Note: if load.rulebase.from.classpath = true, this property will always effectively be true
enable.second.person set to true to enable second person text substitution on rulebases that support it

 

isHTML validation:

 

Name Description
screens.validate.html Screens file content can include html authored by users in oracle policy modeling as static content. These options determine whether to scan the content at application start time and verify that the tags deployed in the rulebase are in the whitelist of allowable content.
screens.html.tags.whitelist If screens.validate.html = true any tag not on this list will cause an exception to be thrown during rulebase loading and the rulebase will not be available. if additional tags are required they must be added to this list.

 

Resource Loading properties:

 

Name Description
load.messages.as.resources Java Only. Set to true if you want to load message properties files from the classpath. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic.
messages.path the path to the directory containing the messages.properties. If load.messages.as.resources = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.
cache.messages set to true if you want message files to be cached.
load.images.as.resources Java Only. Set to true if you want to load images from the classpath. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic.
images.path the path to the directory containing the images If load.images.as.resources = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.
cache.images set to true if you want message files to be cached.
load.resources.as.resources Java Only. Set to true if you want to resources images from the classpath. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic
resources.path the path to the directory containing the resources. If load.resources.as.resources = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.
load.properties.as.resources Java Only. Set to true if you want to load the appearance.properties from the classpath. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic.
properties.path the path to the directory containing the appearance.properties If load.properties.as.resources = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.
cache.properties set to true if you want appearance.properties files to be cached.
load.templates.as.resources Java Only. Set to true if you want to load the templates from the classpath. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic.
templates.path the path to the directory containing the velocity templates If load.templates.as.resources = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.
cache.templates set to true if you want velocity templates files to be cached.
load.static.content.as.resource Java Only. Set to true if you want to load the static contents from the classpath. This value must be set to true in order to deploy to Java application servers that do not explode the war file by default; for example, WebLogic.
static.content.path the path to the directory containing the static files (that is, documents, html files). If load.static.content.as.resources = true then this path must be relative to the 'classes' directory. Otherwise the path can either be absolute or relative to the webroot.

 

Plugin properties:

 

Name Description
plugin.libraries a ';' list of the fully qualified plugin classes to load. By default, all libraries in the plugin directory will be searched, however specifying a list will restrict the plugin loader to only loading the specified classes. On Weblogic the jar files containing the plugins must be explicitly listed here in order to loaded.

 

Data:

 

Name Description
xds.file.path

when using the default data adaptor, this is the base directory to which the data will be saved. Can either be relative to the web root or absolute.

Note:

If you wish to deploy a WAR unexploded, and you want to use the default XDS data adaptor, you will need to change this to point to an absolute path for which Web Determinations has read and write access.

 

Input and output formats

Click on the appropriate link:

Default formatter

Web Determinations allows the accepted input and output format(s) of Date, DateTime, Currency and Number attributes to be specified on a per locale basis using its default formatter. Note that these default formatter properties are manually entered by the user.

 

Property Description Additional Remarks
currency-symbol the currency symbol to use  
grouping-separators a quoted string of allowable grouping separators for number and currency values; for example a string of "\, " would mean that numbers such as 1 000 000 and 1,000,000 are accepted but not 1.000.000 This property applies on the Java platform only. .NET number formatters do not allow you to specify an input pattern but rather make a best attempt to parse the input according to the specifics of the locale (see http://www.dotnet-culture.net/)
decimal-separator the decimal separator value to use; for example, specifying '.' as a separator would interpret the currency value $10.25 as ten dollars and twenty five cents. If the decimal separator was a ',' then the same number would be written as $10,25 this property applies on the Java platform only. .NET number formatters do not allow you to specify an input pattern but rather makes a best attempt to parse the input according to the specifics of the locale (see http://www.dotnet-culture.net/)
output-currency-format The format in which all currency values should be displayed. This format will automatically become an accepted currency input format.

This string is expressed using the Java Decimal format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/DecimalFormat.html).

Note: the currency symbol *must* be defined in addition to the output currency format if using Web Determinations in .NET. Failure to specify the currency symbol will cause the error "Cannot specify an output currency format without also specifying the currency symbol." to appear in the log file.
input-currency-formats This is the ',' delimited list of input formats for currency values.

This property applies on the Java platform only. .NET number formatters do not allow you to specify an input pattern but rather make a best attempt to parse the input according to the specifics of the locale (see http://www.dotnet-culture.net/). Like the output currency format, the format itself is expressed using the Java Decimal Format convention.

Notes:

  • the user may include the currency symbol in the currency formats, and if they do a second copy with not be added. If the user wants a split format like $#,##0.00;($#) then they must set it themselves that way, and add a second copy without the currency symbol e.g. input-currency-formats = #\,##0.00;(#),$#\,##0.00;($#)

  • the format strings themselves are not localized, that is the format should always use , as the grouping separator and . as the decimal separator (e.g. #,##0.0#) even if the user has specified a space for the grouping separator. # ##0.00 will not be understood as a valid format even though 1 234.56 is a valid number according to that format.

  • leading # characters don't do anything. #######0.0######## is the same as #0.0#

  • the grouping size is set by the last separator. So, #,##0.0# is the same as ###,###,###,##0.0# is the same as ####,#,##,##0.0#

  • in separate negative groupings, only the prefix and suffix matter, so $#,##0.0#;($#,##0.0#) is the same as $#,##0.0#;($#) is the same as $#,##0.0#;($#,######000.000000#)
output-number-format The format in which all number values should be displayed. This format will automatically become an accepted number input format. This string is expressed using the Java Decimal format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/DecimalFormat.html).
input-number-formats The ',' delimited list of input formats for number values. This property applies on the Java platform only. .NET number formatters do not allow you to specify an input pattern but rather make a best attempt to parse the input according to the specifics of the locale (see http://www.dotnet-culture.net/). This string is expressed using the Java Decimal format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/DecimalFormat.html).
output-date-format The format in which all date values should be displayed. This format will automatically become an accepted date input format.

This string is expressed using the Java Simple Date Format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html).

Note: the output date format is always treated as the first input date format.
input-date-formats This is the ',' delimited list of allowable input formats for date values.

This string is expressed using the Java Simple Date Format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html). Notes:

  • this format will also be used to parse the date portion of a date time input where the date time input style has been set to two text boxes

  • if you want to allow both two digit year format and four digit year format, the two digit year formats must be specified before those with four digit years (e.g. d/M/yy, d-M-yy, dd/MM/yyyy, dd-MM-yyyy)

  • the output date format is always treated as the last input date format, and so the order is important.
output-datetime-format The format in which all DateTime values should be displayed. This format will automatically become an accepted date time input format. This string is expressed using the Java Simple Date Format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html).
input-datetime-formats This is the ',' delimited list of allowable input formats for DateTime values. This string is expressed using the Java Simple Date Format convention (see http://docs.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html).

Locale codes

Locale codes use the two letter ISO 693-1 code followed by the two letter ISO 3166-1 country code separated by a hyphen.
Out of the box we provide localizations for the following languages:

 

Language Locale code
Arabic (Saudi Arabia) ar
Chinese (Simplified) zh-CN
Chinese (Traditional) zh-HK
Czech cs
Danish da
Dutch nl
English (American) en
English (Great Britain) en-GB
Finnish fi
French (France) fr
German (Germany) de
Hebrew he
Italian it
Japanese ja
Korean ko
Polish pl
Portuguese (Brazillian) pt-BR
Portuguese (European) pt-PT
Russian ru
Spanish (Modern) es
Swedish sv
Thai th
Turkish tr

appearance.properties

These properties control the general appearance of the application. Properties in this file can be overridden on a per-locale basis, if you create a appearance.<locale>.properties file; for example, appearance.en-US.properties

Click on the appropriate link:
Debugging properties:

 

Name Description
show-attribute-question-identifiers if true, shows attribute ids for controls on question screens
show-status-bar if true, shows the status bar containing information about the session being run
show-case-id if true, shows the current case id in the status bar
show-rulebase if true, shows the name of the rulebase in the status bar
show-rulebase-version

if true, shows the rulebase version in the status bar

Note that if the rulebase did not have a rulebase version stamped into it when it was built then nothing will be displayed.
show-rulebase-build-time if true, shows the rulebase time in the status bar. The rulebase build time will always be formatted as an ISO 8601 date time value.
show-policy-modeling-version if true, shows the version of Oracle Policy Modeling used to build this rulebase in the status bar.
show-locale if true, show session locale in the status bar
show-user-id if true, shows the current user id in the status bar
warn-unsubmitted-pages if true, warns the user if they try to navigate away from a screen without submitting data, to prevent the lose of data.

 

Progress bar options:

 

Name Description
show-progress-bar if true, shows the investigation progress bar
show-progress-stages if true, shows the investigation progress stages

 

Commentary options:

 

Name Description
opa-commentary-type

This property controls the commentary display and can have the following values:

  • frameset - commentary and the investigation will be run in frames of a frameset
  • popup - commentary will open in a separate window
  • iframe - commentary will open in an iframe
  • none - commentary will not be shown

The default value is set to frameset. If an invalid value is provided, opa-commentary-type will be set as none and no commentary will be shown.

opa-commentary-iframe-style Use this property to set the various attributes for the iframe in which the commentary is to be displayed.
iframe-border

Use this property to set the border of the commentary iframe; 0 refers to no border.
This is useful in cases where setting the frame-border using the style attribute does not work (for example, in Internet Explorer).

Note: the border can also be set using the opa-commentary-iframe-style.
frameset-top-target the frameset target
commentary-target the commentary target

 

Colors, fonts and images

Click on the appropriate link:

General and main form body:
Name Description
body-background-color the background color for the screen body
body-text-color the text color of the screen body
display-fonts the list of available display fonts
attribute-id-text-color the text color of the attribute ids
mandatory-marker-text-color the text color of the marker used to signify a control is mandatory
link-text-color the text color of any links in the screen body
link-hover-text-color the text color of any links in the screen body when the mouse hovers over them
decision-report-leaf-image the image to use for leaf nodes in decision report controls
decision-report-collapse-image the image to use for collapsed nodes in decision report controls
data-review-collapse-image the image to use for collapsed nodes in decision report controls
question-width the percentage width of the question text on a question screen
info-width the percentage width of the question info on a question screen
answer-width the percentage width of the input control for a question of the question screen
screen-min-width the minimum width a screen can be before scrolling, defined in piles
text-area-cols the default number of columns for multi-line text inputs
text-area-rows the default number of rows for multi-line text inputs
listbox-width the width of listbox controls
text-control-width the width of text controls

 

Header:
Name Description
header-image the image displayed in the header
header-alt the alt text for the header image
header-title the header title
header-text-color the color of the header text
headers-font-weight the header font weight
hide-header if set to "true" the header will be hidden

 

Progress bar and progress stages:
Name Description
progress-bar-border-color the progress bar border colour
progress-bar-complete-color the colour of the completed stages in the progress bar
progress-bar-incomplete-color the colour of the uncompleted stages in the progress bar
progress-stages-background-color the background colour of of the progress stages
progress-stages-border-color the border colour of the progress stages
progress-stages-text-color the text colour of the progress stages
status-bar-background-color the background colour of the status bar
status-bar-text-color the colour of the status bar text
status-bar-border-color the colour of the status bar border

 

Menu:
Name Description
menu-background-color the background color of the menu bar
menu-text-color the text color of the menu items
menu-border-color the menu items border color
menu-background-image the background image for the menu items
menu-link-text-color the color of the menu item links
menu-link-text-hover-color the color of the menu item links when the mouse hovers over them
menu-left-width the percentage of the left hand portion of the menu
menu-right-width the percentage width of the right hand portion of the menu
show-save controls the visibility of the Save button on the Oracle Web Determination menu bar
show-save-as controls the visibility of the Save-as button on the Oracle Web Determinations menu bar
show-load controls the visibility of the Load button on the Oracle Web Determinations menu bar

 

Important note:

Turning off the visibility of items in the menu bar does not mean that the functionality is completely disabled; to ensure security, functionality must be disabled via the Data Adaptor.

 

Footer:
Name Description
footer-border-color the color of the footer border
footer-text-color the color of the footer text
footer-background-color the background color of the footer
footer-background-image the image to use in the footer
hide-footer if set to "true" the footer will be hidden

 

Form controls:
Name Description
input-border-color the border color of input control
input-text-color the text color for input controls
input-background-color the background color of input controls
input-disabled-border-color the border color of disabled input controls
input-disabled-text-color the text color of disabled input controls
input-disabled-background-color the background color of disabled input controls
input-readonly-border-color the border color of read only input controls
input-readonly-text-color the color of the text in read only input controls
input-readonly-background-color the background color of read only input controls
input-seperator-color the input of the separator between input controls
button-border-color the border color of any buttons
button-background-color the button background color
button-background-image the background images to use for any inputs

 

Messages:
Name Description
messages-border-color the border color for any messages
messages-text-color the messages text color
messages-error-text-color the text color of error messages
messages-warning-text-color the text color of warning messages
messages-background-color the background color of the messages

 

 

 

Decision report options:


Name Description
decision-report-default-depth Sets the display depth of decision reports; the default is a display depth of 2 levels. Setting it to 0 will display all levels.

message.<locale>.properties

Contains locale specific properties like error messages, text, data formats and so on; see the topic, Localization.

Click on the appropriate link:
Message properties:

 

Name Description Available properties
boolean-true         text for true boolean values  
boolean-false text for false boolean values  
boolean-uncertain text for uncertain values  
boolean-unknown text for unknown values  
AttributeValueTypeError Indicates that the value submitted for the attribute is of the wrong data type; for example, attempting to set a number value to 'bob'
  • attributeId - the id of the attribute
  • entityInstanceIdentifier - the entity instance this error was raised in
  • message - the generic error message
  • value - the value that caused the error
AttributeValueError Generic error that is raised due to an error attempting to set an attribute value
  • attributeId - the id of the attribute
  • entityInstanceIdentifier - the entity instance this error was raised in
  • message - the generic error message
  • value - the value that caused the error
MissingValueError Raised when no value (or an uncertain value) has been submitted for a mandatory value
  • attributeId - the id of the attribute
  • entityInstanceIdentifier - the entity instance this error was raised in
  • message - the generic error message
UnknownAttributeError Raised when attempting to access an attribute instance that does not exist
  • attributeId - the id of the attribute
  • entityInstanceIdentifier - the entity instance this error was raised in
  • message - the generic error message
UnknownEntityError Raised when attempting to access an entity that does not exist in the rulebase
  • entityId - the name of the entity
  • message - the generic error message
UnknownEntityInstanceError Raised when attempting to access an instance of an entity that does not exist in the session
  • entityId - the name of the entity
  • instanceName - the name of the entity instance
  • message - the generic error message
DuplicateEntityInstanceError Raised when attempting to create an entity instance with the same name as one that already exists
  • entityId - the name of the entity
  • instanceName - the name of the entity instance
  • message - the generic error message
InvalidRelationshipInstanceError Caused by the failure to set an entity instance in the session
  • relationshipId - the name of the relationship
  • source - the source entity instance
  • target - the target entity instance
  • message - the generic error message
UnknownRelationshipError Caused by attempting to access a relationship that does not exist in the rulebase
  • relationshipId - the name of the relationship
  • message - the generic error message
UnknownRelationshipInstanceError Caused by attempting to access an instance of a relationship that does not exist in the session
  • relationshipId - the name of the relationship
  • source - the source entity instance
  • target - the target entity instance
  • message - the generic error message
InvalidValueChangeWarning Raised when the submitted value of a read only or invisible control differs to the current value of that attribute in the session.
  • attributeId - the id of the attribute
  • entityInstanceIdentifier - the entity instance this error was raised in
  • message - the generic warning message
  • value - the value that caused the error
GenericError This is the fall-back generic error message for errors occurring during the submission of a screen that is displayed.
  • message - the generic error message
ControlValueFormatError Raised when the submitted value is in an invalid format for the specified control.
  • message - the generic error message
  • value - the value submitted
  • controlId - the id of the control which contained the invalid value
FailedToLoadCaseError Raised when the specified case could not be loaded.
  • message - the generic error message
  • caseId - the Id of the case attempting to be loaded
InvalidActionError Raised when the submitted url action is invalid.
  • message - the generic error message
  • action - the name of the invalid action
MissingResourceError Raised when a required resource file is missing.
  • message - the generic error message
  • fileName - the name of the missing file
NoActiveSessionError Raised when attempting to perform an action that requires an active session but no session has been started.
  • message - the generic error message
NoResourcesForLocaleError Raised when at least one of the required localized resources files (screen.properties, styling.properties or messages.properties) can not be found for the specified locale.
  • message - the generic error message
  • locale - the specified locale
NoSuchMessageError Raised when attempting to display an error message in a given locale for which no localized message has been provided.
  • message - the generic error message
  • msgKey - the message key
  • locale - the locale
ResourceLoadError Raised when the required resource file can be found but could not be loaded for some reason.
  • message - the generic error message
  • fileName - the name of the resource file
TemplateParseErrror Raised when the specified template file could not be parsed.
  • message - the generic error message
  • templateName - the name of the template file
CaseIDNotValidError Raised when the specified case id is invalid
  • message - the generic error message
  • caseID - the invalid case id
CaseIDNotFoundError Raised when no case can be loaded for the specified case id
  • message - the generic error message
  • caseID - the invalid case id
TemplateParseErrror Raised when the specified template file could not be parsed.
  • message - the generic error message
  • templateName - the name of the template file
FormatValueError Raised when the formatter is unable to format the given value.
  • message - the generic error message
  • value - the value that could not be formatted
InputValueParseException Raised when the formatter can not parse the specified value.
  • message - the generic error message
  • value - the value that could not be parsed
InvalidRequestError Raised when the url request is invalid
  • message - the generic error message
  • param - the invalid parameter
  • value - the invalid value
InvalidScreenTemplateError Raised when the specified template is invalid
  • message - the generic error message
  • templateName - the name of the invalid template
DataSaveError Raised when the case failed to save  

 

Months

The names of the months that are displayed in the drop down list for Date and DateTime controls where the input types are set to 'Year, Month and Day Edits' and 'Year, Month, Day, Hour Minute and Second Edits' respectively can also be localized through the following properties:

 

Month Proprty Key
January month-jan
February month-feb
March month-mar
April month-apr
May month-may
June month-jun
July month-jul
August month-aug
September month-sep
October month-oct
November month-nov
December month-dec

 

Other text values not authored in Oracle Policy Modeling.

All other text values not authored in Oracle Policy Modeling can also be localized via the messages.properties file:

 

Property Description
tree-leaf-alt alt text for the leaf node icon in tree controls
tree-collapse-alt alt text for the collapse node icon in tree controls
tree-expand-alt alt text for the expand node icon in tree controls
data-review-no-controls text for screens that appear on the data review screen, that have no child controls to display
decision-report-why-text text for the decision report link on summary screens
decision-report-already-proven text for the already proven nodes in a decision report
frame-interview-title tooltip for the interview frame when displaying commentary using a frameset
frame-commentary-title tooltip for the commentary frame when displaying commentary using a frameset
select-rulebase-screen-title the text to display on the select rulebases screen
LocaleSelectionTitleInfoMessage the text to display on the select locale screen
confirm-end-session-text the message to display when ending a session
save-failed-title the title of the save failed screen
save-failed-label the text to display on the save failed screen
case-saved-label the text to display on the screen confirming that the case saved
RestoreCaseLabelInfoMessage the text to display on the restore saved file
SavedCasesAvailableForUserInfoMessage the text to display when getting the list of available saved cases
NoSavedCasesAvailableForUserInfoMessage the text to display when no saved cases are available to load
load-failed-title the title of the load failed screen
load-case-title the title of the load case screen
footer-left-text the left footer text
footer-right-text right footer text
delete-check-box-text caption for the delete check box on the entity collect controls
delete-button-text caption for the delete entity instance(s) button
add-button-text caption for the add entity instances button
submit-button-text caption for the submit button
ok-button-text caption for the ok button
end-session-button-text caption for the end session button
cancel-button-text caption for the cancel button
save-case-label caption for the case ID input on the save case screen
save-button-text caption for the save button
continue-button-text caption for the continue button
second-selection-alt alt text for the seconds selection input for date time and time inputs
minute-selection-alt alt text for the minute selection input for date time and time inputs
hour-selection-alt alt text for the hour selection input for date time and time inputs
day-selection-alt alt text for the day selection input for date and date time inputs
month-selection-alt alt text for the month selection input for date and date time inputs
year-selection-alt alt text for the year selection input for date and date time inputs
date-selection-alt alt text for the date input for date time inputs
time-selection-alt alt text for the time input for date time inputs
mandatory-text the text to display next to mandatory fields
save-text caption for the save button on the menu bar
save-as-text caption for the save as button on the menu bar
load-text caption for the load button on the menu bar
close-text caption for the close button on the menu bar
restart-text caption for the restart button on the menu bar
summary-text caption for the summary screen button on the menu bar
data-review-text caption for the data review button on the menu bar
case-id-text caption for the case ID element in the status bar
rulebase-text caption for the rulebase element in the status bar
rulebase-version-text caption used when displaying the rulebase version in the status bar
rulebase-build-time-text caption used when displaying the rulebase build time in the status bar
policy-modeling-version-text caption used when displaying the Oracle Policy Modeling version used to build the rulebase in the status bar
locale-text caption for the locale element in the status bar
user-id-text caption for the user ID element in the status bar
auto-screen-title screen title used for all automatic screens