Documentación de manifiestos de frontend

En este documento se proporciona una guía detallada sobre la estructura y configuración de los manifiestos de frontend en las cargas de trabajo de Fabric. Estos manifiestos basados en JSON permiten a los asociados definir la apariencia, la identidad y el comportamiento de la carga de trabajo, algo esencial para ofrecer a los usuarios una experiencia personalizada y coherente en Fabric.

Los manifiestos de frontend constan de dos componentes principales:

• Manifiesto del producto: defina la identidad de carga de trabajo y la personalización de marca.
• Manifiesto de elemento: configuración de detalles de elementos individuales dentro de la carga de trabajo, incluidos los elementos de interacción del usuario.

Manifiesto del producto

El manifiesto de producto define los atributos principales del producto de la carga de trabajo, especificando su identidad, marca y configuración para la interacción con el usuario.

Atributos

• name (cadena): un nombre de sistema único para el producto.
• displayName (cadena): nombre para mostrar fácil de usar.
• fullDisplayName (cadena): un nombre descriptivo para el producto.
• favicon (cadena): ruta de acceso al favicon del producto’.
• icon (objeto): ruta de acceso al icono del producto, almacenado en la carpeta assets (por ejemplo, "assets/icon.png").

Configuración de la página principal

Define el diseño y el contenido de la página principal de la carga de trabajo.

• homePage (objeto): opciones de configuración de la página principal.
  • learningMaterials (matriz): lista de materiales de aprendizaje mostrados en la página de detalles de la carga de trabajo.
    • title (cadena): título del material de aprendizaje.
    • introduction (cadena): breve introducción al material.
    • description (cadena): descripción detallada del material.
    • onClick (objeto): acción desencadenada cuando se hace clic en el material.
    • image (cadena): ruta de acceso a la imagen asociada al material.
  • recommendedItemTypes (matriz): lista de tipos de elementos recomendados que se muestran en la página de detalles de la carga de trabajo.

Crear experiencia

Configuraciones para crear nuevos elementos en el producto, especificando opciones para la interacción del usuario.

• createExperience (objeto): configuración para la creación de elementos de carga de trabajo.
  • description (cadena): descripción general de la experiencia de creación.
  • cards (matriz): lista de tarjetas mostradas durante el proceso de creación.
    • title (cadena): título de la tarjeta.
    • description (cadena): breve descripción de la tarjeta.
    • icon (objeto): ruta de acceso al icono usado en la tarjeta.
    • onClick (objeto): acción desencadenada cuando se hace clic en la tarjeta.
    • availableIn (matriz): ubicaciones donde la tarjeta está disponible.
    • itemType (cadena): tipo de elemento vinculado a la tarjeta creada.

Configuración del área de trabajo y detalles del producto

• workspaceSettings (objeto): configuración específica de la funcionalidad del área de trabajo.
  • getWorkspaceSettings (objeto): contiene la acción para recuperar la configuración del área de trabajo.
• productDetail (objeto): detalles adicionales para la personalización de marca y la información del producto.
  • publisher (cadena): publicador del producto.
  • slogan (cadena): eslogan del producto.
  • description (objeto): breve descripción del producto.
  • image (objeto): configuración de imágenes de producto.
    • mediaType (entero): tipo de medio de la imagen.
    • source (cadena): ruta de acceso a la imagen.
  • slideMedia (matriz): lista de archivos multimedia usados en las diapositivas de la página de detalles del producto.

Manifiesto de elemento

El Manifiesto de elementos define detalles de configuración para elementos individuales dentro de la carga de trabajo, incluyendo atributos, iconos, rutas del editor y la configuraciones relacionadas con el trabajo.

Atributos

• name (cadena): un nombre de sistema único para el elemento.
• displayName (cadena): nombre descriptivo que se muestra para el elemento.
• displayNamePlural (cadena): forma plural del nombre para fines de visualización.

Configuración del editor y del icono

• editor (objeto): configuración de la ruta para el editor del elemento en la aplicación de carga de trabajo Fabric.
  • path (cadena): ruta de acceso relativa al editor.
• icon (objeto): especifica el icono que representa el elemento.
  • name (cadena): ruta de acceso al archivo de icono de la carpeta assets (por ejemplo, "assets/icon.svg").

Elementos del menú contextual

Define las acciones disponibles en el menú contextual del elemento, proporcionando a los usuarios opciones de interacción.

• contextMenuItems (matriz): lista de acciones en el menú contextual.
  • name (cadena): nombre del sistema de la acción.
  • displayName (cadena): nombre para mostrar de la acción.
  • icon (objeto): icono de la acción.
    • name (cadena): ruta de acceso al archivo de icono (por ejemplo, "assets/icon.svg").
  • handler (objeto): controlador de acciones para el elemento de menú.
    • action (cadena): nombre de la acción desencadenada.
  • tooltip (cadena): texto de información sobre herramientas opcional para la acción.

Supervisión y configuración de DataHub

• supportedInMonitoringHub (booleano): especifica si el elemento se puede mostrar o filtrar en el Centro de supervisión.
• supportedInDatahubL1 (booleano): especifica si el elemento se puede mostrar o filtrar en DataHub L1.

Configuración de la acción de trabajo de elemento

Configuraciones para acciones relacionadas con el trabajo asociadas a la instancia de trabajo de elemento.

• itemJobActionConfig (objeto): define acciones relacionadas con los trabajos del elemento.
  • registeredActions (objeto): contiene acciones de trabajo como detallar, cancelar y reintentar.
    • detail (objeto): acción para ver los detalles del trabajo.
    • cancel (objeto): acción para cancelar un trabajo.
    • retry (objeto): acción para reintentar un trabajo.

Configuración del elemento

Opciones de configuraciones para la configuración del elemento.

• itemSettings (objeto): configuración adicional para el elemento.
  • schedule (objeto): contiene información de programación.
    • itemJobType (cadena): tipo de trabajo que se va a programar desde la interfaz de usuario compartida del tejido.
    • refreshType (cadena): especifica la funcionalidad de actualización del elemento. Los valores posibles incluyen "None", "Refresh" y "Run".
  • recentRun (objeto): configuración para ejecuciones de trabajos recientes.
    • useRecentRunsComponent (booleano): si se usa el componente de ejecuciones recientes compartidas del tejido.
  • getItemSettings (objeto): configuración para elementos personalizados.
    • acción (cadena): nombre de la acción correspondiente que devolverá la lista de opciones de configuración de elementos personalizados.

Categorías de flujo de tareas de elemento

Define las categorías de elementos para la integración con Fabric Task Flow Framework..

• itemJobTypes (matriz): especifica las categorías asignadas a un elemento dentro del marco de flujo de tareas. Cada elemento puede tener hasta dos categorías. Las categorías admitidas son "getData", "storeData", "prepareData", "analyzeAndTrainData", "trackData", "visualizeData", "develop", "generalTask" y "others". Si no se especifica ninguna categoría, se usa "otros" como valor predeterminado.

Nota:

Cuando desarrolle y pruebe nuevos atributos agregados al manifiesto, asegúrese de haber sincronizado los scripts de validación más recientes y las herramientas de nuestro repositorio de muestra.

Este paso solo es necesario para el desarrollo local y no es necesario para el modo de nube.