Plugins – UCRM

Este articulo describe como habilitar los complementos de UCRM para que éste sea funcional. 

Notas y requisitos: Los complementos de UCRM son compatibles con UCRM v2.10.0 y superior. 

Los plugins son programas de código abierto que amplían la funcionalidad de UCRM. Entre estos plugins podemos mencionar los siguientes: 

Importaciones automáticas de datos bancarios. 

Integración con software de contabilidad externo. 

Integración mejorada con hardware y herramientas de terceros. 

Modificación de datos personalizadas y acciones masivas. 

Varias exportaciones e importaciones. 

Todas las funciones que se pueden realizar con UCRM API.  

Webhook de UCRM puede activar el complemento automáticamente en función de varias acciones (por ejemplo, cuando se suspende un cliente de último pago). 

Como habilitar el plugins. 

1. Encuentre el plugin que necesita y descarga su archivo en ZIP. 

2. Cargue el archivo ZIP en UCRM (Sistema →Plugins). En esta parte se checará si es válido el plugin, se extraerá una carpeta con el nombre del plugin. 

3. Habilitar el plugin y configurarlo. 

4. Esperar a que UCRM ejecute el plugin repetidamente o haga clic en ejecutar bajo demanda. 

Requisitos para la creación y modificación de plugins UCRM.  

Estos complementos están bajo la licencia de MIT permitiendo que cualquier persona pueda contribuir con cualquier actualización a los plugins existentes o con la creación de nuevos. Estos plugins usan un lenguaje de programación PHP y se ejecutan automáticamente en función de un período definido por el usuario. 

Nota: Serán necesarios conocimientos básicos de programación para crear o modificar un plugin en UCRM.  

Estructura del archivo.

El plugin mínimo válido consta de 2 archivos, manifest.json y main.php. Estos archivos son necesarios para una instalación exitosa de UCRM. Además de los archivos necesarios, los archivos pueden contener todo lo que necesite el plugin.  

manifest.json. Este archivo contiene toda la información necesaria sobre el plugin, como el nombre, autor y la configuración requerida.  

main.php. Este es el archivo principal del plugin, éste se ejecutará cuando UCRM ejecute el plugin.  

public.php. Si este archivo esta presente, se genera una URL pública para el plugin que apuntará a este archivo. Cuando se accede a la URL, el archivo se analizará como script PHP y se ejecutará. Este archivo es opcional.  

Archivos reservados.

Estos archivos no pueden estar contenidos en el archivos de plugin ya que UCRM los maneha y los anulará.  

ucrm.json  

Este es un archivo generado automáticamente,  creado después de que el plugin este instalado en UCRM.  Contiene una configuración preparada que el plugin puede usar de inmediato. La configuración se actualiza automáticamente, cuando los cambios se realizan en la configuración de UCRM.  

Las siguientes opciones están disponibles:  

ucrmPublicUrl – URL bajo la cual es UCRM públicamente accesible, esto será “null” o si las opciones de “server domain name” o “server IP” no están configuradas en UCRM.  

pluginPublicUrl – URL bajo la cual public.php es públicamentre accesible, esto será “null” si el complemento no tiene el archivo public.php o si las opciones de  “server domain name” o “server IP” no están configuradas en UCRM.  

pluginAppKey – Es una clave de aplicación generada automáticamente para el plugin, que se pueden usar para acceder a la API de UCRM.  

Ejemplo del archivo ucrm.json:  

{  

“ucrmPublicUrl”: “http://ucrm.example.com/”,  

“pluginPublicUrl”: “http://ucrm.example.com/_plugin/dummy-plugin”,  

“pluginAppKey”: “5YbpCSto7ffl/P/veJ/GK3U7K7zH6ZoHil7j5dorerSN8o+rlJJq6X/uFGZQF2WL”  

“data” directory  

Este directorio esta protegido en contra de actualizaciones de plugin. Este directorio no se tocará, todos los demás archivos se eliminarán y aparecerán nuevos archivos de plugin. 

data/config.json 

La configuración del plugin se guardará en este archivo. Cuando se guarde el formulario de configuración del complemento UCRM, este archivo se regenerará. 

data/plugin.log 

Cualquier cosa que contenga este archivo se mostrará como texto en la página de detalles del plugin del complemento en UCRM. 

.ucrm-plugin-running 

Este archivo se usa para evitar la ejecución de múltiples plugins si la instancia anterior aún está ejecutando.

Nota: Tenga en cuenta que independientemente del período de ejecución elegido por el usuario, el complemento nunca se ejecuta si la instancia anterior no finalizó. Si el script no finaliza en una hora, se eliminará automáticamente. 

.ucrm-plugin-execution.requested 

Este archivo se usa para planificar la ejecución del plugin desde la interfaz UCRM, independientemente del período de ejecución elegido.