SAP BICS_CONS_GET_WORKSTATUS Function Module for Get the current workstatus and new workstatus

Search SAP Function Modules

BICS_CONS_GET_WORKSTATUS is a standard bics cons get workstatus SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Get the current workstatus and new workstatus 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 bics cons get workstatus FM, simply by entering the name BICS_CONS_GET_WORKSTATUS into the relevant SAP transaction such as SE37 or SE38.

Function Group: RSBOLAP_BICS_CONSUMER
Program Name: SAPLRSBOLAP_BICS_CONSUMER
Main Program: SAPLRSBOLAP_BICS_CONSUMER
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled + BasXML supported
Update:

Function BICS_CONS_GET_WORKSTATUS 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 'BICS_CONS_GET_WORKSTATUS'"Get the current workstatus and new workstatus
  EXPORTING
   I_APPLICATION_HANDLE =  "Unique Object Handle for External Communication
   I_DATA_AREA =  "Data Area Context Within an Application
   I_T_WS_CONTEXT_GET =  "Table type for BICS_CONS_WS_T_CONTEXT
   I_T_HIER_INFOS =  "Table type for BICS_CONS_WS_HIER_INFO
   I_INCLUDE_CHILDREN =  "show the aggregate status for a node
   I_READ_WITH_LOCK =  "Boolean

 IMPORTING
   E_T_STATUS_INFO =  "Dimension Tuple + Status Info
   E_NO_WS_CONFIGURATION =  "No workspace configuration found
   E_MISSING_DIMENSION =  "Missing Dimension in provided context
   E_WRONG_HIER_INFO =  "Wrong Hierarchy information provided
   E_ERROR_GET_STATUS =  "Error calling the get status API

TABLES
*  E_T_MESSAGE =  "Message Texts

.

IMPORTING Parameters details for BICS_CONS_GET_WORKSTATUS

I_APPLICATION_HANDLE - Unique Object Handle for External Communication

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

I_DATA_AREA - Data Area Context Within an Application

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

I_T_WS_CONTEXT_GET - Table type for BICS_CONS_WS_T_CONTEXT

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

I_T_HIER_INFOS - Table type for BICS_CONS_WS_HIER_INFO

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

I_INCLUDE_CHILDREN - show the aggregate status for a node

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

I_READ_WITH_LOCK - Boolean

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

EXPORTING Parameters details for BICS_CONS_GET_WORKSTATUS

E_T_STATUS_INFO - Dimension Tuple + Status Info

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

E_NO_WS_CONFIGURATION - No workspace configuration found

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

E_MISSING_DIMENSION - Missing Dimension in provided context

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

E_WRONG_HIER_INFO - Wrong Hierarchy information provided

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

E_ERROR_GET_STATUS - Error calling the get status API

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

TABLES Parameters details for BICS_CONS_GET_WORKSTATUS

E_T_MESSAGE - Message Texts

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

Copy and paste ABAP code example for BICS_CONS_GET_WORKSTATUS 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.

ABAP code using 7.40 inline data declarations to call FM BICS_CONS_GET_WORKSTATUS

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.

Search for further information about these or an SAP related objects