Variables
You can use variables to:
- Provide configuration property values after the application is built.
- Edit property values and see the results without the need to rebuild the application every time you make a change.
Variable guidelines
The following guidelines apply:
-
Don't use variables to manage environment variables.
For details, see Environment variables.
-
Variables are updated when you deploy all or selected applications.
You must redeploy the apps for which you changed the variables with the values in Branch and Build # / Dockerize # unchanged.
-
To change application properties in real time, without redeploying and restarting the application server, use runtime properties.
For details, see Runtime properties.
Placeholder values
InsuranceSuite properties are stored as placeholder values in configuration files. With the Variables app, you can use variables to provide and edit external properties for these configuration files.
To identify the affected configuration files, use NAMESPACE prefixes.
At the start of an application, the values in these placeholders are updated with the values set in the Variables app.
Create placeholders in configuration files
A placeholder must meet the following criteria:
- Contains only letters, digits, and underscores (
_). - Isn't an empty string.
- Doesn't start with a digit.
Placeholders must be in the following format:
${NAMESPACE_VARIABLENAME:defaultValue}
Where:
-
NAMESPACEThe prefix identifying the affected configuration file. The Variables app supports externalizing properties using the following prefixes:
CONFIG— identifiesconfig.xml(except for theregistrynode, which isn't supported)DATABASE— identifiesdatabase-config.xmlSUITE— identifiessuite-config.xmlSCHEDULER— identifiesscheduler-config.xmlWORKQUEUE— identifieswork-queue.xmlMESSAGING— identifiesmessaging-config.xmlSOLR— identifiessolr.xmlISO— identifiesISO.propertiesMETRO— identifiesMetro.propertiesPLUGIN— identifies*.gwp(plugin registry definition files)PUBLISHEDAPIS— identifiespublished-apis.yaml
-
VARIABLENAMEDescriptive name of the variable for which you are providing the placeholder.
-
defaultValueDefault value of the property, used when there is no value provided from a variable. Default values are also used in TeamCity for testing.
Important:If you don't provide a default value and there is no value passed from a variable, the placeholder isn't updated. This might cause a failure during a server startup.
The code below is an example of a placeholder for the MinPasswordLength property in the config.xml file:
<param name="MinPasswordLength" value="${CONFIG_MINPASSWORDLENGTH:5}"/>
Don't use the env parameter in configuration files to specify variable values
for different planets.
Okta variables
Whenever you update application credentials, you must deploy the affected apps.
The Variables app uses Okta variables to authorize communication between InsuranceSuite applications and other services. To obtain the Okta variables, the deployed InsuranceSuite applications must have the integration feature flag ISIntegrationEnabled set to all or all propertyServiceDisabled. During the very first deployment in a star system, the Variables app sends requests to Okta to register the InsuranceSuite applications. In return, Okta provides values for the following variables:
OKTA_SCOPE- a list of scopes to access the InsuranceSuite applications.OKTA_CLIENT_ID- an ID that Okta uses for authorization.OKTA_CLIENT_SECRET- a secret used for authorization.OKTA_CLIENT_SECRET_ID- ID of the secret used for authentication.OKTA_AUTH_SERVER_URL- a URL address to which the Variables app sends theOKTA_CLIENT_IDand theOKTA_CLIENT_SECRETto obtain a token for authorization.
The next deployments use the same variables.
You can't change Okta variables in the Variables app.
Check Okta variables
To check the Okta variables:
-
Select a star system.
-
From Apps
, select Planets or select it from your pinned apps. -
Select a planet with InsuranceSuite apps deployed.
-
From Applications and add-ons, select InsuranceSuite.
-
Go to Variables and search for variables with the key starting with
OKTA.
Environment variables
In the Variables app, some environment variables have predefined values that you can't change or remove. If you use such variables, your provided values won't be applied and will be overridden by the Variables app. To avoid this situation, don't use variables with the following names:
POD_NAMEPOD_IPDEPLOYMENT_IDGW_TENANTGW_PROPERTY_SERVICE_DISABLEDOKTA_CLIENT_IDOKTA_AUTH_SERVER_URLOKTA_SCOPEOKTA_APP_NAMEOKTA_CLIENT_SECRETOKTA_CLIENT_SECRET_IDTZDATABASE_JDBC_URLCONFIG_FREE_TEXT_SEARCH_ENABLEDSOLR_SOLRSERVER_HOSTMESSAGING_SOLR_DESTINATION_DISABLEDPLUGIN_RUNTIME_PROPERTY_CONFIG_LOCATIONPLUGIN_SOLR_MESSAGE_TRANSPORT_PLUGIN_DISABLEDPLUGIN_SOLR_SEARCH_PLUGIN_DISABLEDPLUGIN_S3_BUCKET_NAMEPLUGIN_INBOUND_S3_INPUT_PREFIXPLUGIN_INBOUND_S3_ARCHIVE_PREFIXPLUGIN_INBOUND_S3_FAILED_PREFIXPLUGIN_OUTBOUND_S3_OUTPUT_PREFIXPLUGIN_ARCHIVING_S3_PREFIXPLUGIN_INTERNAL_S3_PREFIXPLUGIN_AWS_SECRET_NAMESPLUGIN_AWS_SECRET_TAGSPLUGIN_AWS_REGIONDD_ENTITY_IDDD_ENVDD_SERVICEDD_VERSIONDD_HTTP_CLIENT_TAG_QUERY_STRINGDD_HTTP_SERVER_TAG_QUERY_STRINGDD_LOGS_INJECTIONDD_TRACE_CLASSES_EXCLUDEDD_SERVICE_MAPPINGDD_PROFILING_ENABLEDDD_TAGSDD_TRACE_ANALYTICS_ENABLEDDD_INTEGRATION_THROWABLES_ENABLEDDD_TRACE_PARTIAL_FLUSH_ENABLEDDD_TRACE_PARTIAL_FLUSH_MIN_SPANSDD_DOGSTATSD_NON_LOCAL_TRAFFICDD_AGENT_HOSTAPM_OPS_SENDAPM_TENANT_SENDDISABLE_HEALTHCHECKCATALINA_OPTSINTERNAL_CM_PRODUCT_URLPUBLIC_CM_PRODUCT_URLINTERNAL_BC_PRODUCT_URLPUBLIC_BC_PRODUCT_URLINTERNAL_CC_PRODUCT_URLPUBLIC_CC_PRODUCT_URLINTERNAL_PC_PRODUCT_URLPUBLIC_PC_PRODUCT_URLCONFIG_CM_PRODUCT_URLCONFIG_BC_PRODUCT_URLCONFIG_CC_PRODUCT_URLCONFIG_PC_PRODUCT_URLSUITE_CM_PRODUCT_URLSUITE_BC_PRODUCT_URLSUITE_CC_PRODUCT_URLSUITE_PC_PRODUCT_URL