Skip to content

/AWS1/CL_QSTSNAPFILESHEETSEL00

A structure that contains information that identifies the snapshot that needs to be generated.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_sheetid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

iv_selectionscope TYPE /AWS1/QSTSNAPFILESHEETSELION00 /AWS1/QSTSNAPFILESHEETSELION00

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

  • ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

  • SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

Optional arguments:

it_visualids TYPE /AWS1/CL_QSTSNAPFILESHEETSEL01=>TT_SNAPFILESHEETSELIONVISUAL00 TT_SNAPFILESHEETSELIONVISUAL00

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Queryable Attributes

SheetId

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

Accessible with the following methods

Method Description
GET_SHEETID() Getter for SHEETID, with configurable default
ASK_SHEETID() Getter for SHEETID w/ exceptions if field has no value
HAS_SHEETID() Determine if SHEETID has a value

SelectionScope

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

  • ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

  • SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

Accessible with the following methods

Method Description
GET_SELECTIONSCOPE() Getter for SELECTIONSCOPE, with configurable default
ASK_SELECTIONSCOPE() Getter for SELECTIONSCOPE w/ exceptions if field has no valu
HAS_SELECTIONSCOPE() Determine if SELECTIONSCOPE has a value

VisualIds

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Accessible with the following methods

Method Description
GET_VISUALIDS() Getter for VISUALIDS, with configurable default
ASK_VISUALIDS() Getter for VISUALIDS w/ exceptions if field has no value
HAS_VISUALIDS() Determine if VISUALIDS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_SNAPFILESHEETSELECTIONLIST

TYPES TT_SNAPFILESHEETSELECTIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_QSTSNAPFILESHEETSEL00 WITH DEFAULT KEY
.