Versions Compared

Old Version 18

changes.mady.by.user Jacques Le Roux

Saved on

compared with

New Version 19

changes.mady.by.user Pranay Pandey

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

There are certain patches those you will only need to apply on staging box or only need to apply in production thats why we need to have different directories managed like above to differentiate properly and to avoid any confusion, when it comes to take system from testing to production environment. eg. two different baseUrl should be needed in content.properties file for these two different instances.

 

Applying a Patch

...

  1. Applying a patch is again a thing can be done from eclipse or from console.
  2. Always apply a patch from OFBiz root directory.
  3. In eclipse click on OFBiz root directory and got to Team --> Apply Patch, just browse the path to patch file and follow the instructions.
  4. If the changes are in the patch are already there in files being patched then it will show you conflicts in the file which should be resolved before applying the patch.

  5. For applying a patch from console use following command from OFBiz root directory:

    Code Block
    patch -p0 < [patch file path]
  6. While applying the patch if there is a conflict then system will prompt you to either postpond or continue patching, follow the instructions.
  7. Once the patch is applied you don't need to apply it again until you replace the patched file from source repository or there are conflicts. In case of conflicts you need to update the patch file and apply it again.

Extending an Existing webapp Only

If you only need to change a few things such then follow the instructions How to Extend an existing component in customized application 

Extending an Existing Component

 

Note

You will find redundancy in the info you got from last point where you saw how to extend an existing webapp. Creating a new custom component for extending OOTB application is required in certain cases where there are heavy customization to be made and code to be kept manageable. You can take any of the approach that you find better. Both works good.

 If a large set of code needs to be added or changed in a a specific component in an existing OFBiz OOTB component where you will need to add more new entities, services, screens, forms etc. then this strategy should can be adopted and complete component should can be overridden in hot-deploy directory, by creating a new component.

Following steps need to be performed for overriding an existing component:

  1. Create custom component in hot-deploy directory by any name as you want to override, its just going be replica of existing OOTB OFBiz component structure with all the major directories and files required for setting up a component.
  2. You can use ant create-component target on OFBiz root directory to create this component in hot-deploy directory.
  3. Only those files need to be added which you need to have in overriding the component, webapp. Rest of the resources are going to be used from OOTB component so if you have used ant create-component target then you can safely delete some of the files like e.g. if you are not going to write a service then services.xml file can be deleted, or if you are not going to add or extend an existing entity then you can delete entitymodel.xml file and their entries from ofbiz-component.xml file of custom component.
  4. Basically this is the thin line between extending a webapp and a component. If you are going to have major changes in services and entities then creating a new component should be preferred where you will be extending the existing webapp.
  5. e.g. If you want to have a separate component for adding or extending existing functionalities from catalog application which is a webapp in product component then you can have component in hot-deploy dir by extending the catalog webapp from product component.
  6. Follow these steps:

    1. Make sure to properly override the webapp in ofbiz-component file of custom component as example given below:

      Code Block
      <webapp name="catalog"
    title="Catalog"
    server="default-server"
    location="webapp/catalog"
    base-permission="OFBTOOLS,CATALOG"
    mount-point="/catalog"
    app-bar-display="true"/>

    2. Make sure to make entries of custom service defs(if-any), entity defs(if-any) and data files(if-any) in ofbiz-component file of custom component as example given below:

      Code Block
      <entity-resource type="model" reader-name="main" loader="main" location="entitydef/entitymodel.xml"/>
<entity-resource type="data" reader-name="seed" loader="main" location="data/*TypeData.xml"/>
<service-resource type="model" loader="main" location="servicedef/services.xml"/>
    3. Make sure to have same web.xml file from existing webapp.
    4. You can have new main-decorator defined for screens in webapp so if this is the case this needs to be changed in web.xml.

    5. Make sure to have controller.xml file in new webapp created and include the the controller from existing webapp and only include custom requests only rest will be taken care by included controller only, as shown bellow:

      Code Block
      <include location="component://product/webapp/catalog/WEB-INF/controller.xml"/>
    6. Make sure to have error.jsp inside extended webapp.
    7. Make sure to have index.jsp file with redirect path.

...

And last but not least, if you want to quickly get rid of the changes done using build-dev you can rely on revert-dev.

Extending an Existing webapp Only

If you only need to change a few things such then follow the instructions How to Extend an existing component in customized application