Você está na página 1de 27

Padronização de Desenvolvimento

ABAP

Nomenclatura dos Objetos

HISTÓRICO
Versão Data (dd/mm/aaaa) Descrição
1.0 04/01/2016 Versão inicial

SUMÁRIO

1 OBJETIVO DO DOCUMENTO........................................................................................3
2 HEADER PADRÃO .......................................................................................................3
2.1 PRODUTOS ITS GROUP ................................................................................................3
2.1.1 PROGRAMAS PRINCIPAIS ................................................................................................... 3
2.2 DEMAIS DESENVOLVIMENTOS ........................................................................................4
2.2.1 PROGRAMAS PRINCIPAIS ................................................................................................... 4
2.2.2 INCLUDES ....................................................................................................................... 5
2.2.3 EXIT’S / INCLUDES............................................................................................................ 6
3 CONVENÇÃO DA NOMENCLATURA DOS OBJETOS ABAP ..............................................6
3.1 TABELA RESUMO ........................................................................................................6
3.2 ABAP PROGRAM ..................................................................................................... 12
3.3 ABAP MODULE POOL ............................................................................................... 13
3.4 FUNCTION GROUP .................................................................................................... 14
3.5 FUNCTION MODULE - PARÂMETROS.............................................................................. 15
3.6 CLASSES ................................................................................................................. 15
3.7 CLASSES - PARÂMETROS ............................................................................................. 15
3.8 INTERFACES ............................................................................................................. 15
3.9 TRANSACTION CODE .................................................................................................. 16
3.10 SCREENS ............................................................................................................... 16
3.11 ÁREA MENU .......................................................................................................... 17
3.12 MESSAGE CLASSES .................................................................................................. 17
3.13 BATCH REQUESTS (JOBS) .......................................................................................... 18
3.14 ABAP VARIANTS ..................................................................................................... 19
3.15 TABLES (TRANSPARENT, POOL) .................................................................................. 20
3.16 STRUCTURES .......................................................................................................... 20
3.17 VIEWS.................................................................................................................. 21
3.18 DOMAINS ............................................................................................................. 21
3.19 DATA ELEMENTS..................................................................................................... 22
3.20 LOGICAL DATABASE ................................................................................................. 22
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

3.21 LAYOUT DE TELA ..................................................................................................... 22


3.22 LAYOUT DE RELATÓRIO ............................................................................................ 23
3.23 SMARTFORMS ........................................................................................................ 23
3.24 MANUTENÇÃO EM OBJETOS SAP STANDARD OU Z ......................................................... 23
3.25 NOMENCLATURA DOS ARQUIVOS DE INTERFACE E CONVERSÕES ......................................... 25
3.26 NOMENCLATURA DE REQUEST ................................................................................... 26
3.27 WORKFLOW .......................................................................................................... 26
3.28 EXITS, BADIS E ENHANCEMENTS ................................................................................ 26
3.29 PARÂMETROS, VARIÁVEIS E ITENS DE CÓDIGO ............................................................... 26
3.30 PROGRAMAÇÃO ORIENTADA À OBJETOS – OBJETOS LOCAIS .............................................. 27
3.31 PARÂMETROS E OPÇÕES DE SELEÇÃO NA STVARV ......................................................... 27
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

1 OBJETIVO DO DOCUMENTO

O propósito deste documento é descrever a política e os procedimentos para nomenclatura


de objetos SAP ABAP. Este processo se aplica para todos os desenvolvimentos ABAP da ITS
Group. Exceto quando o cliente tiver o seu padrão de nomenclatura.

2 HEADER PADRÃO

Todos os desenvolvimentos devem utilizar um modelo de Header padrão para identificação


da consultoria:

2.1 PRODUTOS ITS GROUP

Produtos desenvolvidos pela ITS Group devem possuir um cabeçalho diferenciado. Assim
como as telas principais devem ter identidade visual padronizada .

2.1.1 Programas Principais

Nos programas Principais, utilizar o cabeçalho abaixo. Preencher bem os quadros


(observar o exemplo do monitor logístico). Este é um cabeçalho mais completo. Facilitando a
manutenção.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

*#######################################################################*
*# ___ _________________ #*
*# /__//___ ___ ___ \ #*
*# / / / / | | |_/ #*
*# / / / / \ \ #*
*# / / / / ___ | \ #*
*# / / / / / /__/ / #*
*# /__/ /__/ /________/ #*
*# #*
*#######################################################################*
*# Produto ITS Group – Direitos Reservados #*
*# GRC Recebimento Inbound #*
*# Monitor das operações logíticas , entrada de mercadorias, etc etc #*
*# descrição do produto etc, finalidades, funcionalidades #*
*# Parametrição Tipo de processos #*
*#######################################################################*
**---------------------------------------------------------------------**
** Programa : /ITSGRP/ZGRC_MON_LOGISTICO **
** Cliente : Produto ITS Group **
** Módulo : MM - Processo com GRC **
** Transação : /ITSGRP/ZMONLOG **
** Descrição : Monitor de Operações Logísticas **
** ABAP : Ubiratan Viana **
** Funcional : Éverton Esquia **
** Data : 03.03.2016 **
**---------------------------------------------------------------------**
** Histórico de Alterações: **
**---------------------------------------------------------------------**
** Data |Change # |Autor / Uname |Alteração **
**---------------------------------------------------------------------**
** 03.03.2016 |EH7K900651| ITS_UVIANA |Desenvolvimento Inicial **
** |Pacote Principal **
**---------------------------------------------------------------------**
** 08.03.2016 |EH7K900XXX| ITS_UVIANA |Relatório Analítico **
*-----------------------------------------------------------------------*

2.2 DEMAIS DESENVOLVIMENTOS

2.2.1 Programas Principais


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

*-----------------------------------------------------------------------*
* ITS Group *
*-----------------------------------------------------------------------*
* Programa : ZMMP009_MON_LOG *
* Cliente : Produto ITS Group *
* Módulo : MM - Processo com GRC *
* Transação : ZMONLOG *
* Descrição : Monitor de Operações Logísticas *
* ABAP : Ubiratan Viana *
* Funcional : Éverton Esquia *
* Data : 03.03.2016 *
*-----------------------------------------------------------------------*
* Histórico de Alterações: *
*-----------------------------------------------------------------------*
* Data |Change # |Autor / Uname |Alteração *
*-----------------------------------------------------------------------*
* 03.03.2016 |EH7K900651| ITS_UVIANA |Desenvolvimento Inicial *
* |Pacote Principal *
*-----------------------------------------------------------------------*
* 08.03.2016 |EH7K900XXX| ITS_UVIANA |Relatório Analítico *
*-----------------------------------------------------------------------*

2.2.2 Includes

*-----------------------------------------------------------------------*
* ITS Group *
*-----------------------------------------------------------------------*
* Include : ZMMP009_MON_LOG_F01 *
* Programa Principal : ZMMP009_MON_LOG *
* Módulo : MM - Processo com GRC *
* Transação : ZMONLOG *
*-----------------------------------------------------------------------*
* Histórico de Alterações: *
*-----------------------------------------------------------------------*
* Data |Change # |Autor / Uname |Alteração *
*-----------------------------------------------------------------------*
* dd.mm.aaaa |EH7K900651| ITS_UVIANA |Desenvolvimento Inicial *
*-----------------------------------------------------------------------*
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

2.2.3 Exit’s / Includes

Para a implementação de Exit’s e/ou includes para exit. Utilizar o cabeçalho a baixo, que
possui informações para facilitar a manutenção.

*-----------------------------------------------------------------------*
* ITS Group *
*-----------------------------------------------------------------------*
* Exit : EXIT_SAPLV02V_002 *
* Include : ZXLOFU01 *
* Programa : ZXLOFU01_Ajusta_Valor *
* Ampliação CMOD : *
* Ampliação SMOD : V02V0002 *
* Módulo : SD *
* Funcional : Alex Teixeira *
* Abap : Ubiratan Viana *
* Objetivo : No momento da criação da fatura. Trocar o valor total *
* pelo valor parcial *
*-----------------------------------------------------------------------*
* Histórico de Alterações: *
*-----------------------------------------------------------------------*
* Data |Change # |Autor / Uname |Alteração *
*-----------------------------------------------------------------------*
* dd.mm.aaaa | | |Desenvolvimento Inicial *
*-----------------------------------------------------------------------*

3 CONVENÇÃO DA NOMENCLATURA DOS OBJETOS ABAP

Como regra geral para criação, a inicial do nome de todos os objetos que deverão estar em
meio produtivo deverá ser “Z”.

A tabela resumo abaixo ilustra a convenção para nomenclatura dos objetos criados pela
equipe de desenvolvimento. Nos demais capítulos, alguns tipos de objetos descritos na
tabela resumo são explicados com mais detalhes.

Alguns tipos aparecem em inglês para facilitar sua identificação dentro do próprio SAP. Os
caracteres maiúsculos são fixos.

3.1 TABELA RESUMO


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Item Tipo de Objeto SAP Convenção de Nomenclatura


Zaabnnn
aa: Módulo da Aplicação
1 ABAP program
b: Tipo de Programa (ver capítulo 3.2)
nnn: Numeração Sequencial (Ex.: 001)
SAPMZaannn
2 ABAP module pool (Online) aa: Módulo da Aplicação
nnn: Numeração Sequencial (Ex.: 001)
Using – Variável pv_descrição
Using - Estrutura ps_descrição
3 Using – Tabela pt_descrição
Performs - Parâmetros
Changing – Variável cv_descrição
Changing – Estrutura cs_descrição
Changing - Tabela ct_descrição
Zaabnnn
aa: Módulo da Aplicação
4 Function group
b: Tipo de Programa (ver capítulo 3.4)
nnn: Numeração Sequencial (Ex.: 001)
ZF_nome
5 Function module
F: Fixo
Importing – Variável iv_descrição
Importing – Estrutura is_descrição
Importing – Tabela it_descrição
Exporting - Variável ev_descrição
6 Function module – Parâmetros Exporting – Estrutura es_descrição
Exporting – Tabela et_descrição
Changing – Variável cv_descrição
Changing – Estrutura cs_descrição
Changing – Tabela ct_descrição
7 Classes Globais (SE24) ZCL_nome
8 Classe de Exceção (SE24) ZCX_nome
9 Interfaces Globais (SE24) ZIF_nome
Importing – Variável iv_descrição
10 Importing – Estrutura is_descrição
Importing – Tabela it_descrição
Importing - Referência ir_descrição
Classes e Interfaces – Parâmetros
Exporting – Variável ev_descrição
11 Exporting – Estrutura es_descrição
Exporting – Tabela et_descrição
Exporting – Referência er_descrição
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Item Tipo de Objeto SAP Convenção de Nomenclatura


Changing – Variável cv_descrição
Changing – Estrutura cs_descrição
Changing – Tabela ct_descrição
Changing – Referência cr_descrição
Returning – Variável rv_descrição
Returning – Estrutura rs_descrição
Returning – Tabela rt_descrição
Returning – Referência rr_descrição
Zaannn
12 Transaction code aa: Módulo da Aplicação
nnn: Numeração Sequencial (Ex.: 001)
13 Screens Número entre 9000 e 9999
Zx...x
14 Area menu
x: Nome
ZGPFnnnn
15 GUI Status
nnnnn: Numero da tela
Zx...x
16 Function keys
x: Nome
ZGTnnnn
17 GUI Title
nnnn: Numero da tela
Z_aa
18 Message Classes
aa: Modulo da Aplicação
Zaabc_x...x
aa: Identificação da aplicação
19 Jobs ou Batch request b: versão do job (Ver capítulo 3.13)
c: periodicidade (Ver capítulo 3.13)
x: Nome
Zx...x
20 ABAP Variant
x: Nome
&ZaaTxxxz...z
&: Quando aplicável, /ITSGRP/
aa: Módulo da Aplicação
21 Tables
T: Fixo
xxx: sequencial
z..: Nome literal
&ZaaSTxxxz...z
&: Quando aplicável, /ITSGRP/
22 Structures
aa: Módulo da Aplicação
ST: Fixo
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Item Tipo de Objeto SAP Convenção de Nomenclatura


xxx: sequencial
z..: Nome literal
ZV<Tabela>
23 Views V: Fixo (identificação de view)
<Tabela>: Nome da tabela principal
ZTTx..x
24 Table Type
x: Nome
ZSTAxxx
25 Append Structure
x: Nome
ZZx...x
x: Nome
26 Append Fields Obs: Campos sempre devem começar com ‘ZZ’
não causar conflito com os campos standar
tabela.
ZDOxxxxx
27
Domains x: Nome (máximo de 5 caracteres)
ZDExxxxx
28 Data Elements
x: Nome (máximo de 5 caracteres)
ZSHx
29 Matchcode objects SH: Fixo
x: Nome
Zaabbnnn
aa: Módulo da Aplicação
30 Logical Database
bb: Tipo (Ver capítulo 3.20)
nnn: Numeração Sequencial (Ex.: 001)
Zaannn
31 Biblioteca do Report PaIDDer/Writer aa: Módulo da Aplicação
nnn: Numeração Sequencial (Ex.: 001)
ZaaSx_Nome
aa: Módulo da Aplicação
32 Sapscript / Smartforms S: Fixo

X: S , Sapscript, F smartforms

ZSSF...x
33 Estilo para Smartforms
x: Nome
Zaax...x
34 Relatório do Report PaIDDer/Writer aa: Identificação da aplicação
x...x: Nome
35 Grupo de relatório do Report PaIDDer/Writer Zaax...x
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Item Tipo de Objeto SAP Convenção de Nomenclatura


aa: Módulo da Aplicação
x...x: Nome
Zaax...x
36 Report PaIDDer/Writer Layout aa: Módulo da Aplicação
x...x: Nome
Zaaq_x...x
aa: Módulo da Aplicação
37 Queries ABAP Query
q: Fixo (identificação de Query)
x...x: Nome
Zaaqf_x...x
aa: Módulo da Aplicação
38 Áreas Funcionais ABAP Query q: Fixo (identificação de Query)
f: Fixo (identificação de Área Funcional)
x...x: Nome
Zaaqu_x...x
aa: Módulo da Aplicação
39 Grupo de Usuários ABAP Query q: Fixo (identificação de Query)
u: Fixo (identificação de Grupo de Usuário
x...x: Nome
ZSHaa_nome
40 Search Help SH: Fixo
aa: Módulo da Aplicação
41 Workflow 9*...

Projetos de ampliação na CMOD:


Zaannn
aa: Módulo da Aplicação
nnn: Numeração Sequencial (Ex.: 001)

Implementação de BADI:
Zaa_nome
42 Enhancements
aa: Módulo da Aplicação

Implementação de Enhancement
ZEHaa_nome
EH: Fixo
aa: Módulo da Aplicação

Implementação de Composite Enhancement


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Item Tipo de Objeto SAP Convenção de Nomenclatura


ZCEHaa_nome
CEH: Fixo
aa: Módulo da Aplicação

Zaabbbb_x...x
aa: Módulo da Aplicação
bbbb: É o código do gap conforme mensagem
Solman.
43 Parâmetros e opções de seleção na STVARV
Exemplo: Na mensa
SD_503C_D132_01: Interf.XML SP,
o código do gap é o D132
x...x: Nome
CheckBox cb_descrição
RadioButton rb_descrição
Select Options s_descrição
Parameter p_descrição
Variável Local lv_descrição
Variável Global gv_descrição
Constante Local lc_descrição
Constante Global gc_descrição
Tabela Interna Local lt_descrição
Tabela Interna Global gt_descrição
Estrutura Local ls_descrição
Estrutura Global gs_descrição
44 Parâmetros, Variáveis e Itens de Código
Tipo – Estrutura ts_descrição
Tipo – Tabela tt_descrição
Field-Symbol <fs_descrição>
Range local Utilizar a me
nomenclatura de ta
interna local
Range global Utilizar a me
nomenclatura de ta
interna global
Statics - Variável sv_descrição
Statics – Estrutura ss_descrição
Statics – Tabela st_descrição
Tipo Padrão
Programação Orientada à Objetos – Objetos
45 Definição de Classe lcl_descrição
Locais
Local
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Item Tipo de Objeto SAP Convenção de Nomenclatura


Definição de Interface lif_descrição
Local
Objeto Local lo_descrição
Objeto Global go_descrição
Objeto Classe Exceção - lx_descrição
Local
Objeto Classe Exceção - gx_descrição
Global
Atributo de Instância - mv_descrição
Variável
Atributo de Instância – ms_descrição
Estrutura
Atributo de Instância – mt_descrição
Tabela
Atributos Estáticos - gv_descrição
Variável
Atributos Estáticos – gs_descrição
Estrutura
Atributos Estáticos - gt_descrição
Tabela
Constantes c_descrição
Tipo - Estrutura ts_descrição
Tipo – Tabela tt_descrição
Eventos – Parâmetro de ev_descrição
Saída - Variável
Eventos – Parâmetro de es_descrição
Saída – Estrutura
Eventos – Parâmetro de et_descrição
Saída - Tabela

3.2 ABAP PROGRAM

O tamanho máximo permitido para o nome de um programa ABAP é de 30 caracteres,


porém, a título de simplificar e padronizar a nomenclatura para programas utilizar menos
caracteres. A SAP recomenda que a primeira letra seja “Z”.

O próximo caractere identifica o Módulo do objeto onde o desenvolvimento teve origem,


o seguinte identifica o tipo do desenvolvimento e depois teremos um número sequencial.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Exemplo – ZFIR001 – Este seria um Report desenvolvido para o módulo de FI do SAP1.

3.3 ABAP MODULE POOL

O tamanho máximo para o nome de um “module pool” é de 10 caracteres e deve ser do


tipo SAPMZaannn, onde “aa” identifica o módulo funcional e “nnn” é um numero
sequencial.

Exemplo – SAPMZSD001 – Este seria um on-line para área de Vendas e Distribuição (SD).

Considerações: Um “module pool” deve consistir inteiramente de “include programas”,


cujos nomes devem obedecer às seguintes regras:

 INCLUDE MZaannnTOP Contém a declaração dos dados (tabelas e/ou variáveis).


 INCLUDE MZaannnOww Módulos “Process Before Output (PBO)”, onde ww deve
ser incrementado de 10 a cada módulo.

1
Importante: Programas ABAP originais fornecidos pela SAP nunca devem ser alterados
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

 INCLUDE MZaannnIww Módulos “Process After Input (PAI)”, onde ww deve ser
incrementado de 10 a cada módulo.
 INCLUDE MZaannnFww Subrotinas (FORM ... ENDFORM), onde ww deve ser
incrementado de 10 a cada módulo.

Portanto, alguns dos includes para nosso exemplo SAPMZSD001 seriam: MZSD001TOP,
MZSD001O10, MZSD001I10 e MZSD001F10.

Caminho: Ferramentas  ABAP/4 Workbench  Object Browser.

Transação: SE80

3.4 FUNCTION GROUP

O nome deve ser da forma Zaabnnn, o próximo caractere identifica o Módulo do objeto
onde o desenvolvimento teve origem, o seguinte identifica o tipo do desenvolvimento e
depois teremos um número sequencial.

Exemplo – ZSDG001 – Este seria um grupo para funções associado ao módulo de SD.

Considerações: “Function Groups” fornecidos pela SAP nunca devem ser utilizados para
definição de novos “Function Modules”. O desenvolvedor deve criar seus próprios grupos
antes da criação de novas funções.

Criar uma Atualização ampliada de tabelas para cada tabela, fazendo esta aplicação
independente de outras.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Quando criar diversas tabelas para a mesma aplicação, manter todas as atualizações no
mesmo Grupo de Função.

Caminho: Ferramentas  ABAP/4 Workbench  Object Browser.

Transação: SE80

3.5 FUNCTION MODULE - PARÂMETROS

Antes da descrição, os nomes dos parâmetros devem receber um prefixo que identifique o
tipo de parâmetro que está sendo utilizado. No parâmetro XY_DESCRIÇÃO, por exemplo,
temos o prefixo ‘XY’. A posição ‘X’ deve indicar se o parâmetro é do tipo ‘Importing’ (I),
‘Exporting’ (E) ou ‘Changing’ (C), enquanto a posição ‘Y’ deve indicar se o parâmetro é uma
variável (V), uma estrutura (S) ou uma tabela (T).

3.6 CLASSES

O nome deve ter no máximo 30 caracteres e deve ser da forma ZCL_descrição.

Exemplo – ZCL_CRIANF – Esta seria uma classe para executar a criação de Notas Fiscais.

Transação: SE24

3.7 CLASSES - PARÂMETROS

Antes da descrição, os nomes dos parâmetros devem receber um prefixo que identifique o
tipo de parâmetro que está sendo utilizado. No parâmetro XY_DESCRIÇÃO, por exemplo,
temos o prefixo ‘XY’. A posição ‘X’ deve indicar se o parâmetro é do tipo ‘Importing’ (I),
‘Exporting’ (E), ‘Changing’ (C) ou ‘Returning’ (R), enquanto a posição ‘Y’ deve indicar se o
parâmetro é uma variável (V), uma estrutura (S), uma tabela (T) ou uma referência (R).

3.8 INTERFACES

O nome deve ter no máximo 30 caracteres e deve ser da forma ZIF_descrição.


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Exemplo – ZIF_CRIANF – Esta seria uma interface usada na criação de Notas Fiscais.

Transação: SE24

3.9 TRANSACTION CODE

Os códigos das transações criadas pelo usuário devem obedecer à seguinte regra de
formação: Zaannn, onde “aa” é a identificação da aplicação e “nnn” é um número
sequencial.

Exemplo – ZHR001 Transação que executa um Relatório de HR.

ZSD003 Transação que executa uma Interface de SD.

Considerações: Todos os relatórios e programas criados pela equipe de desenvolvimento


que venham a ser utilizados pelo usuário final deverão obrigatoriamente ter um código de
transação associado. Tal regra objetiva a implementação das restrições de segurança
através de transações.

Caminho: Ferramentas  ABAP/4 Workbench  Desenvolvimento  Outras Ferramentas 


Transações.

Transação: SE93

3.10 SCREENS

A identificação de uma tela consiste de um programa ABAP e um número de 4 dígitos que


deve estar entre 9000 e 9999.

Exemplo – SAPMZTF001  Nome do programa ABAP.

9000  Número da tela associada.


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Considerações: Telas fornecidas pelo SAP nunca devem ser alteradas. Se alguma alteração
se fizer necessária, a tela original deve ser copiada de acordo com as regras de
nomenclatura e as alterações devem ser feitas na cópia.

Caminho: Ferramentas  ABAP/4 Workbench  Screen Painter.

Transação: SE51

3.11 ÁREA MENU

Caminho: Ferramentas  ABAP/4 Workbench  Desenvolvimento  Outras Ferramentas 


Menus de Área.

Transação: SE43

3.12 MESSAGE CLASSES

Classes de mensagens utilizadas em programas ABAP consistem de 20 caracteres. O


primeiro caractere deverá ser a letra “Z”, os dois próximos identificam o módulo da
aplicação, o quarto deverá identificar o módulo ao qual a classe pertence e os demais
caracteres são livres.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Exemplo – Z_SD Identifica a classe de mensagens informativas para o módulo SD.

Considerações: As mensagens definidas nas classes SAP standard só podem ser alteradas
mediante autorização da gerência.

Caminho: Ferramentas  ABAP/4 Workbench  Desenvolvimento  Ambiente


Desenvolvimento  Mensagens.

Transação: SE91

3.13 BATCH REQUESTS (JOBS)

O tamanho máximo para nome de um Job é de 32 caracteres.

A primeira letra deve ser um “Z” para identificar um batch request definido pelo usuário.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Exemplo – ZSDPD_SALDO_DE_ESTOQUE  Indica que é um job criado para o time de Vendas


e Distribuição, executado no ambiente de produção com frequência diária. Trata-se de um
programa que realiza algumas operações referentes a saldo de estoque.

Considerações: Batch requests padrões no SAP nunca devem ser alterados.

Se alguma alteração se fizer necessária, deve haver uma discussão com a equipe de
desenvolvimento e integração.

Caso a alteração seja aprovada, uma cópia do batch original deve ser feita utilizando-se o
padrão de nomenclatura acima descrito.

As modificações devem ser feitas na cópia e o batch original deve ser mencionado na
documentação final.

Caminho: Sistemas  Serviços  Jobs  Definição do Job.

Transação: SM36

3.14 ABAP VARIANTS

O tamanho máximo para o nome de uma variante é de 14 caracteres. Os 14 caracteres são


livres para identificar a variante de uma forma geral. O nome de uma variante não pode
conter os caracteres “&” e “%”.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Formato:

Zx.....x

Livre

Caminho: Ferramentas  ABAP/4 Workbench  Editor ABAP/4.

Transação: SM38

3.15 TABLES (TRANSPARENT, POOL)

O tamanho máximo para um objeto no dicionário de dados é de 16 caracteres. Entretanto,


dependendo do tipo do objeto, o tamanho máximo permitido pode ser menor do que 16
caracteres.

O nome da tabela pode conter até 16 caracteres. O primeiro caractere para tabelas criadas
pela equipe de desenvolvimento e integração deve ser “Z”. O segundo deve identificar o
modulo e os seguintes devem ser o nome da tabela.

Exemplo (sem namespace) – ZSDT001ORDENSVEN.

Exemplo (com namespace) – /ITSGRP/ZSDT001OV.

Considerações: Uma tabela pool contém várias tabelas lógicas numa única tabela física. O
SAP fornece uma série de tabelas pool, sendo que a mais utilizada é a tabela ATAB. Esta
tabela contém informações de controle do SAP. Não é recomendável adicionar novas
tabelas às tabelas pool já existentes, entretanto se houver necessidade para criação de
alguma tabela pool, as mesmas regras para nomenclatura de tabelas transparentes devem
ser utilizadas.

3.16 STRUCTURES

Estruturas não contêm dados e são utilizadas basicamente para:

1- Estruturar tabelas internas utilizadas em funções ou programas;


2- Campos de telas;
3- Formulários sapscript.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

O tamanho máximo para o nome de uma estrutura é de 30 caracteres.

Exemplo – ZSDEORDENSVENDA Estrutura criada para utilização com dados da ordem de


vendas do módulo SD.

Caminho: Ferramentas  ABAP/4 Workbench  Dictionary.

Transação: SE11

3.17 VIEWS

O tamanho máximo para o nome de uma view é 30 caracteres. O tamanho do nome variará
de acordo com o nome da tabela primária já que o nome de uma view deverá sempre
referenciar o nome da tabela primária. O primeiro caractere deverá ser “Z”, o segundo
representa o módulo da aplicação, o terceiro é sempre “V” representando uma View, e os
últimos correspondem à descrição.

Exemplo – ZSDVORDENSVENDA é uma view representando uma seleção na tabela definida


pela equipe de desenvolvimento e integração ZSDTORDENSVENDA.

Caminho: Ferramentas  ABAP/4 Workbench  Dictionary.

Transação: SE11

3.18 DOMAINS

O tamanho máximo para o nome de um domínio é de 30 caracteres. Os dois primeiros


caracteres devem ser “ZZ” e os outros devem ser utilizados para identificar o domínio de
uma forma geral.

Formato:

ZZ xx...xx

Livre

Exemplo – ZZWERKS  domínio para o centro.

Caminho: Ferramentas  AP/4 Workbench  Dictionary.

Transação: SE11
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

3.19 DATA ELEMENTS

O tamanho máximo para Elementos de dados é de 30 caracteres. O primeiro caractere deve


ser “Z” e os restantes devem ser utilizados para identificar o elemento de dados de uma
forma geral.

Formato:

Z xx...xx

Livre

Exemplo – ZSYSTEM

Caminho: Ferramentas  AP/4 Workbench  Dictionary.

Transação: SE11

3.20 LOGICAL DATABASE

O tamanho para o nome de uma classe de desenvolvimento é de 20 caracteres. O primeiro


deve ser sempre “Z”. O segundo identifica a aplicação, o terceiro é fixo ‘BD’ e os demais são
livres.

Exemplo – ZSDBD001 Banco de dados lógico para módulo SD. (sempre que possível,
identificar a finalidade, quais informações, etc.).

3.21 LAYOUT DE TELA


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Em relação ao layout de tela, seguir rigorosamente os mesmos critérios utilizados no


sistema SAP, para que não ocorra uma desfiguração do produto (Padrão de barra de
ferramenta, barra de menu, botões, campos, cores, teclas de atalho, etc.).

3.22 LAYOUT DE RELATÓRIO

Em relação ao layout de relatório, seguir os mesmos critérios utilizados no R/3, para que
não ocorra uma desfiguração do produto. Padrão de layout, cores, drill-down (quando
necessário).

3.23 SMARTFORMS

Para obter o padrão de nomenclatura dos smartforms, consultar o item 32 da tabela


resumo no capítulo 3.1.

DICA: durante o desenvolvimento de Smartforms, definir nomes específicos para cada um


dos elementos criados no formulário (Gráficos, Textos, Linhas de Programa, Quadros, etc.),
evitando o uso dos nomes padrões sugeridos pelo SAP (como %NOME1, por exemplo).

A utilização de uma nomenclatura coerente facilita o desenvolvimento e as futuras


manutenções no formulário.

3.24 MANUTENÇÃO EM OBJETOS SAP STANDARD OU Z

Como mencionado anteriormente, objetos SAP Standard nunca devem ser modificados.
Sempre que possível, deve-se fazer uso de procedimentos de customização ou “exits” para
contornar as necessidades de alteração em objetos padrão. Se não for possível e a alteração
de standard for aprovada pela gerência do projeto, então colocar linhas antes e depois da
alteração e descrever a mesma no código como abaixo, utilizando o cabeçalho para
detalhar a alteração.

As regras acima não precisam ser utilizadas para aplicações de Notas OSS destinadas a
correções de erros no sistema. Porém o procedimento abaixo deve, também, ser utilizado
neste caso.
Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

*** Inicio Alteração – LOGIN DE USUÁRIO – Data – Request - Comentário

Código correspondente à alteração

*** Fim Alteração – LOGIN DE USUÀRIO – Data – Request - Comentário

Abaixo um exemplo de como deve ser feito uma alteração em Select.

Modo errado

*** WLJ- 05/05/2009 - Início ajustes inserir SERIE da NF

* SELECT nfnum credat branch inco1 anzpk

SELECT nfnum series credat branch inco1 anzpk

*** WLJ - 05/05/2009 - Fim ajustes inserir SERIE da NF

brgew ntgew docnum nftot nftype parid

INTO TABLE t_j_1bnfdoc

FROM j_1bnfdoc

WHERE partyp = wc_partyp AND

credat IN r_credat AND

nfnum IN l_rag_nfnum AND

cancel = space AND

branch IN l_rag_branch.

Modo certo

*** Inicio – WLONGHINI - 05.05.2009 – DECK999222 - Inserir SERIE da NF


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

* SELECT nfnum credat branch inco1 anzpk

* brgew ntgew docnum nftot nftype parid

* INTO TABLE t_j_1bnfdoc

* FROM j_1bnfdoc

* WHERE partyp = wc_partyp AND

* credat IN r_credat AND

* nfnum IN l_rag_nfnum AND

* cancel = space AND

* branch IN l_rag_branch.

*** Seleciona dados da nota fiscal

SELECT nfnum series credat branch inco1 anzpk

brgew ntgew docnum nftot nftype parid

INTO TABLE t_j_1bnfdoc

FROM j_1bnfdoc

WHERE partyp = wc_partyp AND

credat IN r_credat AND

nfnum IN l_rag_nfnum AND

cancel = space AND

branch IN l_rag_branch.

*** Fim – WLONGHINI – 05.05.2009 – DECK999222 - Inserir SERIE da NF

3.25 NOMENCLATURA DOS ARQUIVOS DE INTERFACE E CONVERSÕES


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Os arquivos de entrada ou de saída, tanto para Interfaces quanto para conversões, devem
seguir o seguinte padrão de nomenclatura: <Descrição>.<Timestamp><Extensão> ou
padrão de nomenclatura exigido pelo sistema legado.

O campo <Descrição> deve conter um código que identifique a Interface ou conversão.


Deverá ser utilizado o código conforme padrão. A extensão <Timestamp> é o timestamp de
geração do arquivo e deve possuir o formato AAAAMMDDHHMMSS onde:

O limite para o tamanho do nome do arquivo é determinado pelo sistema operacional onde
o arquivo é armazenado. No Unix o tamanho máximo é de 255 caracteres.

Exemplo – MM_Carga_Materiais_200804301455.csv

3.26 NOMENCLATURA DE REQUEST

Esta nomenclatura depende de cada Projeto .

3.27 WORKFLOW

Todos os objetos de Workflow devem começar com o número “9”.

3.28 EXITS, BADIS E ENHANCEMENTS

Consultar o item 42 - “Enhancements” da tabela resumo, no capítulo 3.1.

3.29 PARÂMETROS, VARIÁVEIS E ITENS DE CÓDIGO


Padronização de Desenvolvimento
ABAP

Nomenclatura dos Objetos

Para obter a nomenclatura dos objetos criados localmente em programas Abap, consultar
o item 44 da tabela resumo no capítulo 3.1.

3.30 PROGRAMAÇÃO ORIENTADA À OBJETOS – OBJETOS LOCAIS

Para obter a nomenclatura dos objetos criados localmente quando utilizar Programação
Orientada à Objetos, consultar o item 45 da tabela resumo no capítulo 3.1.

3.31 PARÂMETROS E OPÇÕES DE SELEÇÃO NA STVARV

Para obter a nomenclatura dos parâmetros e opções de seleção criados na transação


STVARV, consultar o item 43 da tabela resumo no capítulo 3.1.