Cómo añadir la opción a cualquier ventana de nuestra aplicación (clientes, contactos, facturas, albaranes, apuntes, proveedores, partes de trabajo, incidencias, expedientes, artículos, etc) de insertar/visualizar documentos. Puede ser muy útil para adjuntar a una factura, por ejemplo, la factura imprimida en PDF, o para adjuntar a un presupuesto su correspondiente documento de Word. Utilizaremos MySQL (motor de base de datos) y Delphi (lenguaje de programación).
Para permitir añadir documentos a cualquier tabla de nuestra aplicación, en un primer momento añadimos a cada tabla un campo de tipo LONGBLOB y en el formulario de Alta/Modificación de cada tabla (facturas, albaranes, clientes, contactos, etc) añadimos un botón para permitir insertar un documento al usuario. Este tipo de desarrollo presentaba varios inconvenientes:
- Si el documento añadido tiene un tamaño considerable y si, además, la aplicación tiene acceso desde fuera de nuestra red local (LAN), desde Internet este método hace que algunos proceso se ralenticen en exceso. Pues el documento adjunto se guarda en la misma tabla que, posteriormente, deberemos utilizar para consultas, modificaciones, etc.
- Sólo admite un documento por registro.
- Para poder optimizar las consultas, en todos los SELECT que realicemos deberemos quitar el campo de tipo LONGBLOB para evitar retardos excesivos en procesos que deberían ser rápidos. Con lo cual, si una tabla tiene 20 campos y queremos mostrarlos todos salvo el LONGBLOB estaremos obligados a añadirlos uno a uno al SELECT.
- Las copias de seguridad programadas con MySQL Administrator también se ralentizan en exceso, lo que hace que, a veces, no se ejecute correctamente la copia de seguridad.
- Al añadir este tipo de datos a cada tabla estamos incrementando la posibilidad de corrupción de la misma.
Tras analizar los inconvenientes de este tipo de desarrollo y tras varias pruebas, decidimos crear una única tabla exclusivamente para los documentos y el resto de tablas de la aplicación las dejaremos tal y como estuvieran (sin el campo LONGBLOB). De esta forma conseguimos no incrementar en exceso el tamaño de las tablas principales de la aplicación (facturas, clientes, albaranes, contactos, citas, incidencias, notas, etc). También conseguimos que la copia de seguridad se pueda realizar de forma rápida. Utilizando MySQL Administrator programamos dos copias de seguridad para la misma aplicación, una primera realiza la copia de seguridad de todas las tablas excepto la de los documentos, así nos aseguramos que las tablas más importantes quedan guardadas. Una segunda realiza la copia de seguridad de la tabla de documentos por separado.
En primer lugar deberemos crear la tabla que contendrá los documentos de la aplicación. Para saber a qué ventana y a qué registro de cada ventana corresponde un documento utilizamos dos campos: codigoregistro (guardará el ID de la clave primaria de la tabla a la que pertenezca el documento) y ventana (guardará el nombre de la ventana/tabla a la que pertenece el documento). Así conseguimos también que se puedan añadir varios documentos por cada registro de cada ventana.
El script de SQL de MySQL de creación de la tabla «documento» será:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
CREATE TABLE `documento` ( `codigo` int(10) unsigned NOT NULL auto_increment, `documento` longblob, `fechaalta` datetime default NULL, `version` varchar(40) default NULL, `nombre` varchar(150) default NULL, `ruta` varchar(255) default NULL, `caracteristicas` text, `codusuarioa` int(10) unsigned default NULL, `codusuariom` int(10) unsigned default NULL, `fechaa` datetime default NULL, `fecham` datetime default NULL, `codigoregistro` int(10) unsigned default NULL, `ventana` varchar(50) default NULL, `guardarbd` char(1) default NULL, PRIMARY KEY (`codigo`) ) |
Otro campo a destacar de esta tabla es guardarbd que indicará si el documento insertado se guardará en la base de datos, en el campo documento de tipo LONGBLOB o bien si sólo se guarda la ruta donde se encuentra.
Desde Delphi, abriremos nuestro proyecto (aplicación) y crearemos un formulario como este:
Con varios TEdit, TButton, TBitBtn, TLabel, TComboBox, TCheckBox, TPageControl, TDBGrid, etc. Esta ventana será la que muestre los documentos del registro de la ventana actual. También permitirá insertar nuevos documentos para el registro de la ventana actual. Las dos acciones se realizarán en la misma ventana, separadas por el componente «TPageControl» en dos pestañas/solapas.
Para ver el código fuente de todos los componentes de esta ventana pulsa aquí.
Nota: esta ventana incorpora varios componentes de pago que son perfectamente sustituibles por componentes normales de Delphi. Por ejemplo, incluye TdxDBGrid que es sustituible por TDBGrid.
Por otro lado, debemos mencionar que en el desplegable «Tabla» de este formulario, en la propiedad «Items», añadiremos el nombre de todas las ventanas a las que queramos añadir la opción de inserción de documentos, en nuestro caso:
Artículos
Cobros
Contactos
Cheques/Pagarés
Facturas a clientes
Facturas de proveedores
Gastos
Incidencias
Notas
Pagos
Partes de trabajo (Albaranes)
Recursos
Técnicos
Terceros
En el campo «Info» se añadirán de forma automática algunas propiedades del fichero seleccionado (nombre, extensión, tamaño, etc).
En el campo «ID registro» se guardará el código de la clave primaria del registro de la ventana a la que queramos insertar el documento.
En el campo «Nombre«, por defecto, la aplicación obtendrá el nombre del fichero seleccionado sin la extensión, es perfectamente modificable (como el resto de los campos, salvo «ID registro» y «Tabla»).
Por último para esta ventana, cabe mencionar que no hemos utilizado componentes enlazados con base de datos, para mejorar la velocidad. Para hacer la inserción de un nuevo documento utilizamos consultas SQL con INSERT, pasándole como parámetro el valor de cada campo. Al no estar enlazados con la base de datos, conseguimos abrir la ventana de forma instantánea pues no hay que hacer el acceso a la base de datos hasta que se pulse el botón «Insertar documento«.
Para añadir a la ventana que deseemos de nuestra aplicación la posibilidad de insertar y visualizar documentos, os mostramos a continuación un ejemplo de cómo hacer la llamada a la ventana anterior (para insertar o para visualizar). Utilizaremos como muestra la ventana «Modificación Factura» de la aplicación AjpdSoft Gestión Integral:
Hemos marcado con una elipse roja los dos botones que utilizaremos para insertar y visualizar documentos. En el anexo de este manual hemos añadido el código fuente de estos dos botones.
Convendrá activar y desactivar estos dos botones en función de las necesidades que consideremos, por ejemplo, para el evento «FormCreate» del formulario anterior (cuando se crea), ejecutaremos el siguiente código:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
procedure TformGFactura.FormCreate(Sender: TObject); begin if vtAccion = 'nuevo' then begin bAdjuntar.Enabled := false; bVisualizarDocumentos.Enabled := false; md.tcFacturaDetalle.Close; caption := 'Añadir ' + ventana + '...'; tTabla.Insert; .... end; if vtAccion = 'modificar' then begin bAdjuntar.Enabled := true; bVisualizarDocumentos.Enabled := true; caption := 'Modificación de ' + ventana + '...'; GDetalle.Enabled := true; ActNuevo.Enabled := true; .... end; if vtAccion = 'zoom' then begin bAdjuntar.Enabled := false; bVisualizarDocumentos.Enabled := true; tTabla.locate ('Codigo', vtCodigo, []); caption := 'Visualización de ' + ventana + '...'; .... end; end; |
Como se puede observar activamos y desactivamos estos botones en función de nuestras necesidades, por ejemplo, cuando se utiliza el formulario para un alta de una nueva factura, desactivamos ambos botones (el de visualizar porque al ser un alta no tiene documentos adjuntos y el de insertar porque al ser un alta aún no se le ha asignado un código a la clave primaria, hasta que se valide la factura).
La aplicación ejecutándose quedará de la siguiente forma, cuando modificamos una factura, nos aparecerán activos los botones de Adjuntar y Visualizar documentos, si pulsamos en «Adjuntar»:
Nos mostrará la ventana de Gestión Documental, con el campo «Tabla» con el valor «Facturas a clientes» y el campo «ID registro» con el valor 112 (clave primaria de la factura anterior). Seleccionaremos el documento que queramos adjuntar a la factura:
En nuestro caso un documento PDF con la factura imprimida en este formato:
Al seleccionar el documento se rellenarán automáticamente algunos datos (que podremos cambiar). Pulsaremos «Insertar Documento» para añadir el documento actual a la factura actual:
Nos preguntará si queremos adjuntar otro documento a esta factura:
Para visualizar los documentos adjuntados a la factura pulsaremos el botón «Visualizar»:
Nos mostrará la pestaña «Documentos» de la ventana «Gestión documental», desde esta pestaña podremos visualizar (descargar) los documentos adjuntos y también eliminar los que consideremos que no sirven:
Con lo cual, con unas líneas de código y dos botones, conseguiremos de forma sencilla y rápida agregar esta funcionalidad de gestión documental a cualquiera de nuestras ventanas.
ANEXO
Código fuente completo (de todo el formulario) de la ventana «Gestión Documental»:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
unit UnidadGestionDocumental; interface uses Windows, Messages, SysUtils, Variants, Classes, <br> Graphics, Controls, Forms, Dialogs, StdCtrls, ComCtrls, Buttons, db, <br> dxExEdtr, dxCntner, dxTL, dxDBCtrl, dxDBGrid, ExtCtrls, dxDBTLCl, <br> dxGrClms, shellapi; type TformGestionDocumental = class(TForm) tab: TPageControl; tabInsertar: TTabSheet; GroupBox1: TGroupBox; dlAbrir: TOpenDialog; Label1: TLabel; txtRuta: TEdit; bSel: TButton; txtNombre: TEdit; Label6: TLabel; tabDocumentos: TTabSheet; Panel1: TPanel; Tabla: TdxDBGrid; bVisualizar: TBitBtn; Tablacodigo: TdxDBGridColumn; Tablanombre: TdxDBGridMaskColumn; Tablaversion: TdxDBGridMaskColumn; Tablafechaalta: TdxDBGridDateColumn; Tablaruta: TdxDBGridMaskColumn; Tablacaracteristicas: TdxDBGridMemoColumn; dlGuardar: TSaveDialog; bInsertarDocumento: TBitBtn; BCancelar: TBitBtn; linfoTamanoTabla: TLabel; opGuardarBD: TCheckBox; txtVersion: TEdit; Label5: TLabel; Label3: TLabel; txtTabla: TComboBox; Label4: TLabel; txtID: TEdit; txtInfo: TMemo; Label2: TLabel; bCerrarVentana: TBitBtn; Panel2: TPanel; Tablaguardarbd: TdxDBGridCheckColumn; bEliminarDocumento: TBitBtn; procedure bSelClick(Sender: TObject); procedure bInsertarDocumentoClick(<br> Sender: TObject); procedure bVisualizarClick(Sender: TObject); procedure FormShow(Sender: TObject); procedure BCancelarClick(Sender: TObject); procedure bCerrarVentanaClick(Sender: TObject); procedure bEliminarDocumentoClick(<br> Sender: TObject); private { Private declarations } public { Public declarations } filtroVentana : string; filtroCodigoRegistro : integer; end; var formGestionDocumental: TformGestionDocumental; implementation uses UnidadModuloDatos, UnidadProcedimientos; {$R *.dfm} procedure TformGestionDocumental.bSelClick(Sender: TObject); var nombre : string; begin dlAbrir.Filter := 'Acrobat PDF (*.pdf)|*.pdf' + '|Microsoft Word (*.doc)|*.doc|' + 'Microsoft Excel (*.xls)|*.xls|' + 'Microsoft Access (*.mdb)|*.mdb|' + 'Imagen JPEG (*.jpg)|*.jpg|' + 'Todos los archivos (*.*)|*.*'; if dlAbrir.Execute then begin txtRuta.Text := dlAbrir.FileName; nombre := ChangeFileExt( ExtractFileName(dlAbrir.FileName), ''); if txtNombre.Text = '' then txtNombre.Text := nombre; if txtInfo.Text = '' then begin txtInfo.Lines.Add ('Nombre: ' + nombre); txtInfo.Lines.Add ('Nombre original: ' + ExtractFileName(dlAbrir.FileName)); txtInfo.Lines.Add('Ubicación original: ' + ExtractFilePath(dlAbrir.FileName)); txtInfo.Lines.Add('Tamaño: ' + FormatFloat ('###,###,###,##0.00 MB;' + '-###,###,###,##0.00 MB;0', tamanoFichero(dlAbrir.FileName) / 1048576)); end; end; end; procedure TformGestionDocumental.bInsertarDocumentoClick( Sender: TObject); begin if opGuardarBD.Checked then begin if tamanoFichero(txtRuta.Text) > vtTamanoFicheroAdjunto then begin MessageDlg('El tamaño del fichero ' + 'seleccionado excede el máximo ' + 'permido para adjuntar: ' + chr(13) + chr(13) + ' Tamaño fichero: ' + FormatFloat ('###,###,###,##0.00 MB;-###,###,###,##0.00 MB;0', (tamanoFichero(dlAbrir.FileName)/ 1048576)) + chr(13) + ' Tamaño máximo: ' + FormatFloat ('###,###,###,##0.00 MB;-###,###,###,##0.00 MB;0', (vtTamanoFicheroAdjunto / 1048576)), mtinformation, [mbok], 0); exit; end; if Not FileExists (txtRuta.Text) then begin MessageDlg('El fichero seleccionado no existe.', mtWarning, [mbok], 0); tabInsertar.Show; txtRuta.SetFocus; exit; end; end; try md.tc.Close; md.tc.SQL.Clear; md.tc.SQL.Add('INSERT INTO ' + vtTablaDocumento + ' (documento, fechaalta, version, ' + 'ruta, caracteristicas, ' + 'codusuarioa, fechaa, codigoregistro, ' + 'ventana, nombre, guardarbd) VALUES ' + '(:pDocumento, :pFechaalta, :pVersion, ' + ':pRuta, :pCaracteristicas, :pCodUsuA, :pFechaA, ' + ':pCodReg, :pVentana, :pNombre, :pGuardarBD)'); md.tc.ParamByName('pDocumento').DataType := ftBlob; md.tc.ParamByName('pFechaalta').DataType := ftDateTime; md.tc.ParamByName('pVersion').DataType := ftString; md.tc.ParamByName('pRuta').DataType := ftString; md.tc.ParamByName('pCaracteristicas').DataType := ftString; md.tc.ParamByName('pCodUsuA').DataType := ftInteger; md.tc.ParamByName('pFechaA').DataType := ftDateTime; md.tc.ParamByName('pCodReg').DataType := ftInteger; md.tc.ParamByName('pVentana').DataType := ftString; md.tc.ParamByName('pNombre').DataType := ftString; md.tc.ParamByName('pGuardarBD').DataType := ftString; if opGuardarBD.Checked then begin md.tc.ParamByName('pDocumento').LoadFromFile ( txtRuta.Text, ftBlob); md.tc.ParamByName('pGuardarBD').AsString := 'S'; end else begin md.tc.ParamByName('pDocumento').Value := null; md.tc.ParamByName('pGuardarBD').AsString := 'N'; end; md.tc.ParamByName('pFechaalta').AsDateTime := Now; md.tc.ParamByName('pVersion').AsString := txtVersion.Text; md.tc.ParamByName('pRuta').AsString := txtRuta.Text; md.tc.ParamByName('pCaracteristicas').AsString := txtInfo.Text; md.tc.ParamByName('pCodUsuA').AsInteger := vtCodigoUsuario; md.tc.ParamByName('pFechaA').AsDateTime := Now; md.tc.ParamByName('pCodReg').AsInteger := StrToInt(txtID.Text); md.tc.ParamByName('pVentana').AsString := txtTabla.Text; md.tc.ParamByName('pNombre').AsString := txtNombre.Text; md.tc.ExecSQL; if MessageDlg('Documento añadido correctamente ' + '¿Desea añadir otro documento?', mtConfirmation, [mbyes, mbno], 0) = mrYes then begin txtRuta.Text := ''; txtRuta.SetFocus; txtInfo.Clear; txtVersion.Text := ''; txtNombre.Text := ''; end else close; except raise; end; end; procedure TformGestionDocumental.bVisualizarClick( Sender: TObject); var ficheroEjecutar : string; begin md.tc.Close; md.tc.sql.clear; md.tc.sql.add ('select documento, guardarbd, ruta from ' + vtTablaDocumento); md.tc.sql.Add ('where codigo = :pCodigo'); md.tc.ParamByName ('pCodigo').DataType := ftInteger; md.tc.ParamByName ('pCodigo').AsInteger := md.tcDocumentoscodigo.AsInteger; md.tc.open; if md.tc.FieldByName('guardarbd').AsString = 'N' then begin ficheroEjecutar := md.tc.FieldByName('ruta').AsString; if ShellExecute(handle, Nil, PChar(ficheroEjecutar), Nil, Nil, SW_SHOWNORMAL) <= 32 then begin MessageDlg (SysErrorMessage(GetLastError), mtwarning, [mbok], 0); end; end else begin if not TBlobField ( md.tc.FieldByName('documento')).IsNull then begin dlGuardar.FileName := ExtractFileName (md.tcDocumentosruta.AsString); if dlGuardar.Execute then TBlobField(md.tc.fieldbyname('documento')).SaveToFile( dlGuardar.FileName); end else MessageDlg ('El documento seleccionado no tiene datos.', mtInformation, [mbok], 0); end; end; procedure TformGestionDocumental.FormShow( Sender: TObject); begin if Tag = 10 then //inserción begin tabDocumentos.Enabled := false; tabInsertar.Show; md.tc.Close; md.tc.SQL.Clear; md.tc.SQL.Add('show table status like "' + vtTablaDocumento + '"'); md.tc.Open; if md.tc.RecordCount > 0 then begin linfoTamanoTabla.Caption := 'Tamaño tabla "' + vtTablaDocumento + '": ' + FormatFloat ('###,###,###,##0.00 MB;' + '-###,###,###,##0.00 MB;0', md.tc.fieldbyname('data_length').AsFloat / 1048576); end; md.tc.Close; txtRuta.SetFocus; end; if tag = 20 then //mostrar documentos begin tabDocumentos.Show; tabInsertar.Enabled := false; md.tcDocumentos.Close; md.tcDocumentos.SQL.Clear; md.tcDocumentos.SQL.Add('select codigo, nombre, ' + 'version, fechaalta, ' + 'ruta, guardarbd, caracteristicas from ' + vtTablaDocumento); md.tcDocumentos.SQL.Add('where ventana = "' + filtroVentana + '"'); md.tcDocumentos.SQL.Add('and codigoregistro = ' + inttostr(filtroCodigoRegistro)); md.tcDocumentos.Open; Tabla.DataSource := md.dbTCDocumentos; end; end; procedure TformGestionDocumental.BCancelarClick( Sender: TObject); begin close; end; procedure TformGestionDocumental.bCerrarVentanaClick( Sender: TObject); begin close; end; procedure TformGestionDocumental.bEliminarDocumentoClick( Sender: TObject); begin if md.tcDocumentos.RecordCount < 1 then MessageDlg('No hay documentos a eliminar.', mtInformation, [mbok], 0) else begin if MessageDlg('¿Desea eliminar el documento actual?', mtConfirmation, [mbyes, mbno], 0) = mryes then begin md.tc.SQL.Clear; md.tc.sql.add ('delete from ' + vtTablaDocumento + ' where codigo = ' + md.tcDocumentoscodigo.AsString); md.tc.ExecSQL; md.tc.Close; FormShow (nil); end; end; end; end. |
Código fuente de los dos botones que se utilizarán en cualquier ventana de la aplicación para visualizar e insertar documentos:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
procedure TformGFactura.bAdjuntarClick( Sender: TObject); begin if (md.tFactura.State in [dsedit, dsinsert]) and (vtAccion <> 'zoom') then begin application.createform(TformGestionDocumental, formGestionDocumental); formGestionDocumental.Tag := 10; formGestionDocumental.txtID.Text := md.tFacturacodigo.AsString; formGestionDocumental.txtTabla.ItemIndex := formGestionDocumental.txtTabla.Items.IndexOf( 'Facturas a clientes'); formGestionDocumental.txtTabla.Enabled := false; formGestionDocumental.txtID.Enabled := false; formGestionDocumental.showmodal; end; end; procedure TformGFactura.bVisualizarDocumentosClick( Sender: TObject); begin application.createform(TformGestionDocumental, formGestionDocumental); formGestionDocumental.filtroVentana := 'Facturas a clientes'; formGestionDocumental.filtroCodigoRegistro := md.tFacturacodigo.AsInteger; formGestionDocumental.Tag := 20; formGestionDocumental.showmodal; end; |
En estos dos botones, para diferenciar de qué ventana se trata, utilizamos la variable «filtroVentana» del formulario «formGestionDocumental». También le pasaremos por otra variable «filtroCodigoRegistro» el valor del campo «codigo» que es clave primaria de la ventana actual (Facturas). Para diferenciar una inserción de una visualización utilizamos el parámetro «tag» del formulario «formGestionDocumental» (20 para una visualización, 10 para una inserción).