Skip to main content

What’s New

Qrvey 8.5
Version 8.5 (LTS) of the Qrvey platform is now available to customers. This version includes several new features and performance improvements.
Learn More
End-of-life Schedule
We've added a new article that lists the features and endpoints that have been scheduled for deprecation. All features and endpoints will be supported for (1) year after the release date of the LTS version that contains the alternative.
Learn More
NodeJS Deprecation
AWS has announced that it is deprecating NodeJS 12, 14, and 16. To avoid any issues as a result of this deprecation, upgrade your instances of the Qrvey platform as described in this announcement.
Learn More

58 docs tagged with "Solution Architect"

View All Tags

Accessing Qrvey Admin Center

Qrvey Admin Center is a web-based application that is installed with every instance of the Qrvey platform. You must have an account with the Administrator role to access Qrvey Admin.

Automated Content Deployment - Commingled Data

This article describes how to perform an automated deployment of a baseline shared data application and a baseline content application between two Qrvey instances in separate environments. This article assumes a commingled tenant data model. For more information on tenant data models, see Multi-tenant Dataset Architecture.

Automated Content Deployment - Segregated Data

This article describes how to perform an automated deployment of a source baseline application between two Qrvey instances in separate environments. This article assumes a segregated tenant data model. For more information on tenant data models, see Multi-tenant Dataset Architecture.

Branding & Styling

This video describes how to customize the appearance of Qrvey Composer as well as specific applications to match your organization's branding and styling needs. It demonstrates the Customization features provided in Qrvey Admin Center, which you can use to customize your instance of Qrvey Composer. It also demonstrates the Settings feature and Style Themes feature available in Qrvey Composer, which you can use to customize the appearance of applications. Finally, this video provides an overview of the Themes API.

Column-Level Security

This video provides an in-depth overview of Column-Level Security and how to configure it. It demonstrates how to create a Role in Qrvey Admin Center, how to use the Get Dataset, Update Dataset, and Apply Dataset Changes APIs to enable Column-Level Security for a dataset, and how to include the Role in a JSON Web Token (JWT).

Configuring Time Zone Settings

The Qrvey platform enables end users to display dates and times in their local time zone. The Qrvey platform stores data in UTC/GMT+0 and adjusts the time displayed to the end user based on their preferred settings. The default time zone setting is specified in Qrvey Admin Center, but it can be overridden programmatically. The possible settings are:

Content Deployment

This video provides an in-depth overview of the Content Deployment feature in the Qrvey Admin Center. It provides an overview of each component of Content Deployment (Servers, Packages, Deployment Definitions and Deployment Jobs), and it demonstrates how to use these components to deploy content to a Qrvey instance. It also describes how to update existing content using the Content Deployment feature.

Content Publishing

This video describes how to publish the dashboards that you create in Qrvey Composer so that they are available to end users. It covers both embedded and non-embedded scenarios. Features discussed include Publish, Unpublish, Embed, and Live Preview. This video also describes how to use the Navigation feature in Page Builder, as well as an overview of the appid and pageid parameters.

Create a Qrvey Administrator Account in AWS IAM

The initial Qrvey Administrator account was created when your instance of Qrvey platform was created. You may create additional Administrator accounts using the User Management feature in Qrvey Admin Center. You also have the option to create a Qrvey Administrator account in the AWS IAM service.

Customizing Qrvey Composer

The Customization page of Qrvey Admin Center provides administrators with a variety of options for customizing their instance of Qrvey Composer.

Database Connections

You can create connections to various RDBMS by using the Database Connection feature under the Connections tab. Database connections can be created by entering the common connection attributes in the provided fields in the connection dialog, or by using the more advanced connection attributes using a JSON structure. While the former method is the default, the latter can be used to configure properties that are typically not included, such as timeout and encryption preferences.

Dataset Design

This video describes how to design datasets to support charts and visualizations, and how to create datasets using Qrvey Composer. It also discusses some advanced topics including dataset joins, column data types, shared datasets, and dataset reference views.

Dataset Syncing

This video describes how to keep your datasets up-to-date and in sync with your data sources. It covers the following methods of data set syncing:

Dataset Transformations

This video provides an overview of how to use dataset transformations to prepare your data for analysis. It describes how to create new columns of data computed from existing columns, how to standardize data across multiple columns, and how to use formulas and other techniques to prepare data for analysis.

Deployment Definitions

A Deployment Definition is a set of instructions for a deployment job. It defines the package version to use, which content from the package to include, and whether any of the content has to be modified during deployment. You can configure the deployment definition to create a new application or to update an existing application.

Deployment Jobs

A Deployment Job executes the type of deployment specified by one or more deployment definitions against one or more target servers. Deployment jobs consist of “blocks” of instructions, with each block configuring the deployment of one deployment definition to any number of users on one destination server. That means that you can have one Deployment Job deploy multiple applications to as many users as necessary, on multiple environments. Deployment jobs require at least one block.

Download Manager

Download Manager provides a central location to access and manage both exported files and scheduled exports. Exported files are created using the Download option available in a variety of features in Qrvey Composer, including Analyze, Dashboards, Automation, Subscriptions, and Pixel-perfect Reports. Types of exported files include images (JPG, PDF), data (CSV, Excel, PDF), and reports (PDF). The exported files are stored in AWS, and they are automatically deleted after seven days. For more information, see Exporting Data.

Elasticsearch Management

The Infrastructure page of the Qrvey Admin Center enables you to view, monitor, and manage the configuration of your Elasticsearch cluster.

File Upload Connection

This article describes the steps to create connections to the supported file types, which includes comma-delimited CSV, JSON, and ndJSON. You can also connect to an Amazon S3 bucket with multiple files in these formats.

Filter Design

This video provides an in-depth overview of using Filters in the Qrvey platform, including how to build Filters, the types of Filters available, and how Filters can be configured for a cascading hierarchy.

Formulas & Buckets

This video provides an in-depth overview of using Formulas and Buckets in Chart Builder to prepare data for analytics. Formulas enable you to compute values in real-time, and Buckets enable you to create partitions or groupings of data that do not already exist in the database.

Frequently Asked Questions (FAQs)

This article contains frequently asked questions organized by user persona. If you still can't find what you're looking for, ask us!

Health Dashboard

The Health Dashboard in Qrvey Admin Center provides an easy-to-read status of the health of the Elasticsearch cluster in this instance of the Qrvey platform.

Introduction to Qrvey Admin Center

Qrvey Admin Center is a web-based application used by administrators to manage and monitor the Qrvey platform. It is installed with every instance of the Qrvey platform along with Qrvey Composer. For more information on its capabilities, see the following sections:

Introduction to the Qrvey Platform

The Qrvey platform is an all-in-one analytics solution that enables SaaS providers to put cutting-edge analytics into the hands of their users. This article contains essential information required to understand how to work with the Qrvey platform.

Managing Users of Qrvey Composer

The Qrvey Admin Center enables you to create and manage user accounts in Qrvey Composer, assign roles and permissions, and set up authentication methods.

Multi-Tenancy Architecture

This video discusses multi-tenancy architecture of the Qrvey platform for SaaS organizations. Includes a demonstration of a parent application that embeds a Qrvey application in a multi-tenant environment. Topics covered include:

Multi-tenant Dataset Architecture

The first step with any self-service embedded analytics implementation is to design, develop and then populate the datasets that will become the sources for all charts, metrics and visualizations created in the platform. SaaS organizations building datasets for multi-tenant deployments of embedded analytics must think about the following topics with respect to the data architecture:

Multi-tenant Security Architecture

Qrvey’s approach to multi-tenant security architecture is to utilize the assert model for both authentication and authorization. The assert model effectively allows you to maintain your existing user accounts, roles/groups and permissions, and then declare a user’s identity and permissions to the Qrvey platform dynamically at runtime. The ability to assert/declare a user’s identity and access permissions is favorable when embedding third party platforms in your core application for a multi-tenancy deployment, because it means that you will not need to redefine and replicate your existing security schema.

Overview of Applications

A Qrvey application is a self-contained analytics project that can be used directly, shared, distributed, or embedded into other software applications. Qrvey applications connect to one or more datasets, and they typically include any number of analytics components, such as charts, reports, dashboards, and automated workflows. Qrvey applications can be created in Qrvey Composer or programmatically via API.

Overview of Content Deployment

Content Deployment is the process of copying content from one application to another, in the same environment or to a different one. Content Deployment is a powerful tool for managing all of the content generated in a multi-tenant deployment. Some examples of where this feature may be used are:

Overview of Internationalization

Qrvey platform supports internationalization and localization for end users in a comprehensive manner. Multi-lingual support is offered for both “static” and “dynamic” text, as well as formatting of numbers and dates based on regions and cultures.

Overview of Multi-tenant Deployments

SaaS organizations that want to embed self-service analytics within their core applications to support a multi-tenant deployment should think about the following considerations:

Overview of Security

This section describes how to configure security to restrict and grant access to the columns and records in the dataset. Articles include:

Overview of the Solution Architect Persona

Solution Architects use the Qrvey Admin Center to manage the infrastructure, users, and content, as well as configure Qrvey Composer. The primary technical resource for the Solution Architect is the Qrvey Admin Center User Guide.

Overview of User Management

In the User Management tab, you can not only create users and groups but also restrict access to certain portions of your application. For instance, you may wish to hide individual pages or components from certain users or allow certain groups of users to access only specific datasets.

Packages and Versions

A package enables you to create a snapshot of a selected application with all of its content and dependencies. Each snapshot is called a “version”. You can use the same package to create subsequent versions. This enables you to create different versions of this snapshot over time, as the source application changes.

Qrvey 8.2 (LTS)

Note: If you wish to upgrade to this version, please contact the CX team if you have a Managed Infrastructure contract. Otherwise, please see the Upgrade Notes document for important notes and access to the upgrade link.

Qrvey Videos

This section of the Qrvey Partner Portal contains a wide variety of short training videos to help you better understand how to work with the Qrvey platform. They are divided into the following categories:

Row-Level Security

This video provides an in-depth overview of Row-Level Security, which is especially important for multi-tenant environments. It demonstrates how to enable Row-Level Security for the columns in a dataset, and how to configure a widget in code to enforce Row-Level Security. It also describes how to enable Record-Level Security in the Qrvey Admin Center.

Security Groups

This video describes how to use Security Groups to manage user accounts. Topics discussed include the difference between the two primary users of Qrvey dashboards, Composers and Consumers, and how they relate to a Security Group Model. This video then demonstrates how to create Composers using Qrvey Admin Center and how to create Consumers using Qrvey Composer. It also describes how to use the Qrvey API to programmatically create users and groups.

Security Overview

This video provides an overview of the Security features in the Qrvey platform. Topics discussed include authentication versus authorization, configuring user roles and groups, and configuring role-level security and column-level security.

Servers

Each instance of the Qrvey platform is considered a “server”. Servers are identified by the base URL for the Qrvey instance. For example, the base URL of a Qrvey instance looks something like https://abcde.qrveyapp.com. In this example, the Qrvey instance can be uniquely identified by its five character subdomain abcde. Each Qrvey instance is referred to as a “server” within Content Deployment, but this term is also synonymous with “environment”. A server includes Qrvey Composer, Qrvey Admin Center, the ElasticSearch cluster, users of the instance, and all content and related metadata.

Using Google as the OpenID Provider

Before Creators can use the OpenID provider to log in, you must set up your OpenID provider account in order to obtain the OAuth 2.0 credentials: ClientID, Client Secret, Realm; set a redirect URL (Return URL); and optionally, customize the branding information that creators will see on the user-consent screen.

Using OAuth as the OpenID Provider

Before Creators can use the OpenID provider to log in, you must set up your OpenID provider account in order to obtain the OAuth 2.0 credentials: ClientID, Client Secret, Realm; set a redirect URL (Return URL); and optionally, customize the branding information that creators will see on the user-consent screen.

Widgets Overview

This video provides an in-depth overview of Widgets in Qrvey. It defines Widgets, describes the process for embedding Widgets in an application, provides real-life examples of embedded Widgets, and describes Widget best-practices.

Workflows

This video demonstrates how to use the Automation feature in Qrvey Composer to create a workflow.