Skip to content
Vault Logo
Vault Developer Portal Developer Quality
Advanced Search

    Release Notes

    Report

    Class: metadata

    Represents a Vault report.

    AttributeMetadataDescription
    labelType: String
    Required
    Max length: 128    		UI-friendly string in the Vault's base language.
    activeType: Boolean
    Required    		Indicates whether the component is active.
    descriptionType: String
    Max length: 255    		A general description about the report.
    formatType: Enum
    Required
    Allowed values:
    • tabular
    • matrix
    		The output format of the report. For example, a Tabular or Matrix report.
    definitionType: XMLString
    Required
    Max length: 32000    		The query to use to pull the data.
    layoutType: XMLString
    Required
    Max length: 32000    		The layout of the data.
    content_typeType: Enum
    Required
    Allowed values:
    • Document
    • Workflow
    • ReadAndUnderstand
    • Distribution
    • Bindernode
    • Object
    • Relationship
    • MatchedDocument
    • Binder
    • BinderSection
    • MultiPass
    • Union
    		Specifies the type of data the report refers to.
    report_typeType: ComponentThe Reporttype this instance of the report was created from.
    editorsType: String
    Max length: 1500
    Multi-value    		Lists users and Groups in the Editor role. Users in this role can edit reports.
    viewersType: String
    Max length: 1500
    Multi-value    		Lists users and Groups in the Viewer role. Users in this role can view reports.
    ownersType: String
    Max length: 1500
    Multi-value    		Lists users and Groups in the Owner role. Users in this role can assign other users and groups to the Owner role on reports.
    classType: Enum
    Allowed values:
    • Standard
    • View
    		Indicates whether the report is Standard or Multi-Pass.
    excel_templateType: ComponentIndicates which, if any, Excel template is associated with the report.
    fit_pdf_to_pageType: BooleanIndicates whether all columns should fit on a single page in the exported PDF.
    tagsType: String
    Max length: 1500
    Multi-value    		Any tags assigned to the report.
    include_full_longtextType: BooleanIf true, Vault includes the full text of long text fields in exports. If false or omitted, exports only contain the first 250 characters.
    include_full_richtextType: BooleanIf true, Vault includes the full text of rich text fields in exports. If false or omitted, exports only contain the first 250 characters.
    include_richtext_html_tagsType: BooleanIf true, Vault includes HTML markup in exports. This option is only available if include_full_richtext= true.

    Supported Operations

    Section link for Supported Operations
    OperationSupport
    Create*
    Recreate*
    Alter
    Drop
    Rename
    Describe
    Generate Recreate
    Queryable

    Notes:

    • Create, Recreate: MDL Operation is supported, but the Component Type contains field(s) that use proprietary XML. Direct modification of the XML is not supported or recommended. Instead, creating and/or updating the component is better suited through the Admin UI.