diff --git a/files/en/addons_modules/addons_modules.md b/files/en/addons_modules/addons_modules.md index 5891e0bd..08d47e77 100644 --- a/files/en/addons_modules/addons_modules.md +++ b/files/en/addons_modules/addons_modules.md @@ -18,6 +18,7 @@ In this section, we can view, install or delete useful add-ons for integration w * [SageOne module](addons_modules/sageone/sageone.md) * [Self Registration](addons_modules/self_registration/self_registration.md) * [Speedtest](addons_modules/speedtest/speedtest.md) +* [Splynx Adamo](addons_modules/splynx_adamo/splynx_adamo.md) * [Splynx Mailjet](addons_modules/splynx_mailjet/splynx_mailjet.md) * [splynx-ssh-term](addons_modules/splynx-ssh-term/splynx-ssh-term.md) * [splynx_remote_support](addons_modules/splynx_remote_support/splynx_remote_support.md) diff --git a/files/en/addons_modules/splynx_adamo/01.png b/files/en/addons_modules/splynx_adamo/01.png new file mode 100644 index 00000000..11749a50 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/01.png differ diff --git a/files/en/addons_modules/splynx_adamo/02.png b/files/en/addons_modules/splynx_adamo/02.png new file mode 100644 index 00000000..d313fd40 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/02.png differ diff --git a/files/en/addons_modules/splynx_adamo/03.png b/files/en/addons_modules/splynx_adamo/03.png new file mode 100644 index 00000000..7631679d Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/03.png differ diff --git a/files/en/addons_modules/splynx_adamo/04.png b/files/en/addons_modules/splynx_adamo/04.png new file mode 100644 index 00000000..a368daaf Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/04.png differ diff --git a/files/en/addons_modules/splynx_adamo/05.png b/files/en/addons_modules/splynx_adamo/05.png new file mode 100644 index 00000000..ba71b7af Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/05.png differ diff --git a/files/en/addons_modules/splynx_adamo/07.png b/files/en/addons_modules/splynx_adamo/07.png new file mode 100644 index 00000000..29f922ae Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/07.png differ diff --git a/files/en/addons_modules/splynx_adamo/08.png b/files/en/addons_modules/splynx_adamo/08.png new file mode 100644 index 00000000..abec44d6 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/08.png differ diff --git a/files/en/addons_modules/splynx_adamo/09.png b/files/en/addons_modules/splynx_adamo/09.png new file mode 100644 index 00000000..819da69e Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/09.png differ diff --git a/files/en/addons_modules/splynx_adamo/10.png b/files/en/addons_modules/splynx_adamo/10.png new file mode 100644 index 00000000..e4a1b11b Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/10.png differ diff --git a/files/en/addons_modules/splynx_adamo/11.png b/files/en/addons_modules/splynx_adamo/11.png new file mode 100644 index 00000000..34aadfca Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/11.png differ diff --git a/files/en/addons_modules/splynx_adamo/12.png b/files/en/addons_modules/splynx_adamo/12.png new file mode 100644 index 00000000..37dbf9bb Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/12.png differ diff --git a/files/en/addons_modules/splynx_adamo/13.png b/files/en/addons_modules/splynx_adamo/13.png new file mode 100644 index 00000000..8c1c92fa Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/13.png differ diff --git a/files/en/addons_modules/splynx_adamo/14.png b/files/en/addons_modules/splynx_adamo/14.png new file mode 100644 index 00000000..f959137c Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/14.png differ diff --git a/files/en/addons_modules/splynx_adamo/15.png b/files/en/addons_modules/splynx_adamo/15.png new file mode 100644 index 00000000..f53de698 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/15.png differ diff --git a/files/en/addons_modules/splynx_adamo/16.png b/files/en/addons_modules/splynx_adamo/16.png new file mode 100644 index 00000000..1818d299 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/16.png differ diff --git a/files/en/addons_modules/splynx_adamo/17.png b/files/en/addons_modules/splynx_adamo/17.png new file mode 100644 index 00000000..76647b3f Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/17.png differ diff --git a/files/en/addons_modules/splynx_adamo/18.png b/files/en/addons_modules/splynx_adamo/18.png new file mode 100644 index 00000000..07693d8b Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/18.png differ diff --git a/files/en/addons_modules/splynx_adamo/19.png b/files/en/addons_modules/splynx_adamo/19.png new file mode 100644 index 00000000..0f692871 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/19.png differ diff --git a/files/en/addons_modules/splynx_adamo/20.png b/files/en/addons_modules/splynx_adamo/20.png new file mode 100644 index 00000000..21b03de7 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/20.png differ diff --git a/files/en/addons_modules/splynx_adamo/21.png b/files/en/addons_modules/splynx_adamo/21.png new file mode 100644 index 00000000..c8cb0701 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/21.png differ diff --git a/files/en/addons_modules/splynx_adamo/22.png b/files/en/addons_modules/splynx_adamo/22.png new file mode 100644 index 00000000..d1ffb7bc Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/22.png differ diff --git a/files/en/addons_modules/splynx_adamo/23.png b/files/en/addons_modules/splynx_adamo/23.png new file mode 100644 index 00000000..d22a36df Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/23.png differ diff --git a/files/en/addons_modules/splynx_adamo/24.png b/files/en/addons_modules/splynx_adamo/24.png new file mode 100644 index 00000000..1e9310d6 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/24.png differ diff --git a/files/en/addons_modules/splynx_adamo/25.png b/files/en/addons_modules/splynx_adamo/25.png new file mode 100644 index 00000000..64eef350 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/25.png differ diff --git a/files/en/addons_modules/splynx_adamo/26.png b/files/en/addons_modules/splynx_adamo/26.png new file mode 100644 index 00000000..474e8d94 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/26.png differ diff --git a/files/en/addons_modules/splynx_adamo/27.png b/files/en/addons_modules/splynx_adamo/27.png new file mode 100644 index 00000000..d609bbef Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/27.png differ diff --git a/files/en/addons_modules/splynx_adamo/28.png b/files/en/addons_modules/splynx_adamo/28.png new file mode 100644 index 00000000..9b059951 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/28.png differ diff --git a/files/en/addons_modules/splynx_adamo/29.png b/files/en/addons_modules/splynx_adamo/29.png new file mode 100644 index 00000000..237c2ae8 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/29.png differ diff --git a/files/en/addons_modules/splynx_adamo/30.png b/files/en/addons_modules/splynx_adamo/30.png new file mode 100644 index 00000000..5ee1035b Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/30.png differ diff --git a/files/en/addons_modules/splynx_adamo/31.png b/files/en/addons_modules/splynx_adamo/31.png new file mode 100644 index 00000000..0a1575f3 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/31.png differ diff --git a/files/en/addons_modules/splynx_adamo/32.png b/files/en/addons_modules/splynx_adamo/32.png new file mode 100644 index 00000000..3d5f35e7 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/32.png differ diff --git a/files/en/addons_modules/splynx_adamo/33.png b/files/en/addons_modules/splynx_adamo/33.png new file mode 100644 index 00000000..a40cdb79 Binary files /dev/null and b/files/en/addons_modules/splynx_adamo/33.png differ diff --git a/files/en/addons_modules/splynx_adamo/splynx_adamo.md b/files/en/addons_modules/splynx_adamo/splynx_adamo.md new file mode 100644 index 00000000..5d37c9a1 --- /dev/null +++ b/files/en/addons_modules/splynx_adamo/splynx_adamo.md @@ -0,0 +1,248 @@ +Splynx Adamo +========== + +![Adamo Logo](./01.png?w=200&h=100) + + +**Contenido** + +- [Splynx Adamo](#splynx-adamo) + - [1. Configuración del módulo](#1-configuración-del-módulo) + - [1.1 Preparación de los datos](#11-preparación-de-los-datos) + - [1.2 Obtención del Api-Key de Adamo](#12-obtención-del-api-key-de-adamo) + - [1.3 Configuración del módulo](#13-configuración-del-módulo) + - [1.4 Carga de Servicios](#14-carga-de-servicios) + - [2. Gestión de UUIS](#2-gestión-de-uuis) + - [2.1 Añadir UUIS](#21-añadir-uuis) + - [2.1 Actualizar UUIS](#21-actualizar-uuis) + - [3. Gestión de pedidos](#3-gestión-de-pedidos) + - [3.1 Listado de Pedidos](#31-listado-de-pedidos) + - [3.2 Alta de pedidos](#32-alta-de-pedidos) + - [3.3 Modificación de pedidos](#33-modificación-de-pedidos) + - [3.4 Cancelación/Baja de pedidos](#34-cancelaciónbaja-de-pedidos) + - [3.5 Provisión de pedidos](#35-provisión-de-pedidos) + - [3.6 Obtención de FSAN](#36-obtención-de-fsan) + - [3.7 Cambio de FSAN](#37-cambio-de-fsan) + - [3.8 Envio de incidencias](#38-envio-de-incidencias) + - [3.9 Citar un pedido](#39-citar-un-pedido) + - [3.10 Check ONT](#310-check-ont) + - [3.11 Refrescar pedidos](#311-refrescar-pedidos) + +## 1. Configuración del módulo +### 1.1 Preparación de los datos +Para el correcto funcionamiento del módulo hace falta disponer de la API-Key de Adamo, en el siguiente paso se describe cómo obtenerlo, y un acceso al correo electrónico que se facilitó a Adamo, el mismo con el que hacen login en el portal de Wholesale de Adamo, para el envío del correo necesario en caso de generar una incidencia. La contraseña se encriptará y no se utilizará para otra cosa que no sea el envío de correos a Adamo. + +### 1.2 Obtención del Api-Key de Adamo +Para la obtención del Api-Key vamos a necesitar un terminal con la funcionalidad curl instalada y las credenciales para el acceso a la plataforma Wholesale. Cuando tengamos estos datos, vamos al terminal del equipo e introducimos el siguiente comando: +```sh +curl --header "Content-Type: application/json" \ + --request POST \ + --data '{"email":"xyz","password":"xyz"}' \ +https://wholesale.adamo.es/api/v1/api-key +```` + +Se sustituirá xyz tanto en email y en la password con los datos de acceso al portal y dará una +respuesta como esta: +```sh +{ + "key":"12345abcdef12345abcdef345f60123458312345e12345abcdef45bf12345abcdef45c123456192812345e912345abcdef5731234541412345abcdefabcdef6c4", + "role":"operator", + "organization":"yy", + "id":"xxx", + "email":"xyz", + "self_installer":z +} +```` + +Nos quedaremos con la key para la configuración del módulo. + +### 1.3 Configuración del módulo +Accederemos a **Configuración > Integraciones > Lista de módulos > splynx_adamo_addon** y rellenaremos los siguientes campos: + +![Api Key configuration](./02.png) + +Aquí pegamos la key que obtuvimos en el paso anterior. + +![SFTP configuration](./03.png) + +Completamos los datos de FTP de Adamo (IP, puerto, usuario y contraseña), en el caso de que se quiera hacer uso del botón de importación de UIs automático desde el FTP. + +### 1.4 Carga de Servicios +Para que el addon funcione, es fundamental cargar los servicios antes del primero uso. Además, en el caso de contratar un nuevo servicio con Adamo, será necesario repetir esta operación de forma manual. +Para ello, hay que acceder a Configuración > Integraciones > Adamo Services y hacer click en el botón Actualizar servicios que se muestra +a continuación: + +![Carga de servicios](./33.png) + + +## 2. Gestión de UUIS +### 2.1 Añadir UUIS +Para añadir UUIS al sistema para poder realizar las altas hay que ir a Configuración > Integraciones > Adamo UIs en la que veremos en la parte superior el texto “Importar UIs” haremos click en él para que se despliegue el menú para la subida del csv. Adicionalmente, existe la posibilidad de cargar directamente desde el FTP de Adamo (siempre que se hayan configurado los datos de acceso al mismo como se puede ver en la figura anterior). + +![Upload UIs](./04.png) + +Los formatos soportados para la subida de unidades inmobiliarias son los formatos en los que Adamo los exporta, teniendo estas dos opciones: Formato de huella y formato de API California. + +![UIs header](./05.png) + +Cualquier subida con otro formato puede dar un error de de base de datos. + +Una vez importado el fichero nos saldrá en la tabla inferior las UUIS ya importadas, pudiendo utilizar el buscador para encontrar una en específico. + +![UIs](./07.png) + +### 2.1 Actualizar UUIS +Para actualizar una UUI o añadir otra, hay que volver a subir un fichero con el formato especificado en el punto anterior, si se vuelve a subir un fichero con UUIS solo se actualizan las que con el mismo id tengan valor distinto y se insertarán las que no estén previamente. Por lo tanto se puede subir el fichero entero de todas las UUIS sin temor a que se dupliquen. + +## 3. Gestión de pedidos +### 3.1 Listado de Pedidos +Para ver los pedidos existentes se debe acceder a la siguiente ruta desde el dashboard principal: **Clientes > Pedidos Adamo** . +Una vez en esta página se puede visualizar una tabla mostrando los pedidos del cliente tal como se +observa en la figura. + +![Listado de pedidos](./08.png) + +Dicha tabla incluye una fila por cada pedido de cliente y se compone de las las siguientes columnas: + +- **ID**: El identificador único del cliente. +- **Cliente**: El nombre del cliente. +- **Pedido**: El identificador único del pedido. +- **Calle**: La dirección del pedido. +- **Estado**: El estado actual del pedido. + +En la parte superior de la vista hay dos campos: +- **Mostrar**: +Permitiendo elegir el número de filas de la tabla de pedidos a mostrar entre las siguientes opciones: 10, 25, 50, 100, 200. + +- **Buscar**: +Permitiendo filtrar las filas previamente mencionadas (ID, Cliente, Pedido, Calle, Estado) de la tabla por un valor cualquiera que incluyan. +En la parte inferior de la página también se puede elegir la siguiente vista de registro según la configuración del campo mostrar mencionado anteriormente. + +### 3.2 Alta de pedidos +Para realizar un pedido de alta de usuario, primero se debe elegir el cliente desde la ruta **Clientes->Lista** y pulsando en el el campo “Nombre” del cliente, tal como muestra la figura a continuación. + +![Listado de clientes con pedidos activos](./09.png) + +Una vez abierta la vista del cliente elegido, se debe navegar hasta la pestaña “Adamo” y pulsar en el campo **“Alta de Usuario De Usuario En Adamo”** en la parte superior de esta pestaña. Tal como muestra: + +![Proceso de alta](./10.png) + +Una vez pulsado el campo se accede al formulario de alta de usuario en el que se cumplimentan los siguientes campos: + +- **Nombre**: Nombre del Usuario objeto del pedido de Alta. +- **Teléfono**: Teléfono del Usuario objeto del pedido de Alta. +- **Calle**: Dirección del Usuario objeto del pedido de Alta. +- **ID Calamares**: Identificador de la UUI en el sistema de Adamo +- **Servicio**: Servicio objeto del pedido de Alta. +Dicho servicio debe elegirse entre el listado de servicios disponibles mostrado. + +Tal como muestra la Figura a continuación + +![Campos de alta](./11.png) + +![Campos de alta 2](./32.png) + +Una vez solicitado el alta se puede comprobar el estado de su tramitación de alta en la tabla mostrando el resumen de pedidos realizados. +Tal como muestra la Figura a continuación + +![Alta de pedido](./12.png) + +Pudiendo ser dichos estados: +- **Ordered**: Pedido solicitado a falta de verificación por parte de Adamo de por serviciar en esa UUI. +- **Verified**: Pedido verificado con Adamo que se puede serviciar. +- **Planned**: Se ha cerrado una cita con el cliente para la instalación. +- **Issue**: Pedido con una incidencia de falta de recursos. +- **Canceled**: Pedido cancelado, si no se llega a completar. +- **Disconnect**: Pedido de baja de cliente, una vez el pedido ha estado en Completed. +Completed: Pedido completado. + +### 3.3 Modificación de pedidos +Solamente se pueden realizar pedidos de modificación para los pedidos que se encuentren en el estado **Completed**. +Para modificar un pedido dependiendo de su estado se debe pulsar el icono ![Cambiar servicio](./17.png) en la columna Acciones del listado de pedidos del cliente seleccionado mostrado a continuación. + +![Alta de pedido](./13.png) + +Una vez pulsado dicho icono se muestra un desplegable reflejando los tipos de servicio objetivo hacia los que se puede solicitar la modificación. +Tal como muestra a continuación. + +![Servicio](./18.png) + +Una vez realizado el pedido de modificación se muestra el pedido actualizado en el listado de pedidos del cliente. + + +### 3.4 Cancelación/Baja de pedidos +La solicitud de baja de los pedidos que no han llegado a estar en Completed se denomina Canceled, y de los que sí han estado en Completed es Disconnected. Un pedido está en Completed una vez ha provisionado una ONT en esa orden. Para modificar un pedido dependiendo de su estado se debe pulsar el icono ![Cancel/Disconnect button](./16.png) en la columna Acciones del listado de pedidos del cliente seleccionado mostrado en la figura a continuación. + +![Baja de un pedido](./14.png) + +Una vez pulsado dicho icono se muestra un desplegable reflejando los campos de servicio objeto del pedido de Baja. Para proseguir con el pedido de baja se debe pulsar el botón **“Confirmar Cancelación/Baja”**. + +![Confirmación de baja](./15.png) + +Una vez realizado el pedido de baja se muestra un nuevo pedido en el listado de pedidos del cliente. + +### 3.5 Provisión de pedidos +Para provisionar un pedido existe un botón como el que se muestra en la siguiente figura. + +![Provision](./19.png) + +Al hacer click sobre el icon de provisión, saldrá un modal con un formulario con los datos necesarios para realizar la acción. + +![Datos de Provision](./20.png) + +### 3.6 Obtención de FSAN +Para obtener el FSAN asociado a un pedido, hay que hacer click en el icono que se muestra a continuación: + +![Obtencion de FSAN](./21.png) + +El proceso obtendrá el FSAN desde Adamo y lo guardará en la instancia. El FSAN se podrá consultar en la pestaña de datos de usuario, en el campo adicional denominado Numero de Serie. + + +### 3.7 Cambio de FSAN +Para cambiar el FSAN asociado a un pedido, hay que hacer click en el icono que se muestra a continuación: + +![Cambio de FSAN](./22.png) + +Se mostrará un formulario con un campo para el nuevo numero de serie. + +![Modal de Cambio de FSAN](./23.png) + +### 3.8 Envio de incidencias +Para el envío de incidencias sobre un pedido, es necesario realizar dos acciones. +La primera consiste en poner el estado en estado issue. Para ello, hay que hacer click en el icono que se muestra a continuación: + +![Incidencia](./24.png) + +Se mostrará un formulario en el que es necesario marcar el tipo de incidencia. + +![Modal de Incidencia](./25.png) + +Una vez se envía, el estado estará cambiado a issue. + +![Pedido Issue](./26.png) + +Es momento de pasar al segundo paso: + +![Portal Jira de Adamo](./27.png) + +Se abrirá en el navegador el portal de gestión en el que habrá que continuar el proceso. + +### 3.9 Citar un pedido +Para establecer una fecha de instalación del cliente, hay que hacer click en el siguiente icono + +![Cita](./28.png) + +Se abrirá un modal en el que se podrá escoger una fecha + +![Modal de Cita](./29.png) + +### 3.10 Check ONT +Para hacer un check ONT (check del estado de la ONT asociada a ul pedido), hay que hacer click en el siguiente icono: + +![Check ONT](./30.png) + +### 3.11 Refrescar pedidos +Los pedidos son actualizados automáticamente cada 15 minutos, pero existe la posibilidad de actualizarlos al instante de forma manual. Para ello hay que hacer click en el icono que se muestra a continuación: + +![Reload de pedido](./31.png) +