Configuring Sterling Configurator repositories

Sterling Configurator uses Model, Property, Rule, Extensions, and Tenant repositories to store files that are required for configuring and running the application.

Prerequisite Before you start configuring Sterling Configurator repositories, you must perform the following tasks:
  • Install the Visual Modeler application.
  • Identify a directory on your machine to use as the root directory for the Sterling Configurator repositories. This directory is referred to as <config_repo_home> throughout the documentation. By default, the application identifies <USER_HOME> as the root directory. <USER_HOME> home directory location can vary from one operating system to another.
    Note: You can define custom location for <config_repo_home> directory and set this for Sterling Configurator application by passing the appropriate JVM arguments while deploying the WAR file. For more information refer to Deploying Sterling Configurator backend (REST APIs) WAR file topic.
  • Under <config_repo_home>, create a new directory called omniconfigurator.
Setting up Sterling Configurator repositories
  1. Create the model repository directory where all the compiled model XMLs are stored. This directory is referred to as <model_repository> throughout the documentation. For example, <config_repo_home>/omniconfigurator/models.
  2. Create the property repository directory, where all the general configurator property files used to control the behavior of the Sterling Configurator backend engine are stored. This directory is referred to as <property_repository> throughout the documentation. For example, <config_repo_home>/omniconfigurator/properties.
  3. Copy the following property files from the <VM_wardir>/WEB-INF/propertiesdirectory to the <property_repository> directory that you created in Step2. <VM_wardir> refers to the WAR directory under the EAR directory in the deployed Sterling Configurator Visual Modeler application.
    • functionHandlers.properties
    • lookupValues.properties
    • webServiceLookup.properties
  4. Create a new configurator.properties file and copy it to the <property_repository> directory.
  5. Edit the configurator.properties file and add the following content:
    allowConfigErrorsInCart:            true
configuratorDefaultTemplate:        configurator.jsp
configuratorTemplateDirectory:      /configurator/
pricingType:                        OVERRIDE_PRICING
loadModelOnErrors:                  false
cacheSize:                          64
maxPoolSize:                        2
  6. Create the rules repository directory where all the model-related rules are stored. This directory is referred to as <rule_repository> throughout the documentation. For example, <config_repo_home>/omniconfigurator/rules.
  7. Copy the following rules JAR files from the configurator.war\WEB-INF\lib directory to the <rule_repository> directory that you created in Step4:
    • cmgt-rulesEngine.jar
    • cmgt-configuredItem.jar
    • cmgt-configurator.jar
  8. Create the extensions repository directory where all your extensions are stored. This directory is referred to as <extensions_repository> throughout the documentation. For example, <config_repo_home>/omniconfigurator/extensions.
  9. Create the tenant repository directory where all the tenant-related configurations and customization are stored. This directory is referred to as <tenant_repository> throughout the documentation. For example, <config_repo_home>/omniconfigurator/tenants.
Note: By default, the application looks for these repositories in the <config_repo_home>/omniconfigurator directory. But you can define custom location for these repositories by creating Sterling Configurator repository configuration file, repository.properties, in the <config_repo_home>/omniconfigurator directory. Following are sample entries from the repository.properties file.
ModelRepository=C:/data/models
PropertyRepository=C:/data/properties
RuleRepository=C:/data/rules
TenantRepository=C:/data/tenants
ExtensionsRepository=C:/data/extensions