KBaseReport/KBaseReportWorkspace.spec at master · kbaseapps/KBaseReport · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
 * Workspace types for report data that gets generated and saved on report creation.
 * These objects are generated in this module as result data from the create()
 * and create_extended_report() methods found in KBaseReport.spec
 */
module KBaseReport {
    /*
     * Workspace ID reference in the format 'workspace_id/object_id/version'
     * @id ws
     */
    typedef string ws_id;

    /*
     * Reference to a handle ID
     * @id handle
     */
    typedef string handle_ref;

    /*
     * Represents a Workspace object with some brief description text
     * that can be associated with the object.
     * Required arguments:
     *     ws_id ref - workspace ID in the format 'workspace_id/object_id/version'
     * Optional arguments:
     *     string description - A plaintext, human-readable description of the
     *         object created.
     * @optional description
     */
    typedef structure {
        ws_id ref;
        string description;
    } WorkspaceObject;

    /*
     * Represents a single file or zipped directory of files that the report
     * links to or renders as HTML. Used by Report for either html_links or file_links.
     * Required arguments:
     *     handle_ref handle - Handle ID
     *     string name - Filename, such as results.zip (shown to the user)
     *     string URL - URL of shock node: <shock-url>/node/<shock-handle-id>
     * Optional arguments:
     *     string label - A short description for the file (eg. "Filter results")
     *     string description - A more detailed, human-readable description of the file
     * @optional description label
     */
    typedef structure {
        handle_ref handle;
        string description;
        string name;
        string label;
        string URL;
    } LinkedFile;

    /*
     * A Report of a method run in KBase. Both create() and
     * create_extended_report() from KBaseReport.spec ultimately generate these
     * objects and store them in the workspace.
     * Optional arguments:
     *     string text_message - Readable plain-text report message
     *     list<string> warnings - A list of plain-text warning messages
     *     list<WorkspaceObject> objects_created - List of result workspace objects that this app
     *         has created. They will get linked in the report view
     *     list<LinkedFile> file_links - List of LinkedFiles that the report
     *         lists out for the user to download
     *     list<LinkedFile> html_links - List of directories of HTML files and content
     *         that the report will render or link for download. Pass in either
     *         direct_html or direct_html_link_index, not both.
     *     string direct_html - Simple HTML text that will be rendered within the report widget.
     *         Pass in either direct_html or direct_html_link_index, not both.
     *     int direct_html_link_index - Index in html_links to set the direct/default view in the
     *         report. Do not also pass in direct_html if you set this.
     *     html_window_height - Fixed height in pixels of the HTML window for the report
     *     summary_window_height - Fixed height in pixels of the summary window for the report
     * @optional warnings file_links html_links direct_html direct_html_link_index
     * @optional html_window_height summary_window_height
     * @metadata ws length(warnings) as Warnings
     * @metadata ws length(text_message) as Message Length
     * @metadata ws length(objects_created) as Objects Created
     */
    typedef structure {
        string text_message;
        list<string> warnings;
        list<WorkspaceObject> objects_created;
        list<LinkedFile> file_links;
        list<LinkedFile> html_links;
        string direct_html;
        int direct_html_link_index;
        float html_window_height;
        float summary_window_height;
    } Report;
};