Error Messages

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

Create the Exception class.

All exception classes must extend com.crm.exception.CRMValidationException. All exception methods should have a com.crm.exception.CRMValidationException object as an input parameter and use setMessage method of com.crm.exception.CRMException class

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.

AccountTerminationException.java

 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.

messages.xml

<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 the 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.

translation_eng.properties

<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>

InvalidAccountCreditPeriodException.java

package com.crm.exception.accounts;
import java.util.ArrayList;
import com.crm.businessobject.CRMSession;
import com.crm.exception.CRMValidationException;

public class InvalidAccountCreditPeriodException extends CRMValidationException {
    
    private static final long serialVersionUID = 1L;
    /**
     * Invalid Credit period %1 based on definition (%2 % 3).
     * 
     * @param crmSession - the session object
     * 
     * @param value1 - the first exception value
     * @param value2 - the second exception value
     * @param value3 - the third exception value
     * 
     * @throws Exception
     */
    public InvalidAccountCreditPeriodException(CRMSession crmSession, String value1, String value2, String value3) throws Exception {
        
        super();
        
        ArrayList<String> parameters = new ArrayList<String>();
        
        parameters.add(value1);
        parameters.add(value2);
        parameters.add(value3);
        try 
        {
            setMessage(this.getClass().getName().toUpperCase(), crmSession, parameters);
        } 
        catch (Exception e) 
        {
            e.printStackTrace();
        }
    }
}

Furthermore, the exception message should be defined in message metadata file with caps and the correct datapath as code whilst an expression and a description.

messages.xml

<messages>
...
	<message>
       <code>COM.CRM.EXCEPTION.ACCOUNTS.INVALIDACCOUNTCREDITPERIODEXCEPTION</code>
       <expression>key_com_crm_exception_accounts_invalidaccountcreditperiodexception</expression>
       <description>Invalid Credit period %1 based on definition (%2 % 3).</description>
    </message>
...
</messages>

Then, the key expression mentioned above has to create an entry key in the label page and define the exact error message that will be appeared on the screen as follows:

translation_eng.properties

...
<entry key="key_com_crm_exception_accounts_invalidaccountcreditperiodexception">Invalid Credit period %1 based on definition (%2 % 3).</entry>
...

Question Messages

In general, It is important to mention that question messages are implemented exclusively for interfaces. Thus, let see an example of creating a question message for post payments. Firstly, a method named postPaymentButton is constructed to call another method which will show the question message as follows. The nested method parses the class name of the function to be called if the Yes option is chosen. Then it passes the function, the code of the question message as it is defined in the messages metadata file and lastly the parameters of the message.

CRMUIPaymentBean.java

...

	/**
     * Posts payment. (Sets posted date, generates transaction number, performs allocations).
     * 
     * @param payment        a payment to post
     * @return                updated payment
     * @throws Exception
     */
    public CRMDOPayment postPaymentButton(CRMDOPayment payment) throws Exception {
        
		//parameters: interface class, function and question message
        showConfirmQuestion(
                "CRMUIPayment",
                "postPayment",
                "CONFIRM_FINANCIAL_TRANSACTION_SAVED_AS_POSTED",
                new String[]{"Payment"});
        
        return payment;
    }

...

Later on, we observe below, the method named showConfirmQuestion which is implemented in the CRMUI parent class, where the question object and options are defined and lastly the message is been showed.

showConfirmQuestion method

	/**
     * Displays a confirmation question on the UI with options Yes/No. 
     * If the Yes option is chosen then the specified function is called, otherwise it does nothing.
     * 
     * @param beanName - the class name of the function to be called if the Yes option is chosen
     * @param functionName - the name of the function to be called if the Yes option is chosen
     * @param questionCode - the code of the question message as it is defined in the messages metadata file
     * @param messageParameters - the parameters of the question message
     * @throws Exception
     */
    protected void showConfirmQuestion(String beanName, String functionName, String questionCode, String[] messageParameters) throws Exception {
        
        Question question = new Question(getCRMSession(),questionCode,messageParameters, getCRMSession().getRealPath(), getOrganisationID());
        
        QuestionOption optionA = new QuestionOption("Yes", beanName, functionName, new String[]{"[[getDTO]]"}, new String[]{"java.lang.Object"}, "replace", "read");
        QuestionOption optionB = new QuestionOption("No", beanName, "echoDto", new String[]{"[[getDTO]]"}, new String[]{"java.lang.Object"}, "replace", "read");
        
        question.addOption(optionA);
        question.addOption(optionB);
        
        showQuestion(question);
    }

Moreover, as in the previous example, the code of the question message must be defined in messages of metadata file whilst the expression key must also be mentioned in labels file as follows:

messages.xml

 	<message>
         <code>CONFIRM_FINANCIAL_TRANSACTION_SAVED_AS_POSTED</code>
         <expression>key_confirm_financial_transaction_saved_as_posted</expression>
         <description>Confirm Action</description>
    </message>

translation_eng.properties

 	<entry key="key_confirm_financial_transaction_saved_as_posted">%1 is going to be saved as Posted. Do you wish to continue?</entry>

Below, we can see the scenario with the payment post. The question message appears on the top of the screen and ask you if you want to continue and post the payment.

Question Message

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.

InfoMessage method

		InfoMessage infoMsg = new InfoMessage(getCRMSession(),
                "LOGOUT_INFO_MSG", 
                new String[]{"Payment"},
                getCRMSession().getRealPath(), 
                getOrganisationID());
        showInfoMessage(infoMsg);

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.

messages.xml

	<message>
        <code>LOGOUT_INFO_MSG</code>
        <expression>key_logout_info_msg</expression>
        <description>Logout to apply the changes</description>
    </message>

translation_eng.properties

	<entry key="key_logout_info_msg">Please logout and login again so the changes will be applied.</entry>

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

Warning Message

Implement messages

Error Messages

Question Messages

Warning Messages