Functionality
This method posts to SAP Retail the optimized material master andmovement data from the space management program.
The following data can be transferred to SAP Retail:

• Master data:

Material number, unit of measure, EAN, material dimensions, sortsequence in shelf, shelf section, horizontal facing, vertical facing,layout module variant, and exclusion indicator. Exclusion means that thematerial is missing in the layout module variant, i.e. does not have aplacement.

• Movement data:

Maximum shelf quantity, optimum shelf quantity, presentation quantity.
Import parameters

• The parameter layout module SiteLayoutModule and


• the structure Controls, which contains the following fields:

A plant for which listing conditions may have to be created
The path for the planogram file assigned to the layout module
A plant, if applicable
The requirement group
Indicator for whether a listing check is to be carried out
Indicator for whether the dimensions are to be updated
Indicator for whether the placement data is to be updated (thisindicator should always be set if a material is to be added to the shelfor removed from the shelf and/or if placement data has changed)
The validity date for the listing of the materials assigned to thelayout module. This date is also used as the validity date for thelayout module version. If the date is empty, the system date is usedinstead.
Indicator for whether updating is to be started from this BAPI itself(=Commit Work),
Indicator for whether a check is to be carried out on the layout moduleagainst the layout and plant
A mapping variant. In the customer exit of this method, various mappingvariants are defined which can be accessed for each call. Thus onemapping variant can form the average of the movement data, and anothercan aggregate this, for example.
Indicator for whether listing is to be carried out for the materialsconcerned
Indicator for whether the version of the layout module is to be releasedimmediately
A layout module variant to which certain materials are to be assigned
A layout module version. If no version is specified, the "Valid from"date can be used to find a version
Indicator for whether the valid-from date is to be used for versiondetermination
A document number that links a layout module version with a shelfplanogram file via document management
Import and consistency check
The table Items is imported for the optimized material data.
First additional header data is read for the selection data and checkedfor consistency. The imported material numbers are then compared withthe material numbers in SAP Retail. If a material number in tableItems does not exist in SAP Retail, a further check is carriedout to determine whether a material with the same EAN exists. If it doesnot, the material is deleted from the table. In addition, the materialis written to an error log, in order to inform the initiator of whichmaterial postings led to errors.
An entry is also written to the error log if a work in the import tablefor plant does is not assigned to the relevant layout module or does notexist at all.
Finally the system checks whether the materials are in the valid listingperiod or sales period. The start date of listing for the layout modulein structure Controls is used as the check date. If materials inthe import table are not listed or salable at the specified time, anentry is written to the method's error log.
The fixture assignments for the layout module version are imported intable Fix_Asgmt.
Updating of optimized data
After the checks, the following data is updated:

• Date of last optimization for the relevant layout module version


• Updating of material dimensions


• Updating of layout module version


• Updating of assignment of layout module variants


• Updating of assignments of fixtures to layout module version


• Updating of placement data of a material in the layout module


• Updating of the document number.

Values <> 0 are also updated, as materials can be assigned that were notplaced in the planogram but still need to remain in the layout module.Material dimensions with values equal to zero are not updated. For theupdating of optimized stock data, the customer exit of the method mustbe used up to Release 4.5A. As of Release 4.5B, this stock data can beupdated directly without the use of the customer exit.
Planogram file
This link between a planogram file and a layout module is created by adocument in document management. Here, it is necessary for a fewsettings to be made in Customizing for document management.Define Document Types.
You must ensure that document type "Layout document" (L01) permitsexternal number assignments. These settings are made in the details viewfor the document type in Customizing for document management undercontrol data Define Document Types.
At the same point, the flag next to "Version Assignment" must not beset, so that different versions can be created using the BAPI.
There are four different cases for updating the document number:

• If the document specified in the update BAPI does not yet exist in SAP
Retail, this document is created.

• If the document specified in the update BAPI already exists in SAP
Retail and both the object link to the layout module version and theplanogram name and path were not changed, the only the document updatedate is changed.

• If the document specified in the update BAPI already exists in SAP
Retail, but is now linked to another layout module version, a newversion is created in version management for the document. The oldversion of the document is not deleted.

• Finally, if the document specified in the update BAPI already exists in
SAP Retail, but the planogram was saved in a different destination orwith a different file name in the space management system, a new versionis again created. In this case, too, the old version of the document isretained.

Notes
If the update flag is not set in this method, a Commit Work is nottriggered. As a result, after the method has been called, a general BAPIBAPI_TRANSACTION_COMMIT must be called to trigger the update.
As mentioned above, consistency and dependency checks are carried out.The validity of the entries customer, layout, and layout module ischecked and error messages are issued as appropriate. The dependenciescustomer to layout and layout to layout module are also checked.
INCLUDE BAPI_RET
In the listing check, for each material the system checks whether thematerial is list and/or whether it can be sold. The checking period forthe listing check covers the listing period and the sales period.However, a listing check is only possible if a plant was also entered inthe control parameters.
The materials are only assigned to a shelf assortment modules if theindicator for executing listing has been set. In addition, the listingconditions for the materials are created with a horizontal facing of 0and the shelf assortment modules are assigned to the relevantassortments if the layout module on which the version is based wasalready assigned to one or more plants.
A prerequisite for listing is that the layout module version has beenreleased. This can either be done in version maintenance in SAP or viathe Release Version Immediately indicator in this method. If a plant isspecified in the control data, listing conditions are only generated forthis plant. Otherwise, listing conditions are generated for all plantsto which the layout module is assigned.
Directly after data import and before the updating of data in SAPRetail, this method has a customer exit which can be used to process theimported data elsewhere or to import and update further data.
The length of the document path should not exceed 140 characters.
The layout check determines whether the specified layout module isassigned to the plant(s).
The Plant control parameter is used to determine the space managementprofile assigned to this plant. If a plant was not transferred duringdata import, the reference plant of the layout module is used.
The Requirement Group parameter has no functionality in the standardsystem. It is merely used as a further option for controlling theupdating of the imported space management data.
In addition, table STORES can be used to transfer the plantswhose local assortments are to be assigned the selected layout modulevariant.
It behaves in a similar way for the updating of a layout module variantif a store (CUSTOMER) was entered in the Controls. Its localassortment is also assigned the layout module version.
GLOSSARY:
All the key terms are explained in brief below:
Planogram:
Graphical representation of a shelf in a space management program.
Layout:
Spatial arrangement of the goods on sale in a store or department. Alayout consists of layout modules and can be assigned to one or morestores.
Layout area:
A layout can be subdivided into layout areas, whereby a layout areacorresponds to exactly one layout module within the layout.
Layout module:
Grouping of materials that are to be presented together in the same areaof the store. A layout module can correspond to one or more salesshelves. Different layout module versions can exist for a layout module.Each of these versions is valid for a particular period. Differentmaterials can be assigned to the versions. Layout module variants areused to map differences to the currently valid version for individualstores.
Fixture:
A fixture is used to present the goods on the relevant sales area. Thismeans that the fixture holds the goods in order to encourage thecustomer to buy them. The fixture takes up a certain amount of space onthe sales area, so that only a limited number of fixtures can be placedin the sales area. Fixtures are assigned to layout module versions andinclude the following objects: shelf section, wall with hooks, wall withpins, container, round stand, freezer, and so on.
Layout module version:
Version of a layout module. The layout module version assigns materialsto a layout module for a specific period and thus enables layout modulesto be planned. At least one version exists for every layout module. Onlyone version can be valid at a given point in time.
Layout module variant:
Layout module variants are used to define slight differences to thecurrently valid version for individual stores. The variant can containextra materials or fewer materials than in the version. The currentlyvalid version is also known as the basic variant. Layout module variantsalways relate to a basic variant, and from a technical point of viewonly contain the delta, that is the differences to this basic variant.

Further information
For more information, see the SAP Library underSpace Management.

Description
INCLUDE BAPI_TABLE

Value range
If an error occurs, the following messages are issued:
Messages for input checks:
Type,, Code,, Number,, Message
E,, WB,, 024,, Customer &1 does not exist
E,, WB,, 121,, Layout module &1 does not exists
E,, WB,, 801,, Data for customer & is incomplete
E,, WB,, 808,, Layout module &1 is not assigned to customer2
E,, WB,, 810,, No layout is assigned to customer &
E,, WB,, 818,, Customer &1 is not the reference customerfor layout module &2
E,, WB,, 850,, No version exists for layout module &2 for date1
E,, WB,, 868,, The end date for the layout module version must be afterthe start date
E,, WB,, 871,, Layout module &1 does not have version2
Messages on internal error situations:
Type,, Code,, Number,, Message
E,, WB,, 005,, No materials are assigned to the selected layout module
E,, WB,, 797,, Field &1, field 2 and field &3 cannot beselected in &4
E,, WB,, 809,, The import table does not contain any materials
E,, WB,, 813,, No materials are listed or on sale
E,, WB,, 820,, Space management profile &1 does not exist
E,, WB,, 822,, Selection variant & for space management does notexist
E,, WB,, 823,, No fields in selection variant &1
E,, WB,, 824,, Field &1 is not included as a return value inselection variant 2&
E,, WB,, 825,, Field names are not maintained for either the businessvolume quantity or value
E,, WB,, 829,, Field &1 is not included as a selection field inselection variant &2
E,, WB,, 836,, Neither field &1 nor field &2 is a selectionfield in selection variant &3
E,, WB,, 883,, Variant &1 for version &2 of layout module3 does not exist
E,, WB,, 894,, Select a layout module variant
E,, WB,, 899,, Do not run listing checks and listing simultaneously
If errors occur during the updating of material dimensions, the errormessage refers to an error log, which can be displayed usingtransaction MM90.
If errors occur during generation of the listing conditions, during thelisting check, assignment of materials to a layout module version, orassignment of layout module variants to plants, an error log isgenerated, which can displayed using transaction WSAD.
Method BAPI_APPLICATIONLOG_GETDETAIL can be used to displaydetails for an application log.

Description
This structure contains all the data needed for updating the optimizedmaterial data of the space management program to the SAP system. Formore information, see the function module documentation.
INCLUDE BAPI_DATAELEMENT

Description
Grouping of materials for the purposes of assortment management. Thematerials are assigned to the layout module in integrated materialmaintenance. In addition, transactionMASS can be used for the mass assignment of materialsto a layout module. The layout module contains all the materials thatcan be placed in the planogram of the external space managementprogram.
INCLUDE BAPI_KEYFIELD

Value range
The system checks the agreement of layout module to customer and layoutmodule to layout and reports incorrect entries in the messageLayout module is not assigned tocustomer .

Description
Structure for the additional selection and import of header and itemdata.
In order to make additional header data available for the import, youmust create your additional fields in structure BAPI_TE_HEAD_DATAand fill this table accordingly with reference to the structure.The required parameter of the structure is the layout module.
In order to make additional item data available for the import, you mustcreate your additional fields in structure BAPI_TE_ITEMS andfill this table accordingly with reference to the structure. Therequired parameters of the structure are material and unit ofmeasure.
This table supplies data to the customer exit of the method.
INCLUDE BAPI_DATAELEMENT

Description
Table for assigned fixtures.

Description
This table contains all the material data assigned to the layout moduleand optimized in the space management program.
INCLUDE BAPI_DATAELEMENT
Either the material number or the EAN must be filled so that the datacan be updated in R/3.

Description
Import table for the assignment of layout module variants to theindividual plants. The layout module variant is assigned to each ofthese plants. The system checks whether the layout module in questionis actually assigned to the plant.