Dashboard Development Objects

This section lists objects for for use in analytical dashboards and Flash-based visualizations.

Query Parameter Object

If a report has embedded query binding, the parameters used by the queries are accessible as properties in a 'parameter' object. Each parameter is a property in the 'parameter' object and can be accessed using regular JavaScript object property notation.

text = "Customer list for " + parameter.state; 

The parameter values can be modified by onLoad Handler script. The modifications made in an onLoad script will be used when the queries are executed. Modifications made in all other scripts are not effective in queries.

RepletRequest Object

A report is created with optional replet request parameters. The parameters may be defined when a replet is registered with a server, or interactively entered by end users when the report is created. The request parameters can be accessed inside a script like the query parameters. The length of request parameters is given by request.length.

#1 Ranking: Read how InetSoft was rated #1 for user adoption in G2's user survey-based index Read More

The report creation request parameters are stored in a JavaScript object, 'request'. The parameters can be accessed as properties in the object.

 if(request.chartType == 'BAR') {
    Graph1.separatedStyle = Chart.CHART_BAR;
 } 

The request parameter values are read-only. Modifying the parameter values has no effect on the report creation process.

ReportSheet Object

All scripts in a report can access the Java ReportSheet object as a top-level object: 'reportsheet'. All public methods in ReportSheet class are available.

Style Intelligence Global Object

Style Intelligence scripts can access a set of functions only available in the server environment. The functions are generally used in onClick Handler scripts to create report viewer commands. In the Script Editor 'Functions' tree, these are listed under 'StyleReportEE/Global'.

Replet Object

In the Report Portal, a report script can access its own instance of BasicReplet. This allows a script to add interactive features to the report without implementing onClick Handler. You can access the replet object with the global JavaScript property 'replet'.

ParentReport Object

The nested scope of the bean and sub-report scripting environment results in any variable or element in a bean or a sub-report hiding the objects with same names in the parent report. However, such objects in the parent report can be accessed using the 'parentReport' object. For example, say that a bean has a text element whose id is set to 'Title' and its parent report also has a text element with the id equal to 'Title'. The 'Title' text element in the parent report can be accessed using parent

 Report.Title, or
 parentReport['Title'].

RepletParameters Object

A RepletParameters object contains the replet parameter definitions. It is accessed through replet.parameters.create, and can be used to add or modify replet parameter definitions.

The replet.parameters.create.parameter array is available as a global property called parameter. Here is a list of system parameters that are available in the global parameter array:

Parameter Name

PURPOSE

_USER_

The string containing the user id.

_ROLES_

An array containing the role names. This can be used with the 'one-of' condition operator.

__principal__

Retrieves the SRPrincipal object in both report script and VPM triggers. Works in scheduled reports too.

__service_request__

Gets the HttpServiceRequest, only valid in a report script when run live by a user.

Replet.RunType

Returns the context of this report: live, pregenerated, or archive (if the SRO is re-executed due to ad hoc changes)

Dashboard.Replet

Returns true if run as a portlet in a dashboard live, false if outside of a dashboard or pregenerated.

PDF Security Provider Subsets

This is the subset required to be set into the report onLoad script when used in conjunction with an appropriate PDF security provider, and accessed through the docInfo object.

The following properties are available:

• pdf.password.owner – password entered in Adobe for document that provides owner access to document

• pdf.password.user – password entered in Adobe for document that provides user access to document; must have to use any security property

• pdf.permission.add[true/false] – provides the ability to add/modify; maps to Commenting

• pdf.permission.change[true/false] – provides the ability to change anything; maps to Changing the Document and Document Assembly

• pdf.permission.copy[true/false] – provides the ability to copy; maps to Content Copying or Extraction and Content Extraction for Accessibility

• pdf.permission.print[true/false] – provides the ability to print; maps to Printing

To use these security features, you must have an implementation of the Java Cryptography Extension 1.2.2 on your classpath. Sun provides a default implementation with the JRE. To use this, add the {JAVA_HOME}/jre/lib/security folder to your classpath.

More Articles About Dashboards

Creating a Dynamic Top 10 Rank - So the first question was, can you have a dynamic top 10 rank in a dashboard chart? Yes, absolutely, so the top 'n', in this case 10, can be dynamic. So if you wanted the number of top ranked items to be specified by the user maybe even using a slider, that is possible. You could do so with a variable, and you can also do so with script...

Easy Online Interactivity - A key aspect of InetSoft's dashboard software is that it allows users to add powerful interactivity without complicated programming, allowing for new level of exploration and insight into data. Users are free to choose from various types of graphs and charts, as well as tables, crosstabs, and gauges. From there, users can manipulate the size, color, text elements, and layout of an element with unlimited design options. The best part? Once the data is manipulated, you can either save those changes as a bookmark, or simply press the escape button and start over again if you did not find the correlations you were looking for...

Financial Plan Reporting Product - With this financial planning and reporting product, I can also save different scenarios. I might have a median, a best, and a worst case scenario. I can actually save scenarios and name them in the application so that I can bring them up later. Again when I save data I might go through and do everything as a median, save it and submit it for approval, but then later on I find out I need to change over to my best scenario because of a certain event that's occurred...

InetSoft's Query and Analysis Application - So how do you write a report using InetSoft's query and analysis application? Well, it's very simple to do. You are going to log in, and I've already logged into the system, but you see the login/logout on the right hand side. There are multiple levels of securities, so that when you are logging in to the query and analysis tool you'll only have access to those employees that you have access to in the core system. Once you have done that you can write report to couple of different ways, but today we are going to do it the very simplest and easiest way. We are going to use the query wizard...

Previous: Dashboard Creation Objects
We will help you get started Contact us