DOCSEARCHbyAlgolia
Submit Docs

Qrvey Documentation

website·Indexed 35 days ago

https://partners.qrvey.com

Developer and deployment documentation for the Qrvey platform, covering embeddable widgets (Dashboards, Sidekick AI, Pixel-Perfect Reports, Automation), internationalization (i18n), and AWS deployment configurations for OpenSearch, Postgres, Snowflake, and Redshift. Includes technical details for versions 9.3, 9.4, and 9.5.

Tokens
1.4M
Snippets
2.8K
Records
10.4K
Agent score
50%

What's inside Qrvey

  1. Overview of Qrvey Internationalization (i18n) Workflow

    Qrvey uses a Google Spreadsheet-based system to manage translations for two types of text:

    • Static Text: Built-in product elements like titles, labels, tooltips, buttons, and menus.
    • Dynamic Text: User-entered content such as Dataset names and column names.

    The workflow involves using a Translation Spreadsheet to house keys and translations, a Google Cloud Platform (GCP) account for API access, and the Qrvey Translation Service Utility to import keys and publish translated values back to the platform.

  2. Overview of Formulas and Buckets in Chart Builder

    In Chart Builder (Version 9.5), Formulas and Buckets are used to prepare data for analytics. Formulas allow for the real-time computation of values, while Buckets allow users to create custom partitions or groupings of data that are not natively present in the database.

  3. Overview of Column-Level Security

    Column-Level Security (CLS) allows organizations to restrict visibility of specific columns within a dataset based on user roles. This is particularly useful for protecting sensitive data (e.g., salaries, PII) while using a single dataset across multiple dashboards for different audiences.

    Key Mechanics:

    • User Roles: Defined in the Qrvey Admin Center.
    • Column Permissions: Controlled via the accessRoles property on the dataset columns.
    • Validation: When a widget loads, Qrvey compares the roles passed in the qvToken (JWT) against the accessRoles defined in the dataset. If a match is found, the column is displayed. If accessRoles is empty, the column is visible to everyone.

    Limitations:

    • CLS applies only to embedded widgets (Dashboards and Pixel-Perfect Reports).
    • CLS is NOT applied in Composer or other internal UI components; all columns remain visible during design time.

  4. Overview of Column-Level Security (CLS)

    Column-Level Security (CLS) allows administrators to restrict access to specific columns within a dataset to users belonging to predefined roles. If a user is not a member of an assigned role for a specific column, they cannot view that data or reference it in supported embedded widgets.

    Constraints:

    • Only supported for embedded widgets.
    • Only supported for the following UI components: Dashboards and Pixel-Perfect Reports.
    • By default, all users have access to all columns in a dataset.

  5. Overview of Qrvey Table Calculations

    Table Calculations produce new columns of data by executing predefined aggregate functions against existing columns. Any data column added to the 'Values' or 'Other Values' shelves in the Chart Builder UI can serve as a source for these calculations.

    Supported Chart Types: Bar, Line, Multiseries, Combo Charts, and Heatmap.

    Configuration Fields:

    • Column: The source column from the Values/Other Values shelves.
    • Calculation Type: The aggregate function to apply (e.g., Running Calculations or Difference Calculations).
    • Level: Determines the scope of the calculation when multiple groups exist (e.g., calculating per year and restarting, or calculating for the entire table). Default is 'Table'.
    • Custom Label: A name for the calculation used for identification within the panel.
    • Remove: Deletes the calculation.

  6. Overview of Column Level Security (CLS)

    Column Level Security (CLS) allows administrators to restrict data access at the column level within a dataset to users belonging to one or more predefined roles. Users must be members of at least one assigned role to view the data in that column or reference it in supported widgets. By default, all users have access to all columns.

    CLS is currently only supported for embedded widgets and the following UI components:

    • Dashboard View
    • Dashboard Builder
    • Reports

  7. Overview of Qrvey Connections

    A connection in Qrvey is a secure link established between the platform and an external data source. Supported sources include databases, data warehouses, CSV/JSON files, cloud storage (such as AWS S3), and incoming data from REST APIs.

  8. Introduction to Pixel-Perfect Reports Builder

    The Pixel-Perfect Reports Builder allows for the creation of customizable report templates with pixel-level control over positioning and styling. This is specifically designed for outputs requiring exact specifications, such as audit reports, tax forms, regulatory documents, and shipping labels, providing rigorous control for PDF and print output.

    Key behavior: Fixed templates in the editor do not contain live data; values are resolved during the Preview or Export process, which generates the final output across as many pages as necessary.

  9. Overview of Qrvey Content Deployment

    The Content Deployment feature in the Qrvey Admin Center allows users to deploy and update content across Qrvey instances. The process involves four primary components: Servers, Packages, Deployment Definitions, and Deployment Jobs.

  10. Overview of Qrvey Download Manager

    The Download Manager is a central hub for accessing and managing exported files and scheduled exports. Exported files are generated via the 'Download' option in Analyze, Dashboards, Automation, Subscriptions, and Pixel-Perfect Reports. Files are stored in cloud storage and are automatically deleted after seven days. The Download Manager is an embeddable widget and must be embedded separately from other widgets.

  11. Overview of Column-Level Security (CLS)

    Column-Level Security (CLS) allows administrators to restrict data access at the column level within a dataset. Users must belong to at least one of the assigned roles to view data for a specific column or reference it in a supported widget. By default, all users have access to all columns. CLS is only supported for embedded widgets using the following UI components:

    • Dashboards
    • Pixel-Perfect Reports