Intergraph Smart Materials: SAP Material Interface
Intergraph Smart Materials: SAP Material Interface
Intergraph Smart Materials: SAP Material Interface
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the Software License Agreement ("SLA") delivered with the software
product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the Licensee has
a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and
govern the use of this software product and Documentation. Subject to the terms contained within the applicable license
agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the Documentation as
defined in the applicable license agreement and delivered with the software product for Licensee's internal, non-commercial
use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a SLA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the SLA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Export Controls
Intergraph Corporation’s commercial-off-the-shelf software products, customized software and/or third-party software, including any
technical data related thereto (“Technical Data”), obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to
the export control laws and regulations of the United States of America. Diversion contrary to U.S. law is prohibited. To the extent
prohibited by United States or other applicable laws, Intergraph Corporation software products, customized software, Technical Data,
and/or third-party software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or distributors must not
be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but not limited to, the United States
Department of Commerce Denied Persons, Entities, and Unverified Lists, the United States Department of Treasury Specially
Designated Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software product, customized software,
Technical Data and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors is related to the
design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or
sensitive nuclear uses.
d. To any entity when Customer knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product, customized software, Technical Data
and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors, should be addressed to PPM’s
Export Compliance Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify PPM and Hexagon Group Company for any causes of action, claims, costs, expenses
and/or damages resulting to PPM or Hexagon Group Company from a breach by Customer.
Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine, SmartSketch®, SmartPlant Cloud®, PDS®,
FrameWorks®, I-Route, I-Export, ISOGEN®, SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, and CAESAR II® are trademarks or registered trademarks of Intergraph Corporation
or its affiliates, parents, subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon AB or its subsidiaries.
Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley
Systems, Inc. Other brands and product names are trademarks of their respective owners.
Glossary ..................................................................................................................................................... 63
Smart Materials Terms .......................................................................................................................... 63
SAP Terms ............................................................................................................................................ 63
Index ........................................................................................................................................................... 64
Introduction
This documentation describes the interfaces between Intergraph Smart® Materials and the SAP
software system. These interfaces have been specified by Intergraph in the course of
workshops and user conventions involving many customers who use both Smart Materials and
SAP.
The General Overview (on page 7) section provides a general overview and shows you the
general plan for interfaces between Smart Materials and SAP.
The Material Master Transfer (on page 9) section describes the specific details of Material
Master transfer (Smart Materials Idents > SAP Materials), and the conditions and assumptions
required to make it possible for the two systems to operate side by side.
Because both Smart Materials and SAP are extremely flexible and setups can vary enormously,
it is not possible to say what is THE optimum Smart Materials / SAP configuration. What is far
more impressive is the interface concept, which allows the individual interfaces to be combined,
with each one being configured to allow optimum customization and integration into the
particular business case.
All the interfaces available in Smart Materials (for example, PDMS or OMI) that allow you to
process company idents are adapted accordingly so that these interfaces are also able to
process SAP material numbers (interface ident codes for corresponding SAP interfaces).
General Overview
Infrastructure
One important reason for having a modular interface is the fact that on-site, the interface has to
function with different SAP versions. The interface is adjustable on a per interface basis, thus
giving support to different SAP versions at the one customer site.
An online link between Smart Materials and SAP is not required.
Automation
The interface is operated from the Smart Materials end. All transfers are logged.
An automated transfer is not possible.
Integrating Systems
The interface is designed so that the Smart Materials system can feed several SAP systems. In
the case of several SAP systems, an interface-specific ident code is used to uniquely identify the
SAP Material Numbers in Smart Materials. Each connected SAP system is assigned to an
interface within this system, each with a valid client. This makes it possible to define different
configurations for the different SAP systems.
This is on the condition that each SAP system is fed only by a Smart Materials system.
Implementing SAP
Exchanging IDocs connects Smart Materials and SAP. These can be transferred either by XML
files or by using interface tables that contain the IDoc data. An application provided by the
customer will then transfer the data to the SAP system. The functions for receiving IDocs are
available in the SAP standard.
Smart Materials gives you the opportunity to record any enhancements you may need in the
IDocs structure. These customer-specific enhancements must be set when configuring the
interface. The enhancements must fall within the scope of the SAP interface upgrade concept.
Scope of Supply
The modules and procedures for the SAP interface described in Material Master Transfer
(on page 9) with accompanying tables and views
IDoc structures SAP Version 4.0b
MATMAS03 (Material master)
CLFMAS01 (Classification)
Concept
The concept of the interface, applied specifically to material master transfer, that is, the transfer
of Smart Materials idents to SAP materials, is described in this section. Boundary conditions are
explained and fundamental questions answered.
Ident Function - On Smart Materials screen A.60.13, ident functions can be defined.
They can be selected here and the return value will be submitted as an attribute value.
Master Data
To create a material in SAP, the following SAP material master data of a material must be
defined in Smart Materials and transferred.
Test data group for MTVFP Mapped master data attribute (by
availability check ident-function or CIP)
Module Extent
You can find the SAP interface screens in the Smart Materials menu under Integrator > SAP.
An interface is defined for each SAP system with an accompanying client. This means that an
interface must be defined for each client within an SAP system.
Field Descriptions
Interface (mandatory) - Via LOV, an interface is selected; this interface was defined in A.70.01.
To provide more information, the Short Desc and Description fields can be used.
Connection Type (mandatory) - Connection Type is a mandatory field and you must choose
between the following options:
Database: Data is exchanged by creating the IDOC information in interface tables (XI..) in
the M_SYS schema. For the further transfer to SAP, the customer must provide an
appropriate program.
XML: Data is exchanged by creating IDOCs as XML files and (optionally) transferring them
to another system specified by the field ‘Host’.
Host (optional) - Hostname or TCP IP address of the destination system for XML files.
Sys-Num (optional) - Number of the central instance of the SAP destination system.
Systemname (optional) - Name of the SAP destination.
User (optional) – User on the ftp server used as destination for the file transfer of XML IDocs.
Password (optional) – Password of the user for the ftp server.
You need to assign the ‘create external job’ database privilege to M_SYS if
you want to use the ftp transfer. On Windows, the OracleJobScheduler<sid> must be running.
SAP-Version (mandatory) - Via LOV, the corresponding version of the SAP destination system
is selected. The various versions are entered on screen SAP 10.03.
SAP Client (mandatory) - The SAP client is also a mandatory field. You should specify a valid
SAP client here. The interface definition will only be unique if you specify the SAP system
(physical installation) and associated SAP client.
Transfer_New_Idents (mandatory) - This check box defines whether new idents are brought
into the table INTERFACE_IDENTS automatically (that is, not by the user). The interface ident
code will be created with the help of a CIP function and saved in table M_IDENT_INTERFACES
in the field II_CODE.
The user can define the CIP function without any restrictions. The name of the CIP function will
be defined by the value of the according interface setting variable (A.70.11 Interface Settings).
The function M_PCK_SAP_CUSTOM.BUILD_SAP_ART_NR will be delivered by Intergraph per
default. The check box is set as default so that the SAP ident code depends on the CIP function.
Equal Units (mandatory) - The standard assumption is that when idents are transferred, the
quantity units can also be transferred in parallel. If this is not the case, the Equal Units check
box should not be set and the relevant unit declarations must be set on screen A.10.14.
Default Language (mandatory) - The Default Language field defines the language information
to be transferred to SAP per default. Smart Materials usually tries to transfer all IDoc fields that
were defined as multilingual (actually, this only applies to the fields TDLINE [segment
E1MTXLN] and MAKTX [segment E1MAKTM]) for all languages that are listed on SAP 10.02
SAP Languages (on page 22).
If this is not possible for a particular language (or for several languages) because there are no
values available in Smart Materials, the values from the language listed under Default Language
are transferred. This follows the principle of "better to have a description in a foreign language
than no description at all". If there is no value available in this language either, then no value is
transferred.
In this window, you can insert a number of SAP procedures defined on SAP 10.09 SAP
Procedures. These procedures will be assigned to all new SAP transfer jobs. These procedures
will work on the created IDOC information (XML file, database tables).
You build the SAP procedures on SAP 10.09 SAP Procedures.
If you create a new transfer job on SAP 20.01, the procedures defined here are assigned to the
new job. Before you start the job, you can make changes.
If you duplicate an existing job, you copy those procedures assigned to the old job to the new.
On SAP 20.01, you can send the IDoc with or without executing the procedures in one step to
SAP. You also have the choice to first build and save the IDoc, execute the procedures (one
after the other), and, in a last step, send the (changed) IDoc to SAP. Or, you can send the
original IDoc to SAP, make changes to the segment strings, and then send the changed IDoc to
SAP.
Field Descriptions
Seq - Sequence. If the SAP procedures are executed automatically, they will be executed in this
sequence.
Procedure - Code of the procedures defined on SAP 10.09 that are assigned to the SAP
interface and therefore to every new created SAP transfer job.
Field Descriptions
Interfaces Block - Select the interface to which interface settings will be defined.
Interface - The interface that was defined on screen A.70.01 is selected via LOV. The
Description and Short Desc fields contain additional information.
Interface Settings Block - Define the interface setting variables that are dependent on the
interface, which can save specific additional information to an interface.
Setting - Name of the interface setting variable.
Value - Value of the interface setting variable.
Type - Type of the interface setting variable. Types "CHAR", "NUMBER", and "DATE" are
available. Now, only type "CHAR" will be used.
Each language to be transferred must be listed with the relevant SAP language identifier; for
example:
Smart Materials: 1 (=English) in SAP: E
Smart Materials: 2 (=German) in SAP: D.
Field Descriptions
Interface (mandatory) - Via LOV, an interface will be selected that was defined on A.70.01. For
more information, the Desc and Short Desc fields can be used.
Nls - Unique number of a Smart Materials language.
Description - Description of the language.
SAP Language Value - SAP specific and unique value for an SAP language.
For example:
Smart Materials: MM (millimeters) in SAP: 03
Smart Materials: M3 (cubic centimeters) in SAP: 05
Field Descriptions
Block 1 - Select unit group and units for which you want to define interface specific units.
Group - Select via LOV a unit group that was already defined on screen A.10.12 Units of
Measure.
Unit - Select via LOV a unit that was already defined on screen A.10.12 Units of Measure.
Description - Display of the language-dependent description of the unit.
Block 2 - Define an interface unit for each interface and each unit from Block 1.
Interface - Via LOV, an interface will be selected. This interface was defined earlier on A.70.01.
Interface Unit - Define the interface unit for the selected interface.
The Master Data or Plant Dep. check boxes are used to identify master data fields (Master
Data) or plant-dependent master data fields (Plant Dep.).
These two fields decide which of the fields on screens SAP 10.08 Feature Mapping (Master
Data) and SAP 10.09 Feature Mapping (Plant-Dependent Master Data) are used as LOV for
the IDoc-Field on the screen.
If the Master Data check box is set, the field will be displayed in the LOV of the IDoc Field on
screen SAP 10.05 Master Data Mapping.
If the Master Data and Plant Dependent check boxes are set, the field will be displayed in the
LOV of the IDoc Field on screen SAP 10.06 Master Data Mapping (Plant Dependent).
The data for IDOCS MATMATS03 and CLFMAS01 is included with SAP Version 4.0b. However,
it is still necessary to select the requisite master data or plant-dependent master data fields (see
above) by setting the Master Data and Plant Dep. check boxes for using the fields on the two
screens mentioned above.
Field Descriptions
SAP Versions Block - In this block, the various versions of the SAP systems that are supported
by the Smart Materials SAP interface are listed.
SAP Version - Enter the name of the SAP version given by SAP. The Description and Short
Desc fields can contain additional language-dependent information.
SAP Idocs Block - In this block, the various IDocs are saved. The IDocs MATMAS03 and
CLFMAS01 are part of the delivery. The user has the opportunity to copy and modify IDocs with
the "Tree-Copy-Method," but it is important to maintain it in SAP in the same way to ensure an
error-free function.
IDoc Name - Name of the IDoc.
Short Desc and Description – Language-dependent description and short description.
SAP IDoc Segments Block - An IDoc consists of various segments that can have hierarchical
relations to each other. Segments can recur and they can be optional. The minimum and
maximum number can be set.
Seq - This field serves to define the unique sequence of the segments within an IDoc.
Segment Name - Segment name of the IDoc segment. It is defined in SAP. If IDocs will be
copied and user-modified, the segment names must remain unchanged and they must not be
renamed.
Parent Segment Name - With this field, hierarchical segment relations can be set. Via LOV, the
possible parent segments can be selected. Only segments with a lesser Seq number are
available.
Version dep. Segmentname - This is an additional name of SAP for the segment. Its purpose
is for the versioning of the segments and it will get a version number in the case of changes
(only expansions for backwards compatibility).
Min Number - The segment must occur at least n times within this IDoc.
Max Number - The segment can occur at most n times within this IDoc.
Optional - Detail if this segment is a mandatory field or not.
Short Desc and Description – Language-dependent description of the segment.
SAP IDoc Fields Block - The single IDoc fields are the elements of the IDoc segments. They
will be defined within a segment by a fixed position, length, and type. Here you can find the real
information. Each IDoc field has a value that is given by a value type (Data Type).
Seq - Defines the order of the single segment fields.
Field Name - Name of the IDoc field.
Data Type - Internal SAP data type of the IDoc field. Valid values include: "CHAR", "UNIT",
"DATS", "NUMC", "QUAN", "DEC", "INT2", "LANG", "CURR", and "FLTP". For the meaning of
the respective values, please refer to the SAP documentation.
Offset - Within an IDoc segment, each field has a fixed position. The offset determines the
position of a defined structure within the segment at which the field will begin.
Length - The length of the IDoc field within the segment structure.
Master Data - The activated check box defines an IDoc field as master data so that it can be
selected on screen SAP 10.05 Master Mapping and be filled by the procedures that are
available there.
Plant Dep. Data - The activated check box (in combination with Master Data check box) defines
an IDoc field as plant-dependent master data so that it can be selected on screen SAP 10.05
Master Mapping (Plant Dependent) and be filled by the procedures that are available there.
Value Type - This field defines the ways of interpreting the default of the Value/ Content field.
There are the following possibilities:
FIX – The value in the Value/ Content field will be assigned to the respective IDoc as a fixed
value.
CIP - The value in the Value/Content field will be interpreted as a CIP function. The return
value will be assigned as the default value in the corresponding IDoc field. The first input
parameter of the CIP function is the ID of the SAP interface, so the CIP may do different
things depending on the SAP interface.
The CIP function must have the following syntax:
FUNCTION m_pck_sap_custom.<functionname>
( p_interface_id IN m_interfaces.interface_id%TYPE,
,p_ident IN m_idents.ident%TYPE
,p_nls_id IN m_nls.nls_id%TYPE
,p_sp_id IN m_sap_plants.sp_id%TYPE )
return varchar2;
Value / Content - This field defines a standard value for the IDoc field. Depending on the Value
Type field, either the real value will be transferred (Value Type = "FIX") or it will be interpreted as
a CIP function (Value Type = "CIP") of which the return value then will be used as the default
value.
Short Desc and Description – Language-dependent descriptions of the IDoc fields.
Field Descriptions
SAP Interfaces Block - In this block, the SAP interfaces that were defined on SAP 10.01 are
selected. These interfaces are the interfaces for which SAP class profiles will be defined.
Interface - Select the SAP interface via LOV.
Short Desc and Description – Language-dependent description of the SAP interface.
Block 2: SAP Class Profile Settings - This block defines the class profiles that are possible
within an interface. These profiles then can get values on SAP 10.07 depending on the material
class. This description must correspond to the class description in SAP.
Features - Name of the SAP feature.
Short Desc and Description – Language-dependent description of the feature.
CIP functions and ident functions are not part of the delivery and they will not be maintained by
Intergraph.
Field Descriptions
Block 1: SAP Interfaces - In this block, the interfaces that were defined on SAP 10.01 are
selected. These interfaces are the interfaces for which the SAP IDoc master data fields will be
mapped.
Interface - Name of the SAP interface.
Short Desc and Description – Language-dependent description of the SAP interface.
Block 2: SAP Master Data - In this block, the non-dependent SAP master data IDoc fields
(Master Data check box on SAP 10.03, IDoc Fields block) will be mapped to Smart Materials
information. This can be fixed values, ident attributes, CIP functions, or ident functions.
Seq - Order sequence for the order of the mapped IDoc master data fields. This sequence is
particularly important if an IDoc field will be global and for example, assigned to a specific ident,
which is contained within the "generality". The value that is mapped first will be assigned to the
IDoc field, so it is very important to assign the first (lower sequence number) the appropriate
exceptions and only then (higher sequence number) the ident groups that are higher in
granularity.
Group - Group Code Filter. By selecting a group code, the assignment of the mapped IDoc
fields is carried out only for those fields that belong to this group.
Part - Part Filter. By selecting a part code, the assignment of the mapped IDoc fields is carried
out only for those fields that belong to this group.
Commodity Code - By selecting a commodity code, the assignment of the mapped IDoc fields
is carried out only for those fields belonging to this group.
Ident - Ident filter. By selecting an ident, the assignment of the mapped IDoc fields is carried out
only for the chosen ident.
Segment - Displays the segment belonging to the IDoc field.
IDoc Field - The IDoc field that will be mapped must be selected. There is an LOV containing
any plant-independent IDoc fields of the valid MATMAS IDoc, which means any IDoc fields
defined on SAP 10.03 as master data fields (Master Data check box).
Value Type - The values of the IDoc fields will be determined in different ways. You can choose
among the following value types:
Fixed - Features with a fixed value can be transferred to SAP. This means that the value in
the Value/Content field will be actually assigned to the IDoc field.
Ident - All the Smart Materials ident attributes can be assigned to IDoc fields, that is,
commodity attribute and/or object parameter details (geometry). If you select "Ident" as the
Feature type, an LOV in the Value/Content field will display all the available Smart Materials
ident attributes. The value of the ident attribute will be assigned to the respective IDoc field.
CIP function - You can define any CIP function or ident function to use here. The CIP
function must return a string (VARCHAR2) as the return value, which then will be transferred
as the value to SAP. The first input parameter of the CIP function is the ID of the SAP
interface, so the CIP may do different things depending on the SAP interface.
The CIP functions must have the following syntax:
FUNCTION m_pck_sap_custom.<functionname>
( p_interface_id IN m_interfaces.interface_id%TYPE,
,p_ident IN m_idents.ident%TYPE
,p_nls_id IN m_nls.nls_id%TYPE
,p_sp_id IN m_sap_plants.sp_id%TYPE )
return varchar2;
The return value of the CIP function will be assigned to the respective IDoc field.
Ident function - Can be defined on Smart Materials screen A.60.13. The Ident field is
transferred and the function returns a character (VARCHAR2) value, which then will be
transferred to SAP. In this way, it is possible to use any valid ident function to transfer its
return value to SAP. If "CIP" is selected as the attribute type, an LOV in the Value / Content
field displays all the available Smart Materials ident functions or CIP functions.
Value/Content - This field contains the value of the IDoc field, but it will be interpreted
depending on the Value Type field.
Multi Language -The Multi Language check box defines if the corresponding attribute is to be
managed in a multi-lingual way. In most cases, this applies to descriptive IDoc fields (MAKTX
field in segment MAKTM, TDLINE field in MTXLM Segment).
Field Descriptions
SAP Interfaces Block - In this block, the interfaces, defined on SAP 10.01, for which
plant-dependent SAP IDoc master data fields will be mapped, are chosen.
Interface - Name of the SAP interface.
Short Desc and Description - Language-dependent description of the SAP interfaces.
SAP Master Data Block - Here the SAP plants will be selected for which plant- dependent SAP
IDoc fields will be mapped.
Plant - Name of the SAP plant.
Short Description and Description - Language-dependent description of the SAP plants.
SAP Master Data Block - In this block, the plant-dependent SAP master data IDoc fields
(Master Data check box and Plant Dependent check box on screen SAP 10.03, IDoc Fields
block) will be assigned to Smart Materials information. This data can be fixed values, ident
attributes, CIP functions, or ident functions.
Seq - Order sequence for the order of the mapped IDoc master data fields. This sequence is
particularly important if an IDoc field will be global as well as, for example assigned to a specific
ident, which is contained within the "generality". The value that is mapped first will be assigned
to the IDoc field, so it is very important to assign the first (lower sequence number) the
appropriate exceptions and only then (higher sequence number) the ident groups that are higher
in granularity.
Group - Group Code filter. By selecting a group code, the assignment of the mapped IDoc
fields will be carried out only for those fields that belong to this group.
Part - Part filter. By selecting a part code, the assignment of the mapped IDoc fields will be
carried out only for those fields that belong to this group.
Commodity Code - Commodity Code filter. By selecting a commodity code, the assignment of
the mapped IDoc fields will be carried out only for those fields that belong to this commodity
code.
Ident - Ident filter. By selecting an ident, the assignment of the mapped IDoc fields will be
carried out only for the chosen ident.
Segment - Displays the segment belonging to the IDoc field.
IDoc Field - The IDoc field that will be mapped is chosen. There is an LOV containing any
plant-dependent IDoc fields of the valid MATMAS IDoc, which means any IDoc fields defined on
SAP 10.03 as master data fields (Master Data check box).
Value Type - The values of the IDoc fields will be determined in different ways. You can choose
among the following value types:
Fixed - Features with a fixed value can be transferred to SAP. This means that the value in
the Value/Content field will be assigned to the IDoc field.
Ident Attributes - All the Smart Materials ident attributes can be assigned to IDoc fields,
that is, commodity attribute and/or object parameter details (geometry). If you select "Ident"
as the attribute type, an LOV in the Value/Content field will display all the available Smart
Materials ident attributes. The value of the ident attribute will be assigned to the respective
IDoc field.
CIP function - You can define any CIP function or ident function to use here. The CIP
function is dependent on the SAP interface and must return a string (VARCHAR2) as a
return value, which then will be transferred as the value to SAP. The CIP function must have
the following syntax:
FUNCTION m_pck_sap_custom.<functionname>
( p_interface_id IN m_interfaces.interface_id%TYPE,
,p_ident IN m_idents.ident%TYPE
,p_nls_id IN m_nls.nls_id%TYPE
,p_sp_id IN m_sap_plants.sp_id%TYPE )
return varchar2;
The return value will be assigned to the respective IDoc field.
Ident function - Ident functions can be defined on the Smart Materials screen A.60.13. The
ident field is transferred, and the function returns a character (VARCHAR2) value, which then
will be transferred to SAP. In this way, it is possible to use any valid ident function to transfer its
return value to SAP. If "CIP" is selected as the attribute type, an LOV in the Value / Content
field displays all the available Smart Materials ident functions or CIP functions.
Value/Content - This field contains the value of the IDoc field. However, it will be interpreted
depending on the Value Type field.
Field Descriptions
SAP Interfaces Block - In this block, the interfaces defined on SAP 10.01 for which material
class-dependent SAP attributes will be mapped are chosen.
Interface - Name of the SAP interface.
Short Desc and Description - Language-dependent description of the SAP interfaces.
Block 2
SAP Material Class - Here the SAP material class is selected in which dependency SAP
attributes will be defined. The already defined material classes will be displayed in an LOV; they
can only be selected, not created. The creation of material classes is done using the "S.20.08
method". For more information, refer to Definition of SAP Material Classes (on page 55).
Class - The name of the SAP class in Smart Materials. For each material class that will be
created, there must be a table group.
Short Desc (Class) - Language-dependent description of the table group.
SAP Material Class - Table detail that is assigned to the table group. It is used to save and
assign a part independent of the material class.
Short Desc (SAP Material Class) - Language-dependent description of the table detail.
Block 3
SAP Class Profiles - In this block, SAP attributes can be specified as material class dependent
and given respective values. To determine the attribute (feature) values, you can assign fixed
values, ident attributes, CIP functions, or ident functions (see also Value Type and
Value/Content fields).
Seq - Order sequence for the order of the mapped IDoc attributes. This sequence is particularly
important if an IDoc field will be global as well as, for example, assigned to a specific ident,
which is contained within the "generality". The value that is mapped first will be assigned to the
IDoc field, so it is very important to assign the first (lower sequence number) the appropriate
exceptions and only then (higher sequence number) the ident groups that are higher in
granularity.
Group/Part
Group Code Filter/Part Code Filter - Selecting of a group is not possible because the selection
of a material class is like an indirect selection of group and part. By defining a material class, the
respective part was assigned, so that the part and group will be displayed after the selection of
material class in block 2 and cannot be modified.
Commodity Code
Commodity Code Filter - By selecting a commodity code, the assignment of the mapped IDoc
fields will be carried out only for those fields that belong to this commodity code.
Ident
Ident Filter - By selecting an ident, the assignment of the mapped IDoc fields will be carried out
only for the chosen ident.
Feature - The feature that will be mapped is chosen. There is an LOV containing any features
defined on SAP 10.04 as material class-dependent features.
Value Type - The values of the attributes (content of the Value/Content field) will be determined
in different ways. You can choose among the following value types:
Fixed - Attributes with a fixed value can be transferred to SAP. This means that the value in
the Value/Content field will be actually assigned to the IDoc field.
Ident Attributes - All the Smart Materials ident attributes can be assigned to attributes, that
is, commodity attribute and/or object parameter details (Geometry). If you select "Ident" as
the feature type, an LOV in the Value/Content field will display all the available Smart
Materials ident attributes. The value of the ident attribute will be assigned to the respective
IDoc field.
CIP function - You can define any CIP function or ident function to use here. The CIP
function is dependent on the SAP interface and must return a string (VARCHAR2) as the
return value, which then will be transferred as the value to SAP. The first input parameter of
the CIP function is the ID of the SAP interface, so the CIP may do different things depending
on the SAP interface.
The CIP function must have the following syntax:
FUNCTION m_pck_sap_custom.<functionname>
( p_interface_id IN m_interfaces.interface_id%TYPE,
,p_ident IN m_idents.ident%TYPE
,p_nls_id IN m_nls.nls_id%TYPE
,p_sp_id IN m_sap_plants.sp_id%TYPE )
return varchar2;
The return value will be assigned to the respective attribute.
Ident function - Ident functions can be defined on Smart Materials screen A.60.13. The
ident field is transferred, and the function returns a character (VARCHAR2) value, which
then will be transferred to SAP. In this way, it is possible to use any valid ident function to
transfer its return value to SAP. If "CIP" is selected as the attribute type, an LOV in the
Value / Content field displays all the available Smart Materials ident functions or CIP
functions.
CMS - You define Class Systems with properties in Smart Reference Data Plus in the
screens XC1010, XC1020 and XC1030. The property values assigned to the idents are
maintained in XC20 CMS Component Manager (see the CMS documentation for details).
The class properties can now be used for setting the values transferred to SAP.
CMS Class Code – This field contains the CMS class (only allowed for Type CMS). Entering a
CMS class code will transfer the value only for idents belonging to the selected CMS class.
CMS Type – For Type CMS this field contains the CMS type of the property used for the
mapping (Table/Attribute). This field will be filled automatically by the system when selecting a
CMS property in the field Value/Content.
Value/Content - This field contains the value of the attribute, but it will be interpreted depending
on the Value Type field.
Use NLS – This field determines for the mapping type CMS whether the table detail code or the
NLS description in the SAP default language is used for the value transferred to SAP (CMS
Type Table). For CMS type Attribute the NLS dependent value is used when checked. Note that
the attribute definition (NLS dependent/independent) automatically takes precedence.
Field Descriptions
Block 1
SAP Interfaces - In this block, the interface that was defined on SAP 10.01 is selected. This
interface is the interface for which SAP plants will be defined.
Interface - Name of the SAP interface.
Short Desc and Description - Language-dependent description of the SAP interfaces.
Block 2
SAP Plants - Here the SAP plants within an SAP interface will be defined.
Plant - The name of the SAP plant.
Short Desc (Class) - Language-dependent description of the SAP plant.
On this screen, you can create, delete, and update your SAP procedures. After defining a name
for the procedure, type the procedure.
A click on the Check button checks the procedure for syntax errors; the result of the check is
written into item ‘Check Result’.
The procedure(s) can be executed on the created IDOC data (either the XML files or the records
in the database). To make sure that the procedure is used for the IDocs of this special job, use
&SJT_ID > This variable will be replaced by the ID of the transfer job when it is executed on
SAP 20.01.
Assign procedures to SAP interfaces in the window 2 of SAP 10.01.
Define the procedures to be executed on a transfer job on SAP 20.01, tab page SAP
Procedures.
After defining an interface, determining a job name and choosing a where condition, the job can
be started by clicking the Start button.
The transfer can be either in online or batch mode. If it is started in online mode, the user must
wait for the job to finish. In this case a progress bar will be displayed. The user name as well as
the start and end time of the job will be saved in a log file. Furthermore, the user will get
feedback in the Job Return Code field with information about errors that occurred.
The job cannot be started twice.
Block 1
SAP Interfaces - In this block, the interface that was defined on SAP 10.01 is selected. This
interface is the interface for which SAP transfer jobs will be defined.
Interface - Name of the SAP interface.
Short Desc and Description - Language-dependent description of the SAP interface.
Block 2: TAB page SAP Jobs
SAP Plants - Here the necessary parameters to start a job must be defined.
Job - The name of the transfer job. It must be unique.
Short Desc and Description - Language-dependent description of the transfer job.
Where Condition - A where condition (valid for screen SAP 20.01) can be selected via LOV.
This where condition can be defined on screen A.60.06 Where Conditions. The condition
provides an easy way of restricting the total number of idents in accordance with certain criteria.
Ident Code - Select an ident that will be transferred to SAP separately.
From Date/To Date - Complete these fields if you want to transfer idents that have been
modified after a transfer.
Radio Group Transfer Mode - These options define how to determine the set of idents that will
be transferred.
Short Desc and Description - Language dependent description of the where conditions.
Comment - Display of the Comment field on screen A.60.06.Where Condition.
Workload - This button allows the selection of one or more CMS Workloads defined in Smart
Reference Data Plus. All idents belonging to the workloads will be transferred to SAP.
Workload Idents – This button will show a list of all idents belonging to the selected
workload(s).
Job Start User - Name of the user who has started this job.
Job Status - Status of this job. There are the following possible statuses:
OK - The job has finished successfully.
Failed - The job stopped with an error. The exact error message is displayed in the Job
Return Code field and can be looked up in the error file.
Ready to run - The job was already defined but not run until now.
Job Start Date - Start date of the job.
Job Finish Date - End date of the job.
Logfile - Name of the log file for this job. The log file will be created in the directory specified by
the DBA setting LOG_FILE_DEST or the project default ZX_MAR_LOG. The content of the log
file is dependent on the ‘Message Level’ setting in A.60.61 User Preferences. Recommended
values when running SAP transfer jobs are
5 – includes basic information
20 – includes standard information
99 – includes all log information available for the transfer
Job Return Code - In this field, the result of the transfer job is displayed. If there has been an
error during the job, it will be displayed in a shortened form.
Job Summary - This is a summary about the number of transferred idents and attributes and
the errors that occurred.
Send To SAP: There are four possibilities for starting a job:
only build the IDocs and store them as XML files or in the interface tables
build and store IDocs and execute SAP procedures
build and store IDocs and transfer the XML files using FTP to the SAP server
build and store IDocs, execute procedures, and transfer the XML files to the SAP server
Check Pipe - A click on this button checks some fundamentals necessary to start a transfer job;
the results of these checks are written into a log file. After the check, the log file is opened
automatically to display the results (to make sure that the procedure can open and write into a
log file, DBA setting (A 60.04) LOG_FILE_DEST must specify the UTL directory).
First, the interface settings are checked for existence and, if found, the value is written into the
log file. In the next step, the software checks that at least one language is inserted on SAP
10.02 SAP Language. Next, the software checks whether it is possible to work with a pipe and
to work with jobs.
Start - Clicking this button starts the job online so that the user has to wait until the job has
finished. The progress of the job is displayed by a special "progress screen," which informs the
user about the transfer time, the estimated remaining time, and about how many idents have
been transferred.
Show Protocol - After the job has finished successfully or stopped with an error, the user can
display the protocol of the job by clicking this button. He will get more detailed information about
the processing of the job.
IDocs are always stored in M_SAP_TRANSFER_JOB_IDOCS before (or not) they are sent to
SAP and are displayed (after the job has finished) on the next window of SAP 20.01, called SAP
20.01 SAP IDoc Segment Strings.
MATMAS_jobnr_seqnrN.XML XML file of IDOC type MATMAS for SAP without line
feed and leading blanks (only this file will be transmitted
by ftp)
CLFMAS_jobnr_seqnrN.XML XML file of IDOC type CLFMAS for SAP without line
feed and leading blanks (only this file will be transmitted
by ftp)
The import of the XML files into SAP is described in a separate document.
You must create the SAP procedures on SAP 10.09. On the SAP 10.01, window 2, you can
assign some (or all) of these procedures to your SAP interface(s). If you create a new transfer
job (TAB page SAP Jobs), you can find the procedures of SAP 10.01 here. If you duplicate an
existing job, you can find the procedures of the old job here. After committing the new job and
before starting the job, you can make changes to the assigned procedures.
Clicking the Start Procedure button starts the corresponding SAP procedure.
If you start a transfer job for every IDENT within the WHERE condition, one IDoc is built. As an
intermediate step, the IDoc is inserted into the table M_SAP_TRANSFER_JOB_IDOCS.
If you choose the possibility of building, inserting, executing the SAP procedure(s) for this job,
and sending to SAP, the IDocs will read out of M_SAP_TRANSFER_JOB_IDOCS before they
are sent to SAP, so that changes done by the procedures will be seen.
One other way of working is to first create and store the IDocs without sending them to SAP.
You can view the IDocs before sending them by clicking the button ‘Send to SAP’ (window SAP
IDoc Segment Strings). The real segment string is a concatenation of ‘Segname,’ ‘Client,’ and
so forth; the string is divided into the visible elements and each element is shown in its own
item.
If you have an order sequence, a sequence is also inserted into this table and displayed on the
screen. ‘Typ’ gives you information about this segment string of a MATMAS- or a CLFMAS IDoc.
If you want, you can make changes to one or more segment strings. You can do this manually in
this window, but you also can do this with your SAP procedures. You can execute each of the
SAP procedures by clicking the Start Procedure button on TAB page SAP Procedures.
Before executing a SAP procedure, copy the original (cut and paste) into an editor or a
file. If the procedure does not show the result that you want, it is easy to rebuild the original
segment string again.
If you then want to send the IDoc(s) of this job to SAP again, click the Send to SAP button in
this window. The IDocs are then built again from the (changed) records of the table
M_SAP_TRANSFER_JOB_IDOCS and then sent. In this way, you can send the IDocs, built by
one transfer job, to SAP several times.
A log file is written, and you can open it by clicking the Show Protocol button in this window. For
details about the directory and content, see the description for window 1 of SAP 20.01.
When starting a job in batch mode, after completion of the job, an email is sent automatically to
the user who started the job. This functionality requires to be set up as described in the
document about the mailing functionality of Smart Materials.
STJ_ID_OLD ID of the previous SAP transfer job which has already been
transferred
IDOC_NAME CLFMAS/MATMAS
ID2 ID2 of the record from the interface table (empty if ID2 doesn’t exist)
ID3 ID3 of the record from the interface table (empty if ID3 doesn’t exist)
Information about the delta processing is also written to the log file.
Field Descriptions
Block 1
SAP Configs - In this block, select the interface and the order criteria for the display of the
transferred idents and their attributes.
Interface - Select an SAP interface via LOV.
Order Condition - Select the order criteria for the second block.
Block 2
SAP Idents - In this block, the idents that were transferred to the interface are displayed, along
with important information.
Ident - Ident.
Ident Code - Ident code.
Commodity Code - Commodity code.
Job - Name of the transfer job that has transferred this ident to the respective interface.
Field Descriptions
Interface - Select an SAP interface by LOV.
SAP Art Num - SAP article number.
Ident Code - Ident code.
Commodity Code - Commodity code.
Short Description and Description - Language-dependent description for the commodity
code.
Workflow
This section describes the steps and their order to create a new SAP interface. In addition, it
describes how to do the minimum settings for the functionality of the new interface. The
following sections must be worked through in the following order to create a new SAP interface:
Prerequisites
Prerequisites
SAP
The client under which the data shall be imported is known.
ALE customizing was done. A transmitter ALE object and a receiver ALE object (the SAP
system itself is the receiver) must be set up. Both names are known, and the user
mentioned above has the rights to use both ALE objects.
The distribution of the ALE connection was maintained. For example, the IDoc types that will
be transferred with the ALE connection must be defined. Normally, there are the types
MATMAS and CLFMAS. That applies also for the user modified IDocs, which will be used for
transmission. In any case, this requirement is met as long as the modifications are based on
the IDoc types MATMAS and CLFMAS.
Create an Interface
Call screen A.70.01 Interfaces and define a new interface (for example, "SAP").
SAP version 40b The version of the SAP target system will be
assigned to the interface (LOV exist)
The TRFC check box must be selected as the coupling type between Smart Materials and SAP.
For more information about settings, please refer to the SAP 10.01 Interface Parameters
section.
Interface Settings
For the functionality of the SAP interface to work properly, Smart Materials needs more
information. This information will be maintained as Interface Settings on screen A.70.11.
The following interface setting variables must be maintained for each SAP interface.
IDOC_TRACE E:\oradata\m51\utl\id Name and path of the IDoc trace file; the
oc_trace actual name will be unique by assigning the
current job ID; this will write up the processed
IDocs if the interface setting variable „Trace"
>0 was entered (see below)
Language Definitions
Within the interface, it is possible to transfer data in a multilingual manner if the data is marked
accordingly. On screen SAP 10.02 Languages, the languages must be entered that will be
transferred by Smart Materials in the case of a multi-lingual workflow (Multilanguage check box
on screens SAP 10.05 and SAP 10.06). You must enter the SAP language indicator for each
Smart Materials language.
For more information on screen SAP 10.02, refer to the Workflow (on page 50) section.
Unit Definitions
If SAP uses different units from Smart Materials (Equal Units check box on SAP 10.02 is not
marked), the translations for the Smart Materials units must be defined on screen A.10.14.
For more information, refer to the A.10.14 Interface Dependent Units (on page 23)
section.
The picture provides an example. You can choose any name. This table must then be linked to
the M_PARTS table by Next Block and LOV selection.
Because the SAP material classes are recorded using the Smart Materials model of table details
(see next section), you must have previously created at least one table group.
In addition, in case of faulty processing, you can find a detailed description of the error that
occurred in the status record of the ident.
Glossary
SAP Terms
Material - Corresponds to the Smart Materials ident.
Material Number - Material Numbers are a unique alphanumeric description of the SAP
Materials.
Material Master (SAP) - The set of SAP Materials, including all the Features.
Material Master Data
Features - Correspond to the SAP Master Data fields.
Classification Profiles - Features that can be allocated to a Material Class.
Material Master Features (SAP) - Full set of Material Master Data Features and Classification
Profiles.
SAP Material Class - Within SAP, Features (Classification Profiles) can be allocated to a
Material Class.
Idocs - Corresponds to a sort of data capsule in which logical SAP data can be transferred. It
includes, for example, Materials, supply requests (BANF‘EN), and so forth.
T
The Transfer Job • 61
U
Unit Definitions • 55
W
What Data will be Transferred? • 10
Where are Material Numbers Assigned? • 9
Where is Transfer Initiated? • 10
Which System Defines the SAP Material
Numbers? • 9
Workflow • 50