EmployeeFamilyMember

Definition

The Employee Family/Related Person (international)

business object contains details about family members and/or additional persons related to an employee.

Use

Information about the family members and related persons is stored in the Family/Related Person
infotype (0021) in Personnel Administration.

Several family members and related persons can be assigned to an employee.

Structure

The Employee Family/Related Person (DE) business object contains
several relationship types. The different types are represented in the individual subtypes of the Family/Related Person
infotype (0021). The following subtypes are delivered in the standard system:

Integration

This business object is inherited from the Employee Family/Related Person (abstract)
(FAMILYINT) business object.

Available Methods

• Approve : Unlock family [ BAPI_FAMILY_APPROVE ]
  
• Change : Change family [ BAPI_FAMILY_CHANGE ]
  
• Create : Create family [ BAPI_FAMILY_CREATE ]
  
• Createsuccessor : Create subsequent family record [ BAPI_FAMILY_CREATESUCCESSOR ]
  
• Delete : Delete family [ BAPI_FAMILY_DELETE ]
  
• Delimit : Delimit family validity period [ BAPI_FAMILY_DELIMIT ]
  
• Getdetail : Display family [ BAPI_FAMILY_GETDETAIL ]
  
• Getdetailedlist : Read instances with data [ BAPI_FAMILY_GETDETAILEDLIST ]
  
• Getlist : Read instances [ BAPI_FAMILY_GETLIST ]
  
• Request : Create locked family record [ BAPI_FAMILY_REQUEST ]
  
• Simulatecreation : Simulation: Create family [ BAPI_FAMILY_SIMULATECREATION ]
  

Approve

You can use this method to unlock a Family/Related Person record (0021).

It enables you to implement the "double verification principle" inconjunction with the REQUEST method. According to this principle, atleast two users must take part in writing an active record to the
database. One user creates a locked record using the REQUEST method.The other user unlocks or 'activates' this record using the APPROVE method.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

For more information on the REQUEST method, read the documentation on the function module BAPI_FAMILY_REQUEST.

Change

You can use this method to change a Family/Related Person record (0021).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Create

You can use this method to create a Family/Related Person record (0021).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Createsuccessor

You can use this method to create a subsequent Family/Related Person record (0021).

Example:

An employee's husband has just received his Ph.D. A Family/ Related Person record (0021) already exists for the period from 01/01/1990 to 12/31/1999.

You can use the CREATESUCCESSOR method to create a subsequent Family/Related Person record. The subsequent record contains the data of the previous record, only the husband's new title still has tobe entered in the Title field.

The previous record is delimited on the start date of the subsequent record.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Delete

You can use this method to delete a Family/Related Person record (0021).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Delimit

You can use this method to chronologically delimit a data record for the Family/related person infotype (0021).

Notes

Messages are returned in the RETURN parameter. The return codes and their meanings are found in this parameter documentation.

The key fields used by this method are described under the parameters.

This method can only be used if the ENQUEUE method of the EMPLOYEE business object has been called up first. For more information about the ENQUEUE method, see the documentation of the
BAPI_EMPLOYEE_ENQUEUE function module.

Getdetail

You can use this method to read a Family/Related Person record (0021).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

Getdetailedlist

Using this method, the data records of the Family/Related Personinfotype (0021) that come within the given time interval can be read.

Notes

Messages are returned to the RETURN parameter. In this parameterdocumentation you will find the return values and their definitions.

The key fields used in the method are described in the parameter.

Getlist

You can use this method to read the keys (instances) of Family/ Related Person records (0021) which are within the specified time interval.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

Request

You can use this method to create a locked Family/Related Person record (0021).

It enables you to implement the "double verification principle" inconjunction with the APPROVE method. According to this principle, atleast two users must take part in writing an active record to the
database. One user creates a locked record using the REQUEST method.The other user unlocks or 'activates' this record using the APPROVE method.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

For more information on the APPROVE method, read the documentation on the function module BAPI_FAMILY_APPROVE.

Simulatecreation

You can use this method to simulate creation of a Family/Related Person record (0021).

During the simulation all necessary consistency checks are performed, but the record is not written to the database.

Notes

Messages are transferred to the RETURN parameter. The relevant
parameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.