Academy Documentation
  • Usage of Academy Documentation
  • Getting Started
    • Background Information
    • For Apollo Users
    • For Titan Users
    • For Scientists
    • For HPC Users
    • For Experienced Users
  • Cloud Computing
    • General Information
    • Cloud Computing for Scientists
    • Cloud Computing for HPC Users
  • Overview of the Platform
    • Overview of the Platform User Interface
    • Tool Library and App Introduction
  • Billing Access and Orgs
    • Orgs and Account Management
    • Billing and Pricing
  • Cohort Browser
    • Apollo Introduction
    • Overview of the Cohort Browser
    • Combining Cohorts
    • Genomic Variant Browser
    • Somatic Variants
  • JSON
    • Introduction
    • JSON on the Platform
  • Command Line Interface (CLI)
    • Introduction to CLI
    • Advanced CLI
  • Building Applets
    • Introduction
    • Bash
      • Example 1: Word Count (wc)
      • Example 2: fastq_quality_trimmer
      • Example 3: samtools
      • Example 4: cnvkit
    • Python
      • Example 1: Word Count (wc)
      • Example 2: fastq_quality_trimmer
      • Example 3: cnvkit
  • Building Workflows
    • Native Workflows
    • WDL
      • Example 1: hello
      • Example 2: Word Count (wc)
      • Example 3: fastq_trimmer
      • Example 4: cnvkit
      • Example 5: workflow
    • Nextflow
      • Resources To Learn Nextflow
      • Overview of Nextflow
      • Nextflow Setup
      • Importing Nf-Core
      • Building Nextflow Applets
      • Error Strategies for Nextflow
      • Job Failures
      • Useful Information
  • Interactive Cloud Computing
    • Cloud Workstation
    • TTYD
    • TTYD vs Cloud Workstation
    • JupyterLab
      • Introduction
      • Running a JupyterLab Notebook
  • Docker
    • Using Docker
    • Creating Docker Snapshots
    • Running Docker with Swiss Army Knife
  • Portals
    • Overview of JSON files for Portals
    • Branding JSON File
    • Home JSON File
    • Navigation JSON File
    • Updating Your Portal
  • AI/ ML Accelerator
    • Data Profiler
      • Introduction to Data Profiler
      • Utilizing Data Profiler Navigator
      • Dataset Level Screen
      • Table Level Screen
      • Column Level Screen
      • Explorer Mode
      • Accessing Data Profiler in ML JupyterLab
    • ML JupyterLab
      • Introduction to ML JupyterLab
      • Getting Started in ML JupyterLab
      • In App Features
      • Getting Started with ML JupyterLab
    • MLflow
      • Introduction to MLflow
      • Getting Started with MLflow
      • Using MLflow Tracking Server
      • Model Registry
      • Using Existing Model
      • Utilizing MLflow in JupyterLab
Powered by GitBook
On this page
  • Overview of the navigation.json file
  • Overview of the Sections of a portal and matching json files:
  • Example of the navigation.json file
  • Sections in your navigation.json file
  • Examples of items to add to a navigation.json:
  • Resources

Was this helpful?

Export as PDF
  1. Portals

Navigation JSON File

PreviousHome JSON FileNextUpdating Your Portal

Last updated 7 months ago

Was this helpful?

Disclaimer: Portals require a license. These documents are to get you started with your portals. By no means is this the only way to make your portal, nor is this the only way to edit a json file.

Overview of the navigation.json file

  • this .json file will personalize the banner that you navigate to different sections.

    • Examples: projects in the project tab, different tools you want immediate access to in the tool section.

If you have questions about how to use a json file, please view

Overview of the Sections of a portal and matching json files:

Example of the navigation.json file

The navigation.json file for this example is blank. These are the default items in the header

{

}

Sections in your navigation.json file

This file must be at least accessible to community members.

This file is optional. It allows you to edit the feature list of projects. _projects, _tools, and supportURL are all optional.

They can be

  • null, which will remove the item from the header

  • an array of objects

    • Text for the text of the new menu item,

    • url as the destination

    • newTab for if the link should open up a new tab

  • If there is another entry, it indicated that a new navigation item needs to be added.

    • They can be objects with a url and optional parameters. newTab means a link in the navigation when you do this method

    • They can also be array of objects with text, url, and newTab (which will give it a dropdown menu with listed items)

Examples of items to add to a navigation.json:

{
 "_projects": null, #deletes the current list of projects 
 "_tools": [
  {"text": "Custom Menu Item", "url": "http://example.com"}, #creating a new item within tools 
  {"text": "Opens in New Tab", "url": "http://example.com", "newTab": true} #creating a new tab in tools 
 ],
 "_help": null, #removes help 
 "A New Menu": [
  {"text": "New Menu Item", "url": "http://example.com"}, #new menu 
 ],
 "A New Link": {"url": "http://example.com", "newTab": true} #new link 
}

Resources

Please email to create a support ticket if there are technical issues.

Portal Documentation
Full Documentation
support@dnanexus.com
this section