Configuring custom OMS properties

You can add, edit, and remove environment‑specific key‑value properties in Self Service. Self Service stores properties in a vault and injects them into OMS pods at startup. All changes display in the Self Service audit log.

Before you begin

  • Confirm that your role is either organization administrator, developer, or production developer.
  • Identify the target organization and environment.
  • Plan property names and values. Use dot‑delimited names for clarity (for example, yfs.paypal.url).

About this task

You manage properties for a single environment one at a time. Properties apply at runtime after pods restart.

Procedure

  1. Open Self Service.
  2. From the side navigation, select your organization, then select Environment Preferences.
  3. Select the target environment to open the environment details.
  4. In the side navigation, select Custom properties.
    The Custom properties table shows the existing key-value pairs.
  5. Click Add property.
  6. In the Property name field, enter the key.
    For example, enter yfs.paypal.url. Make sure that property names are unique for the environment. To group related properties, use consistent prefixes. For example, yfs.paypal.*, yfs.visa.*.
  7. In the Value field, enter the property value and click Save.
    For example, enter https://test1.com. The table displays the new property.
  8. Optional: To edit a property, in the row, click Edit, change the value, and click Save.
  9. Optional: To delete a property, in the row, click Remove, and confirm the deletion.
  10. From the notification about unsaved property changes, select the property changes to apply and click Create request.
  11. Enter the business justification for the request and click Submit.
    The approval request is displayed in the Request tab. Then, an Organization Administrator approves or rejects the request based on the organization policies. After the Organization Administrator approves the request, it takes a few minutes to take effect.
  12. To load the latest properties from the vault, restart the affected OMS pods.

Results

  • Self Service stores the properties in the vault for the selected environment.
  • The audit log records all changes.
  • On the next pod startup, OMS reads the properties and applies them at runtime.

What to do next

  • Verify that the property appears in the Custom properties table.
  • Check the audit entries to view the recorded event or change history.
  • After the pods restart, confirm that the customization reads the expected value.