Diferencias

Muestra las diferencias entre dos versiones de la página.

--- ada:howto:sicoferp:factory:logmodels:message [2021/08/30 18:10]
administraidor
+++ ada:howto:sicoferp:factory:logmodels:message [2021/09/20 12:47] (actual)
administraidor
@@ Línea 61: / Línea 61: @@
 ==== Proceso de Creación de Mensajes ====
-Todos los mensajes utilizados en las aplicaciones deben ser registrados en esta tabla. A continuación se describen los campos que deben ser incluidos en la creación:
+Todos los mensajes utilizados en las aplicaciones deben ser registrados en esta tabla. A continuación se describen los campos que deben ser incluidos en la creación segun el tipo de mensaje:
 ^# ^Campo ^Observación ^^
 |1|CODIGO_MENSAJE|**Requerido**: Se debe enviar el siguiente numero disponible en la columna. Puede utilizar la siguiente sentencia para asegurar la condición requerida: SELECT NVL(MAX(CODIGO_MENSAJE), 0) + 1 FROM  PRESUP01.MENSAJES_SISTEMA||
 |2|MENSAJE|**Requerido**: El mensaje debe claro y conciso. No debe generar ambiguedades en los usuarios y no debe estar expresado en lenguaje técnico.||
-|3|INFORMATION|Esta columna debe ser enviada con el valor 'S' si el mensaje es informativo. De lo contrario debe ser enviado en 'N'||
+|3|INFORMATION|Esta columna debe ser enviada con el valor 'S' si el mensaje es **Informativo**. De lo contrario debe ser enviado en 'N'||
-|4|STOP|Esta columna debe ser enviada con el valor 'S' si el mensaje es de error. De lo contrario debe ser enviado en 'N'||
+|4|STOP|Esta columna debe ser enviada con el valor 'S' si el mensaje es de **Error**. De lo contrario debe ser enviado en 'N'||
-|5|EXCLAMATION|Esta columna debe ser enviada con el valor 'S' si el mensaje es de advertencia. De lo contrario debe ser enviado en 'N'||
+|5|EXCLAMATION|Esta columna debe ser enviada con el valor 'S' si el mensaje es de **Advertencia**. De lo contrario debe ser enviado en 'N'||
-|6|QUESTION|Esta columna debe ser enviada con el valor 'S' si el mensaje es de confirmación. De lo contrario debe ser enviado en 'N'||
+|6|QUESTION|Esta columna debe ser enviada con el valor 'S' si el mensaje es de **Confirmación**. De lo contrario debe ser enviado en 'N'||
 |7|NONE|Esta columna debe ser enviada con el valor 'S' si el mensaje no lleva ícono. De lo contrario debe ser enviado en 'N'||
 |8|OK|Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton **Aceptar**. De lo contrario debe ser enviado en 'N'||
@@ Línea 86: / Línea 86: @@
 |21|CODIGO|**Requerido**: Código Texto del Mensaje Ej: TERCERO_NOT_FOUND, CDP_NO_BALANCE etc.||
 |22|TITULO|**Requerido**: Título del mensaje el cuál es utilizado en la barra de titulo de la ventana.||
-|23|OBSERVACIONES|Este campo solo es requerido cuando el mensaje requiere gestión y debe presentar información complementaria que oriente al usuario sobre la situación notificada en el mensaje. Puede llevar pasos, consejos o indicaciones. De lo contrario se ignora esta columna.||
+|23|OBSERVACIONES|Este campo solo es requerido cuando el mensaje requiere gestión y debe presentar información complementaria que oriente al usuario sobre la situación notificada en el mensaje.||
+=== Reglas para la columna: OBSERVACIONES ===
+Si un mensaje debe mostrar más información respecto a la situación notificada se debe utilizar esta columna. Sin embargo debe tener presente la siguientes indicaciones:
+  * Si el mensaje requiere gestión de un proceso esta columna se debe describir con una serie de pasos de las acciones a realizar.
+  * Si el mensaje indica una situación puntual esta columna debe indicar la razon de la situación presentada e indicar al usuario la acción a seguir.
+  * La información debe ser clara y evitar ambiguedades.
+  * Se Debe utilizar un lenguaje acorde al usuario.
 === Reglas para la columna: TIPO_PROCESO ===
-Esta columna debe contener el nombre de la funcionalidad a la cuál pertenece el mensaje, Ejmeplos:
+Esta columna debe contener el nombre de la funcionalidad a la cuál pertenece el mensaje, Ejemplos:
   * Disponibilidad
@@ Línea 98: / Línea 106: @@
 === Reglas para la columna: CODIGO ===
-Esta columna representa un código en texto del mensaje. Tener presenta las siguientes consideraciones para la generación de los código externos de los mensajes:
+Esta columna representa un código en texto del mensaje. Tener presente las siguientes consideraciones para la generación de los código externos de los mensajes:
-== Regla Identificador ==
+== Identificador ==
-Debe empezar con el identificador del proceso o entidad que representa en mayúsculas, no debe tener espacios ni separadores al comienzo e intermedio del texto y debe finalizar co el separador _ Ejemplos:
+Debe empezar con el identificador "SICOF" en mayúsculas seguido por el número de la aplicación de la tabla SICOF.MAE_APLICACIONES columna CODIGO((Si el código es menor a 3 dígitos se deben rellenar con ceros a la izquierda. Ejemplo 1 = 001)), no debe tener espacios ni separadores al comienzo e intermedio del texto y debe finalizar con el separador _ Ejemplos:
-^Módulo^Funcionalidad^Identificador^
+^Módulo^Identificador^
-|SISTEMA DE CONTROL PRESUPUESTAL|ADMINISTRACION CONTROL PRESUPUESTAL|ADMINPRESUP_|
+|FUNCIONALIDADES TRANSVERSALES |SICOF000_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|ADMINISTRADOR DEL SISTEMA|ADMINSYSPRESUP_|
+|SISTEMA DE CONTROL PRESUPUESTAL |SICOF001_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|ANTICIPOS|ANTICIPOS_|
+|SISTEMA DE CONTROL DE TESORERIA |SICOF002_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|COMPROMISOS|RP_|
+|SISTEMA DE CONTROL DE CONTABLE |SICOF003_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|CONTABILIDAD|CONTA_|
+|SISTEMA DE COMPRAS |SICOF004_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|CONTRALORIA|CONTRA_|
+|SISTEMA DE NOMINA |SICOF005_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|CUENTAS POR COBRAR|CXC_|
+|SISTEMA DE TALENTO HUMANO |SICOF010_ |
-|SISTEMA DE CONTROL PRESUPUESTAL|DISPONIBILIDADES|CDP_|
-|SISTEMA DE CONTROL PRESUPUESTAL|INFORMES DE CONTABILIDAD|REPORTCONTA_|
-|SISTEMA DE CONTROL PRESUPUESTAL|MAESTROS|MAEPRESUP_|
-|SISTEMA DE CONTROL PRESUPUESTAL|MOVIMIENTO RUBROS|MOVRUBROS_|
-|SISTEMA DE CONTROL PRESUPUESTAL|ORDENES DE PAGO|OP_|
-|SISTEMA DE CONTROL PRESUPUESTAL|PAGOS NOMINA|PAGONOM_|
-|SISTEMA DE CONTROL PRESUPUESTAL|PRESUPUESTO INGRESOS|PRESUPING_|
-|SISTEMA DE CONTROL PRESUPUESTAL|PROGRAMACION PAC|PAC_|
-|SISTEMA DE CONTROL PRESUPUESTAL|REINTEGROS|REINTE_|
-|SISTEMA DE CONTROL PRESUPUESTAL|REPORTES|REPORT_|
-|SISTEMA DE CONTROL PRESUPUESTAL|REPORTES CIERRE VIGENCIA|REPORTCIERREVIG_|
-|SISTEMA DE CONTROL PRESUPUESTAL|RESERVAS|RESER_|
-|SISTEMA DE CONTROL DE TESORERIA|ADMINISTRADOR DEL SISTEMA|ADMINSYSTESORE|
-|SISTEMA DE CONTROL DE TESORERIA|BANCOS|BANK_|
-|SISTEMA DE CONTROL DE TESORERIA|CAJAS MENORES|CAJAMEN_|
-|SISTEMA DE CONTROL DE TESORERIA|COMPROBANTE DE EGRESO|CE_|
-|SISTEMA DE CONTROL DE TESORERIA|COMPROBANTE DE INGRESO|CI_|
-|SISTEMA DE CONTROL DE TESORERIA|CONCILIACION BANCARIA|CONCIBANC_|
-|SISTEMA DE CONTROL DE TESORERIA|DEUDA PÚBLICA|DEUDAPUB_|
-|SISTEMA DE CONTROL DE TESORERIA|FONDO DE CONTINGENCIAS|FONDOCONTING_|
-|SISTEMA DE CONTROL DE TESORERIA|INTERFACE|SUPERTABLA_|
-|SISTEMA DE CONTROL DE TESORERIA|MAESTROS|MAETESORE_|
-|SISTEMA DE CONTROL DE TESORERIA|MANTENIMIENTO P.A.C.|ADMINPAC_|
-|SISTEMA DE CONTROL DE TESORERIA|PAGO ELECTRONICO|PAGOELEC_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Bancos)|REPORTBANK_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Comprobantes de Contabilidad)|REPORTCOMPTTESORE_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES ESTADISTICOS|REPORTESTATESORE_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Pago Electronico)|REPORTPAGOELECT_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Pagos y Taquillas)|REPORTPAGOTAQUI_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Plan Anual de Caja)|REPORTPAC_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Rendicion de Cuentas)|REPROTRENDCUENT_|
-|SISTEMA DE CONTROL DE TESORERIA|REPORTES (Retencion en la Fuente)|REPORTRTEFTE_|
-|SISTEMA DE CONTROL DE CONTABLE|ADMINISTRADOR DEL SISTEMA|ADMINCONTA_|
-|SISTEMA DE CONTROL DE CONTABLE|ASIENTOS CONTABLES|ASIENTOS_|
-|SISTEMA DE CONTROL DE CONTABLE|CONSULTAS|CONSULTCONTA_|
-|SISTEMA DE CONTROL DE CONTABLE|DETERIORO|DETERIOR_|
-|SISTEMA DE CONTROL DE CONTABLE|MAESTROS|MAECONTA_|
-|SISTEMA DE CONTROL DE CONTABLE|MEDIOS MAGNETICOS DIAN|MEDIOSMAGDIAN_|
-|SISTEMA DE CONTROL DE CONTABLE|PLAN CUENTAS CONTABLES|PUC_|
-|SISTEMA DE CONTROL DE CONTABLE|REPORTES|REPORTCONTA_|
-|SISTEMA DE COMPRAS|ACTIVOS FIJOS|ACTIVOSFI_|
-|SISTEMA DE COMPRAS|ADMINISTRADOR DEL SISTEMA|ADMINCOMPRAS|
-|SISTEMA DE COMPRAS|COTIZACIONES|COTIZA_|
-|SISTEMA DE COMPRAS|INVENTARIOS|INVENTA_|
-|SISTEMA DE COMPRAS|MAESTROS|MAECOMPRAS_|
-|SISTEMA DE COMPRAS|REPORTES|REPORTCOMPRAS_|
-|SISTEMA DE COMPRAS|SOLICITUD DE BIENES|SOLICBIEN_|
-|SISTEMA DE COMPRAS|SOLICITUD DE COMPRA|COLICCOMP_|
-|SISTEMA DE NOMINA|ADMINISTRADOR DEL SISTEMA|ADMINNOM_|
-|SISTEMA DE NOMINA|CONFIGURACIÓN|CONFIGNOM_|
-|SISTEMA DE NOMINA|INFORMES|INFONOM_|
-|SISTEMA DE NOMINA|NOVEDADES|NOVEDA_|
-|SISTEMA DE NOMINA|OPERACION|OPERACI_|
-|SISTEMA DE NOMINA|PAGO AUTOMATICO SIIF|PAGOSIIF_|
-|SISTEMA DE NOMINA|PRESTACIONES SOCIALES|PRESTASOCIA_|
-|SISTEMA DE NOMINA|SEGURIDAD SOCIAL|SEGURSOCIAL_|
-|SISTEMA DE NOMINA|UTILIDADES|UTILINOM_|
-|SISTEMA DE TALENTO HUMANO|ADMINISTRADOR DEL SISTEMA|ADMINTALE_|
-|SISTEMA DE TALENTO HUMANO|APOYO ESTUDIANTIL|APOYOESTUD_|
-|SISTEMA DE TALENTO HUMANO|APROVECHAMIENTO TIEMPO LIBRE|APROVTIEMLIBR_|
-|SISTEMA DE TALENTO HUMANO|BECAS|BECAS_|
-|SISTEMA DE TALENTO HUMANO|CONVOCATORIAS|CONVOCATIAS_|
-|SISTEMA DE TALENTO HUMANO|CUENTAS X COBRAR|CXCTALEN_|
-|SISTEMA DE TALENTO HUMANO|DOTACION|DOTACION_|
-|SISTEMA DE TALENTO HUMANO|ENCUESTAS| |
-|SISTEMA DE TALENTO HUMANO|ESTIMULO EDUCATIVO| |
-|SISTEMA DE TALENTO HUMANO|EVALUACIONES| |
-|SISTEMA DE TALENTO HUMANO|EVENTOS| |
-|SISTEMA DE TALENTO HUMANO|FORMULARIOS| |
-|SISTEMA DE TALENTO HUMANO|HOJAS DE VIDA| |
-|SISTEMA DE TALENTO HUMANO|INCENTIVOS| |
-|SISTEMA DE TALENTO HUMANO|INFORMES ADICIONALES| |
-|SISTEMA DE TALENTO HUMANO|MOVIMIENTO RUBROS| |
-|SISTEMA DE TALENTO HUMANO|OTROS CREDITOS| |
-|SISTEMA DE TALENTO HUMANO|PROGRAMA DE VIVIENDA| |
-|SISTEMA DE TALENTO HUMANO|SALUD OCUPACIONAL| |
-|SISTEMA DE TALENTO HUMANO|SEGURIDAD Y SALUD EN EL TRABAJO| |
+== Regla Nombre ==
+El nombre del código del error debe ser un resumen del mensaje que se adiciona al identificador, este (si aplica) solo puede llevar el separador _ y se deben evitar los caraceres especiales y tildes. Tener en cuenta las siguientes consideraciones:
+  * Nombre [[https://es.wikipedia.org/wiki/C%C3%B3digo_mnemot%C3%A9cnico|nemotécnico]]((Un código mnemotécnico (o código nemotécnico) es un sistema sencillo utilizado para recordar una secuencia de datos, nombres, números, y en general para recordar listas de items que no pueden recordarse fácilmente.)) del error((Puede estar en inglés)).
+  * Resumen del error((Puede estar en inglés)).
+  * Palabras clave del error((Puede estar en inglés)).
+== Ejemplo ==
+Para el mensaje "//No existe el tercero con el nit.//" se crearía el CODIGO de la siguiente forma:
+  * Identificador: **SICOF000_** Ya que es una funcionalidad transversal.
+  * Nombre: **TERCERO_NOT_FOUND**((no existe))
+Mensaje: No existe el tercero con el nit.
+Código de Error: SICOF000_TERCERO_NOT_FOUND
 === Ejemplo Script de Inserción ===
@@ Línea 194: / Línea 140: @@
 --==============================================================================
 -- Fecha: 10:03 a. m. lunes, 30 de agosto de 2021 - carlos.torres@ada.co
--- Crear Mensaje para validar existencia del tercero.
+-- Crear Mensaje de Error para validar existencia del tercero.
 --==============================================================================
 Insert into PRESUP01.MENSAJES_SISTEMA
@@ Línea 203: / Línea 149: @@
     TITULO)
  Values
-   ((SELECT NVL(MAX(CODIGO_MENSAJE), 0) + 1 FROM  PRESUP01.MENSAJES_SISTEMA), 'No existe información del tercero con el Nit #1', 'N', 'S', 'N',
+   ((SELECT NVL(MAX(CODIGO_MENSAJE), 0) + 1 FROM  PRESUP01.MENSAJES_SISTEMA),
+   'No existe información del tercero con el Nit #1', 'N', 'S', 'N',
     'N', 'N', 'S', 'N', 'N',
     'N', 'N', 'N', 'N', 1,
-    '9999999999', SYSDATE, 'Tercero', 'TERCERO_NOT_FOUND',
+    '9999999999', SYSDATE, 'Tercero', 'SICOF000_TERCERO_NOT_FOUND',
     'Validación del Tercero');
 COMMIT;
 </code>
+==== Modo de uso: Powerbuilder - Documentación ====
+Para visualizar la documentación debe descargar el siguiente repositorio [[http://adacsc.co:1443/svn/repository/ADA/SICOF/Objetos%20SICOF/FUENTES/branches/branches%2012.5.2.5.0/doc/documentacion|Documentación]], abrir la pagina Index.html en su navegador web la cual es similar a la siguiente imagen:
+{{ :ada:howto:sicoferp:factory:logmodels:pbdoc_objetos_sicof.png?600 |}}
+En ella encontrará la documentación de las librerias que hacen parte del framework **Objetos SICOF** el cuál se irá actualizando frecuentmente a medida que se documenten las clases.
+La Libreria que contiene la funcionalidad del API de mensajes es la librería **sf00util.pbl**
+Los Objetos relacionados en el API son:
+  * **n_cst_app**: Clase contenedora del API de mensajes
+  * **n_cst_msg**: Clase utilizada para la gestion de los mensajes que se visualizan en las aplicaciones.
+=== Ejemplos de Uso ===
+Para facilitar la implementación y uso del API de gestión de mensajes se crea un objeto interno privado en la clase global **guo_app** el cual puede ser accedido por el método **of_msg()** que devuelve la instancia del objeto. Sin embargo para implementaciones específicas se puede optar por crear y administrar la clase de mensajes **n_cst_msg** según considere el desarrollador.
+A continuación se listan ejemplos de uso el cuál presenta las forma de utilizar el API, para más información debe consultar la documentación en el repositorio.
+<code java>
+/*Ejemplos de uso utilizando la instancia genérica de la clase guo_app*/
+guo_app.of_msg( ).of_msg_advertencia("Esto es una Advertencia.")
+guo_app.of_msg( ).of_msg_informacion("Esto es una Información.")
+guo_app.of_msg( ).of_msg_error("Esto es un Error.")
+/*Ejemplo de uso utilizando el API de mensajes*/
+guo_app.of_msg( ).of_mensajes_sistema(10)
+guo_app.of_msg( ).of_mensajes_sistema(10, "Error al insert el encabezado")
+guo_app.of_msg( ).of_mensajes_sistema('SICOF000_TERCERO_NOT_FOUND')
+/*Ejemplo de uso definiendo la clase de mensaje.*/
+n_cst_msg luo_msg
+luo_msg = Create n_cst_msg
+luo_msg.of_msg_advertencia("Esto es una Advertencia.")
+luo_msg.of_msg_informacion("Esto es una Información.")
+luo_msg.of_msg_error("Esto es un Error.")
+luo_msg.of_mensajes_sistema(10)
+luo_msg.of_mensajes_sistema(10, "Error al insert el encabezado")
+luo_msg.of_mensajes_sistema('SICOF000_TERCERO_NOT_FOUND')
+destroy luo_msg
+</code>
+== Consideraciones ==
+  * El API puede ser activada o desactivada por medio de la constante: **API_MESSAGE** (Solo en aplicaciones SICOF ERP (Appeon/Powerbuilder)) siempre y cuando se utilice la implementación de la clase **guo_app**.
+  * El desarrollador es el encargado de gestionar la transacción que realiza las consultas e inicialización del objeto.
+  * Se unifica el desarrollo para que la función global **f_mensajes_sistema** tome los nuevos cambios sin afectar su definición.
+  * Cada módulo (Contabilidad, Prespuesto, Tesorería, Compras, Talento y Nómina) debe implementar el método de inicialización **guo_app.of_init_logs(SQLCA)** en el método **of_process_step_init_transaction** de la clase **guo_app** especializada por cada módulo. A continuación se muestra una imagen de referencia de la implementación del módulo de presupuesto. Utilice esta guía para implementaciones en otros módulos teniendo presente que la clase **n_cst_app** se especializa con el nombre de la aplicación que la contiene. Ejemplo: en presupuesto la clase especializada es **n_cst_app_presupuesto**, por lo general la clase esta en la libreria principal que contiene el objeto **Application**.
+{{ :ada:howto:sicoferp:factory:logmodels:ejemplo_n_cst_app.png?600 |}}
+==== Modo de uso: Java ====
+Para las aplicaciones desarrolladas en las tecnologías (Web):
+  * Java
+  * .Net
+  * PHP
-==== Modo de uso: Java (Próximamente) ====
+el log de sesión será implementado por medio de un [[http://10.1.20.89/doku.php?id=ada:howto:sicoferp:factory:integrations:logs|Servicio Web]] el cual deberá considerar las reglas de [[#Columna: WS|Columna: WS]]
-Para las aplicaciones desarrolladas en la tecnología Java el log de sesión será implementado por medio de un servicio web.
 [[ada:howto:sicoferp:factory:logmodels|←Volver atras]]

Wiki

Herramientas de usuario

Herramientas del sitio

Diferencias

Herramientas de la página