{"id":755,"date":"2010-03-16T15:38:18","date_gmt":"2010-03-16T14:38:18","guid":{"rendered":"http:\/\/websha.de\/xstepcafe\/?p=755"},"modified":"2018-06-01T06:45:21","modified_gmt":"2018-06-01T04:45:21","slug":"function-module-example-with-tabular-parameters","status":"publish","type":"post","link":"https:\/\/websha.de\/xstepcafe\/2010\/03\/16\/function-module-example-with-tabular-parameters\/","title":{"rendered":"Function Module: Example with Tabular Parameters"},"content":{"rendered":"

In this post I would like to demonstrate how to manipulate PI Sheet tables using table parameters in function modules.<\/p>\n

<\/p>\n

Basics<\/h1>\n

A PI Sheet table is a repeated data request with a variable number of lines.<\/p>\n

In a PI-based PI Sheet this is triggered by the characteristic PPPI_DATA_REQUEST_TYPE and the value ‘REPEATED’. Any variable you define inside\u00a0such a process instruction is a tabular value (PI). With XSteps you just set the type in the group node (where you also set the title of the table). Tabular parameters are defined in the XStep to which the repeated instruction belongs by setting a flag in the parameter definition (‘Tabular Value’).<\/p>\n

Having a tabular variable\/parameter does not necessarily means that there must be an visible output of that element. This may happen when you take the value of an input field by a function module inside the table instruction and return another value which valuates that hidden variable\/parameter. A hidden tabular value could be a status flag that indicates that the line is ready to be completed maybe triggering a command.<\/p>\n

There are two\u00a0possibilities to access data from a tabular variable\/parameter with a function module:<\/p>\n

    \n
  1. You create a function call inside<\/strong> the repeated instruction. When you pass the tabular variable\/parameter you should use a scalar<\/strong> parameter type in the function module (not a table parameter). Then the value passed is the value of the current line where the function module is called.
    \nI do not recommend to use function modules with parameters of type ‘TABLES’ \u00a0inside a repeated instruction. This does not mean that it is not working but I simply did not make good experiences with that.<\/li>\n
  2. You create a function call outside<\/strong> the repeated instruction in a separate simple instruction. Then you can pass a tabular<\/strong> variable\/parameter to a function module parameter of type ‘TABLES’. This means that the entire content of the one-column tabular variable\/parameter is passed to the function module.<\/li>\n<\/ol>\n

    So let me give you a simpe example of the second possibility.<\/p>\n

    Example<\/h1>\n

    This example I also showed in my live session #19<\/a>. It shows how to create a table of all components with the quantities in material base unit and BOM unit. The initial reason to set up this example was a question from the topic discussion <\/a>about alternate units of measure when using PI-bases PI Sheets.<\/p>\n

    Structures for the Parameter Definition<\/h2>\n

    To define function module parameters of type ‘TABLES’ you need a special structure for each basic data format (character, numeric, date, time).<\/p>\n

    For a character-like parameter create the structure ZMX_PI_TABLE_CHAR:<\/p>\n

      \n
    • Create one line (component): VALUE<\/li>\n
    • Select ‘Predefined Type’<\/li>\n
    • Select ‘Data Type’: ‘CHAR’<\/li>\n
    • Set Length: ’30’<\/li>\n<\/ul>\n

      For a numeric parameter create the structure ZMX_PI_TABLE_NUM:<\/p>\n

        \n
      • Create one line (component): VALUE<\/li>\n
      • Select ‘Predefined Type’<\/li>\n
      • Select ‘Data Type’: ‘DEC’<\/li>\n
      • Set Length: ’13’ (or more)<\/li>\n
      • Set Decimals: ‘3’ (or more)\u00a0<\/li>\n<\/ul>\n

        Function Module<\/h2>\n

        Create the following function module:<\/p>\n

        \n
        FUNCTION z_mx_tab_set_comp_list.\r\n*\"----------------------------------------------------------------------\r\n*\"*\"Local Interface:\r\n*\"  IMPORTING\r\n*\"     REFERENCE(I_RSNUM) TYPE  RSNUM OPTIONAL\r\n*\"     REFERENCE(I_AUFNR) TYPE  AUFNR OPTIONAL\r\n*\"  TABLES\r\n*\"      T_MATNR STRUCTURE  ZMX_PI_TABLE_CHAR OPTIONAL\r\n*\"      T_POSNR STRUCTURE  ZMX_PI_TABLE_CHAR OPTIONAL\r\n*\"      T_BDMNG STRUCTURE  ZMX_PI_TABLE_NUM OPTIONAL\r\n*\"      T_MEINS STRUCTURE  ZMX_PI_TABLE_CHAR OPTIONAL\r\n*\"      T_ERFMG STRUCTURE  ZMX_PI_TABLE_NUM OPTIONAL\r\n*\"      T_ERFME STRUCTURE  ZMX_PI_TABLE_CHAR OPTIONAL\r\n*\"----------------------------------------------------------------------\r\n\r\n  DATA: ls_resb TYPE resb.\r\n\r\n  DELETE t_matnr FROM 1.\r\n  DELETE t_posnr FROM 1.\r\n  DELETE t_bdmng FROM 1.\r\n  DELETE t_meins FROM 1.\r\n  DELETE t_erfmg FROM 1.\r\n  DELETE t_erfme FROM 1.\r\n\r\n* Get reservation information\r\n  SELECT * FROM resb INTO ls_resb\r\n    WHERE aufnr EQ i_aufnr.\r\n\r\n    IF ls_resb-postp EQ 'L'.\r\n\r\n      t_posnr-value = ls_resb-posnr. APPEND t_posnr.\r\n      t_matnr-value = ls_resb-matnr. APPEND t_matnr.\r\n      t_bdmng-value = ls_resb-bdmng. APPEND t_bdmng.\r\n      t_meins-value = ls_resb-meins. APPEND t_meins.\r\n      t_erfmg-value = ls_resb-erfmg. APPEND t_erfmg.\r\n      t_erfme-value = ls_resb-erfme. APPEND t_erfme.\r\n\r\n    ENDIF.\r\n\r\n  ENDSELECT.\r\n\r\nENDFUNCTION.<\/pre>\n<\/blockquote>\n
        Notes:<\/p>\n
          \n
        • Any tabular variable\/parameter in a PI Sheet table is initially created with one empty line (since each initial table has at least one line at the beginning). If you simply add your content to it you leave the first line empty. Therefore I removed these lines initially (DELETE … FROM 1).
          \nTherefore my intention here is only to call this function module once initially (you could do it on event DOCUMENT.GENERATED). If you want to call such a function module frequently you should think of a more performant way of handling these tables.<\/li>\n
        • You can enhance this example by doing some calculations and returning also a scalar value that you then display above (or below) your table. On example would be to calculate the total sum of all components taking different unit of measure into account.\u00a0<\/li>\n
        • If you use such a function module on a table where you also have input fields you should never delete any lines\u00a0once you begin to enter values in those input fields. This would mess up the table. Reading and modifying would be OK though.<\/li>\n
        • If you create a function module that handles data from multiple tables then I recommend to give all parameters a prefix to identify to which table that parameter belongs (e.g. T1_… \/ T2_…)<\/li>\n<\/ul>\n
          Process Instructions<\/h2>\n\n\n\n
          Simple Instruction with Function Call:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
          Simple Data Request<\/caption>\n
          Characteristic<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
          PPPI_FUNCTION_NAME<\/td>\nZ_MX_TAB_SET_COMP_LIST<\/td>\n<\/tr>\n
          PPPI_BUTTON_TEXT<\/td>\nTEST<\/td>\n<\/tr>\n
          PPPI_FUNCTION_DURING_DISPLAY<\/td>\n0<\/td>\n<\/tr>\n
          PPPI_TABLE_PARAMETER<\/td>\nT_MATNR<\/td>\n<\/tr>\n
          PPPI_STRING_VARIABLE<\/td>\nT_MAT<\/td>\n<\/tr>\n
          PPPI_OPTIONAL_PARAMETER<\/td>\nX<\/td>\n<\/tr>\n
          PPPI_TABLE_PARAMETER<\/td>\nT_BDMNG<\/td>\n<\/tr>\n
          PPPI_FLOAT_VARIABLE<\/td>\nT_QTY1<\/td>\n<\/tr>\n
          PPPI_OPTIONAL_PARAMETER<\/td>\nX<\/td>\n<\/tr>\n
          PPPI_TABLE_PARAMETER<\/td>\nT_MEINS<\/td>\n<\/tr>\n
          PPPI_STRING_VARIABLE<\/td>\nT_UOM1<\/td>\n<\/tr>\n
          PPPI_OPTIONAL_PARAMETER<\/td>\nX<\/td>\n<\/tr>\n
          PPPI_TABLE_PARAMETER<\/td>\nT_ERFMG<\/td>\n<\/tr>\n
          PPPI_FLOAT_VARIABLE<\/td>\nT_QTY2<\/td>\n<\/tr>\n
          PPPI_OPTIONAL_PARAMETER<\/td>\nX<\/td>\n<\/tr>\n
          PPPI_TABLE_PARAMETER<\/td>\nT_ERFME<\/td>\n<\/tr>\n
          PPPI_STRING_VARIABLE<\/td>\nT_UOM2<\/td>\n<\/tr>\n
          PPPI_OPTIONAL_PARAMETER<\/td>\nX<\/td>\n<\/tr>\n
          PPPI_EXPORT_PARAMETER<\/td>\nI_AUFNR<\/td>\n<\/tr>\n
          PPPI_STRING_VARIABLE<\/td>\nX_ORD<\/td>\n<\/tr>\n
          PPPI_OPTIONAL_PARAMETER<\/td>\nX<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\nTable:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
          Repeated Data Request (Table)<\/caption>\n
          Characteristic<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
          PPPI_DATA_REQUEST_TYPE<\/td>\nREPEATED<\/td>\n<\/tr>\n
          PPPI_VARIABLE<\/td>\nT_MAT<\/td>\n<\/tr>\n
          PPPI_MATERIAL<\/td>\n\u00a0<\/td>\n<\/tr>\n
          PPPI_VARIABLE<\/td>\nT_QTY1<\/td>\n<\/tr>\n
          PPPI_MATERIAL_QUANTITY<\/td>\n\u00a0<\/td>\n<\/tr>\n
          PPPI_VARIABLE<\/td>\nT_UOM1<\/td>\n<\/tr>\n
          PPPI_UNIT_OF_MEASURE<\/td>\n\u00a0<\/td>\n<\/tr>\n
          PPPI_VARIABLE<\/td>\nT_QTY2<\/td>\n<\/tr>\n
          PPPI_MATERIAL_QUANTITY<\/td>\n\u00a0<\/td>\n<\/tr>\n
          PPPI_VARIABLE<\/td>\nT_UOM2<\/td>\n<\/tr>\n
          PPPI_UNIT_OF_MEASURE<\/td>\n\u00a0<\/td>\n<\/tr>\n
          PPPI_OUTPUT_TEXT<\/td>\nMaterial<\/td>\n<\/tr>\n
          PPPI_OUTPUT_VARIABLE<\/td>\nT_MAT<\/td>\n<\/tr>\n
          PPPI_OUTPUT_TEXT<\/td>\nQty1<\/td>\n<\/tr>\n
          PPPI_OUTPUT_VARIABLE<\/td>\nT_QTY1<\/td>\n<\/tr>\n
          PPPI_OUTPUT_TEXT<\/td>\nUoM1<\/td>\n<\/tr>\n
          PPPI_OUTPUT_VARIABLE<\/td>\nT_UOM1<\/td>\n<\/tr>\n
          PPPI_OUTPUT_TEXT<\/td>\nQty2<\/td>\n<\/tr>\n
          PPPI_OUTPUT_VARIABLE<\/td>\nT_QTY2<\/td>\n<\/tr>\n
          PPPI_OUTPUT_TEXT<\/td>\nUoM2<\/td>\n<\/tr>\n
          PPPI_OUTPUT_VARIABLE<\/td>\nT_UOM2<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
          \u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"
          Simple example of a function module with tabular parameters to fill or analyze a PI Sheet table.<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_links_to":"","_links_to_target":""},"categories":[52],"tags":[42,41],"_links":{"self":[{"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/posts\/755"}],"collection":[{"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/comments?post=755"}],"version-history":[{"count":46,"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/posts\/755\/revisions"}],"predecessor-version":[{"id":909,"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/posts\/755\/revisions\/909"}],"wp:attachment":[{"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/media?parent=755"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/categories?post=755"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/websha.de\/xstepcafe\/wp-json\/wp\/v2\/tags?post=755"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}