FolderTray
- 1 Datos Generales
- 2 Parámetros soportados
- 2.1 name
- 2.2 inputFolder
- 2.3 outputFolder
- 2.4 errorFolder
- 2.5 className
- 2.6 internalName
- 2.7 count
- 2.8 fields
- 2.9 ignoreFolders
- 2.10 ignoreFiles
- 2.11 includeFolders
- 2.12 includeFiles
- 2.13 keepOriginalName
- 2.14 processOldestFirst
- 2.15 maskTool
- 3 Ejemplo de Configuración
Datos Generales
Tipo de Bandeja | Carpeta de FileSystem. |
---|---|
Nombre Calificado | com.latintech.thuban.docintro.tray.FolderTray |
Extiende de | |
Descripción | Bandeja de trabajo que permite recuperar los archivos de una ubicacion en un filesystem. |
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. |
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. |
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> |
ignoreFolders
Tipo | String |
---|---|
Requerido | No |
Descripción | Expresión regular de exclusion de carpetas. Si es null se ignora este parámetro. |
ignoreFiles
Tipo | String |
---|---|
Requerido | No |
Descripción | Expresión regular de exclusion de archivos. Si es null se ignora este parámetro. |
Ejemplo | .*.([cC][sS][vV])$ → Ignora todos los archivos .csv |
includeFolders
Tipo | String |
---|---|
Requerido | No |
Descripción | Expresión regular de inclusion de carpetas. Si es null se ignora este parámetro. |
includeFiles
Tipo | String |
---|---|
Requerido | No |
Descripción | Expresión regular de inclusión de archivos. Si es null se ignora este parámetro. |
Ejemplo | .*.([cC][sS][vV])$ → Procesa solo archivos .pdf |
keepOriginalName
Tipo | Boolean |
---|---|
Requerido | No. Por defecto asume el valor “true” |
Descripción | Le indica a la bandeja si debe mantener el nombre original del archivo que procesa. |
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="createFileTray" class="com.latintech.thuban.docintro.tray.FolderTray">
<property name="inputFolder" value="C:\docintro\input"/>
<property name="outputFolder" value="C:\docintro\output"/>
<property name="errorFolder" value="C:\docintro\error"/>
<property name="internalName" value=""/>
<property name="count" value="10"/>
<property name="includeFiles" value=".*\.([pP][dD][fF])$"/>
<property name="className" value=""/>
<property name="fields">
<map>
<entry>
<key><value>F_INGRESO</value></key>
<value>$F{'yyyy-MM-dd'}</value>
</entry>
</map>
</property>
<property name="maskTool" ref="maskTool"/>
<property name="marshallingManager" ref="fileMarshallingManager"/>
<property name="name" value="createFileTray"/>
</bean>