01 General Concepts SAP PI

8/13/2019 01 General Concepts SAP PI

http://slidepdf.com/reader/full/01-general-concepts-sap-pi 1/33

1

General Concepts Author: Joachim Orb



2

© SAP AG 2004, General Concepts, Joachim Orb

Objectives

After completing this session you will be able to:

Understand the general concepts of XI Message Mapping

Use standard functions in Message Mapping

Understand the impact of element cardinality on Message Mapping



3


Overview

General Concepts

Standard Functions

Element Cardinality



4

A message mapping consists of several target field mappings:

A target field mapping is a mapping of one or several source fields to one target field. The data

flow editor in the bottom area helps you to design a target field mapping.

All target field mappings describe a complete message mapping

Only mandatory fields of the target structure must be mapped

(displayed in red)

If you want to get an overview of the whole message mapping, use the text preview

function (papersheet icon with glasses).

Design a message mapping as a combination of target field mappings:

1. Create a message mapping in the design maintenance of the Integration Builder.

2. Using the structure overview and the data-flow editor, assign one or more source

fields to a target field. This is a Target Field Mapping (see above). It is also

possible to assign one source field to multiple target fields.

3. If necessary, enhance the target field mapping in the data-flow editor. To do so,

connect the source fields to the target fields by using the standard functions of the

mapping editor. You can also create user-defined functions in Java in the mapping

editor and then also use them in the data-flow editor.4. Carry out the last two steps for at least all mandatory target fields.


General Concepts - Mapping Editor (I)

Data-Flow Editor

Structure Overview

Source Structure Target Structure

Target Field Mapping



5


General Concepts - Mapping Editor (II)

Import of source and target structure

From Integration Repository

XSDs developped in the Integration RepositoryImported External Defini tions (WSDLs, XSDs, DTDs)

Imported SAP meta data (RFCs, IDocs)

From local fi le system (XSD or XML)

Not all XSD tags are supported (general rule: XSDs that can be

created by using the data type editor can be impor ted)

<xsd:include> and <xsd: import> are not supported

Mapping editor displays a simpl ified XML representation

of XSD files in structure overview



6


General Concepts - Mapping Editor (III)

There are 3 ways structures can be assigned to the Message Mapping.

1. By using an existing object already created in the Integration Repository

(e.g. Message Type, External Definit ions)

2. By using an RFC or IDoc meta data imported from SAP

3. By importing XML or XSD files from local file system





8


Icon Status Display

Element with maxOccurs = unbounded

MeaningIcon

Node

Element

Attribute

Icon Types

Icon Colors

Mapping to target field completeGreen

Attribute or element has already been assigned but the

corresponding mapping in the data-flow editor is not

complete

Yellow

Attribute or element must be assigned to complete the

mapping

Red Attribute or element not assignedWhite

MeaningColor



9


General Concepts - Elements

At tr ibute

Element is mandatory and might re-occur

(minOccurs>0, maxOccurs>1)

Element is mandatory (minOccurs>0)

Parent node might repeat (maxOccurs>1)

Element might repeat (maxOccurs>1)



10

A message mapping consists of several target field mappings:

A target field mapping is a mapping of one or several source fields to one target field. The data

flow editor in the bottom area helps you to design a target field mapping.

All target field mappings describe a complete message mapping

Only mandatory fields of the target structure must be mapped

(displayed in red)

If you want to get an overview of the whole message mapping, use the text preview

function (papersheet icon with glasses).

Design a message mapping as a combination of target field mappings:

1. Create a message mapping in the design maintenance of the Integration Builder.

2. Using the structure overview and the data-flow editor, assign one or more source

fields to a target field. This is a Target Field Mapping (see above). It is also

possible to assign one source field to multiple target fields.

3. If necessary, enhance the target field mapping in the data-flow editor. To do so,

connect the source fields to the target fields by using the standard functions of the

mapping editor. You can also create user-defined functions in Java in the mapping

editor and then also use them in the data-flow editor.4. Carry out the last two steps for at least all mandatory target fields.


General Concepts – Assignment of Fields

drag&dropdrag&dropdrag&drop

Double click on afield

=navigate tomapping

Double click on afield

=insert field intodata-flow editor



11


General Concepts - Data–Flow Editor

DeleteFloatingObjects

Lay OutMapping

DeleteCurrent

Mapping

SelectFunctionCategory

DefineUser

Function

SelectFunction



12


General Concepts – Mass Assignment

1.Mark root nodesof subtrees

2. Chooseassignment function

• Mappings are created automatically for homonymous child elements



13


General Concepts – Mapping Templates

1.Mark root nodesof subtrees

2. Right-click onnode. Choose “ ShowSuitable Templates”

• Mapping Templates based on Date Types have to be created beforehand

• Subnodes must reference this pair of Data Types



14


General Concepts - Text Preview

Al l target field mappings

Text Preview

Text Preview pertarget field



15


General Concepts - Dependencies

Dependencies

Al l mappings ormappings of two selectedsubnodes are displayed



16


General Concepts – Test Mappings (I)

A completed Message Mapping can be tested by using the “ Test ” tab.

Prerequisites

The defined message mapping must be complete. This means that each mandatory

target field must be assigned to one or more source fields.

There must not be any unassigned arguments when using functions.

Create test

cases

Tree View

XML documentview

Execute

Mapping

Create

empty

template

Loads an XML

instance from a

local file.



17


General Concepts – Test Mappings (II)

Editing the XML instances to use in test cases:

Using the editor for the XML view,

you can manually edit elements

and attributes or their values

here.

Using the Tree View, you can copy

sub-trees, delete nodes, and add

elements and att ributes. In the

Value column you can also enter

values fo r f ields.

Enter test

data



18


General Concepts – Debug Mappings

Using the “ Display Queue” to examine each step of the mapping:

Note:

The “context”

display and

usage in the

queues wi ll be

discussed in

later slides.



19


Overview

General Concepts

Standard Functions

Element Cardinality



20


Standard Functions: Introduction

Al l functions expect and return s tr ing values

Generating funct ions ‘produce’ values (for example: Constant) Some standard functions provide function properties (denoted by a

small asterisk)

For example: concat lets you additionally specify a delimiter

Call the function properties window by double clicking the function

R = f(X 1 ,X 2)X1

X2

R

R = f(X 1 ,X 2 ,X 3)

X1

X2 R

X3

O = f(I)I O

O =Generated Value

O



21

Functions of category Node functions help you to handle situations like

Your mapping depends on the existence of a field in the source structure

You have to create a tag in your target structure that does not exist in your source structure

See online documentation for details and examples about node functions.

Generating functions

All functions (regardless of whether they are standard or user-defined functions)

that do not have input values are referred to as Generating Functions. This also

includes the function CopyVal ue( ) .

A target field with maxOccur s=<n> that is assigned a generating function is

generated <n> times in the target structure. If maxOccur s=unbounded for the

target field, then exactly 5 target fields are generated.


Simple Standard Functions: c o n c a t

Function category: Text

<?xml version="1.0"encoding="UTF-8" ?>

<Contact><Fullname>

Harry Potter</Fullname>

</Contact>


<Customer><Firstname>

Harry</Firstname><Surname>

Potter</Surname>

</Customer>

Target MessageMappingSource Message

concat properties

Delimiter=“ “



22


Simple Standard Functions: S u b s t r i n g

Function category: Text

counting starts at 0 !

Substring propertiesstart from: 0count: 10


<Customer><CustomerID>

0123456789</customerID>

</Customer >


<Contact><RefNo>0123456789-181170

</RefNo ></Contact >




23


Simple Standard Functions: DateTrans

Function category: Date


<Contact><birthday>

11/18/1970</birthday>

</Contact>


<Customer><custBirthday>

181170</custBirthday>

</Customer>


DateTrans propertiessrc Format: ddMMyydst Format: MM/dd/yyyy

For potential date patterns, please see Java class

java.text.DateFormat



24


Boolean Functions

Boolean funct ions

Return true or false string

Interpret 1 and true (not case-sensitive) as true-value

X

Z

Y

R

then

if

else

Result value if condition is true

Result value if condi tion is false

Condition R = Y if X is true or 1,

else Z

R

X

Y

if

then

Condition

Result value

if condition is true

R = Y if X is true or 1

or no tag is produced

ifWithoutElse

if



25

Functions of category Node functions help you to handle situations like

Your mapping depends on the existence of a field in the source structure

You have to create a tag in your target structure that does not exist in your source structure

See online documentation for details and examples about node functions.

Generating functions

All functions (regardless of whether they are standard or user-defined functions)

that do not have input values are referred to as Generating Functions. This also

includes the function CopyVal ue( ) .

A target field with maxOccur s=<n> that is assigned a generating function is

generated <n> times in the target structure. If maxOccur s=unbounded for the

target field, then exactly 5 target fields are generated.


Calculations

Function category: Ar ithmetic

Calculations (add, multiply, etc.) are performed

with Java float precision

Trailing zeros in result are truncated, e.g.: 4.2-0.2 = 4

To keep t railing zeros use FormatNum function


<Contact><debt>

90.00</debt>

</Contact>


<Customer><debt>

90</debt>

</Customer>


FormatNum propertiesNumber Format:###,###,###.00

(For potential patterns, please see

Java class java.text.DecimalFormat)



26


Overview

General Concepts

Standard Functions

Element Cardinality



27


Element Cardinality – Mandatory Mappings(m i n O c c u r s > 0 )

Mandatory Elements and Nodes

(minOccurs>0) Mapping is mandatory. A source

element or a constant has to be

assigned to the target element.

Otherwise error message: “Message-

mapping not completely defined”

If not suf ficient values are provided

from the source structure the last

source element is reiterated.





29


Element Cardinality – Repeating Elements(m a x O c c u r s > 1 )

Mapping of Repeating Elements

and Nodes (maxOccurs>1)

Source: Target element iscreated as of ten as mapped

source element occurs in the

source message.

Source: Creating function (e.g.

Constant)

If minOccurs>0, <minOccurs>

target elements are created.

If minOccurs=0, 1 target element

is created.



30


Element Cardinality – Node Mapping

Mapping of non mandatory

Nodes (minOccurs=0)

If a non mandatory nodecontains elements with

minOccurs>0, these elements

become mandatory after their

parent node is assigned.



31


Element Cardinality – Node Mapping (II)

Mapping of non mandatory

Nodes (minOccurs=0)

Assignment of elements is notsufficient

Node has to be ‘created’ by

assigning a suitable source

node/element



32


Element Cardinality – Unique Target Mapping

Mapping from more than one

Source element

Only a single and uniquemapping relation per target

element is allowed (n:1

relationship)

Multiple mapping relations can

be defined by duplicating the

target node or element

(Duplicate Subtree)

To duplicate a node or an

element, right-click on the

object in the target structure

pane and select “ DuplicateSubtree”




Summary

Now you should be able to:

describe the main functions and the handling of the Mapping Editor

use Standard Functions of the XI 30. Message Mapping

understand the impact of Element Cardinality on Message Mapping

Documents

01 General Concepts SAP PI