Manual

TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:
DATA:
REVISO:

EMITENTE:

APROVAO:

ANALISTAS DE SISTEMAS

GERENTE TCNICO DE IMPLANTAO SAP

HISTRICO DE ALTERAES
NATUREZA DA ALTERAO

DATA

(*) NECESSIDADE DE NOVO TREINAMENTO

RE-TREINAMENTO (*)

1/9

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:
DATA:
REVISO:

SUMRIO
1 OBJETIVO
2 APLICAO
3 CONDIES GERAIS
3.2 Cabealho do programa
3.3 Hierarquia de declarao dentro do SAP
3.4 Nomenclatura
3.5 Programa
3.6 Tela
3.7 Status Gui e Ttulos Gui
3.8 Include
3.9 Transao
3.10 Mdulo de dilogo
3.11 Implementao de BADI
3.12 Objeto de autorizao
3.13 Classe de objetos
3.14 Aplicao BSP
3.15 Menu de rea
3.16 Objetos do Dicionrio
3.17 Grupo de funo
3.18 Classe de desenvolvimento e classe de mensagem
3.19 Objetos utilizados no programa
3.20 Relao de nomenclatura para consulta rpida
3.21 Template de Report

2/9

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:

3/9

DATA:
REVISO:

1 OBJETIVO
Definir padres de metodologia e nomenclatura a serem utilizados no desenvolvimento de
objetos ABAP/4, no sentido de obter um produto final com qualidade.
2 APLICAO
Todos os Consultores Tcnicos NewCom.
3 CONDIES GERAIS
A aplicao das diretrizes contidas neste documento de responsabilidade de cada
Consultor Tcnico.
Sero fornecidos esclarecimentos e modelos de documentos formais necessrios ao
acompanhamento e documentao das atividades a serem seguidas pela equipe.
Importante: Nunca comece a desenvolver ou alterar um objeto sem antes de ter em
mos as seguintes informaes:
Especificao Tcnica;
Classe de Desenvolvimento;
Request;
Task.
3.2 Cabealho do programa
a) Incluir na documentao bsica do programa, a descrio breve que estar
disponvel na especificao.
b) importante informar alteraes realizadas nos cdigos, com data, solicitante e
responsvel pela alterao, e sempre que possvel o detalhamento da mesma.
c) A padronizao no que se refere aos comentrios adicionados ao cdigo ABAP,
prima pela objetividade.
************************************************************************
* Online SAPMZBNWDO037
*
************************************************************************
* MODULO
: SD
*
Mdulo
* PROGRAMA
: SAPMZNWDO037
*
Programa
Ttulo
* TITULO
: Vendas via Internet - Operaes com Ordem de Vendas
*
Tipo
* TIPO PROG : Online
* Programa
Solicitante
* SOLICITANTE: RODRIGO PINCA
*
Desenvolvido
por
* AUTOR(A)
: TANCREDO NEVES
*
Data
* DATA
: 08/2004
*
* DESCRIO : Sistema de Vendas pelo do Distribuidor
*Descrio breve
Descrio bsica
************************************************************************
************************************************************************
* Este programa responsvel por todas as operaes que envolvem a
* ordem de vendas:
* Criao de Ordem seja One-Time ou cliente SAP, ( VA01 )
* Alterao da Ordem de Vendas, ( VA02 )
* Eliminao da Ordem de Vendas, ( VA02 )
* Impresso de Etiquetas, ( ZNWDR054 )
* Liberao da Ordem de Vendas devido ao Crdito ( VKM3 )
************************************************************************
* Registro de Alteraes
*

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

MA.ISP.001

PG.:

4/9

DATA:

06/05/2004

REVISO:

*
*
*
*
*
*

Data/
Solicitante/
Detalhamento da alterao
Request
Abap

11.03.2003 Robson Lino

- Somar linhas, na impresso, referentes
D00K965997 Mnica Maria da Glria
ao mesmo PEDIDO-LOTE

00

*
*
*
*
*
*

3.3 Hierarquia de declarao dentro do SAP

a) Usar uma linha comentada tracejada sempre que mudar o tipo de declarao ou
semelhante, desde que o programa esteja bem lmpido e as declaraes bem
definidas.
b) Manter o alinhamento de acordo com o tamanho da maior string.
c) Identificar variveis com comentrios:
L_tabix like sy-tabix

indexador para modify em tabela interna.

*----------------------------------------------------------------------*
* Include MZNWDO037TOP
*
*----------------------------------------------------------------------*
Ordem de Declaraes:
PROGRAM SAPMZNWDO037 message-id zsd.
Tabelas
*----------------------------------------------------------------------*
Estruturas
* Tabelas
Tabelas Internas
*----------------------------------------------------------------------*
Work-Area
tables : vbap,
Variveis
vbak,
kuwev.
Dentro do possvel utilizar nomes standards
*----------------------------------------------------------------------*
em tabelas internas, estruturas, work-areas e
* Declarao de variveis globais
variveis.
*----------------------------------------------------------------------*
Dar preferncia a uma work-area do que as
* Estruturas
variveis.
*----------------------------------------------------------------------*
DATA: BEGIN OF ST_KNVV,
KUNNR LIKE KNVV-KUNNR,
LOEVM LIKE KNVV-LOEVM,
CONJUNTO(55),
END OF ST_KNVV.
*----------------------------------------------------------------------*
* Tabelas Internas
*----------------------------------------------------------------------*
DATA: IT_KNVV LIKE ST_KNVV OCCURS 0 WITH HEADER LINE.
*----------------------------------------------------------------------*
* Work Area
*----------------------------------------------------------------------*
DATA : ST_BAPISDHD1 LIKE BAPISDH1.
*----------------------------------------------------------------------*
* Variveis
*----------------------------------------------------------------------*
DATA : G_DATUM like sy-datum.

Observaes Importantes:
Identao, alinhamento e espaamento;
Comentrios breves e objetivos;
Identificao do form com o nome e a descrio da funcionalidade;
Tamanhos breves para tabelas, campos e variveis;
Tamanho mximo de 30 linhas para as subrotinas ou forms;

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:

5/9

DATA:
REVISO:

No utilizar F_ na nomenclatura do form, tamanho mximo 40

caracteres;
Manter alinhamento de acordo com o tamanho da maior String;
Identificao de Form com o nome e a descrio da funcionalidade;
*--------------------------------------------------------------------*
*
Form BUSCA_DESCCANAL
*--------------------------------------------------------------------*
*--------------------------------------------------------------------*
*
Descrio breve da funcionalidade do subprograma
*--------------------------------------------------------------------*

3.4 Nomenclatura
Todos os objetos criados pelos consultores tcnicos nos projetos sob a
responsabilidade da <EMPRESA> devero seguir a nomenclatura proposta neste
documento, salvo os casos onde se faa uso da metodologia do cliente ou de
parceiros.
Como conveno, adotaremos apenas a letra Z para identificao de objetos R/3.
3.5 Programa
O padro a ser utilizado na nomenclatura de objetos do tipo PROGRAMA
corresponde a forma ZEEMMTNNNN.
Z
EE
MM
T
NNNN

Indica que o objeto do cliente

Empresa solicitante
Identificao do mdulo funcional a qual o programa se destina.
Tipo do programa: batch, relatrio, interface, sapscript
Seqncia numrica para a identificao do objeto. De 001 a 999

3.6 Tela
A partir do nmero 9000, seguindo o seqencial de 10 em 10.
3.7 Status Gui e Ttulos Gui
Acompanham o nmero da tela.
3.8 Include
Z
MM
IN
NNN

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Constante que identifica o objeto como sendo um include
Seqncia numrica para a identificao do objeto. Variando de 001
999.

3.9 Transao
O padro a ser utilizado na nomenclatura de objetos do tipo TRANSAO
corresponde a forma ZMMNNN, ou sugerido pelo consultor tcnico.

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:

6/9

DATA:
REVISO:

Z
MM
NNN

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Seqncia numrica p/ a identificao do objeto. Variando de 001 a
999
3.10 Mdulo de dilogo
Z
MM
NN
TTTT

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Nmero do programa online correspondente. Variando de 01 a 99
Nmero da tela que o Dialog ir acessar

3.11 Implementao de BADI

Z
Livre

Indica que o objeto do cliente

Nome da Definio

3.12 Objeto de autorizao

Z
MM
NNN

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Nmero do programa online correspondente. Variando de 01 a 99

3.13 Classe de objetos

Z
MM
CL
NNN

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Identifica que uma classe dentro do R/3
Nmero do programa online correspondente. Variando de 01 a 99

3.14 Aplicao BSP

Z
MM
LIVRE

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Cabe ao programador indicar um nome de acordo com a programao

3.15 Menu de rea

Z
MM
NNN

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Nmero do programa online correspondente. Variando de 01 a 99

3.16 Objetos do Dicionrio

Os objetos ABAP/4 desse grupo esto relacionados, com as respectivas
nomenclaturas:
Tabela
Estrutura
Viso
Elemento de Dados

ZMMTNNN
ZMMENNN
ZMMVNNN
ZZE-LIVRE

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:

7/9

DATA:
REVISO:

Domnio
Objeto de Bloqueio
Ajuda para Pesquisa

onde
Z
MM
NN

ZZD-LIVRE
EZ-NOME TABELA
ZMMANNN

Indica que o objeto do cliente

Identificao do mdulo funcional
Nmero do programa on-line correspondente. Variando
de 001 a 999
Indica o tipo do objeto (sendo o E de Elemento de dados
e o D de domnio opcional)
Cabe ao programador indicar um nome de acordo com o
campo

T,V,E,D,EZ,A
LIVRE

Cabe indicar aos objetos relativos a uma tabela: grupo de funo, transao de
manuteno da tabela o mesmo nome da tabela facilitando assim a manuteno
dos mesmos.
3.17 Grupo de funo
Z
MM
F
NNN

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.
Indica que grupo de funo
Seqncia numrica para a identificao do objeto. De 001 999

3.18 Classe de desenvolvimento e classe de mensagem

Z
MM

Indica que o objeto do cliente

Identificao do mdulo funcional a qual o programa se destina.

3.19 Objetos utilizados no programa

Estruturas utilizadas em programas devero ser compostas da seguinte forma:
Tabela Interna IT_AAAA ou TI_AAAA ou T_AAAA
Tipos Internos ST_AAAA
ST
IT ou TI ou T
AAAA

Indica Tipos internos

Tabela Interna
Utilizar sempre que possvel o nome da tabela standard

Variveis devero ser divididas em:

G_
Objeto Global
L_
Objeto Local
3.20 Relao de nomenclatura para consulta rpida
ZEEMMTNNNN

Programa

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:
DATA:
REVISO:

9000
Mesmo que a tela
Mesmo que a tela
ZEMMMINNN
ZMMNNN
ZMMNN_TTTT
ST
IT ou TI ou T
G_ ou L_
ZMMTNNN
ZMMENNN
ZMMVNNN
ZE-LIVRE
ZD-LIVRE
EZ-NOME
TABELA
ZMMANNN
ZMMFNNN
ZMM
ZMM
ZMMLIVRE
ZMMNNN
ZMMNNN
ZMMCLNNN
ZLIVRE

Tela
Status Gui
Ttulos Gui
Include
Transao
Mdulo de Dilogo
Estrutura em Programa
Tabela Interna em programa
Varivel Global ou Local
Tabela
Estrutura
Viso
Elemento de Dados
Domnio
Objeto de Bloqueio
Ajuda para Pesquisa
Grupo de Funo
Classe de Desenvolvimento
Classe de Mensagem
Aplicao BSP
Menu de rea
Objeto autorizao
Classe de Objetos
Implementao de BADI

3.21 Template de Report

*----------------------------------------------------------------------* NewCom - Negcios e Solues de TI
* Mdulo
: MM
* Transao: ZMMNNN
* Descrio:
* Esta transao
*----------------------------------------------------------------------* Requisitante:
* Data da entrega da especificao: DD/MM/AAA HH:MM
* Programador
Data
Descrio
*----------------------------------------------------------------------REPORT ZBBMCCRNNN NO STANDARD PAGE HEADING
MESSAGE-ID ZMM
LINE-SIZE 80
LINE-COUNT 65.
INCLUDE zbmcabec.
*----------------------------------------------------------------------*
* Tabelas do Dicionrio
*----------------------------------------------------------------------*
TABLES:
*----------------------------------------------------------------------*
* Tabelas Internas
*----------------------------------------------------------------------*
TYPES: BEGIN OF ST_,
END OF ST_.

8/9

Manual
TTULO:

CD.:

PADRONIZAO DE OBJETOS ABAP

PG.:
DATA:
REVISO:

DATA: T_ TYPE STANDARD TABLE OF ST_ WITH HEADER LINE

INITIAL SIZE 0.
DATA: T_ TYPE SORTED

TABLE OF ST_ WITH HEADER LINE

WITH UNIQUE KEY MATNR
INITIAL SIZE 0.
*---------------------------------------------------------------------* Variveis Globais
*---------------------------------------------------------------------* Tela de Parmetros
*---------------------------------------------------------------------SELECTION-SCREEN: BEGIN OF BLOCK BLOQ WITH FRAME TITLE TEXT-001.
SELECT-OPTIONS: S_WERKS FOR T001W-WERKS.
SELECTION-SCREEN: END OF BLOCK BLOQ.
*---------------------------------------------------------------------* Cabealho do relatrio
*----------------------------------------------------------------------*
TOP-OF-PAGE.
PERFORM header USING text-003 '' '' ''.
PERFORM titulos.
*---------------------------------------------------------------------* Rodap do relatrio
*---------------------------------------------------------------------END-OF-PAGE.
*---------------------------------------------------------------------* Consistncia dos parmetros do relatrio
*---------------------------------------------------------------------AT SELECTION-SCREEN.
PERFORM CONSISTENCIAS.
*---------------------------------------------------------------------* Seleo de dados.
*---------------------------------------------------------------------START-OF-SELECTION.
*---------------------------------------------------------------------* Seleciona dos dados do dicionario do SAP
*---------------------------------------------------------------------PERFORM SELECIONA_DADOS.
*---------------------------------------------------------------------* Monta a tabela de sada
*---------------------------------------------------------------------PERFORM MONTA_SAIDA.
*---------------------------------------------------------------------* Exibe os dados formatados
*---------------------------------------------------------------------PERFORM EXIBE_DADOS.
END-OF-SELECTION.
*----------------------------------------------------------------------*
* Procedimentos chamados pelo progama
*----------------------------------------------------------------------*

9/9