The dataprovider element retrieves data from the database and organizes it.
dataprovider Element Properties
|
| Property Name
|
Description
|
| Data Set Provider |
Properties that define how Chart Data Set is created.
| Property Name | Description | | Data Set Provider Type | Defines the method used to create a Data Set. Choose Standard or Custom. | | Standard Data Set | Data Set properties that define a Standard Data Set.
| Property Name | Description | | Standard Data Set Type | Data Set properties define how chart data set is created. Choose SQL, Query, Data Item or Prepared SQL. | | SQL | SQL query to produce the data set. You can use all request Parameters and argument values as tokens ([keyid1] for example). Also a special [currentuser] is available. | | Query | Query Data Set creates a data set based on a SQL query.
| Property Name | Description | | SDC ID | Query SDC. | | Query ID | Query ID. | | Query Params | Parameter and Value for the SQL Query. | | Plot ID Column | Column in the Query Data Set, having a shared value. Can be used as Plot ID. Default is plotid. | | Plot ID Column Value | Value of the Plot ID column. Default is 1. |
| | Data Item DataSet | Define how the chart data set is created.
| Property Name | Description | | Query | Creates a data set based on a SQL Query.
| Property Name | Description | | SDC ID | Query SDC. | | Query ID | Query ID. | | Query Params | Parameter and Value for the SQL Query. | | Plot ID Column | Column in the Query Data Set, having a shared value. Can be used as Plot ID. Default is plotid. | | Plot ID Column Value | Value of the Plot ID column. Default is 1. |
| | Add SDI Notes | Attach SDI Notes to each SDI. SDI Note rows are concatenated so that each SDI row has all its notes in a single column.
| Property Name | Description | | Enable | Flag indicating whether or not to process the adapter. | | Column Name | Column name for the column to contain the flattened notes of a single SDI. | | Delimeter | Delimeter used between notes when they are flattened. | | Max Note Length | Maximum note length for a single flattened SDI Note. |
| | Add SDI Data Items | Defines how Chart data is created.
| Property Name | Description | | Include All Primary Columns | If Yes, all columns from the primary dataset are included in the result dataset. If No, only defined columns are preserved. | | Columns | Additional Columns. The Adapter adds all SDIDataItem keys in the data set, plus Enteredtexst, Enteredvalue, Transformvalue and Displayvalue. See also Add Specs.
| Property Name | Description | | Table ID | Table from which the column is retrieved. | | Column ID | Column Id. |
| | Filters | The Data Set may be filtered by given rules so that only given Parameter List items are retrieved.
| Property Name | Description | | Released Only | If Yes, only released results are added to Result Set. | | Ignore Cancelled | If Yes, data sets in Cancelled status are omitted. | | Result Entered | If Yes, only tests with results are added to the Result Set. | | SDI Data Item Filters | The Data Set may be filtered by given rules so that only given Prameter List items are retrieved.
| Property Name | Description | | Param List ID | Parameter list ID to be used as filter. | | Param List Version ID | Parameter List Version to be used as filter. | | Variant ID | Parameter List Variant to be used as filter. | | Data Set | Data set to be used as filter. | | Param ID | Parameter ID used as filter. | | Param Type | Parameter Type used as filter. | | Replicate ID | Replicate ID to be used as filter. |
|
| | Sort Columns | Collection of Sort columns from Data Set | | Specifications | If Yes, the Data Item Specs are added to the Data Set. This includes the following columns: specparamlimits.limittypeid, specparamlimits.operator1, specparamlimits.operator2, sdidataitemspec.value1, sdidataitemspec.value2, sdidataitemspec.condition |
| | Limits | Adapter properties that extract spec/limit information from the dataset that includes basic information, boundary id and value columns.
| Property Name | Description | | Show only One Limit Type | If Yes, show only one Limit Type InSpec for example. | | Show Limit Type | select the limittype to show. Defaults to Inspec. | | Add Empty Boundary Values | Whether or not to show gaps in boundary lines when no boundary is specified for a data point. Default is Y. | | Overlapping Limits | Define how to handle overlapping Limits.
| Property Name | Description | | Hide Overlapping Limits | Hides overlapping limits (use value2 column if operator is >=, otherwise use value1 column). Works well for Simple Products. If No, will create series for both value1 and value2. | | Show InSpec Limit Type | Hides InSpec Limit Type from the plot. Defaults
to No. Defaults to No if hide overlapping
limits is empty or Yes. |
|
|
| | Prepared SQL | | Property Name | Description | | SDC ID | Primary SDC for the query. SDC table ID is automatically added to first item of from clause. Forces security fragment to where clause which will make the query honor SDI security options. Can be left empty. | | Select | Select clause which implicitly contains the key word SELECT. | | From | From clause which implicitly contains the key word FROM. If SDC ID is given then will also implicitly contain the SDC table ID. Can be left empty if SDC ID is given. Notice the implicit SDC table ID cannot be aliased. | | Where | Where clause which implicitly contains the key word WHERE. Can be left empty. Sql input params should be configured as question marks (?). | | Group By | Group by clause which implicityly contains the key words GROUP BY. Can be left empty. | | Order By | Order by clause which implicityly contains the dey words ORDER BY. Can be left empty. | | Extended Data Types | Flag indicating if extended (CLOB,BLOB etc) data types are added to the resulting data set. | | Max Row Count | Maximum number of rows to return. If left empty then all rows are returned. | | Params | Input param values for each ? in SQL.
| Property Name | Description | | Enable | Flag indicating if this param is added to the list of params. | | Value | Value of the param. Can contain multiple values separated by a separator. | | Value Separator | Separator for Value. | | Param Type | Parameter Type. Choose String, Date or Number. | | Date Param | Define Date Parameters.
| Property Name | Description | | Date Type | Choose a Date Type:
User, System or Custom. | | Custom Format | Define a custom Date Format. |
| | Number Param | Define Number Parameters. Choose User or System. |
|
|
| | Custom Data Set Provider | Custom Data Set properties to define how Chart Data is created.
| Property Name | Description | | Class Name | Java class implementing Data Provider. | | Inputs | Input properties for the Data Provider. Define a Property ID and Value. | | Outputs | Output properties for the Data Provider. Define a Property ID and Value. |
|
|
| Data Set Adatper |
Data Set adapter properties define how the data set is modified after creation. The data set is run through a sequence of adapters before it is passed to chart series creation.
| Property Name | Description | | Adapters | Collection containing all Data Set adapter properties. Data Set adapter modifies the chart data set before chart series are created. Adapters are run in the order they are in this collection.
| Property Name | Description | | Adapter ID | N/A | | Adapter Type | Defines whether the adapter is a Product wide standard adapter or Project specific. Choose Standard or Custom. | | Enable | Flag indicating whether or not the adapter should be processed. | | Standard | Defines properties for a Standard Adapter.
| Property Name | Description | | Standard Adapter Type | Choose the Standard Adapter Type:
| Add SDI Data Items | | Extract Boundaries | | Column Configuration | | Add SDI Spec | | Access Control | | Sequence | | Add SDI Notes |
| | Add SDI Data Items | Define properties for the Standard Adapter Type Add SDI Data Items.
| Property Name | Description | | SDC ID | Choose an SDC ID.
| Sample | | QC Method Sample Type | | QC Batch Sample Type | | Product | | Plate |
| | Include All Primary Columns | Minimum height of the chart. | | Columns | Additional Columns. The Adapter adds all SDIDataItem keys in the data set, plus Enteredtext, Eneteredvalue, Transformvalue and Displayvalue. See also Add specs.
| Property Name | Description | | Table ID | Table from which the column is retrieved. | | Column ID | The column ID to reteive. |
| | Filter Separator | Separator character for filtered items. | | Filters | The Data Set may be filtered by given rules so that only given Parameter List items are retrieved.
| Property Name | Description | | Released Only | If Yes, only released results are added to Result Set. | | Ignore Cancelled | If Yes, data sets in Cancelled status re omitted. | | Result Entered | If Yes, only tests with results are added to the Result Set. | | SDI Data Item Filters | The Data Set may be filtered by given rules so that only given Prameter List items are retrieved. | Property Name | Description | | Param List ID | Parameter list ID to be used as filter. | | Param List Version ID | Parameter List Version to be used as filter. | | Variant ID | Parameter List Variant to be used as filter. | | Data Set | Data set to be used as filter. | | Param ID | Parameter ID used as filter. | | Param Type | Parameter Type used as filter. | | Replicate ID | Replicate ID to be used as filter. |
|
| | Sort Columns | Collection of Sort columns from Data Set | | Specifications | If Yes, the Data Item Specs are added to the Data Set. This includes the following columns: specparamlimits.limittypeid, specparamlimits.operator1, specparamlimits.operator2, sdidataitemspec.value1, sdidataitemspec.value2, sdidataitemspec.condition |
| | Extract Boundaries | Adapter properties that extract spec/limit information from the data set that has basic information, boundary id and value columns.
| Property Name | Description | | Value Column | Value Column (Y Column). | | Main Boundary Key Column | Define the key column for the Main Boundary. | | Extra Boundary Key Columns | Columns that are used to form a unique boundary in addition to the Main Boundary Key Column. | | Add Empty Boundary Values | Whether or not to show gaps in boundary lines when no boundary specified for a data point. Default is Yes. | | Boundaries | Define Boundary properties.
| Property Name | Description | | Boundary ID | Id that is matched against the value from the dataset in the Boundary ID column. If match, a new point is added to this Boundary Series. | | Value Comumn | Column containing the value for this boundary. Can be a groovy expression. Checks for values in a row. Groovy has the DataSet by name dataset and the current row index is called itemindex. | | Series ID | Series ID for this boundary, defaults to Boundary ID with possible specid and specversionid. Checks for values in a row. | | Series Group ID | Series Group ID for this Boundary. Use this to group boundaries into the same Series Group. Empty leaves all series in the same group. Can be a groovy expression. Checks for values in a row. Groovy has the DataSet by name dataset and the current row index is called itemindex. |
| | Key Columns | Columns that are common for singel results in the dataset (must not contain columns from the boundaries). | | Sort Columns | Columns to sort the result Data Set. Define the Column ID. |
| | Column Configuration | Adapter for adding pseudo columns to the data set and handling data display value rules and translations.
| Property Name | Description | | Pseudo Columns | Pseudo columns to add to the data set.
| Property Name | Description | | Column ID | N/A | | Pseudo Column | Pseudo column expression. | | Column Type | Pseudo columns to add to the data set. |
| | Columns | Existing columns in the data set.
| Property Name | Description | | Column ID | N/A | | Display Value | Pre-defined values will be changed according to this rule. | | Translate | If Yes, the data of this column is translated. |
|
| | Add SDI Spec | SDC for adding Specifications. | | Access Control | Adapter for enforcing SDC Access Control. This adapter is not needed if data is provided by query.
| Property Name | Description | | SDC ID | Target SDC ID. | | Key ID1 Column | Key ID1 column in the data set. | | Key ID2 Column | Key ID2 column in the data set. | | Key ID3 Column | Key ID3 column in the data set. |
| | Sequence | Adapter for adding a sequence number for each unique row. This adapter is useful for creating sequence based XY plots.
| Property Name | Description | | Sequence Column ID | Column to populate with sequence. Must not exist in the data set. | | Sequence Key Columns | Key columns which define a base key for creating the sequence. Rows in the data set with the same key column values will get the same sequence value. |
| | Add SDI Notes | Attach SDI notes to each SDI. SDI note rows are concatenated so that each SDI row has all its notes in a single column.
| Property Name | Description | | SDC ID | SDC ID column in the data set. | | Key ID1 Column | Key ID1 column in the data set. | | Key ID2 Column | Key ID2 column in the data set. | | Key ID3 Column | Key ID3 column in the data set. | | Column Name | Column name for the column to contain the flattened notes of a single SDI. | | Delimeter | Delimeter used between notes when they are flattened. | | Max Note Length | Maximum note length for a single flattened SDI note. |
|
| | Custom | Custom adapter properties that define a single adapter by class name and input collection. Custom adapters can be project specific.
| Property Name | Description | | Class Name | Full class name (including package) of a Java class implementing Interface DataSetAdapter. | | Inputs | Collection containing all input properties for the custom adapter. Inputs are defined as key value pairs. Define a Property ID and Value. | | Outputs | Collection for output properties from custome adapter. Define a Property ID and Variable. Property value is stored to binding map with this variable name. It is usable in following data expressions or any chart expressions. |
|
|
|
| Series Group Builder Profile |
Profile identifier for series group builders. Can be left empty. |
| Data Set |
Data Set series are visualized by the Chart. Series are organized in groups of series by series group ID.
| Property Name | Description | | Plot ID Column | Column in data set defining plot ID. Data set creator is responsible for making sure this column is present in the data set. | | Series Group ID Column | Column in data set defining series group ID. Data set creator is responsible for making sure this column is present in the data set. | | Series ID Column | Column in data set defining series ID. Series are always grouped in series groups. Data set creator is responsible for making sure this column is present in the data set. | | Plots | Collection of properties for each plot.
| Property Name | Description | | Plot ID | These properties are applied for all plots matching this ID. If this value is empty then these properties are applied to all plots in the data set (excluding those which have their own plot properties defined. | | Series Groups | Collection of properties for each series group. These properties define what kind of series is created (XY, category, pie etc.)
| Property Name | Description | | Series Group ID | Full class name (including package) of a Java class implementing Interface DataSetAdapter. | | Series Group Builders | Collection of series group builder profiles.
| Property Name | Description | | Series Group Builder Profle | N/A | | Series Group Type | Series group type defines what type of series to create (XY, category, pie, etc.) | | Time Period Values Collection | Represents a sequence of zero or more data items in the
form (period, value) where "period" is
specified by time period type property.
| Property Name | Description | | Time Period Type | Choose a period of time. | | Period Column | Period column (X) in the data set. Can be character, number, decimal or date. | | Value Column | Value column (Y) in data set. Can be character, number, decimal or date. |
| | XY Series Collection | Series group with a sequence of zero or more data items
in the form (x,y). By defaul, items in the series
will be sorted into ascending order by x-value,
and duplicate x-values are permitted.
| Property Name | Description | | X Column | X column in data set. Can be character, number, decimal or date. | | Y Column | Y column in data set. Can be character, number, decimal or date. |
| | Default Category Dataset | Series group with one or more series, and values associated with categories.
| Property Name | Description | | Category Column | Category column (X) in data set. Can be any data type. | | Value Column | Value column (Y) in data set. Can be character, number, decimal or date. |
| | Default Pie Dataset | Series group where values are associated with keys.
| Property Name | Description | | Key Column | Key column. Can be any data type. | | Value Column | Value column. Can be character, number, decimal or date. |
| | Y Interval Series Collection | Collection of series group builder profiles.
| Property Name | Description | | X Column | X column in data set. Can be character, number, decimal or date. | | Y Column | Y column in data set. Can be character, number, decimal or date. | | Y LOW Column | Y LOW column in data set. Can be character, number, decimal or date. | | Y High Column | Y HIGH column in data set. Can be character, number, decimal or date. |
|
|
|
|
|