Beruflich Dokumente
Kultur Dokumente
Development/Support
Standards
And
Guidelines
xx Project Name xx
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Document Information
Revision: 2002/01/10 19:21 a1/p1
File Name: /var/www/apps/conversion/tmp/scratch_1/207031948.doc
_____________________________________________________________________________
Page 2 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Table of Contents
1 GS1 SYSTEM ENVIRONMENT.........................................................................................................................4
1.1 SAP GUI...................................................................................................................................................... 4
1.2 SAP SERVERS............................................................................................................................................... 4
1.3 CLIENT STRATEGY........................................................................................................................................ 4
1.4 DEVELOPMENT CLASS .................................................................................................................................. 5
2 CONVENTIONS FOR DEVELOPMENT AND CHANGES TO SAP PROGRAMS .....................................6
2.1 GENERAL GUIDELINES ................................................................................................................................. 6
2.2 CONVENTIONS FOR CHANGES TO SAP PROGRAMS USING SAP USER EXITS.....................................................6
2.3 CONVENTIONS FOR CHANGES TO SAP PROGRAMS USING SAP MODIFICATION ASSISTANT...............................6
2.4 CONVENTIONS FOR CHANGES TO SAP PROGRAMS USING BUSINESS ADD-INS..................................................7
2.5 CONVENTIONS FOR CHANGES TO SAP OSS NOTES........................................................................................7
2.6 DOCUMENTING CODE CHANGES .................................................................................................................. 8
3 PROGRAM SPECIFICATION................................................................................................................................9
4 NAMING CONVENTIONS....................................................................................................................................10
4.1 DESIGN SPECIFICATIONS............................................................................................................................. 10
4.2 PROGRAM NAMES ...................................................................................................................................... 10
4.2.1 Abap Program Names:..............................................................................................................................10
4.2.2 ABAP Function Names..............................................................................................................................11
4.2.3 Table Names..............................................................................................................................................11
4.2.4 Transaction Codes.....................................................................................................................................11
4.2.5 General Naming conventions for other SAP objects ...............................................................................12
5 IMG CONFIGURATION DOCUMENTATION.................................................................................................16
5.1 TRANSPORT REQUESTS................................................................................................................................ 16
5.2 MENU PATH............................................................................................................................................... 16
5.3 USE OF IMG TO DOCUMENT CONFIGURATION............................................................................................. 16
6 DEVELOPMENT KEY / SAP OBJECT REGISTRATION..............................................................................17
7 MANAGING DEVELOPMENT CHANGES.......................................................................................................18
7.1 STEPS TO MANAGE DEVELOPMENT CHANGES..............................................................................................18
7.2 NOTES........................................................................................................................................................ 18
8 OTHER TOPICS.....................................................................................................................................................19
_____________________________________________________________________________
Page 3 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
gs1hap1p,
gs1hap2p,
gs1hap3p
gs1hdb1p)
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Standard is client: 010.
For setting other client, please follow the specification in
\\CLIENTTCHDAT01\DFS\CLIENT\System Optimization Project\SOP Team
Documents\Standards\04_Client_Strategy_V1.doc
_____________________________________________________________________________
Page 5 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
2.2 Conventions for changes to SAP programs using SAP User Exits
To change a SAP program or module , you are advised to use sap provided USER EXITS, if a
user exit does not exist, you can request SAP to develop an user exit for you via OSS .
Types of user exits:
.
Menu exit
Screen exit
Function Module exit
Keyword exit
There are two ways to search an application user exit:
Workbench Menu ->Utilities -> Enhancements -> Project Management
Utilities -> SAP Enhancements (SMOD)
Workbench Menu ->Overview -> Appli Hierarchy -> SAP
Note: An add-on project must be created in order to take advantage of the user exits as follows:
Workbench Menu ->Utilities -> Enhancements -> Project Management (CMOD)
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Hints:
SE95, the Modification browser provides a system-wide overview for all the changes that you
have made.
Investigate the program using the Modification mode off, and turn it on when you are ready to
make the changes, The SAP keeps a repository for all the changes by the Modification Assistant.
Modifications using this method can be generally be re-imported during a release upgrade without
manual intervention.
If the SAP module or report program requires mass changes, the Modification Assistant may not
be a good approach.
In this case the SAP program is not modified directly but a copy is made renaming the program by
inserting the lead character with Z. Any modified include modules or Sapscripts are similarly
copied.
Note: Previous registered SAP objects need to be registered again in 4.6.
*************************************************************************
*
Module heading
*
___________
*
* Date
OSS Note no/Transport No
Initial
_____________________________________________________________________________
Page 7 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
* _______ Reason_______ ______________________________________________
*
* 970112 OSS 42212/ GSSK900010 - VC
*
General Task List assembly
************************************************************************
Documenting Code Body:
Above or every line changed due to the respective OSS note enter the OSS no/Transport no.
e.g. OSS 42212/GSSK90011
_____________________________________________________________________________
Page 8 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
3 Program specification
The GS1 project will use the standard development templates for all development work.
They are located in \System Optimization Project\SOP Team Documents\TEMPLATES
Document Type
Conversion
Dialog Programs
Interface Programs
Report
Enhancements
Data Conversion Plan
Template
GS1 Conversion Specification
GS1 Dialog Specification
GS1 Interface Specification
GS1 Report Specification
GS1 SAP Modification and Enhancement
GS1 Conversion Execution Plan
_____________________________________________________________________________
Page 9 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
4 Naming Conventions
4.1 Design Specifications
Design Specification Names
Design document names should be patterned with the following convention:
XX_DDDD_NN
Where XX denotes the SAP Applications Area
BC
Basis area, not application specific
HR
Human Resources
PM
Plant Maintenance
PS
Project Systems
MM
Material management
FI
Finance
CO
Controlling
MM
Materials Management
AP
Accounts Payable
AR
Accounts Receivable
EH
Environment & Health Safety
Where DDDD denotes the type of Design specification:
CONV
Data Conversion
REP
Report
DIA
Dialog
INT
Interface
MOD
Modification
FCT
Function Module
AUTH
Authorization
CLSS
Classes (including attributes, methods, etc.)
NN
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
ZZ
denotes customer program
XX
denotes the module area (i.e. FI for Finance, etc.)
25 chars
underscore + descriptive name for module name
XX generally used to denote the module, as follows:
FI
Finance
CO
Controlling
PS
Project System
HR
Human resources
PM
Plant Maintenance
MM Material Management
CA
Cross Application
AP
Accounts Payable
AR
Accounts Receivable
FA
Fixed Assets
EH
Environment & Health Safety
4.2.2 ABAP Function Names
Function are used to centralize reusable code. The naming conventions for
Functions are very free-form, but should adhere to the basic structure as follows:
ZXX_[Module Name], where
Z
denotes customer program
XX
denotes the module area (i.e. FI for Finance, etc.)
27 chars
underscore + descriptive name for module name
Note: Function class should be chosen appropriately and recorded.
Example: ZBC_Last_Day_of_Acc_Period
4.2.3 Table Names
Table names are restricted to 16 characters and should adhere to the following
convention:
ZZXX_description(12), where
ZZ
XX
12 chars
Note: If the table is EDI specific, EDI should be mentioned in the descriptive
comments.
4.2.4 Transaction Codes
Transaction codes are used to identify screens within the SAP system. Each
screen has an associated transaction code which relates to an ABAP program..
Transaction codes are 20 characters long, and should use the folowing naming
convention:
_____________________________________________________________________________
Page 11 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
ZXXdescription(17) , where:
ZZ
denotes a customer defined table
XX
denotes the module area (i.e. FI for Finance)
17 chars
description of the table
4.2.5 General Naming conventions for other SAP objects
This section provides an overview table of customer name ranges. This table shows:
the name lengths
SAP table where appropriate
Proposed naming standard
4.6 Upgrade or comment
All objects should be encoded with the lead character Z.
SAP Naming Conventions
Object
Application log - TAPPL
Object
Subobject
Authorization/authorization profile
Authorization object
Authorization object class
Authorization object group
CATT procedure
Change document object
Class
Length
4
10
12
10
4
30
30
10
30
Code page
Data element
Development class tdevc
4
30
30
Dialog module
Documentation module
Authorization object
Authorization profile
Chapter in a structure (CHAP)
Description of a CATT procedure
Dialog text
General text (TX)
Implementation Guide chapter
Main chapter in a structure (BOOK)
Note on chapter in a structure (NOTE)
Release Notes
30
10
12
20
20
28
28
20
20
26
20
12
_____________________________________________________________________________
Page 12 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Object
Length
Customer name range
Structure
Domain
30
Z*
Enhancement
8
ZXX*
Enhancement project
8
ZXX*
Enterprise Data Model (EDM)
10
Z*
Data model
10
Z*
Entity
Function Builder
30
Z_*
Function module - TLIBG, TLIBV,
26
ZXX_*
TLIBT, TFDIR
4
Z*
Function group - TFDIR
4
*
User exit function module
User exit function module (customerspecific)
IDoc development
27
Z1*
Segment type
30
Z2*
Segment name
30
Z*
Basic IDoc type
30
*
Enhancement type
30
*
Logical message
Info type number
4
9000 - 9999
Interface
30
Z**
(underscore permitted)
LIS (Logistics Information System)
2
Z*
Event
2
Z*
Unit
Lock object
16
EZ*
Logical database
20
ZXX_*
Maintenance and transport object
31
ZXX*
Matchcode
1
0-9
Matchcode ID
4
Z*
Matchcode object
Menu
20
Z* +*
Message - T100A
20
Z*
Message ID
3
900 - 999
Message number
Module pool - TRDIR
30
SAPDZ*
Module pool for dialog
30
DZ*
INCLUDES
8/40
SAPMZ*
Module pool for screens
30
MZ*
INCLUDES
30
MP9*
Module pool for info types
30
MP9*
INCLUDES
30
SAPFZ*
Module pool for subroutines
30
FZ*
INCLUDES
30
SAPUZ*
Module pool for update program
30
UZ*
INCLUDES
_____________________________________________________________________________
Page 13 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Object
Length
Customer name range
Number range document object
10
ZXX_*
Pool name/cluster name
10
ZXX_*
Printer macro
Z* 9*
R/3 Analyzer: Identifier
20
ZXX_*
Relation ID
2
Z*
Report TRDIR
30
Z*
Report category
4
Z*
Report variant
14
X* CUS&*
Transportable, global
14
Transportable, local
1
Z*
Not transportable
Report Writer
8
1st place not numeric (0-9)
Report
4
1st place not numeric (0-9)
Report group
3
1st place not numeric (0-9)
Library
7
1st place not numeric (0-9)
Standard layout
SAPscript
16
ZXX_*
Form
4
ZZ*
Standard text ID
32
ZXX_*
Standard text name
8
Z*
Style
Screen
4
9000 - 9999
????
If the screen does not belong to a
module pool in the customer name
range.
Set
12
1st place not numeric
SPA/GPA parameter
20
ZXX_*
Spool
16
ZXX_*
Layout type
8
Z*
Font family
8
Z*
Device type
8
Z*
Page format
8
Z*
System barcode
Standard role
8
9*
Standard task
8
9*
Structures/structure fields
30
Z*
SYSLOG message ID
2
Z*
Table
10
ZZXX_* T9* P9* PA9* PB9*
Pool and cluster tables
16/30
PS9* PT9* HRT9* HRP9*
Transparent tables
16
HRI9*
Table field
ZZ_* (if possible in append)
Z*
Transaction code
20
ZXX_* +*
Transport layer
4
Continue to use Z001
Type (ABAP)
5
Z*
View
16/30
ZXX_*
Help view
16/30
H_Z*
_____________________________________________________________________________
Page 14 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Object
Length
Customer name range
View cluster
30
ZXX_*
View maintenance data
reserved in TRESC
View content
reserved in TRESC
Table content
Workflow object type
10
ZXX_*
*
A
_
9
XX
Free format
Alphanumeric
Underscore
Numeric
Module ID;
HR, MM, etc
_____________________________________________________________________________
Page 15 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
_____________________________________________________________________________
Page 16 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
_____________________________________________________________________________
Page 17 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
Who
Develop programs
Project/Team
Leads
Project/Team
Leads
Developers
Developers
QA Testing
XXXX
Team
leads/Users
XXXX
Work Assignment
Action
Review an SR and assign user status
'V' when done
Assign Work in SR and change SR
user status to 'APP'
Create Transport request with
proper objects and update SR user
status to 'D'
Update SR user status to Q
Transport the transport request to
QA and update SR user status to 'T'
Update SR user status to 'P'
Update SR user status to 'A_PR'
7.2 Notes
All Change Requests will be transported on a Monthly basic except for emergency transport
In the text of the Change Request, please describe the contents of the change request, prefixed by
the module name XX (see below). This will assist in tracking transport requests later on in the
project.
XX generally used to denote the module, as follows:
FI
Finance
CO
Controlling
PS
Project System
HR
Human resources
PM
Plant Maintenance
MM Material Management
CA
Cross Application
AP
Accounts Payable
AR
Accounts Receivable
EH
Environment & Health Safety
What to include in a change request? A general rule of thumb is to group together all
configuration or development that are logically related to a task. The recommended method is to
create smaller units of work ( a week or less) in a change request release them after successful
unit testing. With smaller change requests, it will be easier to find specific configuration changes
later in the project.
_____________________________________________________________________________
Page 18 of 19
xxx
SAP Development/Support Standards and Guidelines
_____________________________________________________________________________
8 Other Topics
To be developed as required
_____________________________________________________________________________
Page 19 of 19