The Available Trillium Parameters for OLE DB table describes each parameter (shown in alphabetical order), lists the queries that support the parameter, and gives syntax examples. Whereas the the Available Trillium Parameters for OLE DB, by Query table lists all queries in alphabetical order and the parameters they support.
| Parameter | Supported Queries | Description | Syntax Example |
|---|---|---|---|
|
abr |
view_br_fail |
The ID of the attribute business rule for which you want to see failing rows. This ID is the Sequence Number attribute in the Control Center. |
view_br_fail? eid=1&aid=11&abr=1 |
| add_key | view_attribute_values | Useful for maintaining referential integrity and Include the columns containing entity ID and attribute ID. | add_key=1 |
| view_br_fail | Include the columns for entity ID and business rule ID. | ||
|
view_entity_values view_rows |
Include the columns for entity ID. | ||
|
view_attribute_decimal_values view_attribute_integer_values view_attribute_string_values view_attribute_values view_attribute_values_discovered_dependencies view_attribute_values_discovered_joins view_attribute_values_discovered_keys view_attribute_values_mask view_attribute_values_metaphone view_attribute_values_pattern view_attribute_values_permanent_dependencies view_attribute_values_permanent_joins view_attribute_values_permanent_keys view_attribute_values_soundex view_entity_values_discovered_dependencies view_entity_values_discovered_joins view_entity_values_discovered_keys view_entity_values_permanent_dependencies view_entity_values_permanent_joins view_entity_values_permanent_keys |
Include the attribute and entity ID column value data. | ||
| aid |
show_attribute_names view_attribute_decimal_values view_attribute_integer_values view_attribute_string_values view_attribute_values view_attribute_values_discovered_ dependencies view_attribute_values_discovered_joins view_attribute_values_discovered_keys view_attribute_values_mask view_attribute_values_metaphone view_attribute_values_pattern view_attribute_values_permanent_ dependencies view_attribute_values_permanent_joins view_attribute_values_permanent_keys view_attribute_values_soundex view_br_fail |
List of one or more attribute IDs from which to retrieve the view. | aid=1; aid=1%202 |
| baseline | show_baseline | List of one or more Baseline Analysis project IDs. | baseline=5; baseline=6%207%208 |
| columns | All queries supported by OLE DB, except entity and TS test. | List of columns to return. When omitted, a default selection is returned. Use internal column names or the names displayed in the Control Center. See Column Names for a list of names or check the mtb_server.log file. | columns=FAILING_ROWS: returns only values in the Failing Rows column. |
| ebr | show_br_groups | When a single entity is specified, use this optional parameter to display groups for the specified rule only. | eid=1&ebr=12 |
| view_br_fail | The ID of the entity business rule for which you want to see failing rows. This ID is the Sequence Number attribute in the Control Center. | ||
| eid |
show_all_br show_attribute_names show_br_groups show_br_metadata show_entity_member_attributes show_entity_metadata show_failing_br show_tsq_project_names view_attribute_decimal_values view_attribute_integer_values view_attribute_string_values view_attribute_values view_attribute_values_discovered_ dependencies view_attribute_values_discovered_joins view_attribute_values_discovered_keys view_attribute_values_mask view_attribute_values_metaphone view_attribute_values_pattern view_attribute_values_permanent_ dependencies view_attribute_values_permanent_joins view_attribute_values_permanent_keys view_attribute_values_soundex view_br_fail view_entity_fail view_entity_values view_entity_values_discovered_ dependencies view_entity_values_discovered_joins view_entity_values_discovered_keys view_entity_values_permanent_ dependencies view_entity_values_permanent_joins view_entity_values_permanent_keys view_rows |
List of one or more entity IDs from which to retrieve the view. | eid=1; eid=1%202 |
| generations |
show_all_br show_br_groups show_br_metadata show_entity_member_attributes show_entity_metadata view_entity_values view_entity_values_discovered_ dependencies view_entity_values_discovered_joins view_entity_values_discovered_keys view_entity_values_permanent_ dependencies view_entity_values_permanent_joins view_entity_values_permanent_keys |
Use with the tsa parameter to indicate how many entity generations to retrieve: ngenerations=1: returns the newest entity (the latest entity generated in the project) ngenerations=2: returns the 2 most recent entities ngenerations=n: returns the n most recent entities |
tsa=5&generations=2 |
| max_per_rule |
view_entity_fail |
Set the maximum number of rows to retrieve for each failing entity business rule. If no value is specified, the first 100 rows for each failing entity business rule are returned. Use with the max_rows parameter to limit the total number of rows returned for all failing entity business rules. For example, view_entity_fail?eid=1&max_per_rule=5&max_rows=1 returns the first row for the first failing ebr. Note: The max_rows parameter takes precedence over the max_per_rule
parameter. Ensure their values do not conflict.
|
eid=1&max_per_rule=5 |
| max_rows |
view_attribute_decimal_values view_attribute_integer_values view_attribute_string_values view_attribute_values view_attribute_values_discovered_ dependencies view_attribute_values_discovered_joins view_attribute_values_discovered_keys view_attribute_values_mask view_attribute_values_metaphone view_attribute_values_pattern view_attribute_values_permanent_ dependencies view_attribute_values_permanent_joins view_attribute_values_permanent_keys view_attribute_values_soundex view_br_fail view_entity_fail view_entity_values view_entity_values_discovered_ dependencies view_entity_values_discovered_joins view_entity_values_discovered_keys view_entity_values_permanent_ dependencies view_entity_values_permanent_joins view_entity_values_permanent_keys view_rows |
Set the maximum number of rows to retrieve across the dataset. If no rows are specified, 100 rows are returned by default. | max_rows=500 |
| pid |
show_all_br show_attribute_trend show_br_groups show_br_metadata show_entity_member_attributes show_entity_metadata show_entity_values show_entity_trend show_project view_entity_values view_entity_values_discovered_ dependencies view_entity_values_discovered_joins view_entity_values_discovered_keys view_entity_values_permanent_ dependencies view_entity_values_permanent_joins view_entity_values_permanent_keys |
List of one or more Baseline Analysis project IDs. | pid=10%2011 |
|
proj_type |
show_project | Set to Time Series Analysis (tsa or 1) or Quality (tsq or 2) to show only Time Series or Trillium Quality projects, respectively. When omitted, the default is to return both. |
nproj_type=tsa: returns only values for Time Series Analysis projects nproj_type=2: returns only values for Quality projects |
|
show_disabled |
show_all_br | Return rules that are disabled. | show_disabled=1 |
| tsa |
show_all_br show_br_groups show_br_metadata show_entity_member _attributes show_entity_metadata view_entity_values view_entity_values_discovered_ dependencies view_entity_values_discovered_joins view_entity_values_discovered_keys view_entity_values_permanent_ dependencies view_entity_values_permanent_joins view_entity_values_permanent_keys |
List of one or more Time Series Analysis project IDs. Add the generations parameter to view a specified number of generations. | tsa=5; tsa=2&generations=2 |
| show_project |
Set to Time Series Analysis (tsa or 1) or Quality (tsq or 2) to show only Time Series or Trillium Quality projects, respectively. When omitted, the default is to return both. |
ntype=tsa: returns only values for Time Series Analysis projects ntype=2: returns only values for Quality projects |
|
|
view_attribute_values |
Set the type of view to return. If no type is specified, the query returns the type values by default. |
Use with eid and aid parameters. For example: view_attribute_values?eid=1&aid=1&type=strings. Variables include: ndecimals ndiscovered_dependencies ndiscovered_keys ndiscovered_joins nintegers nmetaphones nmasks nnulls npatterns npermanent_dependencies npermanent_joins npermanent_keys nsoundexes nstrings nvalues |
|
| view_entity_values | Set the type of view to return. |
Use with the eid parameter. For example: view_entity_values?eid=1 &type=permanent_keys. Variables include: ndiscovered_dependencies ndiscovered_keys ndiscovered_joins npermanent_dependencies npermanent_joins npermanent_keys |