1 OBDX Component Extension

This topic provides information on OBDX Component Extension. This documentation will guide you on how to override existing OBDX components.

This documentation will guide you on how to override existing OBDX components.

Pre-requisites

• To override existing component, you need following artifacts
  • ViewModel
  • Html
  • Model (optional)
  • Resource bundle
  • Partial (optional)
• Every extensible component must have module name and unique component name within its module.

Steps

• If you want to add new component place that component in <CHANNEL_ROOT_PATH>/extensions/components. It follows the same structure which is present in components folder. Same thing is applicable for the existing components. If you want to change anything then copy that component and place it in extensions/components folder with the same structure.
• If framework component needs to be changed, place the new component code in extensions/components folder with same folder structure as in framework/<api/core> folder. For example, component present in framework/api should be available under extensions/components/api.
• If resource bundle needs to be changed for corresponding component, then place related resource bundle in <CHANNEL_ROOT_PATH>/extensions/resources location. Structure remains same for <CHANNEL_ROOT_PATH>/resources and <CHANNEL_ROOT_PATH>/extensions/resources folder.
• If you want to customize an existing flow, you need to make an entry of the flow in <CHANNEL_ROOT_PATH>/extensions/extension.json file against key “flows”. The customized flow should be present in the <CHANNEL_ROOT_PATH>/extensions/flows folder.

Please note all the components, flows, partials and resource bundles take priority to render. Means if file is present under the extension will be by default available for extension.