Error Messages

In order for an error message to appear on screen, a java exception must be created and thrown.  

1. Create the Exception class. 

   ...

   1. 1. All exception classes must extend com.crm.exception.CRMValidationException. 
      2. All exception methods should have

   ...

   1. 1. a com.crm.exception.CRMValidationException object as an input parameter and use setMessage method of com.crm.exception.CRMException class

   ...

    

   ...

   1. 1. .
         1. To create the exception method:
            1. Use com.crm.businessobject.CRMSession object as an input parameter and any other String input parameters needed.
            2. Put all String input parameters in a String ArrayList.
            3. Use setMessage method of com.crm.exception.CRMException class to construct the exception message.

   Code Block
   language java title AccountTerminationException.java collapse true
   public class AccountTerminationException extends CRMValidationException { /** * You are not allowed to terminate the Accounts Receivable %1. This is only allowed for Active or Suspended accounts. * * @param crmSession - the session object * @param value - the exception value * @throws Exception */ public AccountTerminationException(CRMSession crmSession, String value) throws Exception { super(); ArrayList<String> parameters = new ArrayList<String>(); parameters.add(value); try { setMessage(this.getClass().getName().toUpperCase(), crmSession, parameters); } catch (Exception e) { e.printStackTrace(); } } }

         2. Define the exception in the messages.xml file. Use a unique key for the expression tag.  For more information on customising messages metadata, go to Customize Messages Metadata.

   Code Block
   language xml title messages.xml collapse true
   <messages> <message> <code>COM.CRM.EXCEPTION.ACCOUNTS.ACCOUNTTERMINATIONEXCEPTION</code> <expression>key_com_crm_exception_accounts_accountterminationexception</expression> <description>You are not allowed to terminate the accounts receivable. This is only allowed for Active or Suspended accounts.</description> </message> . . . </messages>

         3. Define the exception in English translation properties file, by using the expression tag key defined in metadata messages file as the entry key, and specifying the exception message. Use %<number> where the input parameters should be placed. Note that <number> is their index+1 in parameters array list.

   Code Block
   language xml title translation_eng.properties collapse true
   <properties> <entry key="key_com_crm_exception_accounts_accountterminationexception">You are not allowed to terminate the accounts receivable %1. This is only allowed for Active or Suspended accounts.</entry> . . . </properties>

   ...

   Code Block
   theme Eclipse language java title InvalidAccountCreditPeriodException.java collapse true
   public void validateTermination(CRMDOAccountReceivable account) throws Exception, AccountTerminationException{ if (account.getLifeCycleState()==null || (!account.getLifeCycleState().equals(AccountReceivableLifeCycleState.ACTIVE) && !account.getLifeCycleState().equals(AccountReceivableLifeCycleState.SUSPENDED))) { throw new AccountTerminationException(getCRMSession(), account.getNumber()); } ... }

   Question Messages

   ...

   Expand
   title Question Message

   ...

         3. Define the question code in metadata messagesin metadata messages file.

   Code Block
   theme Eclipse language java title messages.xml collapse true
   <message> <code>CONFIRM_FINANCIAL_TRANSACTION_SAVED_AS_POSTED</code> <expression>key_confirm_financial_transaction_saved_as_posted</expression> <description>Confirm Action</description> </message>

         4. Define the question in the English translation properties file, by using the expression tag key defined in metadata messages file in metadata messages file as the entry key, and specifying the question message. Use %<number> where the message parameters should be placed. Note that <number> is their index+1 in message parameters array list.

   Code Block
   theme Eclipse language java title translation_eng.properties collapse true
   <entry key="key_confirm_financial_transaction_saved_as_posted">%1 is going to be saved as Posted. Do you wish to continue?</entry>

   Warning Messages

   The last example is about showing warning messages and as previously the same procedure is been followed. The following example constructing a warning message about the license on its interface class. Firstly, an InfoMessage object is created and some parameters are parsed. The first parameter is the crmSession, second the code of the message, third are some message parameters, then the path of the session and the organization id as follows. Lastly, the showInfoMessage method is called to demonstrates the warning message on the screen by parsing the message details.

   ...

   Informational Messages

   Expand
   title Informational Message
   Image Added

   In order for n informational message to appear on screen, you have to 

   1. Create an instance of com.crm.process.InfoMessage object, defining the session, message code, message parameters, session real path, and organisation id as shown below.
   2. Use showInfoMessage method of com.crm.process.CRMUI class to display the message on screen.

   Code Block
   theme Eclipse language java title InfoMessage saveGeneralSetting method collapse true
   /** InfoMessage infoMsg* =Saves new InfoMessage(getCRMSession(), "LOGOUT_INFO_MSG", a general setting. * * @param generalSetting - the general setting to save * @return the saved general setting * @throws Exception */ public GeneralSetting saveButton(GeneralSetting new String[]{"Payment"}, generalSetting) throws Exception { systemSettingBean.validateGeneralSettings(generalSetting); getCRMSession().getRealPath(), systemSettingBean.saveGeneralSettings(generalSetting); InfoMessage infoMsg=new InfoMessage(getCRMSession(),"LOGOUT_INFO_MSG", null, getCRMSession().getRealPath(), getOrganisationID()); showInfoMessage(infoMsg); return generalSetting; }

    

   Once again, the code of the warning message must be defined in messages of metadata file whilst the expression key must also be mentioned in labels file, as follows.

          3. Define the message code in metadata messages file.

   Code Block
   theme Eclipse language java title messages.xml collapse true
   <message> <code>LOGOUT_INFO_MSG</code> <expression>key_logout_info_msg</expression> <description>Logout to apply the changes</description> </message>

         4. Define the message in the English translation properties file, by using the expression tag key defined in metadata messages file as the entry key, and specifying the question message. Use %<number> where the message parameters should be placed. Note that <number> is their index+1 in message parameters array list.

   Code Block
   theme Eclipse language java title translation_eng.properties collapse true
   <entry key="key_logout_info_msg">Please logout and login again so thethat changes will be applied.</entry>

    

   Then, on the following screen is illustrated the warning message, when a field is been changed.

    

   Expand
   title Warning Message
   Image Removed

    

   ...