NOTE: This blog is relevant to version 3.0, 3.1, 4.0 and 4.1 of Helical Insight and will not work for any other version. You can know the version from the bottom left (above file browser) or from the admin page.
This article briefs you about how you can completely white label and change the look and feel of Helical Insight as per your own requirement. Unlike other tools, we provide extensive white labeling capabilities which includes header, footer, login page, logout page, context menu, file browser, repository and any other functionality as well. With Helical Insight it is even possible to have organization specific/user, specfic/role specific white labeling which means the solution will identify who has logged in and based on that every person can have their own completely customized Helical Insight.
White labelling generally involves overriding the default CSS, but in some cases, may also include changing the alignment of the pages completely.
- Overriding default CSS : This method is employed only when changes such as colors, font-type, size of elements, etc are required. This method cannot be used when we want to add or remove elements for most parts.
- Realigning Pages : This method is used when the user needs to add or remove elements from the DOM and needs to make drastic changes in the page’s look, such as adding images, complete realignment of pages, removing some options, etc.
NOTE:
Neither of these methods affects the working of the application, but the user must be careful of the changes being made, so as to avoid over-riding any functional aspect of the DOM, such as hiding or removing buttons or menus, etc.
Overriding the default CSS
The following steps should be followed to override the default CSS –
- Create a custom CSS file, which will override the default css.
- Save this file in path –
“webapps/<application instance>/css”
- Include the CSS file in the respective JSP page, in which the change needs to be reflected.
- The change can be seen in the application as follows-
The background color of the login button has changed to green.
Same loginBody.jsp file also contains the HTML tags for Logs, organization, usename , password input fields as well as the LOG IN button, Default Admin, Default User buttons etc.
Important:
- Locating the correct JSP File: The list of JSP files used, is defined in the following location –
“WEB-INF/tiles-definitions.xml”
Example :
For login-page, in tiles-definitions.xml, the following code snippet exists –
Here, in <put-attribute>
tag, the ‘name’ attribute tells which part of the page is being scripted in the JSP file that is mentioned in the ‘value’ attribute. Hence, to make any change in the body of the login page, the CSS link must be added in ‘loginBody.jsp’ located in
“/WEB-INF/jsp/login” directory
Location List
The following is the list of locations where the CSS files need to be added to reflect changes in different pages:
- Login Page –
/WEB-INF/jsp/login/loginBody.jsp
- Admin Landing (All Admin Pages) –
/WEB-INF/pages/admin/adminBody.jsp
- Users Page –
/WEB-INF/pages/sections/landing.jsp
- Organizations Page –
/WEB-INF/pages/admin/adminBody.jsp
- Roles Page –
/WEB-INF/pages/admin/adminBody.jsp
- Adhoc Landing Page (All Adhoc Pages) –
/WEB-INF/pages/templates/base-template.jsp
- Metadata Create –
/WEB-INF/pages/adhoc/metaData/metaDataBody.jsp
- Metadata Edit –
/WEB-INF/pages/adhoc/metaData/metaDataBody.jsp
- Data Source Create –
/WEB-INF/pages/adhoc/dataSource/dataSourceBody.jsp
- Data Source Edit –
/WEB-INF/pages/adhoc/dataSource/dataSourceBody.jsp
- Create Report –
/WEB-INF/pages/adhoc/report/reportBody.jsp
- Edit Report –
/WEB-INF/pages/adhoc/report/reportBody.jsp
- Adhoc Navigation Bar (Menus) –
/webapp/WEB-INF/pages/sections/secondaryNav.jsp
- Adhoc Report Menus –
/webapp/WEB-INF/pages/sections/reportNav.jsp
- Dashboard Designer Create –
/WEB-INF/pages/designer/designerBody.jsp
- Dashboard Designer Edit-
/WEB-INF/pages/designer/designerBody.jsp
You can refer to the blog “White Labelling in Helical Insight” to learn more about how to remove license detais from home page, footer which has copyright Helical Insight and Click Here to know more details
Some other examples like favicon, logo, background image on the login page, removing “Discover” present on the left side etc can be read at the blog “White Labeling in Helical Insight Application”.
For further assistance, kindly contact us on support@helicalinsight.com or post your queries at forum.helicalinsight.com