Warning
This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.
galaxy.webapps.reports.controllers package¶
Galaxy reports controllers.
Submodules¶
galaxy.webapps.reports.controllers.history module¶
- class galaxy.webapps.reports.controllers.history.History(app)[source]¶
Bases:
BaseUIController
Class defining functions used by reports to make requests to get informations and fill templates before being displayed. The name of function must be the same as as the field “action” of the “href” dict, in .mako templates (templates/webapps/reports).
galaxy.webapps.reports.controllers.home module¶
- class galaxy.webapps.reports.controllers.home.HomePage(app)[source]¶
Bases:
BaseUIController
,ReportQueryBuilder
galaxy.webapps.reports.controllers.jobs module¶
- galaxy.webapps.reports.controllers.jobs.sorter(default_sort_id, kwd)[source]¶
Initialize sorting variables
- galaxy.webapps.reports.controllers.jobs.get_curr_item(check_item, unique_items)[source]¶
When rendering by item and destination_id, render the item uniquely.
- class galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid[source]¶
Bases:
Grid
- class JobIdColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
IntegerColumn
- class StateColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
TextColumn
- class ToolColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
TextColumn
- class CreateTimeColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
DateTimeColumn
- class UserColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
GridColumn
- class EmailColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
GridColumn
- class DestinationIdColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
GridColumn
- class SpecifiedDateColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
GridColumn
- use_async = False¶
- title = 'Jobs'¶
- columns: List[GridColumn] = [<galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.JobIdColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.StateColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.DestinationIdColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.ToolColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.CreateTimeColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.UserColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.SpecifiedDateColumn object>, <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid.EmailColumn object>, <galaxy.web.legacy_framework.grids.StateColumn object>, <galaxy.web.legacy_framework.grids.MulticolFilterColumn object>]¶
- num_rows_per_page = 50¶
- use_paging = True¶
- class galaxy.webapps.reports.controllers.jobs.Jobs(app)[source]¶
Bases:
BaseUIController
,ReportQueryBuilder
Class contains functions for querying data requested by user via the webapp. It exposes the functions and responds to requests with the filled .mako templates.
- specified_date_list_grid = <galaxy.webapps.reports.controllers.jobs.SpecifiedDateListGrid object>¶
- specified_month_all(trans, **kwd)[source]¶
Queries the DB for all jobs in given month, defaults to current month.
- per_month_all(trans, **kwd)[source]¶
Queries the DB for all jobs. Avoids monitor jobs. The by_destination param will group by User.email and Job.destination_id.
- per_month_in_error(trans, **kwd)[source]¶
Queries the DB for user jobs in error. Filters out monitor jobs.
- per_user(trans, **kwd)[source]¶
Queries the DB for jobs per user. The by_destination param will group by Job.destination_id.
- user_per_month(trans, **kwd)[source]¶
Queries the DB for jobs per user per month. The by_destination param will group by Job.destination_id.
galaxy.webapps.reports.controllers.query module¶
Mixin to help build advanced queries for reports interface.
galaxy.webapps.reports.controllers.root module¶
galaxy.webapps.reports.controllers.system module¶
- class galaxy.webapps.reports.controllers.system.System(app)[source]¶
Bases:
BaseUIController
- userless_histories(trans, **kwd)[source]¶
The number of userless histories and associated datasets that have not been updated for the specified number of days.
- deleted_histories(trans, **kwd)[source]¶
The number of histories that were deleted more than the specified number of days ago, but have not yet been purged. Also included is the number of datasets associated with the histories.
galaxy.webapps.reports.controllers.tools module¶
- class galaxy.webapps.reports.controllers.tools.Tools(app)[source]¶
Bases:
BaseUIController
Class defining functions used by reports to make requests to get informations and fill templates before being displayed. The name of function must be the same as as the field “action” of the “href” dict, in .mako templates (templates/webapps/reports).
- tools_and_job_state(trans, **kwd)[source]¶
- fill tools_and_job_state.mako template with
the name of the tool
the number of jobs using this tool in state ‘ok’
the number of jobs using this tool in error
- tools_and_job_state_per_month(trans, **kwd)[source]¶
- fill tools_and_job_state_per_month.mako template with
the name of the tool
the number of jobs using this tool in state ‘ok’
the number of jobs using this tool in error
- tool_execution_time(trans, **kwd)[source]¶
- Fill the template tool_execution_time.mako with informations:
Tool name
Tool average execution time
last job execution time
min and max execution time
galaxy.webapps.reports.controllers.users module¶
- class galaxy.webapps.reports.controllers.users.Users(app)[source]¶
Bases:
BaseUIController
,ReportQueryBuilder
galaxy.webapps.reports.controllers.workflows module¶
- class galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid[source]¶
Bases:
Grid
- class WorkflowNameColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
TextColumn
- class CreateTimeColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
DateTimeColumn
- class UserColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
TextColumn
- class EmailColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
GridColumn
- class SpecifiedDateColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]¶
Bases:
GridColumn
- use_async = False¶
- model_class¶
alias of
StoredWorkflow
- title = 'Workflows'¶
- columns: List[GridColumn] = [<galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid.WorkflowNameColumn object>, <galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid.CreateTimeColumn object>, <galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid.UserColumn object>, <galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid.SpecifiedDateColumn object>, <galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid.EmailColumn object>, <galaxy.web.legacy_framework.grids.MulticolFilterColumn object>]¶
- num_rows_per_page = 50¶
- use_paging = True¶
- class galaxy.webapps.reports.controllers.workflows.Workflows(app)[source]¶
Bases:
BaseUIController
,ReportQueryBuilder
- specified_date_list_grid = <galaxy.webapps.reports.controllers.workflows.SpecifiedDateListGrid object>¶