SAP ABAP Class CL_ARC_ADMIN_UTIL (Utilities for Archive Administration)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-ADK (Application Component) Archive Development Kit
⤷
SARC (Package) Archive Development Kit
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-CCM-ADK (Application Component) Archive Development Kit⤷
SARC (Package) Archive Development KitProperties
| Class | CL_ARC_ADMIN_UTIL | |
| Short Description | Utilities for Archive Administration | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SARC | Archive Development Kit |
| Created | 20090901 | SAP |
| Last change | 20140121 | 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 | ADK |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 3 | TYBTC |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_ARC_ADMIN_UTIL has no interface implemented.
Friends
Class CL_ARC_ADMIN_UTIL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ACTION_LOCKED |
Constant | Public | Type reference (TYPE) | STRING | 'JOB RUNNING' | 20130307 | ||
| 2 | GC_FILE_INDX_INDEX_CREATED |
Constant | Public | Type reference (TYPE) | ADMI_STIDX | '1' | 20130307 | ||
| 3 | GC_FILE_INDX_INDEX_DELETED |
Constant | Public | Type reference (TYPE) | ADMI_STIDX | '2' | 20130307 | ||
| 4 | GC_FILE_INDX_NO_INDEX_EXISTS |
Constant | Public | Type reference (TYPE) | ADMI_STIDX | '0' | 20130307 | ||
| 5 | GC_FILE_PROC_ABORTED |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '4' | 20130307 | ||
| 6 | GC_FILE_PROC_CONVERTED |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '6' | 20130307 | ||
| 7 | GC_FILE_PROC_COPIED |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '7' | 20130307 | ||
| 8 | GC_FILE_PROC_DELETED |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '3' | 20130307 | ||
| 9 | GC_FILE_PROC_DELETING |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '1' | 20130307 | ||
| 10 | GC_FILE_PROC_RELOADED |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '5' | 20130307 | ||
| 11 | GC_FILE_PROC_WRITING |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '0' | 20130307 | ||
| 12 | GC_FILE_PROC_WRITTEN |
Constant | Public | Type reference (TYPE) | ADMI_STFIL | '2' | 20130307 | ||
| 13 | GC_FILE_STRG_NOT_STORED |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '0' | 20130307 | ||
| 14 | GC_FILE_STRG_RETRIEVE_ERROR |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '5' | 20130307 | ||
| 15 | GC_FILE_STRG_RETRIEVE_RUNNING |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '4' | 20130307 | ||
| 16 | GC_FILE_STRG_STORAGE_ERROR |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '3' | 20130307 | ||
| 17 | GC_FILE_STRG_STORAGE_INCOMPLTE |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '6' | 20130307 | ||
| 18 | GC_FILE_STRG_STORAGE_RUNNING |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '1' | 20130307 | ||
| 19 | GC_FILE_STRG_STORED |
Constant | Public | Type reference (TYPE) | ADMI_STOPT | '2' | 20130307 | ||
| 20 | GC_JOB_CON |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'CON' | 20130307 | ||
| 21 | GC_JOB_DEL |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'DEL' | 20130307 | ||
| 22 | GC_JOB_END |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'END' | 20130307 | ||
| 23 | GC_JOB_FIN |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'FIN' | 20130307 | ||
| 24 | GC_JOB_IDX |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'IDX' | 20130307 | ||
| 25 | GC_JOB_PRE |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'PRE' | 20130307 | ||
| 26 | GC_JOB_REA |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'REA' | 20130307 | ||
| 27 | GC_JOB_REL |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'REL' | 20130307 | ||
| 28 | GC_JOB_RET |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'RET' | 20130307 | ||
| 29 | GC_JOB_STO |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'STO' | 20130307 | ||
| 30 | GC_JOB_SUB |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'SUB' | 20130307 | ||
| 31 | GC_JOB_WRC |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'WRC' | 20130307 | ||
| 32 | GC_JOB_WRI |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'WRI' | 20130307 | ||
| 33 | GC_JOB_WRP |
Constant | Public | Type reference (TYPE) | ADMI_JOB_T | 'WRP' | 20130307 | ||
| 34 | GC_SESS_ABORTED |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '2' | 20130307 | ||
| 35 | GC_SESS_BEING_RELOADED |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '5' | 20130307 | ||
| 36 | GC_SESS_CONVERTED |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '4' | 20130307 | ||
| 37 | GC_SESS_CREATED_BY_RELOADING |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '6' | 20130307 | ||
| 38 | GC_SESS_FILES_EXIST |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '1' | 20130307 | ||
| 39 | GC_SESS_NO_FILE_EXISTS |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '0' | 20130307 | ||
| 40 | GC_SESS_RELOADED |
Constant | Public | Type reference (TYPE) | ADMI_STRUN | '3' | 20130307 | ||
| 41 | GC_USER_SAP |
Constant | Public | Type reference (TYPE) | XMILOGEUSR | 'SAP' | 20130307 | ||
| 42 | HEADING_RUN_ABORTED |
Constant | Public | See coding | '0' | 20130307 | |||
| 43 | HEADING_RUN_BEING_RELOADED |
Constant | Public | See coding | '3' | 20130307 | |||
| 44 | HEADING_RUN_COMPLETE |
Constant | Public | See coding | '2' | 20130307 | |||
| 45 | HEADING_RUN_COMPLETE_INTER |
Constant | Public | See coding | '9' | 20130307 | |||
| 46 | HEADING_RUN_COPIED |
Constant | Public | See coding | 'A' | 20130307 | |||
| 47 | HEADING_RUN_CREATED_BY_RELOAD |
Constant | Public | See coding | '4' | 20130307 | |||
| 48 | HEADING_RUN_DESTROY |
Constant | Public | See coding | 'B' | 20130307 | |||
| 49 | HEADING_RUN_ILM_CONV |
Constant | Public | See coding | 'E' | 20130307 | |||
| 50 | HEADING_RUN_ILM_CONV_SNAP |
Constant | Public | See coding | 'F' | 20130307 | |||
| 51 | HEADING_RUN_ILM_DELTA |
Constant | Public | See coding | 'C' | 20130307 | |||
| 52 | HEADING_RUN_ILM_DELTA_SNAP |
Constant | Public | See coding | 'D' | 20130307 | |||
| 53 | HEADING_RUN_INCOMPLETE |
Constant | Public | See coding | '1' | 20130307 | |||
| 54 | HEADING_RUN_INCOMPLETE_INTER |
Constant | Public | See coding | '8' | 20130307 | |||
| 55 | HEADING_RUN_NOT_VALID |
Constant | Public | See coding | '7' | 20130307 | |||
| 56 | HEADING_RUN_REPLACED |
Constant | Public | See coding | '5' | 20130307 | |||
| 57 | HEADING_RUN_TO_BE_ARCHIVED |
Constant | Public | See coding | '6' | 20130307 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CALL_ILM_BROWSER |
Static method | Public | Method | Call Up ILM Store Browser | 20100615 |
| 2 | CALL_ILM_XMLDAS_ADMIN |
Static method | Public | Method | Call Up ILM Store Browser | 20100923 |
| 3 | GET_COMMENT |
Static method | Public | Method | Get Comment from the Write Program Variant | 20130328 |
| 4 | GET_FILE |
Static method | Public | Method | 20090902 | |
| 5 | GET_HEADING |
Static method | Public | Method | Add Header | 20090901 |
| 6 | GET_HEADINGS |
Static method | Public | Method | Add Headers | 20090901 |
| 7 | GET_RUN |
Static method | Public | Method | 20090902 |
Events
Class CL_ARC_ADMIN_UTIL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_HEADING_INFO | Public | See coding | 20090901 | BEGIN OF ty_heading_info,
heading(1) TYPE c,
key TYPE lvc_nkey,
runs_left TYPE i,
key_area TYPE lvc_nkey,
area_low TYPE admi_run-document,
creation_date_low TYPE admi_run-creat_date,
relat_key TYPE lvc_nkey,
relationship TYPE i,
END OF ty_heading_info
|
||
| 2 | TY_T_HEADING_INFOS | Public | See coding | 20090901 | ty_t_heading_infos TYPE STANDARD TABLE OF ty_heading_info
|
Method Signatures
Method CALL_ILM_BROWSER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_SHOW_BROWSER_SCREEN | Call by reference | Type reference (TYPE) | BOOLE_D | ABAP_TRUE | Store Browser zeigen | 20100615 | |
| 2 |  Returning |
RV_URL | Value transfer | Type reference (TYPE) | STRING | 20100615 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_XADK |
XADK: Ausnahmen | 20100615 |
Method CALL_ILM_XMLDAS_ADMIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SHOW_BROWSER_SCREEN | Call by reference | Type reference (TYPE) | BOOLE_D | ABAP_TRUE | Store Browser zeigen | 20100923 | |
| 2 | Returning |
RV_URL | Value transfer | Type reference (TYPE) | STRING | 20100923 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XADK |
XADK: Ausnahmen | 20100923 |
Method GET_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PROGNAME | Call by reference | Type reference (TYPE) | RRGID_TR01 | Schreibprogramm | 20130328 | ||
| 2 | Importing |
IV_VARIANT | Call by reference | Type reference (TYPE) | ADMI_VARI_ | Variante, mit der das Archivierungsprogramm gestartet wurde | 20130328 | ||
| 3 | Returning |
RV_COMMENT | Value transfer | Type reference (TYPE) | ADMI_TEXT | Vermerk zum Archivierungslauf | 20130328 |
Method GET_COMMENT on class CL_ARC_ADMIN_UTIL has no exception.
Method GET_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_NODE_LAYOUT | Call by reference | Type reference (TYPE) | LVC_S_LAYN | Knotenlayout ALV-Tree Control | 20090902 | ||
| 2 | Exporting |
EV_NODE_TEXT | Call by reference | Type reference (TYPE) | LVC_VALUE | ALV-Control: Zelleninhalt | 20090902 | ||
| 3 | Importing |
IS_FILE | Call by reference | Type reference (TYPE) | ADK_ARCHIVE_FILE | 20090902 | |||
| 4 | Importing |
IV_USE_JOB_INFO | Call by reference | Type reference (TYPE) | BOOLE_D | ABAP_TRUE | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20090902 |
Method GET_FILE on class CL_ARC_ADMIN_UTIL has no exception.
Method GET_HEADING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_NODE_LAYOUT | Call by reference | Type reference (TYPE) | LVC_S_LAYN | Knotenlayout ALV-Tree Control | 20090901 | ||
| 2 | Exporting |
EV_NODE_TEXT | Call by reference | Type reference (TYPE) | LVC_VALUE | ALV-Control: Zelleninhalt | 20090901 | ||
| 3 | Importing |
IV_HEADING | Call by reference | Type reference (TYPE) | CHAR1 | Einstelliges Kennzeichen | 20090901 |
Method GET_HEADING on class CL_ARC_ADMIN_UTIL has no exception.
Method GET_HEADINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_HEADING_INFOS | Call by reference | Type reference (TYPE) | TY_T_HEADING_INFOS | 20090901 | |||
| 2 | Importing |
IT_RUNS_AND_FILES | Call by reference | Type reference (TYPE) | ADK_ARCHIVING_RUNS | 20090901 |
Method GET_HEADINGS on class CL_ARC_ADMIN_UTIL has no exception.
Method GET_RUN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_NODE_LAYOUT | Call by reference | Type reference (TYPE) | LVC_S_LAYN | Knotenlayout ALV-Tree Control | 20090902 | ||
| 2 | Exporting |
EV_NODE_TEXT | Call by reference | Type reference (TYPE) | LVC_VALUE | ALV-Control: Zelleninhalt | 20090902 | ||
| 3 | Importing |
IS_RUN | Call by reference | Type reference (TYPE) | ADK_ARCHIVING_RUN | 20090902 | |||
| 4 | Importing |
IV_USE_JOB_INFO | Call by reference | Type reference (TYPE) | BOOLE_D | ABAP_TRUE | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20090902 |
Method GET_RUN on class CL_ARC_ADMIN_UTIL has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 730 |
