Input and Output Parameters for BAPI

This section describes the parameters required to configure the BAPIs used for aggregation filtering and to fetch additional attributes.

BAPI for Aggregation Filters

This section describes the input and output of the aggregation filter BAPI.

Input of the Aggregation Filter BAPI

The input of this BAPI must be a structure.

The name of the structure is AGGREGATION_FILTER.

This structure must have the components listed below. The connector provides the input values for the BAPI input structure, and they are based on the values specified in the source.

This aggregation is based on the various statuses of the employee.

Possible values:

  • ACTIVE

  • FUTURE

  • INACTIVE

  • RETIREE

  • WITHDRAWN

Note

  • If the Aggregate Inactive Employees on the Aggregation Settings page is not disabled, then the EMPLOYEE_STATUS value is set as ACTIVE and FUTURE.

  • If the Aggregate Inactive Employees on the Aggregation Settings page is enabled, then the EMPLOYEE_STATUS value is set as ACTIVE, FUTURE, INACTIVE, RETIREE, and WITHDRAWN.

Indicates the number of past days to aggregate inactive (INACTIVE, RETIREE, and WITHDRAWN) employees. The inactive offset value is referred to from the terminationOffset attribute and is effective only if the Aggregate Inactive Employees is enabled.

The following table gives an example of this offset:

Value from configuration

Description

Value passed on to BAPI

0

No Inactive employees are aggregated.

0

Positive Value

The number of days past from when the inactive employees must be aggregated.

For example, 30

No input provided (BLANK)

Aggregation of all the employees based on status:

  • INACTIVE

  • RETIREE

  • WITHDRAWN

-1

Indicates the number of days to aggregate the future hires. The future offset values are referred to from the attribute Future Dated Hires Offset.

The following table gives an example of this offset:

Value from configuration

Description

Value passed on to BAPI

0

No future hires are aggregated.

0

Positive Value

Aggregates future hires within the specified number of days.

For example, 30

No input provided (BLANK)

Aggregates all future hires until 9999-12-31

-1

Note
With every EMPLOYEE_STATUS, offset values will be passed as specified in the configuration attributes.

The values for AGGREGATION_MODE can be FULL or DELTA.

Note
By default, AGGREGATION_MODE is FULL. If the Delta Aggregation checkbox is selected on the Source UI, the mode is DELTA.

Output of the Aggregation Filter BAPI

The output of this value must be in the form of a JCOTable.

A JCOTable is an interface that describes internal tables used in the parameter lists of function modules. It is a data container, which can have multiple rows of the same fields.

The table name is AGGREGATION_FILTERED_LIST. The Output table must be a structure as described in the following figure:

The table must have the following components:

  • PERNR

  • BEGDA

  • ENDDA

  • STAT2

For example:

PERNR

BEGDA

ENDDA

STAT2

00000001

20170505

99991231

3

00000002

2017050‘6

99991231

2

00000003

20170508

20181231

1

Note

  • PERNR - Personnel Number, BEGDA - Beginning Date, ENDDA - End Date, STAT2 - Employment Status

  • The SAP-HR connector expects only one PERNR for one employee. If multiple person IDs are returned, the connector creates two separate identities for the person IDs as the default native identity is Employee Number.

Return Table

BAPIs used for aggregation filtering and fetching additional attributes must return an additional JCOTable.

  • Table Name: RETURN

  • The table must have the following components:

    • TYPE: Possible values are as follows:

      • S (success)

      • E (error)

      • W (warning)

  • MESSAGE

Custom BAPI for Additional Attributes

You must write the code based on your requirement for the Custom BAPI, and the SAP HR Source invokes that code accordingly. The Custom BAPI input and output parameters must be based on the guidelines as specified in this section.

Note
This is the second custom BAPI for additional attributes. The first custom BAPI is for aggregation filters.

Prerequisite

All the additional attributes returned from the Custom BAPI must be added to the schema manually.

Input of the BAPI to Fetching Additional Attributes

The input of this BAPI must be a structure.

The name of the structure is EMPLOYEE_DETAILS.

This structure must have the PERNR field.

Output of the BAPI to Fetch Additional Attributes

The output for the custom BAPI should be a JCOTable with a name of ADDITIONAL_ATTRIBUTE_LIST.

Note

  • All attributes returned by the BAPI are treated as additional attributes. The attributes returned from the custom BAPI must be manually added to the schema to manage them.

  • The connector processes all returned additional attributes as single-valued. It does not support multiple values for additional attributes.

  • If the attribute names returned by the ADDITIONAL_ATTRIBUTE_LIST match those in the default schema, the default values are overwritten by the values returned from the custom BAPI.

The table must have all the additional attributes based on your requirements.

Example:

MANAGER

REGION

LAST_DAY_WORK

GLOBAL_ID

John

Pune

2018-5-1

11111

In this example, MANAGER, REGION, LAST_DAY_WORK, and GLOBAL_ID are additional attributes.