SAP OIRE_READ_DTF Function Module for PC: Read the DTF transaction









OIRE_READ_DTF is a standard oire read dtf SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for PC: Read the DTF transaction processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for oire read dtf FM, simply by entering the name OIRE_READ_DTF into the relevant SAP transaction such as SE37 or SE38.

Function Group: OIRE_PC_DTF
Program Name: SAPLOIRE_PC_DTF
Main Program: SAPLOIRE_PC_DTF
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function OIRE_READ_DTF pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'OIRE_READ_DTF'"PC: Read the DTF transaction
  EXPORTING
   I_ACCESS =  "Access method
*  I_DOCYEAR =  "Fiscal year
*  I_DOCTYPE =  "Document type
*  I_CHOBJ =  "Clearing house
*  I_GET_FIDOC =  "Get also the FI documents
*  I_LOCKIND =  "Locking indicator
*  I_PROC =  "Processed/Unprocessed indicator structure
*  I_FILL_T_LINK =  "Indicator to fill T_LINK
*  I_MAXHITS =  "Number of maximum hits
*  I_WITH_AUTH =  "Flag for  authorisation filtering
*  P_READDB = 'X' "Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')
   I_BUKRS =  "Company Code
*  P_READAR =  "Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')
*  P_READAS =  "Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')
*  I_DUMM = 'E' "'Dummy' Indicator
*  I_COMPINDICATOR =  "PC transactions with a complaint flag
*  I_COMPRES =  "Complaint result
*  I_SETTLNR =  "Settlement run number
*  I_SETTLDAT =  "Settlement run date
*  I_TRNSMNR =  "SSR PC: Transmission number
*  I_DOCNR =  "Processed/Invoiced to SSP

TABLES
   TI_PBLNR =  "Business Location
*  TI_NUMBERS =  "Number of selected records
*  TI_SRCID =  "Data source indicator
*  TI_LINKNR =  "DTLT link number range table
*  TI_LINK =  "Link between DTF table and UPLNR
*  TI_DTLT_RESULT =  "DTLT link number range table
   TI_DTF_HDR =  "DTF Header
   TI_DTF_ITM =  "DTF Item
*  TI_SETTLNR =  "Settlement number table
*  TI_SETTLDAT =  "Settlement date ranges table type
*  TI_TRANSNR =  "Transmission number table
   TI_SSR_CCINS =  "Payment Card Type
*  TI_LINKNRYR =  "Link number and link year
*  TI_RECON_NO =  "Reference structure for reconciliation number ranges
*  TI_RECON_DAT =  "Reference structure for upload number (UPLNR)  ranges
*  TI_CHOBJ =  "Reference structure for CH object ranges
*  TI_STFLG =  "Statistical update flag ranges table type
*  TI_DOCNR =  "Reference structure for document number range
*  S_FILES =  "Ranges table for ARKEY (S_FILES)
   TI_VKDAT =  "Sales Date
*  TI_UPLDAT =  "Upload date
*  TI_WAERS =  "Currency
*  TI_TERMNR =  "Receipt number at the business location
*  TI_MATNR =  "SAP material number
*  TI_CCNUM =  "Payment card numbers
*  TI_VAL_ROUTINE =  "Validation status of the PC transactions

EXCEPTIONS
   INVALID_ACCESS_METHOD = 1    WRONG_VALIDATION_STATUS = 2    CLEARING_HOUSE_DOES_NOT_EXIST = 3    COMPANY_CODE_DOES_NOT_EXIST = 4    INVALID_DOCUMENT_TYPE = 5    INVALID_COMPLAINT_FLAG = 6    INVALID_LOCK_INDICATOR = 7    INVALID_COMPRES = 8    INVALID_DUMMY_INDICATOR = 9
.



IMPORTING Parameters details for OIRE_READ_DTF

I_ACCESS - Access method

Data type: ROIREDTF-ACCESS_DTF
Optional: No
Call by Reference: No ( called with pass by value option)

I_DOCYEAR - Fiscal year

Data type: BKPF-GJAHR
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_DOCTYPE - Document type

Data type: OIRADTLT-DOCTYPE
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_CHOBJ - Clearing house

Data type: OIREUPLKXXXX-CHOBJ
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_GET_FIDOC - Get also the FI documents

Data type: C
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_LOCKIND - Locking indicator

Data type: C
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_PROC - Processed/Unprocessed indicator structure

Data type: OIRE1_PROC
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_FILL_T_LINK - Indicator to fill T_LINK

Data type: C
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_MAXHITS - Number of maximum hits

Data type: SY-DBCNT
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_WITH_AUTH - Flag for authorisation filtering

Data type: C
Optional: Yes
Call by Reference: No ( called with pass by value option)

P_READDB - Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')

Data type: BOOLE_D
Default: 'X'
Optional: Yes
Call by Reference: Yes

I_BUKRS - Company Code

Data type: ROIREDTF-BUKRS
Optional: No
Call by Reference: No ( called with pass by value option)

P_READAR - Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')

Data type: BOOLE_D
Optional: Yes
Call by Reference: Yes

P_READAS - Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')

Data type: BOOLE_D
Optional: Yes
Call by Reference: Yes

I_DUMM - 'Dummy' Indicator

Data type: C
Default: 'E'
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_COMPINDICATOR - PC transactions with a complaint flag

Data type: OIREUPLKXXXX-COMPFL
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_COMPRES - Complaint result

Data type: OIREUPLKXXXX-COMPRES
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_SETTLNR - Settlement run number

Data type: OIREUPLKXXXX-SETTLNR
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_SETTLDAT - Settlement run date

Data type: OIREUPLKXXXX-SETTLDAT
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_TRNSMNR - SSR PC: Transmission number

Data type: OIREUPLKXXXX-TRNSMNR
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_DOCNR - Processed/Invoiced to SSP

Data type: OIREUPLKXXXX-UPLNR
Optional: Yes
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for OIRE_READ_DTF

TI_PBLNR - Business Location

Data type: OIRE_PBLNR_RANGE_TT
Optional: No
Call by Reference: Yes

TI_NUMBERS - Number of selected records

Data type: OIRE_RESULT_NUMBERS_TT
Optional: Yes
Call by Reference: Yes

TI_SRCID - Data source indicator

Data type: OIRE_SRCID_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_LINKNR - DTLT link number range table

Data type: OIRE_LINKNR_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_LINK - Link between DTF table and UPLNR

Data type: OIRE1_T_LINK
Optional: Yes
Call by Reference: No ( called with pass by value option)

TI_DTLT_RESULT - DTLT link number range table

Data type: OIRA3_T_DTLT_RESULT
Optional: Yes
Call by Reference: No ( called with pass by value option)

TI_DTF_HDR - DTF Header

Data type: OIREUPLKXXXX
Optional: No
Call by Reference: No ( called with pass by value option)

TI_DTF_ITM - DTF Item

Data type: OIREUPLPXXXX
Optional: No
Call by Reference: No ( called with pass by value option)

TI_SETTLNR - Settlement number table

Data type: OIRE_SETTLNR_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_SETTLDAT - Settlement date ranges table type

Data type: OIRE_SETTLDAT_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_TRANSNR - Transmission number table

Data type: OIRE_TRANSNR_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_SSR_CCINS - Payment Card Type

Data type: OIRE_CCINS_RANGE_TT
Optional: No
Call by Reference: Yes

TI_LINKNRYR - Link number and link year

Data type: OIRE1_T_LINKNRYR
Optional: Yes
Call by Reference: No ( called with pass by value option)

TI_RECON_NO - Reference structure for reconciliation number ranges

Data type: ROIRE_RECON_NO_RANGE
Optional: Yes
Call by Reference: Yes

TI_RECON_DAT - Reference structure for upload number (UPLNR) ranges

Data type: ROIRE_RECON_DAT_RANGE
Optional: Yes
Call by Reference: Yes

TI_CHOBJ - Reference structure for CH object ranges

Data type: ROIRE_CHOBJ_RANGE
Optional: Yes
Call by Reference: Yes

TI_STFLG - Statistical update flag ranges table type

Data type: OIRE_STFLG_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_DOCNR - Reference structure for document number range

Data type: OIRA_DOCNR_RANGES_TT
Optional: Yes
Call by Reference: Yes

S_FILES - Ranges table for ARKEY (S_FILES)

Data type: S_FILES
Optional: Yes
Call by Reference: Yes

TI_VKDAT - Sales Date

Data type: OIRE_VKDAT_RANGE_TT
Optional: No
Call by Reference: Yes

TI_UPLDAT - Upload date

Data type: OIRE_UPLDAT_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_WAERS - Currency

Data type: OIRE_WAERS_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_TERMNR - Receipt number at the business location

Data type: OIRE_TERMNR_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_MATNR - SAP material number

Data type: OIRE_MATNR_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_CCNUM - Payment card numbers

Data type: OIRE_CCNUM_RANGE_TT
Optional: Yes
Call by Reference: Yes

TI_VAL_ROUTINE - Validation status of the PC transactions

Data type: OIRE_VAL_ROUTINE_RANGE_TT
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

INVALID_ACCESS_METHOD - Invalid access method

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

WRONG_VALIDATION_STATUS - Entered validation status is wrong.

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

CLEARING_HOUSE_DOES_NOT_EXIST - Clearing house does not exist

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

COMPANY_CODE_DOES_NOT_EXIST - Company code does not exist

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

INVALID_DOCUMENT_TYPE - Entered document type is invalid

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

INVALID_COMPLAINT_FLAG - Entered complaint flag is invalid

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

INVALID_LOCK_INDICATOR - Entered locking indicator is invalid

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

INVALID_COMPRES - Entered complaint result is invalid

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

INVALID_DUMMY_INDICATOR - Entered 'dummy' indicator is invalid

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for OIRE_READ_DTF Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_i_access  TYPE ROIREDTF-ACCESS_DTF, "   
lt_ti_pblnr  TYPE STANDARD TABLE OF OIRE_PBLNR_RANGE_TT, "   
lv_invalid_access_method  TYPE OIRE_PBLNR_RANGE_TT, "   
lv_i_docyear  TYPE BKPF-GJAHR, "   
lt_ti_numbers  TYPE STANDARD TABLE OF OIRE_RESULT_NUMBERS_TT, "   
lt_ti_srcid  TYPE STANDARD TABLE OF OIRE_SRCID_RANGE_TT, "   
lv_i_doctype  TYPE OIRADTLT-DOCTYPE, "   
lv_i_chobj  TYPE OIREUPLKXXXX-CHOBJ, "   
lt_ti_linknr  TYPE STANDARD TABLE OF OIRE_LINKNR_RANGE_TT, "   
lt_ti_link  TYPE STANDARD TABLE OF OIRE1_T_LINK, "   
lv_i_get_fidoc  TYPE C, "   
lv_i_lockind  TYPE C, "   
lt_ti_dtlt_result  TYPE STANDARD TABLE OF OIRA3_T_DTLT_RESULT, "   
lv_i_proc  TYPE OIRE1_PROC, "   
lt_ti_dtf_hdr  TYPE STANDARD TABLE OF OIREUPLKXXXX, "   
lt_ti_dtf_itm  TYPE STANDARD TABLE OF OIREUPLPXXXX, "   
lv_i_fill_t_link  TYPE C, "   
lv_i_maxhits  TYPE SY-DBCNT, "   
lt_ti_settlnr  TYPE STANDARD TABLE OF OIRE_SETTLNR_RANGE_TT, "   
lv_i_with_auth  TYPE C, "   
lt_ti_settldat  TYPE STANDARD TABLE OF OIRE_SETTLDAT_RANGE_TT, "   
lv_p_readdb  TYPE BOOLE_D, "   'X'
lt_ti_transnr  TYPE STANDARD TABLE OF OIRE_TRANSNR_RANGE_TT, "   
lv_i_bukrs  TYPE ROIREDTF-BUKRS, "   
lt_ti_ssr_ccins  TYPE STANDARD TABLE OF OIRE_CCINS_RANGE_TT, "   
lv_wrong_validation_status  TYPE OIRE_CCINS_RANGE_TT, "   
lv_p_readar  TYPE BOOLE_D, "   
lt_ti_linknryr  TYPE STANDARD TABLE OF OIRE1_T_LINKNRYR, "   
lv_p_readas  TYPE BOOLE_D, "   
lt_ti_recon_no  TYPE STANDARD TABLE OF ROIRE_RECON_NO_RANGE, "   
lt_ti_recon_dat  TYPE STANDARD TABLE OF ROIRE_RECON_DAT_RANGE, "   
lt_ti_chobj  TYPE STANDARD TABLE OF ROIRE_CHOBJ_RANGE, "   
lt_ti_stflg  TYPE STANDARD TABLE OF OIRE_STFLG_RANGE_TT, "   
lt_ti_docnr  TYPE STANDARD TABLE OF OIRA_DOCNR_RANGES_TT, "   
lt_s_files  TYPE STANDARD TABLE OF S_FILES, "   
lv_i_dumm  TYPE C, "   'E'
lt_ti_vkdat  TYPE STANDARD TABLE OF OIRE_VKDAT_RANGE_TT, "   
lv_clearing_house_does_not_exist  TYPE OIRE_VKDAT_RANGE_TT, "   
lt_ti_upldat  TYPE STANDARD TABLE OF OIRE_UPLDAT_RANGE_TT, "   
lv_i_compindicator  TYPE OIREUPLKXXXX-COMPFL, "   
lv_company_code_does_not_exist  TYPE OIREUPLKXXXX, "   
lt_ti_waers  TYPE STANDARD TABLE OF OIRE_WAERS_RANGE_TT, "   
lv_i_compres  TYPE OIREUPLKXXXX-COMPRES, "   
lv_invalid_document_type  TYPE OIREUPLKXXXX, "   
lv_i_settlnr  TYPE OIREUPLKXXXX-SETTLNR, "   
lt_ti_termnr  TYPE STANDARD TABLE OF OIRE_TERMNR_RANGE_TT, "   
lv_invalid_complaint_flag  TYPE OIRE_TERMNR_RANGE_TT, "   
lt_ti_matnr  TYPE STANDARD TABLE OF OIRE_MATNR_RANGE_TT, "   
lv_i_settldat  TYPE OIREUPLKXXXX-SETTLDAT, "   
lv_invalid_lock_indicator  TYPE OIREUPLKXXXX, "   
lt_ti_ccnum  TYPE STANDARD TABLE OF OIRE_CCNUM_RANGE_TT, "   
lv_i_trnsmnr  TYPE OIREUPLKXXXX-TRNSMNR, "   
lv_invalid_compres  TYPE OIREUPLKXXXX, "   
lv_i_docnr  TYPE OIREUPLKXXXX-UPLNR, "   
lt_ti_val_routine  TYPE STANDARD TABLE OF OIRE_VAL_ROUTINE_RANGE_TT, "   
lv_invalid_dummy_indicator  TYPE OIRE_VAL_ROUTINE_RANGE_TT. "   

  CALL FUNCTION 'OIRE_READ_DTF'  "PC: Read the DTF transaction
    EXPORTING
         I_ACCESS = lv_i_access
         I_DOCYEAR = lv_i_docyear
         I_DOCTYPE = lv_i_doctype
         I_CHOBJ = lv_i_chobj
         I_GET_FIDOC = lv_i_get_fidoc
         I_LOCKIND = lv_i_lockind
         I_PROC = lv_i_proc
         I_FILL_T_LINK = lv_i_fill_t_link
         I_MAXHITS = lv_i_maxhits
         I_WITH_AUTH = lv_i_with_auth
         P_READDB = lv_p_readdb
         I_BUKRS = lv_i_bukrs
         P_READAR = lv_p_readar
         P_READAS = lv_p_readas
         I_DUMM = lv_i_dumm
         I_COMPINDICATOR = lv_i_compindicator
         I_COMPRES = lv_i_compres
         I_SETTLNR = lv_i_settlnr
         I_SETTLDAT = lv_i_settldat
         I_TRNSMNR = lv_i_trnsmnr
         I_DOCNR = lv_i_docnr
    TABLES
         TI_PBLNR = lt_ti_pblnr
         TI_NUMBERS = lt_ti_numbers
         TI_SRCID = lt_ti_srcid
         TI_LINKNR = lt_ti_linknr
         TI_LINK = lt_ti_link
         TI_DTLT_RESULT = lt_ti_dtlt_result
         TI_DTF_HDR = lt_ti_dtf_hdr
         TI_DTF_ITM = lt_ti_dtf_itm
         TI_SETTLNR = lt_ti_settlnr
         TI_SETTLDAT = lt_ti_settldat
         TI_TRANSNR = lt_ti_transnr
         TI_SSR_CCINS = lt_ti_ssr_ccins
         TI_LINKNRYR = lt_ti_linknryr
         TI_RECON_NO = lt_ti_recon_no
         TI_RECON_DAT = lt_ti_recon_dat
         TI_CHOBJ = lt_ti_chobj
         TI_STFLG = lt_ti_stflg
         TI_DOCNR = lt_ti_docnr
         S_FILES = lt_s_files
         TI_VKDAT = lt_ti_vkdat
         TI_UPLDAT = lt_ti_upldat
         TI_WAERS = lt_ti_waers
         TI_TERMNR = lt_ti_termnr
         TI_MATNR = lt_ti_matnr
         TI_CCNUM = lt_ti_ccnum
         TI_VAL_ROUTINE = lt_ti_val_routine
    EXCEPTIONS
        INVALID_ACCESS_METHOD = 1
        WRONG_VALIDATION_STATUS = 2
        CLEARING_HOUSE_DOES_NOT_EXIST = 3
        COMPANY_CODE_DOES_NOT_EXIST = 4
        INVALID_DOCUMENT_TYPE = 5
        INVALID_COMPLAINT_FLAG = 6
        INVALID_LOCK_INDICATOR = 7
        INVALID_COMPRES = 8
        INVALID_DUMMY_INDICATOR = 9
. " OIRE_READ_DTF




ABAP code using 7.40 inline data declarations to call FM OIRE_READ_DTF

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

"SELECT single ACCESS_DTF FROM ROIREDTF INTO @DATA(ld_i_access).
 
 
 
"SELECT single GJAHR FROM BKPF INTO @DATA(ld_i_docyear).
 
 
 
"SELECT single DOCTYPE FROM OIRADTLT INTO @DATA(ld_i_doctype).
 
"SELECT single CHOBJ FROM OIREUPLKXXXX INTO @DATA(ld_i_chobj).
 
 
 
 
 
 
 
 
 
 
"SELECT single DBCNT FROM SY INTO @DATA(ld_i_maxhits).
 
 
 
 
DATA(ld_p_readdb) = 'X'.
 
 
"SELECT single BUKRS FROM ROIREDTF INTO @DATA(ld_i_bukrs).
 
 
 
 
 
 
 
 
 
 
 
 
DATA(ld_i_dumm) = 'E'.
 
 
 
 
"SELECT single COMPFL FROM OIREUPLKXXXX INTO @DATA(ld_i_compindicator).
 
 
 
"SELECT single COMPRES FROM OIREUPLKXXXX INTO @DATA(ld_i_compres).
 
 
"SELECT single SETTLNR FROM OIREUPLKXXXX INTO @DATA(ld_i_settlnr).
 
 
 
 
"SELECT single SETTLDAT FROM OIREUPLKXXXX INTO @DATA(ld_i_settldat).
 
 
 
"SELECT single TRNSMNR FROM OIREUPLKXXXX INTO @DATA(ld_i_trnsmnr).
 
 
"SELECT single UPLNR FROM OIREUPLKXXXX INTO @DATA(ld_i_docnr).
 
 
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!