Query

The Query activity submits a query to a table on a TIBCO Patterns server to retrieve a record set.

General

The General tab has the following fields:

Query Configuration Fields

Field

Module Property?

Description

Name

No

The name of the activity within the process. The default value is query.

Patterns Connection

Yes

The path to the shared configuration resource which contains the Patterns Connection information. See Activities Connection.

Show Tables

No

The Show Tables button displays information on existing tables, thesauri, character maps, and learn models that might be useful during query design.

Description

Provide a short description for the Query activity.

Input

The Input tab has the following fields:

Query Input Fields

Input Item

Description

TableName

Name of the table to search.

AnyQueryOutput

The output of any querylet activity.

MatchesRequested

The number of match results desired. The default is 25.

StartingMatch

The rank of the first result to be returned. The default is 1.

FilteringPredicate

A predicate to restrict search results. This is optional.

FilteringPredicate/Expression

A predicate expression.

FilteringPredicate/FallEmpty

If set to true(), the query faults if an empty value is encountered. The default is set to true().

FilteringPredicate/FallInvalid

If set to true(), the query faults if an invalid value is encountered. The default is set to true().

Cutoff

Defines a rule for cutting off the returned output. Cutoff is an optional group (contains Type and Value).

Cutoff/Type

The type of cutoff processing to perform. The following are the possible types:

Absolute: Sets a hard lower limit on the match score.
ExactPlusScore: Only exact matches, and the specified number of inexact matches are returned.
PercentOfTop: Results below the specified percentage of the top score are not be returned.
SimpleGap: Results are cut off if the specified gap in scores occurs.

This is required if Cuttoff is given.

Cutoff/Value

The value to apply for the cutoff. This is required if Cuttoff is given.

HtmlVisualization

Sets HTML visualization formatting options. This is optional.

HtmlVisualization/BaseColor

The color used to indicate a weak match. This is optional.

HtmlVisualization/MatchColor

The color used to indicate a strong match. This is optional.

HtmlVisualization/BaseBackgroundColor

The background color used to indicate a weak match. This is optional.

HtmlVisualization/MatchBackgroundColor

The background color used to indicate a strong match. This is optional.

HtmlVisualization/MaxFontSize

The HTML font size to use for strong matches. This ranges from 0 to 3. This is optional.

HtmlVisualization/ItalicsThreshold

Set the threshold for italicizing visualization data. This is optional.

HtmlVisualization/BoldThreshold

Set the threshold for bolding visualization data. This is optional.

HtmlVisualization/UnderlineThreshold

Set the threshold for underlining visualization data. This is optional.

CustomTieBreak

Control how records are ordered in the event that multiple records receive the same score. This item is optional and can be repeated.

CustomTieBreak/ID

Identifies the tiebreak rule. 2 - Record ID, 3 - Alignment, 4 - scoretype, 5 - field value.

CustomTieBreak/Parameter

Parameter for tie break rule. Value depends on rule.

The following inputs provide defaults for all querylets under the query as appropriate for the query type.

Query Input Fields for Querylets

Field

Description

EmptyScore

The score to use if there is no data to compare.

InvalidScore

The score to use if the record has invalid data.

MatchEmpty

If set to true(), empty values in both the record and the query produces a 1.0 queylet score.

ScoreType

The type of score to perform. The following are the possible types: Normal, Symmetric, Reverse, Max, or Min. The default is Normal. This is optional.

ThesaurusName

Name of an existing thesaurus to apply. This is optional.

ThesaurusWeight

Weight of thesaurus. The default is 1.0. This is optional.

TemporaryThesaurus

See Simple Querylet Input Fields.

ExpertParameter

Only use this under the direction of TIBCO Support.

The following inputs are advanced tuning parameters and only used under the direction of TIBCO Support.

Query Advanced Inputs

Parameter

Description

FetchSize

Tuning parameter, only use on the advice of your TIBCO representative.

PCSize

Tuning parameter, only use on the advice of your TIBCO representative.

QCSize

Tuning parameter, only use on the advice of your TIBCO representative.

GpuIndexing

Set to true() to enable GPU harnessing on the table.

GpuCallParallelism

The number of GPU channels to use when processing the query. The Patterns Server calculates a default value; setting this may improve performance in some situations, but usually degrades performance.

TableBlocksPerGpuCall

The number of memory blocks to use per GPU unit. The Patterns Server calculates a default value; setting this may improve performance in some situations, but usually degrades performance.

Output

Query Output

Parameter

Description

FilterTime

Performance statistic: cpu usage of search filters.

FilterTime/Name

Name of the filter.

FilterTime/Time

Time used by filter.

FilterOutput

Output sizes, by filter.

FilterOutput/Name

Name of the filter.

FilterOutput/Size

Number of records output by the filter.

ResultConfidence

The overall confidence measure for the result set. The result confidence is the minimum confidence of any record in the returned result set.

MinConfidence

The minimum confidence value seen at any point during the processing of this query. This value can be used to determine if a Learn Model is processing poorly trained situations even if the records involved were not returned in the final return set.

QueryResult

One per result returned by the search. This is optional and can be repeated.

QueryResult/MatchScore

The final match strength of the record in the search.

QueryResult/MatchRank

The rank of the record in the search.

QueryResult/MatchRecord

Details of the record that matched the query.

QueryResult/MatchRecord/Field

A field of the matched record. This can be repeated.

QueryResult/MatchRecord/Field/Name

Name of the matched field.

QueryResult/MatchRecord/Field/Value

Value of the matched field.

QueryResult/MatchRecord/Field/Type

Type of the matched field.

QueryResult/MatchRecord/Field/Visualization

Populated only if HTML visualization is requested.

QueryResult/MatchRecord/Attribute

A variable-attribute of the matched record.

QueryResult/MatchRecord/Attribute/Name

Name of the attribute.

QueryResult/MatchRecord/Attribute/Value

Value of the attribute.

QueryResult/Dirty

This is true() if the record is in a dirty state. A dirty record is one that has been modified by a transaction that is still open.

QueryResult/SourceTable

The name of the table from which the record came from.

QueryResult/SourceTableInfo

The table info field for the table from which the record came from.

QueryResult/Scores

The match strengths of the record in the search.

QueryResult/Scores/Normal

The Normal match strength of the record in the search.

QueryResult/Scores/Symmetric

The Symmetric match strength of the record in the search.

QueryResult/Scores/Reverse

The Reverse match strength of the record in the search.

QueryResult/Scores/Min

The Min match strength of the record in the search.

QueryResult/Scores/Max

The Max match strength of the record in the search.

QueryResult/QueryletScores

There is one score per top-level querylet. This can be repeated.

QueryResult/QueryletScores/Normal

The Normal match strength of the querylet in the search.

QueryResult/QueryletScores/Symmetric

The Symmetric match strength of the querylet in the search.

QueryResult/QueryletScores/Reverse

The Reverse match strength of the querylet in the search.

QueryResult/QueryletScores/Min

The Min match strength of the querylet in the search.

QueryResult/QueryletScores/Max

The Max match strength of the querylet in the search.

QueryResult/RLinkConfidence

If the top querylet is an RLINK query, this parameter holds an estimate of how confident the Model is in the prediction it made.

QueryResult/RLinkSignificance

If the top querylet is an RLINK query and the returned match score is above 0.5, this parameter shows the significances of the model features. This can be repeated.

QueryResult/NamedQueryletResult

If named querylets were used, this parameter holds information on each named querylet.

QueryResult/NamedQueryletResult/QueryletName

The Querylet name.

QueryResult/NamedQueryletResult/Score

Match score of the querylet.

QueryResult/NamedQueryletResult/Confidence

Confidence of the querylet.