DashXML

Overview

DashXML is a Java web application that communicates with Yellowfin via Web Services. It can be deployed alongside Yellowfin, or on a separate server.

The DashXML framework provides a method for creating dashboards that combine Yellowfin content and custom items without the need for programming. The dashboards are configured in a single XML document that describes each element on each tab as a widget. All layout and styling can be achieved via customised CSS.

 

Skill Prerequisites

DashXML is designed to be implemented by a highly advanced user. This user would either be a developer, or someone with a strong technical background.

In order to implement a DashXML solution the user would require the following technical skills as a minimum:

 

 

Security

No user security is offered out-of-the-box with DashXML. Third party user security can be implemented using a Java Servlet Filter. This can test access for a user for a given dashboard, apply appropriate source filters for that user, and run the reports as the nominated user specified in the web.xml file.

Source filter can be passed for a particular session to enable row-level security. Source filters will need to be defined in the Yellowfin interface, and then referenced within the DashXML.

 

Limitations

DashXML does not replicate all functionality found in the Yellowfin interface. Some of the functions that can't be replicated within DashXML include:

• • Drill Down (on Tables) and Linked Drill Down
  • Drill Anywhere (on both Tables or Charts)
  • Drill Through (on both Tables or Charts)
  • Brushing and Linked Brushing
  • Series Selection and Linked Series Selection
  • Interaction and Tooltips on Multi-Chart Canvases
  • Animated Chart Loading
  • Time Series Date Slider and Unit Selection
  • Column Formatters (such as Flag Formatter)
  • Selectable Layers on Maps
  • Collaboration
  • Yellowfin Dashboards
  • Yellowfin Storyboards

 

Installation

1. Ensure that your version of Yellowfin currently has Multicast enabled as part of the licence parameters. 
   If you don't have a multicast licence, you should contact your account manager.
   
   
2. Download DashXML from the Support Centre page of the Yellowfin website. 
   If you don't have access to this page, you should contact your account manager.
   
   
3. Ensure your version of Yellowfin is running the latest 7.1 patch. 
   Yellowfin releases monthly patches, visit the Support Centre to download the latest. 
   Note: early versions of Yellowfin 7.1 (or releases prior to 7.1) will not be compatible with the DashXML framework.
   
   
4. Stop your Yellowfin instance. 
   There are some changes to files related to your Yellowfin instance that you will have to update, and in order for the changes to be implemented correctly, Yellowfin must not be running.
   
   

5. Edit your Yellowfin web.xml file. 
   Navigate to \Yellowfin\appserver\webapps\ROOT\WEB-INF\ and edit the web.xml file. You will need to uncomment the following section in order to enable Web Services.
   
   

   Update your file from this: <!-- Uncomment this section to enable JAX-WS Web Services. Java 1.6+ only <listener> <listener-class> com.sun.xml.ws.transport.http.servlet.WSServletContextListener </listener-class> </listener> <servlet> <servlet-name>WebServices</servlet-name> <servlet-class> com.sun.xml.ws.transport.http.servlet.WSServlet </servlet-class> </servlet> <servlet-mapping> <servlet-name>WebServices</servlet-name> <url-pattern>/webservices/*</url-pattern> </servlet-mapping> -->

   To this: <!-- Uncomment this section to enable JAX-WS Web Services. Java 1.6+ only --> <listener> <listener-class> com.sun.xml.ws.transport.http.servlet.WSServletContextListener </listener-class> </listener> <servlet> <servlet-name>WebServices</servlet-name> <servlet-class> com.sun.xml.ws.transport.http.servlet.WSServlet </servlet-class> </servlet> <servlet-mapping> <servlet-name>WebServices</servlet-name> <url-pattern>/webservices/*</url-pattern> </servlet-mapping>

   Save your changes.

    

6. Unzip your DashXML file.
   You are able to install DashXML two ways:
   1. into your Yellowfin directory, so that it runs on the same Tomcat instance, or 
   2. into a completely separate Tomcat instance which may sit on a different server to Yellowfin if required.

   Yellowfin Tomcat	Separate Tomcat
   Copy the DashXML folder (from your downloaded zip) into your \Yellowfin\appserver\webapps\ directory. You should now have both a ROOT and DashXML directory sitting within webapps.	Copy the DashXML folder (from your downloaded zip) into your \Tomcat\webapps\ directory. You will now have a DashXML directory sitting within webapps.

7. Edit your DashXML web.xml file.
   Navigate to \webapps\DashXML\WEB-INF\ and edit the web.xml file. You will need to make three changes to this file, in order for DashXML to be able to connect to your Yellowfin instance.
   

   1. Set your Yellowfin URL.

      <init-param>
        <param-name>PathToServer</param-name>
        <param-value>http://server-name:7171</param-value> <!-- update to Yellowfin server -->
      </init-param> 

   2. Set your Yellowfin username.

      <init-param>
        <param-name>Username</param-name>
        <param-value>admin@yellowfin.com.au</param-value> <!-- update to Yellowfin username -->
      </init-param>  

   3. Set your Yellowfin password.

      <init-param>
        <param-name>Password</param-name>
        <param-value>test</param-value> <!-- update to Yellowfin password -->
      </init-param>   

8. Start Yellowfin.

 

 

Getting Started

Explore the elements available in DashXML here:

• • Widget Overviews
  • Widget Examples
  • Widget XML