Skip to Content

As a SAP manufacturing visualization platform, SAP MII is growing day by day and nowadays SAP MII with SAPUI5 integration is becoming a major factor to offer rich user interfaces for the business end user. SAPUI5 is nothing but client side web UI library which includes lots of simple or complex UI controls. And among them “sap.ui.commons.Carousel” is one of the complex controls which can be use to show updated information for different purpose:-

  • Defect Status
  • Current Notification
  • Current Stock Status
  • KPI Trend
  • Replacement of iTicker  etc. These are the overview of few areas where Carousel can be much useful.


You can find some useful examples and API of Carousel at the following link:

Examples           :  https://sapui5.hana.ondemand.com/sdk/#test-resources/sap/ui/commons/Carousel.html

API                   :  https://sapui5.hana.ondemand.com/sdk/#docs/api/symbols/sap.ui.commons.Carousel.html

SAP provides very good standard method for Carousel UI. But, there is a functionality which is missing in “sap.ui.commons.Carousel” API. That is

  • Auto Loop: Auto rotation of the Carousel component.
    • Set Auto Timer Loop
      • Configurable option to show carousel next or previous component.
      • Configuration option to set timer for auto loop.
    • Start Auto Loop
    • Stop Auto Loop

So, without wasting the valuable project time to find the alternative solution if you follow below solution which can save your time. In below example I have created a custom utility code “CarouselUtilities.js” for sap.ui.commons.Carousel which offer Auto-Loop functionality along with custom start-stop control and can be pluggable to any code whenever required.

Project Structure :-

Test.png

index.html :-


<!DOCTYPE HTML>

<html>

<head>

<meta http-equiv=”X-UA-Compatible” content=”IE=edge”>

<meta http-equiv=”Cache-Control” content=”no-cache”>

<script src=”/…/resources/sap-ui-core.js” id=”sap-ui-bootstrap”

            data-sap-ui-libs=”sap.ui.commons, sap.ui.core”

            data-sap-ui-theme=”sap_platinum”>

</script>

<script src=”/…/Bibhas/UI5/WebContent/CarouselUtilities.js” type=”text/javascript”></script>

<script>

            jQuery.sap.registerModulePath(“WebContent”, “/…/Bibhas/UI5/WebContent”);

            var view = sap.ui.view({

                        id : “dbUI5”,

                        viewName : “WebContent.test”,

                        type : sap.ui.core.mvc.ViewType.JS

            });

            view.placeAt(“content”);

</script>

</head>

<body class=”sapUiBody” role=”application”>

<div id=”content”></div>

</body>

</html>

test.view.js :-


sap.ui.jsview(“WebContent.test”, {

    getControllerName : function() {

           return “WebContent.test”;

    },

    createContent : function(oController) {

                       

           // Step-1: Create a new carousel instance  >>>>>

           var oCarousel_Trend = new sap.ui.commons.Carousel();

           oCarousel_Trend.setVisibleItems(4);

           oCarousel_Trend.setOrientation(“horizontal”);

           oCarousel_Trend.setWidth(“100%”);

           // Step-2: Create a new JSON model instance loaded with data >>>>>

           var oModel = new sap.ui.model.json.JSONModel();

           oModel.loadData(“/XMII/Illuminator?QueryTemplate=Default/Bibhas/QueryTemplates/XAC_RetrieveDefectDetails&Content-Type=text/json”, “”, false);

 

           // Step-3: Set the model into global level  >>>>>

           sap.ui.getCore().setModel(oModel);

           // Step-4: On the basis of model data create component for Carousel >>>>>

           var defectData = oModel.getProperty(“/Rowsets/Rowset/0/Row”);

           for (var i = 0; i < defectData.length; ++i) {

                       

                 // Step-4A: Retrieve value from model >>>>>

                 var prodName = defectData[i].product;

                 var defectStatus = defectData[i].status;

                 var defectTrend = defectData[i].trend;

                 var defectPercentage = defectData[i].percentage;

                 // Step-4B: Apply logic for status image >>>>>

                 var statusIMG = “”;

                 if (defectStatus == ‘Green’) {

                      statusIMG = “<img src=\”/…/Bibhas/UI5/Images/green.png\” alt=’OK’>”;

                 } else if (defectStatus == ‘Yellow’) {

                      statusIMG = “<img src=\”/…/Bibhas/UI5/Images/yellow.png\” alt=’Warning’>”;

                 } else {

                      statusIMG = “<img src=\”/…/Bibhas/UI5/Images/red.png\” alt=’Problem’>”;

                 }

                 // Step-4C: Apply logic for trend image >>>>>

                 var trendIMG = “”;

                 if (defectTrend == ‘Up’) {

                       trendIMG = “<img src=\”/…/Bibhas/UI5/Images/upward.png\” alt=’Upward’>”;

                 } else {

                       trendIMG = “<img src=\”/…/Bibhas/UI5/Images/downward.png\” alt=’Downward’>”;

                 }

                                   

                 // Step-4D: Create UI5 html content >>>>>

                 var htmlContent = new sap.ui.core.HTML(“”, {

                       content:

                                    “<html>” +

                                    “<body>” +

                                    “<table border=\”1\” width=\”100%\” cellspacing=\”0\” cellpadding=\”0\”>” +

                                    “<tr>”+

                                    “<th colspan=\”4\”>Defect Details</th>” +

                                    “</tr>”+

                                    “<tr>” +

                                    “<th align=\”left\”>  Product </th>” +

                                    “<th align=\”center\”>Status</th>” +

                                    “<th align=\”center\”>Trend</th>” +

                                    “<th align=\”center\”>Percentage</th>” +

                                    “</tr>” +

                                    “<tr>” +

                                    “<td height=\”25\”>   ” + prodName +”</td>” +

                                    “<td height=\”25\” align=\”center\”>” + statusIMG+ “</td>” +

                                    “<td height=\”25\” align=\”center\”>” + trendIMG + “</td>” +

                                    “<td height=\”25\” align=\”center\”>”+ defectPercentage +”</td>” +

                                    “</tr>” +

                                    “</table>” +

                                    “</body>” +

                                    “</html>”

                 });

                 // Step-4E: Create layout which hold the html content >>>>>

                 var oLayout_Carousel = new sap.ui.commons.layout.MatrixLayout({height: “60px”});  

                 oLayout_Carousel.setWidth(“100%”);

                 oLayout_Carousel.createRow(htmlContent);

                 // Step-4F: Add component into Carousel >>>>>

                 oCarousel_Trend.addContent( oLayout_Carousel );

                  // Step-4G: Add Start and Stop Event into Carousel >>>>>

                  oLayout_Carousel.attachBrowserEvent(“click“,stopTimerLoop); 

                  oLayout_Carousel.attachBrowserEvent(“dblclick“, startTimerLoop);

           }

           // Step-5: Add Carousel into Main layout >>>>>

           var oLayout_Main = new sap.ui.commons.layout.MatrixLayout({columns : 1, widths : [ ‘99%’]});

           oLayout_Main.createRow(oCarousel_Trend);

           // Step-6: Set Timer for Carousel for auto-loop >>>>>

           setTimerLoop(oCarousel_Trend, false, 3000);

           // Step-7: Add main layout content into view >>>>>

           this.addContent(oLayout_Main);

      }

});

CarouselUtilities.js :-


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

/******************** Custom Carousel Utilities ***************************/

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

var oCarouselU = null;   // This will hold the carousel component

var loopTimeU = null;    // This will hold the carousel loop time value in millisecond

var bShowNextU = null;  // This will hold the value in boolean whether user wants to loop nextwise or previouswise

var timeoutID = null;      //  This will hold the return value of  setTimeout function

/**

* Setter for loop timer

*

* @param oCarousel [sap.ui.commons.Carousel]

* @param bShowNext [boolean]

* @param loopTime [millisecond]

* @return void

* @function

*/

function setTimerLoop(oCarousel, bShowNext, loopTime) {

            oCarouselU = oCarousel;

            bShowNextU = bShowNext;

            loopTimeU = loopTime;

            if (bShowNextU) {

                        runTimerLoopForShowNext();

            } else {

                        runTimerLoopForShowPrevious();

            }

}

/**

* Perform carousel ShowNext according to recursive loop timer

*

* @return void

* @function

*/

function runTimerLoopForShowNext() {

            oCarouselU.onsapnext();

            timeoutID = setTimeout(‘runTimerLoopForShowNext()’, loopTimeU);

}

/**

* Perform carousel ShowPrevious according to recursive loop timer

*

* @return void

* @function

*/

function runTimerLoopForShowPrevious() {

            oCarouselU.onsapprevious();

            timeoutID = setTimeout(‘runTimerLoopForShowPrevious()’, loopTimeU);

}

/**

* Start carousel timer loop

*

* @return void

* @function

*/

function startTimerLoop() { 

            if (bShowNextU) {

                        runTimerLoopForShowNext();

            } else {

                        runTimerLoopForShowPrevious();

            }

  }

/**

* Stop carousel timer loop

*

* @return void

* @function

*/

function stopTimerLoop() { 

            clearTimeout(timeoutID);

  }

Test.png

Now, in the above example single click on the “Carousel” Auto-Loop will stop immediately and again double-clicked on the “Carousel”, Auto-Loop starts instantly. Hope, this simple solution will be helpful for any project requirements and also for the learning purpose.

I want to express my sincere and special thanks to Dipankar Saha for giving me an awesome guidance and continuous inspiration to move ahead.

Thanks

&

Best Regards,

Bibhas Das

To report this post you need to login first.

9 Comments

You must be Logged on to comment or reply to a post.

    1. Bibhas Das Post author

      Thanks Suman for the comments. I have just updated the model data loading part and used query templates.

      Best Regards,

      Bibhas Das

      (0) 
  1. Abesh Bhattacharjee

    Dear Bibhas,

    Good blog and a good solution to yet one more functionality not inherent in the current SAPUI5 release.

    Do not mean to dampen your spirits, but I think, while designing a web application, it is more important to concentrate on the UX than the UI. To put it more clearly, the UI should be driven by the UX and not the other way around.

    That being said, I often find the carousel control as something that I would generally avoid in my UI elements. This page gives a few reasons as to why 🙂

    But then again, as I said, it is what I think, there might be cases where people might need to use the carousel control for reasons not entirely in their control (e.g. client insistence)

    (0) 
  2. Avik Gupta

    Hi Bibhas, I really like the re-usable utility script file. It gives me a concept which I can apply on other areas. Thanks and Good Job.

    (0) 
  3. Mahesh kumar palavalli

    This is really a good document and i am kind of new to ui5, till now what i know is that we can develop ui5 applications in Eclipse and Neptune, but in the first image its kind of new designer i guess and is it a new designer?

    (0) 
  4. Jackuline James

    Hallo Bibhas,

    Thank you for the post. I tried using this in my application and I get the following error:

    Uncaught TypeError: Cannot read property ‘preventDefault’ of undefined.

    This error occurs at the following two lines under carouselUtilities.js

    • oCarouselU.onsapnext();
    • oCarouselU.onsapprevious();

    I couldn’t fix it.

    (0) 

Leave a Reply