TES Runs Component

Beta

0.1.1

<ecc-client-ga4gh-tes-runs/>

ECCClientGa4ghTesRuns

Overview

The TES Runs component is designed to browse and display task runs using the Task Execution Service (TES) API. It provides a user-friendly interface for viewing and managing task executions within a TES-compliant environment.

For more details, refer to the TES API GET endpoint specification (opens in a new tab).

Preview

Examples

Basic Usage

ECCClientGa4ghTesRuns.tsx

import React from 'react';
import ECCClientGa4ghTesRuns from '@elixir-cloud/tes/dist/react/runs/index';
 
export default function Runs() {
  return <ECCClientGa4ghTesRuns />;
}

Properties

Property	Required	Default	Type	Description
`baseURL`	false	`https://protes.rahtiapp.fi/ga4gh/tes/v1`	`String`	Base URL of the TES instance/gateway
`fields`	false	See default config	`Array<Field>`	Configuration for what fields to display
`pageSize`	false	5	`Number`	Number of runs per page
`extendFields`	false	`false`	`Boolean`	Extend default fields instead of overriding

baseURL

Specifies the base URL for the TES instance. This is used as the endpoint for API requests.

fields

The fields property is an array of objects that define the fields to be displayed.

Default Fields Configuration

[
  {
    "key": "name",
    "path": "name",
    "tab": "Overview",
    "label": "Name",
    "copy": true
  },
  {
    "key": "description",
    "path": "description",
    "tab": "Overview",
    "label": "Description"
  },
  {
    "key": "resources",
    "path": "resources",
    "tab": "Overview",
    "label": "Resources"
  },
  {
    "key": "tags",
    "path": "tags",
    "tab": "Overview",
    "label": "Tags"
  },
  {
    "key": "executors",
    "path": "executors",
    "tab": "Overview",
    "label": "Executor"
  },
  {
    "key": "executors*",
    "path": "executors[*]",
    "arrayOptions": {
      "labelOptions": {
        "path": "image"
      }
    }
  },
  {
    "key": "executors*command",
    "path": "executors[*].command",
    "arrayOptions": {
      "type": "tag"
    }
  },
  {
    "key": "volumes",
    "path": "volumes",
    "tab": "Overview",
    "label": "Volumes"
  },
  {
    "key": "creation_time",
    "path": "creation_time",
    "tab": "Overview",
    "label": "Creation time"
  },
  {
    "key": "logs",
    "path": "logs",
    "tab": "Logs",
    "label": "Logs",
    "copy": true
  },
  {
    "key": "logs[*].logs[*].stderr",
    "path": "logs[*].logs[*].stderr",
    "label": "STDERR",
    "copy": true
  },
  {
    "key": "logs[*].logs[*].stdout",
    "path": "logs[*].logs[*].stdout",
    "label": "STDOUT",
    "copy": true
  },
  {
    "key": "logs[*]",
    "path": "logs[*]",
    "arrayOptions": {
      "labelOptions": {
        "path": "start_time",
        "prefix": "Start time: "
      }
    },
    "copy": true
  },
  {
    "key": "logs[*].logs[*]",
    "path": "logs[*].logs[*]",
    "arrayOptions": {
      "labelOptions": {
        "path": "start_time",
        "prefix": "Start time: "
      }
    },
    "copy": true
  },
  {
    "key": "outputs",
    "path": "outputs",
    "tab": "Output",
    "label": "Output",
    "copy": true
  },
  {
    "key": "inputs",
    "path": "inputs",
    "tab": "Inputs",
    "label": "Input",
    "copy": true
  },
  {
    "key": "inputs",
    "path": "inputs[*]",
    "arrayOptions": {
      "labelOptions": {
        "path": "path"
      }
    },
    "copy": true
  }
]

pageSize

Defines the number of task runs to be displayed per pagination window.

extendFields

When set to true, allows developers to pass additional fields that will extend the default fields rather than override them completely.

Known Limitations

Filtering: The component currently does not support filtering based on the task state due to backend limitations.

⚠️

While the UI provides filtering options, the backend API does not support this functionality, making client-side filtering impractical.

Search: The ability to search tasks by name prefix is not implemented.

⚠️

Although the TES specifications define filtering based on name_prefix, this feature has not been implemented in the current version.

Create Run Introduction