Trucos y Consejos

test3
Consejos y trucos útiles sobre FME
Del caos a la claridad: cómo mejorar tus proyectos de FME con una buena documentación

A medida que los procesos en FME se vuelven más complejos, la necesidad de una documentación clara y estructurada cobra mayor importancia.

Mantener una documentación organizada permite que los espacios de trabajo se utilicen de manera eficiente a largo plazo, facilita el trabajo en equipo y ayuda a mejorar y ampliar los procesos existentes. En cambio, los procesos sin documentación suelen resultar difíciles de comprender para otros usuarios.

En este artículo, te presentamos las mejores prácticas para documentar los procesos de FME de forma clara y organizada.

Parámetros de descripción del espacio de trabajo:

La información general sobre un proceso de FME se puede almacenar en el parámetro Descripción del espacio de trabajo (ver Imagen 1). Aquí se pueden registrar metadatos importantes para facilitar la comprensión del espacio de trabajo, tanto para su uso en FME Form como para su publicación en FME Flow o en FME Hub.

 

Imagen 1: Descripción de los Parámetros del Espacio de Trabajo
Imagen 1: Descripción de los Parámetros del Espacio de Trabajo

 

Se puede almacenar la siguiente información:

 

  • Nombre del espacio de trabajo: Asigna un nombre descriptivo a tu proceso. Este nombre es independiente del nombre del archivo .fmw que se guarde. 
  • Categoría: Asocia al espacio de trabajo a una categoría adecuada. Esto es especialmente útil si el proceso se va a publicar en el FME Hub. 
  • Resumen: Aquí puedes añadir una descripción general del espacio de trabajo. Esto es particularmente relevante si el proceso se va a ejecutar en FME Flow, ya que la descripción se mostrará en el menú "Run Workspace". 
  • Ayuda: se pueden añadir notas importantes sobre el uso del espacio de trabajo, como, por ejemplo, información sobre archivos de origen necesarios o dependencias de Transformadores personalizados y sistemas externos. 
  • Historial: Si el proceso ha sido desarrollado o modificado por varias personas, este campo se puede usar para documentar los cambios realizados. Además, aquí se muestra la fecha y hora de la última vez que se guardó el archivo, así como la versión de FME utilizada.

 

Para añadir o modificar esta información, abre el apartado Descripción dentro de los Parámetros del Espacio de Trabajo en la ventana del Navegador, haciendo doble clic sobre cualquiera de los subelementos.

Comentarios:

Los comentarios pueden colocarse en cualquier parte del espacio de trabajo, ya sea de forma independiente o asociados a elementos como Feature Types o Transformadores. Ambas opciones se muestran en la Imagen 2.

 

Los comentarios independientes son útiles para incluir explicaciones generales sobre todo el proceso o sobre secciones específicas del mismo.

 

Además, los comentarios pueden adjuntarse directamente a objetos específicos como Feature Types o Transformadores. Estos comentarios ayudan a documentar cada paso del proceso o a señalar configuraciones particulares.

 

Se pueden agregar al espacio de trabajo o sobre el objeto deseado haciendo clic derecho y seleccionando Añadir Comentario.

 

Imagen 2: Comentarios independientes y comentarios adjuntos
Imagen 2: Comentarios independientes y comentarios adjuntos

 

Tras insertar un comentario, el texto puede formatearse mediante la barra de herramientas, por ejemplo, ajustando el tamaño o el color de la fuente (véase la Imagen 3).

 

Imagen 3: Personalización del formato mediante la barra de herramientas
Imagen 3: Personalización del formato mediante la barra de herramientas 

Descripciones Breves:

Las Descripciones Breves son útiles si se desea documentar de forma breve todos los ajustes de un Transformador. Se actualizan automáticamente en cuanto cambia algo en la configuración del Transformador y, por tanto, siempre reflejan el estado actual. 

 

Imagen 4: Descripción Breve
Imagen 4: Descripción Breve

 

Para mostrar las Descripciones breves, haz clic con el botón derecho del ratón en el Transformador o Feature Type y selecciona Mostrar Descripción Breve.

Documentación de parámetros individuales en Transformadores:

También pueden almacenarse comentarios para ajustes específicos dentro de los Transformadores. Estos aparecen cuando se abren los parámetros del Transformador y se pasa el ratón por el campo correspondiente. De este modo, el espacio de trabajo queda claramente organizado, mientras que los comentarios detallados también pueden almacenarse en el Transformador.

 

Esta función se introdujo con FME 2024.1.

 

Imagen 5: Comentarios de los parámetros del Transformador
Imagen 5: Comentarios de los parámetros del Transformador 

 

Para añadir un comentario a un parámetro, haz clic en el símbolo de la flecha situado junto al ajuste correspondiente y selecciona Añadir Comentario.

 

Imagen 6: Inserción de un comentario en un parámetro de un Transformador
Imagen 6: Inserción de un comentario en un parámetro de un Transformador

Marcadores:

Los marcadores también son útiles para documentar y estructurar los espacios de trabajo. Permiten dividir el proceso en secciones claramente definidas.

 

A cada marcador se le puede asignar un título, que también aparece en la ventana del Navegador. Haciendo doble clic en el título del marcador correspondiente en el Navegador, FME pasa directamente a la sección del proceso, lo que ahorra tiempo, especialmente con procesos grandes y complejos.

 

Los marcadores pueden insertarse seleccionando los elementos deseados, haciendo clic con el botón derecho del ratón para abrir el menú y seleccionando la opción Crear Marcador.

 

Imagen 7: Marcadores
Imagen 7: Marcadores

Documentación en automatizaciones de FME Flow

Los comentarios y marcadores también se pueden utilizar en las Automatizaciones de FME Flow para documentar los procesos y hacerlos comprensibles para los demás.

 

Pueden insertarse en la automatización haciendo clic con el botón derecho del ratón y fijarse directamente a los elementos existentes o colocarse de forma independiente.

 

Imagen 8: Comentarios y marcadores en una automatización de FME Flow
Imagen 8: Comentarios y marcadores en una automatización de FME Flow

Puedes encontrar más información sobre FME en https://www.conterra.es/portfolio/fme.

Contacto

Francisco Girón Gesteira

Francisco Girón Gesteira

+34 911 391 240