Section 14: Named Data Set Parameters
NDSPlugInAdapter Parameters (Inherited by Jdbc, CSV, XML, and Cache NDS Plugins)
| Parameter | Description | Example |
| cacheKey | An identifier used by charts and tables to share data. | cacheKey = Q202FinancialData |
| cacheLifeSpan | Time in seconds cache data is valid. | cacheLifeSpan = 3 |
| cacheRefresh | When passed, causes the cache to explicitly be refreshed with new data. | cacheRefresh = true |
| computeScales | When NDS is used to import an axis scale, the imported values are used as guidelines to calculate an appropriate axis scale. When computeScales is false, no additional calculations are done, and the imported axis scale values are used directly to set the axis scale. The default value is true. | computeScales = true |
| rawRowFilter | The list of rows to include in the data set. Occurs before data is put into cache and before other sort or aggregate processing | rawRowFilter = 0-10,15-20,30* |
| rawColumnFilter | The list of columns to include in the data set. Occurs before data is put into cache and before other filter, sort or aggregate processing | rawColumnFilter = 0-10,15-20,30* |
| transposeData | Transposes the data so that columns become rows and vice versa. Occurs after data is put into cache but before other filter, sort, or aggregate processing | transposeData = true |
| columnSort | Identifies a column on which the sorted data is based. If the column is appended with an ‘R’ than a reverse sort is applied. | columnSort = 4R |
| skipFirstRowSort | If sorting, don’t include the first row in the sort. | skipFirstRowSort = true |
| skipLastRowSort | If sorting, don’t include the last row in the sort. | skipLastRowSort = true |
| simpleDateFormat | If sorting, specify the pattern to use for date columns | simpleDateFormat = dd-MMM-yyyy |
| aggregateFunction | The name of a function AVG, SUM, MAX, MIN, to apply to the data set. | aggregateFunction = SUM |
| aggregateInclude | If set to RAWDATA, causes the original data set to be included with the aggregate. | aggregateInclude = RAWDATA |
| aggregateLabel | A text label to insert into the first cell of the aggregated data. | aggregateLabel = My Average |
| aggregateBy | COLUMN, ROW, or BOTH. If COLUMN (default), data is aggregated top to bottom. If ROW is selected data is aggregated left to right. BOTH aggregates both top to bottom and left to right. | aggregateBy = ROW |
| pivotFunction | If true, the NDS Pivot Function will be processed. | pivotFunction = true |
| pivotColumn | The table column to “pivot” around. | pivotColumn = 1 |
| pivotRow | The table column that specifies the unique set of data to use as the row headers | pivotRow = 0 |
| pivotDataColumns | The table columns that include the data to show. | pivotDataColumns = 2,3 |
| pivotRowHeaderName | The column header of the row data. | pivotRowHeaderName = Date |
| rowFilter | Specifies the rows to be returned. Occurs after all other sort or aggregate processing. | rowFilter = 0-15,20* |
| columnFilter | Specifies the columns to be returned. Occurs after all other sort or aggregate processing. | columnFilter = 1,4,9 |
| variables | A comma separated list of variables that this NDS expects. | variables = FIELDS,WHERECLAUSE |
| defaultvalues | A comma separated list of values that are used for variable values if those values are not passed. | defaultvalues = ”apples,oranges”,”sales > 100” |
| processModules | List of pre-built and user defined processes that should be applied to the data | processsModules = DataTranspose,DataGroup,com.my co.userprocess |
| dataGroupKeyColumn | Only available if processModules includes DataGroup. Used to identify the keyword column. | dataGroupKeyColumn1 = 0 |
| dataGroups | Only available if processModules includes DataGroup. Identifies 1) a particular keyword (or fragment) to look for and 2) which column(s) the data should be pulled from | dataGroups1 = ACTUAL:1,2;BUDGET:1;VARIANCE:1; |
JDBC PlugIn Parameters (Also Includes all NDSPlugInAdapter Parameters)
| Parameter | Description | Example |
| dbName | The name of the database or DSN to which the Server is attempting to connect. Appended to serverURLBase to resolve the complete JDBC URL. | dbName = SunshineData |
| serverURLBase | Concatenated with dbName at connection time. Represents a valid JDBC server URL. Defaults to an ODBC prefix. | serverURLBase = jdbc:odbc |
| driverName | Name of the JDBC driver that will manage this connection. Defaults to an ODBC driver. | driverName = sun.jdbc.odbc.JdbcOdbcDriver |
| login | If non-null, this parameter is sent with the password parameter when connecting to the database. If login is set, password must also be set (even if there is no password). | login=scott |
| password | If non-null, this parameter is sent with the login parameter when connecting to the database. If no password is required, but a login is, password should be set to the empty string, “”. | password=tiger |
| sql | The actual SQL statement that the JDBC plugin will pass to the database server to execute. | select * from expenseTable |
| properties | Custom properties that the JDBC driver may require. | properties = user:scott&&password:tiger |
| simpleDateFormat | Specifies a date format (using Java SimpleDateFormat patterns) to be applied to dates as they are read from the database. | simpleDateFormat = dd-MMM-yy |
| skipNulls | If true, does not return any string or placeholder when a null is found in the dataset. If false, inserts the contents of nullString. | skipNulls=true |
| nullString | Used to indicate a null value—is used only if skipNulls is false. | nullString = [No Value] |
| stayAlive | If true, database connection is kept open for subsequent requests. | stayAlive = false |
| includeColumnNames | If true, the column names are returned as the first row of the data. | includeColumnNames = true |
CSV/Flat File PlugIn Parameters (Also Includes all NDSPlugInAdapter Parameters)
| Parameter | Description | Example |
| filename | The name of a file in the project or a URL identifying the source data. | filename = mydata.txt |
| fieldDelim | Characters to be used as field delimiters. | fieldDelim = , |
| endOfLineDelim | Characters to be used as end of line delimiters. | endOfLineDelim = \n\r |
| strings | Characters to delimit string values. | strings = “ |
| comments | Characters indicating the start of a comment line. | comments = # |
| ignoreChars | Characters to be removed after the parsing process has occurred. | ignoreChars = , |
XML PlugIn Parameters (Also Includes all NDSPlugInAdapter Parameters)
| Parameter | Description | Example |
| filename | The name of a file in the project or a URL containing XML data. | filename = mydata.xml |
| xmlString | A string of raw XML data. | xmlString = <data><r><c v=4/></r></data> |
| parserClassName | The name of a class file (in the NetCharts Server classpath) that is to be used to parse the XML. The class must implement the NCXMLParser interface. | parserClassName = com.myco.myxmlparser.class |
Cache PlugIn Parameters (Also Includes all NDSPlugInAdapter Parameters)
| Parameter | Description | Example |
| defaultData | The data to use if the cacheKey is not set or contains no data. | defaultData=10,20,30,40\n5,10,15,20 |