Skip to main content
All CollectionsExplore Reports
Guidelines for Search
Guidelines for Search

Learn to search within Petavue

Updated over a week ago

Overview

In Petavue, business users can perform the following searches in the business language:

  1. Search for Reports

  2. Search for Drill-Downs

  3. Search for Columns that can be added

  4. Search for Charts

For each of the different searches mentioned above, there are some guidelines that the user must keep in mind.

Search for Report

When searching for Reports, users can ask questions in business language based on the definitions and drill-downs configured within the system. Also, Petavue supports only a defined list of operations when performing drill-downs. The boundary conditions and supported operations are listed below:

Boundary Conditions

  1. Definitions:

    • Users can only ask questions about the Definitions that have been configured in the system. These Definitions represent the main metrics or business insights available for querying. For example, a definition might be "Sales Cycle Length," and users can ask questions related to this definition.

  2. Drill-Down Fields:

    • Users can only filter or group data based on the drill-down fields defined during the configuration of the definitions.

    • Drill-down fields include columns tagged as "drill-down" during the setup of the data by the admin.

  3. Supported drill-down operations:

    • The system currently supports only the following:

      • Filtering: Users can filter data based on the values in the drill-down fields (e.g., filtering by specific values in "Industry" or "Account Category").

      • Grouping: Users can group data based on drill-down fields (e.g., grouping by "Stage Name" or "Amount").

  4. Supported operations on data types:

a. Filter by operations

Boolean

is equals

is not equal

is null

is not null

Number

equals

not equals

greater or equal

less or equal

less than

greater than

between

is null

is not null

in

not in

String

equals

not equals

contains

does not contain

in

not in

starts with

ends with

is null

is not null

Enum

in

not in

is null

is not null

contains

starts with

ends with

Multi enum

all

any

not in

is null

is not null

Date (support only for equals today)

Custom

Date

Year

Quarter Year

Calendar Month Year

Calendar Year

This Year

Last Year

Next Year

Last N Years

Next N Years

Fiscal Year

This Fiscal Year

Last Fiscal Year

Next Fiscal Year

Last N Fiscal Years

Next N Fiscal Years

Fiscal Quarter/Quarter

This Fiscal Quarter

Last Fiscal Quarter

Next Fiscal Quarter

Last N Fiscal Quarters

Next N Fiscal Quarters

Calendar Month

This Month

Last Month

Next Month

Last N Months

Next N Months

Calendar Week

This Week

Last Week

Next Week

Last N Weeks

Next N Weeks

Calendar Days

Today

Yesterday

Tomorrow

Last N Days

Next N Days

Before

N Calendar Year

N Fiscal Year

N Quarter

N Month

N Week

Date

Quarter Year

After

N Calendar Year

N Fiscal Year

N Quarter

N Month

N Week

Date

Quarter Year

b. Group by operations

Type

Boolean

Number

String

Enum

Multi enum

Date - Year

Date - Fiscal Year

Date - Quarter

Date - Month

Date - Week

Search for Drill-downs

When searching for drill-downs on top of a selected report, users can search using business language based on drill-downs configured for the selected definition in the report. Also, Petavue supports only a defined list of operations when performing drill-downs. The boundary conditions and supported operations are listed below:

Boundary Conditions

  1. Definitions:

    • Users can drill down only on the selected definition in the report. The available drill-down options are based on the drill-down fields configured for that definition. For example, if the chosen report is for "Sales Cycle Length," users can drill down into the dimensions specifically configured as drill-downs for the "Sales Cycle Length" definition.

  2. Drill-Down Fields:

    • Users can only filter or group data based on the drill-down fields defined during the configuration of the definitions.

    • Drill-down fields include columns tagged as "drill-down" during the setup of the data by the admin.

  3. Supported drill-down operations:

    • The system currently supports only the following:

      • Filtering: Users can filter data based on the values in the drill-down fields (e.g., filtering by "Industry" or "Account Name").

      • Grouping: Users can group data based on drill-down fields (e.g., grouping by "Stage Name" or "Amount").

  4. Supported operations on data types:

a. Filter by operations

Boolean

is equals

is not equal

is null

is not null

Number

equals

not equals

greater or equal

less or equal

less than

greater than

between

is null

is not null

in

not in

String

equals

not equals

contains

does not contain

in

not in

starts with

ends with

is null

is not null

Enum

in

not in

is null

is not null

contains

starts with

ends with

Multi enum

all

any

not in

is null

is not null

Date (support only for equals today)

Custom

Date

Year

Quarter Year

Calendar Month Year

Calendar Year

This Year

Last Year

Next Year

Last N Years

Next N Years

Fiscal Year

This Fiscal Year

Last Fiscal Year

Next Fiscal Year

Last N Fiscal Years

Next N Fiscal Years

Fiscal Quarter/Quarter

This Fiscal Quarter

Last Fiscal Quarter

Next Fiscal Quarter

Last N Fiscal Quarters

Next N Fiscal Quarters

Calendar Month

This Month

Last Month

Next Month

Last N Months

Next N Months

Calendar Week

This Week

Last Week

Next Week

Last N Weeks

Next N Weeks

Calendar Days

Today

Yesterday

Tomorrow

Last N Days

Next N Days

Before

N Calendar Year

N Fiscal Year

N Quarter

N Month

N Week

Date

Quarter Year

After

N Calendar Year

N Fiscal Year

N Quarter

N Month

N Week

Date

Quarter Year

b. Group by operations

Type

Boolean

Number

String

Enum

Multi enum

Date - Year

Date - Fiscal Year

Date - Quarter

Date - Month

Date - Week


Search for Columns that can be added

When searching for columns to be added to an existing report, users can search using business language to find direct columns that can be added to the output and also create calculated columns based on the columns already available in the report. The boundary conditions for adding direct columns and calculated columns are listed below:

Boundary Conditions

  1. Add columns from source

    • Users can only add columns from tables that are already part of the final report generation process.

    • The complete list of available columns to add is made available in the Add columns section

    • A foreign key cannot be included in the report unless the referenced table itself is part of the final output.

      • Example - To add a foreign key column (e.g., Account ID from the Opportunities table), the corresponding referenced table (e.g., Accounts) must also be included in the report.

    • Columns cannot be added to the report when a group-by operation is applied.

  2. Add calculated columns

    • Fields used in calculations must be from data available in the report's output table.

    • Supported operations include arithmetic, string, date, and percentage calculations.

    • Calculated columns can still be added when a group-by operation is applied to the report

Search for Charts

When searching for charts to be added to an existing report, users can use business language to explore all available charting options for the report. The conditions for adding charts are outlined below:

Boundary Conditions

  1. Supported Charts

    • The system currently supports only the following:

      • Pie chart

      • Column chart

      • Line chart

  2. Charting Recommendations

    • Chart options are only available when the report table contains more than one row.

    • Chart suggestions are generated based on the columns available in the final report output.

    • Users can search for additional chart suggestions using natural language, limited to the context of the report and its columns.

Did this answer your question?