Home SAP Development ABAP Coding SAP Fiori SAP Training SAP Tables SAP Objects...

SAP BAPI_FAMILYTH_REQUEST Function Module for Family TH: Create locked record

Table Field Attributes
Data Element Attributes
Domain Attributes
SAP Tables
Best ABAP Books

BAPI_FAMILYTH_REQUEST is a standard bapi familyth request SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Family TH: Create locked record 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 bapi familyth request FM, simply by entering the name BAPI_FAMILYTH_REQUEST into the relevant SAP transaction such as SE37 or SE38.

Function Group: PFAM_TH
Program Name: SAPLPFAM_TH
Main Program:
Appliation area: P
Release date: 01-Feb-2000
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function BAPI_FAMILYTH_REQUEST 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 'BAPI_FAMILYTH_REQUEST'"Family TH: Create locked record
  EXPORTING
   INEMPLOYEENUMBER =  "Personnel Number
*  GENDER =  "Gender key
*  DATEOFBIRTH =  "Date of birth
*  BIRTHPLACE =  "Birthplace
*  COUNTRYOFBIRTH =  "Country of birth
*  NATIONALITY =  "Nationality
*  SECONDNATIONALITY =  "Second nationality
*  THIRDNATIONALITY =  "Third nationality
*  PHONENUMBER =  "Telephone number
*  ADDRESSNUMBERSOITROK =  "Address Number, Soi Trok (TH)
*  STREETTHAMBOL =  "Street/Road, Tambol
   INVALIDITYBEGIN =  "Start date
*  CITY =  "Province/City (TH)
*  DISTRICT =  "District (TH)
*  POSTALCODE =  "Postal code
*  COUNTRY =  "Country key
*  COMMUNICATIONTYPE01 =  "Communication type
*  COMMUNICATIONNUMBER01 =  "Communications number
*  COMMUNICATIONTYPE02 =  "Communication type
*  COMMUNICATIONNUMBER02 =  "Communications number
*  COMMUNICATIONTYPE03 =  "Communication type
*  COMMUNICATIONNUMBER03 =  "Communications number
   INVALIDITYEND =  "End Date
*  COMMUNICATIONTYPE04 =  "Communication type
*  COMMUNICATIONNUMBER04 =  "Communications number
*  ALIVEDECEASED =  "Alive/Deceased
*  JOBTITLE =  "Job title
*  EMPLOYEROFFAMILYMEMBER =  "Employer of Family Member (TH)
*  NOCOMMIT =  "COMMIT control at BAPI interface
*  MEMBERTYPE =  "Type of family record
*  FIRSTNAME =  "First name
*  LASTNAME =  "Last name
*  FORMOFADDRESS =  "Form-of-address key
*  OTHERTITLE =  "Other Title
*  CHILDNUMBER =  "Object identification

 IMPORTING
   RETURN =  "Return messages
   EMPLOYEENUMBER =  "Personnel Number
   SUBTYPE =  "Subtype
   OBJECTID =  "Object identification
   LOCKINDICATOR =  "Lock indicator for HR master record
   VALIDITYBEGIN =  "Start date
   VALIDITYEND =  "End Date
   RECORDNUMBER =  "Number of infotype record

IMPORTING Parameters details for BAPI_FAMILYTH_REQUEST

INEMPLOYEENUMBER - Personnel Number

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

GENDER - Gender key

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

DATEOFBIRTH - Date of birth

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

BIRTHPLACE - Birthplace

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

COUNTRYOFBIRTH - Country of birth

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

NATIONALITY - Nationality

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

SECONDNATIONALITY - Second nationality

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

THIRDNATIONALITY - Third nationality

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

PHONENUMBER - Telephone number

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

ADDRESSNUMBERSOITROK - Address Number, Soi Trok (TH)

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

STREETTHAMBOL - Street/Road, Tambol

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

INVALIDITYBEGIN - Start date

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

CITY - Province/City (TH)

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

DISTRICT - District (TH)

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

POSTALCODE - Postal code

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

COUNTRY - Country key

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

COMMUNICATIONTYPE01 - Communication type

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

COMMUNICATIONNUMBER01 - Communications number

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

COMMUNICATIONTYPE02 - Communication type

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

COMMUNICATIONNUMBER02 - Communications number

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

COMMUNICATIONTYPE03 - Communication type

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

COMMUNICATIONNUMBER03 - Communications number

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

INVALIDITYEND - End Date

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

COMMUNICATIONTYPE04 - Communication type

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

COMMUNICATIONNUMBER04 - Communications number

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

ALIVEDECEASED - Alive/Deceased

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

JOBTITLE - Job title

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

EMPLOYEROFFAMILYMEMBER - Employer of Family Member (TH)

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

NOCOMMIT - COMMIT control at BAPI interface

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

MEMBERTYPE - Type of family record

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

FIRSTNAME - First name

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

LASTNAME - Last name

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

FORMOFADDRESS - Form-of-address key

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

OTHERTITLE - Other Title

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

CHILDNUMBER - Object identification

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

EXPORTING Parameters details for BAPI_FAMILYTH_REQUEST

RETURN - Return messages

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

EMPLOYEENUMBER - Personnel Number

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

SUBTYPE - Subtype

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

OBJECTID - Object identification

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

LOCKINDICATOR - Lock indicator for HR master record

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

VALIDITYBEGIN - Start date

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

VALIDITYEND - End Date

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

RECORDNUMBER - Number of infotype record

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

Copy and paste ABAP code example for BAPI_FAMILYTH_REQUEST 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_return	TYPE BAPIRETURN1, "
	lv_inemployeenumber	TYPE BAPIP0021-PERNR, "
	lv_gender	TYPE BAPIP0021-FASEX, "
	lv_dateofbirth	TYPE BAPIP0021-FGBDT, "
	lv_birthplace	TYPE BAPIP0021-FGBOT, "
	lv_countryofbirth	TYPE BAPIP0021-FGBLD, "
	lv_nationality	TYPE BAPIP0021-FANAT, "
	lv_secondnationality	TYPE BAPIP0021-FANA2, "
	lv_thirdnationality	TYPE BAPIP0021-FANA3, "
	lv_phonenumber	TYPE BAPIP0021TH-PHONENUMBER, "
	lv_addressnumbersoitrok	TYPE BAPIP0021TH-ADDRESSNUMBERSOITROK, "
	lv_streetthambol	TYPE BAPIP0021TH-STREETTHAMBOL, "
	lv_employeenumber	TYPE BAPIP0021-PERNR, "
	lv_invaliditybegin	TYPE BAPIP0021-BEGDA, "
	lv_city	TYPE BAPIP0021TH-CITY, "
	lv_district	TYPE BAPIP0021TH-DISTRICT, "
	lv_postalcode	TYPE BAPIP0021TH-POSTALCODE, "
	lv_country	TYPE BAPIP0021TH-COUNTRY, "
	lv_communicationtype01	TYPE BAPIP0021TH-COMMUNICATIONTYPE01, "
	lv_communicationnumber01	TYPE BAPIP0021TH-COMMUNICATIONNUMBER01, "
	lv_communicationtype02	TYPE BAPIP0021TH-COMMUNICATIONTYPE02, "
	lv_communicationnumber02	TYPE BAPIP0021TH-COMMUNICATIONNUMBER02, "
	lv_communicationtype03	TYPE BAPIP0021TH-COMMUNICATIONTYPE03, "
	lv_communicationnumber03	TYPE BAPIP0021TH-COMMUNICATIONNUMBER03, "
	lv_subtype	TYPE BAPIP0021-SUBTY, "
	lv_invalidityend	TYPE BAPIP0021-ENDDA, "
	lv_communicationtype04	TYPE BAPIP0021TH-COMMUNICATIONTYPE04, "
	lv_communicationnumber04	TYPE BAPIP0021TH-COMMUNICATIONNUMBER04, "
	lv_alivedeceased	TYPE BAPIP0021TH-ALIVEDECEASED, "
	lv_jobtitle	TYPE BAPIP0021TH-JOBTITLE, "
	lv_employeroffamilymember	TYPE BAPIP0021TH-EMPLOYEROFFAMILYMEMBER, "
	lv_nocommit	TYPE BAPI_STAND-NO_COMMIT, "
	lv_objectid	TYPE BAPIP0021-OBJPS, "
	lv_membertype	TYPE BAPIP0021-FAMSA, "
	lv_firstname	TYPE BAPIP0021-FAVOR, "
	lv_lockindicator	TYPE BAPIP0021-SPRPS, "
	lv_lastname	TYPE BAPIP0021-FANAM, "
	lv_validitybegin	TYPE BAPIP0021-BEGDA, "
	lv_validityend	TYPE BAPIP0021-ENDDA, "
	lv_formofaddress	TYPE BAPIP0021TH-FORMOFADDRESS, "
	lv_othertitle	TYPE BAPIP0021-FNMZU, "
	lv_recordnumber	TYPE BAPIP0021-SEQNR, "
	lv_childnumber	TYPE BAPIP0021TH-CHILDNUMBER. "

CALL FUNCTION 'BAPI_FAMILYTH_REQUEST' "Family TH: Create locked record

EXPORTING
	INEMPLOYEENUMBER	= lv_inemployeenumber
	GENDER	= lv_gender
	DATEOFBIRTH	= lv_dateofbirth
	BIRTHPLACE	= lv_birthplace
	COUNTRYOFBIRTH	= lv_countryofbirth
	NATIONALITY	= lv_nationality
	SECONDNATIONALITY	= lv_secondnationality
	THIRDNATIONALITY	= lv_thirdnationality
	PHONENUMBER	= lv_phonenumber
	ADDRESSNUMBERSOITROK	= lv_addressnumbersoitrok
	STREETTHAMBOL	= lv_streetthambol
	INVALIDITYBEGIN	= lv_invaliditybegin
	CITY	= lv_city
	DISTRICT	= lv_district
	POSTALCODE	= lv_postalcode
	COUNTRY	= lv_country
	COMMUNICATIONTYPE01	= lv_communicationtype01
	COMMUNICATIONNUMBER01	= lv_communicationnumber01
	COMMUNICATIONTYPE02	= lv_communicationtype02
	COMMUNICATIONNUMBER02	= lv_communicationnumber02
	COMMUNICATIONTYPE03	= lv_communicationtype03
	COMMUNICATIONNUMBER03	= lv_communicationnumber03
	INVALIDITYEND	= lv_invalidityend
	COMMUNICATIONTYPE04	= lv_communicationtype04
	COMMUNICATIONNUMBER04	= lv_communicationnumber04
	ALIVEDECEASED	= lv_alivedeceased
	JOBTITLE	= lv_jobtitle
	EMPLOYEROFFAMILYMEMBER	= lv_employeroffamilymember
	NOCOMMIT	= lv_nocommit
	MEMBERTYPE	= lv_membertype
	FIRSTNAME	= lv_firstname
	LASTNAME	= lv_lastname
	FORMOFADDRESS	= lv_formofaddress
	OTHERTITLE	= lv_othertitle
	CHILDNUMBER	= lv_childnumber
IMPORTING
	RETURN	= lv_return
	EMPLOYEENUMBER	= lv_employeenumber
	SUBTYPE	= lv_subtype
	OBJECTID	= lv_objectid
	LOCKINDICATOR	= lv_lockindicator
	VALIDITYBEGIN	= lv_validitybegin
	VALIDITYEND	= lv_validityend
	RECORDNUMBER	= lv_recordnumber
. " BAPI_FAMILYTH_REQUEST

ABAP code using 7.40 inline data declarations to call FM BAPI_FAMILYTH_REQUEST

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 PERNR FROM BAPIP0021 INTO @DATA(ld_inemployeenumber).

		"SELECT single FASEX FROM BAPIP0021 INTO @DATA(ld_gender).

		"SELECT single FGBDT FROM BAPIP0021 INTO @DATA(ld_dateofbirth).

		"SELECT single FGBOT FROM BAPIP0021 INTO @DATA(ld_birthplace).

		"SELECT single FGBLD FROM BAPIP0021 INTO @DATA(ld_countryofbirth).

		"SELECT single FANAT FROM BAPIP0021 INTO @DATA(ld_nationality).

		"SELECT single FANA2 FROM BAPIP0021 INTO @DATA(ld_secondnationality).

		"SELECT single FANA3 FROM BAPIP0021 INTO @DATA(ld_thirdnationality).

		"SELECT single PHONENUMBER FROM BAPIP0021TH INTO @DATA(ld_phonenumber).

		"SELECT single ADDRESSNUMBERSOITROK FROM BAPIP0021TH INTO @DATA(ld_addressnumbersoitrok).

		"SELECT single STREETTHAMBOL FROM BAPIP0021TH INTO @DATA(ld_streetthambol).

		"SELECT single PERNR FROM BAPIP0021 INTO @DATA(ld_employeenumber).

		"SELECT single BEGDA FROM BAPIP0021 INTO @DATA(ld_invaliditybegin).

		"SELECT single CITY FROM BAPIP0021TH INTO @DATA(ld_city).

		"SELECT single DISTRICT FROM BAPIP0021TH INTO @DATA(ld_district).

		"SELECT single POSTALCODE FROM BAPIP0021TH INTO @DATA(ld_postalcode).

		"SELECT single COUNTRY FROM BAPIP0021TH INTO @DATA(ld_country).

		"SELECT single COMMUNICATIONTYPE01 FROM BAPIP0021TH INTO @DATA(ld_communicationtype01).

		"SELECT single COMMUNICATIONNUMBER01 FROM BAPIP0021TH INTO @DATA(ld_communicationnumber01).

		"SELECT single COMMUNICATIONTYPE02 FROM BAPIP0021TH INTO @DATA(ld_communicationtype02).

		"SELECT single COMMUNICATIONNUMBER02 FROM BAPIP0021TH INTO @DATA(ld_communicationnumber02).

		"SELECT single COMMUNICATIONTYPE03 FROM BAPIP0021TH INTO @DATA(ld_communicationtype03).

		"SELECT single COMMUNICATIONNUMBER03 FROM BAPIP0021TH INTO @DATA(ld_communicationnumber03).

		"SELECT single SUBTY FROM BAPIP0021 INTO @DATA(ld_subtype).

		"SELECT single ENDDA FROM BAPIP0021 INTO @DATA(ld_invalidityend).

		"SELECT single COMMUNICATIONTYPE04 FROM BAPIP0021TH INTO @DATA(ld_communicationtype04).

		"SELECT single COMMUNICATIONNUMBER04 FROM BAPIP0021TH INTO @DATA(ld_communicationnumber04).

		"SELECT single ALIVEDECEASED FROM BAPIP0021TH INTO @DATA(ld_alivedeceased).

		"SELECT single JOBTITLE FROM BAPIP0021TH INTO @DATA(ld_jobtitle).

		"SELECT single EMPLOYEROFFAMILYMEMBER FROM BAPIP0021TH INTO @DATA(ld_employeroffamilymember).

		"SELECT single NO_COMMIT FROM BAPI_STAND INTO @DATA(ld_nocommit).

		"SELECT single OBJPS FROM BAPIP0021 INTO @DATA(ld_objectid).

		"SELECT single FAMSA FROM BAPIP0021 INTO @DATA(ld_membertype).

		"SELECT single FAVOR FROM BAPIP0021 INTO @DATA(ld_firstname).

		"SELECT single SPRPS FROM BAPIP0021 INTO @DATA(ld_lockindicator).

		"SELECT single FANAM FROM BAPIP0021 INTO @DATA(ld_lastname).

		"SELECT single BEGDA FROM BAPIP0021 INTO @DATA(ld_validitybegin).

		"SELECT single ENDDA FROM BAPIP0021 INTO @DATA(ld_validityend).

		"SELECT single FORMOFADDRESS FROM BAPIP0021TH INTO @DATA(ld_formofaddress).

		"SELECT single FNMZU FROM BAPIP0021 INTO @DATA(ld_othertitle).

		"SELECT single SEQNR FROM BAPIP0021 INTO @DATA(ld_recordnumber).

		"SELECT single CHILDNUMBER FROM BAPIP0021TH INTO @DATA(ld_childnumber).

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!