@clavisco/user-help

Tiene como propósito principal permitir al cliente (y también al equipo de soporte) acceder fácilmente a la documentación de la aplicación alojada en Confluence, con base en la vista actual desde la que se accede. Esto facilitará la comprensión de procesos y funcionalidades específicas sin necesidad de asistencia directa. Si no existe una configuración específica para la vista en cuestión, se redireccionará automáticamente a una ruta base de documentación.

Tabla de contenido

• Paquetes y dependencias requeridas
• Resumen de la versión
• Instalación
• ¿Cómo lo implemento?
• API de referencia

Paquetes y dependencias requeridas

• @angular/cdk ^13.2.5
• @angular/common ^13.0.0
• @angular/core ^13.0.0
• @angular/material ^13.2.5
• @clavisco/core ^0.2.4
• @clavisco/linker ^0.0.15
• @clavisco/table ^1.5.0-beta.0

Resumen de la versión

• Componente de visualización de links de documentación configurados
• Componente de edición de links de documentación
• Componente de botón de ayuda

Instalación

npm i @clavisco/user-help

¿Cómo lo implemento?

1. Instalar componentes npm i @clavisco/core@^0.2.4 @clavisco/linker@^0.0.15 @clavisco/table@^1.5.0-beta.0 @clavisco/logs-viewer.
2. Importaciones de modulos y servicios:
   • import { MatIconModule } from '@angular/material/icon';
   • import { MatButtonModule } from '@angular/material/button';
   • import { MatTooltipModule } from '@angular/material/tooltip';
   • import { TableModule } from '@clavisco/table';
   • import { CommonModule } from '@angular/common';
   • import { MatFormFieldModule } from '@angular/material/form-field';
   • import { MatCheckboxModule } from '@angular/material/checkbox';
   • import { ReactiveFormsModule } from '@angular/forms';
   • import { MatInputModule } from '@angular/material/input';
   • import { LinkerService } from '@clavisco/linker';
3. Agregar al array de imports los modulos y al array de providers los servicios.
4. El servicio de linker ser debe proveer de la siguiente manera: { provide: 'LinkerService', useClass: LinkerService }
5. Hay tres componentes
   • cl-user-help-admin-edit: Formulario de edición y creación de links de documentación. Tiene un atributo componentId que representa el identificador para la comunicacion mediante linker.
   • cl-user-help-administrator: Componente administrativo, contiene una tabla donde se van a mostrar los links de documentación configurados. Tiene un atributo componentId que representa el identificador para la comunicacion mediante linker.
   • cl-user-help-button: Botón de ayuda, el cual a presionarlo se redirecciona al link de documentación de la vista actual. Este componente debe implementarse en un lugar donde sea accesible desde cualquier vistas. Ejemplo, se podria implementar en el toolbar.
6. La comunicacion con el componente se explica en API de referencia
7. Listo, así se implementa el componente user help.

Api de referencia

Esta sección muestra todas las características disponibles y especificaciónes del consumo de estas.

Clase: LinkerService
Nombre: Publish
Tipo de retorno: void
Descripción: Este canal es utilizado para agregar y renderizar los enlaces de documentación configurados. El objeto que debe recibir el metodo debe ser el siguiente:

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:--------------|-----------------------|:--------------------------------------------------------------------------------------------------------------|-----------|------------| | CallBack | CL_CHANNEL | Canal por el cual se va a realizar al comunicacion con le componente | INFLATE | Sí | | Data | string | Objeto @clavisco/user-help.IUserHelpRedirectionLinkEntity[] serializado | | Sí | | Target | string | Identificador del componente cl-user-help-administrator, valor pasado por la propiedad componentId | | Sí |

Clase: LinkerService
Nombre: Publish
Tipo de retorno: void
Descripción: Este canal es utilizado para editar o crear un link de documentación. El objeto que debe recibir el metodo debe ser el siguiente:

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:--------------|-----------------------|:--------------------------------------------------------------------------------------------------------------|-----------|------------| | CallBack | CL_CHANNEL | Canal por el cual se va a realizar al comunicacion con le componente | INFLATE | Sí | | Data | string | Objeto @clavisco/user-help.IUserHelpRedirectionLinkEntity serializado o string vacio que indica creación | | Sí | | Target | string | Identificador del componente cl-user-help-admin-edit, valor pasado por la propiedad componentId | | Sí |

Clase: Método global de @clavisco/linker
Nombre: Register
Tipo de retorno: void
Descripción: Este canal se ejecuta cada vez que se quiere crear o editar un enlace de documentación

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:------------------|-----------------------------------|:---------------------------------------------------------------------------------------------------------|--------------------|------------| | _componentId | string | Identificador del componente cl-user-help-administrator, valor pasado por la propiedad componentId | | Sí | | _action | CL_CHANNEL | Canal que se debe escuchar para manejar la edición y creación de links de documentación | OUTPUT | Sí | | _callback | Function | Función que se va a ejecutar como manejador del evento del canal OUTPUT | | Sí | | _interface | ICLCallbacksInterface<CL_CHANNEL> | Objeto utilizado para registrar el callback | | Sí |

Clase: Método global de @clavisco/linker
Nombre: Register
Tipo de retorno: void
Descripción: Este canal se ejecuta cada vez que se quiere guardar o cancelar una edición o creación

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:------------------|-----------------------------------|:---------------------------------------------------------------------------------------------------------|--------------------|------------| | _componentId | string | Identificador del componente cl-user-help-admin-edit, valor pasado por la propiedad componentId | | Sí | | _action | CL_CHANNEL | Canal que se debe escuchar para manejar el guardar o cancelar una edición o creación | OUTPUT | Sí | | _callback | Function | Función que se va a ejecutar como manejador del evento del canal OUTPUT | | Sí | | _interface | ICLCallbacksInterface<CL_CHANNEL> | Objeto utilizado para registrar el callback | | Sí |

Clase: Repository.Behavior
Nombre: SetTokenConfiguration
Tipo de retorno: void
Descripción: Se debe ejectuar para configurar los enlaces de documentación que se utilizaran cuando se presione el botón de ayuda.

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:----------|---------|:----------------------------------------------------------------------------|----------|------------| | token | string | Usar @clavisco/core.Structures.Enums.TOKENS.USER_HELP | | Sí | | value | string | Un JSON de @clavisco/user-help.IUserHelpDocumentationLink[] | | Sí | | setting | string | Usar enumerado @clavisco/user-help.UserHelpConfiguration.DocumentationLinks | | Sí | | override | boolean | Para sobreescribir la configuración | | No |

Clase: Repository.Behavior
Nombre: SetTokenConfiguration
Tipo de retorno: void
Descripción: (Opcional) Se debe ejectuar para configurar el formato de fecha que tendrán los campos de fecha en la tabla.

| Parámetro | Tipo | Descripción | Defecto | Mandatorio | |:----------|---------|:---------------------------------------------------------------------|----------|------------| | token | string | Usar @clavisco/core.Structures.Enums.TOKENS.USER_HELP | | Sí | | value | string | Un formato de fecha | | Sí | | setting | string | Usar enumerado @clavisco/user-help.UserHelpConfiguration.DateFormats | | Sí | | override | boolean | Para sobreescribir la configuración | | No |

Especificación de datos especiales

Clase: IUserHelpDocumentationLink
Nombre: ApplicationPath
Tipo de dato: string
Descripción: Representa la URL de la aplicación donde se va a usar el enlace de documentación. Detalles:

• El formato debe ser /<path>.
• En caso de que la URL tenga parametros de ruta (/user/edit/:id) se debe reemplazar el parametro por #any# dando como resultado /user/edit/#any#.

ClavisCo © - 2025

Keywords

help user-help user