ngSurvey
  • ✔️ What is ngSurvey ?
  • ❔Help on Help
  • 📁Projects
    • Creating a New Survey
    • Folders
      • Project Trashcan
    • Survey Information
    • Survey Search
    • Collaboration
    • Import / Export
      • JSON Survey Export / Import
      • XLSForm
        • Survey Sheet
          • Types
          • Groups
          • Appearances
          • Relevant
          • Constraint
          • Calculations
          • Multi-Languages
          • Choice filters (Casacade)
        • Choices Sheet
        • Settings Sheet
        • XLSForm Samples
  • 📄Forms / Surveys
    • Overview Dashboard
      • Dashboard Title
      • Dashboard Information Box
      • Dashboard Reports
      • Last Respondents
      • Last Sentiments
    • Form Designer
      • Questions
        • Creating a Question
        • Editing a Question
          • Question Preset Styles
        • Question Properties
          • Conversation reply type
            • Auto reply type
          • Question Branching
          • Skip / Hide Logic
        • Question Types
          • Standard
            • Single Choice
            • Multiple Choice
            • Image Choices
            • Dropdown List
            • Autocomplete
            • Text / Comment Field
          • Matrix Questions
            • Columns / Rows Sums
            • Single Matrix
            • Multi Matrix
            • Mobile Rendering
          • Satisfaction Questions
            • Net Promoter Score® Question
              • Understanding the Net Promoter Score® (NPS)
            • CSAT Score
              • Understating CSAT Score
            • CES Score
              • Understanding CES
            • Star Rating
            • Smileys
            • Thumbs Up / Down
          • Choice-Based Conjoint (CBC)
            • Create a Conjoint Question
            • Design Experiments
              • Balanced Design
              • Manual Design
              • Import Design
            • Reporting / Export
          • Advanced Types
            • Appointment Calendar
            • Constant Sum
            • Answer Ranking
            • Slider Scale
            • File Upload
            • Hidden Question
            • Contact Details
          • Questions Generator
          • Smart Generator
        • Question Blocks
        • Static / Images Content
        • Rating
        • Panel Linking
          • Panel Auto Filling
          • Panel Updating
      • Answers
        • Adding an Answer
        • Editing an Answer
        • Answer Properties
          • Field Properties
          • Reporting / Exports
          • Skip / Hide Logic
          • Entry Validation
        • Answer Types
          • Creating New Type
            • Custom Validation Code
            • Lists
              • JSON / REST API Lists
              • SQL Server Lists
                • Parent / Child Related Lists
                • SQL Parameters
              • List Items
            • Widgets
              • Widget Samples
                • Widget Definitions
                • Basic Field
                • Multiple input type
                • Basic Selection
                • Material Date
                • Material selection
                • Total Score Per Page
          • Selection Answers
            • Checkbox
            • Radio Button
          • Other selection
          • Entry Field
          • Password
          • Captcha
          • Calendar Date
          • Calendar time
          • Compare Field
          • Countries
          • Email
          • Email Validator
          • Hidden Field
          • File Upload
          • Language Selector
          • Phone Confirmation
          • Signature Pad
          • Slider
          • Constant sum
          • Constant sum total
          • Ranking Field
          • Ranking drag / drop
          • Text label
          • Time Picker
          • Appointment Calendar
      • Pages
        • Page Branching
        • Skip / Hide Logic
        • Conditional Redirection
        • Thanks / End Page
          • Redirection URL
          • Conditional Thanks Message
        • Page Looping
          • Looping Pipes
        • Pages Navigator
      • Multi-Language Forms
        • Setup multi-languages
        • Import / Export
        • Auto-translation
        • Resources
      • Survey Properties
        • Progress Completion
          • Respondent Answers Update
        • Single Question Flow
          • Flow Animation Transitions
        • Privacy
          • Privacy checklist
        • Quotas
        • Kiosk
        • Form Code
        • Survey Security
      • Footer Manager
      • Repeatable Sections
      • Rich Text Editor
        • Rich Attributes
      • Piping
        • Text / Data Piping
        • Carry Forward Answers
      • Preview / Testing
        • Pref-filled answers
      • Form Trashcan
      • Scoring
      • Timer
      • Conditions
        • Condition Groups
        • Conditions Rules
          • Question Conditions
          • Javascript Conditions
      • Geolocation
        • Browser Location
        • IP Address Location
        • Location Reporting
      • Google Analytics
        • Google Analytics Events
    • Flow Logic Graph
      • Page Branching Graph
      • Question Branching Graph
    • Security
      • Security Items
        • Active Directory Security
        • Azure Active Directory Security
        • Auth0 Security
        • Captcha
        • CAS Authentication
        • HTTP Function
          • Azure Function Login Sample
        • Invitation Code
        • IP Protection
        • IP Access Control
        • Local Users Security
        • OpenId Connect
        • Panel Security
          • Panelist Mapping
        • Password
        • Quota Restrictions
        • Tokens
          • Token Generator
            • Individual Entry
            • Automatic Generator
            • CSV File
          • Token Manager
          • Token and Querystring
          • Token Hierarchy / Permissions
        • Referer
        • SQL Security
      • Key Provider
      • Data Attributes
    • Style / Branding
      • Style Library
      • Style Editor
        • Style
          • Header / Footer
          • Header Logo Image
        • Theme
        • Elements
        • CSS
          • CSS Classes
          • CSS Rating Sample
        • Mobile / Responsive Design
        • Custom Font
      • Media Gallery
    • Tasks
      • Task Items
        • Completion Alerts
        • Google Sheet Task
        • SQL Query Task
        • Webhooks
          • Webhooks payload transform
      • Triggers
    • Publish
      • Web Link
      • Offline Survey
        • Uploading respondents
      • Embed Form
      • QR Code
      • Word Format Export
      • Website Intercepts
        • How to implement intercepts
        • Intercept Hosts
        • Intercepts
          • Intercept Properties
          • Intercept Layout
          • Intercept Triggers
          • Multi-Language Intercepts
          • Intercept Display Formats
      • Page
    • Campaigns
      • Information Box
      • Campaign
        • Email Distribution
          • Email List
          • Import Emails
        • Panel Members Distribution
        • Mobile Phone Distribution
          • SMS Distribution
          • WhatsApp Distribution
            • WhatsApp Invitations
            • WhatsApp Conversation
          • Phone Number List
          • Import Phones
        • Invitation Message
          • Invitation Piping Tags
          • Embedding a Question
          • WhatsApp Template
        • Reminders
          • One time reminders
        • Schedules
        • Virtual Campaign
        • Campaign Results
      • Campaign Batches
      • Invitation Templates
      • REST Trigger
    • Respondents
      • Respondent Details
      • Editing Respondent Answers
      • Respondents Status
      • Archived Respondents
      • Actions Links
    • Reporting
      • Default Report
      • Report Builder
        • Report Items
          • Bar Chart
          • Pie Chart
          • Free Text Report
          • Sentiment Index
          • Net Promoter Score®
          • Historical Trends Chart
          • Cross Tabulation
          • Tag Clouds
          • T.U.R.F
          • Ranking Report
          • Constant Sum Report
          • Languages Chart
          • Location Chart
      • Text Reports
        • Sentiment Analysis
      • Report Filters
      • Test Data Generator
      • Historical Trends
      • Files Vault
      • Multi-Language Report
      • Reporting Printing
    • Data Exports / Imports
      • Data Exports
        • Export Jobs
        • CSV / Excel
          • Excel
          • CSV Individual Answers
          • CSV Separated Selection / Fields
          • Questions as Rows
        • SPSS / SAV
        • JSON
        • Aggregated Results
        • Word Respondents
        • Export Templates
      • Data Imports
      • Variables
    • Data Access
    • Activity Log
  • 💬Conversational Surveys
    • Get Conversation Started
    • Conversation Questions
      • Answer Reply
      • Text Reply
      • File Upload
      • NPS
      • CSAT
      • CES
      • Language Reply
    • Conversation Commands
    • WhatsApp Conversations
    • Unifonic Template Message
  • 📖Shared Sessions Surveys
    • Sessions
  • ✨AI Suite
    • AI Generated Survey
    • Smart Questions Generator
    • Smart Answers Suggestions
    • Smart Analysis
    • Smart Columns
      • Smart Columns Properties
      • Smart Works
        • Custom Prompt
        • Translation
        • NPS
        • Sentiment
        • Labels
  • 👪Panels
    • Panel Connectors
      • Built-in Connector
        • Import panelist from CSV
      • Database Connector
    • Panel information
    • Panelists
    • Panel Views
    • Panel Attributes
    • Entry Approvals
    • Panelist Surveys
    • Panel Properties
  • 👤Personal Account
    • Account Settings
    • Developer
      • API Connection Sample
        • Get Survey From API
      • Power Apps / Logic App Flow Integration
        • Connector Setup
        • Connector / Mail Example
      • Zapier.com Connection
  • 🔐Access Control
    • Users
    • Groups
    • Roles
      • Rights
  • 🔑Data Encryption
    • Encryption Setup
      • Transparent Encryption
        • Azure Encryption Setup
        • IIS Encryption Setup
      • PGP Encryption
    • Data Classification
      • Internal
      • Sensitive
      • Restricted
    • Respondent Answers Encryption
    • File Upload Encryption
    • Campaign Encryption
  • 🕸️ Tenants
  • 🚀On-Site Setup
    • Enterprise Edition Installation
      • Docker
        • Filesystem Storage
      • Microsoft Azure
      • Amazon Web Services
        • AWS Elastic Beanstalk
          • AWS EBS / STAND ALONE SQL SERVER
          • AWS EBS / SQL Server
        • Cognito
        • LightSail
      • Microsoft IIS
        • Azure KeyVault
        • Update / Upgrade
      • ZIP Archive
      • Linux (Ubuntu / CentOS)
        • Linux SSL
      • Database Backend
        • Microsoft SQL Server
        • Oracle MySQL
        • MariaDB
        • PostgreSQL
      • WhatsApp Messenging
        • Twilio
        • Unifonic
      • Cluster / Scale out setup
      • Microsoft Entra / Azure AD
        • Entra Setup
        • Register Entra Users
      • Active Directory
        • Active Directory Setup
        • Register Active Directory Users
      • Environment Variable Settings
      • Content Security Policy (CSP)
      • Cross Origins Setup (CORS)
    • System Settings
      • General
      • Mailing Server
        • SMTP Mailing Server
        • IIS SMTP / Exchange Server
        • Postmark
        • Twilio / Sendgrid
        • MailJet
      • Account Security
      • Connections vault
      • AI Suite Provider
        • OpenAI
        • Azure AI
      • Third Party APIs
        • Microsoft
        • IPStack
      • Google
        • Captcha Setup
        • Google Web Font
        • Service Account
      • Azure Entra Settings
      • Active Directory Settings
      • OpenId Connect Settings
      • Mobile Messenging
        • Twilio
        • HTTP SMS Messenging
        • Amazon SNS
        • Unifonic
      • Translations
      • File Storage
      • Bounce Account
    • White-Label
    • Register Trial Copy
    • Upgrades
    • Release Notes
    • Change log
  • 📚Walkthroughs
    • Quick create survey start
    • Translate a survey
    • Rename a survey
    • Restore a deleted survey
    • Invite respondents to a survey
    • Capture value from query string
    • Share a survey with other users
    • Using token in email campaigns
    • Using a campaign with MailChimp
    • Power BI Integration
      • Link data to Power BI
      • Reporting with Power BI
    • Tableau Integration
      • Link data to Tableau
        • Reporting with Tableau
    • Link existing SQL table to a survey
    • Send invitations using an existing SQL Table
    • Export data to Excel
    • Export data to R
    • Zendesk integration
  • ©️ Copyrights / EULA
    • License
    • Copyrights and disclaimers
Powered by GitBook

(c) 2024 Data Illusion Zumbrunn. All rights reserved. Reproduction strictly forbidden.

On this page
  • ➕ Adding a tenant
  • 🔅 Tenant properties
  • 🔨 Tenant editing
  • ↪️️ Switching from the root to a tenant
  • 👩🏻‍💻 Tenants API calls

Was this helpful?

🕸️ Tenants

PreviousCampaign EncryptionNextOn-Site Setup

Last updated 3 years ago

Was this helpful?

Using tenants along a you can run one single installation of ngSurvey shared across multiple organizations or customers having each their own separate users, groups, surveys and system settings that can be managed either at the tenant level or globally from the root tenant.

Each tenant can be setup using host names or domains that ngSurvey will use to know under tenant it should run. Internally each tenant has its own isolated database allowing you to run tenants under different servers or regions that the main ngSurvey database.

As each tenant has its own settings you can set a different branding for each of the tenant.

➕ Adding a tenant

New tenants can be added and managed from the System / Tenant screen.

🔅 Tenant properties

  • Organization unique name of the tenant. This cannot be changed later on.

  • Domain is the domain / host under which the tenant will run. You can have one or multiple domains / hosts per tenant.

  • Use custom connection string let you define your own connection string to an ngSurvey database that will be used by the tenant.

  • Copy system settings copy over the tenant root system settings over to the newly created tenant.

The first user that will be created in the tenant with privileges will be the same user that is used to add the tenant with admin. Users can be either edited by connecting to the tenant using the domain/host defined for the tenant or through the root tenant by switching the root tenant context to the newly created tenant.

🔨 Tenant editing

Tenants can be removed or edited from the System / tenant screen. You can see at any point of the time the status of your tenant and its database.

Be careful if you delete a tenant with its database as the data cannot be recovered unless you have a database backup.

Tenants are chosen by ngSurvey based on the domain / host that is used to call the ngSurvey website however if administrators can access all the different tenants using the tenant switch.

Using the switch you can chose any tenants of your choice, once selected ngSurvey will run under the context of this tenant letting you edit and manage all the data, users, settings that is available under this tenant.

Its only possible to switch to a different tenant when running the administration section under the root ngSurvey installation with administrator privileges.

👩🏻‍💻 Tenants API calls

As with the surveys and administration section ngSurvey will automatically run the API call based on the domain/host that is used to call the API. It is however possible to force the API call to run under a given tenant context when called from the root tenant by adding following header name / value in your HTTP call.

X-NGS-TenantId:TenanId

To impersonate the current user to access a tenant you need to call the API using an administrator account from the root tenant.

In case of updates on newer versions NGSurvey will automatically updates all tenants database if you have in place for automatic upgrading. Should you have disabled the automatic upgrade you can use the Upgrade tenants option to upgrade all tenants databases that are not in sync with the root ngSurvey installation.

↪️ Switching from the root to a tenant

AutoDBUpgrade
️
multi-tenant license