Page History

Enable View for Guided NLQ

Toggle this on to enable Guided NLQ for this view. This is the only mandatory option on this page for enabling Guided NLQ.

Off

Primary Date Field

From this dropdown, select the default date field for Guided NLQ to use. When your question contains the date range (for example, ‘Show profit margin for this month’), Guided NLQ will use this date field, which you can alter. 

Note that this field is also used for Assisted Insights. An additional field called Scope of Analysis - Date Period will appear when this field is not empty and it is used only for Assisted Insights. Therefore, you can ignore the Scope of Analysis - Date Period field for Guided NLQ.

None

From this dropdown, select from one of the predefined date periods. If a user enters and submits a question without a date period, this default date period will be appended automatically to the question. This can be used to prevent users running questions that are not restricted by time and might otherwise create long-running database queries.

Custom Help Text - NLQ

Add content to this text field if you wish to display any specific text for the current view. When using this view with Guided NLQ, this text will be displayed on the dropdown for switching views, alongside the view name and description. 

None

– 

A dropdown on the left displays any default aggregation applied to the field. This can be edited from the dropdown if required.

System-wide

–

– 

The field name can be edited here, but note that it will be updated everywhere else it’s used (the view, reports etc.).

System-wide

–

Guided NLQ

Use this checkbox to enable or disable Guided NLQ at field level. If the checkbox is greyed out, check for these situations and correct, if necessary.

• You selected the field as the view’s Primary Date Field in the previous steps.
• The date field has been formatted using an unsupported formatter such as the datePart formatter (they should be formatted using the DateFormatter or Timestamp formatter for use with Guided NLQ).
• The field is part of a date hierarchy. Date hierarchies work on granularity (for example, year, month, week day), and each date field in a hierarchy is automatically checked and greyed out to prevent unchecking to ensure the hierarchy functions correctly within Guided NLQ.

Guided NLQ only

Unchecked

Plural (dimensions only)

Only editable if a field has been enabled for either Assisted Insights or Guided NLQ. In Guided NLQ, this will ensure that plurals are shown as needed when someone is asking a question, and when certain types of results are displayed.

Assisted Insights, Signals and Guided NLQ

–

Format

This dropdown lets you customize the format of metrics and dates. For example, you can use the typical date format options to display a yyyy-MM-dd date as MM d yyyy. 

You may also set the date default after you’ve chosen your preferred format by clicking on the date displayed on the dropdown above the Custom menu option.
You can also set date granularity via this dropdown (see Granularity, below).

Guided NLQ

—

Granularity

This column is displayed only if the date field uses DateFormatter or TimestampFormatter. Use this field to see and set the date granularity with one click using this dropdown menu. When a date field appears in a question, Guided NLQ uses its granularity as the suggested default and when building charts with a date axis. 

System wide

—

Custom Chart Color

Any custom chart colors set here will be used when Guided NLQ creates charts.

System wide

—

Filter Value Case

Selecting Uppercase or Lowercase for this field activates a backend operation which converts the filter value into the selected case. Anything you set for a field here will be used when Yellowfin runs an SQL query with this field. It is never reflected in how field values are displayed when asking a question within Guided NLQ.

System wide

Mandatory Filter

If a dimension or date field has this option set, it must be included with every Guided NLQ question. In Guided NLQ, an orange dot will appear next to mandatory fields in the dropdowns for the date blocks and ‘Where’ blocks of a sentence (these are the two clauses where filters can be used). Make sure that anyone using Guided NLQ with a view with mandatory filters is aware of the mandatory filters.

System wide

—

Field Usage Restrictions

This red checkbox works differently to the blue tick-style checkboxes. If a red checkbox on the dropdown is checked, some restrictions have been applied. Click on the dropdown to see the full list. 

The Load Filter Values is used only for Guided NLQ. For fields with many values, this option can be disabled (red cross on) to prevent Yellowfin from querying the database for possible values when Guided NLQ displays the field values as a list. This can improve performance of the system. The user can instead type a value.

System wide (excluding Load Filter Values which is used for

Guided NLQ only)

Load Filter Values is enabled (red cross off)