NetCharts® Server JSP Tag Descriptions

The NetCharts Server JSP Tag Library provides JSP authors with a set of JSP tags that can be used to interact with a NetCharts Server. The tag library virtually eliminates the need for JSP authors to know Java in order to interact with the server. The tag library includes a data mapping facility that automatically maps rows and columns from a query result set into chart data sets.

cacheid
chart
chartdata
chartscript
datacache
ndsdata
table
tabledata
session
variable

To see more of how these are used, see the JSP Tag Code Examples on the Coding Examples page .

cacheid

Creates a unique string suitable for use as a cacheID key. cacheid is primarily intended to create cache ID strings that can by datacache to put data into a NetCharts Server data cache.

<ncs cacheid output="cacheID_variable_name"/>

output
Required. The name of a variable to store the cacheID.

chart

Adds a chart to a page. chart tags may contain chartdata and variable tags as necessary.

<ncs:chart
server="server_host_name"
port="server_port"
user="server_userID"
password="server_password"
project="server_project"
chart="chart_template_name"
fullPage="true/false"
encoding="encoding_string"
chart="chart_template_name"
type="return type"
drilldown="true/false"
query="query_name"
defaultHREF="default_href_url"
accessibilityMode="true/false"
amActiveLabelTextTemplate="template_name"
amChartDescription="chart_description_string">
</ncs:chart>

server
Required if not within a session. Server host name, overrides value set in enclosing session.

port
Required if not within a session. Server port, overrides value set in enclosing session.

user
Optional. Server user ID, overrides value set in enclosing session.

password
Optional. Server password, overrides value set in enclosing session.

project
Required if not within a session. Server project, overrides value set in enclosing session.

fullPage
Optional. Inserts javascript that implements roll-over labels. This code needs to be inserted only once per HTML page. Default value is true.

chart
Required. Name of chart template to use.

type
Optional. Type of output, PNG, JPG, TIFF, BMP, SVG, SWF and PDF. Default value is PNG.

drilldown
Optional. Generates and includes HTML MAP tag for chart. Default value is true.

query
Optional. JDBC result set object with which to populate chart.

encoding
Optional. Character encoding to use when interacting with the server. When unspecified, uses the default platform encoding.

defaultHREF
Optional. URL to use for drilldown for drillable elements in a chart that do not have an explicit URL defined.

accessibilityMode
Optional. Used to control creation of US Government Section 508 compliant chart images. If true, NetCharts Server creates images and image maps with ALT and TITLE tags that make them accessible in non-graphical environments. Default is false.

amActiveLabelTextTemplate
Optional. Used when accessibilitymode=true. The ActiveLabelTextTemplate String defines the text to be used in html image map AREA tags for ALT and TITLE attributes. The template can optionally contain the following variables that NetChartsServer will replace at creation time.

@label@	The value of the data point represented by this area tag
@index@	The index of the data point represented by this area tag
@param@	The name of the chart element represented by this area tag
@href@	The URL that will be visited when mouse is clicked on this area tag
@target@	The window that will receive the URL that is visited when the mouse is clicked on this area tag

amChartDescription
Optional. Used when accessibilityMode=true. The chart description text is used as the value for the ALT and TITLE attributes on the chart image tag. If unspecified, the ALT and TITLE attributes will be generated from data in the Chart Templates MetaData attribute named ChartDescription. If there is no MetaData attribute named ChartDescription defined, simple text for the ALT and TITLE attributes will be autogenerated by NetCharts Server.

chartdata

Maps rows and columns from a JDBC result set into a chart template. This tag can only appear inside a chart tag.

<ncs:chartdata type="chart_attribute_type"
rows="rows"
columns="columns"
rowMajor="true/false"/>

type
Required. The type of chart parameter to which this instance of chartdata refers. The legal values for TYPE depend on the type of chart specified by the chart attribute in the enclosing chart tag.

Chart Style	Legal values for type
Bar Chart	legend,bars,bar labels
Box Chart	legend,popup labels,data
Combo Chart	legend,popup labels,bubbles,bubble scale
Line Chart	legend,bars,lines,labels
Pie Chart	legend,slices, slice labels
Radar Chart	legend, data sets, axes config
Stock Chart	legend,bars,lines,labels, stock data
Time Chart	legend,tasks, task labels
XY Chart	legend,popup labels, x-y data

rows
The rows from the result set from which to extract data. Examples of legal syntax include 3* (rows three and greater) 0,1,3 (rows 0,1 and 3), and 1-4,7,9* (rows 1-4, 7 and all rows 9 and greater). Setting rows=COLUMNNAMES will use the column names from the result set as the data for the row.

columns
The columns from the result set from which to extract data. Examples of legal syntax include 0* (all columns) 0,1,3 (columns 0,1 and 3), and 1-4,7,9* (columns 1-4, 7 and all columns 9 and greater).

rowMajor
Optional. Specifies the order from which to extract data from the result set. Default is true.

chartscript

Inserts into the page javascript code that implements the pop-up labels on chart images. This script will support all chart tags that occur in a single page. If this tag is present in a page, then all chart tags in that page should set fullpage=false.

<ncs:chartscript/>

datacache

Adds, retrieves or removes data from a NetCharts Server data cache. Data added to the NetCharts Server data cache can be used to populate charts and tables via the chart and table tags. Data retrieved from the NetCharts Server data cache can be used to populate other elements of a page with the same data that appears in a chart. Any data put in the cache by a call to datacache should be explicitly removed by another call to datacache when no longer needed.

<ncs:datacache server="server_host_name"
port="server_port"
user="server_userID"
password="server_password"
action="get|getncxml|put|remove"
cacheID="cache_id"
cacheLifespan="cache_life_span"
includeHeaders="true|false"
encoding="character_encoding_scheme"
ncxml="ncxml_file_name"
query="query_name"
output="output_variable_name"
/>

server
Required if not within a session. Server host name, overrides value set in enclosing session.

port
Required if not within a session. Server port, overrides value set in enclosing session.

user
Optional. Server user ID, overrides value set in enclosing session.

password
Optional. Server password, overrides value set in enclosing session.

action
Optional. Specifies the operation to be performed on the NetCharts Server data cache. Legal values are GET, GETNCXML, PUT and REMOVE. PUT places data in the cache, GET retrieves data from the cache as a QUERY object, GETNCXML retrieves data from the cache as an XML document, REMOVE removes data from the cache.

cacheID
Required. A String used as an ID tag by the NetCharts Server to reference a particular set of data. The cacheid tag can be used to produce unique values for this attribute.

cacheLifespan
Optional. The time in milliseconds that the server should consider the cached data to be valid. The default value is 3600.

includeHeaders
Optional. When ACTION=PUT, specifies that the column headers in the query should be used as the first row of data put into the data cache. When ACTION=GET, specifies that the first row of data in the data cache will be used to create the column headers in the query or ncxml data returned. The default value is false.

query
Required when ACTION=GET. Specifies the name of the query object to be populated with data from the data cache. When ACTION=PUT, QUERY, if set, will be used as the source of the data to be placed in the cache.

encoding
Optional. Character encoding to use when interacting with the server. When unspecified, uses the default platform encoding.

ncxml
Optional. If specified, and query is unspecified and ACTION=PUT, specifies an NCXML document containing the data to be added to the data cache.

output
Required when ACTION=GET,GETNCXML. Specifies the variable to store data retrieved from the cache.

ndsdata

Instructs NetCharts Server to execute the specified Named Data Set and return the results as either a QUERY object, an NCXML document or a character delimited string.

<ncs:ndsdata server="server_host_name"
port="server_port"
user="server_userID"
password="server_password"
project="server_project"
action="get|getncxml|getcsv"
nds="nds_name"
includeHeaders="true|false"
encoding="encoding_string"
delimiter="delimiter_character"
output="output_variable_name"
/>

server
Required if not within a session. Server host name, overrides value set in enclosing session.

port
Required if not within a session. Server port, overrides value set in enclosing session.

user
Optional. Server user ID, overrides value set in enclosing session.

password
Optional. Server password, overrides value set in enclosing session.

project
Required if not within a session. Server project, overrides value set in enclosing session.

action
Optional. Specifies the format for the data to be returned as a result of executing the NDS file. Legal values are GET, GETNCXML, and GETCSV.

nds
Required. The name of the NDS file on the NetCharts Server to execute.

includeHeaders
Optional. Specifies that the first row of data in the data cache will be used to create the column headers in the data returned. The default value is false.

encoding
Optional. Character encoding to use when interacting with the server. When unspecified, uses the default platform encoding.

delimiter
Optional. Specifies the character to use as the delimiter between fields when ACTION=GETCSV. The default value is ",".

encoding
Optional. Character encoding to use when interacting with the server. When unspecified, uses the default platform encoding.

output
Required. Specifies the variable to store data retrieved as a result of executing the NDS file.

table

Adds a table to a page. table tags may contain tabledata and variable tags as necessary.

<ncs:table server="server_host_name"
port="server_port"
user="server_userID"
password="server_password"
project="server_project"
table="table_template_name"
encoding="encoding_string"
query="query_name">
</ncs:table>

server
Required if not within a session. Server host name, overrides value set in enclosing session.

port
Required if not within a session. Server port, overrides value set in enclosing session.

user
Optional. Server user ID, overrides value set in enclosing session.

password
Optional. Server password, overrides value set in enclosing session.

project
Required if not within a session. Server project, overrides value set in enclosing session.

table
Required. Name of table template to use.

query
Optional. JDBC result set object with which to populate table.

tabledata

Maps rows and columns from a query result set into a table template. This tag must can only appear inside a table tag.

<ncs:tabledata rows="rows"
columns="columns"
rowMajor="true/false"
/>

rowMajor
Optional. Specifies the order from which to extract data from the result set. Default is true.

session

Defines a session with a NetCharts Server. All chart and table tags contained in a session tag inherit the server, project and user ID defined by the session.

<ncs:session server="server_host_name"
port="server_port"
user="server_userID"
password="server_password"
project="server_project"
encoding=encoding_string"
query="query_name">
</ncs:session>

server
Required. Server host name.

port
Required. Server port.

user
Optional. Server user ID.

password
Optional. Server password.

project
Required. Server project.

query
Optional. query object with which to populate enclosed charts and tables.

encoding
Optional. Character encoding to use when interacting with the server. When unspecified, uses the default platform encoding.

variable

Defines a variable and its value. variable tags are used inside chart and table tags to provide values for variables that may appear in chart and table templates.

<ncs:variable name="variable_name" value="variable_value"/>

name
Required. The name of a variable in the related chart or table template.

value
Required. The value for the variable.