SAP ABAP Class CL_HRPAYFR_FILE_UTILITIES (Utilities class for French payroll)
Hierarchy
☛
SAP_HRCFR (Software Component) Sub component SAP_HRCFR of SAP_HR
⤷
PY-FR (Application Component) France
⤷
PC06 (Package) HR Payroll: France
⤷
⤷
Properties
| Class | CL_HRPAYFR_FILE_UTILITIES | |
| Short Description | Utilities class for French payroll | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | PC06 | HR Payroll: France |
| Created | 20120425 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_HRPAYFR_FILE_UTILITIES has no interface implemented.
Friends
Class CL_HRPAYFR_FILE_UTILITIES has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Protected | Object reference (TYPE REF TO) | CL_HR99S00_DAQ | 20120611 | ||||
| 2 | Static Attribute | Protected | Object reference (TYPE REF TO) | CL_HR99S00_TEMSE | 20120611 | ||||
| 3 | Static Attribute | Protected | Object reference (TYPE REF TO) | CL_XML_DOCUMENT | XML Document for WF- WEB Activity | 20120611 | |||
| 4 | Static Attribute | Protected | Object reference (TYPE REF TO) | DATA | 20120611 | ||||
| 5 | Static Attribute | Protected | Type reference (TYPE) | PFRDS_T_SECTN_ADD_INFO | DAQ section additional info | 20120611 | |||
| 6 | Static Attribute | Protected | Type reference (TYPE) | HR99S_TAB_T5F99FD | Table type for T5F99SE | 20120611 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Create temse file | 20120611 | |
| 2 | Static method | Public | Method | Create .xml file | 20120611 | |
| 3 | Static method | Public | Method | Get "standard" structure related to a section | 20120611 | |
| 4 | Static method | Public | Method | Display a .pdf file | 20120611 | |
| 5 | Static method | Public | Method | Display temse file or xml data | 20120816 | |
| 6 | Static method | Public | Method | Search help to select a given file | 20120611 | |
| 7 | Static method | Protected | Method | Set field value from the .xml into target structure | 20120611 | |
| 8 | Static method | Public | Method | Filter CRA based on a declaration number | 20120816 | |
| 9 | Static method | Public | Method | Get file name | 20120615 | |
| 10 | Static method | Protected | Method | Handle section change | 20120611 | |
| 11 | Static method | Protected | Method | Handle section change (temse file upload) | 20120611 | |
| 12 | Static method | Protected | Method | Handle table type attribute | 20120611 | |
| 13 | Static method | Public | Method | Set excluded DAQ section | 20120816 | |
| 14 | Static method | Public | Method | Set file name for message | 20120611 | |
| 15 | Static method | Public | Method | Upload .pdf files | 20120611 | |
| 16 | Static method | Public | Method | Upload an .xml file into SAP memory based on a DAQ form | 20120611 | |
| 17 | Static method | Public | Method | Upload an .xml file into SAP memory based on a DAQ form | 20120611 |
Events
Class CL_HRPAYFR_FILE_UTILITIES has no event.
Types
Class CL_HRPAYFR_FILE_UTILITIES has no local type.
Method Signatures
Method CREATE_TEMSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_TEMSE | Call by reference | Object reference (TYPE REF TO) | CL_HR99S00_TEMSE | 20120611 | ||||
| 2 | IO_DAQ | Call by reference | Object reference (TYPE REF TO) | CL_HR99S00_DAQ | 20120611 | ||||
| 3 | IS_FILE_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | File data for which a temse file has to created | 20120611 | |||
| 4 | IT_TEMSE_DATA | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20120611 | ||||
| 5 | IV_TYPE | Call by reference | Type reference (TYPE) | ANY | 20120611 |
Method CREATE_TEMSE on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method CREATE_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_DAQ | Call by reference | Object reference (TYPE REF TO) | CL_HR99S00_DAQ | 20120611 | ||||
| 2 | IO_TEMSE | Call by reference | Object reference (TYPE REF TO) | CL_HR99S00_TEMSE | 20120611 | ||||
| 3 | IT_TEMSE_DATA | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20120611 | ||||
| 4 | IV_TYPE | Call by reference | Type reference (TYPE) | ANY | 20120611 |
Method CREATE_XML on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method DAQ_GET_SECTN_STRUCT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_KEEP_SOURCE | Call by reference | Type reference (TYPE) | XFELD | Keep source data? | 20120611 | |||
| 2 | EV_STRUCT_NAME | Call by reference | Type reference (TYPE) | ANY | Structure name | 20120611 | |||
| 3 | IS_SECTN | Call by reference | Type reference (TYPE) | P99SD_SECTN | 20120611 | ||||
| 4 | IV_GET_ALL | Call by reference | Type reference (TYPE) | XFELD | 'X' | Checkbox | 20120611 |
Method DAQ_GET_SECTN_STRUCT on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method DISPLAY_PDF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_MSG | Call by reference | Type reference (TYPE) | SYMSG | Message variable structure | 20120611 | |||
| 2 | IV_PATH | Call by reference | Type reference (TYPE) | ANY | Indication of logical access path to file | 20120611 |
Method DISPLAY_PDF on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method DISPLAY_TEMSE_OR_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_APPL | Call by reference | Type reference (TYPE) | P_APPL | Subapplication | 20120816 | |||
| 2 | IV_DEORD | Call by reference | Type reference (TYPE) | P06_DEORD | Declaration sequence number | 20120816 | |||
| 3 | IV_MOLGA | Call by reference | Type reference (TYPE) | MOLGA | '06' | Country group | 20120816 | ||
| 4 | IV_TEMSE | Call by reference | Type reference (TYPE) | P_TS_TSOBJ | HR TemSE Object | 20120816 | |||
| 5 | IV_UCOMM | Call by reference | Type reference (TYPE) | SYUCOMM | TV: Temse Viewer | 20120816 |
Method DISPLAY_TEMSE_OR_XML on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method F4_GET_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_FILENAME | Call by reference | Type reference (TYPE) | ANY | 20120611 |
Method F4_GET_FILE on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method FIELD_SET_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_DATA | Call by reference | Type reference (TYPE) | ANY | Target structure | 20120611 | |||
| 2 | ES_FIELD_FOUND | Call by reference | Type reference (TYPE) | XFELD | Field found | 20120611 | |||
| 3 | IS_SECTN | Call by reference | Type reference (TYPE) | P99SD_SECTN | Section data | 20120611 | |||
| 4 | IV_NODE | Call by reference | Object reference (TYPE REF TO) | IF_IXML_NODE | In-process node | 20120611 |
Method FIELD_SET_VALUE on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method FILTER_CRA_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_DATA | Call by reference | Type reference (TYPE) | ANY | 20120816 | ||||
| 2 | IV_DEORD | Call by reference | Type reference (TYPE) | P06_DEORD | Declaration sequence number | 20120816 |
Method FILTER_CRA_DATA on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method GET_FILE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_MSG | Call by reference | Type reference (TYPE) | SYMSG | Message variable structure | 20120615 | |||
| 2 | EV_FULLPATH | Call by reference | Type reference (TYPE) | ANY | 20120615 | ||||
| 3 | EV_IS_OK | Call by reference | Type reference (TYPE) | XFELD | File name recovery ok? | 20120615 | |||
| 4 | IV_ACTIVITY | Call by reference | Type reference (TYPE) | TEXT10 | 'WRITE' | Activity code | 20120615 | ||
| 5 | IV_LFILE | Call by reference | Type reference (TYPE) | FILEINTERN | Logical file name | 20120615 | |||
| 6 | IV_PARAM1 | Call by reference | Type reference (TYPE) | ANY | 20120615 | ||||
| 7 | IV_PARAM2 | Call by reference | Type reference (TYPE) | ANY | 20120615 | ||||
| 8 | IV_PARAM3 | Call by reference | Type reference (TYPE) | ANY | 20120615 | ||||
| 9 | IV_WITH_FE | Call by reference | Type reference (TYPE) | XFELD | ABAP_FALSE | With file extension? | 20120615 |
Method GET_FILE_NAME on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method HANDLE_SECTION_CHANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_DATA | Call by reference | Type reference (TYPE) | ANY | Data related to the in-process section | 20120611 | |||
| 2 | CS_DATA_FILE | Call by reference | Type reference (TYPE) | ANY | Whole data file | 20120611 | |||
| 3 | CS_FILE_SUBNODE | Call by reference | Type reference (TYPE) | PFRDS_FILE_SUBNODE | Information about subnodes (up to 3 levels) | 20120611 | |||
| 4 | CT_SECTN_TMP | Call by reference | Type reference (TYPE) | P99SD_TAB_SECTN | 20120611 | ||||
| 5 | IS_EOF | Call by reference | Type reference (TYPE) | XFELD | End of file reached? | 20120611 | |||
| 6 | IS_SECTN | Call by reference | Type reference (TYPE) | P99SD_SECTN | Current section data | 20120611 | |||
| 7 | IS_SECTN_REF | Call by reference | Type reference (TYPE) | P99SD_SECTN | Ref. section data | 20120611 |
Method HANDLE_SECTION_CHANGE on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method HANDLE_SECTION_CHANGE_TEMSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_FILE_DATA | Call by reference | Type reference (TYPE) | ANY | Information about subnodes (up to 3 levels) | 20120611 | |||
| 2 | CS_FILE_SUBNODE | Call by reference | Type reference (TYPE) | PFRDS_FILE_SUBNODE | Information about subnodes (up to 3 levels) | 20120611 | |||
| 3 | IS_EOF | Call by reference | Type reference (TYPE) | XFELD | End of file reached? | 20120611 | |||
| 4 | IS_SECTN | Call by reference | Type reference (TYPE) | P99SD_SECTN | Current section data | 20120611 |
Method HANDLE_SECTION_CHANGE_TEMSE on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method HANDLE_TABLE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_DATA_TEMSE | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20120611 | ||||
| 2 | CT_SECTN_EXCL | Call by reference | Type reference (TYPE) | STANDARD TABLE | Sub-sections to be excluded | 20120611 | |||
| 3 | ES_SECTN_NEXT | Call by reference | Type reference (TYPE) | P99SD_SECTN | 20120611 | ||||
| 4 | IS_DATA_SOURCE | Call by reference | Type reference (TYPE) | ANY | 20120611 | ||||
| 5 | IS_SECTN | Call by reference | Type reference (TYPE) | P99SD_SECTN | Section data | 20120611 |
Method HANDLE_TABLE_TYPE on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method SET_EXCL_SECTN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ER_EXCL_SECTN | Call by reference | Type reference (TYPE) | STANDARD TABLE | Range in which are stored DAQ sections to be excluded | 20120816 | |||
| 2 | IV_APPL | Call by reference | Type reference (TYPE) | P_APPL | 'CRA' | Subapplication | 20120816 |
Method SET_EXCL_SECTN on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method SET_FILENAME_FOR_MSG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_FILENAME | Call by reference | Type reference (TYPE) | ANY | 20120611 |
Method SET_FILENAME_FOR_MSG on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method UPLOAD_PDF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_MSG | Call by reference | Type reference (TYPE) | HRPADFR_SYMSG | Table de messages d'erreur | 20120611 | |||
| 2 | CT_STATUS_SH | Call by reference | Type reference (TYPE) | HR99S_B2AID_TAB | SH status per employee/declaration | 20120611 | |||
| 3 | EV_IS_OK | Call by reference | Type reference (TYPE) | XFELD | Upload ok? | 20120611 | |||
| 4 | IV_DIR_PATH | Call by reference | Type reference (TYPE) | LOCALFILE | Directory location | 20120611 | |||
| 5 | IV_DOCTY | Call by reference | Type reference (TYPE) | PC_B2A_DOCTY | HR-B2A: Document type | 20121015 | |||
| 6 | IV_FILES_ONLY | Call by reference | Type reference (TYPE) | XFELD | Only file recovery? | 20120611 | |||
| 7 | IV_FILTER | Call by reference | Type reference (TYPE) | STRING | '*.pdf' | Extension (filter) | 20120615 | ||
| 8 | IV_LFILE | Call by reference | Type reference (TYPE) | FILEINTERN | Logical file name | 20120615 | |||
| 9 | IV_STATS | Call by reference | Type reference (TYPE) | P_99S_STATS | SubGro | 20120615 |
Method UPLOAD_PDF on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method UPLOAD_TEMSE_WITH_DAQ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_FILE_DATA | Call by reference | Type reference (TYPE) | ANY | 20120611 | ||||
| 2 | IO_DAQ | Call by reference | Object reference (TYPE REF TO) | CL_HR99S00_DAQ | 20120611 | ||||
| 3 | IR_EXCL_SECTN | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20120611 | ||||
| 4 | IV_APPL | Call by reference | Type reference (TYPE) | P_APPL | Subapplication | 20120611 | |||
| 5 | IV_DATE | Call by reference | Type reference (TYPE) | DATUM | SY-DATUM | Date | 20120611 | ||
| 6 | IV_MOLGA | Call by reference | Type reference (TYPE) | MOLGA | Country group | 20120611 | |||
| 7 | IV_NAME | Call by reference | Type reference (TYPE) | P_TS_TSOBJ | HR TemSE Object | 20120611 | |||
| 8 | IV_TREE_SECTN | Call by reference | Type reference (TYPE) | XFELD | ABAP_TRUE | Checkbox | 20120611 |
Method UPLOAD_TEMSE_WITH_DAQ on class CL_HRPAYFR_FILE_UTILITIES has no exception.
Method UPLOAD_XML_WITH_DAQ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_FILE_DATA | Call by reference | Type reference (TYPE) | ANY | File data uploaded into SAP memory | 20120611 | |||
| 2 | ES_MSG | Call by reference | Type reference (TYPE) | SYMSG | Message variable structure | 20120611 | |||
| 3 | EV_RETURNCODE | Call by reference | Type reference (TYPE) | SY-SUBRC | Return code | 20120611 | |||
| 4 | IO_DAQ | Call by reference | Object reference (TYPE REF TO) | CL_HR99S00_DAQ | 20120611 | ||||
| 5 | IR_EXCL_SECTN | Call by reference | Type reference (TYPE) | STANDARD TABLE | 20120611 | ||||
| 6 | IV_APPL | Call by reference | Type reference (TYPE) | P_APPL | DAQ form | 20120611 | |||
| 7 | IV_DATE | Call by reference | Type reference (TYPE) | DATUM | SY-DATUM | Date | 20120611 | ||
| 8 | IV_FILENAME | Call by reference | Type reference (TYPE) | LOCALFILE | Name of the .xml file to be uploaded | 20120611 | |||
| 9 | IV_MOLGA | Call by reference | Type reference (TYPE) | MOLGA | Country grouping | 20120611 | |||
| 10 | IV_TREE_SECTN | Call by reference | Type reference (TYPE) | XFELD | Checkbox | 20120611 |
Method UPLOAD_XML_WITH_DAQ on class CL_HRPAYFR_FILE_UTILITIES has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |