Custom OMS properties

Custom OMS properties are environment‑specific key‑value pairs that Self Service stores in a vault and injects into IBM Sterling® Order Management System (OMS) pods at startup. Custom OMS properties provide a controlled way for you to externalize runtime configuration without modifying the OMS database. You can use custom properties to support integrations, payments, and your customizations that require environment‑specific values.

Who uses custom properties

Administrators, developers, and production developers who manage environment configuration in Self Service use custom properties. One of the following roles is required:
  • Organization Administrator
  • Developer
  • Production Developer
Access is scoped to the selected organization and environment.

Why use custom properties

Custom properties help enable:
  • Separation of configuration and code. Change behavior without redeploying.
  • Environment isolation. Keep development, test, and production values separate.
  • Auditable changes. Records every add, update, and delete by Self Service.
  • No database customization. Avoid direct updates to OMS tables.

How custom properties work

  1. You define key‑value pairs in Self Service for a specific environment.
  2. Self Service stores the properties in a vault as part of the OMS configuration.
  3. OMS pods read the properties from the vault during startup.
  4. OMS applies the properties at runtime and does not persist them in the database.
  5. Customizations can reference the properties as standard OMS properties.
Note: Property updates are picked up on pod restart.

When to use custom properties

You can use custom properties to support integrations, payments, and your customizations that require environment‑specific values.

Use custom properties for configuration that varies by environment and must be available at runtime, including:
  • External service endpoints (for example, payment, tax, fraud)
  • Integration identifiers and routing hints
  • Feature flags and tuning parameters
  • Values read by OMS customizations

Example

A customer defines payment endpoints as custom properties:
1 yfs.paypal.url = https://test1.com
2 yfs.visa.url.1 = https://test2.com
3 yfs.visa.url.2 = https://test3.com
Pods load these values at startup. Customizations read the properties to call the correct endpoint for the environment.

Limitations

  • Properties are evaluated at pod startup. Restart pods to apply changes.
  • Property names must be unique within the environment.
  • Custom properties are not stored in OMS database tables.

Auditing

Self Service writes an audit event for every add, update, and delete action, including the actor, timestamp, environment, and property keys affected.