Liquid UI: Convert function module structure detail to type object

[Leo Chu]

Liquid UI: Convert function module structure detail to type object

This example is to convert function module structure detail to a type object, which is required when Use call command to get native SAP function module detail.

For each function module structure, it needs specific type object for call command to reference.

   var z_STRUCTURE_NAME = {
      name:STRUCTURE_NAME,
      components:[
         { name:COMPONENT_NAME,   length:DATA_LENGTH,   decimalpl:DECIMAL_POINT_LENGTH,   type:DATA_TYPE },
         ...
      ]
   };

In type object, each component has different ABAP data type, which can be referenced from below table.

LUI Type	ABAP Type	Data Type	Description
b	'b'	INT1	Cannot be substituted with 'C'
C	'C'	CHAR, UNIT, LANG, CUKY, LCHR
D	'D'	DATS	Can be substituted with 'C'
			When used as 'D', the Component will be a JavaScript Date object,
			whereas, if specified as 'C', it will be a string returned by SAP in the format of "19941107"
F or f	'F'	FLTP	Cannot be substituted with 'C'
			For BAPI FM, specify LUI type as "F"; for FM RFC_READ_TABLE, specify LUI type as "f"
T	'T'	TIMS	Currently same as 'C' and can be substituted with 'C'
N	'N'	NUMC	Can be substituted with 'C'
P or f	'P'	QUAN, DEC, CURR	Cannot be substituted with 'C'
			For BAPI FM, specify LUI type as "P"; for FM RFC_READ_TABLE, specify LUI type as "f"
s or i	's'	INT2	Cannot be substituted with 'C'
			For BAPI FM, specify LUI type as "s"; for FM RFC_READ_TABLE, specify LUI type as "i"
I	'I'	INT, INT4	Cannot be substituted with 'C'

Step 1: Check output structure according to parameter

The structure of each output parameter needs to be specified individually.
Its detail can be referenced from SAP in transaction SE37 follow by below steps.
1.   On initial screen of SE37, enter the FM
2.   Click on "Display" button to check detail
3.   On the display screen, select "Export" or "Tables" tab according to your output
4.   In corresponding tab, find the row of output parameter and double click on it to see detail structure
5.   Stay in the structure detail screen, and prepare to create the script based on the screen

Use FM BAPI_ALM_ORDER_GET_DETAIL as an example, its ES_HEADER parameter has structure BAPI_ALM_ORDER_HEADER_E which SAP screen should shown as below.

Component	Typing Method	Component Type	Data Type	Length	Decimal Pl	Short Description
ORDERID	1	AUFNR	CHAR	12	0	Order Number
ORDER_TYPE	1	AUFART	CHAR	4	0	Order Type
PLANPLANT	1	IWERK	CHAR	4	0	Maintenance Planning Plant
BUS_AREA	1	GSBER	CHAR	4	0	Business Area
MN_WK_CTR	1	GEWRK	CHAR	8	0	Main work center for maintenance tasks
PLANT	1	WERGW	CHAR	4	0	Plant associated with main work center
MN_WKCTR_ID	1	LGWID	NUMC	8	0	Object ID of the Work Center
PMACTTYPE	1	ILA	CHAR	3	0	Maintenance activity type
PLANGROUP	1	INGRP	CHAR	3	0	Planner Group for Customer Service and Plant Maintenance
SYSTCOND	1	ANLZU	CHAR	1	0	Syst.Condition
FUNCT_LOC	1	TPLNR	CHAR	30	0	Functional Location
EQUIPMENT	1	EQUNR	CHAR	18	0	Equipment Number
SERIALNO	1	GERNR	CHAR	18	0	Serial Number
MATERIAL	1	MATNR	CHAR	18	0	Material Number
ASSEMBLY	1	BAUTL	CHAR	18	0	Assembly
DEVICEDATA	1	DEVICEID	CHAR	40	0	Additional Device Data
MAINTPLANT	1	SWERK	CHAR	4	0	Maintenance plant
LOCATION	1	STORT	CHAR	10	0	Asset location
MAINTROOM	1	RAUMNR	CHAR	8	0	Room
PLSECTN	1	BEBER	CHAR	3	0	Plant section
LOC_WK_CTR	1	ARBPL	CHAR	8	0	Work center
LOC_WKCTR_ID	1	PPSID	NUMC	8	0	Object ID of PP work center
ABCINDIC	1	ABCKZ	CHAR	1	0	ABC indicator for technical object
SORTFIELD	1	EQFNR	CHAR	30	0	Sort field
COMP_CODE	1	BUKRS	CHAR	4	0	Company Code
PROFIT_CTR	1	PRCTR	CHAR	10	0	Profit Center
CO_AREA	1	KOKRS	CHAR	4	0	Controlling Area
RESPCCTR	1	AUFKOSTV	CHAR	10	0	Responsible cost center
FUNC_AREA	1	FKBER	CHAR	16	0	Functional Area
SUPERIOR_NETWORK	1	CO_TEILNET	CHAR	12	0	Number of superior network
SUPERIOR_ACTIVITY	1	CN_VORNR	CHAR	4	0	Activity number in network and standard network
SUPERIOR_ROUTING_NO	1	CO_AUFPL	NUMC	10	0	Routing number of operations in the order
SUPERIOR_COUNTER	1	CO_APLZL	NUMC	8	0	General counter for order
WBS_ELEM	1	PS_PSP_PNR	NUMC	8	0	Work Breakdown Structure Element (WBS Element)
PROJ_DEF	1	PS_PSP_PRO	NUMC	8	0	Project definition
PROCESSING_GROUP	1	AUFABKRS	NUMC	2	0	Processing group
OBJECTCLASS	1	SCOPE_CV	CHAR	2	0	Object Class
TAXJURCODE	1	TXJCD	CHAR	15	0	Tax Jurisdiction
LOC_COMP_CODE	1	BUKRS	CHAR	4	0	Company Code
LOC_CO_AREA	1	KOKRS	CHAR	4	0	Controlling Area
ASSET_NO	1	ANLN1	CHAR	12	0	Main Asset Number
SUB_NUMBER	1	ANLN2	CHAR	4	0	Asset Subnumber
LOC_BUS_AREA	1	GSBER	CHAR	4	0	Business Area
COSTCENTER	1	KOSTL	CHAR	10	0	Cost Center
LOC_WBS_ELEM	1	PS_PSP_PNR	NUMC	8	0	Work Breakdown Structure Element (WBS Element)
STANDORDER	1	DAUFN	CHAR	12	0	Standing order number
SETTLORDER	1	ILOM_ORDST	CHAR	12	0	Settlement order
SALESORG	1	VKORG	CHAR	4	0	Sales Organization
DISTR_CHAN	1	VTWEG	CHAR	2	0	Distribution Channel
DIVISION	1	SPART	CHAR	2	0	Division
ORDPLANID	1	AUF_PLKNZ	CHAR	1	0	Maintenance order planning indicator
START_DATE	1	CO_GSTRP	DATS	8	0	Basic start date
FINISH_DATE	1	CO_GLTRP	DATS	8	0	Basic finish date
BASICSTART	1	CO_GSUZP	TIMS	6	0	Basic start time
BASIC_FIN	1	CO_GLUZP	TIMS	6	0	Basic finish (time)
PRIORITY	1	PRIOK	CHAR	1	0	Priority
REVISION	1	REVNI	CHAR	8	0	Revision for Plant Maintenance and Customer Service
VERSION	1	KAPVERSA	NUMC	2	0	Version of Available Capacity
SCHED_TYPE	1	TERMKZ	CHAR	1	0	Scheduling type
AUTOSCHED	1	CO_AUTERM	CHAR	1	0	Indicator: Schedule automatically
CAP_REQMTS	1	AUKBED	CHAR	1	0	Indicator: Calculate capacity requirements
SCHEDULING_EXACT_BREAK_TIMES	1	BREAKS	CHAR	1	0	Indicator:  Scheduling allowing for breaks
MRP_RELEVANT	1	AUDISP_PLUS	CHAR	1	0	Reservation Relevance/Generation of Purchase Requisition
PRODUCTION_START_DATE	1	CO_GSTRS	DATS	8	0	Scheduled start
PRODUCTION_FINISH_DATE	1	CO_GLTRS	DATS	8	0	Scheduled finish
PRODUCTION_START_TIME	1	CO_GSUZS	TIMS	6	0	Scheduled Start (Time)
PRODUCTION_FINISH_TIME	1	CO_GLUZS	TIMS	6	0	Scheduled finish time
ACTUAL_START_DATE	1	CO_GSTRI	DATS	8	0	Actual start date
ACTUAL_FINISH_DATE	1	CO_GETRI	DATS	8	0	Confirmed Order Finish Date
ACTUAL_START_TIME	1	CO_GSUZI	TIMS	6	0	Actual start time
ACTUAL_FINISH_TIME	1	CO_GEUZI	TIMS	6	0	Confirmed order finish (time)
REFDATE	1	ADDAT	DATS	8	0	PM Order: Reference Date
SALES_ORD	1	KDAUF	CHAR	10	0	Sales Order Number
S_ORD_ITEM	1	KDPOS	NUMC	6	0	Item Number in Sales Order
CALC_MOTIVE	1	BEMOT	CHAR	2	0	Accounting Indicator
INVEST_PROFILE	1	IM_PROFIL	CHAR	6	0	Investment measure profile
SCALE	1	IM_SIZECL	CHAR	2	0	Scale of investment objects
INV_REASON	1	IZWEK	CHAR	2	0	Reason for investment
ENVIR_INVEST	1	AM_UMWKZ	CHAR	5	0	Reason for environmental investment
ESTIMATED_COSTS	1	AUFUSER4	CURR	11	2	Estimated total costs of order
CURRENCY	1	AUFWAERS	CUKY	5	0	Order Currency
CURRENCY_ISO	1	ISOCD	CHAR	3	0	ISO currency code
CSTG_SHEET	1	AUFKALSM	CHAR	6	0	Costing Sheet
OVERHEAD_KEY	1	AUFZSCHL	CHAR	6	0	Overhead key
RES_ANAL_KEY	1	ABGR_SCHL	CHAR	6	0	Results Analysis Key
NETWORK_PROFILE	1	PROFIDNZPL	CHAR	7	0	Network profile
CSTGVAPPLN	1	KALKVARPLN	CHAR	4	0	Costing variant for planned costs
CSTGVARACT	1	KALKVARIST	CHAR	4	0	Costing variant for actual costs
TASK_LIST_GROUP	1	PLNNR	CHAR	8	0	Key for Task List Group
GROUP_COUNTER	1	PLNAL	CHAR	2	0	Group Counter
TASK_LIST_TYPE	1	PLNTY	CHAR	1	0	Task List Type
RESP_PLANNER_GROUP	1	VAGRP	CHAR	3	0	Responsible planner group/department
MNTPLAN	1	WARPL	CHAR	12	0	Maintenance Plan
MAINTITEM	1	WAPOS	CHAR	16	0	Maintenance item
CALL_NO	1	ABNUM	INT4	10	0	Maintenance Plan Call Number
LAST_ORD	1	LAUFN	CHAR	12	0	Order number
ENTERED_BY	1	AUFERFNAM	CHAR	12	0	Entered by
ENTER_DATE	1	AUFERFDAT	DATS	8	0	Created on
CHANGED_BY	1	AUFAENAM	CHAR	12	0	Last changed by
CHANGE_DATE	1	AUFAEDAT	DATS	8	0	Change date for Order Master
SCENARIO	1	SCRTP	CHAR	4	0	Scenario or Subscreen Category
SYS_STATUS	1	CO_STTXT	CHAR	40	0	System Status
USER_ST	1	CO_ASTEX	CHAR	1	0	User status active
USERSTATUS	1	CO_ASTTX	CHAR	40	0	Field displaying user status
STAT_PROF	1	J_STSMA	CHAR	8	0	Status Profile
OBJECT_NO	1	J_OBJNR	CHAR	22	0	Object number
ROUTING_NO	1	CO_AUFPL	NUMC	10	0	Routing number of operations in the order
RESERV_NO	1	RSNUM	NUMC	10	0	Number of Reservation/Dependent Requirement
SHORT_TEXT	1	AUFTEXT	CHAR	40	0	Description
LONG_TEXT	1	CO_LTEXT	CHAR	1	0	Long text exists
NOTIF_NO	1	QMNUM	CHAR	12	0	Notification No
ASSEMBLY_EXTERNAL	1	MGV_ASSEMBLY_EXTERNAL	CHAR	40	0	Long Material Number for Field ASSEMBLY
ASSEMBLY_GUID	1	MGV_ASSEMBLY_GUID	CHAR	32	0	External GUID for ASSEMBLY Field
ASSEMBLY_VERSION	1	MGV_ASSEMBLY_VERSION	CHAR	10	0	Version Number for ASSEMBLY Field
MATERIAL_EXTERNAL	1	MGV_MATERIAL_EXTERNAL	CHAR	40	0	Long Material Number for MATERIAL Field
MATERIAL_GUID	1	MGV_MATERIAL_GUID	CHAR	32	0	External GUID for MATERIAL Field
MATERIAL_VERSION	1	MGV_MATERIAL_VERSION	CHAR	10	0	Version Number for MATERIAL Field
CALID	1	WFCID	CHAR	2	0	Factory Calendar
KALSN	1	KALSN	NUMC	2	0	Calendar Selection for Order
SUPERIOR_ORDERID	1	MAUFNR	CHAR	12	0	Number of superior order
LEADING_ORDERID	1	CO_LAUFNR	CHAR	12	0	Leading order in current processing
START_POINT	1	EAML_START_POINT	CHAR	18	0	Start Point
END_POINT	1	EAML_END_POINT	CHAR	18	0	End Point
LINEAR_LENGTH	1	EAML_LINEAR_LENGTH	CHAR	18	0	Length
LINEAR_UNIT	1	EAML_LINEAR_UNIT	UNIT	3	0	Unit of Measurement for Linear Data
LINEAR_UNIT_ISO	1	EAML_LINEAR_UNIT_ISO	CHAR	3	0	Unit of Measurement for Linear Data in ISO Code
FIRST_OFFSET_TYPE_CODE	1	EAML_OFFSET1_TYPE_CODE	CHAR	2	0	Type of First Offset
FIRST_OFFSET_VALUE	1	EAML_OFFSET1_VALUE	CHAR	18	0	Value of Offset 1
FIRST_OFFSET_UNIT	1	EAML_OFFSET1_UNIT	UNIT	3	0	Unit of Measurement for Offset 1
FIRST_OFFSET_UNIT_ISO	1	EAML_OFFSET1_UNIT_ISO	CHAR	3	0	Unit of Measurement for Offset 1 in ISO Code
SECOND_OFFSET_TYPE_CODE	1	EAML_OFFSET2_TYPE_CODE	CHAR	2	0	Type of Second Offset
SECOND_OFFSET_VALUE	1	EAML_OFFSET2_VALUE	CHAR	18	0	Value of Offset 2
SECOND_OFFSET_UNIT	1	EAML_OFFSET2_UNIT	UNIT	3	0	Unit of Measurement for Offset 2
SECOND_OFFSET_UNIT_ISO	1	EAML_OFFSET2_UNIT_ISO	CHAR	3	0	Unit of Measurement for Offset 2 in ISO Code
FIRST_OFFSET_TYPE_CODE_NAME	1	EAML_OFFSET1_TYPE_CODE_NAME	CHAR	60	0	First Offset Type Description
SECOND_OFFSET_TYPE_CODE_NAME	1	EAML_OFFSET2_TYPE_CODE_NAME	CHAR	60	0	Second Offset Type Description
MARKER_START_POINT	1	EAML_MARKER_START_POINT	CHAR	18	0	Marker for Start Point
MARKER_DISTANCE_START_POINT	1	EAML_MARKER_DISTANCE_START	CHAR	18	0	Distance between Marker and Start Point
MARKER_END_POINT	1	EAML_MARKER_END_POINT	CHAR	18	0	Marker for End Point
MARKER_DISTANCE_END_POINT	1	EAML_MARKER_DISTANCE_END	CHAR	18	0	Length Spec for Distance between Marker and End Point
MARKER_DISTANCE_UNIT	1	EAML_MARKER_DISTANCE_UNIT	UNIT	3	0	Unit for the Distance from Marker
MARKER_DISTANCE_UNIT_ISO	1	EAML_MARKER_DISTANCE_UNIT_ISO	CHAR	3	0	Unit for the Distance from Marker in ISO Code
PRIOTYPE	1	ARTPR	CHAR	2	0	Priority Type

Note:    Use "Ctrl+Y" can select table content from SAP GUI, then use "Ctrl+C" to copy



Step 2: Create lookup dictionary for different data type

According to different ABAP data types, we need to create a lookup dictionary when generating the structure object.

DATA_TYPE_REF_ARY = {
               "CHAR":"C", "UNIT":"C", "LANG":"C", "CUKY":"C", "LCHR":"C",
               "DATS":"D", "FLTP":"F", "TIMS":"T", "NUMC":"N",
               "QUAN":"P", "DEC":"P", "CURR":"P",
               "INT":"I", "INT1":"b", "INT2":"s", "INT4":"I"
   };

   

Step 3: Create custom layout on the screen

//Make sure this layout will only show in transaction SE37
if(_transaction == "SE37"){
   
   if(!z_se37_display_structure_obj){
      pushbutton([TOOLBAR], "Get Structure Object", "?", {"process":se37GetStructureObject});      //Trigger the function to generate structure object detail
   }
   else {
      pushbutton([TOOLBAR], "Clear Structure Object", "?", {"process":se37Reset});      //Trigger the function to reset all realted variables
     
      clearscreen();
     
      textbox([0,0], [30,200], {"name":"z_se37_structure_obj_text"});      //Textbox to display result structure object detail
   }
}   

   
   
Step 4: Create function to reset SE37 related variables   

function se37Reset(){
   set("V[z_se37*]", "");
}

Step 5: Create function to read the component table and return structure object detail   

function se37GetStructureObject(){
   
   onscreen "SAPLSD41.2100"
      set("V[z_se37_structure]", "&F[Structure]");            //Read the structure value
      var relrow = 1;
      var absrow = 1;
      var z_se37_component_ary = [];
      var z_se37_row_ary = [];
     
NEW_SCREEN:;     
      enter("/ScrollToLine=&V[absrow]", {"table":"T[SAPLSD41_TC0]"});
     
   onscreen "SAPLSD41.2100"
      gettableattribute("T[SAPLSD41_TC0]", {"firstvisiblerow":"FVisRow", "lastvisiblerow":"LVisRow", "lastrow":"LRow"});   
      relrow = 1;
NEW_ROW:;   
      if(absrow > LVisRow){
         goto NEW_SCREEN;
      }
   
      if(absrow > LRow){
         goto END_OF_TABLE;
      }
   
      z_se37_row_ary = [];
     
      //Read each row of component table
      set("V[cur_component]", "&cell[SAPLSD41_TC0,Component,&V[relrow]]");
      set("V[cur_typing_method]", "&cell[SAPLSD41_TC0,Typing Method,&V[relrow]]");
      set("V[cur_component_type]", "&cell[SAPLSD41_TC0,Component Type,&V[relrow]]");
      set("V[cur_data_type]", "&cell[SAPLSD41_TC0,Data Type,&V[relrow]]");
      set("V[cur_length]", "&cell[SAPLSD41_TC0,Length,&V[relrow]]");
      set("V[cur_decimal_pl]", "&cell[SAPLSD41_TC0,Decimal Pl,&V[relrow]]");
      set("V[cur_short_desc]", "&cell[SAPLSD41_TC0,Short Description,&V[relrow]]");
   
      z_se37_row_ary.push(cur_component);
      z_se37_row_ary.push(cur_typing_method);
      z_se37_row_ary.push(cur_component_type);
      z_se37_row_ary.push(cur_data_type);
      z_se37_row_ary.push(cur_length);
      z_se37_row_ary.push(cur_decimal_pl);
      z_se37_row_ary.push(cur_short_desc);
   
      z_se37_component_ary.push(z_se37_row_ary);
   
      relrow++;
      absrow++;
      goto NEW_ROW;
END_OF_TABLE:;

      //Change flag to display the result textbox
      z_se37_display_structure_obj = true;

      //Get organized structure object detail
      var z_se37_result_struct_ary = setStructureObject(z_se37_structure,z_se37_component_ary);      //Get organized result array from function
     
      //Logic to copy content from organized result array to longtext variable
      for(var struct in z_se37_result_struct_ary){         
         tmp_str = z_se37_result_struct_ary[struct];
         
         if(struct==0)
            copytext({"totext":"z_se37_structure_obj_text", "fromstring":"tmp_str"});
         else
            copytext({"totext":"z_se37_structure_obj_text", "fromstring":"tmp_str", "appendline":true});

      }
     
      enter("/ScrollToLine=1", {"table":"T[SAPLSD41_TC0]"});
}

Step 6: Create function to organized fetched table data   

function setStructureObject(structure,component_ary){
   var result_ary = [];
   var component_str = "";

   
   result_ary.push("\tvar z_" + structure + " = {\n");         //Decalre the type object
   result_ary.push("\t\tname:'" + structure + "',\n");         //Add the name variable
   result_ary.push("\t\tcomponents:[\n");                  //Add the components object
   
   for(var i=0; i<component_ary.length; i++){               //For loop to form each component
      component_str = "\t\t\t{ name:'" + component_ary[0] +
                  "', \tlength:" + component_ary[4] +
                  ",\tdecimalpl:" + component_ary[5] +
                  ",\ttype:'" + DATA_TYPE_REF_ARY[component_ary[3]] +
                  "' }" + ((i!=component_ary.length-1)?",\n":"\n") +
                  "\t" + ((component_ary[3]=="CHAR")?"\t\t\t\t":("/** " + component_ary[3] + " **/\t\t\t")) +
                  "//" + component_ary[6];
     
      result_ary.push(component_str);
   }
   
   result_ary.push("\t\t]\n");                           //End component object
   result_ary.push("\t};");                           //End type object
   
   return   result_ary;
}

Step 7: Copy result to your script   

After execution, the result of structure object should displayed in the textbox.
Now select everything from the textbox and copy to the targeting script.


   
See attachments for full script example