Skip to main content

Organisation settings

Introduction

The Organisation Settings page enables Host Admin to configure core settings for the company, product branding, infrastructure, metadata preferences, and integrations. This document outlines each tab, its fields, and tooltip descriptions, along with visual references.

To access the organization settings, follow these steps:

  • Click on the profile icon located at the top-right corner of the header.

  • From the dropdown menu, select "Organisation Settings."

  • You will be redirected to the Organisation Settings page.

  • The image below highlights the location of the "Organisation Settings" option in the dropdown.

    organisation-settings-option

Tabs Overview

The Organisation Settings interface is divided into the following tabs:

  • Company Info

  • Custom Branding

  • Infra

  • Metadata

  • Integration

    Company Info

    Configure company name, contact details, signup options, and more.

    Field NameDescriptionTooltip Info (if any)
    Company NameName of your organization. This will appear on headers or emails.Registered name of the company.
    Product NameName of the product used across the app for branding.Product name used for sign-up and other pages.
    Company AddressOfficial physical address of your organization.
    Contact NamePoint of contact (team or individual).The primary contact name used for company support and services.
    Email IdPrimary support/contact email ID.The primary email address used for company support and services.
    CityCity of company address.
    StateState of company address.
    CountryCountry of company address.
    Zip CodePostal code of company address.
    WebsiteYour organization's website URL.Company's official website for product and service information.
    Referral LinkToggle to enable referral-based user onboarding.Share this link to invite others to sign-up and join the service.
    Sign-up ActivationToggle to require admin activation for new sign-ups.Allows users to sign-up using an email verification link.
    Plain Sign-upToggle to allow sign-ups without email verification.Allows users to sign-up using only their email, name, and password.
    Required TOSToggle to enforce Terms of Service agreement during signup.Requires users to agree to the Terms of Service to access the platform.

    organisation-settings-detail

    Custom Branding

    Customize branding elements like logos, themes, and product labels.

    Field NameDescriptionTooltip Info (if any)
    Logo UploadUpload your custom logo.
    Favicon UploadUpload your custom favicon.
    Primary ColorPrimary brand color for UI elements.Used for the background color of headers.
    Secondary ColorSecondary brand color for UI elements.Background color for action buttons such as Create New Project, Run Analysis, Verify, Set New Password, and similar actions. Color of loaders, button borders (on hover), navigation link color text, tab bottom borders, tab text, table link colors, etc.
    Tertiary ColorTertiary brand color for UI elements.Background color for action buttons such as Create New Project, Run Analysis, Verify, Set New Password, and similar actions. Color of loaders, button borders (on hover), navigation link color text, tab bottom borders, tab text, table link colors, etc.
    Text ColorText color for application.Standard text color used throughout the application for text. Navigation link hover text color, tab bottom borders, tab text, table link colors, etc.
    Button Text ColorButton text color.Text color specifically for action buttons.

    Infra Tab

    Manage infrastructure-related configurations.

    Compute Settings

    Fields and their tooltips:

    Field NameDescriptionTooltip Info (if any)
    LifecycleChoose between On-Demand (standard pricing) and Spot (cost-saving).Default instance lifecycle, spot or on-demand
    Max wait for Spot AvailabilityTime to wait before falling.Max wait time (seconds) for spot availability before switching to on-demand.
    Behavior on ErrorTime delay before termination on error.Auto-terminate after X seconds if pipeline has an error. If the field is empty, the instances don’t terminate.

    Storage Settings

    Field NameDescriptionTooltip Info (if any)
    Archive Input afterDays after which input is archivedNumber of days after which input data is archived.
    Archive ClassType of archive (e.g., Glacier Deep Archive)Storage class for archive

    organisation-settings-infra-tab

    MetaData Tab

    Define and manage custom metadata fields for your datasets or workflows.

    Field NameDescriptionTooltip Info (if any)
    Enabled PlatformsPlatforms which supports like Illumina, PacBio, etc.Platform choices for users.
    Default PlatformPreselected platform.Select the default Platforms.
    Enabled Data TypesData types supported (e.g., RNA-Seq, ATAC-Seq)Data type choices for users.
    Default Data TypesPreselected data typesSelect the default Data type.

    organisation-settings-metadata-tab

    Integration Tab

    Configure external system or platform integrations.

    GitHub Integration

    • Install Basepair App: Button to install GitHub App.
    • Git Repo URL: URL to validate GitHub access.
    • Verify: Button to validate access.

    SSO Integration

    • Provider: SSO identity provider like Azure or Okta.
    • App Id, Client Id, Client Secret: Credentials for app integration.
    • Login Button Text: Text displayed on login button.
    • Verify: Button to test SSO connection.

    organisation-settings-integration-tab