Sistema de Gestin Documental Quipux

SISTEMA DE GESTIN
DOCUMENTAL

MANUAL DE CDIGO
FUENTE
SUBSECRETARA DE TECNOLOGAS DE LA INFORMACIN
SECRETARA NACIONAL DE LA ADMINISTRACIN PBLICA
PRESIDENCIA DE LA REPBLICA

Abril-2012

Manual de Cdigo Fuente

Sistema de Gestin Documental Quipux

Licencia
Usted es libre de:
Copiar, distribuir y comunicar pblicamente la obra

Hacer obras derivadas

Condiciones:

Reconocimiento. Debe reconocer los crditos de la obra de la manera

especificada por el autor o el licenciador (pero no de una manera que
sugiera que tiene su apoyo o apoyan el uso que hace de su obra).

Compartir bajo la misma licencia. Si altera o transforma esta obra, o

genera una obra derivada, slo puede distribuir la obra generada bajo una
licencia1 idntica a sta.
I. Al reutilizar o distribuir la obra, tiene que dejar bien claro los trminos de la
licencia de esta obra.
II. Alguna de estas condiciones puede no aplicarse si se obtiene el permiso
del titular de los derechos de autor
III. Nada en esta licencia menoscaba o restringe los derechos morales del
autor.
Versiones:

IV. Versin del sistema: 1.3

V. Versin del manual de administracin: 1.5

Para ver la licencia completa, visite:

http://creativecommons.org/licenses/by-sa/2.5/es/legalcode.es

Manual de Cdigo Fuente

Sistema de Gestin Documental Quipux

NDICE

MANUAL DE CDIGO FUENTE ..................................................................................................... 1

I. INTRODUCCIN............................................................................................................................ 1
II. ALCANCE..................................................................................................................................... 1
III. CONSIDERACIONES GENERALES...........................................................................................1
IV. LENGUAJES DE PROGRAMACIN..........................................................................................2
V. ESTRUCTURA DEL CDIGO FUENTE.......................................................................................2
1.ARCHIVOS DE CONFIGURACIN...............................................................................................2
2.ACCESO AL SISTEMA Y VALIDACIN DE SESIONES...............................................................3
3.FUNCIONES GENERALES DEL SISTEMA..................................................................................3
4.INTERCONEXIN CON OTROS SERVICIOS...............................................................................3
5.CONEXIN CON LA BASE DE DATOS........................................................................................3
6.FUNCIONES JAVASCRIPT........................................................................................................... 3
7.MENS........................................................................................................................................... 4
8.BANDEJAS.................................................................................................................................... 4
9.CREACIN DE DOCUMENTOS.................................................................................................... 4
10.ACCIONES CON LOS DOCUMENTOS.......................................................................................4
11.INFORMACIN GENERAL DE LOS DOCUMENTOS.................................................................4
12.RECORRIDO DEL DOCUMENTO............................................................................................... 5
13.CREACIN DE ARCHIVOS PDF................................................................................................. 5
14.TAREAS....................................................................................................................................... 5
15.ASOCIACIN DE DOCUMENTOS.............................................................................................. 5
16.ADMINISTRACIN...................................................................................................................... 6
17.CRONS PARA ACTUALIZACIN DE ESTADSTICAS, BLOQUEOS Y ALERTAS....................6
18.ANEXOS...................................................................................................................................... 6
19.CARPETAS VIRTUALES............................................................................................................. 6
20.ARCHIVO FSICO........................................................................................................................ 6
21.BSQUEDA AVANZADA............................................................................................................. 6
22.REPORTES.................................................................................................................................. 6

Manual de Cdigo Fuente

Sistema de Gestin Documental Quipux

23.FIRMA ELECTRNICA................................................................................................................ 7
24.IMPRESIN DE COMPROBANTES Y ASOCIACIN DE DOCUMENTOS DIGITALIZADOS....7

Manual de Cdigo Fuente

Sistema de Gestin Documental Quipux

MANUAL DE CDIGO FUENTE

I. INTRODUCCIN
El presente documento es el Manual de Cdigo Fuente del Sistema de Gestin Documental
Quipux Versin 1.3, herramienta informtica que le apoyar en la gestin documental
realizada por los servidores pblicos de las Instituciones.
El documento est dirigido a desarrolladores, quienes podrn guiarse de ese manual para
encontrar los archivos de cada funcionalidad y pueda hacer cambios en el sistema.

II. ALCANCE
En el presente documento hablaremos de forma sucinta sobre la estructura del cdigo del
sistema de Gestin Documental Quipux y analizaremos brevemente los archivos principales
del sistema para que puedan tener una idea de dnde pueden encontrar los archivos en el
caso que deseen realizar algn cambio o aadir funcionalidades al sistema.

III. CONSIDERACIONES GENERALES

El cdigo del sistema se encuentra un poco desordenado y no hay un estndar de
programacin, en parte porque en el sistema Orfeo, del cual tomamos el cdigo, no tena
definido un estndar y tambin porque varios desarrolladores que han intervenido en el
sistema han hecho parte del cdigo en base a sus propios estndares; sin embargo el cdigo
no es muy complicado de leer y actualmente nos encontramos reescribiendo gran parte del
mismo, ordenndolo y mejorando las funcionalidades; lo estamos separando en mdulos,
trabajando con clases, web services y ajax en la interfaz del usuario con el fin de hacerlo ms
gil y vistoso.
Respecto a los queries, ah si van a encontrar cosas un poquito complicadas de entender,
muchos pensarn que para qu nos dimos tantas vueltas si solo debamos cruzar dos tablas,
pero debido a la gran cantidad de datos que alberga el sistema, nos vemos obligados a
trabajar con subqueries y joins para mejorar los tiempos de respuesta y disminuir el consumo
de recursos del servidor, nunca se hacen cruces simples de tablas porque esto hara que
colapse el motor de base de datos.
En nuestro caso desarrollamos en mquinas con Ubuntu como sistema operativo, Netbeans
como IDE de desarrollo y subversion para el control de versiones. Nuestros servidores son
Centos de modo que el sistema funciona correctamente en distribuciones basadas en Debian
y Red Hut; hemos hecho pruebas con Suse y otras distribuciones de Linux y en teora debe
funcionar con cualquiera, pero no se han realizado pruebas exhaustivas para confirmar su
correcto funcionamiento.

Manual de Administracin

Sistema de Gestin Documental Quipux

IV. LENGUAJES DE PROGRAMACIN

El cdigo del sistema est escrito en php5, html y javascript; y la base de datos es
PostgreSQL.

V. ESTRUCTURA DEL CDIGO FUENTE

1. Archivos de configuracin
Todos los archivos de configuracin estn creados con un 2 al final del archivo para no crear
conflictos con el SVN cuando se cambie su informacin; para las configuraciones locales se
deben crear copias de los mismos y poner la informacin necesaria para cada caso; por
ejemplo se debe copiar el archivo config2.php con el nombre config.php y completar luego la
informacin requerida.

Archivo

config2.php

Descripcin

Guarda la configuracin general del sistema, variables de

conexin con la base de datos, nombres de servidores,
parmetros, etc.
Se recomienda leer y aplicar las sugerencias del archivo
config_recomendacion_seguridad.php para mejorar las
seguridades al configurar este archivo.

config_replicacion2.php

En caso que la replicacin est habilitada, se pueden

configurar que funcionalidades se conectan a cada rplica

include/local/localEcuador.php Se guardan algunas configuraciones regionales para los

textos y labels del sistema

interconexion/firma2.wsdl

Manual de Administracin

WSDL del web service que recibe el archivo firmado

electrnicamente desde el servidor de firma

Sistema de Gestin Documental Quipux

2. Acceso al sistema y validacin de sesiones

El control del ingreso al sistema y la validacin de las sesiones de los usuarios que ingresaron
al sistema se la realiza desde los archivos:

session_orfeo.php

securesession.class.php

3. Funciones generales del sistema

Las funciones que se utilizan en casi todo el cdigo del sistema se encuentran en los
siguientes archivos:

funciones.php

funciones_interfaz.php

obtener_datos.php

js/ajax.js

4. Interconexin con otros servicios

Funciones que hacen solicitudes o reciben datos de otros servicios relacionados con quipux;
como por ejemplo: la generacin de pdfs, firma electrnica, consultas al registro civil, entre
otros.

5. Conexin con la base de datos

La conexin con la BDD, todas las funciones que hacen peticiones y ejecutan sentencias, el
paginador y todo lo referente a la comunicacin con el motor de BDD se encuentran en los
archivos de las carpetas:

adobd/

include/db/

6. Funciones Javascript
Las funciones javascript y varios mdulos desarrollados por terceros y que se utilizan en el
sistema como calendarios, el editor de texto entre otros se encuentran dentro de la carpeta:

js/

Manual de Administracin

Sistema de Gestin Documental Quipux

7. Mens
Este cdigo se encuentra en:

correspondencia.php

menu/

8. Bandejas
Los principales archivos son:

cuerpo.php

cuerpo_paginador.php

include/query/query_cuerpo.php

tx/txOrfeo.php

9. Creacin de documentos
Los principales archivos se encuentran dentro de las carpetas:

radicacion/

include/tx/

10. Acciones con los documentos

Este cdigo se encuentra en:

tx/

include/tx/Tx.php

11. Informacin general de los documentos

El cdigo que compone esta parte del sistema se encuentra en:

verradicado.php

Manual de Administracin

Sistema de Gestin Documental Quipux

seguridad/obtener_nivel_seguridad.php

tx/txOrfeo.php

lista_general.php

ver_historico.php

anexos.php

tipo_documental/lista_expediente.php

asociar_documentos/lista_asociados.php

tareas/tareas.php

12. Recorrido del Documento

ver_historico.php

13. Creacin de Archivos PDF

Se lo maneja desde el archivo

plantillas/generar_documentos.php

Mdulo HTML_A_PDF

14. Tareas
El cdigo referente al mdulo de tareas se encuentra en:

tareas/

tx/

15. Asociacin de documentos

La asociacin de documentos se manejan desde

asociar_documentos/

Manual de Administracin

Sistema de Gestin Documental Quipux

16. Administracin
Los archivos de este mdulo se encuentran en:

Administracion/

17. Crons para actualizacin de estadsticas, bloqueos y alertas

Deben programarse en el crontab del sistema operativo y los archivos a ejecutar se
encuentran en:

cron/

18. Anexos
La carga de archivos adjuntos se encuentra en la raz y los nombres de los archivos
relacionados inicia con la palabra anexo_

19. Carpetas virtuales

Se encuentra dentro de la carpeta:

tipo_documental/

20. Archivo fsico

Se encuentra dentro de la carpeta:

archivo/

21. Bsqueda Avanzada

Las bsquedas se encuentran dentro de la carpeta:

busqueda/

22. Reportes
Los reportes se encuentran dentro de la carpeta:

Manual de Administracin

Sistema de Gestin Documental Quipux

reportes_new/

23. Firma Electrnica

Se encuentra en:

include/tx/Tx.php

include/tx/Firma_Digital.php

interconexion/ws_firma_digital.php

Mdulo de Firma Digital

24. Impresin de comprobantes y asociacin de documentos digitalizados

Se encuentra en:

uploadFiles/

Manual de Administracin