SAP ABAP Class CL_HC_UTIL_SOLMAN (Solution Manager Documents in Help Center)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-HLP-ABA (Application Component) Help Infrastructure for ABAP
⤷
SWDP_HELP_CENTER (Package) Help Center ABAP Web Dynpro
SAP_UI (Software Component) User Interface Technology⤷
BC-HLP-ABA (Application Component) Help Infrastructure for ABAP⤷
SWDP_HELP_CENTER (Package) Help Center ABAP Web DynproProperties
| Class | CL_HC_UTIL_SOLMAN | |
| Short Description | Solution Manager Documents in Help Center | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SWDP_HELP_CENTER | Help Center ABAP Web Dynpro |
| Created | 20080602 | SAP |
| Last change | 20110908 | 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) |
Interfaces
Class CL_HC_UTIL_SOLMAN has no interface implemented.
Friends
Class CL_HC_UTIL_SOLMAN has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APPL_NAME |
Static Attribute | Private | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_NAME | Object Name in Object Directory | 20080624 | ||
| 2 | APPL_NAME_EXTD |
Static Attribute | Private | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_NAME_EXTD | Name Extension, e.g. Configuration ID for WD ABAP | 20080624 | ||
| 3 | APPL_SUBNAME1 |
Static Attribute | Private | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_SUBNAME1 | Object Name in Object Directory | 20080624 | ||
| 4 | APPL_SUBNAME2 |
Static Attribute | Private | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_SUBNAME2 | 30 Characters | 20080624 | ||
| 5 | APPL_TYPE |
Static Attribute | Private | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_TYPE | Object Type | 20080624 | ||
| 6 | BACK_DESTINATION |
Static Attribute | Public | Type reference (TYPE) | RFCDEST | BACK Destination in Solution Manager | 20081120 | ||
| 7 | C_HELP_CENTER_FILES |
Constant | Public | Type reference (TYPE) | SDOK_DOCID | '48223A59A8C732CFE10000000A114504' | OBJID of Folder for Uploaded Documents (Productive) | 20081125 | |
| 8 | C_RFC_DESTINATION |
Constant | Public | Type reference (TYPE) | RFCDEST | 'HELP_CENTER_TO_SOLMAN' | Power User Destination in Solution Manager | 20080602 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_SOLMAN_AVAILABILITY |
Static method | Public | Method | Check Whether Solution Manager Is Available | 20081118 |
| 2 | FILE_DELETE_FROM_SOLMAN |
Static method | Public | Method | Delete Power User File from Hard-Coded Folder | 20081204 |
| 3 | FILE_DOWNLOAD_FROM_SOLMAN |
Static method | Public | Method | Read Power User File from Hard-Coded Folder | 20081205 |
| 4 | FILE_UPDATE_IN_SOLMAN |
Static method | Public | Method | Update Power User File in Hard-Coded Folder | 20081203 |
| 5 | FILE_UPLOAD_TO_SOLMAN |
Static method | Public | Method | Load Power User File to Hard-Coded Folder | 20081203 |
| 6 | GET_URL |
Static method | Public | Method | Generate URL for Solution Manager Documents (IOs and LMs) | 20081117 |
| 7 | INIT |
Static method | Public | Method | Initialization and Availability Check | 20081118 |
| 8 | SEARCH_FOR_CR_DOC |
Static method | Public | Method | Find Documents in Central Repository | 20081208 |
| 9 | SEARCH_FOR_IO |
Static method | Public | Method | Find Help Documents | 20081124 |
| 10 | SEARCH_FOR_LM |
Static method | Public | Method | Find Learning Maps | 20081113 |
| 11 | UPDATE_LINKS |
Static method | Public | Method | Update SAPGUIHC_LINKS from SOLMAN_DOCS | 20081208 |
Events
Class CL_HC_UTIL_SOLMAN has no event.
Types
Class CL_HC_UTIL_SOLMAN has no local type.
Method Signatures
Method CHECK_SOLMAN_AVAILABILITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
FLAG_BACK_DESTINATION_ONLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100506 | |||
| 2 |  Returning |
R_BACK_DESTINATION | Value transfer | Type reference (TYPE) | RFCDEST | Back-Destination | 20081118 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_WDHC_SM_NOT_AVAILABLE |
Solman nicht verfügbar | 20081119 |
Method FILE_DELETE_FROM_SOLMAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DOCUMENT_KEY | Call by reference | Type reference (TYPE) | CSEQUENCE | Dokument-Schlüssel | 20081205 | ||
| 2 | Importing |
I_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | WDHC_DOCUMENT_TYPE | Dokument-Typ | 20081205 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
Fehler im Solution Manager | 20081204 |
Method FILE_DOWNLOAD_FROM_SOLMAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
E_FILEDATA | Call by reference | Type reference (TYPE) | XSTRING | Binärdaten | 20090109 | ||
| 2 | Exporting |
E_FILENAME | Call by reference | Type reference (TYPE) | STRING | Name der Datei | 20090109 | ||
| 3 | Exporting |
E_MIMETYPE | Call by reference | Type reference (TYPE) | STRING | MIME-Type | 20090112 | ||
| 4 | Importing |
I_DOCUMENT_KEY | Call by reference | Type reference (TYPE) | CSEQUENCE | Dokument-Schlüssel | 20081205 | ||
| 5 | Importing |
I_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | WDHC_DOCUMENT_TYPE | Dokument-Typ | 20081205 | ||
| 6 | Importing |
I_LANGUAGE | Call by reference | Type reference (TYPE) | SPRAS | SY-LANGU | Sprache | 20081205 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
Fehler im Solution Manager | 20081205 |
Method FILE_UPDATE_IN_SOLMAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_PHIO_LANGUAGE | Call by reference | Type reference (TYPE) | SY-LANGU | Sprache des neu angelegten PHIOs | 20081203 | ||
| 2 | Importing |
I_DOCUMENT_KEY | Call by reference | Type reference (TYPE) | CSEQUENCE | Dokument-Schlüssel | 20081205 | ||
| 3 | Importing |
I_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | WDHC_DOCUMENT_TYPE | Dokument-Typ | 20081205 | ||
| 4 | Importing |
I_FILEDATA | Call by reference | Type reference (TYPE) | XSTRING | Inhalt der Datei | 20081203 | ||
| 5 | Importing |
I_FILENAME | Call by reference | Type reference (TYPE) | STRING | Dateiname | 20081203 | ||
| 6 | Importing |
I_LANGUAGE | Call by reference | Type reference (TYPE) | SPRAS | SY-LANGU | Sprache | 20081203 | |
| 7 | Importing |
I_MIMETYPE | Call by reference | Type reference (TYPE) | W3CONTTYPE | HTML-Content-Type | 20081203 | ||
| 8 | Importing |
I_TITLE | Call by reference | Type reference (TYPE) | TEXT60 | Titel | 20081203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
20081203 |
Method FILE_UPLOAD_TO_SOLMAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_FILEDATA | Call by reference | Type reference (TYPE) | XSTRING | Binärdaten | 20081203 | ||
| 2 | Importing |
I_FILENAME | Call by reference | Type reference (TYPE) | STRING | Dateiname | 20081203 | ||
| 3 | Importing |
I_KEYWORDS | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_KEYWORD_ID | Help Center für ABAP Webdynpro: Solution Manager Keyword ID | 20081203 | ||
| 4 | Importing |
I_LANGUAGE | Call by reference | Type reference (TYPE) | SPRAS | SY-LANGU | Sprachenschlüssel | 20081203 | |
| 5 | Importing |
I_MIMETYPE | Call by reference | Type reference (TYPE) | W3CONTTYPE | HTML-Content-Type | 20081203 | ||
| 6 | Importing |
I_RESPONSIBLE | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | Benutzername | 20081203 | |
| 7 | Importing |
I_TECHNAME | Call by reference | Type reference (TYPE) | IW_TECNAME | Technischer Name | 20081203 | ||
| 8 | Importing |
I_TITLE | Call by reference | Type reference (TYPE) | TEXT60 | Textfeld der Länge 60 | 20081203 | ||
| 9 | Returning |
RT_SOLMAN_DOCS | Value transfer | Type reference (TYPE) | SAPHC_SM_OBJ_TT | Solution Manager Dokumente | 20081203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
20081203 |
Method GET_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DOCUMENT_KEY | Call by reference | Type reference (TYPE) | CSEQUENCE | Dokument-Schlüssel | 20081117 | ||
| 2 | Importing |
I_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | WDHC_DOCUMENT_TYPE | Dokument-Typ | 20081117 | ||
| 3 | Importing |
I_LANGUAGE | Call by reference | Type reference (TYPE) | SY-LANGU | SY-LANGU | Sprache | 20090209 | |
| 4 | Returning |
R_URL | Value transfer | Type reference (TYPE) | STRING | Dokument-URL | 20081124 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
20081128 |
Method INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_APPL_NAME | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_NAME | Objektname im Objektkatalog | 20081118 | ||
| 2 | Importing |
I_APPL_NAME_EXTD | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_NAME_EXTD | Namenserweiterung z..B. Kofigurations-Id bei WD ABAP) | 20081118 | ||
| 3 | Importing |
I_APPL_SUBNAME1 | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_SUBNAME1 | Objektname im Objektkatalog | 20081118 | ||
| 4 | Importing |
I_APPL_SUBNAME2 | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_SUBNAME2 | 30 Characters | 20081118 | ||
| 5 | Importing |
I_APPL_TYPE | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_TYPE | Objekttyp | 20081118 | ||
| 6 | Importing |
I_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | SY-LANGU | Sprachenschlüssel der aktuellen Textumgebung | 20081118 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_NOT_AVAILABLE |
Solman nicht verfügbar | 20081120 |
Method SEARCH_FOR_CR_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CREATED_AT | Call by reference | Type reference (TYPE) | DATS | Erstellungszeitpunkt der ersten Version | 20081208 | ||
| 2 | Importing |
I_CREATED_BY | Call by reference | Type reference (TYPE) | IW_CREABY1 | Ersteller der ersten Version | 20081208 | ||
| 3 | Importing |
I_DESCRIPTION | Call by reference | Type reference (TYPE) | SDOK_TITEL | Titel | 20081208 | ||
| 4 | Importing |
I_KEYWORDS | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_KEYWORD_ID | Klassifizierung für Solution Architect Dokumente | 20081208 | ||
| 5 | Importing |
I_LAST_CHANGED_AT | Call by reference | Type reference (TYPE) | DATS | Änderungszeitpunkt (UTC) | 20081208 | ||
| 6 | Importing |
I_LAST_CHANGED_BY | Call by reference | Type reference (TYPE) | SDOK_CHUSR | Letzter Änderer | 20081208 | ||
| 7 | Importing |
I_RESPONSIBLE | Call by reference | Type reference (TYPE) | IW_RESPNSB | Verantwortlicher | 20081208 | ||
| 8 | Importing |
I_SEARCHTERM | Call by reference | Type reference (TYPE) | CHAR128 | Volltext Suchbegriffe | 20081208 | ||
| 9 | Importing |
I_TECHNAME | Call by reference | Type reference (TYPE) | IW_TECNAME | Technischer Name | 20081208 | ||
| 10 | Returning |
RT_SM_OBJECTS | Value transfer | Type reference (TYPE) | SAPHC_SM_OBJ_TT | Gefundene Infoobjekte | 20081208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
20081208 |
Method SEARCH_FOR_IO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_APPL_NAME | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_NAME | Name der Anwendung | 20081124 | ||
| 2 | Importing |
I_APPL_TYPE | Call by reference | Type reference (TYPE) | SAPGUIHC_LINKS-APPL_TYPE | Typ der Anwendung | 20081124 | ||
| 3 | Importing |
I_CREATED_AT | Call by reference | Type reference (TYPE) | DATS | Erstellungszeitpunkt der ersten Version | 20081124 | ||
| 4 | Importing |
I_CREATED_BY | Call by reference | Type reference (TYPE) | IW_CREABY1 | Ersteller der ersten Version | 20081124 | ||
| 5 | Importing |
I_DESCRIPTION | Call by reference | Type reference (TYPE) | SDOK_TITEL | Titel | 20081124 | ||
| 6 | Importing |
I_DOCU_TYPE | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_DOCUTYPE_ID | Dokumentationsart | 20081124 | ||
| 7 | Importing |
I_KEYWORDS | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_KEYWORD_ID | Klassifizierung für Solution Architect Dokumente | 20081124 | ||
| 8 | Importing |
I_LAST_CHANGED_AT | Call by reference | Type reference (TYPE) | DATS | Änderungszeitpunkt (UTC) | 20081124 | ||
| 9 | Importing |
I_LAST_CHANGED_BY | Call by reference | Type reference (TYPE) | SDOK_CHUSR | Letzter Änderer | 20081124 | ||
| 10 | Importing |
I_ONLY_FOR_THIS_SYSTEM | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Dokumente nur für dieses System suchen | 20081125 | |
| 11 | Importing |
I_PROJECT | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_PROJECT_ID | Projekt | 20081124 | ||
| 12 | Importing |
I_RESPONSIBLE | Call by reference | Type reference (TYPE) | IW_RESPNSB | Verantwortlicher | 20081124 | ||
| 13 | Importing |
I_SEARCHTERM | Call by reference | Type reference (TYPE) | CHAR128 | Volltext Suchbegriffe | 20081124 | ||
| 14 | Importing |
I_SOLUTION | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_SOLUTION_ID | Lösung | 20081124 | ||
| 15 | Importing |
I_STATE | Call by reference | Type reference (TYPE) | IW_STATUS | Status | 20081124 | ||
| 16 | Importing |
I_TECHNAME | Call by reference | Type reference (TYPE) | IW_TECNAME | Technischer Name | 20081124 | ||
| 17 | Returning |
RT_SM_OBJECTS | Value transfer | Type reference (TYPE) | SAPHC_SM_OBJ_TT | Gefundene Infoobjekte | 20081124 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
20081128 |
Method SEARCH_FOR_LM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CREATED_BY | Call by reference | Type reference (TYPE) | SYUNAME | Ersteller | 20081113 | ||
| 2 | Importing |
I_CREATED_ON_DAY_OR_AFTER | Call by reference | Type reference (TYPE) | DATS | Erstellung nach diesem Datum | 20081113 | ||
| 3 | Importing |
I_LANGUAGE | Call by reference | Type reference (TYPE) | SYLANGU | Sprache | 20100426 | ||
| 4 | Importing |
I_PROJECT | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_PROJECT_ID | Projekt | 20081113 | ||
| 5 | Importing |
I_SOLUTION | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_SOLUTION_ID | Lösung | 20081113 | ||
| 6 | Importing |
I_TITLE | Call by reference | Type reference (TYPE) | WDHC_SOLMAN_LM_DESCRIPTION | Titel | 20081113 | ||
| 7 | Returning |
RT_SM_OBJECTS | Value transfer | Type reference (TYPE) | SAPHC_SM_OBJ_TT | Solution Manager Objekte mit Attributen | 20081124 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
20081128 |
Method UPDATE_LINKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_ERROR_MSG | Call by reference | Type reference (TYPE) | IWERRORMSG | IWB: Übergabestruktur für Nachrichten | 20081208 | ||
| 2 | Exporting |
E_SAPGUIHC_DOCS | Call by reference | Type reference (TYPE) | SAPGUIHC_DOC_TT | Help Center: "Wissenswertes" | 20081208 | ||
| 3 | Importing |
I_CATEGORY | Call by reference | Type reference (TYPE) | WDHC_CATEGORY | Help Center: Kategorie | 20081209 | ||
| 4 | Importing |
I_SOLMAN_DOCS | Call by reference | Type reference (TYPE) | SAPHC_SM_OBJ_TT | Übergabestruktur Dokumente aus Solution Manager | 20081208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_WDHC_SM_ERROR |
Fehler im Solution Manager | 20081210 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |
