How to change default messages in OFBiz
Locked
 
|
Hi, I have created a doc on “How to change default messages in OFBiz”. Would anyone please suggest any improvement on it? The contents are included in this mail itself. --
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- How to change the default messages of OFBiz by Amitava Neogi [hidden email] The messages that come in different pages in OFBiz are configured using several configuration files. The best parts of message display framework under OFBiz are as follows: 1. It is totally internationalized. 2. Actual text messages are stored in configuration files only. This configuration files are written in XML.using property key value approach. The actual files like FTL files, service definition files which use these text messages refers to the property key and locale (optional) only to display the message in the output page. 3. You can hide the message by just clicking on it. No reloading is required. The main components of the message display framework in OFBiz are 1. messages.ftl under ofbiz/framework/common/webcommon/includes folder. It is responsible for displaying error and event message in a specific div on the top of the content area. 2. CommonUiLabels.xml under ofbiz/framework/common/config folder. This is a property key value configuration file for storing common UI label elements including error / event headers and messages. 3. CommonErrorUiLabels.xml under ofbiz/framework/common/config folder. This is a property key value configuration file for storing common error message elements. Beside these two configuration files there are at least one property key value configuration file under the config directory of the respective element for almost all elements like accounting, manufacturing, service, minilang etc. under the applications and framework directories. e.g. AccountingErrorUiLabels.xml, MiniLangErrorUiLabels.xml, ServiceErrorUiLabels.xml One important thing to notice here is that all UI labels in OFBiz are displayed in the same manner using the property key value XML configuration files available under the config directory. In some cases there are no separate error configuration files but the error messages are included in the UI label configuration file itself. e.g. in case of marketing component related error messages are included in the MarketingUiLabels.xml under ofbiz/applications/marketing/config folder. How to change a specific error message 1. First identify the module in which the message is coming. 2. If it is a common message then it would be in CommonUiLabels.xml or in CommonErrorUiLabels.xml 3. If it is a module specific message then look into the configuration files under the config folder of that component. 4. Identity the key and change the value in English language. If you presently want to change the English message only, then there is no need to do to anything else. However, if you want to update the internationalization part also then you need to do the following step for each language. 5 Now using a specific translation program like Google Language Tools, translate the English sentence into a specific language and copy paste that in the value for that specific language. 6. After the change is over you need to restart the server for the changes to take effect. The same procedure can be followed for changing the UI label elements. ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
Re: How to change default messages in OFBiz
Administrator
|
I had not chances to have a look at it, yet. I will answer you later...
Thanks for your effort Jacques ----- Original Message ----- From: Amitava Neogi To: [hidden email] Sent: Tuesday, March 15, 2011 12:47 PM Subject: How to change default messages in OFBiz Hi, I have created a doc on “How to change default messages in OFBiz”. Would anyone please suggest any improvement on it? The contents are included in this mail itself. Thanks and Regards, -- Amitava Neogi, Sr. Project Leader Soffront Software Pvt. Ltd. Webel STP-II, Block - DN, Plot- 53 Sector V, Salt Lake, Kolkata - 700091 Ph: +91-033-2367-3480 ext 235 www.soffront.com ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- How to change the default messages of OFBiz by Amitava Neogi [hidden email] The messages that come in different pages in OFBiz are configured using several configuration files. The best parts of message display framework under OFBiz are as follows: 1. It is totally internationalized. 2. Actual text messages are stored in configuration files only. This configuration files are written in XML.using property key value approach. The actual files like FTL files, service definition files which use these text messages refers to the property key and locale (optional) only to display the message in the output page. 3. You can hide the message by just clicking on it. No reloading is required. The main components of the message display framework in OFBiz are 1. messages.ftl under ofbiz/framework/common/webcommon/includes folder. It is responsible for displaying error and event message in a specific div on the top of the content area. 2. CommonUiLabels.xml under ofbiz/framework/common/config folder. This is a property key value configuration file for storing common UI label elements including error / event headers and messages. 3. CommonErrorUiLabels.xml under ofbiz/framework/common/config folder. This is a property key value configuration file for storing common error message elements. Beside these two configuration files there are at least one property key value configuration file under the config directory of the respective element for almost all elements like accounting, manufacturing, service, minilang etc. under the applications and framework directories. e.g. AccountingErrorUiLabels.xml, MiniLangErrorUiLabels.xml, ServiceErrorUiLabels.xml One important thing to notice here is that all UI labels in OFBiz are displayed in the same manner using the property key value XML configuration files available under the config directory. In some cases there are no separate error configuration files but the error messages are included in the UI label configuration file itself. e.g. in case of marketing component related error messages are included in the MarketingUiLabels.xml under ofbiz/applications/marketing/config folder. How to change a specific error message 1. First identify the module in which the message is coming. 2. If it is a common message then it would be in CommonUiLabels.xml or in CommonErrorUiLabels.xml 3. If it is a module specific message then look into the configuration files under the config folder of that component. 4. Identity the key and change the value in English language. If you presently want to change the English message only, then there is no need to do to anything else. However, if you want to update the internationalization part also then you need to do the following step for each language. 5 Now using a specific translation program like Google Language Tools, translate the English sentence into a specific language and copy paste that in the value for that specific language. 6. After the change is over you need to restart the server for the changes to take effect. The same procedure can be followed for changing the UI label elements. ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
Re: How to change default messages in OFBiz
|
Administrator
|
Thanks Amitava,
I put your howto in FAQ at https://cwiki.apache.org/confluence/display/OFBIZ/FAQ+-+Tips+-+Tricks+-+Cookbook+-+HowTo#FAQ-Tips-Tricks-Cookbook-HowTo-Howtochangethedefaultmessages Jacques Jacques Le Roux wrote: > I had not chances to have a look at it, yet. I will answer you later... > > Thanks for your effort > > Jacques > ----- Original Message ----- > From: Amitava Neogi > To: [hidden email] > Sent: Tuesday, March 15, 2011 12:47 PM > Subject: How to change default messages in OFBiz > > > > > Hi, > > I have created a doc on “How to change default messages in OFBiz”. > > Would anyone please suggest any improvement on it? > > The contents are included in this mail itself. > > > > > Thanks and Regards, > -- > Amitava Neogi, Sr. Project Leader > Soffront Software Pvt. Ltd. > Webel STP-II, Block - DN, Plot- 53 > Sector V, Salt Lake, Kolkata - 700091 > Ph: +91-033-2367-3480 ext 235 > > www.soffront.com > > > > > > > > > > > ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- > > How to change the default messages of OFBiz > by Amitava Neogi > [hidden email] > > The messages that come in different pages in OFBiz are configured using several configuration files. > The best parts of message display framework under OFBiz are as follows: > > 1. It is totally internationalized. > 2. Actual text messages are stored in configuration files only. This configuration files are written in XML.using property key > value approach. > The actual files like FTL files, service definition files which use these text messages refers to the property key and locale > (optional) only > to display the message in the output page. > 3. You can hide the message by just clicking on it. No reloading is required. > > The main components of the message display framework in OFBiz are > > 1. messages.ftl > under ofbiz/framework/common/webcommon/includes folder. > It is responsible for displaying error and event message in a specific div on the top of the content area. > > 2. CommonUiLabels.xml > under ofbiz/framework/common/config folder. > This is a property key value configuration file for storing common UI label elements including error / event headers and > messages. > > 3. CommonErrorUiLabels.xml > under ofbiz/framework/common/config folder. > This is a property key value configuration file for storing common error message elements. > > Beside these two configuration files there are at least one property key value configuration file under the config directory of > the respective element > for almost all elements like accounting, manufacturing, service, minilang etc. under the applications and framework directories. > e.g. AccountingErrorUiLabels.xml, MiniLangErrorUiLabels.xml, ServiceErrorUiLabels.xml > > One important thing to notice here is that all UI labels in OFBiz are displayed in the same manner using the property key value > XML configuration files > available under the config directory. In some cases there are no separate error configuration files but the error messages are > included in the UI label configuration file itself. > e.g. in case of marketing component related error messages are included in the MarketingUiLabels.xml under > ofbiz/applications/marketing/config folder. > > > How to change a specific error message > > 1. First identify the module in which the message is coming. > 2. If it is a common message then it would be in CommonUiLabels.xml or in CommonErrorUiLabels.xml > 3. If it is a module specific message then look into the configuration files under the config folder of that component. > 4. Identity the key and change the value in English language. > > If you presently want to change the English message only, then there is no need to do to anything else. > However, if you want to update the internationalization part also then you need to do the following step for each language. > 5 Now using a specific translation program like Google Language Tools, translate the English sentence into a specific language > and copy paste that in the value for that specific language. > > 6. After the change is over you need to restart the server for the changes to take effect. > > The same procedure can be followed for changing the UI label elements. > > > > ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
Thank you Jacques. Nice to see it. On Sat, Mar 26, 2011 at 4:16 PM, Jacques Le Roux <[hidden email]> wrote: Thanks Amitava, --
|
«
Return to OFBiz - User
|
1 view|%1 views
| Free forum by Nabble | Edit this page |