IndexedFileTray
- 1 Datos Generales
- 2 Parámetros soportados
- 2.1 name
- 2.2 inputFolder
- 2.3 outputFolder
- 2.4 errorFolder
- 2.5 backupFolder
- 2.6 className
- 2.7 internalName
- 2.8 indexFileExtension
- 2.9 deleteEmptySubFolders
- 2.10 batchIncompleteCheckExpression
- 2.11 keepFileNameOnError
- 2.12 count
- 2.13 fields
- 2.14 includeSubFolders
- 2.15 includeFiles
- 2.16 processOldestFirst
- 2.17 maskTool
- 3 Ejemplo de Configuración
Datos Generales
Tipo de Bandeja | Carpeta de FileSystem. |
---|---|
Nombre Calificado | com.latintech.thuban.docintro.tray.IndexedFileTray |
Extiende de | |
Descripción | Extiende el comportamiento de FolderTray para permitir el procesamiento de archivos indexados mediante un archivo de indices separado. Permite buscar en subcarpetas y eliminar carpetas vacías. |
Disponible desde Versión | 5.7 |
Parámetros soportados
A continuación se listarán todos los parámetros aceptados por la bandeja. Los títulos que anteceden cada tabla son los nombres de los parámetros, los mismos son caseSensitive.
name
Tipo | String |
---|---|
Requerido | Sí. |
Descripción | Es el nombre que se le otorga a esta instancia particular de la bandeja que se está definiendo en el XML de DocIntro. Es utilizado para referencia la bandeja en el TrayManager. |
inputFolder
Tipo | Carpeta |
---|---|
Requerido | Sí. Además la misma debe existir. |
Descripción | Carpeta desde la cuál se tomarán los archivos a ser procesados. |
outputFolder
Tipo | Carpeta |
---|---|
Requerido | Sí. Además la misma debe existir. |
Descripción | Carpeta dónde serán trasladados todos los archivos que hayan sido procesados correctamente. |
errorFolder
Tipo | Carpeta |
---|---|
Requerido | Sí. Además la misma debe existir. |
Descripción | Carpeta dónde serán traslados todos los archivos que al ser procesados hayan arrojado un error. Junto al archivo, en la misma carpeta se depositará un archivo de tipo .log con el detalle del error y el archivo de índice asociado. |
backupFolder
Tipo | Carpeta |
---|---|
Requerido | Sí. Además la misma debe existir |
Descripción | Carpeta donde se dejará un resguardo de los archivos procesados. |
className
Tipo | String |
---|---|
Requerido | No |
Descripción | Indica el ID de la clase documental de destino de los archivos a ser procesados. No es necesario definirla aquí, puede ser definida posteriormente en un procesador. |
internalName
Tipo | String |
---|---|
Requerido | No |
Descripción | Permite sobreescribir la configuración de la clase documental indicando aquí de que forma se debe conformar el nombre del documento en Thuban. Puede ser definido posteriormente en un procesador de subida de documentos. En caso de no informar nada en ningún lado del DocIntro, al momento de subirse el documento a Thuban se generará el nombre como está definido en la clase documental. |
indexFileExtension
Tipo | String |
---|---|
Requerido | Sí |
Descripción | La extension del archivo de índices. Se asume que el archivo de índices se llama igual al archivo de imagen + la nueva extensión o al archivo de imagen con la extension. Por ejemplo: Para imagen.tif si “indexFileExtension” es indices, se busca imagen.tif.indices o imagen.indices para recuperar los indices que irán asociados a imagen.tif |
deleteEmptySubFolders
Tipo | Boolean |
---|---|
Requerido | No |
Descripción | Indica si debe eliminar las carpetas vacías que quedan luego del procesamiento. |
batchIncompleteCheckExpression
Tipo | String |
---|---|
Requerido | No |
Descripción | Expresión regular que en caso de ser configurada, hará que no se procesan documentos mientras se encuentren archivos que cumplen con la expresion. Sería para controlar que se hayan cargado en la carpeta todos los archivos necesarios antes de empezar a procesar. Por ejemplo, se podría poner un archivo .temp mientras se suben los documentos y como expresión regular “.*.([tT][eE][mM][pP])$“ entonces, mientras haya al menos un archivo .temp, la bandeja no procesará archivos. |
keepFileNameOnError
Tipo | Boolean |
---|---|
Requerido | No. Valor por defecto “false” |
Descripción | Si se configura en “true”, en caso de ocurrir un error, al pasar el archivo a la carpeta “errorFolder” no modificará el nombre del archivo original. Es decir, no le agregará la fecha de procesamiento como es el comportamiento estandar. |
count
Tipo | Integer |
---|---|
Requerido | Sí |
Descripción | Indica cuántos archivos serán procesados por la bandeja en cada ejecución del DocIntro. |
Este no es estrictamente un parámetro obligatorio en el sentido de que la aplicación no arrojará un error de no estar definido.
Sin embargo, decidimos ponerlo como tal ya que el valor que toma por defecto es “0”, entonces el efecto será que no se procesará ningún archivo de la carpeta y eso podría causar confusión sobre el funcionamiento de nuestro DocIntro.
fields
Tipo | Map |
---|---|
Requerido | Sí, aunque puede estar vacío. |
Descripción | Mapa de campos que se quiere agregar el ítem de trabajo de la bandeja. |
Ejemplo | <property name="fields">
<map>
<entry>
<key><value>F_INGRESO</value></key>
<value>$F{'yyyy-MM-dd'}</value>
</entry>
</map>
</property> |
includeSubFolders
Tipo | Boolean |
---|---|
Requerido | No. Valor por defecto “false” |
Descripción | Indica si debe buscar archivos en subcarpetas de la carpeta “inputFolder” |
includeFiles
Tipo | String |
---|---|
Requerido | Sí |
Descripción | Expresión regular de inclusión de archivos a procesar. No confundir con archivos índice. |
Ejemplo | .*.([cC][sS][vV])$ → Procesa solo archivos .pdf |
processOldestFirst
Tipo | Boolean |
---|---|
Requerido | No. Por defecto asume el valor “false” |
Descripción | Le indica a la bandeja si debe procesar primero los archivos más antiguos. |
maskTool
Tipo | ThubanMaskTool |
---|---|
Requerido | No |
Descripción | Esta es una propiedad que referencia otro Bean de utilidades del docintro que permite reemplazar valores de campos o asignar valores a campos en función de Máscaras. Por ejemplo, si se define una campo:
Esa máscara será reemplazada por la fecha del momento con ese formato por el maskTool. |
Ejemplo de Configuración
<bean id="createTramite" class="com.latintech.thuban.docintro.tray.IndexedFileTray">
<property name="inputFolder" value="C:\DocIntro\input"/>
<property name="outputFolder" value="C:\DocIntro\output"/>
<property name="errorFolder" value="C:\DocIntro\error"/>
<property name="backupFolder" value="C:\DocIntro\bkp"/>
<property name="className" value="CLASE_1"/>
<property name="internalName" value=""/>
<property name="indexFileExtension" value="txt"/>
<property name="includeFiles" value=".*\.([pP][dD][fF])$"/>
<property name="count" value="100"/>
<property name="fields">
<map>
</map>
</property>
<property name="maskTool" ref="maskTool"/>
<property name="marshallingManager" ref="fileMarshallingManager"/>
<property name="name" value="createTramite"/>
</bean>