SAP Error Codes

The SAP native error codes during its integration with other technologies are always difficult to understand.. Here is a possible list of standard SAP Error Codes

/**********************************************************************/

/* Standard error codes.                                              */

/**********************************************************************/

   SAP_O_K     (ECode)0      /* Ok */

   MYSAP_NO_USER      (ECode)1      /* No user provided to function  */

   MYSAP_BUFFER_TOO_SMALL   (ECode)3      /* Provided buffer too small */

   MYSAP_EXPIRED               (ECode)4      /* Ticket expired */

   MYSAP_INVALID               (ECode)5      /* Ticket syntactically invalid */

   MYSAP_BUFFER_TOO_SMALL_USER (ECode)6      /* provided buffer too small  */

   MYSAP_NO_COOKIE       (ECode)8      /* no ticket provided to function */

   MYSAP_INTERNAL_ERROR    (ECode)9      /* Internal error */

   MYSAP_HDLNOTINITIALIZED     (ECode)10     /* API is not initialized*/

   MYSAP_NO_MEMORY        (ECode)11     /* malloc failed*/

   MYSAP_WRONG_ACTION    (ECode)12     /* wrong action */

   MYSAP_FUNCPOINTERNULL   (ECode)13     /* tried to call NULL p. function*/

   MYSAP_SECTK_RELATED     (ECode)14     /* Error occured in security tk  */

   MYSAP_NULL_POINTER     (ECode)15     /* pointer was NULL */

   MYSAP_NO_MORE_CONTENTS    (ECode)16     /* incomplete information .  */

   MYSAP_NO_CERTIFICATE   (ECode)17     /* couldn't get certificate */

   MYSAP_RESERVED_ID     (ECode)18     /* reserved */

   MYSAP_MISSING_AUTH    (ECode)19     /* missing authentication */

   MYSAP_VERIFY_FAILED    (ECode)20     /* Signature couldn't be verified*/

   MYSAP_WRONG_VERSION    (ECode)21     /* Ticket too new for lib*/

   MYSAP_CP_CONVERSION    (ECode)22     /* Conversion error*/


/**********************************************************************/

/* SSF error codes.                                                   */

/**********************************************************************/

#SSF_API_OK                    0  /*operation ok            */

#SSF_API_NOSECTK               1  /no security toolk. found/

#SSF_API_INVALID_FORMAT        2  /*unknown wrapper format  */ 

#SSF_API_NODATA                3  /*input data length zero  */

#SSF_API_NOMEMORY              4  /*insuff. main memory     */

#SSF_API_SIGNER_ERRORS         5  /*there are signer errors */             

#SSF_API_NORESULTLISTMEMORY    6  /no memory f. result list/            

#SSF_API_UNKNOWN_PAB           7  /Priv.Addr.Book not found/            

#SSF_API_INVALID_PAB_PASSWORD  8  /*invalid PAB password    */            

#SSF_API_RECIPIENT_ERRORS      9  /*there are recip. errors */            

#SSF_API_INVALID_MDALG         10 /*unknown MD algorithm    */

#SSF_API_ENCODE_FAILED         11 /*could not encode output */

#SSF_API_DECODE_FAILED         12 /*could not decode input  */

#SSF_API_UNKNOWN_SECTK_ERROR   13 /unknown sec.toolk. error/
/**********************************************************************/
/* SSF Aux Function Return Codes -
/**********************************************************************/



#SSF_AUX_OK                    0 /* function ended successfully*/

#SSF_AUX_NOMEMORY             51 /* no more memory output data */

#SSF_AUX_NOSIGRCPID           52 /* signer/recip. id is empty  */

#SSF_AUX_NOSIGRCPINFO         53 /* signer/recipient info empty*/

#SSF_AUX_NOSIGRCPINFOLIST     54 /* sig./recip. info list empty*/


/**********************************************************************/
/* Signer and Recipient result codes -

*/

/*                     - used in uResult component of a signer or  */

/*                       recipient security information structure  */
/**********************************************************************/

#SSF_API_SIGNER_OK          0 /* operation ok for signer    */

#SSF_API_RECIPIENT_OK       0 /* operation ok for recipient */

#SSF_API_PROFILE_LOCKED    21 /* security profile is locked */

#SSF_API_UNKNOWN_SIGNER    22 /* unknown signer             */            

#SSF_API_UNKNOWN_RECIPIENT 22 /* unknown recipient          */

#SSF_API_UNKNOWN_PROFILE   23 /* security profile not found */             

#SSF_API_INVALID_PROFILE   24 /* security profile not usable*/             

#SSF_API_INVALID_PASSWORD  25 /* invalid password for signer*/            

#SSF_API_NOCERTIFICATE     26 /* certificate not found      */

#SSF_API_SIGNER_NOT_OK     27 /* signature invalid          */

#SSF_API_RECIPIENT_NOT_OK  27 /* operation not ok f. recip. */

#SSF_API_UNDEFINED_RESULT  28


 

Form re submission of/on Page Reload Errror

The property 'action-url-redirect' must be added to the liferay-portlet.xml file. This will not allow the form to be re submitted once the page is refreshed after a form submission is already done.


<action-url-redirect>true</action-url-redirect>

By default the property is false and thus the form resubmission occurs

Display error and success messages in liferay

Error Display Many times we need to display the errors messages or the success messages on the jsp pages.The way it is done is the following. Add the following the your implementation of processAction.
 //for Errors 
    com.liferay.portal.kernel.servlet.SessionErrors.add(portletRequest, "unique-error-key"); 
//for Messages 
    com.liferay.portal.kernel.servlet.SessionMessages.add(portletRequest, "unique-message-key"); 
or In Language_xx.properties add your custom message in this file like this
unique-message-key2="Success"

 TO display them in your jsp use this: <!--taglib--> <%@ taglib uri="http://liferay.com/tld/ui" prefix="liferay-ui" %> <!--for Errors--> <liferay-ui:error key="unique-error-key" message="ErrorMessage"> <!--for Messages--> <liferay-ui:success key="unique-message-key" message="Success Message"> <!--for displaying messages from the language_xx.properties--> <liferay-ui:success key="unique-message-key2">

Running liferay script on control Panel Script console

Liferay has a script console at the Control Panel. It is accessible to the Liferay administrator. In the Script console Liferay API code , and other various code can be run seamlessly.

The script console is located at

ContolPanel --> Server --> Server Administration. 

 Here are few examples of codes run in the console and screenshot of the output. Most of the  codes were run here by selecting the Language as "Groovy".

Example 1.  Get list of users

Language : Groovy
code:

import com.liferay.portal.service.UserLocalServiceUtil;

userCount = UserLocalServiceUtil.getUsersCount();
users = UserLocalServiceUtil.getUsers(0, userCount);
count=0;
for (user in users) {
    count++;
    println(count+". User: " + user.getFullName());

}




































Example 2.  Get list of roles supported be the portal.


Language : Groovy
code:

import com.liferay.portal.service.RoleLocalServiceUtil;

roleCount =RoleLocalServiceUtil.getRolesCount();
roles=RoleLocalServiceUtil.getRoles(0,roleCount );

for(role in roles){
    println("Role Name: " + role.getName());
}

Example 3.  Get number of users in the portal . (using Javascript as language default script)
Language : Javascript
code:

number = Packages.com.liferay.portal.service.UserLocalServiceUtil.getUsersCount();

out.println(number);

How to Remove default Success Message your-request-completed-successfully

There are several ways to remove the message from displaying.


To remove the display use any of the following mentioned approach:

1. Remove entirely from a Portlet :
 Add this init param to your portlet.xml:
<init-param> <name>add-process-action-success-action</name> <value>false</value> </init-param>

2. Remove  from specific  Portlet actions:
Add this to your implementation of processAction method.

SessionMessages.add(actionRequest, 

(LiferayPortletConfig)portletConfig.getPortletName()+ 

SessionMessages.KEY_SUFFIX_HIDE_DEFAULT_SUCCESS_MESSAGE);

3.Using Hook for HOOK for html\common\themes\ portlet_messages.jspf

a) remove the message display from all the portlets.

<div class="portlet-msg-success"> <%String successMessage = (String)SessionMessages.get(renderRequest, "request_processed");%> <c:choose> <c:when test='<%= Validator.isNotNull(successMessage) && !successMessage.equals("request_processed") %>'> <%= HtmlUtil.escape(successMessage) %> </c:when> <c:otherwise> <liferay-ui:message key="your-request-completed-successfully" /> </c:otherwise> </c:choose> <c:if test="<%= themeDisplay.isStatePopUp() && SessionMessages.contains(renderRequest, portlet.getPortletId() + SessionMessages.KEY_SUFFIX_CLOSE_REDIRECT) %>"> <%String taglibMessage = "class=\"lfr-hide-dialog\" href=\"javascript:;\"";%> <liferay-ui:message arguments="<%= taglibMessage %>" key="the-page-will-be-refreshed-when-you-close-this-dialog.alternatively-you-can-hide-this-dialog-x" /> </c:if> </div>

Comment out the lines , then the message will not be displayed for any of the portlets in Liferay at all.

b) remove the message display from specific portlets.

  create a hook and edit the portlet_messages.jspf file. Use the portletId to show/hide the message display. As shown

  <c:otherwise> <% ThemeDisplay themeDisplay = (ThemeDisplay) request.getAttribute( WebKeys.THEME_DISPLAY ); PortletDisplay portletDisplay= themeDisplay.getPortletDisplay(); String strPortletId= portletDisplay.getId(); //update the code to hide message error display if(!strPortletId.equals("<<enter portlet id of your portlet>>") ) {%> <liferay-ui:message key="your-request-completed-successfully" /> <%}%> </c:otherwise>

4. Masking with Custom Message in Portlet : Change that message key in your portlet's language.properties file with your custom text. Like, in the language_en.properties file for your custom portlet. add the custom message to the key:

 your-request-processed-successfully=Success! Process completed with no Errors. 

How to remove the message you-have-entered-invalid-data

There are several ways to remove the message from displaying. This message is present in the portal at the following path :-

   html\taglib\ui\error\end.jsp   

<c:when test="<%= key == null %>"> <c:if test="<%= !SessionErrors.isEmpty(portletRequest) %>"> <div class="portlet-msg-error"> <liferay-ui:message key="your-request-failed-to-complete" /> </div> <%= rowBreak %> </c:if> </c:when>

To remove the display use any of the following mentioned approach:

1. Using HOOK for all portlets :create a hook and edit the end.jsp file. In which you can comment out the lines , then the message will not be displayed for any of the portlets in  Liferay.

2. Using HOOK for specific portlet: create a hook and edit the end.jsp file. Use the portletId to show/hide the message display.


 
ThemeDisplay themeDisplay = (ThemeDisplay) request.getAttribute( WebKeys.THEME_DISPLAY ); PortletDisplay portletDisplay= themeDisplay.getPortletDisplay(); String strPortletId= portletDisplay.getId(); //update the code to hide message error display <c:when test="<%= key == null %>"> <c:if test="<%= !SessionErrors.isEmpty(portletRequest) %>"> <% if(!strPortletId.equals("<<enter portlet id of your portlet>>") ) {%> <span class="portlet-msg-error"> <liferay-ui:message key="you-have-entered-invalid-data" /> </span> <%}%> <%= rowBreak %> </c:if> </c:when>

3. Masking with Custom Message in Portlet :
Change that message key in your portlet's language.properties file with your custom text.
Like, in the language_en.properties file for your custom portlet. add the custom message to the key:

   you-have-entered-invalid-data=Server Error: Please try again. 

4. Using CSS property:
Hook the file end.jsp (at html\taglib\ui\error\end.jsp ) with a surrounding CSS.

<div class="portlet-msg-error-invalid-data-show-hide"> <liferay-ui:message key="you-have-entered-invalid-data"></liferay-ui:message> </div>
in the custom CSS of your portlet add

   .portlet-msg-error-invalid-data-show-hide{
     display : none;
   }

You are not allowed to use this program (crontab)

The crontab command used in unix sometimes shows the following error.

crontab -e
You (UnixUser) are not allowed to use this program (crontab)
See crontab(1) for more information

The system checks cron.allow file for allowing the user to use the crontab command. So, just add the user to the crontab.allow using the following command.

[UnixUser~]$ su
Password:
[root UnixUser]# echo UnixUser> /etc/cron.allow

Cron is driven by a crontab (cron table) file, a configuration file that specifies shell commands to run periodically on a given schedule.

XML Validation in Liferay

The property 'xml.validation.enabled' must be added to the Portal-ext.properties file.

If set false,

xml.validation.enabled=false

The xml files won't be validated inside the liferay. In some cases,where the xml,DTD ..etc files are kept external. This property can be used to avoid the validation errors.

Enable Transactional cache in Liferay

The property 'transactional.cache.enable' must be added to the Portal-ext.properties file.
If set true,

transactional.cache.enable=true

cache updations are done when transactions commit successfully to the database. Also, on  transactions rollback caches rolledback. This can be sometimes performace blocker.

RSS Portlet Connection Timeout

The property 'rss.connection.timeout' must be added to the Portal-ext.properties file.
Set the timeout in milliseconds like,
rss.connection.timeout=2000
This makes the RSS reades wait untill 2 seconds for reading the RSS feeds before timeout.

Show / Hide Lookand Feel Icon on a Liferay portlet

The property 'portlet.css.enabled' must be added to the Portal-ext.properties file.

If made true,

portlet.css.enabled=true

# shows the 'Look and Feel' icon on the portlet titlebar. Enabling the user to edit it.This is default.

If made false,

portlet.css.enabled=false

# hides the 'Look and Feel' icon on the portlet titlebar . Disabling it can speed up the portal performance.

How to get the current logged in user in liferay

There are more than one way to do this. Let's look at some of the options available.

1. User user = (User) request.getAttribute(WebKeys.USER);
   The User class is the Liferay's model User class.
   
   
2. ThemeDisplay td  = (ThemeDisplay) request.getAttribute( WebKeys.THEME_DISPLAY );
   User user = td.getUser();
   
   This ' ThemeDisplay 'class can be used to get various information about the portal page,user and theme. Classes ThemeDisplay, User and WebKeys are available in portal-service.jar
   
   
3. User currentUser = PortalUtil.getUser( request );
   
   The 'PortalUtil' has various utility functions , which come handy during Liferay Programming. This is also a part of the Portal-service.jar.
   
   
4. LiferayFacesContext liferayFacesContext = LiferayFacesContext.getInstance();
   User currentUser=liferayFacesContext.getUser();
   
   The class 'PortalFacesContext' has been renamed to 'LiferayFacesContext'.This class exists in order to assist with migrating old JSF 1.2 based projects from the legacy PortletFaces-Tools project to the new LiferayFaces project.
   
   Hope It helps you in your portal programming. Happy Coding :)