Property Definitions Integration Point

Background

All Oracle Health Insurance applications rely on system properties to enable different kinds of behavior. The Installation Guide contains an exhaustive list of the available system properties.

The purpose of the following HTTP IP is to make the definition of the system properties available on a running system.

System Property Definitions Integration Point

This integration point provides the ability to retrieve all system property definitions, including the relevant characteristics.

The operations are protected by the HTTP API access restriction 'property definitions IP'.

The endpoint is available at the following location:

http://<host>:<port>/<context-root>/propertydefinitions

Operations

GET (all)

This method returns all the system property definitions order by name.

Example of a response:

{
    "items": [
    {
        "name" : "ohi.policies.calculate.commission",
        "description" : "This property can be set to true if a license for commission calculation is present.",
        "deprecated" : false,
        "mandatory" : false,
        "defaultValue" : "false",
        "possibleValues" : "true or false",
        "accessMode" : "Protected",
        "changeEffective" : "AfterRestart"
    }, {
        "name" : "ohi.policies.calculate.leapyear.fiscalyear.startmonth",
        "description" : "Can be set to let the fiscal year start at another month than January. Used for leap year detection. If for example set to 4, the period of 2019-04-01 to 2020-03-31 is now the leap year. \nIf this property is not specified, days in a year is considered as 365 for non-contracted policies.",
        "deprecated" : false,
        "mandatory" : false,
        "defaultValue" : null,
        "possibleValues" : "Positive integer, values between 1 and 12",
        "accessMode" : "Public",
        "changeEffective" : "NextExecution"
    },
...
]
}

This operation returns a status as described in Response Messages, typically 200.

The following table lists the attributes of a system property definition:

Attribute	Description
name	The unique name of the property. This name may include a placeholder like {0}. For example ohi.service.{0}.client.authentication
description	A description of the property’s purpose and what should be used as actual value for placeholders
deprecated	true: the system property definition is deprecated and will be removed in a future release false: the system property definition not deprecated
mandatory	true: a value is required to be set explicitly for the application to start properly. This means a property with a defaultValue is never mandatory, because it has a default value false: a value need not be supplied
defaultValue	The value used for this property when no explicit value is given.
possibleValues	A list of the available values for this property
accessMode	Public: (SAAS) users can set this property Protected: the configuration of this property is reserved for (SAAS) administrators only
changeEffective	Indicates when a changed value takes effect. The possible values are: Immediate: immediately NextExecution: with the next execution of the use case / business process AfterRestart: after restart of the Oracle Health Insurance Application

Note

ChangeEffective value "Immediate" does not influence the polling delay for reading the properties file. It only defines when a change detected by the polling is effectuated in the application.

Get (subset)

This method is available at:

http://<host>:<port>/<context-root>/propertydefinitions?name=<prefix>

Only system property definitions whose name start with the given prefix are returned, ordered by name.

This operation returns a status as described in Response Messages, typically 200 if at least one matching property is found, or 204 if there is no match.

GET (one)

This operation is available on the same location, followed by "/<property>", where <property> is the exact name of the property:

http://<host>:<port>/<context-root>/currentproperties/<property>

This operation is similar to the GET (subset) operation, but only returns the property if it exactly matches the path parameter <property>.

This operation returns a status as described in Response Messages, typically 200 if a matching property is found or 404 if no property of that name is found.