Customization Application

Customization is a tool that is used to satisfy specific customer needs and to implement basic Billing functionality, for example, sorting of list elements, or changing a number of columns to be displayed. Billing containers may influence screens of other containers by generating customization files for their screens.

Customization changes a screen definition thus creating new screen definition. Each following customization changes screen definition resulted from previous changes. In other words, customizations are applied as layers. Some layers add something, other remove or change logic. Screens XML files are located in the ~bm/conf/wnd/ directory, on the bss-www pod. The directory contains default XML files. It can also contain directories with customized XML files copied from the /k8s_data/customization_bm/ directory of the bss-www pod's persistent storage. The customization file location defines its application priority. The following is the list of XML files locations in order of their application. Paths are given relative to the ~bm/conf/wnd/ directory.

Note: Currently, customizations can only be applied to BM container. UI of other containers cannot be customized.

1. dwcache/

   The directory contains source files of Billing dynamic screens. Such screens content highly depends on data stored in Billing database. For example, the General tab of an order. The screens are generated using application code every time when it is requested. The directory is erased, when the session ends. Any of directories described further may contain customization files for dynamic screens.

2. <container_name>/

   The directory contains source files of Billing static screens and customization files for dynamic screens.

3. <container_name>/customization/

   The directory contains customization files created by Billing developers to change original screen appearance for some reason. Also, this folder usually contains symlink to installation specific customization files. Customization files from this directory are applied first, then customization files from subdirectories that have customization name.

4. <container_name>/customization.<container_name>/

   The directory contains customization files created by Billing developers to change original screen appearance for some reason.

5. <container_name>/customization.<other_container_name_A>/

   The customization files are added automatically on the other_container installation. Customization files from this directory are applied first, then customization files from subdirectories that have customization name.

6. <container_name>/customization.<other_container_name_B>/

   The customization files are added automatically on the other_container installation. Customization files from this directory are applied first, then customization files from subdirectories that have customization name.

7. <container_name>/customization.<other_container_name_...>/
   and
   <container_name>/customization.<other_container_name_Z>/

   The customization files are added automatically on the other_container installation. Customization files from this directory are applied first, then customization files from subdirectories that have customization name.

8. <container_name>/customization_<vendor_ID>/*.xml

   The customization files that are in effect for customers of certain vendor (vendor_ID) only. For example, for customers of a reseller.

9. <container_name>/<user_ID>.customization/*.xml

   The customization files that are in effect for certain user (user_ID) only. Such customization files are generated automatically for screens that contain lists. Usually customization files appearance is initiated by user actions. For example, list elements sorting. These customization files are rewritten every time when a user performs some action with a list. We recommend that you store here only customizations for screens that do not contain lists. The files location is .

10. <container_name>/customization/*.xml

    The customization files from this folder are applied again to preserve system functionality. The customization files from the subdirectories are not applied at this time. If you create a customization for a screen from this folder, make sure that you do not change elements, actions or layout mentioned in these files, otherwise your changes are to be overwritten.

We will consider installation specific customizations further in this guide. Namely, customization files that are specific for certain installation. These files are created by the installation owner or Billing developers on the owner's request. Customization files of this type do not influence other Billing installations. The customization files must be located in the persistent storage of the bss-www pod, in the /k8s_data/customization_bm/customization/*.xml directory.