0% encontró este documento útil (0 votos)
1K vistas14 páginas

Estandar Programacion Sistemas Ion

Este documento establece los estándares de programación para el desarrollo de sistemas de información en Electrosur S.A. Define una arquitectura de programación en tres capas y estandariza la conexión a bases de datos, la denominación de archivos, variables y otros elementos para facilitar la documentación y mantenimiento del código por diferentes programadores.

Cargado por

luis_1306
Derechos de autor
© Attribution Non-Commercial (BY-NC)
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
0% encontró este documento útil (0 votos)
1K vistas14 páginas

Estandar Programacion Sistemas Ion

Este documento establece los estándares de programación para el desarrollo de sistemas de información en Electrosur S.A. Define una arquitectura de programación en tres capas y estandariza la conexión a bases de datos, la denominación de archivos, variables y otros elementos para facilitar la documentación y mantenimiento del código por diferentes programadores.

Cargado por

luis_1306
Derechos de autor
© Attribution Non-Commercial (BY-NC)
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 14

ELECTROSUR S.A.

INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006


TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 1/14

1. OBJETIVO.
El objetivo del presente documento es definir los estándares de
programación en cuanto a denominación de archivos, distribución de
pantallas, reportes, etc. con el fin de desarrollar una programación fácil
de entender por cualquier programador y contar con una herramienta
de fácil documentación de los sistemas de información.

2. ALCANCES
El estándar de programación se utilizará en todos los desarrollos de
software realizados para Electrosur S.A.

3. BASE LEGAL
Norma de Control Interno NTCI-005-03-98.

4. DEFINICIONES
4.1. Metodología de Programación
Permite realizar mantenimientos en menor tiempo y costo, migrar
código consistentemente, habilita a los programadores moverse
entre proyectos diferentes y asegura la comunicación técnica
entre desarrolladores.

4.2. Sistema
Conjunto de elementos que interactúan entre sí para lograr un
objetivo común.

5. RESPONSABILIDAD
5.1 De los analistas programadores
Cada analista programador deberá utilizar el estándar de
programación en los desarrollos de software posteriores a la
fecha de aprobación del mismo.

5.2 Es responsabilidad del Analista Supervisor controlar la


aplicación del estándar de programación en los desarrollos de
software posteriores a la fecha de aprobación del mismo.

5.3 Es responsabilidad del Jefe de la Oficina de Informática y


Sistemas que el estándar de desarrollo sea utilizado en los
proyectos de software de Electrosur S.A.

6. DESARROLLO

6.1. Arquitectura de Programación


Se debe utilizar la programación en 03 capas :
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 2/14

Capa de Presentación : En esta capa se diseña todo lo que


constituye la interfaz gráfica y la interacción del usuario con el
software, aquí puede incluirse algunas validaciones mínimas.

Capa de Reglas del Negocio : Son todas las subrutinas creadas


con el propósito de regular alguna acción del usuario.

Capa de Datos : En esta capa programamos todo lo que tiene


que ver con el acceso a la base de datos. Esta capa queda
encargada de tomar la información de la base de datos dada una
petición de la capa de Reglas del Negocio, que a su vez es
generada por la capa de presentación.

En la capa de datos se deben definir los Procedimientos


Almacenados, Triggers, Funciones, etc.

6.2. Conexión a Base de Datos


Se utilizarán cadenas de conexión almacenadas en archivos con
extensión .INI, las mismas que deberán estar encriptadas,
mediante la rutina estándar desarrollada por Informática.

La denominación de los archivos .INI deberá ser la misma que el


ejecutable generado para el proyecto.

Las cadenas de conexión deben ser llamadas desde una Clase.

6.3. Denominación de archivos


Se aplica a la denominación de Proyectos, Programas,
Formularios, Reportes, Archivos de Texto, Menús, Archivos de
Ayuda, Clases.

Longitud Máxima : 20 caracteres.

Nº Caracteres Descripción Notación


1–2–3 Identifica la pertenencia Minúscula
a un determinado
sistema
4–5–6 Identifica el Tipo de El primer carácter en
Archivo mayúscula y los dos
restantes en
minúscula.
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 3/14

7 al 20 Descripción del El primer carácter con


Archivo mayúscula, el resto en
minúscula. Se puede
alternar mayúsculas y
minúsculas para
separar palabras

Ejemplo :
Archivo de Proyecto del Sistema Contable Elecont : cntPryElecont

Tabla para la Codificación de Sistemas (primeros 3


caracteres)

Nº Nombre Abreviación
1 Recursos Humanos rrh
2 Logística log
3 Activo Fijo acf
4 Contabilidad cnt
5 Almacén alm
6 Seguro Médico sem
7 Viáticos via
8 Presupuesto ppt
9 Adquisiciones adq
10 Trámite documentario trd
11 Control de Equipos ceq
12 Ordenes de Trabajo otr
13 Alumbrado Público alp
14 Redes Eléctricas eee
15 Pedidos ped
16 Interrupciones int
17 Contratos con

Tabla de Tipo de Archivos (siguientes 03 caracteres)

Nº Nombre Abreviación
1 Proyectos Pry
2 Formularios Frm
3 Reportes Rpt
4 Programa Prg
5 Menú Mnu
6 Ayudas Hlp
7 Textos Txt
8 Clases Cls
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 4/14

6.4. Denominación de Variables

Nº Caracteres Descripción Notación


1 Indicador de Parámetro Minúscula
(Sólo aplicable en
caso de que la
variable actúe como
parámetro de entrada)
2 Indica el ámbito de la Mayúscula
variable
3–4–5 Identifica el tipo de dato Minúscula
que se almacena en la
variable
A partir del 5to. Descripción de la El primer carácter con
caracter variable mayúscula, el resto en
minúscula. Se puede
alternar mayúsculas y
minúsculas para
separar palabras

Denominaciones puntuales : En caso que la variable


almacene el valor de un campo determinado de una tabla, la
descripción de la variable deberá ser el nombre del campo al que
hace referencia, antecedida por el indicador de parámetro - si es
que corresponde - , el ámbito y el tipo de dato.

Ejemplo Variable Simple


Variable Pública Promedio de Edad : GintPromedioEdad

Ejemplo Variable Parámetro


Variable pública de Promedio de Edad que actúa como parámetro
de una función o procedimiento : xGintPromedioEdad

Tabla de Indicador de Parámetros y Ámbito de Variables

Nº Nombre Abreviación
1 Parámetro x
2 Globales (Públicas) G
3 Locales L
3 Privadas P
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 5/14

Tabla de Tipo de Datos

Nº Nombre Abreviación
1 Bolean Bln
2 Byte Byt
3 Char Chr
4 Date Dat
5 Decimal Dec
6 Double Dbl
7 Integer Int
8 Long Lng
9 Object obj
10 Short srt
11 Single sng
12 String str
13 DateTime Dtt
14 Float Flt
15 Image Img
16 Money Mny
17 Nchar Nch
18 Ntext Ntx
19 Nvarchar Nvc
20 Real Ral
21 Smalldatetime Sdt
22 Smallint Smi
23 Smallmoney Smn
24 Text Txt
25 TimeStamp Tms
26 Varbinary Vbn
27 Varchar Vch
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 6/14

6.5. Denominación de Controles WinForm

Nº Nombre Abreviación
1 Label lbl
2 LinkLabel lnk
3 Button btn
4 TextBox txt
5 MainMenu mnu
6 Checkbox chk
7 RadioButton rdo
8 GroupBox grp
9 PictureBox pic
10 Panel pnl
11 DataGrid grd
12 ListBox lst
13 CheckedListBox clst
14 ComboBox cbo
15 ListView lvw
16 TreeView tvw
17 TabControl tab
18 DataTimePicker dtp
19 MonthCalendar cal
20 HScrollBar hscr
21 VScrollBar vscr
22 Timer tim
23 Splitter spl
24 DomainUpDown dup
25 NumericUpDown nup
26 TrackBar trk
27 ProgressBar prg
28 RichTextBox rtxt
29 ImageList ilst
30 HelpProvider hlp
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 7/14

31 ToolTip tip
32 ContextMenu cmnu
33 ToolBar tbar
34 StatusBar sbar
35 NotifyIcon nic
36 OpenFileDialog ofd
37 SaveFileDialog sfd
38 FontDialog fd
39 ColorDialog cd
40 PrintDialog pd
41 PrintPreviewDialog ppd
42 PrintPreviewControl ppc
43 ErrorProvider errp
44 PrintDocument pdoc
45 PageSetupDialog psd
46 CrystalReportViewer crv
47 Command cmd
48 Editbox ebx
49 CommandGroup cmg
50 OptionGroup opg
51 Checkbox chb
52 Spinner spn
53 Image img
54 PageFrame pfr
55 OleControl ole
56 OleBudControl olb
57 Container ctn
58 Hyperlink hyp
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 8/14

6.6. Denominación de Controles WebForm

Nº Nombre Abreviación
1 Label lbl
2 TextBox txt
3 Button btn
4 LinkButton lnk
5 ImageButton img
6 HyperLink hyp
7 DropDownList ddl
8 ListBox lst
9 DataGrid grd
10 DataList dlst
11 Repeater rep
12 CheckBox chk
13 CheckBoxList cbl
14 RadioButtonList rbl
15 RadioButton rdo
16 Image img
17 Panel pnl
18 PlaceHolder plc
19 Calendar cal
20 AdRotator ad
21 Table tbl
22 RequiredFieldValidator reqv
23 CompareValidator cmpv
24 RangeValidator rngv
25 RegularExpressionValidator rexpv
26 CustomValidator custv
27 ValidationSummary vsum
28 Xml xml
29 Literal lit
30 CrystalReportViewer crv
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 9/14

6.7. Denominación de Objetos ADO.Net

Nº Nombre Abreviación
1 DataSet ds
2 DataTable dt
3 DataView dv
4 DataRow drw
5 Connection* cnn
6 Command* cmd
7 DataAdapter* da
8 CommandBuilder* bld
9 DataReader* dr

6.8. Procedimientos Almacenados


Abreviación Descripción Notación
Caracteres
1–2–3 usp Diferencia los En minúscula
procedimientos
almacenados
creados por los
usuarios de los
propios del
sistema
4 _ Separador
(underline)
5 S, I, D, U Indicador del S = Select
tipo de I = Insert
transacción D = Delete
U = Update
6 _ Seprarador
(underline)
A partir del Nombre de la La Primera
7mo. Tabla letra con
Carácter Se puede mayúscula.
incluir los
campos
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 10/14

utilizados para
la transacción
separados por
underline “_”

Ejemplo
Procedimiento almacenado para seleccionar Cuentas Contables:
usp_S_cntCTAtCuentasContables

6.9. Denominación de Procedimientos, Funciones, Métodos

Nº Caracteres Descripción Notación


1–2–3 Identificador de En minúscula
procedimientos y
funciones
A partir del Descripción Primera letra con mayúsculas.
4to. Carácter del Se puede alternar mayúsculas
Procedimient y minúsculas para diferenciar
o o Función palabras puntuales. Debe ser
lo más descriptivo posible y
sin considerar espacios en
blanco.

En cada método, procedimiento o función, se deberá colocar una


cabecera descriptiva.

Ejemplo
Función para convertir números a letras :
fncConvertirNumerosLetras

Tabla de Codificación de Procedimientos y Funciones

Nº Nombre Abreviación
1 Procedimientos prc
2 Funciones fnc
3 Métodos mtd
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 11/14

6.10. Nombre de Base de Datos

Las Bases de datos deberán ser denominadas según el nombre


del sistema de información que la trate, y deberán ser escritas
con la primera letra en mayúscula y las demás en letras
minúsculas, considerando el tipo de archivos DAT y LOG.

Ejemplo:
Sistema Base de Datos
-----------------------------------------------------------
Sistema de Logística logistica

6.11. Nombre de Tablas y Vistas

Longitud Máxima : 25 Caracteres

Nº Caracteres Descripción Notación


1–2–3 Identifica la pertenencia a Minúscula
un determinado sistema
4–5–6 Código identificador de la Mayúscula
Tabla o Vista
7 Código Tipo de Tabla Minúscula
A partir del Nombre de la tabla o vista La primera letra
8vo. Carácter en mayúscula

Codificación de Tablas y Vistas

Nº Nombre Abreviación
1 Principal P
2 Secundaria T
3 Histórica H
4 Vista V

Ejemplo – Tabla Bancos : cntBCOtBancos


Ejemplo – Vista Bancos : cntBCOvBancos
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 12/14

6.12. Nombre de Campos

Longitud Máxima : 20 Caracteres

Nº Caracteres Descripción Notación


1–2–3 Código identificador de Mayúscula
la Tabla
A partir del 4to. Descripción del Campo Minúscula
Carácter Los campos deberán
ser lo más descriptivos
posible

Campos Clave : Para este caso se utilizará la denominación “id”


luego del código identificador de la tabla

Ejemplo:
Campo Clave de Cuentas Contables = CTAid_cuenta

6.13. Formato de Formularios

Título de Formulario :
Se deberá consignar la siguiente información :
⇒ Nombre de la tarea o proceso principal del formulario
⇒ Fecha y Hora del Sistema
⇒ Usuario

Ejemplo :
|Mantenimiento de Usuarios |01-01-2006 10:00 AM | USR001 |

Color de Fondo
Backcolor : 249,248,242

Botones Estándar del Formulario


a) Nuevo (CTRL + N): crea un nuevo registro
b) Editar (CTRL + E): edita un registro, habilitando todos los
campos para ser modificados
c) Guardar (CTRL + G): almacena los datos ingresados en la
tabla.
d) Cancelar (CTRL + Z): cancela el registro ingresado.
e) Borrar (CTRL + T): borra los datos del registro actual.
f) Buscar (CTRL + B): busca un registro determinado.
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 13/14

g) Imprimir (CTRL + P): imprime los datos del registro actual.


h) Salir (CTRL + F4): sale del formulario.

Posición de Botones: ubicados en la parte inferior del formulario.


Si la aplicación contase con una barra de herramientas, esta
deberá estar ubicada en la parte superior bajo el menú principal
del sistema.

Se debe evitar en lo posible la utilización de gráficos en los


botones del formulario.

Todo código que se encuentre en algún objeto, método,


procedimiento u otro deberá ser descrito de manera clara y breve.

6.14. Sobre las Descripciones

Cada procedimiento, programa o cualquier otro código, deberá


incluir una cabecera en la cual se indicará el nombre del
programa, procedimiento o función.
*-------------------------------------------------------------- *
* Programa Principal *
* Nombre del programa: *
* Programador: *
* Fecha Creación: *
* Fecha de última modificación: *
*-------------------------------------------------------------- *

6.15. Sobre los Reportes

Los reportes deben consignar la siguiente información :


⇒ Esquina Superior Izquierda : Logotipo de la Empresa
⇒ Esquina Superior Derecha : Nombre del Sistema, Nombre del
Reporte, Fecha y Hora de Impresión
⇒ Parte Superior Central : Título del Reporte, Período
⇒ Esquina Inferior Izquierda : Usuario, Nombre de PC, IP desde
donde se realiza la impresión
⇒ Esquina Inferior Derecha : Número de Página

Fuente : Se podrán utilizar los siguientes tipos de letra de forma


predeterminada, según el tamaño propio del reporte :
ELECTROSUR S.A. INSTRUCCION ADMINISTRATIVA GSP- 001 - 2006
TÍTULO: ESTANDAR DE PROGRAMACION PARA EL
Rev. 02
DESARROLLO DEL SISTEMAS DE INFORMACION
Emitido por: Aprobado por:
GSP/Sr. Guido Cavagnaro V. G/Ing. Jorge Rivadeneira G.
Fecha: 05.06.2006 Pág. 14/14

Para el Nombre del Sistema, Nombre del Reporte, Fecha y Hora


de impresión, Usuario, Nombre de PC, IP :
⇒ Marigold – 10 pts.

Para el cuerpo del Reporte :


⇒ Arial Narrow
⇒ Universal Condensed

Modelo Cabecera :

Modelo Pie de Página

6.16. Sobre la Documentación

Durante el desarrollo del sistema cada fase terminada deberá ser


documentada, según el estándar de documentación vigente. La
responsabilidad de la documentación de cada sistema de
información recaerá en el jefe de cada proyecto de software.

Se deberá indicar en la documentación el código identificador


asignado para cada tabla que conforma el sistema desarrollado.

Todo sistema que se encuentre en producción, deberá tener un


registro de bitácora, donde se detallen las modificaciones y/o
adecuaciones que se realicen sobre el mismo.

7. LISTA DE DISTRIBUCION
GSP, GSPI, GSPI-A, GSPI-P, GSPI-AP.

También podría gustarte