SAP ABAP Class CL_MSS_LOGIN_SETUP (MSSQL: Setup DB monitor environment)
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_LOGIN_SETUP | |
| Short Description | MSSQL: Setup DB monitor environment | |
| 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 | 20100205 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_MSS_LOGIN_SETUP has no forward declaration.
Interfaces
Class CL_MSS_LOGIN_SETUP has no interface implemented.
Friends
Class CL_MSS_LOGIN_SETUP has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | `Initial` | Initial web client setup | 20100731 | ||
| 2 | Constant | Public | Type reference (TYPE) | STRING | `Refresh` | Refresh web client | 20100731 | ||
| 3 | Constant | Public | Type reference (TYPE) | STRING | `Uninstall` | Uninstall web client | 20100731 | ||
| 4 | Constant | Public | Type reference (TYPE) | STRING | `A_initial` | Initial setup | 20100209 | ||
| 5 | Constant | Public | Type reference (TYPE) | STRING | `A_re_drop` | Drop old context including history | 20100209 | ||
| 6 | Constant | Public | Type reference (TYPE) | STRING | `A_re_preserve` | Drop old context, keep history | 20100209 | ||
| 7 | Constant | Public | Type reference (TYPE) | STRING | `A_uninstall` | Remove monitor context | 20100209 | ||
| 8 | Constant | Public | Type reference (TYPE) | STRING | `SQL` | SQL Server Security | 20100206 | ||
| 9 | Constant | Public | Type reference (TYPE) | STRING | `SSPI` | Windows Security | 20100206 | ||
| 10 | Constant | Public | Type reference (TYPE) | STRING | `None` | Anonymous access | 20100731 | ||
| 11 | Constant | Public | Type reference (TYPE) | STRING | `Self` | Use SQL login | 20100731 | ||
| 12 | Constant | Public | Type reference (TYPE) | STRING | `Service` | Use service account | 20100731 | ||
| 13 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@ACTION@' | Substitution key | 20100205 | ||
| 14 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@ACTIVITY@' | Substitution key | 20100731 | ||
| 15 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@AUTHENTICATION@' | Substitution key | 20100205 | ||
| 16 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@DATUM@' | Substitution key | 20100205 | ||
| 17 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@DBNAME@' | Substitution key | 20100205 | ||
| 18 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@DBSCHEMA@' | Substitution key | 20100205 | ||
| 19 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@DISABLESQLCNTR@' | Substitution key | 20100731 | ||
| 20 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@HOSTNAME@' | Substitution key | 20100205 | ||
| 21 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@LOGIN_NAME@' | Substitution key | 20100205 | ||
| 22 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@LOGIN_PASSWD@' | Substitution key | 20100205 | ||
| 23 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@PROCSVERS@' | Substitution key | 20100205 | ||
| 24 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@SERVICESEC@' | Substitution key | 20100731 | ||
| 25 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@SERVICEURL@' | Substitution key | 20100731 | ||
| 26 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@TRUST_LEVEL@' | Substitution key | 20100205 | ||
| 27 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@UNAME@' | Substitution key | 20100205 | ||
| 28 | Constant | Public | Type reference (TYPE) | SUBSTKEY | '@UZEIT@' | Substitution key | 20100205 | ||
| 29 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'DBCOLL' | Collector job parameters | 20100225 | ||
| 30 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'DBH' | Performance data warehouse parameters | 20100225 | ||
| 31 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'LOCKSTATS' | Blocking lock job parameters | 20101118 | ||
| 32 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'MSSPROCS' | Parameters for source schema refresh | 20100225 | ||
| 33 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'SAPMonWin' | Monitor web service parameters | 20100728 | ||
| 34 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'STMTHIST' | Statement history parameters | 20100818 | ||
| 35 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'SYSTEM' | System settings relevant for collector | 20100225 | ||
| 36 | Constant | Public | Type reference (TYPE) | PARL_TYP-AREA | 'TABSTATS' | Table statistics job parameters | 20101118 | ||
| 37 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'AgentState' | SQL Agent is running ? | 20100301 | ||
| 38 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'Authenticate' | Web client authentication mode | 20100728 | ||
| 39 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'AutoInject' | Automatic update of the monitor objects | 20100226 | ||
| 40 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'DisableREMon' | Disable relational monitor counters | 20100728 | ||
| 41 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'enabled' | DB Collector is active | 20100225 | ||
| 42 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'frequency' | DBCOLL frequency [min] | 20100225 | ||
| 43 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'hour' | Hour to start table statistics job | 20101118 | ||
| 44 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'InjectContext' | App server and user of last auto update | 20100226 | ||
| 45 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'InjectStatus' | Auto update status - see CO_STATUS_* | 20100226 | ||
| 46 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'InjectTime' | UTC timestamp of last auto update | 20100226 | ||
| 47 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'jobname' | DB Collector SQL Agent job | 20100225 | ||
| 48 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'job_enabled' | DB Collector SQL Agent job enabled | 20100225 | ||
| 49 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'job_exists' | DB Collector SQL Agent job exists | 20100225 | ||
| 50 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'retention' | DBCOLL retention frame | 20100225 | ||
| 51 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'stmthist_enabled' | 20100819 | |||
| 52 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'max_interval' | 20100818 | |||
| 53 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'retain_days' | 20100818 | |||
| 54 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'top_n' | 20100818 | |||
| 55 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'TabsizeTime' | UTC timestamp of last table size extraction | 20100305 | ||
| 56 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'Url' | Web service URL | 20100728 | ||
| 57 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'Error' | Auto update resulted in error | 20100226 | ||
| 58 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'Executing' | Auto update running | 20100226 | ||
| 59 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'Initial' | No previous auto update | 20100226 | ||
| 60 | Constant | Public | Type reference (TYPE) | PARL_TYP-KEY | 'OK' | Auto update succeeded | 20100226 | ||
| 61 | Instance attribute | Private | Type reference (TYPE) | MSSCONNDATA | MSSQL multi-connect : Complete connection information | 20100225 | |||
| 62 | Constant | Public | Type reference (TYPE) | MSSPROCS-PROCNAME | 'INJECT_TEMPLATE' | MS SQL Server: Stored procedure name | 20100802 | ||
| 63 | Instance attribute | Private | Type reference (TYPE) | PDESCTAB | Parameter descritpion table | 20100225 | |||
| 64 | Constant | Public | Type reference (TYPE) | MSSPROCS-PROCNAME | 'SAPCLR_TEMPLATE' | MS SQL Server: Stored procedure name | 20100802 | ||
| 65 | Instance attribute | Private | Type reference (TYPE) | SUBSTTAB | Substitution table | 20100205 | |||
| 66 | Constant | Public | Type reference (TYPE) | STRING | `T_impersonate` | Trust level impersonate sa | 20100209 | ||
| 67 | Constant | Public | Type reference (TYPE) | STRING | `T_restricted` | Restricted trust level | 20100209 | ||
| 68 | Constant | Public | Type reference (TYPE) | STRING | `T_standard` | Standard trust level | 20100209 | ||
| 69 | Constant | Public | Type reference (TYPE) | STRING | `T_sysadmin` | Trust level sa | 20100209 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Fill friendly names into a parameter line | 20100225 | |
| 2 | Instance method | Public | Method | Add tupel to substitute table | 20100205 | |
| 3 | Instance method | Public | Method | Refresh substitute table | 20100205 | |
| 4 | Instance method | Public | Constructor | CONSTRUCTOR | 20100225 | |
| 5 | Instance method | Public | Method | Execute fully substituted script | 20100206 | |
| 6 | Static method | Private | Method | INJECT_TEMPLATE is encoded in method source | 20100206 | |
| 7 | Instance method | Public | Method | Get a sap_mon_para recordset, optionally with texts | 20100225 | |
| 8 | Instance method | Public | Method | Retrieve script with (non-secret) substitutions for display | 20100205 | |
| 9 | Instance method | Public | Method | Get a single sap_mon_para record, optionally with texts | 20100225 | |
| 10 | Static method | Public | Method | Create strong random password | 20100205 | |
| 11 | Instance method | Public | Method | Set a single parameter via sap_set_para | 20100225 |
Events
Class CL_MSS_LOGIN_SETUP has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | ADMIN_CONN | Public | See coding | Credentials for one-time administrative DB connection | 20100209 | BEGIN OF ADMIN_CONN,
HOSTNAME TYPE MSSCONNDATA-HOSTNAME,
AUTH TYPE STRING,
WINDOMAIN(128) TYPE C,
LOGIN(128) TYPE C,
PASSWD(128) TYPE C,
DBNAME TYPE MSSCONNDATA-DBNAME,
END OF ADMIN_CONN
|
|
| 2 | DISPLAYTAB | Public | See coding | Line-by-line table for script display | 20100205 | DISPLAYTAB type standard table of SRCLINE120
|
|
| 3 | EXEC_INTER | Public | See coding | DBACOCKPIT navigator data interchange | 20100301 | BEGIN OF EXEC_INTER ,
REQUEST_DYNP TYPE SYST-DYNNR ,
PROCNAME TYPE MSSPROCS-PROCNAME ,
DBRELEASE TYPE MSSPROCS-DBRELEASE ,
END OF EXEC_INTER
|
|
| 4 | OUTL_TYP | Public | See coding | Line type for script execution result set | 20100216 | OUTL_TYP(1024) type C
|
|
| 5 | OUTTAB_TYP | Public | See coding | Script execution result set | 20100216 | OUTTAB_TYP type standard table of OUTL_TYP
|
|
| 6 | PARL_TYP | Public | See coding | sap_mon_para + description | 20100225 | BEGIN OF PARL_TYP,
AREA(64) TYPE C ,
KEY(64) TYPE C ,
VALUE(128) TYPE C ,
DEFAULT(128) TYPE C ,
READONLY TYPE ABAP_BOOL ,
KEYTEXT(64) TYPE C ,
DESCRIPT(128) TYPE C ,
END OF PARL_TYP
|
|
| 7 | PARTAB_TYP | Public | See coding | Parameter table (including description columns) | 20100225 | PARTAB_TYP type standard table of PARL_TYP
|
|
| 8 | PASSWD64 | Public | See coding | Password type C(64) | 20100209 | PASSWD64(64) type C
|
|
| 9 | PDESCTAB | Private | See coding | Parameter descritpion table | 20100225 | PDESCTAB type standard table of PDESC_L
|
|
| 10 | PDESC_L | Private | See coding | Parameter description line | 20100225 | begin of PDESC_L ,
AREA(64) TYPE C ,
KEY(64) TYPE C ,
KEYTEXT(64) TYPE C ,
DESCRIPT(128) TYPE C ,
READONLY TYPE ABAP_BOOL ,
end of PDESC_L
|
|
| 11 | SRCLINE120 | Public | See coding | Line type for script display | 20100205 | SRCLINE120(120) type C
|
|
| 12 | SUBSTKEY | Public | See coding | Substitution key | 20100205 | SUBSTKEY(30) type C
|
|
| 13 | SUBSTTAB | Private | See coding | Substitution table | 20100205 | SUBSTTAB type standard table of SUBST_L
|
|
| 14 | SUBST_L | Private | See coding | Line type substitution table | 20100205 | BEGIN OF SUBST_L ,
UNSUBST TYPE SUBSTKEY ,
SUBSTITUT TYPE STRING ,
END OF SUBST_L
|
Method Signatures
Method ADD_PARA_TEXTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PARAM | Call by reference | Type reference (TYPE) | PARL_TYP | sap_mon_para + description | 20100225 |
Method ADD_PARA_TEXTS on class CL_MSS_LOGIN_SETUP has no exception.
Method ADD_SUBSTITUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SUBSTITUTE | Call by reference | Type reference (TYPE) | CLIKE | Substitution string | 20100205 | |||
| 2 | UNSUBST | Call by reference | Type reference (TYPE) | SUBSTKEY | Substitution key | 20100205 |
Method ADD_SUBSTITUTE on class CL_MSS_LOGIN_SETUP has no exception.
Method CLEAR_SUBSTITUTES Signature
Method CLEAR_SUBSTITUTES on class CL_MSS_LOGIN_SETUP has no parameter.
Method CLEAR_SUBSTITUTES on class CL_MSS_LOGIN_SETUP has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CURRCON | Call by reference | Type reference (TYPE) | MSSCONNDATA | MSSQL multi-connect : Complete connection information | 20100225 |
Method CONSTRUCTOR on class CL_MSS_LOGIN_SETUP has no exception.
Method EXECUTE_SCRIPT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ADMIN | Call by reference | Type reference (TYPE) | ADMIN_CONN | Credentials for one-time administrative DB connection | 20100209 | |||
| 2 | OUT_TAB | Call by reference | Type reference (TYPE) | OUTTAB_TYP | Script execution result set | 20100216 | |||
| 3 | PROCNAME | Call by reference | Type reference (TYPE) | MSSPROCS-PROCNAME | INJECT_TEMPLATE | MS SQL Server: Stored procedure name | 20100802 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | MSSQL exception class | 20100209 | ||
| 2 | Exception Class for SQL Error | 20100209 |
Method GET_INJECT_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DBRELEASE | Call by reference | Type reference (TYPE) | MSSSOURCE-DBRELEASE | MS SQL Server : Database Release X.YY.ZZZ | 20100206 | |||
| 2 | SRCTAB | Call by reference | Type reference (TYPE) | DISPLAYTAB | Standard table of SRCLINE120 | 20100206 |
Method GET_INJECT_TEMPLATE on class CL_MSS_LOGIN_SETUP has no exception.
Method GET_PARA_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | PARL_TYP-AREA | Parameter class, empty for all | 20100225 | |||
| 2 | PARAMTAB | Value transfer | Type reference (TYPE) | PARTAB_TYP | Parameter table (including description columns) | 20100225 | |||
| 3 | WITH_TEXTS | Call by reference | Type reference (TYPE) | C | Fill friendly texts? | 20100225 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | MSSQL exception class | 20100225 |
Method GET_SCRIPT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DBRELEASE | Call by reference | Type reference (TYPE) | MSSSOURCE-DBRELEASE | MS SQL Server : Database Release X.YY.ZZZ | 20100205 | |||
| 2 | PROCNAME | Call by reference | Type reference (TYPE) | MSSSOURCE-PROCNAME | INJECT_TEMPLATE | MS SQL Server: Stored procedure name | 20100731 | ||
| 3 | RESITAB | Call by reference | Type reference (TYPE) | DISPLAYTAB | Standard table of SRCLINE120 | 20100205 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | MSSQL exception class | 20100216 |
Method GET_SINGLE_PARA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | PARL_TYP-AREA | sap_mon_para + description | 20100225 | |||
| 2 | KEY | Call by reference | Type reference (TYPE) | PARL_TYP-KEY | sap_mon_para + description | 20100225 | |||
| 3 | PARAM | Value transfer | Type reference (TYPE) | PARL_TYP | sap_mon_para + description | 20100225 | |||
| 4 | WITH_TEXTS | Call by reference | Type reference (TYPE) | C | Fill friendly texts? | 20100225 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | MSSQL exception class | 20100225 |
Method RANDOM_PASSWD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PASSWD | Value transfer | Type reference (TYPE) | PASSWD64 | Type for random password | 20100205 |
Method RANDOM_PASSWD on class CL_MSS_LOGIN_SETUP has no exception.
Method SET_SINGLE_PARA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | PARL_TYP-AREA | Parameter area | 20100226 | |||
| 2 | KEY | Call by reference | Type reference (TYPE) | PARL_TYP-KEY | Parameter key | 20100226 | |||
| 3 | VALUE | Call by reference | Type reference (TYPE) | PARL_TYP-VALUE | Parameter value | 20100226 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | MSSQL exception class | 20100226 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 730 |