SAP Function BAPI_ADV_MED_GET_LAYOUT - Read Product Catalog Layout

Parameter Reference Type Length Default Optional Text
APPLY_AUTH_FILTER BAPILAYHLP-XFELD C 1 SPACE X Use Authorization Filter
APPLY_CHAR_FILTER BAPILAYHLP-XFELD C 1 SPACE X Use Characteristic Filter
AREA BAPILAYA-AREA N 10 SPACE X Layout Area Number
CATALOG BAPIADMID-PRODCAT C 10 Product Catalog
READ_STEPWISE BAPILAYHLP-XFELD C 1 SPACE X Checkbox field
VARIANT BAPIADMVID-VARIANT C 3 Variant
WITH_ITEMS BAPILAYHLP-XFELD C 1 SPACE X Flag for Reading Items
WITH_KZKFG BAPILAYHLP-XFELD C 1 SPACE X Indicator for Reading Material Configuration Indicator
WITH_PRICES BAPILAYHLP-XFELD C 1 SPACE X Flag for Reading Prices

Parameter Reference Type Length Text
LAYOUT BAPILAYA-LAYOUT C 10 Layout
RETURN BAPIRETURN u 452 Return Value

Parameter Reference Length Optional Text
AREAS BAPILAYA 37 Layout Areas
CURRENCIES BAPIADMVC 21 Currencies of Variant
FILTER_CRITERIA API_VAL_R 125 X
ITEMS BAPILAYIT 182 X Layout Area Items
LANGUAGES BAPIADMVL 16 Languages of Variant
PRICES BAPIADMIP 51 X Prices
RETURN_AREAS BAPIRET2 548 X Return Values for Layout Areas
TEXTS BAPILAYTX 153 Texts for Layout Areas and Items

Functionality
This method can be used to read information for the layout of a productcatalog.
The layout defines the structure of a product catalog and containsinformation on where the materials are roughly placed in the piece.

Example

Notes
The variant (parameter VARIANT) defines the language in which the textsin TEXTS and the currency in which the prices in PRICES are returned.
Currently you can only assign one currency and language when youmaintain a product catalog. This is why the tables LANGUAGES andCURRENCIES only contain one entry.
If the IMPORT parameter WITH_ITEMS is set ('X'), all product catalogitems in the ITEMS table are issued.
If WITH_ITEMS has the initial value, only the short texts for theproduct catalog and layout areas in TEXTS are returned.
If in addition to WITH_ITEMS, the parameter WITH_PRICES is also set,the table PRICES is filled.
In the case of layout areas for which there is no Read authorization,no item data (parameter ITEMS and TEXTS) is returned.
The product catalog items and prices can also be read separately withthe methods GetItems and GetPrices.
Messages are returned in parameter RETURN. The return values and theirmeaning can be found in the parameter documentation.
Messages that relate to individual layout areas are returned in theparameter RETURN_AREA. For information on the return values and theirmeanings, please see this parameter documentation.

Further information

Description
Number uniquely identifying the advertising medium layout.

Description
Return values for errors

Value range
TYPE = "E" CODE = "W+405" wrong parameter: WITH_PRICES = 'X' andWITH_ITEMS = SPACE
TYPE = "E" CODE = "W+406" wrong parameter: WITH_ITEMS = 'X', but ITEMSnot passed on.
TYPE = "E" CODE = "W+407" wrong parameter: WITH_PRICES = 'X', butPRICES nnot passed on.
TYPE = "E" CODE = "W+402" Advertising medium does not exist
TYPE = "E" CODE = "W+403" Variant does not exist
TYPE = "E" CODE = "W+404" Layout does not exist
TYPE = "E" CODE = "W+409" Error during pricing
TYPE = "E" CODE = "W+401" Unknown error
TYPE = "E" CODE = "W+544" No authorization to read catalog
TYPE = "I" CODE = "W+415" Language key & has no ISO code
TYPE = "I" CODE = "W+416" Currency key & has no ISO code
TYPE = "I" CODE = "W+417" Unit of measure & has no ISO code

Description
For further information, please refer to thedata element documentation.

Description
For further information, please refer to the

data element documentation.
Value range


Default

Description
If set, ('X'), layout area items in the tableITEMS are passed on.

Description
If set ('X'), prices for the layout area items in tablePRICES are passed on.

Description

  • LAYOUT: Layout of advertising medium

  • AREA: Layout area

  • PARENT: Superior layout area. Initial, if no superior layout area

    • exists.
    • CHILD: Indicates the number in succession the layout area is from

      • the superior layout area.
      • LEAF: Indicates whether the layout area is a page (or a leaf) in the

        • layout area hierarchy. If the indicator is set,
        ('X'), the layout area can contain items.
        If it is not set (initial), it contains subordinate
        layout areas.
        In table AREAS layout areas are returneddepth first search sorted, that is, in the same sequence as they appearin the expanded display of the maintenance transaction(Tcode WWMI). Please see the following example.
        For the layout area hierarchy
        Layout summer 98
        |
        |--- Fashion
        | |
        | |---- Ladieswear
        | |
        | |---- Menswear
        |
        |---- Jewelry
        with the layout area numbers 2 for fashion
        1 for ladieswear
        3 for menswear
        4 for jewelry
        and layout number 1001
        the following vaues are returned in AREAS:
        LAYOUT AREA PARENT CHILD LEAF
        ---------------------------------------
        1001 2 1
        1001 1 2 1 X
        1001 3 2 2 X
        1001 4 2 X

        Description
        Table in which the currency of the advertising medium variant isreturned.
        It consists of the fields:

        • ADVMED

        • VARIANT

        • CURRNCY:,,,,Currency

        • CURRNCY_ISO:,,Currency in ISO format

          • Description
          This table contains returned layout area items.
          It consists of the following fields:

          • LAYOUT: Layout of advertising medium

          • AREA: Layout area

          • ITEM

          • MATERIAL

          • UNIT: Unit of measure

          • SORT SEQUENCE NUMBER

          • MATTYPE

          • PARENT

          • UNIT_ISO: Unit of measure in ISO format

            • Entries of ITEMS are arranged by the components AREA and ITEM.
            If the materials are to appear in the same sequence as they wereentered in the maintenance transaction, the items in a layout area haveto be arranged by sort sequence number after the method is called.
            For materials with special material category characteristics,additional information can be obtained from further function modules:
            For sales sets (material category 10), function module'BAPI_MATERIAL_GETCOMPONENTS' provides all BOM materials and thequantities of these materials in the BOM.
            For variants of a generic article (material category 02), functionmodule 'BAPI_MATERIAL_GETCHARMERCHHIER' provides characteristics andcharacteristic values.

            Description
            Table in which the language of the advertising medium variant isreturned.
            It consists of the fields:

            • ADVMED

            • VARIANT

            • LANGU: Language

              • Description
              This table contains the returned prices for layout area items.
              It consists of the following fields:

              • LAYOUT: Layout of the product catalog

              • AREA: Layout area

              • ITEM

              • CURRNCY: Currency of price transferred in CONDVAL

              • CONDVAL: Price for layout area item

              • CURRNCY_ISO: Currency (ISO format) of the price transferred in CONDVAL

                • The records are sorted by the components AREA, ITEM and CURRNCY.

                Description
                Return values for errors in the layout areas

                Value range
                TYPE = "E" ID = "W+" NUMBER = "254"
                no authorization to read the layout area

                Description
                In this table short texts are returned for layout area items, layoutareas and the product catalog. It consists of the following components:

                • LAYOUT: Layout of the product catalog

                • AREA: Layout area

                • Item:

                • LANGU: Language of the texts in NAME and TITLE

                • NAME: Short texts from R/3

                • TITLE: Title from product catalog maintenance

                • LANGU_ISO:Language (ISO format) of the texts in NAME and TITLE

                  • The returned records are sorted according to the components AREA, ITEMand LANGU.
                  If the components AREA and ITEM are blank, both NAME and TITLE aregiven the product catalog short text.
                  If ITEM is blank, the short texts refer to the relevant layout area.