Home

How to add a new Analysis

Modules

Result Templates

This document outlines the structure and fields used in the JSON configuration to manage links, dashboards, and downloadable files in a bioinformatics workflow. Each JSON object represents a resource or action within the system, detailing how the platform should handle different tasks such as file downloads, dashboard visualizations, and folder access.

The JSON templates are highly configurable and use placeholders like {{uuid}} to inject dynamic values, allowing the system to serve specific resources based on context.

json_details

This JSON configuration defines various types of links, dashboards, and downloadable files related to a bioinformatics workflow. Each JSON object describes a specific task, resource, or file with fields indicating how the system should handle it.

Common Fields

• type: This indicates the type of action or resource. Common values are:

  • link: A clickable link to a resource, report, or file.
  • pattern: A dynamic link generator based on a file pattern.

• shape: The type of the resource being linked to. Common values:

  • dashboard: A visualization or UI-based resource (e.g., interactive reports).
  • download: A file that can be downloaded.
  • folder: A link to a directory or collection of files.

• path: The actual path to the resource. This can include a specific URL or a reference to files in the system. Dynamic placeholders such as {{uuid}} are used to inject specific data into the path dynamically.

• label: The human-readable label for the link or file. This will be what users see.

• context_path: The base path or context in which the resource is located. It’s often combined with path to fully determine the location of the file or report.

• fallback_message: The error message to display if the resource cannot be accessed or generated. If null, no fallback message will be shown.

• external_viewer: A Boolean flag (true or false) indicating if the link should be opened in an external viewer.

• internal_link: A Boolean flag indicating if the link is internal to the platform (set to false for external links).

• check_existence: A Boolean that indicates whether the system should check if the file or resource actually exists before presenting it to the user.

• required_files (optional): If this field is present, it lists files that need to exist in the system for this link to work.