--- title: "Widget XML" canonical: "https://wiki.yellowfinbi.com/space/USER72/2833438/Widget%20XML" format: markdown --- Overview The purpose of this page is to assist in using the DashXML framework to generate and display dashboards. When reading, you will notice that each element will have a table listing the child elements available. This table will also reference child node descriptions which brand out into their own list of children. Some elements may only be used in particular cases, and these will be outlined in their description. Reading the table, you will find the name of each element, the possible values (if they are generated by the system), and a description. For example: Child Value Description styleClass Contains a CSS class name used to apply styling to the component. html Contains the HTML to be used as the component, wrapped in a CDATA section. For example: Your camp started on:

You're viewing data for: <@- test @>

]]> replacements This allows you to place a parameter in the custom html that will be replaced with values of a filter, if required. For example, the above example calls a parameter <@- test @> . The test parameter (defined as test in the node of ) will be replaced with the values of the filter nominated in the node of . See node description. The above is a description of the node contents. You will notice that the replacements within references the node. This means that your XML file will have something like this: dashboardDates Your camp started on:

You're viewing data for: <@- test @>

]]> test datefilter Elements Child Value Description dashboard Contains information outlining the dashboard contents. See node description. Child Value Description code This is the source filter code as defined in Yellowfin. parameter This is the parameter that will be used in the dashboard URL to pass the source filter values to all reports that have it applied. For example, if the parameter is ‘ISO’ and the source filter value is ‘AU’ then the URL might look like: http://localhost:7171/DashXML/dashboard.jsp?id=1&ISO=AU Child Value Description id This is a unique number used to identify the tab within the XML. It’s also used in the URL in order to identify the tab. For example, if the id is 1 then the URL might look like: http://localhost:7171/DashboardPortal/dashboard.jsp?id=1 name This is the name of the tab for referencing within the XML. The value should be unique. styleClass Contains a CSS class name used to apply styling to the component. text This contains text to be displayed on the tab, which is defined through the XML rather than pulled from a report. This contains See node description. filter This contains the details of filters used on the tab. See node description. report This contains information around a single report to be displayed on the tab. See node description. modal This contains information around creating a link allowing the user to click and view a report in a modal. See node description. customhtml This allows custom HTML to be inserted into the dashboard to create custom components such as help, etc. See node description. subtab This contains details of sub tabs to be displayed and switched between within the main tab layout. See node description. Child Value Description styleClass Contains a CSS class name used to apply styling to the component. name This is a name of the sub tab for referencing within the XML. selectType If you wish the sub tab to be selected via a drop down list, set this value to SELECT, otherwise omit. options This contains nodes to define the contents of the display and reports within the sub tab. See node description. For within a sub tab. Child Value Description styleClass Contains a CSS class name used to apply styling to the component. title This is the text label for the sub tab selector (how you toggle between the sub tab sets of reports). description Optional. This is the descriptive text displayed below the sub tab title in the sub tab selector. icon Optional. This can contain a reference for an image to be displayed in the sub tab option area. This will be the image source, for example: images/myimagename.png iconURL Optional. This can contain HTML to display an icon. For example: ]]> defaultOption TRUE FALSE This specifies which of the options within the sub tab node is the default selection. Only one