Sterling OMS Overriding

By | 07/07/2018

Sterling OMS Overriding

Sterling OMS Overriding

Sterling OMS Overriding

In this post we are going to learn about basic concepts of Sterling OMS properties. As part of Sterling install folder you can see folder with name properties.  This folder has lot of files related to properties. Few important files to discuss

S.No Files under properties folder Used Build or Run Time Remarks
1 sandbox.cfg Build Time Contains key,value parameters which is
Used to create properties file.
Stores all the information given during
Installation like DB URL, DB user name, Password
Install location details
Example : DB_PORT=1521
2 Run Time This is important file which holds all the location reference for properties file available. During server startup below value passed to locate server properties file.
-DvendorFile=/servers.propertiesSample Data in file
3 Run Time This file contains default configuration related to below area. Do not modify any value in this file. You should use file to override

  • Agent
  • API security
  • CDT
  • Database
  • Exception management
  • Implementation
  • Internal
  • InteropHttpServlet
  • JMS
  • Online help (for SSCAP)
  • Prints
  • Security
  • Service Definition Framework (SDF)
  • Rich Client Platform (RCP)
  • System management
  • User interface
4 Build Time This is temp file used for creating file
5 APPDynamicclasspath.cfg Run Time Holds class path which used during APP server startup
6 Build Time This is temp file used for creating APPDynamicclasspath.cfg
Using sandbox.cfg values
7 AGENTDynamicclasspath.cfg Run Time Holds class path which used during AGENT server startup
8 Build Time This is temp file used for creating AGENTDynamicclasspath.cfg using sandbox.cfg values
9 Run Time Manually created by user under <Install Dir>/properties. Used for override any existing or adding new properties

How to modify database related properties in sandbox.cfg?

  1. From <Install Directory>/properties folder take a copy of sandbox.cfg as sandbox.cfg.original
  2. Search for following values in sandbox.cfg
    • NO_DBVERIFY=false
    • REINIT_DB=true
  1. First make change in sandbox.cfg file
    • NO_DBVERIFY=false (DDL scripts created automatically)
    • REINIT_DB=false (Database update will not happen automatically; Have to run the DDL script manually)
  1. Go to <Install Directory>/bin in command prompt
  2. Run <Install Directory>/bin/setupfiles.cmd files
  3. All places will get referenced with new change

How to add new 3rdparty jar file into OMS ?

  • Go to <Install Directory>/bin in command prompt
  • Run <Install Directory>/bin/install3rdParty.cmd weblogic 12.3 -j C:\weblogic\12\wlfullclient.jar -targetJVM AGENT
    • weblogic – vendorname
    • 12.3 – version number
    • C:\weblogic\12\wlfullclient.jar – path of the jar file (Can take multiple jars)
    • -targetJVM AGENT – Defines which classpath files should be updated

What happens when install3rdParty cmd run ?

  • Jar files get copied under location <OMS Install Dir>/jar/weblogic/12.3 (If folder not there gets created)
  • <OMS Install Dir>\properties\ files gets below entry


  • <OMS Install Dir>\properties\AGENTDynamicclasspath.cfg files gets below entry


How to override property in ? file has property with name yfs.jms.session.disable.pooling

Lets see how this property been defined in file (property group, modifiable, possible values, default)

if you like to override this property you need to make entry into file in below format.

Format : prefix_name.property_name=property_value

Example : yfs.yfs.jms.session.disable.pooling=N

Here prefix_name (first yfs) is derived from <Install dir>\properties\ file (Inside this file search for yfs=)

How to override property using ?

Make below entry into

Sample Java Code for reading value from properties file

Export Jar and Add part of OMS (One time activity)

How to write java program : Read this blog

  • Export project and create SterlingCustom94.jar file under C:\deploy\SterlingCustom94.jar
  • Run below command from OMS bin folder (One time Activity)

install3rdParty.cmd customjar 1 -j C:\deploy\SterlingCustom94.jar -targetJVM EVERY

  • Jar file automatically copied into <Install Directory>\jar\customjar\1\SterlingCustom94.jar
  • Below lines get added in 3 files (APPDynamicclasspath.cfg, AGENTDynamicclasspath.cfg, and dynamicclasspath.cfg files)
  • VENDOR_JAR=<OMS Install Directoty>\jar\customjar\1\SterlingCustom94.jar
  • Next time you can export the custom jar directly into <Install Directory>\jar\customjar\1 from Eclipse
  • Perform Build and deploy

OMS Build & Deployment

  • Go to bin folder
  • Run command : deployer.cmd -t resourcejar
  • Run command : buildear.cmd -Dappserver=weblogic -Dwarfiles=smcfs -Dearfile=smcfs.ear -Dnowebservice=true -Ddevmode=true -Dnodocear=true -Dwls-10=true create-ear
  • Ear file gets created under <Install Directory>\external_deployments\smcfs.ear
  • Create new folder deploy and C:\
  • Run command : del C:\deploy\smcfs.ear (Clean up any existing file)
  • Run command : copy <Install Directory>\external_deployments\smcfs.ear C:\deploy\smcfs.ear
  • Deploy manually using weblogic console from folder C:\deploy\smcfs.ear

Create New Service in OMS

  • Go to Application Manager — General — Service
  • Create new service with name “ReadProperties” and service group name as “Custom”
  • Select Option as “In a Synchronous Mode”
  • Add API from components tab and connect the start and end
  • Select Extended API radio button
  • API Name : ReadProperties
  • Class Name : com.oms94.util.PropertiesReaderDemo
  • Medthod Name : readProperties
  • Save

Test the program using API Tester

How to use API tester ?

Input to API Tester : <Hello />

API Tester Result : 

<Hello Option1=”E:/OMS/SearchIndex Option2=”Y Option3=”E:/OMS/SearchIndex Option4=”ActiveKite Option5=”Active Kite Test/>

If you have any question or suggestion please email to :

Questions from this topic

  1. OMS System allows to override only existing property values ? Answer : No. In this above example we had added new property
  2. Can we change the property value run time ? Answer : Yes if MODIFIABLE_AT_RUNTIME value is Y
  3. Does property  can be managed using database ? Answer : Yes if DATABASE_SUPPORT value is Y
  4. How to enable database property management ? Answer : sandbox.cfg file DATABASE_PROPERTY_MANAGEMENT=true
  5. Which database table holds the property name and value ? Answer : PLT_PROPERTY
  6. How to add or modify entry into database table ? Answer : manageProperty API or manageProperties command line script
  7. If property name available in database and file system which one value gets selected ? Answer : file system has priority over database

Hope this helps !!! Cheers. Happy Learning

Test your knowledge using our quiz page : install3rdparty.cmd

Register with us to get more updates

IBM OMS Sterling Interview Questions

12 thoughts on “Sterling OMS Overriding

    1. admin Post author

      Thanks lot Mayank Gaur for your nice words !!! Helps us to keep motivated. Thanks once again

    1. admin Post author

      Currently we don’t have onDemand video tutorials. We will work in this and keep you posted. Thank you.

  1. Priyanshi Jain

    The Information provided is very clear & I really appreciate the effort made for this information. Thank you !

  2. Priyanshi Jain

    Here are some more interesting points regarding the topic. Enjoy 🙂
    1. How to identify or create the Custom Property In database?
    Answer : We can pass PropertyType==”CUSTOM” in the manageProperty API Call
    and in PLT_PROPERTY table you can identify the custom property via PROPERTY_TYPE=’CUSTOM’.

    2. How can you load Properties into database and what is the benefit of it in real time scenarios or with On -Primise ?
    –> By running the loadProperties.cmd or script from /foundation/bin.
    –>This command line script loads all the default properties and factory values to the database. This tool reads tagged property files and converts them into XML format, which can be loaded to the database, conforming to the PLT_Property_Metadata and PLT_Property property tables.
    –>Benefits : The mechanism of handling properties via file based approach does not allow changes to properties at runtime. The JVMs must be restarted if you want to modify a property value. But in case of managing properties using DB , the db-cache mechanism is used to broadcast changes to property values to all live Sterling Order Management JVMs.
    And the restart of JVM’s is /App Server is not required. This approach help us in lots of time saving and debugging also becomes easy in lower environments.

  3. Neeraj Sharda

    Thanks for the same. Sure helps a lot.

  4. Irfan

    @admin @ Priyanshi As mentioned that file system as priority over db property vales then even if we update property values in db, how its gonna reflect?
    And how to use db-cache mechanism to broadcast changes to property values to all live Sterling Order Management JVMs.


Leave a Reply

Your email address will not be published. Required fields are marked *