Development Guidelines and

Naming Conventions for PO

Title: Development Guidelines – PO

Version: 1.01
SAP Release: SAP PO 7.5 SP18
Date of version: 0922-FebMar-2021
Stored: Development Guidelines

Responsible Date/Signature
[Name, Function] [DD-MM-YYYY]

Ravi Shankar, PO
Creation Consultant

Review

Release

1 of 34
SAP PO Development Guidelines and Naming Conventions

Document Information and Revision History

Please add your recent changes always on top of the following table.

Versio Date Author(s) Summary of Sections

n [DD-MMM-YYYY] changes affected
[n.m]
1.0 22-FEB-2021 Ravi Shankar Released All
1.1 09-MAR-2021 Ravi Shankar Re-Released All

Pixelle Integration
Last update: 22-Feb-2021 Page 2/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Table of contents

1 Overview 5
1.1 References............................................................................................... 5
2 Design Principles 6
3 Guidelines 7
3.1 Installation Options and Guidelines..........................................................7
3.2 General Guidelines...................................................................................9
3.3 Development Guidelines..........................................................................9
3.4 Development Tools................................................................................10
4 SAP PO Components 11
4.1 Enterprise Service Repository................................................................11
4.1.1 Object Placement with ESR...............................................................11
4.1.2 Integration Scenarios.........................................................................11
4.1.3 Mappings............................................................................................12
4.1.4 Lookups.............................................................................................. 12
4.2 Integration Directory...............................................................................12
4.2.1 Configuration Scenario.......................................................................12
4.2.2 Integrated Configuration.....................................................................12
4.2.3 Services..............................................................................................12
4.2.4 Value Mapping...................................................................................12
4.3 System Landscape Directory..................................................................13
4.4 Business Process Management.............................................................13
4.5 BRM – Business Rule Management.......................................................13
4.6 Integration Flow [iFlow]..........................................................................14
5 Naming Convention 15
5.1 System Landscape Directory..................................................................15
5.1.1 SAP Products.....................................................................................15
5.1.2 Non-SAP Products.............................................................................15
5.1.3 SAP Software Components................................................................15
5.1.4 Non-SAP Software Components........................................................15
5.1.5 Technical Systems.............................................................................16
5.1.6 Business Systems..............................................................................17
5.1.7 Business System Group.....................................................................17
5.2 ALE........................................................................................................ 18
5.2.2 Partner Profile – Non-ABAP Systems................................................18
5.2.3 Partner Profile – ABAP system...........................................................18
5.3 Enterprise Service Repository................................................................18
5.3.1 Namespaces......................................................................................18
5.3.2 Local SWCV.......................................................................................19
5.3.3 Process Integration Scenario Objects................................................19
5.3.4 Interface Objects................................................................................20
5.3.5 Mapping Objects................................................................................22
5.4 Configuration..........................................................................................23
5.4.1 Configuration Scenarios.....................................................................23
5.4.2 Business Services..............................................................................24
5.4.3 Communication Channels..................................................................24
5.4.4 Integration Flows................................................................................24
5.5 Alert Framework.....................................................................................24
5.5.1 Alert Classifications............................................................................24
5.5.2 Alert Categories..................................................................................25

Pixelle Integration
Last update: 22-Feb-2021 Page 3/34
Guideline
SAP PO Development Guidelines and Naming Conventions

6 Transport of Interface Objects 26

6.1 SAP Module ID.......................................................................................26
7 Monitoring 27
7.1 Monitoring Messages.............................................................................27
7.2 Monitoring Communication Channels.....................................................27
8 Annexure 30
8.1 Business Applications............................................................................30
Error! Hyperlink reference not valid.1 Overview 5
Error! Hyperlink reference not valid.1.1..................................................... References
5
Error! Hyperlink reference not valid.2 Design Principles 6
Error! Hyperlink reference not valid.3 Guidelines 7
Error! Hyperlink reference not valid.3.1........Installation Options and Guidelines
7
Error! Hyperlink reference not valid.3.2...................................... General Guidelines
9
Error! Hyperlink reference not valid.3.3........................... Development Guidelines
9
Error! Hyperlink reference not valid.3.4..................................... Development Tools
10
Error! Hyperlink reference not valid.4 SAP PO Components
11
Error! Hyperlink reference not valid.4.1................. Enterprise Service Repository
11
Error! Hyperlink reference not valid.4.1.1............. Object Placement with ESR
11
Error! Hyperlink reference not valid.4.1.2.......................... Integration Scenarios
11
Error! Hyperlink reference not valid.4.1.3................................................ Mappings
12
Error! Hyperlink reference not valid.4.1.4.................................................. Lookups
12
Error! Hyperlink reference not valid.4.2.................................... Integration Directory
12
Error! Hyperlink reference not valid.4.2.1....................... Configuration Scenario
12
Error! Hyperlink reference not valid.4.2.2.................... Integrated Configuration
12
Error! Hyperlink reference not valid.4.2.3.................................................. Services
12
Error! Hyperlink reference not valid.4.2.4...................................... Value Mapping
12
Error! Hyperlink reference not valid.4.3...................System Landscape Directory
13
Error! Hyperlink reference not valid.4.4..............Business Process Management
13
Error! Hyperlink reference not valid.4.5......BRM – Business Rule Management
13
Error! Hyperlink reference not valid.4.6.............................. Integration Flow [iFlow]
14

Pixelle Integration
Last update: 22-Feb-2021 Page 4/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Error! Hyperlink reference not valid.5 Naming Convention

15
Error! Hyperlink reference not valid.5.1...................System Landscape Directory
15
Error! Hyperlink reference not valid.5.1.1........................................ SAP Products
15
Error! Hyperlink reference not valid.5.1.2.............................. Non-SAP Products
15
Error! Hyperlink reference not valid.5.1.3.............. SAP Software Components
15
Error! Hyperlink reference not valid.5.1.4.....Non-SAP Software Components
15
Error! Hyperlink reference not valid.5.1.5.............................. Technical Systems
16
Error! Hyperlink reference not valid.5.1.6............................... Business Systems
17
Error! Hyperlink reference not valid.5.1.7.................... Business System Group
17
Error! Hyperlink reference not valid.5.2................................................................... ALE
18
Error! Hyperlink reference not valid.5.2.2............Partner Profile – Non-ABAP
Systems.......................................................................................................... 18
Error! Hyperlink reference not valid.5.2.3........Partner Profile – ABAP system
18
Error! Hyperlink reference not valid.5.3................. Enterprise Service Repository
18
Error! Hyperlink reference not valid.5.3.1......................................... Namespaces
18
Error! Hyperlink reference not valid.5.3.2.......................................... Local SWCV
19
Error! Hyperlink reference not valid.5.3.3..........Process Integration Scenario
Objects 19
Error! Hyperlink reference not valid.5.3.4.................................. Interface Objects
20
Error! Hyperlink reference not valid.5.3.5.................................. Mapping Objects
22
Error! Hyperlink reference not valid.5.4................................................. Configuration
23
Error! Hyperlink reference not valid.5.4.1.................... Configuration Scenarios
23
Error! Hyperlink reference not valid.5.4.2............................... Business Services
24
Error! Hyperlink reference not valid.5.4.3................. Communication Channels
24
Error! Hyperlink reference not valid.5.4.4.................................. Integration Flows
24
Error! Hyperlink reference not valid.5.5........................................... Alert Framework
24
Error! Hyperlink reference not valid.5.5.1............................. Alert Classifications
24
Error! Hyperlink reference not valid.5.5.2.................................... Alert Categories
25

Pixelle Integration
Last update: 22-Feb-2021 Page 5/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Error! Hyperlink reference not valid.6 Transport of Interface

Objects 26
Error! Hyperlink reference not valid.6.1............................................. SAP Module ID
26
Error! Hyperlink reference not valid.7 Monitoring 27
Error! Hyperlink reference not valid.7.1.................................. Monitoring Messages
27
Error! Hyperlink reference not valid.7.2....Monitoring Communication Channels
27

Pixelle Integration
Last update: 22-Feb-2021 Page 6/34
Guideline
SAP PO Development Guidelines and Naming Conventions

1 Overview
The purpose of this document is to make clear standards for all the
elements and processes in the SAP integration environment. In Pixelle
SAP PI system is used as central integration hub. It is the basis for
development of interfaces between SAP applications and ERP systems
as well as between non-SAP applications and the ERP systems. This
document describes development of interface objects on SAP PO with
the goal of maximizing the quality, value and maintainability of the
developed solution.

The scope is to have:

 Consistent naming conventions for SAP PO interface objects
 Rules based on best practices and code optimization principles

1.1 References
Source Topic
Sap note - 856597 SOAP Adapter FAQ
Sap note - 831162 JDBC Adapter FAQ
Sap Note - 1004107 Release Restrictions for SAP
NetWeaver PI 7.1
SAP Note 1039369 Axis Adapter FAQ
http://scn.sap.com/docs/DOC-3832 Do and Donts SAP BPM
Composite Development Architecture
http://scn.sap.com/docs/DOC-3195
Guidelines
http://scn.sap.com/docs/DOC-4601 SAP Netweaver BRM Best Practices
SAP Help on PO, BPM, BRM, iFlow,
http://help.sap.com
Development tools

2 Design Principles
Below are certain general design principles to be followed while doing
development in SAP PI.

 Keep it simple and avoid custom development as much as

possible.
 Do not execute business logic in PI layer, try and cover them in
either the source or target application.

Pixelle Integration
Last update: 22-Feb-2021 Page 7/34
Guideline
SAP PO Development Guidelines and Naming Conventions

 Do not cache information in the PI layer as it may result it non

uniqueness of data at enterprise level.
 Use standard guidelines for any development, in case of
deviation document the same.
 Do not access SAP tables directly.
 Where possible, usernames and passwords should be stored
outside of the XI/PI/PO/BPM configuration (Secure Store
preferable). Passwords must always be encrypted.
 Carry out message transformations as much as possible outside
SAP PI. This is to ensure no business logic gets carried out in the
middleware layer hence reducing visibility.
 IP addresses must never be used in configuration in any
landscape.
 All integration with SAP system should be done using SAP PI to
enable governance.
 Increase reusability with the help of message templates, step
groups and function libraries.
 Use Integration processes only if it is imperative. While using
Integration processes, follow the guidelines given under the
specific section.
 Use Netweaver BPM for defining business process in SAP
Process Orchestration
 Use BRM to ONLY support decision making. Do not pollute rules
with other application logic like calling web services, external
systems or database tables.


3 Guidelines
3.1 Installation Options and Guidelines
Installation
Options Releases Characteristics Recommendation
Process a 1. Dual stack 1. Stateless
Integration (PI) ll(1) installation message processing
2. Design and 2. Stateful
configuration: message
System Landscape orchestration
Directory (SLD), 3. Deploy
Enterprise Service only if want to
Repository &

Pixelle Integration
Last update: 22-Feb-2021 Page 8/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Registry (ESR),
Integration Directory
(ID)
3. Runtimes:
Integration Engine
(IE), Adapter Engine
(AE), Business
Process Engine (BPE)
Monitoring
4. ABAP User
Management leverage ABAP
Environment (UME) engine capabilities

1.
Connectivity: hosts
most of the PI
adapters
Mapping 1.
runtime Deployment either
2. Cannot be centrally as
operated on its own, part of PI server or
i.e., design, as non-
configuration, central option:
Adapter ≤ monitoring , and scaling out, placing
Engine (AE) 7.0x UME via PI in DMZ, etc

Advance ≥ 1. Successor of 1. Run

d Adapter 7.1 AE synchronous
Engine (AAE) 2. Cannot be scenarios in local
(2) operated on its own, processing mode at
i.e., design, faster speed
configuration, 2. Move
monitoring, specific scenarios
3. UME via from PI to AAE for
PI / AEX / PO higher throughput
4. Enhanced to
provide local
message processing

Pixelle Integration
Last update: 22-Feb-2021 Page 9/34
Guideline
SAP PO Development Guidelines and Naming Conventions

bypassing the IE
leading to higher
performance in terms
of throughput and
response time

1. Java-only
standalone
installation
2. Design and
configuration SLD,
ESR, ID
3, Monitoring,
runtime and 1.
connectivity Lightweight
capabilities of AAE integration at lower
Advance
d Adapter 4. No support costs
Engine for integration 2. Like PI, can
Extended ≥ processes be scaled out by
(AEX)(3) 7.3 5. Java UME adding further AAEs

1. Java-only
standalone
installation
2. Co-
installation of AEX
and Business Process
Management (BPM) /
Business Rules
Management (BRM) 1. Deploy as a
3. SLD, ESR, central instance
ID, Message and only; can be scaled
Process Monitoring out by adding
4. Java UME further AAEs
5. Design and 2. Stateless
Process Configuration as and stateful message
Orchestration ≥ plug-in in Eclipse or processing
(PO)(4) 7.31(5) NWDS

Pixelle Integration
Last update: 22-Feb-2021 Page 10/34
Guideline
SAP PO Development Guidelines and Naming Conventions

3.2 General Guidelines

 A description should always be used when creating an object.
 All changes have to be captured in the technical design and
approved.
 All changes have to be made in the DEV system and transported
to other environments.

3.3 Development Guidelines

 All the B2B messages that comes into PO system should be
backed up in windows share drive for future reference and it is
mandated by audit requirements.
 The SAP back up of A2A messages can determined on a case-to-
case basis although it is always a good practice to store the
message that is sent/received from 3rd party systems.
 A2A interfaces must provide a backup feature to allow the
investigation of issues. The type of backup depends on the
adapter.
o IDoc – SAP automatically maintains the history of Idocs
via we02.
o Proxy – SAP automatically maintains the history of Idocs
via SXMB_moni.
o JDBC – Staging or transaction tables that are used as a
source or destination are responsible for maintaining
history of processed messages.
o File – A backup copy of the source file used for mapping
should be stored on the Pixelle file server.
o RFC/BAPI – All RFC/BAPI calls should be wrapped using
a proxy call so that message tracking and
troubleshooting is possible.
 Back up of A2A messages can determined on a case-to-case
basis although it is always a good practice to store the message
that is sent/received from 3rd party systems.
 IDocs, Proxy and RFC/BAPI are preferred mode of message
exchange between SAP PO and SAP systems in that order.
 Java Mapping should always contain “.java” file in the JAR file
when it is exported from NWDS.
 Proxy developments are preferred protocol in cases where
interface design requires a complete custom solution to
exchange messages

Pixelle Integration
Last update: 22-Feb-2021 Page 11/34
Guideline
SAP PO Development Guidelines and Naming Conventions

 Development of custom adapter module is discouraged due to

the challenge of maintainability, but in cases where a custom
adapter module is inevitable, development of such object
should be documented and necessary knowledge transfer
should be planned.
 Exchange of security artifacts like certificates/Public Keys/PGP
keys should be documents in interface repository.
 Standard archive functionlity available in Sender SFTP
communication channels should be avoided, as it poses the risk
of message loss.
 Practice of Creation/Modification of RFC destinations without
Architect‘s approval should be avoided.
 All the UDFs that is part of message mapping must contain a
inline comments describing the intended logic/functionality
 Use dynamic configuration to enable key business document to
appear in the Document Number column in Message Monitoring
and in backup files.

3.4 Development Tools

For PI developers, there are two different set of tools. They are
classified as Swing based tools (traditional) and Eclipse environment
based (NWDS). By now, many of us already know that PI 7.5 offers
enhanced support for developing and configuring PI objects using SAP
Netweaver Developer Studio (NWDS). For Java only installations, SAP
recommends recommendation is to use using NWDS as a development
tool. Both Swing based tools and NWDS use are acceptable in Pixelle’s
environment..

4 SAP PO Components

Pixelle Integration
Last update: 22-Feb-2021 Page 12/34
Guideline
SAP PO Development Guidelines and Naming Conventions

4.1 Enterprise Service Repository

4.1.1 Object Placement with ESR
Objects should be created in ESR using the following guidelines:
 Under each SWCV namespaces will be created as per business area and
interface, all source app interfaces should be placed in its respective
SWCV.
 All target interfaces, transformations and Integration processes should be
created under the SWCV of the target software component.
 The namespaces for a single integration will same under both source and
target SWCVs.
 While doing any tests on maps, a single Local SWCV (XYZ_TESTBED)
should be utilized.
 For common objects like Function libraries, step groups a single SWCV
(COMMON OBJECTS of XYZ) should be used. Suitable dependencies
should be created in SLD to make these objects visible across SWCVs.
4.1.2 Integration Scenarios
 Always use an integration scenario to model the interfaces so that a
holistic view is available for quick understanding of the flow. Use the
naming convention as given under section 8 while creating the objects.
4.1.3 Mappings
The order of preference of mapping is:
 Message mapping (simple maps only);

Pixelle Integration
Last update: 22-Feb-2021 Page 13/34
Guideline
SAP PO Development Guidelines and Naming Conventions

 XSL (no JAVA extensions) if complex structure changes are required.

 XSL (with JAVA extensions) if the data volume is less.
 If the volume of data is very high then go for Java Mapping.

Avoid the use of complex udfs. If required, document them properly

with pseudo-code in the mapping template.
4.1.4 Lookups
 Use graphical lookups provided with PI 7.5 to do RFC/JDBC lookups if
each value from the sender system is unique and needs to be retrived from
the other corresponding system.
 Use lookups in User Defined Function and store value in hash table and
retrieve them to avoid multiple lookups for the same value

4.2 Integration Directory

4.2.1 Configuration Scenario
Configuration scenarios are intended to group configuration objects
and to structure the content of the Integration Directory more clearly.
 Use folders to group the integration between two applications.
 Use scenarios for each integration scenario
4.2.2 Integrated Configuration
Using Integrated Configuration you can specify the complete
configuration settings for the clear exchange of a message in one single
object. This object replaces the 'classic' configuration objects (sender
agreement, receiver determination, interface determination, and
receiver agreements). ICO should be used in case AEX or AAE
installation of PI/PO
4.2.3 Services
When working with a business system/service that is not easily
available or should not be part of a unit testing strategy, a “test” service
should be created to emulate the system.
4.2.4 Value Mapping
Value mapping in the Configuration will be used for less number of
values. Mass value lookup will be used only when the data to be looked
up will be high. For now the fixed value map and value map lookup
through id values will be used on as per the requirement of each
interface.

Pixelle Integration
Last update: 22-Feb-2021 Page 14/34
Guideline
SAP PO Development Guidelines and Naming Conventions

4.3 System Landscape Directory

System landscape directory [SLD] setup depends on client landscape
complexity and architecture. It is recommended that set up one SLD for
all non-production environments and one for production environment.

4.4 Business Process Management

First let's take a quick look at why you might want to use workflow in
the first place:
 Streamline – Automate activity such as approvals to free supervisor time
 Streamline - Assign work to those who can act on it
 Control - Ensure Compliance and speed up audits
 Control - Validate Early (stops errors being unpicked later)

Different options to implement workflow are:

SAP business workflow: SAP Business Workflow is a component of your
SAP ABAP system (ERP. SRM etc) and it is designed to create workflow
within your SAP system.
Integration process in PI: Integration process, also known as ccBPM in
XI/PI/PO. It is used to define integration centric process. Integration
process runs on ABAP stack and supported only by dual stack
installations.
Netweaver BPM in PO: Netweaver BPM is used for defining integration
centric business processes. You can maintain business rules in BRM and
design solution with improved maintainability. It runs on Java stack. It
is available as a part of PO license.

Guidelines for Netweaver BPM design are:

 Ensure there are no more than 25-30 process steps.
 Identify reusable tasks and promote reuse where possible
 Ensure that interfaces are minimalistic with only required input and output
parameters
 Identify tasks that can be clubbed and create single tasks where possible
 Avoid large Data Objects
 Try breaking Data Objects in smaller pieces to avoid unnecessary data
getting loaded in every step
 Avoid persisting the data unless required
 Decouple backend communication using asynchronous service calls

Pixelle Integration
Last update: 22-Feb-2021 Page 15/34
Guideline
SAP PO Development Guidelines and Naming Conventions

4.5 BRM – Business Rule Management

Guidelines for using Rule/Decision table and Rule script in BRM
Rule:
 For simple conditions and actions
 One level condition check
 Create rules with common conditions and reuse them across ruleset
Decision Table:
 To group similar rules which have to be checked for different set of values
and take actions based on the condition values. 
 Use when business users want to use MS-Excel integration with
Import/Export feature to maintain rules
 Split large decision tables into logically related smaller decision tables
 Definition and alias names should be distinct from condition and action
values in DT
 Limit size of decision table to 20,000 rows and 100,000 cells to avoid
performance issues
Rulescript:
 For multilevel (nested) conditions
 For complex calculations
 In scenarios where the business users use SAP NW BRM Rules Manager
extensively for modifying the rules, and the changes to the rules are also
frequently done, then it is better not using RuleScripts or RuleFlows.

4.6 Integration Flow [iFlow]

 Group the integration flows that are logically related to each other in a
scenario using folders
 On deploying an integration flow, corresponding integrated configuration
and its channel objects are generated in the Integration Directory. On
successful deployment, the integrated configuration and channel objects
are activated and updated into the runtime cache.
o Do not edit the generated integrated configuration using the
Integration Builder (swing client) as the changes you make there
are not reflected in the Integration Flow Tool (eclipse client).
o Do not to modify the channels of the integration flow in the
Integration Builder (swing client) and refer them in integrated
configurations.

Pixelle Integration
Last update: 22-Feb-2021 Page 16/34
Guideline
SAP PO Development Guidelines and Naming Conventions

5 Naming Convention
5.1System Landscape Directory
5.1.1 SAP Products
 No changes will be made to SAP products.
5.1.2 Non-SAP Products

<Company>_<Business Application> (Max. Length 30 Characters)

Company Specify a string naming the company

_ Separator
Business Internal terminology of the application for example
Application “OTCSD” or “RTRFI”

Example: PXL_RTRFI, PXL_OTCSD

5.1.2.1 Product Vendor

<URL of company>

URL of Use lower case letters and shortened version of URL

company (e.g. “pixelle.com”)

5.1.2.2 Product Version

<Product version>

Product Enter the product version in shortened form (e.g. 9i for

version Oracle 9i).

5.1.3 SAP Software Components

No changes will be made to SAP Software components

5.1.4 Non-SAP Software Components

We follow creating three software components for interface

development process, one for sender application’s interface objects,
another for receiver application’ and the third SWC should be used for
Mapping
 Will be same as the product if there is only one software
component. If there are multiple software components within

Pixelle Integration
Last update: 22-Feb-2021 Page 17/34
Guideline
SAP PO Development Guidelines and Naming Conventions

the ProductProduct, then the following convention needs to be

used.

5.1.4.1 Name
<Company that owns the license for the software>_<Type of
application>_<Product or Component Name> (Name must be in
capital letters and be less than 30 characters)

Company that For example PXL for PXL applications.

owns the
license for the
software
Type of Internal terminology of the application
application
_ Separator

Example: PXL_HTRHR, PXL_OTCSD

5.1.4.2 Vendor
<URL of software vendor company>

URL of software Use lower case letters and shortened version of

vendor URL (e.g. “pixelle.com”)
company

5.1.4.3 Software Component Version

<Software Component Version>

Product  Enter the product version in shortened form

Version (e.g. 9i for Oracle 9i).

5.1.5 Technical Systems

5.1.5.1 Web AS ABAP or Web AS Java

 Technical system naming convention applies only to non-SAP
system, SAP technical systems are registered at SLD
automatically via SLD data supplier.

Pixelle Integration
Last update: 22-Feb-2021 Page 18/34
Guideline
SAP PO Development Guidelines and Naming Conventions

5.1.5.2 Standalone Java Systems and Third

PartyThird-Party Systems

<Location | Organizational Area>?<Business Application>

Location Specify the geographical area the system is located

in
Organizational Specify the business unit the system is assigned to
Area
| Separator
Business Specify your actual business application or usage of
Application the system

Example:EUProcurementSystem, BillingSystem

5.1.6 Business Systems

5.1.6.1 SAP Business Systems

<SAP system ID>CLNT<Client Number>

SAP system ID Three letter SAP system ID that uniquely defines

SAP backend system
Client Number Client number of the backend system that is used
for the integration

Example: SBXCLNT100 , ERPCLNT100, SBXCLNT100

5.1.6.2 Non-SAP Business Systems

<Location | Organizational Area>?<Business Application>_<Stage>

Location Specify the geographical area the system is located

in
Organizational Specify the business unit the system is assigned to
Area
_ Separator
Business Specify your actual business application or usage of
Application the system
Stage D|Q|P|T

Example: BusinessUnitLiquidsFinance_D, MDMServer_P

Pixelle Integration
Last update: 22-Feb-2021 Page 19/34
Guideline
SAP PO Development Guidelines and Naming Conventions

5.1.7 Business System Group

<Group Description>_<Stage>
Group Use description that defines the collection of
Description business systems
_ Separator
Stage D|Q|P|T

5.2 ALE
5.2.1 RFC
<SID>CLNT<Clnt>
SID if the aim to create a partner profile in ECC, to send
an Idoc to HCM system then SID of HCM should be
used.
Clnt Client number of the partner system

For example E1DCLNT001

5.2.2 Partner Profile – Non-ABAP Systems
<SystemNameAbrv>
SystemNameAb Use a descriptive abbreviation for the system name
rv for which the Partner profile is being created

5.2.3 Partner Profile – ABAP system

<SID>CLNT<Clnt>
SID if the aim to create a partner profile in ECC, to send
an Idoc to HCM system then SID of HCM should be
used.
Clnt Client number of the partner system

5.3 Enterprise Service Repository

5.3.1 Namespaces
http://<Company URNL>/:<Process Level3rd Party
Reference>:/(<Further Level>:)*<Application<BP Name>

Company URLN Use the url of the company who owns the software.

Pixelle Integration
Last update: 22-Feb-2021 Page 20/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Third Party Name/Reference of the third party system that is to

ReferenceProce be integratedFI (Finance), CPL (Contracts,
ss Level Procurement & Logistics) PMPS (Plant Maintenance
& Project Systems)
/ Separator
BP Easily understandable business process nameAn
NameApplicati abbreviated reference to the SWC.
on

Example:
http://pixelle.com/ERP/Finance/Accountinghttp://pixelle.com/Ver
itiv/OrderAck, http://pixelle.com/AveryDennison/Invoice,
http://pixelle.com/Dayforce/EmployeeImport

5.3.2 Local SWCV

A single local SWCV will be created for map test purposes. If at any
point of time a local SWCV is required to hold the objects of a SLD
defined SWCV, a new local SWCV will be created. For test purposes
SWCV “TESTBED” should be used.

5.3.3 Process Integration Scenario Objects

5.3.3.1 Process Integration Scenario

 The integration scenario should always be used to define the overall

integration process.
 For integration scenarios, self-explanatory names in terms and non-
technical names should be used.
 Example: AddressDataDistribution

5.3.3.2 Action
<Action with direction><Object>_<abbreviation of SWCV to which
the related message interface belongs>_<[BPM]>

Action The action being carried upon the object.

Object The business object being acted upon
_ Separator

Example: SendConfirmation_Order

5.3.3.3 Integration Process

<Object><Action>

Pixelle Integration
Last update: 22-Feb-2021 Page 21/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Action The action being carried upon the object.

Object The business object being acted upon

Example: OrderReceive

5.3.3.4 Step Group

<Description>

Description Descriptive name to define the function accomplished

by the step group.

Example: SplitMessages

The latest version of BPM offers the use of user intervention. These
guidelines will be updated as and when such a scenario is identified in
the landscape.

5.3.4 Interface Objects

5.3.4.1 Service Interface

<Business Object><Activity>_<Mode>_<Direction or type>

Business If the Service Interface contains multiple operations

Object then use a description which groups all operation
functions for example “ManageVendor”. In other cases
use a name representative if the business data, for
example “VendorDetails”
Activity Specify a more generic interaction activity, Create|
Change|Query|Delete|Confirmation|Request|Read|
Notification
_ Separator
Mode Async|Sync, use either one of the possible values to
indicate whether the service interface is Synchronous or
Asynchronous. Do not use this for multiple operation
Service Interfaces.
Direction Use inbound(In), outbound(Out) or abstract(ABS)
or Type depending upon the type of Service Interface.

Example: VendorCreation_Async_In, SalesOrderCreate_Async_In

5.3.4.2 Operation
<Action><Object>

Pixelle Integration
Last update: 22-Feb-2021 Page 22/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Action Use a verb to indicate what action is to be performed on

the object.
Object Provide a business object name

Example: ReadVendor, CreateVendor etc

5.3.4.3 Message Type

<Business Object><Action><Message Type Category>

Business Specify the underlying business object representing

Object business content.
Action Create | Change | Update | Cancel | Maintain | Modify |
Delete | Read | <Other>
Category Notification | Request | Confirmation | Query | Response
| <Other>

Example: VendorCreateRequest, SalesOrderCreateRequest

5.3.4.4 Data Type

<Business Object>
Business Specify the underlying business object representing
Object business content.

Example: Vendor, BusinessPartner

5.3.4.5 Data Type Enhancement

<Basis Data Type Name><Description | Area>

Basis Data Specify the data type the data type enhancement is
Type based on.
Description Describe the kind of enhancement
Area Describe the area that needs the enhancement
| Separator

Example: AddressExtended4Banking

5.3.4.6 External Definition

<Business Object | Message Type>

Pixelle Integration
Last update: 22-Feb-2021 Page 23/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Business Specify the underlying business object representing

Object business content
Description Describe the kind of enhancement
Area Describe the area that needs the enhancement
| Separator

Example: LoanContract, PORequest

5.3.5 Mapping Objects

5.3.5.1 Operation Mapping

<Source Service Interface>?<Source Service
Operation>_to_<Target Service Interface>?<Target Service
Operation> (_multi)

Service Specify the service interface name omitting

Interface direction
Service Specify the service operation name omitting mode
Operation
_ Separator

Example: MaterialMasterCreateRequest_to_MATMAS_MATMAS03

5.3.5.2 Message Mapping

<Source Message Type>_to_<Target Message Type>(_Multi)

Source Message Name of source message type

Type
Target Message Name of target message type
Type
_ Separator

Example: MaterialMasterCreateRequest_to_MATMAS_MATMAS03

5.3.5.3 Imported Archive

<Source Message Type>_to_<Target Message Type>_<Technology>

Pixelle Integration
Last update: 22-Feb-2021 Page 24/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Source Message Name of source message type

Type
Technology XSLT|JAVA
_ Separator

5.3.5.4 Function Library

Use a function library within an SWCV to contain all udf requirements
within that particular SWCV. For naming the function libraries use
business relevant name for the SWCV.

Utilize a generic library defined within a common SWCV and refer it

using usage dependency.

5.3.5.5 Mapping Template

<Source Message Type>_to_<Target Message Type>_Template

Source Message Name of source message type

Type
Target Message Name of target message type
Type
_ Separator

Example:MaterialMasterCreateRequest_to_MATMAS_MATMAS03_T
emplate

5.3.5.6 Java Developments

For Java package naming and class naming follow standard open source
guidelines.
Package naming for packages developed for XI/PI/PO:

<Reverse DNS>/<Function Grouping>/<Function>

Reverse DNS Follow the reverse dns standard for creating the
package structure. For example com.XYZ.pi
Function If the package contains a group of classes provide
Grouping the functional grouping for example – For some
Vendor specific mappings provide the VendorName
/ Separator
Function The function carried out by the package in general

Example: com.XYZ.pi.VendorXYZ.Invoices

Pixelle Integration
Last update: 22-Feb-2021 Page 25/34
Guideline
SAP PO Development Guidelines and Naming Conventions

In case of third party packages retain their package structure and

convention

5.4 Configuration
5.4.1 Configuration Scenarios
<BusinessApplication>_<Description>_<SenderSystem>To<Receiv
erSystem>

Business Internal terminology of the application

Application
Description Description of the interface along with action that is
performed
_ Separator
Sender System Origination business system name
Receiver Destination business system Name
System

Configuration scenarios correspond to the role of integration scenarios

in the Enterprise Services Repository and the naming standards of
configuration scenarios will correlate exactly with the naming
standards of integration processes.
• Configuration Scenario Naming convention identical to
Integration Scenario Naming Conventions
• Configuration Scenarios do not have any environment specific
standards as they are identical in all landscapes (Dev, Test, QA,
Production)

Example: RTRFI_Payments_ERPToCitizensBank,
OTCSD_SalesOrderCreate_VeritivToERPPurchaseOrdersOutbound

5.4.2Business Services
<Type>_<Description>

Type For Business Service use the prefix SERVICE. For

integration Services use the prefix INTEGRATION
Description should be descriptive of the relevant application
_ Separator

Pixelle Integration
Last update: 22-Feb-2021 Page 26/34
Guideline
SAP PO Development Guidelines and Naming Conventions

5.4.3 Communication Channels

<Adapter Type>_<Transport/Message
Protocol>_<Direction><Object | Description>

Adapter The type of adapter –FILE, SOAP etc.

Type
Transport  : Protocol which will be used for the
Protocol communication – XI, HTTP, AXIS etc

_ Separator
Direction Sender|Receiver
Description Meaningful description to describe the communication
channel or to differentiate various communication
channels if there are multiple channels.

Example: IDOC_XML_Sender, SOAP_HTTP_Receiver_ServiceOrder

5.4.4 Integration Flows

Every integration flow has a unique ID of maximum 32 characters

5.5 Alert Framework

5.5.1 Alert Classifications

<Business area>_<Description>[_<Multiple differentiator>]

Business Use the defined business areas

area
Description A meaningful name switching between uppercase and
lowercase characters to separate individual words. This
could be a project name, or a source system grouping.
This must correspond to the SCENARIO name defined in
the ID.
_ Separator

Examples:
FI_ALERT_RULE – Finance
MFG_ALERT_RULE - Manufacturing
SD_ALERT_RULE – Order Management
CPL_Lookups

Pixelle Integration
Last update: 22-Feb-2021 Page 27/34
Guideline
SAP PO Development Guidelines and Naming Conventions

5.5.2 Alert Categories

A minimum of three ALERT CATEGORIES must be defined per
corresponding SCENARIO; this to cover APPLICATION, SYSTEM and
ADAPTER errors.

<Business area>_<Description>[_<Multiple differentiator>]

Business Use the defined business areas

area
Description A meaningful name switching between uppercase and
lowercase characters to separate individual words. This
could be an interface name, or a source system
grouping.
_ Separator

5.5.3 Availability Time Planning

ATP naming convention should follow these guidelines

<DayIdentifier>_<TimeZone><TimeIdentifier>

DayIdentifi Daily Schedules – Day identifier could be Days of week

er for specific days, specific weekdays or range of days in
case of Daily Schedules.
Weekly Schedules – Set to run once a week on a specific
day of a week.
_ Separator
TimeZone Placeholder to define Timezone in which the
communication channel is set to run using ATP
TimeIdenti Could be specific time or a range with start and end time
fier
Examples:
MonThruSat_ET00To24
Weekdays_ET0750
Sun_ET00To05

Pixelle Integration
Last update: 22-Feb-2021 Page 28/34
Guideline
SAP PO Development Guidelines and Naming Conventions

6 Transport of Interface Objects

Transport requests are created manually.
Descriptions should have the following rules.
<Project>/<Type>/<Module ID>/<Jira ID>/XXXX…

<Project> 3 FUS – Fusion

Chars
/ Separator
<Type> 1 Char W – Workbench
/ Separator
<Module ID> (2 SAP Module id
Char) (Refer to Module ID List 6.1)
/ Separator
XXXX… Free Text

6.1 SAP Module ID

The following abbreviations for Business Functions/SAP Modules are
used in the following:

AP Advanced Planner and Optimizer (APO)

BC Basis
CA Cross Application
DP Demand Planning and Supply Network Planning
FI Financial Accounting
HR Human Resource
IM Inventory Management
MD Master Data
MM Materials Management
PP Production Planning
SD Sales and Distribution
WM Warehouse Management
QM Quality Management
EH Environmental, Health & Safety Management
CO Controlling
LE Logistics Execution
PM Plant Maintenance
PS Project System
GT Global Trade System
BI BW/BI Business Information Warehousing

Pixelle Integration
Last update: 22-Feb-2021 Page 29/34
Guideline
SAP PO Development Guidelines and Naming Conventions

7 Monitoring
7.1 Monitoring Messages
With the message monitor in SAP NetWeaver Administrator, you can
monitor the processing of messages on the local Advanced Adapter
Engine. User can use message monitoring in the following cases:
 To create an overview of message processing. Message overview gives
you an overview of message processing as well as two different modes for
searching for messages.
 To track the status of messages.
 To find errors that have occurred and to establish what caused them.
User can also search for messages that were persisted in the database,
or for messages that have already been archived.

7.2 Monitoring Communication Channels

With the communication channel monitor user can obtain information
about communication channels that are set up for the Advanced
Adapter Engine. User can also perform some administrative activities.
Consider that if the Advanced Adapter Engine runs on a server cluster,
the communication channels comprise multiple instances for the
various cluster nodes.

7.3 Monitoring IDoc Adapter

7.3.1 Displaying IDoc Message

User can use the IDoc monitor when he needs information about the
messages processed with the IDoc adapter available on AS Java. Using
the message monitor user can search for IDoc messages processed with
the IDoc adapter on the Advanced Adapter Engine. You can add various
IDoc parameters to the search criteria to find only those messages in
which you are interested.

7.3.2 IDoc Metadata Maintenance

By default Idoc metadata is loaded automatically. User can chose to load

them manually if user wishes to reload/delete the existing metadata, if
the Idoc structure is modified in the backend ABAP system. This would
eventually force the PO system to load the active version of metadata
from the backend system.

Pixelle Integration
Last update: 22-Feb-2021 Page 30/34
Guideline
SAP PO Development Guidelines and Naming Conventions

7.4 Performance Monitor

When user want to obtain statistical data about the performance of
message processing in the Adapter Engine and Integration Engine, user
can use the performance monitor. Within this monitor, the performance
is gauged by measuring the amount of bytes processed over a given
time period.
The performance details provided by the monitor are useful for
administrators who need to know the amount of time spent by
messages at various points of their life cycle. These points (known as
measuring points) are at the following stages of message processing:

7.4.1 Measuring points of Adapter Engine

Stage Name Description
MS:stage:SI Virus scan inbound
MS:stage:BI Before Inbound XML Validation
MS:stage:VI After Inbound XML Validation
MS:stage:MS After Receiver Determination
MS:Message_Put_In_Store Persist the message to the database
MS:Message_Put_In_Disp_ Put the message in the dispatcher queue
Queue
MS:Message_Wait_In_Disp Waiting time in the dispatcher queue
_Queue
MS:Message_Put_In_Queu Put the message in the processing queue
e
MS:Message_Wait_In_Que Waiting time in the processing queue
ue
MS:Message_Update_Statu Update the message status and persist the new
s status into the DB
MS:stage:AM After Mapping execution
MS:stage:SO Virus Scan Outbound
MS:stage:VO After Outbound XML Validation
MS:stage:AT End of transport processing block. End of
messaging system processing and hand-over to
adapter.

7.4.2 Local Integration Server (Sender)

Step Name Description
PROXY_OUTBOUND_CREAT Creation of Proxy Framework instance, begin
E of Outbound Call
PROXY_OUTBOUND_METH Execution of Outbound Proxy Method
OD
PROXY_OUTBOUND_RENDE Process Payload of Outbound Request
R

Pixelle Integration
Last update: 22-Feb-2021 Page 31/34
Guideline
SAP PO Development Guidelines and Naming Conventions

PROXY_OUTBOUND_XMBC Call Local Integration

ALL
PROXY_OUTBOUND_PARSE Process Payload of Outbound Response
PROXY_OUTBOUND_COMPL Execution of Outbound Proxy Complete (Not
ETE Part of Performance Header, Visible in
Database and Runtime Workbench)
PLSRV_CALL_INTEGRATIO Pipeline Service: Call Central Integration
N_SERVER Server
IE_COMPLETE Execution of Integration Engine Complete
(Not Part of Performance Header, Visible in
Database and Runtime Workbench)

7.4.3 Local Integration Server (Receiver)

Step Name Description
PLSRV_CALL_INBOUND_P Pipeline Service: Call Inbound Proxy
ROXY
PROXY_INBOUND_METHO Execution of Inbound Proxy Method
D
PROXY_INBOUND_PARSE Process Payload of Inbound Request
PROXY_INBOUND_APPLM Execution of Application Coding
ETH
PROXY_INBOUND_RENDE Process Payload of Inbound Response
R

7.5 Cache Monitor

Cache monitor is used to display objects that are currently in the
runtime cache of the Advanced Adapter Engine and the Mapping
Runtime. User can enter selection criteria to search for current objects
in the runtime cache, and review the details of a selected object.
Mapping Runtime Cache, can be used to monitor the value mapping
replication values that are present in the system cache based on the
value mapping context.

Pixelle Integration
Last update: 22-Feb-2021 Page 32/34
Guideline
SAP PO Development Guidelines and Naming Conventions

8 Annexure
8.1 Business Applications Abbreviations
The fFollowing abbreviations are referred to in this document
whenever a business application is used to identify to identify
SAPPixelle’s Fusion Project application areas: application area

PTP Procure to Pay

STP Source to Pay
OTC Order to Cash
QTC Quotation to Cash
CTC Contract to Cash
ATO Assemble to Order
MTO Make to Order
PTM Plan to Manufacture
HTR Hire to Retire
RTR Record to Report
ATR Accounting to Reporting

DF Demand Forecasting
FI Finance
HR Human Resources
LE Shipping and Load Planning
MFG Manufacturing
MM Procurement
PM Plant Maintenance
PP Production Planning
QM Quality Management
SD Order Management

Pixelle Integration
Last update: 22-Feb-2021 Page 33/34
Guideline
SAP PO Development Guidelines and Naming Conventions

Pixelle Integration
Last update: 22-Feb-2021 Page 34/34
Guideline