Sie sind auf Seite 1von 21

Proyecto Tubrica - Tubosa

Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

CONVENCIONES Y NOMENCLATURA DE OBJETOS ABAP


Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Historial de Revisiones

Nmero de Fecha Revisin Resumen de Cambios Actualizado por Cambios


Revisin marcados
V1 19/02/2016 Versin inicial Yonys Rodrguez

Distribucin

Este documento ha sido distribuido a:


Nombre/Firma Titulo
Equipo Tcnico ABAP del Proyecto SAP

Revisores

Este documento debe ser revisado por:


Nombre/Firma Titulo

Aprobadores

Este documento requiere de las siguientes aprobaciones:


Nombre /Firma Titulo

1. Propsito

El propsito de este documento es dar a conocer los lineamientos referentes a convenciones de nombres y
estndares para la creacin de objetos de desarrollo ABAP en los proyectos de implementacin y mantenimiento de
soluciones SAP y dems Verticales. Esto es con el fin de reducir el esfuerzo necesario para identificar el objeto, entender
el cdigo fuente, mejorar la apariencia del cdigo y finalmente, mantener la uniformidad de la plataforma.

2. Alcance

Est dirigido a todo personal supervisor y tcnico Abap, tanto de consultores internos como externos, encargados del
anlisis y desarrollo de nuevas funcionalidades de cliente con el fin de adaptarlas a las necesidades del negocio.
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

El documento es una gua para la creacin objetos de cliente, basado en las mejores prcticas de utilizacin. Tambin
para fijar normas en el desarrollo de objetos ABAP con la finalidad de obtener un producto donde el cdigo sea legible y
fcil de mantener por cualquier desarrollador.

3. Generalidades

ABAP es el lenguaje de programacin propiedad del Sistema SAP, que se utiliza para programar en la mayora de los
productos de la empresa y su uso slo se puede entender a travs de este software empresarial.

Como lenguaje de programacin propietario de SAP, ABAP se ha utilizado y se utiliza como elemento de
programacin especfico para la mayor parte de sus productos. Sus siglas ABAP significan Advanced Business Application
Programming.

Originalmente fue definido como un lenguaje estructurado de cuarta generacin (de ah el antiguo nombre de
ABAP/4), posteriormente ha incorporado elementos propios de lenguajes orientados a objetos.

Cuando se hacen desarrollos(programas y objetos ABAP) en los clientes, los mismos se pueden clasificar en dos tipos

3.1. Desarrollos de Cliente. Corresponden a nuevos objetos generados en la plataforma, no son copias modificadas
de los objetos estndar de SAP.

3.2. Objetos modificados(Copiados). Son copias de objetos estndar de SAP, que luego son modificados para cubrir
una necesidad o Gap detectado del objeto original. SAP recomienda no modificar los objetos estndar, por lo
cual en caso de necesidad, se deben hacer copias del objeto, renombrarlo y modificarlo acorde al requerimiento
del negocio.

En todo proyecto es necesario definir estndares para el proceso de desarrollo de aplicaciones complementarias al
sistema. SAP tiene un estndar para los desarrollo de aplicaciones complementarias a la licencia adquirida.
Dicho estndar es la letra Z, la cual debe utilizarse como inicial a la identificacin de las objetos que se desarrollan. Esto
permite que cuando se realicen actualizaciones al sistema, todo lo que este identificado inicialmente con la letra Z, es
respetado por SAP, es decir, no lo toca al realizarse una actualizacin del sistema.

4. Recomendaciones Generales

4.1. Cdigo Duro (HARD-CODE)

Bajo ninguna circunstancia est permitido el uso de Cdigo Duro en el cdigo de los desarrollos. En su reemplazo, se
debe crear una tabla de Parmetros tipo Z, o en su defecto, una pantalla inicial de captura de parmetros que le
permita al usuario realizar mantenimiento al desarrollo sin necesidad de efectuar modificaciones al cdigo.

4.2. Unidades lgicas

Estructure la solucin de forma tal que, se identifique con facilidad la secuencia lgica de su operacin. Defina
rutinas, funciones o mtodos reutilizables siempre que se pueda y de forma que puedan ser aplicados en diferentes
componentes.

4.3. Cdigo Muerto


Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Evite la existencia de cdigo muerto a lo largo de los programas. Remueva definiciones o declaraciones de campos
que nunca sern usados y cdigos que nunca sern ejecutados, a menos que sean modificaciones del estndar SAP,
donde hay que dejarlos como comentarios.

4.4. Indentacin del cdigo fuente

Para mantener un cdigo de fcil lectura, comprensin y con uniformidad, se recomienda que todos los desarrollos
deben utilizar la funcionalidad Pretty Printer del editor, para auxiliar en la justificacin del cdigo fuente.

5. Convenciones generales en Nombres de objetos ABAP

Al crear nuevos objetos ABAP se recomienda lo siguiente:

- Usar la letra Z al inicio del nombre de los objetos transportables.


- Use la letra Y al inicio del nombre para objetos de Pruebas o programas que No requieran ser
transportados a otros ambiente.
Ejemplos:
zmm_listado_balance_masa.
ymm_listado_test ( Objeto No transportable )

Los nombres de objetos Abap No pueden contener ninguno de los siguientes caracteres: Punto (.), coma (,), espacio (
), parntesis (()), apostrofe (), comillas ("), signo igual (=), asteriscos (*), caracteres acentuados o con diresis (, , ,
, , etc), signo porcentaje (%), o palabras subrayadas (_).

Slo se debern utilizar los siguientes caracteres: A...Z, a...z, 0...9.

En nombres compuestos, Usar el carcter underscore (_) como separador. Ejemplo: ZCL_COMPANY_CODE.

6. Nomenclatura Ordenes de Transporte WORKBENCH

El texto de Descripcin para la Orden de Transporte(Change Request) debe comenzar de la siguiente forma:

Nomenclatura CCC FFOOOOOXXX


CCC Cdigo transporte Identificador de la orden de transporte. Este cdigo depende
de la nomenclatura definida en la plataforma del cliente y es
generado automticamente por sta.
ABAP-XX Mdulo funcional Luego de Colocar el identificador ABAP, coloque la sigla del
mdulo que utiliza el objeto segn la tabla 1.
BBB Descripcin Colocar la descripcin libre que identifica el contenido de la
orden. Es de tipo Alfa-numrico.
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Ejemplo: DEVK900022 ABAP-CO: Orden Ppal. para desarrollos del mdulo Costos.

Documentacin

Para facilitar la trazabilidad futura de las modificaciones o ajustes, es obligatoria la apropiada documentacin en
los objetos nuevos o modificados. Para ello se proveen varias opciones de documentacin soportadas por SAP. Varios
elementos de la interfaz, as como componentes de desarrollo de ABAP, pueden ser documentados directamente en el
sistema. Esta documentacin puede ser llamada usando opciones de men o teclas de funcin dentro de una aplicacin
especfica.

En el diccionario de ABAP se puede ingresar la documentacin para el elemento de datos o el dominio en que se
est trabajando.

Cuando se selecciona esta funcin, es llamado el editor preparado para permitir el mantenimiento del objeto en
cuestin. Despus de salvar el texto, se puede retornar a la transaccin original de mantenimiento del objeto. Se muestra
una vista de ejemplo del editor SAPscript:

El modo del Editor puede ser cambiado. Estando posicionado en el editor y dentro del men: Pasar a, Cambiar editor o
tambin en la opcin Configurar editor.

7. Tabla de Mdulos y Submdulos.


Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

8.

Mdulo Submdulo Descripcin


FI AC Contabilidad financiera - General
FI Contabilidad financiera
GL Ledger de libro mayor
LC Consolidacin empresarial
AP Contabilidad de acreedores
AR Contabilidad de deudores
BL Gestin de cuentas bancarias
AA Contabilidad de activos fijos
FM Gestin presupuestaria
TM Gestin de viajes
TR Tesorera
IM Gestin de inversiones
CO CCA Contabilidad por Centros de Coste
CEL Contabilidad de elementos de Coste
PC Control de Costes del Producto
PA Analisis de Rentabilidad
OPA Ordenes Internas
ABC Costes Basados en Actividades
Planificacin de necesidades sobre
MM CBP
consumo
PUR Gestin de Compras
IM Gestin de Inventarios
IV Verificacin de Facturas
SRV Gestin de servicios Externos
EDI Intercambio Electrnico de Datos

Funciones Bsicas, Gestin Tarifas y


SD BF
Condiciones de Precio, Gestin de crditos.

MD Datos maestros
SLS Gestin de Ventas
LE-SHP Gestin de Expediciones
BIL Facturacin
CAS Soporte de ventas
FT Comercio Exterior
EDI Intercambio Electrnico de Datos
PS Sistema de proyectos
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

EC Controlling Empresarial
RE Administracin de bienes inmuebles
HCM PA Administracin de Personal (PA)
PY Nmina de sueldos (PY)
OM Gestin de la Organizacin (OM)
GE Gestin de Eventos (GE)
RC Contratacin de Personal (RC)
PD Desarrollo de Personal (PD)
PT Gestin de Tiempos (PT)
ESS ESS - Employee Self Service
MSS MSS - Manager Self Service
LE - Ejecucin de logstica
QM - Gestin de Calidad
PM - Mantenimiento de Planta
WM - Gestion de Almacenes
CS - Servicio al Cliente
PP - Control y planificacin de la produccin
PS - Sistema de proyectos
EHS - Medio ambiente, Salud y Seguridad
WF - Workflow
WS - Web Service
WD - Web Dynpro
PI - Process Integrator
IS - Soluciones de Industria
BI - Business Intelligence

Tabla 1.

9. Tabla de clase o uso de objetos Abap.

Tipo Descripcin Objetos que lo componen


R Reporte Reportes de todo tipo.
I Interfaz Interfaces del sistema
C Conversin-Carga Objetos BDC, Bapi, LSMW, otros.
E Extensin - Ampliaciones Exits, enhancement, Badi, entr otros.
Formularios de todo tipo: Smartforms, SapScritp, Adobe Forms, Hr
F
Formulario Forms, otros.
W Flujo de trabajo Workflow

Tabla 2.
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

10. Tabla tipos de programas.

Tipo Descripcin
1 Programa ejecutable (Report)
I Includes
M Module pool
F Grupo de funciones
K Pool de Clases globales (class definitions)
Pool de Interfaces globales (interface
J
definitions)
S Pool de subrutinas
X Transformacin (Programa ST o XSLT)
Q Proxy de procedimiento de base de datos

Tabla 3.

11. Reportes nuevos

Nomenclatura ZMMSST_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido por SAP. Inicia
con Z para Objetos nuevos. Letra Y para casos en que el objeto
no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
SS Submdulo Identificador de 2 caracteres para indicar el Submdulo(en los
casos que aplique). Ver (tabla 1). Ante la duda, apoyarse por
favor, en el especialista funcional del mdulo.
T Objeto
Define la clase o uso que se le dar al programa (Tabla 2).
_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el
carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.

Ejemplo:
zhcmpyr_lista_empleados
yhcmpyr_lista_empleados ( No transportable )
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

11.1. Includes

Nomenclatura ZMMSST_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido por SAP. Inicia
con Z para Objetos nuevos. Letra Y para casos en que el objeto
no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP . Ver Tabla 1.
SS Submdulo Identificador de 2 caracteres para indicar el Submdulo(en los
casos que aplique). Ver (tabla 1). Ante la duda, apoyarse por
favor, en el especialista funcional del mdulo.
T Objeto
Define la clase o uso que se le va a dar al programa Tabla 2.
I Tipo de Objeto
Colocar el tipo de programa segn la tabla 3.
_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el
carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
VVV Tipo de Elemento Los tipos de elementos permitidos son:
PBO Process Before Output
PAI Process after input
FOR Rutinas
LCD Definicin clases locales
LCI Implementacin clases locales

Ejemplo:
zhcmpyi_top
yhcmpyi_rutinas ( No transportable )

11.2. Copia de programa Estndar.

SAP recomienda no modificar los objetos estndar, por lo cual no se permite la modificacin de los mismos. Las
mejores prcticas sealan que los objetos deben ampliarse con los mtodos permitidos por la aplicacin. En caso que se
desee aprovechar una funcionalidad estndar, el procedimiento es realizar una copia del objeto y sus elemento
relacionados y modificar la copia, segn las necesidades del negocio. Es importante copiar slo los programas donde
desee realizar cambios, en especial para los casos de programas tipo Include.

Nomenclatura ZMM_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido por SAP. Inicia
con Z para Objetos nuevos. Letra Y para casos en que el objeto
no requiera ser transportado
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP . Ver Tabla 1.
_XXX
Luego de colocar Underscore o guion bajo, coloque el Nombre
del Objeto Estndar SAP que se copi.
YMM_RFITEMAP => copia de programa RFITEMAP (No transportable)
ZMM_RFITEMAP => copia de programa RFITEMAP

Aplicar la misma nomenclatura para copias de Includes.

12. Atributos de los programas.

Los atributos de programas se establecen en la opcin Atributos en la pantalla inicial del editor de screen de ABAP.
Todos los atributos de programa para un ABAP son configurados de la siguiente forma.

Ttulo. El ttulo debe ser una descripcin corta y concisa.

Tipo. El tipo indica la clase de programa de que se trata. Los tipos permitidos son:

- Programa ejecutable. Puede iniciarse directamente sin cdigo de transaccin o en fondo. Un programa de sistema
invisible, controla todos los programas ejecutables. Un programa ejecutable permite trabajar con bases de datos lgicas.
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

- Modulpool (M) para dynpros SAP Screen Painter. Contiene pasos para procesar mdulos de dynpro de las transacciones
y slo puede llamarse mediante un cdigo de transaccin o una funcin de men.

- Report de Include. Contiene un cdigo de programa que no puede ejecutarse por s slo. Esta parte de programa puede
incluirse en otro programa mediante INCLUDE.

- Pool de subrutinas. Contiene partes de programa (FORM) que son llamadas desde instrucciones PERFORM externas.

- Grupo de funciones. No puede asignarse desde la SE38. Contiene mdulos de funciones. Grupos y mdulos se
administrarn en la biblioteca de funciones que fijar tambin el tipo de programa F cuyos atributos no pueden
modificarse.

- Pool de interfaces. No puede asignarse desde la SE38. Contiene interfaces. El generador de clases gestiona las interfaces
y las clases; los atributos del tipo de programa J no pueden modificarse.

- Pool de clases. No puede asignarse desde la SE38, contiene clases. El generador de clases gestiona las interfaces y las
clases; los atributos del tipo de programa K no pueden modificarse.

Status

- P: programas de produccin estndares de SAP.


- K: programas de desarrollos propios para produccin.
- S: programas del sistema.
- T: programas de prueba (test) que nunca estarn en produccin.

Aplicaciones. Colocar la aplicacin a la cual pertenece el programa. De no existir la categora, se puede dejar en blanco o
seleccionar la opcin multiaplicaciones. Para programas copia de estndar, debe preservar el atributo del programa
original.

Grupos de autorizacin. Grupo de autorizaciones al que ha sido asignado el programa. La pertenencia de un programa a
un grupo de autorizaciones es muy importante cuando se verifica si un usuario est autorizado para:

1) Ejecutar un programa:
--> Objeto de autorizacin S_PROGRAM

2)Tratar un (Include de) programa en el Workbench ABAP:


--> Objeto de autorizacin S_DEVELOP

Los programas que no estn asignados a ningn grupo de autorizaciones, es debido a que no requieren ninguna
proteccin eficiente contra la visualizacin y ejecucin. Por ello, los programas relevantes para la seguridad deben
asignarse siempre a un grupo de autorizaciones. Para la asignacin de programas a grupos de autorizacin puede
utilizarse el Report RSCSAUTH, que est descrito de forma detallada.

Base de datos lgica. Asigna la base de datos lgica para ser evaluada por el programa. Es de gran uso en el mdulo de
HCM(HR).

Paquete. Los objetos relacionados del Workbench ABAP se agrupan en un paquete. El paquete determina las propiedades
de transporte del objeto mediante la capa de transporte.
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Vers. Imagen de Seleccin(Screen). Esta opcin es slo para programas de reporte. Si no se especifica una screen el
sistema crear una selection screen basada en la base de datos lgica (si fue especificada), los parmetros del programa y
los select-options.

Bloqueo del editor. Mediante este indicador se puede impedir que otros usuarios modifiquen el programa, incluyendo
atributos, elementos de texto y funciones tales como 'Cambiar nombre' y 'Borrar'. El indicador slo podr ser eliminado
por el autor de la ltima modificacin del programa.

Verificacin Unicode Activa. Se recomienda mantener activa esta opcin. UNICODE es el Standard de codificacin que
proporciona la base para el procesamiento, almacenamiento e intercambio de datos de texto en cualquier lenguaje.
Todos los sistemas SAP instalados recientemente son UNICODE por defecto.

Clculo de coma fija. Al marcar este campo, todos los clculos en el programa sern ejecutados en base a aritmtica de
coma fija.

Ejecutar slo mediante variante. Si se ha marcado el campo "Ejecutar con variante", el usuario solamente podr ejecutar
este report mediante una variante. El campo slo es relevante para programas ejecutables (reports). Si el campo est
marcado, tiene que estar creada al menos una variante para el report para poderlo ejecutar.

13. Grupos de Funcin

Nomenclatura ZMMFG_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido por SAP. Inicia
con Z para Objetos nuevos. Letra Y para casos en que el objeto
no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
FG Tipo de Objeto
Identificador de Grupo de Funcin
_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el
carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
Debe ser acorde a la longitud del campo descriptivo.
Ejemplo:
ZFIFG_LIBROS

14. Mdulos de Funcin

Nomenclatura Z_MMFM_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido por SAP. Inicia
con Z para Objetos nuevos. Letra Y para casos en que el objeto
no requiera ser transportado
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

_ Coloque Guin Bajo o


UnderScore
Coloque UnderScore luego de la letra Z o Y, para cumplir con
los espacios de nombres para Clientes(mdulos de Funcin)
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)

_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el


carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
Debe ser acorde a la longitud del campo descriptivo.

Ejemplo: Z_FI_OBTENER_SALDO

15. Mdulos de Funcin Copias de Estndar

Nomenclatura Z_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido por SAP. Inicia
con Z para Objetos nuevos. Letra Y para casos en que el objeto
no requiera ser transportado
_XXX Descripcin
Coloque un guin bajo seguido del Nombre del objeto
estndar

Ejemplo de la Funcin estndar SAVE_TEXT:


Z_SAVE_TEXT

16. Transacciones

Nomenclatura ZMMXXX
Z ID objeto nuevo Identificador de nuevos desarrollos definido para Cliente.
Inicia con Z para Objetos nuevos.
MM Mdulo funcional Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)

NOTA: Para el proceso de Cargas Iniciales colocar las


siguientes siglas: CI

XXX Descripcin
Coloque consecutivo de 3 cifras

Ejemplo: ZSD001, ZMM002, ZCO003, ZFI004


Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Cargas Iniciales, ejemplo de Transacciones: ZCI001, ZCI002, ZCI003

17. Men de mbito.

Nomenclatura ZMM_XXX
Z ID objeto nuevo Identificador de nuevos desarrollos definido para Cliente.
Inicia con Z para Objetos nuevos.
MM Mdulo funcional Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el
carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
Debe ser acorde a la longitud del campo descriptivo.

Ejemplo: ZCO_001

18. Clase de Mensajes.

Nomenclatura ZMM / ZMMXX


Z ID objeto nuevo Identificador de nuevos desarrollos definido para Cliente.
Inicia con Z para Objetos nuevos.
MM Mdulo funcional Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
XX Consecutivo Colocar Consecutivo, nicamente n los casos que aplique(Ver
Notas)
Notas:
- Generar una clase de mensaje general para cada mdulo Ejemplo: ZFI01 Cuando sea su creacin por primera vez.
Ejemplo: ZFI.

- Para casos donde existan o creen aplicaciones de Cliente completas, se recomienda la siguiente Nomenclatura:
ZMMXX. En este caso se debe, luego de colocar las siglas a la cual pertenece, colocar un Consecutivo desde el 01
al 99. Ejemplo: ZMM01

19. Formularios

Nomenclatura ZMMT_XXX
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Z ID objeto nuevo
Identificador de nuevos desarrollos definido para el Cliente.
Inicia con Z para Objetos nuevos. Letra Y para casos en que el
objeto no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
T Tipo de Objeto Colocar los valores siguientes, segn sea el tipo:
Smartforms = SF
SapScript = SS
HR forms = HRF
Estilos = STY
Texto Estndar = ST
Adobe Forms = AF
_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el
carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
Debe ser acorde a la longitud del campo descriptivo.
Ejemplos:
ZMMSF_FACTURA.
ZSDSS_NOTA_CREDITO.
ZHCMHRF_RECIBO_PAGO.
ZFIST_NOTA_FINAL.

20. Generador de clases (class builder)

Los nombres de clases creadas por los desarrolladores estn debidamente definidos en SAP ya que es necesario tener
convenciones estndar para los nombres de los tipos de objetos y sus componentes y usarlos uniformemente dentro del
ambiente de desarrollo.

Convenciones para tipos de objeto

ZCL_<class name>
Clase en la librera Usar nombres en singular:
ZCL_COMPANY_CODE, ZCL_GENERAL_LEDGER_ACCOUNT

ZIF_<interface name>
Interface en la librera Usar nombres en singular:
ZIF_STATUS_MANAGEMANT, ZIF_CHECKER

LCL_<class name>
Clase local en programas Usar nombres en singular:
LCL_TREE_MANAGEMENT

LIF_<interface name>
Interfaz local en programas Usar nombres en singular:
LIF_PRINTER
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Convenciones para componentes

<method name>
Mtodos El nombre debe iniciar con un verbo: GET_STATUS, CREATE_ORDER,
DETERMINE_PRICE

<event name>
Eventos El nombre debe tener la forma: <nombre>_<participio>:
BUTTON_PUSHED, COMPANY_CODE_CHANGED,
BUSINESS_PARTNER_PRINTED

21. Tablas y Estructuras de Datos

Nomenclatura ZMMT_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido para el Cliente.
Inicia con Z para Objetos nuevos. Letra Y para casos en que el
objeto no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
T Tipo de Objeto Colocar los valores siguientes, segn sea el tipo:
Tabla = T
Estructura = S
Vista = V
Tipo Tabla = TT
_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el
carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
segn longitud del campo descriptivo.
Ejemplos:
ZMMT_MATERIALES, ZSDS_VALORES, ZCOV_MEDIDAS, ZFITT_TIPOS.

22. Diccionario de Datos

Nomenclatura ZMMT_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido para el Cliente.
Inicia con Z para Objetos nuevos. Letra Y para casos en que el
objeto no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
T Tipo de Objeto
Colocar los valores siguientes, segn sea el tipo:
Dominio = D
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Elemento de Datos = E

_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el


carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
segn longitud del campo descriptivo.
Ejemplos:
ZMMD_VALOR, ZSDE_VALORES.

23. Estructuras APPEND

Nomenclatura ZMMT_XXX
ZZ ID objeto nuevo
Identificador de nuevos desarrollos definido para el Cliente. En
el caso de Estructuras APPEND, se debe comenzar el Identificar
del objeto colocando dos(2) letras ZZ.
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
T Tipo de Objeto
Colocar los valores siguientes, segn sea el tipo:
Estructura = S
_XXX Descripcin Comience con el carcter Underscore o guion bajo. Para el
caso de las Estructuras APPEND, colocar el nombre de la tabla
madre, en los casos que aplique en relacin a la longitud del
nombre de la tabla.
Ejemplos:
ZZMM_SMEPO1211

24. Ayuda de Bsqueda

Nomenclatura ZMMT_XXX
Z ID objeto nuevo Identificador de nuevos desarrollos definido para el Cliente. En
el caso de Estructuras APPEND, se debe comenzar el Identificar
del objeto colocando dos(2) letras ZZ.
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
TT Tipo de Objeto
Colocar el siguiente valor(Search Help): SH

_XXX Descripcin Comience con el carcter Underscore o guion bajo. Luego,


coloque el nombre de Campo, Elemento de Datos o Tabla para
el cual aplique.
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Ejemplo: ZMMSH_BEDNR, ZFISH_T003

25. Objetos No estandarizados

Para aquellos objetos no tratados en este documento y para casos en que aplique, se deben nombrar, hasta donde sea
posible, de la siguiente manera:

Nomenclatura ZMMT_XXX
Z ID objeto nuevo
Identificador de nuevos desarrollos definido para el Cliente.
Inicia con Z para Objetos nuevos. Letra Y para casos en que el
objeto no requiera ser transportado
MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)
T Tipo de Objeto
Coloque la primera Inicial del tipo de Objeto.(Segn tabla 2)

_XXX Descripcin Descripcin libre de tipo Alfa-numrico. Comience con el


carcter Underscore o guion bajo). Es de libre definicin por
parte del programador y debe reflejar el objetivo a cumplir.
Debe ser acorde a la longitud del campo descriptivo.
Ejemplos:
ZMM_SET.

26. Convenciones de Nombres Internos

La Convencin de nombres debe ser en lo posible, conciso, breve y distinta. Cualquier ambigedad puede ser una
carga para el mantenimiento en el futuro de los desarrollos.

Dicho lo anterior, y para los casos que aplique, a partir de tres(3) categoras de criterios es posible definir una
denominacin definida prcticamente para todas las variables y la mayora de los parmetros que se puedan usar. Para
ello se pueden clasificar de acuerdo a:

Segn su Visibilidad:
Global / Local / Contexto de Clases

Segn su Tipo:
Campo / Estructura / Tipo Tabla / Referencias / Constantes

Segn el Contexto Estructural:


rutinas FORM / Mdulos de funcin / Mtodos

Tabla de Modelos:
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

Visibilidad Prefijo Tipo Prefijo Ejemplo Cdigo


Global G Field D GD_MATNR DATA: gd_matnr TYPE matnr.
Structure S GS_KNB1 DATA: gs_knb1 TYPE knb1.
Table Type T GT_VBAK DATA: gt_vbak TYPE TABLE OF vbak.
Class GO_GRID DATA: go_grid TYPE REF TO cl_gui_alv_grid.
Interface O GO_MSGLIST DATA: go_msglist TYPE REF TO if_reca_message_list.
Data Object DO GDO_DATA DATA: gdo_data TYPE REF TO data.
Constant C GC_LIGHTSPEED CONSTANTS: gc_lightspeed TYPE i VALUE '300000'.

Local L Field D LD_MATNR DATA: ld_matnr TYPE matnr.


Structure S LS_KNB1 DATA: ls_knb1 TYPE knb1.
Table Type T LT_VBAK DATA: lt_vbak TYPE TABLE OF vbak.
Class LO_GRID DATA: lo_grid TYPE REF TO cl_gui_alv_grid.
Interface O LO_MSGLIST DATA: lo_msglist TYPE REF TO if_reca_message_list.
Data Object DO LDO_DATA DATA: ldo_data TYPE REF TO data.
Constant C LC_LIGHTSPEED CONSTANTS: lc_lightspeed TYPE i VALUE '300000'.

Class Context M Field D MD_MATNR DATA: md_matnr TYPE matnr.


Structure S MS_KNB1 DATA: ms_knb1 TYPE knb1.
Table Type T MT_VBAK DATA: mt_vbak TYPE TABLE OF vbak.
Class MO_GRID DATA: mo_grid TYPE REF TO cl_gui_alv_grid.
Interface O MO_MSGLIST DATA: mo_msglist TYPE REF TO if_reca_message_list.
Data Object DO MDO_DATA DATA: mdo_data TYPE REF TO data.
Constant C MC_LIGHTSPEED CONSTANTS: mc_lightspeed TYPE i VALUE '300000'.

27. Cabecera de Cdigo Fuente

Se recomienda la siguiente estructura para la cabecera en el editor de cdigo fuente con el fin de colocar la
informacin relevante del desarrollo. Como buena prctica, dentro del sistema y con el fin de ahorrar tiempo, se
recomienda crear un Patrn con la siguiente estructura:
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

*&---------------------------------------------------------------------*
*& Report ZXXX *
*&---------------------------------------------------------------------*
*& ID Requermto. : *
*& Cliente. . . : MRW *
*& Mdulo . . . : *
*& Solicitado por: Nombre Consultor Funcional *
*& Autor. . . . : usuario SAP / Nombre Consultor ABAP / ABSIDE *
*& Fecha. . . . : *
*& Descripcin. : *
*& Transaccin : *
*& Entradas . . : Ejemplos: Valores/archivo/sistema fuente *
*& Salidas . . : Ejemplos: Impresin pantalla, impresoras, archivos, *
*& sistema destino. *
*&---------------------------------------------------------------------*
*& Lgica del Programa: *
*&---------------------------------------------------------------------*
*&Objetivo: *
*& *
*&---------------------------------------------------------------------*
*& Modificaciones *
*&---------------------------------------------------------------------*
*& Modificacin #: 1 *
*& Fecha . . . : XX/XX/XXXX *
*& Autor. . . . : *
*& Motivo . . . : *
*& Orden Transp. : *
*&---------------------------------------------------------------------*

28. Objetos de Autorizacin( Authority-Checks )

Los objetos de autorizacin de clientes son necesarios cuando se desee aplicar seguridad(lo cual se recomienda) en
programas Z o cuando no aplique la seguridad estndar para el escenario u objeto tratado. Se recomienda levantar
informacin con el cliente sobre la informacin gestionada por la aplicacin y si requiere chequeos de autorizacin. De ser
afirmativo la respuesta, se deben agregar a los nuevos programas desarrollados. Esta sentencia nos permite comprobar
las autorizaciones de un usuario a determinada actividad. Recordemos que dichas autorizaciones forman parte del perfil
de usuario y el sistema las guarda en el maestro de los mismos. Los objetos de autorizacin disponibles se encuentran en
las transacciones SU20 y SU21. Mediante la primera se puede buscar por campo/elemento de datos los objetos
disponibles.

Para casos en que no apliquen objetos de autorizacin estndar, se debe crear uno nuevo. Para ello se debe seguir la
siguiente Nomenclatura:

Nomenclatura ZMMT_XXX
Z ID objeto nuevo Inicia con Z para Objetos nuevos. Letra Y para casos en que el
objeto no requiera ser transportado
Proyecto Tubrica - Tubosa
Fase: Realizacin
Actividad: Documento Tcnico de Desarrollos
Entregable: Convenciones y Nomenclatura para Objetos ABAP

MM Mdulo funcional
Siglas del mdulo que utiliza el objeto segn la nomenclatura
de SAP (tabla 1)

_XXX Descripcin Comience con el caracter Underscore o guion bajo. Luego


colocar nombre de campo/elemento de datos segn
necesidad.
Ejemplo:

Objeto de Autorizacin de Cliente(Z)


authority-check object 'ZFI_BELNR'
id 'BUKRS' field p_bukrs
id 'ACTVT' field '03 '.
if sy-subrc <> 0.
message e001 with p_bukrs. No tiene autorizacin para la sociedad &.
endif.

Objeto de Autorizacin de estndar


AUTHORITY-CHECK OBJECT 'F_BKPF_GSB'
ID 'GSBER' FIELD p_gsber.
IF sy-subrc <> 0.
MESSAGE e809(fr) WITH p_gsber.
ENDIF.

Das könnte Ihnen auch gefallen