SAP ABAP Class CL_MSS_PSNAP (MSSQL : Performance Snapshot)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-DB-MSS (Application Component) Microsoft SQL Server
     SMSS_TOOLS (Package) Utilities for MS SQL Server
Properties
Class CL_MSS_PSNAP  
Short Description MSSQL : Performance Snapshot    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status P  SAP Standard Production Program 
Category 0   
Package SMSS_TOOLS   Utilities for MS SQL Server 
Created 20120505   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 CL_MSS_RAT Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_MSS_PSNAP has no interface implemented.
Friends
Class CL_MSS_PSNAP has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ARDR_TAB Instance attribute Private Type reference (TYPE) ARDR_TYPE_30 Rowset adminstration structure table type 20120622
2 AR_CH Constant Public Type reference (TYPE) MSSROWSET-RELID 'CH' sap_sheet_charts data 20121101
3 AR_DR Constant Public Type reference (TYPE) MSSROWSET-RELID 'DR' Payload rowset directory 20120505
4 AR_EP Constant Public Type reference (TYPE) MSSROWSET-RELID 'EP' Parameters for batch execution 20120512
5 AR_HD Constant Public Type reference (TYPE) MSSROWSET-RELID 'HD' Custom file properties 20120505
6 AR_IP Constant Public Type reference (TYPE) MSSROWSET-RELID 'IP' sap_tf_inpars data 20120505
7 AR_OC Constant Public Type reference (TYPE) MSSROWSET-RELID 'OC' sap_tf_outcols data 20120505
8 AR_RO Constant Public Type reference (TYPE) MSSROWSET-RELID 'RO' Rowset payload data 20120505
9 AR_SC Constant Public Type reference (TYPE) MSSROWSET-RELID 'SC' sap_sheet_contents data 20120505
10 AR_SH Constant Public Type reference (TYPE) MSSROWSET-RELID 'SH' sap_sheets data 20120505
11 AR_TF Constant Public Type reference (TYPE) MSSROWSET-RELID 'TF' sap_tf_tlist data 20120505
12 BATCH_ACT_RESET Constant Public Type reference (TYPE) CHAR1 'R' Batch action 'reset' 20120615
13 BATCH_ACT_SNAP Constant Public Type reference (TYPE) CHAR1 'S' Batch action 'snapshot' 20120615
14 CCLASS_SQL Constant Public Type reference (TYPE) MSSPPACK-CONTENT_KEY 'SQL' Standard relational performance package 20120615
15 CCLASS_SSAS Constant Public Type reference (TYPE) MSSPPACK-CONTENT_KEY 'SSAS' Standard Analysis Services paerformance package 20120615
16 CONN Instance attribute Private Type reference (TYPE) MSSCONNDATA MSSQL multi-connect : Complete connection information 20120621
17 CURRENT_SEQ Instance attribute Private Type reference (TYPE) ARDR_LINE_30-SEQ_NO Current sequence number 20120616
18 FLAGOFF_NATIVE Constant Public Type reference (TYPE) INT4 0 Native snapshot ('X') or imported as XML file (' ') 20120615
19 FLAGOFF_SINCERESET Constant Public Type reference (TYPE) INT4 2 Reset / since reset ('X') or floating average (' ') 20120615
20 FLAGOFF_TEMPORARY Constant Public Type reference (TYPE) INT4 1 Temporary snapshot for immediate download ('X') 20120615
21 INTERACT Instance attribute Private Type reference (TYPE) ABAP_BOOL Give user feedback 20120626
22 NAV_REF Instance attribute Private Object reference (TYPE REF TO) CL_DB6_TREE_NAVIGATOR CL_DB6_TREE_NAVIGATOR 20120621
23 OBJNAME_CH Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'sap_sheet_charts' Sheet chart list 20121101
24 OBJNAME_HD Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'CustomFileProperties' Custom file properties 20120615
25 OBJNAME_IP Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'sap_tf_inpars' List of RAT input parameters 20120615
26 OBJNAME_OC Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'sap_tf_outcols' List of RAT output columns 20120615
27 OBJNAME_SC Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'sap_sheet_contents' Sheet content list 20120615
28 OBJNAME_SH Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'sap_sheets' Sheet list 20120615
29 OBJNAME_TF Constant Public Type reference (TYPE) ARSC_LINE_30-RAT_PROVIDER 'sap_tf_tlist' List of RAT providers 20120615
30 PARSTACK Instance attribute Private Type reference (TYPE) PARSTACK_TTYPE Drilldown parameter stack table type 20120616
31 STATOFF_RESET Constant Public Type reference (TYPE) INT4 1 Statistics reset 20120621
32 STATOFF_SCHEDULED Constant Public Type reference (TYPE) INT4 0 Snapshot scheduled 20120621
33 STATOFF_SNAPSHOT Constant Public Type reference (TYPE) INT4 2 Snapshot execution 20120621
34 STATUS_ERR Constant Public Type reference (TYPE) CHAR1 'E' Error 20120621
35 STATUS_NA Constant Public Type reference (TYPE) CHAR1 'N' N / A 20120621
36 STATUS_OK Constant Public Type reference (TYPE) CHAR1 'S' Success 20120621
37 STATUS_OPEN Constant Public Type reference (TYPE) CHAR1 ' ' Still to come 20120621
38 VERSION_MAIN Constant Public Type reference (TYPE) INT4 3 File Schema Version - main 20120615
39 VERSION_SUB Constant Public Type reference (TYPE) INT4 5 File Schema Version - sub 20120615
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20120621
2 CREATE_PACKAGE_DIRECT Instance method Public Method Create a performance package in dialog 20120615
3 FILE_PROPERTIES Instance method Private Method Populate and save custom file properties 20120622
4 GET_CONTENT_CLASSES Static method Public Method Return a list of supported package classes 20120615
5 INIT_PACK_HEADER Instance method Private Method Initialize package header structure (MSSPPACK) 20120621
6 PROCESS_PROVIDER Instance method Private Method Recursive processing of data providers 20120616
7 SAVE_DIRECTORY Instance method Private Method Save the rowset directory as standard internal table 20120623
8 SAVE_IPLIST Instance method Private Method Save relevant input parameter data 20120622
9 SAVE_SHEET_CHARTS Instance method Private Method Read and save sap_sheet_charts 20121101
10 SAVE_SHEET_CONTENTS Instance method Private Method Read and save sap_sheet_contents 20120622
11 SAVE_SHEET_LIST Instance method Private Method Save the list of active sheets 20120622
12 SAVE_TLIST Instance method Private Method Read and save sap_tf_tlist 20120622
13 SERIALIZE_ITAB Static method Public Method Convert a rowset into an XML fragment 20120615
14 WRITE_PACKAGE_FRAGMENT Instance method Private Method Write a package fragment to table MSSROWSET 20120615
Events
Class CL_MSS_PSNAP has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 ARCH_LINE_35 Public See coding sap_sheet_charts line type 20121101 BEGIN OF ARCH_LINE_35 , CHART_NAME(128) TYPE C , PSTRING(1024) TYPE C , END OF ARCH_LINE_35
2 ARCH_TYPE_35 Public See coding sap_sheet_charts table type 20121101 ARCH_TYPE_35 TYPE STANDARD TABLE OF ARCH_LINE_35
3 ARDR_LINE_30 Public See coding Rowset administration structure line type 20120615 BEGIN OF ARDR_LINE_30 , SHEET_INDX(4) TYPE N , " INITIAL for drill-down RS_ON_SHEET_IX(4) TYPE N , " INITIAL for drill-down FPRINT TYPE STRING , SEQ_NO(8) TYPE N , META_SEQ(8) TYPE N , " Sequence number of metadata END OF ARDR_LINE_30
4 ARDR_TYPE_30 Public See coding Rowset adminstration structure table type 20120615 ARDR_TYPE_30 TYPE SORTED TABLE OF ARDR_LINE_30 WITH UNIQUE KEY SHEET_INDX RS_ON_SHEET_IX FPRINT
5 AREP_TYPE_30 Public See coding Batch execution control data 20120614 BEGIN OF AREP_TYPE_30 , RESET_JOBNAME TYPE TBTCJOB-JOBNAME , RESET_JOBCOUNT TYPE TBTCJOB-JOBCOUNT , SNAP_JOBNAME TYPE TBTCJOB-JOBNAME , SNAP_JOBCOUNT TYPE TBTCJOB-JOBCOUNT , RSAMPLE_ID TYPE I , END OF AREP_TYPE_30
6 ARHD_LINE_30 Public See coding Header line (key/value) 20120614 BEGIN OF ARHD_LINE_30 , KEY(255) TYPE C , VALUE(255) TYPE C , END OF ARHD_LINE_30
7 ARHD_TYPE_30 Public See coding Header table (key/value list) 20120614 ARHD_TYPE_30 TYPE STANDARD TABLE OF ARHD_LINE_30
8 ARIP_LINE_30 Public See coding Reduced sap_tf_inpars structure plus parameter value 20120622 BEGIN OF ARIP_LINE_30 , COLNAME TYPE CL_MSS_RAT=>ISTRUCT_L-COLNAME , COLTYPE TYPE CL_MSS_RAT=>ISTRUCT_L-COLTYPE , INITIO TYPE CL_MSS_RAT=>ISTRUCT_L-INITIO , DEFWERT TYPE CL_MSS_RAT=>ISTRUCT_L-DEFWERT , VALUE(255) TYPE C , END OF ARIP_LINE_30
9 ARIP_TYPE_30 Public See coding Table type for ARIP_LINE_30 20120622 ARIP_TYPE_30 TYPE STANDARD TABLE OF ARIP_LINE_30
10 ARSC_LINE_30 Public See coding sap_sheet_contents line type 20120615 BEGIN OF ARSC_LINE_30 , SHEET_NAME TYPE ARSH_LINE_30-SHEET_NAME , RAT_PROVIDER TYPE CL_MSS_RAT=>TLIST_L-OBJNAME , RAT_PARAMS(256) TYPE C , END OF ARSC_LINE_30
11 ARSC_LINE_35 Public See coding sap_sheet_contents line type 20121101 BEGIN OF ARSC_LINE_35 , SHEET_NAME TYPE ARSH_LINE_30-SHEET_NAME , RAT_PROVIDER TYPE CL_MSS_RAT=>TLIST_L-OBJNAME , RAT_PARAMS(256) TYPE C , CHARTS(128) TYPE C , END OF ARSC_LINE_35
12 ARSC_TYPE_30 Public See coding sap_sheet_contents table type 20120615 ARSC_TYPE_30 TYPE STANDARD TABLE OF ARSC_LINE_30
13 ARSC_TYPE_35 Public See coding sap_sheet_contents table type 20121101 ARSC_TYPE_35 TYPE STANDARD TABLE OF ARSC_LINE_35
14 ARSH_LINE_30 Public See coding Basic sap_sheets line type 20120615 BEGIN OF ARSH_LINE_30 , SHEET_NAME(128) TYPE C , SHEET_DESC(31) TYPE C , END OF ARSH_LINE_30
15 ARSH_TYPE_30 Public See coding Basic sap_sheets table type 20120615 ARSH_TYPE_30 TYPE STANDARD TABLE OF ARSH_LINE_30
16 ARTF_LINE_30 Public See coding sap_tf_tlist structure without ACTVT 20120622 BEGIN OF ARTF_LINE_30 , HIERARCHY TYPE CL_MSS_RAT=>TLIST_L-HIERARCHY, OBJNAME TYPE CL_MSS_RAT=>TLIST_L-OBJNAME, OBJTYPE TYPE CL_MSS_RAT=>TLIST_L-OBJTYPE, HIDDEN TYPE CL_MSS_RAT=>TLIST_L-HIDDEN, NRKEYS TYPE CL_MSS_RAT=>TLIST_L-NRKEYS, PTYPE TYPE CL_MSS_RAT=>TLIST_L-PTYPE, DESCRIPT TYPE CL_MSS_RAT=>TLIST_L-DESCRIPT, END OF ARTF_LINE_30
17 ARTF_TYPE_30 Public See coding Table type for ARTF_LINE_30 20120622 ARTF_TYPE_30 TYPE STANDARD TABLE OF ARTF_LINE_30
18 CCLASS_TTYPE Public See coding Package content class table type 20120615 CCLASS_TTYPE TYPE STANDARD TABLE OF CONTENT_CLASS WITH KEY CONTENT_KEY
19 CONTENT_CLASS Public See coding Package content class line type 20120615 BEGIN OF CONTENT_CLASS , CONTENT_KEY TYPE MSSPPACK-CONTENT_KEY , DESCRIPTION(64) TYPE C , END OF CONTENT_CLASS
20 PARSTACK_LTYPE Private See coding Drilldown parameter stack line type 20120616 BEGIN OF PARSTACK_LTYPE , LEVEL TYPE I , CLPARAM(64) TYPE C , VALUE(255) TYPE C , END OF PARSTACK_LTYPE
21 PARSTACK_TTYPE Private See coding Drilldown parameter stack table type 20120616 PARSTACK_TTYPE TYPE STANDARD TABLE OF PARSTACK_LTYPE
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CURRCON Call by reference Type reference (TYPE) MSSCONNDATA MSSQL multi-connect : Complete connection information 20120621
2 Importing INTERACTIVE Call by reference Type reference (TYPE) ABAP_BOOL ' ' Give user feedback 20120626
3 Importing NAVIGATOR Call by reference Object reference (TYPE REF TO) CL_DB6_TREE_NAVIGATOR CL_DB6_TREE_NAVIGATOR 20120621

Method CONSTRUCTOR on class CL_MSS_PSNAP has no exception.

Method CREATE_PACKAGE_DIRECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTENT_KEY Call by reference Type reference (TYPE) MSSPPACK-CONTENT_KEY Content key (CL_MSS_PSNAP=>GET_CONTENT_CLASSES) 20120615
2 Importing IS_TEMPORARY Call by reference Type reference (TYPE) ABAP_BOOL ' ' Delete package after download 20120621
3 Exporting PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120615
4 Importing SHEET_LIST Call by reference Type reference (TYPE) ARSH_TYPE_30 Basic sap_sheets table type 20120615
5 Importing STEXT Call by reference Type reference (TYPE) MSSPPACK-STEXT Short text 20120621
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120621

Method FILE_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PACK_HEADER Call by reference Type reference (TYPE) MSSPPACK MSSQL : list of DB performance snapshots 20120622
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120622

Method GET_CONTENT_CLASSES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CLASS_LIST Value transfer Type reference (TYPE) CCLASS_TTYPE List of package content classes 20120615

Method GET_CONTENT_CLASSES on class CL_MSS_PSNAP has no exception.

Method INIT_PACK_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTENT_KEY Call by reference Type reference (TYPE) MSSPPACK-CONTENT_KEY Content key (CL_MSS_PSNAP=>GET_CONTENT_CLASSES) 20120621
2 Importing IS_TEMPORARY Call by reference Type reference (TYPE) ABAP_BOOL Delete package after download 20120621
3 Returning PACK_HEADER Value transfer Type reference (TYPE) MSSPPACK MSSQL : list of DB performance snapshots 20120621
4 Importing STEXT Call by reference Type reference (TYPE) MSSPPACK-STEXT Short text 20120621
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120621

Method PROCESS_PROVIDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INSTRUCT Call by reference Object reference (TYPE REF TO) DATA Stronly typed input parameter structure with values 20120616
2 Importing IPLIST Call by reference Type reference (TYPE) CL_MSS_RAT=>ISTRUCT_T Table of ISTRUCT_L 20120616
3 Importing LEVEL Call by reference Type reference (TYPE) I Drilldown stack index 20120616
4 Importing OBJNAME Call by reference Type reference (TYPE) CL_MSS_RAT=>TLIST_L-OBJNAME RAT provider 20120616
5 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120622
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120622

Method SAVE_DIRECTORY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ARDR Call by reference Type reference (TYPE) ARDR_TYPE_30 Rowset adminstration structure table type 20120623
2 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120623
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120623

Method SAVE_IPLIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INSTRUCT Call by reference Object reference (TYPE REF TO) DATA Strongly typed input parameter structure 20120622
2 Importing IPLIST Call by reference Type reference (TYPE) CL_MSS_RAT=>ISTRUCT_T Table of ISTRUCT_L 20120622
3 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120622
4 Importing SEQ_NO Call by reference Type reference (TYPE) ARDR_LINE_30-SEQ_NO Rowset administration structure line type 20120622
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120622

Method SAVE_SHEET_CHARTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20121101
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20121101

Method SAVE_SHEET_CONTENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120622
2 Changing SC_TAB Call by reference Type reference (TYPE) ARSC_TYPE_35 sap_sheet_contents table type 20120622
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120622

Method SAVE_SHEET_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120622
2 Importing SHEET_LIST Call by reference Type reference (TYPE) ARSH_TYPE_30 Basic sap_sheets table type 20120622
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120622

Method SAVE_TLIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120622
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120622

Method SERIALIZE_ITAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ITAB Call by reference Object reference (TYPE REF TO) DATA Rowset 20120615
2 Importing OBJNAME Call by reference Type reference (TYPE) CL_MSS_RAT=>TLIST_L-OBJNAME RAT object name 20120615
3 Importing OUTCOLS Call by reference Type reference (TYPE) CL_MSS_RAT=>OSTRUCT_T Explicit rowset structure 20120615
4 Exporting XMLSTRING Call by reference Type reference (TYPE) XSTRING Resulting XML fragment 20120615
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120615

Method WRITE_PACKAGE_FRAGMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing AREA_ID Call by reference Type reference (TYPE) MSSROWSET-RELID INDX-style area specification 20120615
2 Importing PACK_ID Call by reference Type reference (TYPE) MSSPPACK-PACK_ID UUID in character form 20120615
3 Importing SEQ_NO Call by reference Type reference (TYPE) MSSROWSET-SEQ_NO Rowset index within performance snapshot 20120615
4 Importing XMLFRAGMENT Call by reference Type reference (TYPE) XSTRING XML fragment in UTF-8 encoding 20120615
# Exception Resumable Description Created on
1 CX_SMSS_TOOLS MSSQL exception class 20120615
History
Last changed by/on SAP  20130531 
SAP Release Created in 740