GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 1 de 18
Contenido
INTRODUCCIÓN .................................................................................................................................................................... 2
2. Tipos de módulos (TM) y sub-módulos (SM) ................................................................................................................ 2
3. Programas ejecutables (se38). ...................................................................................................................................... 3
4. Objetos creados en el diccionario de datos. ................................................................................................................. 5
5. Variables y tablas internas ............................................................................................................................................... 7
6. Orden de transporte ....................................................................................................................................................... 9
6.1) Para aquellos clientes que no manejan un Ricef...................................................................................................... 10
6.2) Documentación ....................................................................................................................................................... 11
7. ESTÁNDARES HCI ............................................................................................................................................................ 11
8. Estándares PI/PO ............................................................................................................................................................ 14
8.1. OBJETOS DEL ENTERPRISE SERVICE REPOSITORY ............................................................................................ 14
8.2. OBJETOS DEL INTEGRATION DIRECTORY 2.1. .................................................................................................. 16
8.3. BPM (BUSINESS PROCESS MANAGEMENT) .................................................................................................. 17
8.4. BRM (BUSINESS RULES MANAGEMENT) ...................................................................................................... 17
9. Vistas Hana ..................................................................................................................................................................... 18
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 2 de 18
INTRODUCCIÓN
1. Este documento describe la política y los procedimientos para la nomenclatura de los objetos ABAP,
HCI, PI/PO. Todas las personas del equipo de desarrollo deben seguir tales procedimientos.
2. Tipos de módulos (TM) y sub-módulos (SM)
Módulos y Sub-módulos LO QM Gestión de Calidad
FI Contabilidad LO PM Mantenimiento de
financiera planta
MP SM
FI GL Contabilidad general
FI AR Cuentas a Cobrar
FI AP Cuentas a Pagar
FI AA Contabilidad de
Activos
WF Workflow
FI TR Tesorería
FI PS Gestión de Proyectos
LO Logísticos
MP SM
LO SD Ventas y distribución
LO MM Manejo de
Materiales
LO PP Planificación y
producción
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 3 de 18
ZTOSM####_#_C(Includ cla)
ZTOSM####_#_F(Includ fun)
3. Programas ejecutables (se38).
ZTOSM####_#_I(Include PAI)
ZTOSM####_#_O(Include PBO)
Principales
TO Tipos programa y objetos: Ej:
RP->Reporte
MP->Module Pool ZRPSD2418_1_V
FG->Grupo de Función ZRPSD2418_1_P
FM->Modulo de función ZRPSD2418_1_C
CL->Clases ZRPSD2418_1_F
ZRPSD2418_1_I
TM->Tipo de modulo ZRPSD2418_1_O
SM->Sub-modulo
Y->Programa prueba
Z->Programa final Module Pool
####->RICEF ZMPSM####_#_TOP
xxxx->Descripción ZMPSM####_#_PAI
#-Consecutivo del programa ZMPSM####_#_PBO
ZMPSM####_#_F
ZTOTMSM####_#
EJ: EJ:
ZRPLOSD2560_1 ZPMSD2418_1_TOP
ZPMSD2418_1_PAI
Include report(SE38 ) (SE80) ZPMSD2418_1_PBO
ZPMSD2418_1_F
ZTOSM####_#_V (Includ var)
ZTOSM####_#_P(includ Par)
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 4 de 18
Grupo de función (SE37) JOB (SE36)
ZFGSM####_# Frecuencia del programa (F)
EJ:
ZFGSD2418_1 A Año
D Día
Módulo de Función S Semana
ZFMSM####_# M Mes
EJ: ZFMSD2418_1 H Hora
Variantes ZFSM####_#
ZVTSM_#### EJ:
ZASD2418_1
ZDSD2418_1
Grupo de función (Vista de
actualización) Puntos de ampliación:
ZTSM####_#_V Z_Nombre del Programa
EJ estándar_sm_####_#
ZTSD2418_1_V
Implementación BADI(SE19)
Rangos de números ZBADI_SM _####_#
ZRNSM####_#
EJ. Clase de implementación
ZRNSD2418_1 ZBADICL_ SM _####_#
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 5 de 18
Formulario (SE71- Código de transacción (SE93)
SMARTFORMS) ZTRSSM####_#
Sapscript|smartforms|styles(FF) EJ:
ZFFSM####_# ZTRSMM2018_1
FF: Tipo de Formulario
ST->Sapscript
SF->Smartforms
AD->ADS
ST->Styles
4. Objetos creados en el diccionario de
Ej: datos.
ZSTSD2418_1
Tablas | vistas | Estructuras (SE11)
ZSFSD2418_2
Clase mensaje (SE91) ZTSM####_# -> Tabla
ZMSGSM####_# ZVSM####_# -> Vista
EJ: ZESM####_#-> Estructura
ZMSGSD2418_1
Tipos
Texto estándar(SO10)
ZTXTSM####_# T Tablas
V Vistas
EJ: ES Estructuras
ZTXTSD2418_1
EJ:
LSMW
Proyecto: ZTM####xxxxxx ZTSD2418_1(Tabla)
Subproyecto: TM-SM ZVSD2418_1(Vista)
Objeto: ####_#_xxxxx ZESD2418_1(Estructura)
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 6 de 18
Elemento de datos EJ:
ZDESM###_# ZCVSD2418_1
Ej; Objeto de autorización
ZDESD2418_1 ZOASM_#
Dominio Objeto de Bloqueo
ZDMSM###_# EOB_TABLA
Ej: EJ:
ZDMSD2418_1Append Structure EOB_ZTSD2418_1
ZASSM_####_# Índices de Tabla
Tipos tabla Z##
ZTTSM####_# Campos: Si el campo existe en SAP se debe tener el
mismo nombre y si no existe se debe nombrar así:
TTXXXX descripción, hasta 15 caracteres.
Ej;
TT Tipo de datos
ZTTSD2418_1
NM Numérico
Ayudas o search Help
CD Carácter para código
ZSHSM####_# DS Carácter para descripción
PT Valor
EJ:
FE Fecha
ZSHSSD2418_1
PO Porcentaje
Clúster vistas SN Selección Si/No
ZCVSM####_#
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 7 de 18
5. Variables y tablas internas
Ámbito
Global G
Local L
Module Pool (Dynpros)
Tipos de variables Text field TF_libre
Group Box GB_ libre
C Carácter
Radio Button RB_libre
F Fecha
Push Button BT_libre
U Punto flotante Sub-screen SS_libre
TabStrip TS_libre
N Texto numérico
Table control TC_libre
P Numero empaquetado Gui status GS_Num
consecutivo(4)
H Hora
GUI Title GT_Num
X Hexadecimal consecutivo(4)
R Rango
O Objeto
E Entero
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 8 de 18
Variable Ámbito + Tipo _ libre Variables de propósito general.
GI_+ Libre Donde I se utilizan los tipos y ámbito en el siguiente
Ej.: “GE_CANTIDAD” cuadro
Tabla Interna Ámbito + TI_ + libre Tablas Internas para guardar grupos de datos (tipo
LTI_+ Libre registro)
Estructura Ámbito + WA_ + libre Estructura para almacenar un solo registro de datos
LWA_ + libre
Parámetro PA_ + libre Variables para entrar datos antes de la ejecución
programa. Permiten máximo 8 caracteres
Select-Option SO_ + libre Variables (tipo tabla interna) para entrar datos de rango
antes de la ejecución del programa. Permite máximo 8
caracteres
Field Symbol Ámbito + Tipo + _ + libre Fields Symbols
<GFS_ + libre + >
<LFS_” + libre + >
Constante Ámbito + CTE_ + libre Variables tipo constante no pueden cambiar durante la
<LCTE_+ libre > ejecución de los programas
<GCTE_ + libre >
Tipo Local Ámbito + TY_ + libre Tipo de datos global
GTY_ + libre Tipo de datos local
LTY_ + libre
Tipo tabla Ambito+TT+_+libre Tipo tabla creado en el código del desarrollo
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 9 de 18
Parámetros de subrutinas y funciones
Rutina internas y Using -> P_Tipo_libre
variables CHANGING-
>P_+Tipo+_libre
Tablas y estructuras Using->P_(WA)o(TI)_libre
CHANGING-
>P_(WA)o(TI)_libre
Funciones y clases Import->I_tipo_libre
Export->E_ tipo_libre
Changing->C_ tipo_libre
6. Orden de transporte
FDS-CLIENT-MD-SM-####-NomDes -(PRY) O (REQ)-#OT
FDS->NW
Client->Cliente
MD->Modulo
SM->Submodulo
####->Ricef
NomDes->Nombre desarrollo
PRY->Proyecto
REQ->Requerimiento
#OT->Consecutivo de la OT
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 10 de 18
Paquete de Documentación:
A la hora de enviar la documentación el Paquete debe ser .ZIP
EF: Especificación funcional
ET: Especificación Técnica
TE: Test de ejecución
MU: Manual de usuario
LOG: Log de auditoria.
PG: Parametrización General
NW-PREB-LO-SD-0001-EF-Facturacion abierta de recado PRY
NW-PREB-LO-SD-0001-ET-Facturacion abierta de recado PRY
NW-PREB-LO-SD-0001-TE-Facturacion abierta de recado PRY
NW-PREB-LO-SD-0001-MU-Facturacion abierta de recado PRY
NW-PREB-LO-SD-0001-LOG-Facturacion abierta de recado PRY
NW-PREB-LO-SD-0001-PG-Facturacion abierta de recado PRY
NOTA: En su operación NetW cuenta con diversos clientes, algunos han definido sus propias metodologías de
programación y documentación; Otros al interior de sus procesos no han establecido algún tipo de estándar y/o
forma de nomenclatura. Será una labor de NetW que el consultor líder presente los estándares de calidad
definidos por la organización ha dicho cliente.
A continuación, se detallará la forma cómo se deben entregar los desarrollos y la documentación:
6.1) Para aquellos clientes que no manejan un Ricef en específico el consultor realizara lo siguiente:
OT Desarrollo nuevo
NW+CLIENTE+TM+SM+##+ Nombre del desarrollo
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 11 de 18
Ej. NW-PREBEL-LO-SD-01-facturacion electrónica
Nota: Esta forma de nombrar la OT solo será para los desarrollos nuevos.
OT Control de cambio
Los desarrollos que son controles de cambio se nombraran así:
NW+CLIENTE+TM+SM+NOMBRE DEL REPORT +Nombre del desarrollo
Ej. NW-PREBEL-LO-SD-ZR-facturación electrónica.
6.2) Documentación
Al cliente se le entregará únicamente la documentación requerida por este, con el fin de generar valor agregado
NetW realiza una revisión de la documentación antes de ser enviada al cliente, por tal motivo es necesario enviar
un correo al área de auditoria para verificar que los estándares se encuentran acordes a los definidos y que
queda la trazabilidad de dicha documentación.
7. ESTÁNDARES HCI
Responsables de la Andrés Felipe Gallo
solicitud
Fecha Creación 12/03/2018
Cliente: NETW
Nombre Jan Sebastian Jaramillo Arroyo
Especificador
FDS NetW Consulting
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 12 de 18
7.1. La nomenclatura en HCI debe ser nemotécnica, es decir que permita identificar todos los artefactos que
involucren una integración, empezando por las terminales, como los sender y receiver, también se recomienda
para los nombres de los iflows y los paquetes de integración.
a). Estándar para nombres de paquetes de integración
Integration_package_nombre cliente_nombre legado_ambiente.
b). Estándares para nombres de iflows.
Destino_origen.(nombre integración sea libre o entregada por el cliente).
C). Estandares nombres sender y receiver.
Para el sender sería el sistema de origen y para el receiver o los receivers son los sistemas de destino.
7.2. hay que tener en cuenta que a nivel de integración hallan máximo 15 artefactos, para manejar un orden de
la misma, si se requieren más se recomienda usar llamados locales.
7.3. se recomienda emplear un solo sender en un iflow.
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 13 de 18
7.4. Se recomienda no usar HCI para escenarios on-premise on-premise
7.5. Para ingresar datos hacia el ERP se recomienda el uso de web service, ya sean expuestos por PI o por
soamanager. Aunque no se considera mala práctica entrar por un servicio expuesto por la SICF.
7.6. En los mapeos se recomienda lo siguiente:
a) Seguir los estándares de java para las udf aunque estos no apliquen mucho siendo que el lenguaje que se
trabaja es groovy script.
b) En el área de mapeo no deben ir más de 15 elementos, en lo posible emplear funciones estándar por sap, si
es necesario emplear udf que faciliten su desarrollo.
7.7. Se debe marcar los codigos en java script y groovy scrypt de la siguiente manera, en los bloques script.
/*
*-----------------------------------------------------------------------------*
Información General
*-----------------------------------------------------------------------------*
Descripción: Indicar el propósito de la función
Autor: Quien la creó
Fábrica de software: Empresa que hizo la función
Fecha de Creación: Fecha en formato YYYY.MM.DD
*-----------------------------------------------------------------------------*
*/
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA .
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 14 de 18
7.8. Los bloques scripts deben evitar tener más de tres ciclos for anidados.
7.9. se debe emplear excepciones de error a nivel del iflow.
7.10. se debe generar log de la carga útil que entra en el iflow y en el que llega a los diferentes destinos.
7.11. Se debe evitar emplear el parallel multicast en iflows, si se usa es porque existe la necesidad de llamar más
de dos receivers al mismo tiempo.
7.12. Se debe garantizar con el mecanismo manual de exactly once diseñado, que las integraciones asíncronas
que puedan verse afectadas por cuestiones de datos masivos, este implementado.
8. Estándares PI/PO
8.1. OBJETOS DEL ENTERPRISE SERVICE REPOSITORY 1.1. Espacio de Nombres (Namespace)
Se define un espacio de nombres para el trabajo dentro del proyecto, con el fin de evitar conflictos entre los
tipos de objetos en el Enterprise Service Repository (ESR).
Para el proyecto Pasaporte, se define que el espacio de nombres está definido hacia los procesos de
negocio, por tanto, se define la siguiente estructura:
urn:‹Compañía>:‹Aplicación de Negocio>:‹Proceso>:‹Paso de
Negocio> Para el sistema ERP:
Objetos de Negocio:
<Compañía>20
ERP_COMMON
urn:‹Compañía>: globales
urn:‹Compañía>: maestros
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 15 de 18
urn:‹Compañía›: transaccionales
Para mensajes de mapeo y operaciones de mapeo:
<Compañía> M ERP COMMON
urn:‹ Compañía>: erp:<Nombre Legado>: mapeos
Para interfaces de entrada, salida de maestros:
<Compañía> I ERP_MAESTROS
urn:‹ Compañía>:
erp:maestros
Para interfaces de entrada, salida de procesos transaccionales:
<Compañía> I ERP_<Modulo SAP>
urn:‹ Compañía>: erp:<Modulo SAP>: transaccionales
Para los sistemas LEGADOS:
Para interfaces de entrada, salida o definiciones externas:
<Compañía> I <Nombre LEGADO>
urn:‹Compañía:‹Nombre Legado>: maestros
urn:‹Compañía:‹Nombre Legado>: transaccionales
urn:‹Compañía:‹Nombre Legado>: definiciones Externas
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 16 de 18
8.1.1. Tipos de datos (Data Type)
Los tipos de datos describen la estructura de los mensajes. Para su identificación se define la siguiente
estructura: <Business Object>
8.1.2. Tipos de Mensajes (Message Type)
Los tipos de mensajes incluyen un Data Type que describe la estructura de un mensaje. Define el
elemento raiz de un mensaje. Para su identificación se define la siguiente estructura:
<Business Object><Action>
8.1.3. Interfaces de Servicio (Service Interface)
Una Interfaz de servicio es la representación en diseño, de un servicio. Para la identificación de las
Service Interfaces, se define la siguiente nomenclatura:
<Business Object>_<Direction>
8.1.4. Mapeo de Mensaje (Message Mapping)
Los rnapeos de mensaje establecen la estructura de los rnapeos entre dos estructuras XML. Se
identifican así: <Source Message Type>_to_< Target Message Type>
8.1.5. Operation Mapping
Las operaciones de mapeo contienen los programas de mapeo entre los XML involucrados. Para su
identificación se define:
<Source Service Operation>tc_<Target Service Operation>
8.2. OBJETOS DEL INTEGRATION DIRECTORY 2.1.
Canal de Comunicación (Communication Channel)
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 17 de 18
Los canales de comunicación definen los detalles para el procesamiento de inbound a outbound de un
mensaje. Se identifica así:
<Adapter Type><Direction><Business Object>
8.2.1. Flujo de Integración (IFlow)
Los flujos de integración definen los detalles de la configuración de la comunicación entre SAP ERP y los
sistemas. Se identifica así:
<Business Qbject>_<Dfrection>_<Sistema Técnico SAP>_<Mandante>
8.3. BPM (BUSINESS PROCESS MANAGEMENT)
Los BPM (Gestión de Procesos de Negocio) se utilizan en un proceso de integración para la orquestación de
servicios: Se identifica así:
<Business Object><General Action 1 Pattern>
8.4. BRM (BUSINESS RULES MANAGEMENT)
Las BRM (Gestión Reglas de Negocio) describen las políticas y restricciones que definen las decisiones de negocio de
la organización, ayuda a estandarizar y optimizar sus reglas de negocio con el fin de lograr una mayor
visibilidad, centralización y la coherencia de las decisiones clave de negocio.
<Business Object><General Action 1 Pattern>.
GT-ST-GI-001 Versión 002
ESTÁNDARES DE NOMENCLATURA
Fecha: 18/06/2018
ABAP, HCI, PI/PO.
Página 18 de 18
9. Vistas Hana
Core Data Service
ZCDSSMobj
Vista Atributos
ZVATSMobj
Vista Analítica
ZVANSMobj
Vista Calculada
ZVCASMobj
Obj = Objeto de búsqueda (EJ: Material ) o Ricef
Parámetros de Entrada
IP_NOMBREPARAMETRO
Procedimientos Almacenados
ZSP_NOMBREPROCEDIMIENTO