Skip to main content

Runtime properties

In the InsuranceSuite applications, you can change application properties in real-time without restarting the application server. Note that if you want to add properties in the Planets app, you still need to deploy the affected applications.

Each runtime property contains four fields:

  • Group

    Group identifier of the property. This parameter is used by runtime property retriever. In the base configuration, InsuranceSuite applications provide the two following groups: configuration and integration.

  • Name

    Original identifier of the property.

  • Description

    (Optional) Additional information about the property.

  • Value

    Property value.

To use runtime properties, you must link each property with application code. Your application code must call an instance of the RuntimePropertyRetriever class and use one of its methods to retrieve the property value.

For more information, see InsuranceSuite documentation.

You can also use the Variables app to set up configuration property values after the application is built. Variables are updated when you deploy affected applications. For details, see Variables.

Pass runtime properties from the Planets app​

You can pass runtime properties to applications in each planet from the Planets app. To use runtime properties, upload a definition file to the Planets app. Each definition file is automatically validated against the XSD schema. For details, see File validation against XSD schema.

When a file is uploaded, deploy the affected applications.

Note:

To work with runtime properties in the Planets app, you must use the latest version of the runtime properties plugin. Contact your customer partner.

To manage definition files, you can also use the Runtime Properties API.

Process runtime properties​

Properties defined at the application level are processed before properties that you define in external files. When you deploy an application, runtime properties are processed the following way:

  • New properties defined in the file are added to the application.
  • Values of existing properties are not updated to values defined in the file. The value you set at the application level precedes the value you set in an external file. To see how to update property values at run time, see Edit existing properties.
  • Properties removed from the file are not removed from the application.

Runtime properties plugin​

When you upload runtime properties definition files in the Planets app and deploy the application, they are copied to the deployment storage. The path to the properties is passed to the RuntimePropertiesPlugin plugin. The Planets app passes the data in the PLUGIN\_RUNTIME\_PROPERTY\_CONFIG\_LOCATION environment variable. This process is automatic.

Note:

To work with runtime properties in the Planets app, you must use the latest version of the runtime properties plugin. Contact your customer partner.

Add properties​

To define new application properties using runtime properties:

  1. Create an XML definition file.

    A file name must contain only letters, numbers and the following characters: hyphens (-), periods (.) and underscores (_).

  2. Select a star system.

  3. From Apps, select Planets or select it from your pinned apps.

  4. Select the planet with the application for which you want to set properties.

  5. From Applications and add-ons, select InsuranceSuite.

  6. In Applications, find the application whose runtime properties you want to set and select Set Runtime Properties.

  7. Select Upload and choose the configuration file.

    The total size of all runtime properties configuration files must not exceed 700 KB.

  8. Deploy the affected application.

    Note:

    If you have re-uploaded a definition file, select the Drop database check box when deploying the application to see your changes.

Edit properties​

When you upload a definition file to the Planets app and deploy the application, runtime properties are processed the following way:

  • New properties defined in the file are added to the application.
  • Values of existing properties are not set to values defined in the file.

You can change the values of existing properties in the two following ways:

  • Delete the properties that you want to change using the InsuranceSuite application user interface. Then, upload a definition file with new property values to the Planets app.
  • Upload a definition file with new definitions to the Planets app. Then, drop the application database during deployment.

Set properties to default​

Set the application properties to their default values or remove properties added from the runtime properties definition file:

  1. Select a star system.

  2. From Apps, select Planets or select it from your pinned apps.

  3. Select the planet with the application for which you want to reset properties.

  4. From Applications and add-ons, select InsuranceSuite.

  5. In Applications, select Set Runtime Properties.

  6. In the table, hover over the related definition file and select Delete.

  7. Deploy the related application.

    When deploying, select the Drop database check box.