DNAnexus Documentation
APIDownloadsIndex of dx CommandsLegal
  • Overview
  • Getting Started
    • DNAnexus Essentials
    • Key Concepts
      • Projects
      • Organizations
      • Apps and Workflows
    • User Interface Quickstart
    • Command Line Quickstart
    • Developer Quickstart
    • Developer Tutorials
      • Bash
        • Bash Helpers
        • Distributed by Chr (sh)
        • Distributed by Region (sh)
        • SAMtools count
        • TensorBoard Example Web App
        • Git Dependency
        • Mkfifo and dx cat
        • Parallel by Region (sh)
        • Parallel xargs by Chr
        • Precompiled Binary
        • R Shiny Example Web App
      • Python
        • Dash Example Web App
        • Distributed by Region (py)
        • Parallel by Chr (py)
        • Parallel by Region (py)
        • Pysam
      • Web App(let) Tutorials
        • Dash Example Web App
        • TensorBoard Example Web App
      • Concurrent Computing Tutorials
        • Distributed
          • Distributed by Region (sh)
          • Distributed by Chr (sh)
          • Distributed by Region (py)
        • Parallel
          • Parallel by Chr (py)
          • Parallel by Region (py)
          • Parallel by Region (sh)
          • Parallel xargs by Chr
  • User
    • Login and Logout
    • Projects
      • Project Navigation
      • Path Resolution
    • Running Apps and Workflows
      • Running Apps and Applets
      • Running Workflows
      • Running Nextflow Pipelines
      • Running Batch Jobs
      • Monitoring Executions
      • Job Notifications
      • Job Lifecycle
      • Executions and Time Limits
      • Executions and Cost and Spending Limits
      • Smart Reuse (Job Reuse)
      • Apps and Workflows Glossary
      • Tools List
    • Cohort Browser
      • Chart Types
        • Row Chart
        • Histogram
        • Box Plot
        • List View
        • Grouped Box Plot
        • Stacked Row Chart
        • Scatter Plot
        • Kaplan-Meier Survival Curve
      • Locus Details Page
    • Using DXJupyterLab
      • DXJupyterLab Quickstart
      • Running DXJupyterLab
        • FreeSurfer in DXJupyterLab
      • Spark Cluster-Enabled DXJupyterLab
        • Exploring and Querying Datasets
      • Stata in DXJupyterLab
      • Running Older Versions of DXJupyterLab
      • DXJupyterLab Reference
    • Using Spark
      • Apollo Apps
      • Connect to Thrift
      • Example Applications
        • CSV Loader
        • SQL Runner
        • VCF Loader
      • VCF Preprocessing
    • Environment Variables
    • Objects
      • Describing Data Objects
      • Searching Data Objects
      • Visualizing Data
      • Filtering Objects and Jobs
      • Archiving Files
      • Relational Database Clusters
      • Symlinks
      • Uploading and Downloading Files
        • Small File Sets
          • dx upload
          • dx download
        • Batch
          • Upload Agent
          • Download Agent
    • Platform IDs
    • Organization Member Guide
    • Index of dx commands
  • Developer
    • Developing Portable Pipelines
      • dxCompiler
    • Cloud Workstation
    • Apps
      • Introduction to Building Apps
      • App Build Process
      • Advanced Applet Tutorial
      • Bash Apps
      • Python Apps
      • Spark Apps
        • Table Exporter
        • DX Spark Submit Utility
      • HTTPS Apps
        • Isolated Browsing for HTTPS Apps
      • Transitioning from Applets to Apps
      • Third Party and Community Apps
        • Community App Guidelines
        • Third Party App Style Guide
        • Third Party App Publishing Checklist
      • App Metadata
      • App Permissions
      • App Execution Environment
        • Connecting to Jobs
      • Dependency Management
        • Asset Build Process
        • Docker Images
        • Python package installation in Ubuntu 24.04 AEE
      • Job Identity Tokens for Access to Clouds and Third-Party Services
      • Enabling Web Application Users to Log In with DNAnexus Credentials
      • Types of Errors
    • Workflows
      • Importing Workflows
      • Introduction to Building Workflows
      • Building and Running Workflows
      • Workflow Build Process
      • Versioning and Publishing Global Workflows
      • Workflow Metadata
    • Ingesting Data
      • Molecular Expression Assay Loader
        • Common Errors
        • Example Usage
        • Example Input
      • Data Model Loader
        • Data Ingestion Key Steps
        • Ingestion Data Types
        • Data Files Used by the Data Model Loader
        • Troubleshooting
      • Dataset Extender
        • Using Dataset Extender
    • Dataset Management
      • Rebase Cohorts and Dashboards
      • Assay Dataset Merger
      • Clinical Dataset Merger
    • Apollo Datasets
      • Dataset Versions
      • Cohorts
    • Creating Custom Viewers
    • Client Libraries
      • Support for Python 3
    • Walkthroughs
      • Creating a Mixed Phenotypic Assay Dataset
      • Guide for Ingesting a Simple Four Table Dataset
    • DNAnexus API
      • Entity IDs
      • Protocols
      • Authentication
      • Regions
      • Nonces
      • Users
      • Organizations
      • OIDC Clients
      • Data Containers
        • Folders and Deletion
        • Cloning
        • Project API Methods
        • Project Permissions and Sharing
      • Data Object Lifecycle
        • Types
        • Object Details
        • Visibility
      • Data Object Metadata
        • Name
        • Properties
        • Tags
      • Data Object Classes
        • Records
        • Files
        • Databases
        • Drives
        • DBClusters
      • Running Analyses
        • I/O and Run Specifications
        • Instance Types
        • Job Input and Output
        • Applets and Entry Points
        • Apps
        • Workflows and Analyses
        • Global Workflows
        • Containers for Execution
      • Search
      • System Methods
      • Directory of API Methods
      • DNAnexus Service Limits
  • Administrator
    • Billing
    • Org Management
    • Single Sign-On
    • Audit Trail
    • Integrating with External Services
    • Portal Setup
    • GxP
      • Controlled Tool Access (allowed executables)
  • Science Corner
    • Scientific Guides
      • Somatic Small Variant and CNV Discovery Workflow Walkthrough
      • SAIGE GWAS Walkthrough
      • LocusZoom DNAnexus App
      • Human Reference Genomes
    • Using Hail to Analyze Genomic Data
    • Open-Source Tools by DNAnexus Scientists
    • Using IGV Locally with DNAnexus
  • Downloads
  • FAQs
    • EOL Documentation
      • Python 3 Support and Python 2 End of Life (EOL)
    • Automating Analysis Workflow
    • Backups of Customer Data
    • Developing Apps and Applets
    • Importing Data
    • Platform Uptime
    • Legal and Compliance
    • Sharing and Collaboration
    • Product Version Numbering
  • Release Notes
  • Technical Support
  • Legal
Powered by GitBook

Copyright 2025 DNAnexus

On this page
  • Guidelines
  • Built in a Well-Documented, User-Friendly Manner
  • Built with Security Best Practices in Mind
  • Maintained and Kept Up to Date
  • Users are Supported in a Timely and Active Manner

Was this helpful?

Export as PDF
  1. Developer
  2. Apps
  3. Third Party and Community Apps

Community App Guidelines

Last updated 2 months ago

Was this helpful?

This guide is not a replacement for the Community App DPAA. This is meant to be a guide to the building and supporting an app that can be run on the DNAnexus Platform. Non-adherence to these guidelines can result in an app being removed from the Platform.

Guidelines

Built in a Well-Documented, User-Friendly Manner

  1. The app-level metadata must include the following:

    1. A descriptive "name", "title", and "summary".

    2. One or more "categories".

  2. The app's "description" (typically represented by Readme.md) must be a markdown document that includes the following:

    1. A description of what this app does, with some common use cases.

    2. Clear and comprehensive information on how the app handles any user data, including whether any data, metadata, or diagnostic information is collected and/or transferred outside of DNAnexus.

    3. Expectations on the app's performance (e.g. runtime for typical inputs under default parameters).

  3. Each field in the app's input/output spec must include the following:

    1. A descriptive "name", "label", and "help".

    2. One or more "patterns", for file inputs that require a particular file format.

  4. The app's JSON "details" hash must include the following:

    1. A "whatsNew" key, whose value is a string that discusses what is new with each app version.

    2. A "citations" key, whose value is an array of zero, one, or more strings of Digital Object Identifiers (such as "doi:10.1093/bioinformatics/btv098") for publications associated with the software.

    3. A "contactEmail" key, whose value is a string with a valid email that can be contacted for any inquiries about this app.

    4. An "upstreamProjects" key, whose value is an array of hashes, each of which describes the licenses associated with software or packages included in this app, as discussed . This is required to ensure compliance with open-source licenses.

  5. The app's "version" must follow .

  6. The app's run specification ("runSpec") must include the following:

    1. A default (non-empty) "timeoutPolicy".

    2. A value for "release" no lower than the highest two supported versions.

      1. For new apps they should use the highest version supported, currently "24.04"

  7. A link to an app FAQ page, if available, should be added to the app's Readme.md file.

Built with Security Best Practices in Mind

  1. The app must list "org-dnanexus_tools_admin" in the "developers" array. You may not remove this entry throughout the app series lifetime (regardless of publishing new app versions).

  2. For any app versions that require network access, the Readme.md associated with each such version should include a clear, visible section outlining why network access is needed.

  3. The app may not request "developer", "projectCreation", or "allProjects" access permissions (of any kind). At this point DNAnexus does not support third party apps with those permissions.

  4. The app may not request "project" access permissions that are higher than "VIEW".

  5. If the app runs any other apps, applets, workflows or global workflows, these may not be run in "detached" mode.

  6. Apps may not include any software that has known publicly disclosed vulnerabilities. If such vulnerabilities arise after an app has been published, a new version must be published within the agreed upon timeline in the DPAA and the old marked as deprecated.

  7. If an app has the ability to access the internet, the app's developers should add a warning about possible leakage of sensitive data, to the app's Readme.md file. This warning should inform app users that they are responsible for ensuring that when the app accesses the internet, no personal identifiable information (PII), protected health information (PHI), or other sensitive data is exposed or otherwise made accessible.

Maintained and Kept Up to Date

  1. The app algorithm is a maintained/supported version of the algorithm and is within 1 year of the latest release.

  2. Apps are updated to run on supported execution environments and cluster specs.

Users are Supported in a Timely and Active Manner

Note that DNAnexus Support will provide support related to issues with launching an app. But DNAnexus cannot provide support related to bugs in a third-party app, or explain how a third-party can or should be used. Support inquiries on these and related matters will be passed to the vendor of the app in question.

  1. Priority support items are engaged within a week of opening the request.

  2. Open comments or support items are engaged within a month of opening the request.

  3. A link to the app developer's support page, if available, is added to the app's Readme.md file.

If the app makes any API calls to the DNAnexus platform, those need to be done using the , which point to internal API endpoints and internal job tokens. The app must not contact external DNAnexus API endpoints, and must not make API calls using tokens other than the job's token.

here
Semantic Versioning 2.0.0
settings provided by the app execution environment