59 docs tagged with "Software Developer"

When embedded in an application, the Analytic Suite widget enables users to display the distinct views available on the analyze side (i.e Summary, Table, Custom, and Metric views).

This article discusses the architecture of the Qrvey platform and how all of our components work together to deliver on the promise of a unified, all-in-one data solution. If you are new to Qrvey, first see Introduction to the Qrvey Platform.

Haven’t found what you were looking for?

The Automation widget enables you to embed the Automation functionality into your application.

Overview

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).

Introduction

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:

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.

Qrvey Composer supports the configuration of Push API connections from the Connections page within the Dataset UI. This feature provides “creator” users a low-code way to create datasets that are populated from a specified API connection. Configuring a dataset to use a Push API connection is a two-step process. First, a Push API connection type with a sample JSON object structure must be supplied. Second, the dataset must be configured to refer to the Push API connection for the expected metadata schema, and then the API connection details must be configured to perform the data push.

This article describes how to create a dataset from scratch using the Qrvey endpoint, Create Dataset. This endpoint enables you to set the properties of all dataset elements that you want to create. To learn more about how datasets work in Qrvey Composer, see Overview of Datasets.

A dataset view is a type of reference dataset that points to another dataset as its source. Dataset views allow you to create a customized view of a dataset for users with access to the application where the dataset view resides. Dataset views only belong to a single application; however, the source dataset can belong to a different application. Dataset views are recommended whenever you want to share data amongst users with access to different applications and avoid replicating and copying large datasets.

This article provides guidelines for properly using CSS to customize the visual theme of embedded widgets.

When embedded in an application, the Dashboard Builder widget enables users to modify existing dashboards or add new dashboards. Dashboards may contain reports, web forms, or other content.

The Dashboard View widget enables you to embed one or more dashboards or a mashup of several charts, maps, and metrics into your application.

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.

The Download Manager widget enables users to access and manage exported files in a central location. For more information about this feature, see Download Manager.

Qrvey has two different embedding options available if you'd like to display your web form on a website, blog, web or mobile application.

When you are embedding Qrvey widgets in your applications, you need to keep in mind that you have to authenticate and authorize the use of the widget to the Qrvey system. Usually, this authentication process is done directly on the widget’s configuration object. However, as you send sensitive information (API-KEY, User Security Settings, etc.), using this method to pass these parameters is not recommended as it is not a secure way to do it.

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.

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

When using the Qrvey API in production environments, it is strongly suggested to use a secure JSON Web Token (JWT) for authentication. Include the token in the request header when accessing an endpoint. The Qrvey API supports two types of tokens, depending on which set of endpoints you wish to call:

Introduction

Everything that is created in Qrvey Composer is ultimately for the benefit of an “End User”. In some cases, the Data Analyst persona may be the same as the End User, and in other cases they may be different people. However, in all cases, the permissions and interactions with the content are different between the two personas: Data Analysts create content that End Users interact with.

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.

Software Developers embed Qrvey widgets in their host applications and use Qrvey APIs to programmatically interact with the Qrvey platform. This section of the Qrvey Partner Portal provides Software Developers with the information they need to perform these tasks. Articles include:

This video provides an in-depth overview of how to securely integrate Qrvey widgets using JSON Web Tokens (JWT). JWT enables you to encrypt sensitive data, such as your organization’s API access key, logged-in user’s ID and role, as well as sensitive record-level security filters. This video demonstrates how to securely embed the Page View widget in an application using a JWT token, which includes examples of front-end and back-end code.

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:

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.

You can create and manage your connections to various data sources in the Connections tab.

Developers can seamlessly embed the Qrvey platform’s self-service data collection, automation, and analytics functionalities into their web applications. The Qrvey platform provides a comprehensive suite of “widgets” that are directly embedded into applications using simple Javascript and custom HTML tags. These widgets provide various front-end application features, including web form builders, data visualizations, and more.

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.

Qrvey provides a comprehensive set of REST APIs that can be accessed via standard HTTP requests and responses (GET, POST, etc.). You may use the Qrvey API to work with any of the core Qrvey platform features for data collection, automation, and analytics, or when integrating Qrvey into your own applications. For best results programming with Qrvey APIs, you should be familiar with performing the same tasks in the Qrvey Admin Center and/or Qrvey Composer applications.

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

Software Developers embed Qrvey widgets in their host applications and use Qrvey APIs to programmatically interact with the Qrvey platform.

Overview

The Pixel-perfect Reports widget enables you to embed the Pixel-perfect Reports feature in an application.

This article describes how to use the Post Data API to update a Managed Dataset. Managed Datasets store data in Amazon OpenSearch/Elasticsearch service. The Post Data API is provided by the Qrvey Data Router component.

Qrvey makes it easy to publish your web forms just about anywhere. This article discusses different ways you can use your forms, surveys, and quizzes. For information on embedding web forms, see Embedding Web Forms.

Release Date: 2023-02-01

Release Date: 2023-04-21

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.

Release Date: 2023-10-04

Release Date: 2024-02-05

Release Date: 2024-04-10

This tutorial demonstrates an end-to-end process for using the Qrvey API. It assumes that you have a basic understanding of REST APIs, how to make web requests, and how to work with responses in JSON format. We will use Postman to send requests and view responses.

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:

Overview

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.

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.

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.

The Single Panel widget enables you to embed a chart, metric, or summary panel that has already been created in Qrvey Composer.

Custom events enable Qrvey Software Developers to handle custom scenarios. This article describes several custom events that can be triggered by Qrvey widgets. The host application can be programmed to listen to these events and then perform its own custom tasks.

The Bullet chart and Dial chart support the use of custom tokens to set threshold values. Custom tokens are based on individualized criteria and are set dynamically each time the widget is rendered.

When embedded in an application, the Web Form - End User widget enables end users to enter data in a designed Web Form.

When embedded in an application, the Web Form Design widget enables end users to create, preview, and modify web forms. The Qrvey platform provides three types of web forms: survey, form, and quiz.

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.

Qrvey provides developers with a comprehensive set of “Widgets” to allow them to seamlessly embed Qrvey’s self-service data collection, automation, or analytics functionalities to power their applications. Widgets are directly embedded into web applications using simple Javascript and custom HTML tags. Qrvey Widgets are available for embedding various front-end application features, including Web Form builders (Survey, Quiz, Forms, etc), Data Visualizations for both creating and consuming charts and report outputs, and more.

Qrvey provides a set of controls to create and interact with filters across the application to refine the data based on your needs. You can find more details about these controls in the portal section Working with Interactive Filters. When embedding Qrvey’s widgets into your system, you may run into situations where you need to combine Qrvey’s filters with your own set of filter controls. This article walks you through the steps that are needed for passing the values of your own filters to embedded Qrvey widgets.