WHITE LABELING IN PROGRESS ROLLBASE PRIVATE CLOUD

Size: px

Start display at page:

Download "WHITE LABELING IN PROGRESS ROLLBASE PRIVATE CLOUD"

Leon Griffin
6 years ago
Views:

1 W HI TEPAPER www. p rogres s.com WHITE LABELING IN PROGRESS ROLLBASE PRIVATE CLOUD In this whitepaper, we describe how to white label Progress Rollbase private cloud with your brand name by following a few simple steps. Whitepaper Author: Chandrasekhar Gontla

2 1 INTRODUCTION Rollbase is a rapid application development platform in the cloud where you can develop Cloud-based applications with minimal coding using various UI tools and techniques. One can build, deploy and manage cloud-based applications with a single platform, which minimizes your time to go to market. You can not only develop enterprise productivity applications rapidly, but also white-label them to suite your needs and requirements. It includes many useful things such as incorporating your company name, logo, custom login page, privacy, forum etc. This whitepaper describes various white-labeling features that are offered by Progress Rollbase. 2 PREREQUISITE Rollbase Private Cloud v or later is installed and available in your favorite machine/cloud 3 CUSTOM LOGIN AND FORGOT PASSWORD PAGE FOR ROLLBASE PRIVATE CLOUD User can develop custom login page instead of using the default login form provided by Rollbase. User can design forgot password page as well. These pages can be hosted on any other website to allow users to log into a Rollbase customer tenant. 3.1 Create Custom Login page The login page should contain forms that store the user name and password, post them to Rollbase and handle both successful and unsuccessful log in attempts. Ex: The following code snippets show an example of a servlet program that is used for custom login of Rollbase private cloud Custom login pages must contain a FORM tag that includes the action tag out.println("<form action=\" method=\"post\" name=\"theform\">"); An act hidden parameter with a value of login out.println("<input type=\"hidden\" name=\"act\" value=\"login\">"); An rt hidden parameter points to the full URL of your custom login page (this parameter stands for "return to" and is stored as part of the user's session, so when they log out or their session expires the user is automatically taken back to your custom login page rather than Rollbase.com) out.println("<input type=\"hidden\" name=\"rt\" value=\" The loginname and password parameters will be used to store credentials specified by user

3 out.print("<table><tr><td> User </td>\n"); out.print("<td><input type=\"text\" name=\"loginname\"/></td></tr>"); out.print("<tr><td> Password </td>\n"); out.print("<td><input type=\"password\" name=\"password\"/></td></tr></table>"); An errmsg parameter is optional. If this HTTP parameter is set in the Login Page, URL errors, such as invalid user name, will be captured and displayed as error messages. If a login is unsuccessful, Rollbase will redirect the user back to your custom login page and then display the error description set in the HTTP parameter errmsg. Progress strongly recommends that your custom login page capture and display this error message when it is non-empty An o parameter is optional. If this HTTP parameter is set in the Login Page URL, it will be captured and stored in the o hidden parameter. For example, this parameter might contain the location of the first landing page Find the below complete servlet program for reference. CustomLogin.java package com.serv; import javax.servlet.*; import javax.servlet.annotation.webservlet; import javax.servlet.http.*; import public class CustomLogin extends HttpServlet { private static final long serialversionuid = 1L; public CustomLogin() { super(); public void init(servletconfig config) throws ServletException { super.init(config); protected void doget(httpservletrequest request, HttpServletResponse response) throws ServletException, IOException { response.setcontenttype("text/html"); PrintWriter out = response.getwriter(); String title = "Custom Login Page"; String doctype = "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\n"; out.println(doctype + "<html>\n" + "<head><title>" + title + "</title></head>\n"+ "<body bgcolor=\"#f0f0f0\">\n" + "<h1 align=\"center\">" + title + "</h1>\n"); out.println("<form action=\" method=\"post\" name=\"theform\">"); out.println("<input type=\"hidden\" name=\"act\" value=\"login\">"); out.println("<input type=\"hidden\" name=\"rt\" value=\"

4 out.print("<table><tr><td> User </td>\n"); out.print("<td><input type=\"text\" name=\"loginname\"/></td></tr>"); out.print("<tr><td> Password </td>\n"); out.print("<td><input type=\"password\" name=\"password\"/></td></tr></table>"); out.println("<td><a href=\" your password?</a></table>"); out.print("<input type=\"submit\" value=\"login\"/></form>\n</body></html>"); 3.2 Create Custom Forgot Password page Rollbase Private Cloud provides a way to create a page for users to retrieve forgotten passwords. Such a page must contain HTML with a FORM tag satisfying the following conditions: Ex: The following code snippets part of a servlet program is used for custom forgot password page of Rollbase private cloud An action attribute pointing to out.println("<form action=\" method=\"post\" name=\"theform\">"); An act hidden parameter with a value of forgotpassword out.println("<input type=\"hidden\" name=\"act\" value=\"forgotpassword\">"); An rt hidden parameter that points to the full URL of your custom login page out.println("<input type=\"hidden\" name=\"rt\" value=\" A loginname input parameter that stores the login name entered by a user out.println("<tr> <td nowrap><b>user Name:</b> </td><td ><input name=\"loginname\" size=\"30\" type=\"text\"></td> </tr>"); An input parameter that contains the address entered by a user (must match with the login name) out.println("<tr><td nowrap><b> Address:</b> </td><td ><input name=\" \" size=\"30\" type=\"text\"></td></tr>");

5 Find the below complete servlet program for reference. CustomForgotPwd.java package com.serv; import javax.servlet.servletexception; import javax.servlet.annotation.webservlet; import javax.servlet.http.*; import public class CustomForgotPwd extends HttpServlet { private static final long serialversionuid = 1L; public CustomForgotPwd() { super(); protected void doget(httpservletrequest request, HttpServletResponse response) throws ServletException, IOException { response.setcontenttype("text/html"); PrintWriter out = response.getwriter(); String title = "Custom Forgot Password page"; String doctype = "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\n"; out.println(doctype + "<html>\n" + "<head><title>" + title + "</title></head>\n"+ "<body bgcolor=\"#f0f0f0\">\n" + "<h2 align=\"center\">" + title + "</h2>\n"); out.println("<form action=\" method=\"post\" name=\"theform\">"); out.println("<input type=\"hidden\" name=\"act\" value=\"forgotpassword\">"); out.println("<input type=\"hidden\" name=\"rt\" value=\" out.println("<table cellpadding=0 cellspacing=0>"); out.println("<tr><td><h2>forgot your password?</h2><td><tr>"); out.println("<tr><td colspan=\"2\">in order for us to reset your password we need to confirm your identity. Please enter your user name. <br>you will receive an with a new temporary password.</td></tr>"); out.println("<tr><td nowrap><b>user Name:</b> </td><td ><input name=\"loginname\" size=\"30\" type=\"text\"></td> </tr>"); out.println("<tr><td nowrap><b> Address:</b> </td><td ><input name=\" \" size=\"30\" type=\"text\"></td></tr>"); out.println("<tr height='5'><td></td></tr>"); out.println("<tr><td></td><td alignment='left'><input type=\"submit\" value=\"submit\" name=\"btns\"></td></tr>"); out.println("</table></form></body></html>");

3.3 Create and deploy the war in your Private Cloud installation Create a war file using the above two files Copy to <Rollbase installation directory>/pas_instanse/webapps folder Start Rollbase

forgot password page looks like the one given below 3.

6 3.3 Create and deploy the war in your Private Cloud installation Create a war file using the above two files Copy to <Rollbase installation directory>/pas_instanse/webapps folder Start Rollbase Private Cloud Now, you can access custom login page by using the following url The custom login page looks like the one given below The custom forgot password page looks like the one given below 3.4 Customizing JSP files References to obfuscated classes have been removed from the following JSP files, making the migration of customizations easier. Now, when there are no changes to the original JSP file in a new release, you can replace it with your customized file from the previous release. Any changes to these files will be documented for each

7 subsequent release, so you will know whether the files you have customized need to be changed. All directories are relative to <rollbase_install_dir>\pas_instance\webapps (if using PAS) or <tomcat-install-dir>\webapps (if using Tomcat). o router\login\loginprivate.jsp The custom login page o router\login\logout.jsp The custom logout page o router\login\forgotpassword2.jsp The custom forgot password page o router\login\mobile.jsp The custom mobile login page o master(or prod1)\components\loginexpired.jsp The custom login expired page 4 CUSTOM LABELING YOUR PRIVATE CLOUD INSTANCE Rollbase provides a way to change the system name of a private cloud instance. In addition to that, it provides lot of properties that can be overridden by customers with their values. 4.1 Updating shared.properties and lang.properties files User can update the following properties in shared.properties file that can be located at <private cloud installation directory>/pas_instance/rollbase/config folder Property Name Description Default Value SystemName Private Cloud instance Progress Rollbase system name DocumentationURLNewUI NewUI Help Me SupportURL URL to point to support and services LinkPrivacy Link to 'Privacy' page LinkTerms Link to 'Terms of Use' page FastTrackPage RB FastTrack page ForumURL URL of Forum aka Community VideosWebinarsURL Demo link CreateNewAppVideoURL Demo link (Getting Started page) ate.html CustomizeAppVideoURL Demo link (Getting Started page) e_ovr.html ShareYouAppVideoURL Demo link (Getting Started page) NavAppVideoURL Demo link (Page which will be shown after quick create app) tml In addition to above properties, user can update App_Forum_Link_Name key in lang_en.properties file that will be found at <private cloud installation directory>/pas_instance/rollbase/res folder For example, change the following properties and check the UI SystemName= Shanyu Systems App_Forum_Link_Name= Shan Forum

Steps: Login to Rollbase private cloud as a customer Go to setup Click on Account Settings link Here, upload

8 4.2 Changing Customer logo User can change the logo that is shown at the top-left corner of a page when logged into the system as a customer. Steps: Login to Rollbase private cloud as a customer Go to setup Click on Account Settings link Here, upload an image file in Customer Logo field and save it Note: As a master admin, we can update customer logo while creating customer as well. In UI, the logo looks as shown in the below image

9 5 OVERRIDING A FEW SPECIFIC IMAGE FILES Rollbase Private Cloud provides a way to override particular image files. We have introduced a folder under installation directory in which user can place the following image files to override them. Folder Path: <rollbase_install_dir>\pas\rollbase\personalize\images S.No. Image File Name 1 web-app-this.png 2 web-app.png 3 mobil-app-this.png 4 mobil-app.png 5 1icon.png 6 2icon.png 7 3icon.png 8 pacific-logo.svgz 9 setuplogo.svgz 10 Progress.png 11 ProgressBlackBg.png 12 Poweredby.gif Description For desktop browsers, the icon next to the selected web application. This icon will be available only in application switcher (old UI) For desktop browsers, the icon next to not selected web applications in application switcher and all web applications on the Applications Setup > Applications page (old UI) For desktop browsers, the icon next to the selected mobile application. This icon will be available only in application switcher (old UI) For desktop browsers, the icon next to not selected mobile applications in application switcher and all mobile applications on the Applications Setup > Applications page (old UI) The icon next to Create New Apps in Getting Started page The icon next to Customize Your Apps in Getting Started page The icon next to Share Your Apps in Getting Started page The Progress Pacific logo in Setup pages header (old UI) The Setup logo in Setup pages header (old UI) The Progress logo for light themes in application header The Progress logo for dark themes in application header The Powered by Progress logo on Portal and Account Settings page Check the below screen shots to understand the same.

10 Copy the images files to personalize/images folder in installation directory. Now observe that the UI will be updated as shown in below screen shots.

11 6 CONCLUSION User can rebrand the application built using Rollbase easily with minimal configuration. This document will help you to do that. We are in the process of enhancing White label support in Rollbase. So, this document will evolve as and when those features are implemented.

Servlet Basics. Agenda

Servlet Basics. Agenda Servlet Basics 1 Agenda The basic structure of servlets A simple servlet that generates plain text A servlet that generates HTML Servlets and packages Some utilities that help build HTML The servlet life