Ansicht
Dokumentation
BURX_OXT_TASK_GEN_API - Task API for Classic APIS
PERFORM Short Reference Fill RESBD Structure from EBP Component StructureThis documentation is copyright by SAP AG.
Functionality
This function module is the task API for defining the classic APIs. This applies to new extensions for the application object, Business Partner Relationship (BUPR), generated through the Easy Enhancement Workbench (EEW).
In the case of BUPR for the cardinality types 1:1 and 1:N, this task API defines the following objects:
- Function group, which holds the generated APIs
- Includes
- APIs, which are of the following types:
- Get - This API retrieves the details of the extension that is valid for a specified date.
- GetList - This API reads the details of the extension for a particular time interval.
- Add - This API adds a record to the extension.
- Change - This API updates the changes made to the attributes of an extension.
- Maintain_Period - This API should be called, in the case of time dependent extensions, when you add or change the records, which results in the merging, shrinking or deletion of existing records.
- Maintain_All - This API should be called, in the case of time dependent extensions, in scenarios such as data exchange and mass update. This API should be called to perform operations such as creation, modification, deletion of records simultaneously for an extension.
- Remove - This API deletes the record in an extension that is valid for a specified date.
- MemoryInit - This API initializes the memory.
- UpdateServices - This API saves the data to the database.
- Callback - This API retrieves the data from the memory. In the BDT scenario, the API has to retrieve data from the BDT memory. Since the BDT memory is different, a new API is available in the BDT, which is called by the Callback API to retrieve data from BDT memory.
- Include structure - The Get and GetList APIs retrieve data in the format of this structure. This structure will not have the Parent Object Key fields.
- Key structure, which contains the key fields of the table excluding the Parent Object Key fields.
- Data structure, which contains all the non key fields of the table.
- DataX Structure
- Structure for data exchange, which has to be appended to the complex structure BUS_EI_EXTERN for data exchange. This structure has the following format for both 1:1 and 1:N extensions:
| Field | Description |
|---|---|
| CURRENT_STATE | Indicator for complete data |
| TIME_DEPENDENT | To determine if data is coming from time dependent or time independent system |
| XXX_DATA | Data that is coming from another system |
- The field XXX_DATA has the format XXX_TABLE_LINE structure. XXX_TABLE_LINE structure has the following format:
| Field | Description |
|---|---|
| TASK | Change Indicator Object |
| DATA_KEY | Key Field Structure |
| DATA | Search Structure |
| DATAX | Change Structure |
| CURRENTLY_VALID | Determines if data is valid today |
- Note: XXX is determined by the task API.
The Classic API task API reads the following entries of the table CT_TASKPARAMLIST:
| Parameter Name | Description |
|---|---|
| TABL | Name of the generated table |
| FIELD | Name of the field for the generated table. All fields of the table use this parameter. This parameter is the child of the TABL parameter. |
| ISKEY | Key field information of the field. This parameter is the child of the FIELD parameter. |
| DTEL | Name of the data element for the field. This parameter is the child of the FIELD parameter. |
| PARENT_KEY | Parent key information of the field. This parameter is the child of the FIELD parameter. |
| Note: The value of the parameter PARENT_KEY is marked as 'X' for parent key fields. | |
| STRUC_CHD | Details of the new structure for change document. This parameter is the child of the TABL parameter. |
| APICHECKFUNC | Name of the Check table function module. This parameter is the child of the FIELD parameter. |
| APIUPDATE | Name of the Update API. This parameter is the child of the TABL parameter. |
The task API reads the following entries of Applications Knowledge Base table (OXT_ER_KNOWLEDGE) for the time validity of the extension:
| Node1 | Node2 | Parameter Name | Description |
|---|---|---|---|
| APIGEN | DATA_ELEMENT | DATEFROM, DATETO | When a new field is added through the knowledge base, the data element of the field has to be mentioned for the generation of APIs. |
The Classic API task API updates the:
- Table CT_GOX_HEADER with the details of the objects to be generated
- Table CT_TASKPARAMLIST with the following information:
| Parameter Name | Description |
|---|---|
| FUNCTION_GROUP_API | Name of the function group containing all the APIs. This parameter is the child of the TABL parameter. |
| APIGET | Name of the Get API. This parameter is the child of the TABL parameter. |
| APIGETLIST | Name of the GetList API. This parameter is the child of the TABL parameter. |
| APIADD | Name of the Add API. This parameter is the child of the TABL parameter. |
| APICHANGE | Name of the Change API. This parameter is the child of the TABL parameter. |
| APIMAINTAIN | Name of the Maintain_Period API. This parameter is the child of the TABL parameter. |
| APIMAINTAINALL | Name of the Maintain_ALL API. This parameter is the child of the TABL parameter. |
| APIREMOVE | Name of the Remove API. This parameter is the child of the TABL parameter. |
| APIMEMINIT | Name of the Memory Init API. This parameter is the child of the TABL parameter |
| APIUPDSERVICE | Name of the Update Services API. This parameter is the child of the TABL parameter. |
| FUNC_CALLBACK | Name of the Callback API. This parameter is the child of the TABL parameter. |
| APIMEMORYGET | Name of the API in the BDT, which is called by the Callback API to retrieve data from the BDT memory. This parameter is the child of the TABL parameter. |
| STRUC | Name of the include structure. This parameter is the child of the TABL parameter. |
| STRUC_KEY | Name of the ey structure. This parameter is the child of the TABL parameter. |
| STRUC_API | Name of the data structure. This parameter is the child of the TABL parameter. |
| STRUC_UPD | Name of the dataX structure. This parameter is the child of the TABL parameter |
| STRUC_MEM | Memory structure name |
| STRUC_DX_TABLE | Name of the data table type for data exchange. This parameter is the child of the STRUC_DX parameter. |
| STRUC_DX_LINE_TYPE | Name of the data structure for data exchange. This parameter is the child of the STRUC_DX_TABLE parameter. |
Example
Notes
Further information
Parameters
CT_GOX_HEADERCT_POSTPROC
CT_TABLE_ENTRIES
CT_TASKPARAMLIST
IT_EXTENSIONDEF
IT_GOX_HEADER_OLD
IT_TAB_HEADER_OLD
IV_MODE
IV_NAMESPACE
IV_NSPCSHT_CUS
IV_NSPCSHT_DEV
T_RETURN
Exceptions
SEMANTICAL_ERRORTECHNICAL_ERROR
Function Group
BUX_OXT_TASKBAL_S_LOG - Application Log: Log header data Fill RESBD Structure from EBP Component Structure
This documentation is copyright by SAP AG.
Length: 12182 Date: 20240523 Time: 165722 sap01-206 ( 110 ms )
