MANUAL DE INSTALACIÓNPROMO
PROMO - Manual de Instalación 7.0
...
Painel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Âncora | ||||
---|---|---|---|---|
|
...
A continuación se detallan los requisitos mínimos para la instalación de la Consola de Administración de PROMO que operara con una (1) compañía.
Los requerimientos mínimos de hardware se proveen como una guía para el sizing de un ambiente no productivo. Para instalaciones en ambientes productivos con requerimientos específicos de performance y volumen de datos se requiere un sizing particular para estimar la configuración apropiada.
Considerar que la siguiente configuración sería la necesaria para utilizar un mapa no mayor a 1 MB y sin utilizar funciones de loyalty, de lo contrario debe analizar cuánta memoria debe utilizar.
Descripción | Requisito mínimo (10 Tiendas) |
Servidor de Aplicaciones | Wildfly |
12 | |
Memoria RAM libre | 16 GB |
JVM (Java Virtual Machine) | jdk-8u25-windows-x64 o superior |
Procesador | 8 x 2.5 GHz |
Capacidad del disco rígido (libres) | 200 GB |
Sistema Operativo | Windows Server 2008 R2, Windows 7 64-bit |
Servidor de base de datos | MongoDB |
4. |
2 |
Aviso | ||
---|---|---|
| ||
Los requisitos dependen del uso de funciones y carga esperada. Entonces se requiere una estimación y estudio de cada caso para realizar un ajuste en los recursos requeridos. |
Informações | ||
---|---|---|
| ||
El uso de máquinas virtuales agrega un overhead que puede afectar la performance o escalabilidad. |
...
Aviso | ||
---|---|---|
| ||
Adicionalmente se deberá agregar el JDK a la variable de entorno %PATH%. (ver8 Apendice B: Variables de Entorno) |
Documentación relacionada
PROMO - Manual de Integración 7.0 - Motor
PROMO - Manual de Integración 7.0 - Servicios
PROMO 7.0 - Manual de Integración - Colas de Mensajes
PROMO - Manual de Usuario Principal 7.0
Ejecución del Instalador (Windows)
...
- Wildfly 9.
- PromoSimEngine x.x (motor de simulación)
- MongoDB 34.62
Los servicios de MongoDB, Wildfly y PromoSinEngine quedaran instalados y podrá optarse al momento de la instalación si se ejecutan al terminar el proceso de instalación o bien si se iniciaran a mano, en caso de ser necesario realizar configuraciones previas el inicio de los servicios.
Respecto del servicio Wildfly, inicialmente vendrá configurado por defecto el directorio sugerido, ocupando el puerto 8080
Al finalizar el instalador se crearán todos los servicios y directorios correspondientes.
...
Se presentara la siguiente pantalla donde se deberá presionar "Next":
Luego se solicitará la aceptación de los términos y condiciones de uso de la aplicación.
Luego de aceptados los términos y condiciones, se solicitará que se identifique el nombre del usuario y el e-mail de quien (empresa o persona) está realizando la instalación.
A continuación se deberá indicar la ruta de acceso a Java (JDK) y el directorio donde se realizara la instalación de Promo. Por default se propone "c:\synthesis\Promo". Tambien se deberá indicar el directorio donde se instalara la base de datos (MongoDb)
Informações | ||
---|---|---|
| ||
En caso de que PROMO trabaje integrado con BRIDGE, deberá tildarse la opcion "Install Bridge Integration" para una correcta configuracion de la aplicación. |
...
Si no activó el check para instalar el motor como aplicación Tomee, se solicitará indicar el directorio donde se instalará Wildfly, para que el motor se instale como servicio.
En caso de no existir el directorio, se solicitara autorización para la creación del mismo.
...
Se solicitara se informe si se desea instalar o solo activar los servicios que se instalan con PROMO.
Ya sea que haya instalado el motor como aplicación o como servicio continuará con los siguientes pasos:
En la siguiente pantalla que se presente, habrá que presionar el botón "Instalar" a fin de dar comienzo al proceso de instalación de PROMO y sus componentes.
Finalizada la instalación se mostrara la siguiente ventana donde se informara la correcta instalación de la consola de PROMO y se solicitara dar Clic en "OK" para terminar con el proceso.
Âncora | ||||
---|---|---|---|---|
|
...
- synthesis\promo\images: directorio de las imágenes
- \synthesis\promo\images\profile
- \synthesis\promo\images\barcode: contiene las imágenes de códigos de barras asociados a cupones emitidos.
- \synthesis\promo\images\promotion: contiene las imágenes que se asocien a las promociones
- \synthesis\promo\logs: información sobre las trazas de ejecución de la aplicación, incluyendo información técnica ante cualquier falla.
- \synthesis\promo\backup: backups de la base de datos MongoDB
- \synthesis\promo\import: directorio donde deberán alojarse los mapas para la importación de promociones.
- \synthesis\promo\mdb: aquí se encuentran las funciones utilizadas en la base de datos.
- \synthesis\promo\engine: el motor de promociones que utiliza la consola para la simulación de las mismas.
- \synthesis\promo\catalogs: directorio donde se alojaran los archivos de catálogo (.catalogs) que se importaran al iniciar la aplicación. Deberán generarse de manera manual las carpetas correspondientes a cada compañía, indicando en el nombre del directorio el ID de la compañía. (Ej.: \synthesis\promo\catalogs\22 donde 22 corresponde al ID de la nueva Ccia)
- \synthesis\promo\export: (a partir de Promo v7.1 en adelante) en este directorio se van a bajar los archivos que se exportan con el botón "Exportación Masiva" que se encuentra en los informes. Este directorio se crea automáticamente al realizar la instalación de Promo. Pero debe tenerse en cuenta que si se hace una actualización en lugar de una instalación desde cero, debe crear a mano este directorio.
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Es requisito que antes de realizar la instalación de la consola estén instaladas los siguientes componentes:
- MongoDB 34.62
- JDK 1.8.0_25
Junto con la consola de PROMO, durante el proceso se instalarán el motor de simulación y Wildfly.
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
...
4.
...
2
Se pueden seguir los pasos en la documentación de instalación online de Mongo.
Linux: https://docs.mongodb.com/v3v4.42/tutorial/install-mongodb-on-red-hat/
...
Terminada la descompresión, se solicitara autorización para proceder con la instalación de la aplicación, dar clic en "Next"
En la siguiente pantalla se deberán aceptar los términos y condiciones de uso, una vez leídos los mismos, de estar de acuerdo, dar clic en "Accept" para continuar.
Se deberá proveer de un nombre (persona física u organización) y un mail para poder registrar la aplicación y proseguir con la instalación, así como también se solicita re confirmar la aceptación de los términos y condiciones.
Completados los campos, presionar "Next":
A continuación se deberá indicar la ruta de acceso a Java (JDK) y el directorio donde se realizara la instalación de Promo. Por default se propone "/usr/local/promo/". También se deberá indicar el directorio donde se instalara la base de datos (MongoDb)
Informações | ||
---|---|---|
| ||
En caso de que PROMO trabaje integrado con BRIDGE, deberá tildarse la opción "Instalar Integración con Bridge" para una correcta configuracion de la aplicación. |
De no existir los directorios se solicitara autorización para la creación de los directorios necesarios para la instalación de PROMO.
Presionar "Si"
En la siguiente ventana se solicitara indicar el directorio donde se instalara Wildfly.
En caso de no existir el directorio, se solicitara autorización para la creación del mismo. Dar clic en "Si"
...
Para iniciar la instalación, en la siguiente pantalla habrá que presionar el botón "Installar" a fin de dar comienzo al proceso de instalación de PROMO y sus componentes.
Durante la instalación se presentara una ventana de progreso donde se podrá visualizar los componentes que se están instalando y su progreso.
Finalizado el proceso se presentara un pop-Up de proceso terminado, donde se deberá presionar "Aceptar" y luego "Salir" para terminar el proceso.
Una vez instalada la consola, sera será requerido iniciar Wildfly, lo cual podrá hacerse manualmente ejecutando "sudo ./standalone.sh", o bien podrá configurarse Wildfly como servicio en linux siguiendo los pasos indicados en la Web para tal fin.
...
Para Instalar la consola integrada con Bridge, durante el proceso de instalación, ya sea sobre Windows o sobre Linux, deberá tildarse en la ventana de Opciones de Instalación, la opción "Instalar Integración con Bridge"
Con lo cual, al presionar "Siguiente", en el siguiente popUp se mostrara como ruta para Wildfly, el directorio donde este instalado la App Server de Bridge.
También deberá tenerse en cuenta que el archivo de configuracion configuración para las conexiones con la base de Bridge, entre otras configuraciones, propias de PROMO sera será "promoconfig.properties".
En este archivo, aparte de encontrar las opciones de configuracion configuración de base de promo (mongoDB) y la estructura de directorio por defecto, también encontraran los valores de configuracion configuración para la integración con Bridge, ya sea se utilice una base SQL o una base Oracle.
Ejemplo:
De usarse un esquema de base de datos u otro habrá que descomenar y configurar la opción correspondiente.
...
Como se mencionó en el punto anterior, el motor de promociones es el componente de PROMO encargado de recibir tickets directamente desde el punto de venta, luego procesarlos, y, finalmente, informar las promociones que participaron y los artículos afectados.
La instalación del motor de promociones se realiza conjuntamente con la instalación de la consola de Promo, al ejecutarse el instalador de la aplicación. La comunicación se establece a través de mensajes XML enviados mediante TCP/IP, REST o Pipes (IBM 4690).
Âncora | ||||
---|---|---|---|---|
|
...
Se provee un archivo promo-gengine-installer-X.X.X.jar donde X.X.X es la versión del motor que se está instalando (67.40.0x).
Se deberá ejecutar como administrador, en modo comando el instalador del Motor de PROMO ( java –jar promo-gengine-installer-X7.X0.Xx.jar)
Al ejecutarse el instalador aparecerá la siguiente ventana:
Presionar "Siguiente" para continuar.
Se deberán aceptar los términos y condiciones para continuar con la instalación del motor de PROMO.
Presionar en "Aceptar" para continuar.
Luego de aceptados los términos y condiciones, se solicitara que se identifique el nombre del usuario y el e-mail de quien (empresa o persona) está realizando la instalación.
Presionar "Siguiente" para continuar.
A continuación se deberá indicar la ruta de acceso a Java (JDK) y el directorio donde se realizara la instalación del motor de PROMO. Por default se propone "c:\synthesisnapse\gengine".
Se podrá indicar aquí, por medio del check "Instalar Servidor REST (Default TCP/IP)", para que se instale el motor como SERVIDOR REST sino se instalara por default en modo TCP/IP.
...
Aviso |
---|
Importante: Verificar de No instalar el motor donde se instalo previamente el motor de simulacion de la consola (el motor de simulación se instala por default en \synthesisnapse\promo\engine) de ocurrir eso no funcionará correctamente. |
Presionar "Siguiente" para continuar.
Si se desea instalar el motor como aplicación, se debe tildar el cheeckbox
Expandir | ||
---|---|---|
| ||
Si se tildo el checkbox, se observará la pantalla siguiente; donde se deberá seleccionar el directorio donde estará alojado el servidor de aplicaciones de TomEE: |
En el siguiente Pop-UP se deberá indicar la URL de acceso a "Director" para futuras actualización y el código de tienda que tomara el motor A continuación se deberá indicar
Presionar
Luego de presionar "Siguiente", debe completar los parámetros solicitados:
Si se presiona "Siguiente" para continuar.
En la siguiente pantalla que se presente, habrá que presionar el botón "Instalar" a fin de dar comienzo al proceso de instalación del motor de PROMO y sus componentes.
Finalizada la instalación se mostrara la siguiente ventana donde se informara la correcta instalación del motor de PROMO. Se solicitara dar Clic en "Aceptar" y luego en "Salir" para terminar con el proceso.
Terminado el proceso de instalación del motor de promociones podrá chequearse en los servicios del sistema la existencia de dos nuevos servicios correspondientes al motor de promociones y al agente Director que ya estarán ejecutándose de manera atomística, hecho que marcara la correcta instalación y puesta en funcionamiento del nuevo motor de PROMO.
...
Los parámetros de configuración de la sección General son:
Tag/Parámetro | Descripción | Valor por defecto |
---|---|---|
simulation | Indica si el motor opera para simulaciones desde la consola o no. Valor por defecto "False" (No simulación) | false |
compatibilityMode | indica si el motor opera en modo compatible con el antiguo motor (Integraciones 4690) agrupando o no los beneficios en la respuestas dadas por el motor. Por default el parámetro viene definido en "False" (No compatble) por lo que en este modo agrupara los beneficios (motor nuevo). En caso de definir el beneficio en "True", no se agruparan los beneficios (compatibilidad con antiguo motor). | false |
mapIdentifiers | identificaran las carpetas por las cuales el motor irá en búsqueda del mapa para evaluar la promoción. Deberán definirse en una lista separada por comas. | companyId |
ticketIdentifiers | indicara por qué atributo se identificara al ticket cuando el motor opere como multiempresa. | store, terminal |
disableLoyalty | El valor por default de este parámetro será "false" indicando que el motor mantiene una comunicación con PROMO central para la gestión de elementos de Fidelidad. En caso de configurar en "true" este parámetro, se deshabilitara la comunicación con PROMO central, por lo que un status de Finish, commit, rollback, etc etc se evaluara como un status "sales" (método de evaluación previo a Fidelidad). | false |
disablePrices | El valor por default de este parámetro será "false" indicando que el motor utiliza preciadores, esto habilitara la funcionalidad de precios (desde la consola se generan listas de precios y |
serán distribuidos al motor) y se disponibilizara el status de prices y en caso de utlizar en los tickets |
ítems con unitPrice=0 los buscara los precios de los preciadores (listas de precios). En caso de configurar en "true" este parámetro indica que NO esta habilitada esta funcionalidad. | false | |
engineId | identificador único del motor. Deberá configurarse cuando se desee que el motor reporte su mapa activo a la consola de PROMO. | 0 |
engineName | Nombre único del motor.Junto con el "EnginerId" deberá configurarse cuando se desee que el motor reporte su mapa activo a la consola de PROMO. | |
promotionCacheMode | (desde v7.EP2) Activa el modo de trabajo "Cache de Promociones" del motor. Reservado para SOLO este modo de trabajo particular. | false |
useExactLimitValue | Otorgamiento de beneficio con límites: true otorga el saldo(default), false no otorga beneficio si el apply supera el saldo | true |
negativeDiscount | Permite o no que los descuentos otorgados superen el valor del producto | true |
adjustCalculatedCoupon | Limita (cuando esta en true) dentro de un mismo paso que un cupon no de mas del 100% de un producto, (descuentosMonetarios + valor del cupon > xprice) recorta el valor del cupon para que no supere el 100% (a partir de 7.1) | false |
Configuración de la operatoria Prices (contingencia) del Motor:
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
<promoCentral> <url>http://localhost:8080/promo</url> <user>sender</user> <password>mate</password> <!--Define el timeout en segundos de comunicacioncomunicación con la consola central si se especifica este aplica en general y anula a los otros dos.--> <!-- timeout></timeout --> <!--Define el timeout en segundos de conneccion con la consola Central.--> <!-- connectionTimeout></connectionTimeout --> <!--Define el timeout en segundos de comunicacion con la consola Central.--> <!-- communicationTimeout></communicationTimeout --> <!-- Descomentar en el caso que la mensajeria no lo implemente y se requiere el envio de un valor fijo --> <!-- companyId></companyId --> </promoCentral> |
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
<!--Directorio de trabajo del cache de datos interno utilizado por el motor, en caso de no especificarse el motor usa "./data" --> <cachedata> <directory>data</directory> </cachedata> |
Optimización de carga de mapas en motor
...
(a partir de Promo v7.1)
Esta mejora consiste en habilitar la utilización de mapas pre-compilados, significa que el motor, luego de procesar un mapa xml generado por consola, guardará archivos compilados de mapas, promociones e indices en el directorio indicado, para que en caso de reiniciar el motor, cargar los mapas compilados en vez de cargarlos desde el xml, lográndose con esto un mejora de tiempo sustancial en mapas grandes.
...
Para configurar esto se poseen 3 nuevos parametros en el archivo config.xml:
Tag | Descripción |
---|---|
useHttps | true indica que el motor debe trabajar en este modo. |
keyStore | El nombre del archivo que contiene el almacén de claves, especificando su ruta absoluta |
keyStorePassword | La contraseña del almacén de claves en texto plano. |
Un ejemplo de configuración sería:
...
En este ejemplo vamos a generar un almacén de claves de nombre keystore para un alias de nombre Jettycon validez del certificado de 365 días y los algoritmos detallados. Pedirá información que llevará el certificado, al final darle si para terminar. La clave que pide al inicio es una nueva clave y debe tenerse en cuenta ya que se configurará la misma en el motor. Según la página esto funciona sólo para pruebas porque el certificado no es de confianza para el cliente (navegador por ej.).
keytool -keystore keystore.dat -alias jetty -genkey -keyalg RSA -sigalg SHA256withRSA -validity 365
Se puede revisar el almacén de claves con;
keytool -list -keystore keystore.dat -storetype jks -storepass THEPASSWORD -v
Se genera el archivo csr (solicitud de firma del certificado / certificate signing request - CSR).
keytool -certreq -alias jetty -keystore keystore -file jetty.csr
- En el config.xml del motor ingresar los siguientes valores:
<useHttps>true</useHttps>
<keyStore>C:\keystore.dat</keyStore>
<keyStorePassword>THEPASSWORD</keyStorePassword>
...
Autenticación por usuarios y roles
Informações | ||
---|---|---|
| ||
|
...
Para configurar esto se poseen nuevos parametros en el archivo config.xml:
Tag | Descripción |
---|---|
useRoleAccessRestrictions | true indica que el motor debe trabajar en este modo. |
usersDefinition | El nombre del archivo que contiene el almacén de usuarios y claves, especificando su ruta absoluta |
configurationDirectory | La ruta completa donde se encuentra el archivo web.xml de configuración de seguridad. Si el archivo no existe se tomarán los valores por defecto con un unico usuario y rol. |
Un ejemplo de configuración sería:
...
- [promo.MIDDLEWARE.MESSAGING]- WARNING: INVALID TICKET: cvc-datatype-valid.1.2.1: 's250.0' is not a valid value for 'double'.
Indica que se ha recibido una petición o ticket que posee un valor o tipo de dato inválido. En este caso, el motor dará un mensaje de respuesta con un código de error (ver "Manual de mensajería – Promo").
...
- .
...
Âncora | ||||
---|---|---|---|---|
|
...
Configuraciones disponibles para el Usuario Principal:
Módulo | Clave | Valor | Descripción |
---|
Promo | operative.system | windows | Sistema operativo |
Promo | soap.url | http://10.4.13.108:8280/bridge/services/bridgeCoreSOAP?wsdl | Dirección de web service de bridge. |
Negocio | lang | es_AR (Argentina) | General: idioma de la aplicación (etiquetas) |
Negocio | backupDirectory | C:/synthesis/promo/backup | General: de backup |
Negocio | mongoDBDirectory | C:/synthesis/promo/mdb/bin | General: directorio base de datos |
Negocio | mongoDBHostname | localhost | Host de la base de datos |
. En caso de poseer una configuracion en replicaset el formtao de configuracion es: "replicaName/node1:port1,node2:port2" Se destaca que deberá de definirse el campo mongoDBPort vacío cuando se utilice la función de Backup en Clusters | |||
Negocio | mongoDBPort | 27017 | Puerto de la base de datos. En caso de replicaset este parametro es ignorado. |
General | auditDateCleaner | 30 | Existe un proceso que elimina registros de las tablas de auditoría. Se puede configurar el valor que desee pero tener en cuenta que esos registros ocupan lugar en el disco. |
General | importReceiptDateCleaner | 30 | Eliminar registros de las tablas de importación. |
General | ticketGeneratorSeconds | 2 | DEMO: cantidad de segundos de generación de ticket para demos |
Negocio | charsMaximumAlphabetical | 20 | Cantidad máxima de caracteres alfabéticos |
Negocio | charsMaximumNumerical | 20 | Cantidad máxima de caracteres numéricos |
Negocio | charsMaximumQuantity | 20 | Cantidad máxima de caracteres totales |
Negocio | charsMaximumSpecial | 20 | Cantidad máxima de caracteres especiales |
Negocio | charsMinimumQuantity | 7 | Cantidad mínima de caracteres totales |
1Negocio | charsMinimumUser | 3 | Cantidad |
mínima de caracteres en el nombre de usuario |
Negocio | maximumLoginFailedCount | 3 | Cantidad máxima de reintentos de login fallidos sucesivos |
Negocio | numberQuantity | 1 | Cantidad mínima de caracteres numéricos |
Negocio | passwordExpirationDays | 30 | Días de expiración de la contraseña del usuario |
Negocio | specialCharsQuantity | 0 | Cantidad mínima de caracteres especiales |
Negocio | stringQuantity | 1 | Cantidad mínima de caracteres alfabéticos |
Negocio | userBlockDays | 90 | Bloqueo de usuario - días de inactividad |
Negocio | userLockTime | 30 | Periodo de bloqueo de la cuenta de usuario (en minutos) |
Promo | engineSalesPath | C:/synthesis/promo/engine/sales/ | Directorio de Mapas del Motor |
Configuraciones disponibles para el Usuario Admin. de cada compañía:
...
Desinstalación
...
1- Bajar servicios
- PromoSImEngine
- Wildfly
- MongoDB
- PromoEngine (si se instaló el motor)
- PromoEngineDirector (si se instaló el motor)
2- Borrar directorio C:\Synthesis (ruta donde se instaló la consola)
3- Desinstalar MongoDB
4- Borrar los servicios de PromoSinEngine, Wilfly y MongoDB, y PromoEngine, PromoEngineDirector si se instaló el motor
Reverso de actualizaciones ante problemas en el proceso
Ante algun problema durante la actualizacion de una version de consola o motor, debera de bajarse los servicios involucrados y colocar el archivo .war o .jar anterior, segun se trate de una actualizacion de consola o motor respectivamente y volver a subir los servicios.
...
Modulo | Clave | Valor | Descripción |
---|
Cupones | barcodePath | C:/ |
napse/ |
promo70/images/barcode/ | Directorio |
imágenes de |
códigos de barra |
Cupones | barcodeUrl | http://localhost:8080/promo/assets/barcode/ | Url |
imágenes de |
códigos de barra |
Cupones | rabbitMQ.couponHistory.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos de tipo CouponHistory | |
Cupones | CODE128 | PPPSSSTTTnnnnnnnnnnnnnnnnnn | Formato de código de barras CODE128 |
. Más detalle ver en: _Formato_de_Código | |||
Cupones | EAN13 | PPPSSSTTTnnnc | Formato de código de barras EAN13 |
. Más detalle ver en: _Formato_de_Código | |||
Cupones | UPCA | PPPSSSTTTnnc | Formato de código de barras UPCA |
. Más detalle ver en: _Formato_de_Código | |||
Cupones | max.qty | 999 | Cantidad |
máxima de generación Masiva de Cupones por transacción |
Cupones | prefix.active | true | Utilizar prefijo |
numérico incremental para tipos de cupón |
Cupones | isEditableCouponTypeDistributed | false | Habilita la edición de tipos de cupones en estado "Distribuidos" |
Cupones | visibleDigits | Cantidad de dígitos visibles del código de cliente que se verán en los cupones | |
Cupones | amountFormat | %.02f | Formato en el que se imprimen los montos de los cupones |
Cupones |
nameInfoPos0 |
...
- actualización de la consola de administración (de existir alguna actualización se entregará la correspondiente documentación y la forma de instalarla),
- depuración de backups de BD.
Informações | ||
---|---|---|
| ||
Tener en cuenta que para realizar el mantenimiento se deberá detener la aplicación, realizar los cambios y luego volver a iniciarla. |
...
La aplicación registra un backup automático diario de la base de datos MongoDB. Es por ello que es necesario realizar un cierto mantenimiento, consistente en la depuración de los mismos periódicamente a fin de que la carpeta de backup no ocupe demasiado en disco.
Alta de cliente durante la transacción
...
Para que el alta de clientes pueda efectuarse al momento de procesarse una transacción, deberá de habilitarse en el archivo de configuraciones de la Consola de Promo (“promoplus.properties”) el siguiente atributo:
...
# Habilita el alta de clientes on the fly
promo.allowNonExistingCustomers = true
Una vez actualizado, deberá de reiniciarse el Wildfly para que los cambios sean tomados correctamente.
Los clientes serán creados utilizando el estado "loyaltyValidation" en el caso de enviarse los datos mínimos y al mismo tiempo Promo detecte que el cliente no existe. Los datos mínimos mencionados son (marcados en Rojo):
<customer-add seq="1"
id="10090504"
identifier="10090504"
type="test"
name="pepe"
lastName="rodrigues"
identifierType="cpf"
email="mimail@
test.com"
/>
Bloco de código | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<message companyId="napse" store="1" terminal="1" date-time="2020-11-03 11:11:22" init-tck="true" messageId="1" void-trx="false" response="true" status="loyaltyValidation" evaluate="true" map-version="2" tckpath="Y" suggest="true">
<customer-add seq="1" id="47001517" identifier="47001517" type="test" name="bruno" lastName="Lopez" identifierType="cpf" email="[email protected]" />
</message> |
Nota: Para mas informacion ver "Manual de Integracion 7.0 - Motor" - LoyaltyValidation.
Enmascarar Contraseña de DB
La clave enmascarada de base de datos se genera mediante la promo-crypto-tool que sera provista.
El programa toma como ingreso a la clave a encriptar y devuelve la clave encriptada que se debe situar en el archivo promoplus.properties en una entrada llamada grails.mongodb.encryptedPassword (por ej. grails.mongodb.encriptedPassword=lYYBAfxLR40=).
En caso de utilizar grails.mongodb.encryptedPassword se debe considerar comentar o eliminar la anterior grails.mongodb.password ya que en caso de existir ambas siempre utilizará grails.mongodb.password. En caso de que el archivo promoplus.properties no exista, se tomará, como valor por defecto, a v9vbhV.
Para encriptar una clave se debe utilizar promo-crypto-tool de la siguiente forma en una consola:
Bloco de código | ||||
---|---|---|---|---|
| ||||
java -jar <nombre del jar> <contraseña a encriptar>, por ej java -jar promo-crypto-tool-1.0.0.jar abcdefg |
o bien
Bloco de código | ||||
---|---|---|---|---|
| ||||
java -jar <nombre del jar> y al ejecutarlo, de modo interactivo, solicitará el ingreso de la contraseña. |
En ambos casos la contraseña encriptada se obtendrá por pantalla.
Al momento de levantar el servidor, se hará uso de Datasource.groovy que mantiene el llamado a assignMongodbPassword() el cual a su vez llama al desencriptador para obtener la contraseña para asignársela a grails.mongodb.password.
Informações | ||
---|---|---|
| ||
Se debe considerar la limitación del algoritmo tripledes, el cual acepta sólo caracteres us-ascii como entrada del encriptador. Utilizar caracteres diferentes genera contraseñas encriptadas inválidas. |
Informações | ||
---|---|---|
| ||
Se asume que si existe, en el archivo promoplus/promoconfig.properties, una contraseña no encriptada (grails.mongodb.password) no debe existir la entrada de contraseña encriptada (grails.mongodb.encryptedPassword) y viceversa. La entrada no deseada se puede eliminar o comentar. |
...
Para trabajar con redes sociales PROMO posee una serie de opciones de configuración que se describen a continuación. También es importante aclarar que los servicios de redes sociales están en constante evolución y cambio por lo cual aquí se hace referencia al sitio del servicio en cuestión para obtener la información actualizada al respecto.
...
Desde la consola de cada compañía, accediendo con el usuario administrador, y accediendo a Administración Información de configuración se encontraran las siguientes configuraciones que serán necesarias completar para la correcta publicación en la red social.
Los datos presentes en esta imagen son solo de carácter ilustrativo y deberán ser reemplazados por las credenciales adquiridas con los usuarios de desarrollo de cada aplicación.
- Generación de Aplicación en Facebook
Para poder utilizar la publicación en Facebook se deberá ingresar a https://developers.facebook.com/, darse de alta como desarrollador de Aplicaciones Facebook y agregar una nueva aplicación siguiendo los pasos indicados en la página.
Esto aplica a la versión de App Facebbok 2.9, pero es importante notar que al crear una aplicación para Facebook, se comienza en estado de desarrollo y para poder realizar publicaciones hay que dar los permisos de Administrador al usuario de FB que realizara las publicaciones. Por otra parte, si se quiere compartir o que otro usuario pueda realizar publicaciones, es necesario ser amigos entre los usuarios y darle permisos de administrador. Al acceder a la URL indicada más arriba, se accederá a la sección de "Facebook for Developers" de Facebook.
...
Identificador de la aplicación >> grails.plugin.facebooksdk.app.id
Clave secreta de la aplicación >> grails.plugin.facebooksdk.app.secret
Sera necesario tener una pagina de Facebook dada de alta y asociada a la cuenta de usuario de facebook para poder realizar las publicaciones en esta pagina.
Desde el perfil de usuario con el que se haya generado la app de Facebbok, se deberá dar clic en el menú desplegable de la cual se tendrá acceso a las configuraciones y paginas.
En este menú dar clic en "Crear pagina", y generarla en base al perfil del negocio siguiendo los pasos indicados por facebok
Una vez generada la pagina y configurados los datos en el archivo de configuracion aportados por la aplicación generada, se podrá reiniciar la consola y proceder a la publicación de las promociones en la red social.
Informações | ||
---|---|---|
| ||
Se deberá ser administrador tanto de la pagina como de la aplicación generada en Facebook para poder realizar las publicaciones desde PROMO. |
...
Desde la consola de cada compañía, accediendo con el usuario administrador, y accediendo a Administración Información de configuración se encontraran las siguientes configuraciones que serán necesarias completar para la correcta publicación en la red social.
Los datos presentes en esta imagen son solo de carácter ilustrativo y deberán ser reemplazados por las credenciales adquiridas con los usuarios de desarrollo de cada aplicación.
...
Deberá accederse a la URL https://developer.twitter.com/ y presentara la siguiente pantalla:
Deberá darse clic en el botón correspondiente al usuario logueado en Twitter, se desplegara un menú y se dará clic en "Apps"
Se presentara la siguiente pantalla y debera darse clic en "Create an app"
...
Para obtener los Ids y Tokens deberá darse clic en la solapa "Keys and Tokens" donde se visualizaran los datos necesarios para configurar correctamente los permisos de acceso desde Promo.
Aviso | ||
---|---|---|
| ||
No podrán subirse a las redes sociales imágenes con tamaños motor a 1 MB. |
Integración con Syslog/QRADAR
La implementación del envío de eventos a QRadar se apoya en el sistema de logueo log4j utilizado por Promo, agregando un appender específico para syslog "SysLogAppender" disponible en el paquete log4j, y el desarrollo de un clase que presta servicio a tal fin denominada "SysLogService" la cual formatea los mensages en otra clase "SysLogMessageFactory".
Para habilitar el envío a QRadar, se debe editar el archivo de configuracion de logueo "log4j.xml" insertando las siguientes entradas antes del final:
Bloco de código | ||||
---|---|---|---|---|
| ||||
<appender name="syslogappender" class="org.apache.log4j.net.SyslogAppender">
<param name="syslogHost" value="myserver:myport"/>
<param name="facilityPrinting" value="false"/>
<param name="facility" value="AUTHPRIV"/>
<param name="header" value="false"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy-MM-dd'T'HH:mm:ss.SXXX} %m%n"/>
</layout>
</appender>
<logger name="sts.console.audit.SysLogService" additivity="false">
<level value="info"/>
<appender-ref ref="syslogappender"/>
</logger>
</log4j:configuration> |
Cambiar en el parámetro "syslogHost" , el valor "myserver:myport", por el correspondiente a la dirección ip y port del syslog server QRadar. Ejemplo: localhost:514
Luego re-deployar la consola de Promo para que tome la configuración.
Tipos de eventos :
Los eventos que serán enviados a QRadar en una primera instancia son los correspondientes a usuario: login, logout, login failed, nuevo usuario, modificación de usuario.
...
Indistinto | Descripción de las opciones para el POS | ||
Cupones | nameInfoPos1 | Campo 1 | Descripción de las opciones para el POS |
Cupones | nameInfoPos2 | Campo 2 | Descripción de las opciones para el POS |
Cupones | externalAmountAttributeCodeOfitemAdd | calCouponVal | Atributo que se utilizará en la etiqueta item-add para indicar el monto externo del cupón |
Cupones | default.from | [email protected] | Email por defecto con el que se enviaran los correos |
Cupones | default.insertImages | false | Indica si acepta o no barcodes |
Cupones | default.subject | Promo Test Mail | Asunto por default |
Cupones | host | smtp.gmail.com | Host del proveedor de email |
Cupones | password | ************** | Contraseña de la cuenta de email |
Cupones | port | Puerto de conexión | |
Cupones | smtp.auth | true | Habilitar Auth SMTP |
Cupones | smtp.port | 587 | Puerto SMTP |
Cupones | smtp.socketFactory.class | javax.net.ssl.SSLSocketFactory | nombre de la clase SSLSocketFactory |
Cupones | smtp.socketFactory.fallback | false | Fallback de socketFactory |
Cupones | smtp.socketFactory.port | 465 | Puerto SMTP de socketFactory |
Cupones | smtp.starttls.enable | true | Habilitar Start TLS |
Cupones | smtp.ssl.trust | * | Nombre de host de certif de confianza (* todos) |
Cupones | username | [email protected] | Usuario o nombre de la cuenta de email |
Lista de precios | priceList.distribution.force.offline | false | Habilita la acción descargar contingencia en todo momento |
Lista de precios | priceList.job.cleanPriceListSchedule.time | 90 | Cantidad de días a mantener los ítems en la lista de precios pendientes de impresión |
Lista de precios | priceList.lockForUpate | 15 | Minutos para poder desbloquear Lista cero en el proceso rest |
Lista de precios | priceList.mongo.bulk.insertOrUpdate | 200 | Cantidad de registros a insertar por lote en el proceso rest |
Lista de precios | priceList.distribution.print.before | true | Requiere Impresión previa para poder distribuir Precios. |
Lista de precios | priceList.requiresActivation | false | Parámetro para configurar si requiere activación de listas de precios |
Negocio | moneySymbol | $ | Símbolo de moneda |
Negocio | charsMaximumAlphabetical | 20 | Cantidad máxima de caracteres alfabéticos |
Negocio | charsMaximumNumerical | 20 | Cantidad máxima de caracteres numéricos |
Negocio | charsMaximumQuantity | 20 | Cantidad máxima de caracteres totales |
Negocio | charsMaximumSpecial | 20 | Cantidad máxima de caracteres especiales |
Negocio | charsMinimumQuantity | 7 | Cantidad mínima de caracteres totales |
Negocio | charsMinimumUser | 3 | Cantidad mínima de caracteres en el nombre de usuario |
Negocio | maximumLoginFailedCount | 3 | Cantidad máxima de reintentos de login fallidos sucesivos |
Negocio | numberQuantity | 1 | Cantidad mínima de caracteres numéricos |
Negocio | passwordExpirationDays | 30 | Días de expiración de la contraseña del usuario |
Negocio | publishedDays | 7 | Cantidad de días de antigüedad de precios publicados de competidores |
Negocio | specialCharsQuantity | 0 | Cantidad mínima de caracteres especiales |
Negocio | stringQuantity | 1 | Cantidad mínima de caracteres alfabéticos |
Negocio | userBlockDays | 90 | Bloqueo de usuario - días de inactividad |
Negocio | userLockTime | 30 | Periodo de bloqueo de la cuenta de usuario (en minutos) |
Negocio | competitors.images.path | C:\synthesis\promo\images\custom\competitors\ | Directorio para almacenamiento de imágenes de competidores |
Negocio | competitorsPricesItems.images.path | C:\synthesis\promo\images\custom\competitorsPricesItems\ | Directorio para almacenamiento de imágenes de precios publicados de competidores |
Promo | fileDirectory | C:/napse/promo70/catalogs/2\ | Importación de catálogo: directorio donde estarán los archivos |
Promo | decimalSeparator | . | Separador de decimales, solo para Lista de precios y para PromoLite. Para el resto lo toma de la configuración de la máquina. |
Promo | groupingSeparator | , | Separador de miles, solo para Lista de precios y para PromoLite. Para el resto lo toma de la configuración de la máquina. |
Promo | additionalProvider1FieldName | Sobreescribe el nombre del campo del proveedor adicional 1 del beneficio | |
Promo | additionalProvider2FieldName | Sobreescribe el nombre del campo del proveedor adicional 2 del beneficio. | |
Promo | applicationMethod | resume | Promociones: valor por defecto en el método de aplicación |
Promo | divisionMethod | proportional | Promociones: valor por defecto en el método de división |
Promo | divisionPrice | benefited-price | Promociones: valor por defecto el tipo de precio beneficiado |
Promo | requiredBothSuppliers | true | Promociones: valor por defecto si requiere ambos proveedores del beneficio |
Promo | fileList.txt.Separator | , | Importación de catálogo: separador |
Promo | fileList.xls.ColStart | 0 | Importación de catálogo: columna de comienzo de la importación de catálogo |
Promo | fileList.xls.Direction | vertical | Importación de catálogo: forma de importación |
Promo | fileList.xls.RowStart | 0 | Importación de catálogo: fila de comienzo de la importación de catálogo |
Promo | separator | | | Importación de catálogo: separador de columnas |
Promo | updateSize | 100 | Importación de catálogo: tamaño de subida |
Promo | validate.autocomplete.existing | false | Valida que los campos autocomplete de catálogos SOLO permita valores existentes |
Promo | validateRelatedEntities | true | Validar catálogos relacionados al catálogo de clientes |
Promo | attribute.relationship.validation.required | false | Requiere validación de datos de atributos de ítem en la condición de promociones |
Promo | customer.required | false | La promoción requiere condición de Cliente para considerarse completa |
Promo | dateTime.required | false | La promoción requiere condición de Fecha con hora para considerarse completa |
Promo | transaction.required | false | La promoción requiere condición de Transacción para considerarse completa |
Promo | valid.date.couponType | true | Valida si la vigencia de la promoción esta contemplada dentro de la vigencia del cupón |
Promo | distributionThreadPool | 10 | Cantidad de hilos creados para la distribución simultánea |
Promo | promocache.enabled | false | Habilita la generación de cache de ítems participantes en promociones |
Promo | promocache.engineHost | localhost | Servidor en el que corre el motor de cache de promociones |
Promo | promocache.enginePort | 3002 | Puerto en el que corre el motor de cache de promociones |
Promo | promocache.engineRetries | 2 | Reintentos de conexión al motor de cache de promociones |
Promo | promocache.engineTimeout | 8000 | Timeout de conexión al motor de cache de promociones |
Promo | promocache.imagesURL | PromoCache: URL Imágenes Promociones. | |
Promo | promocache.salesPath | C:\synthesis\promo\cache\sales | Directorio de mapas del motor de cache de promociones |
Promo | promocache.tasksQuantity | 10 | Cantidad de hilos de ejecución del cache de promociones. |
Promo | scheduled.enabled | false | Generación y distribución programada de mapas. |
Promo | scheduled.filter.enable | false | Filtrar promociones por tienda para la distribución programada. |
Promo | scheduled.mapVersion | true | Incrementar la versión del mapa para la distribución programada. |
Promo | microsoft.crm.clientId | Identificador del cliente de Microsoft Dynamics CRM | |
Promo | microsoft.crm.clientSecret | Client Secret de Microsoft Dynamics CRM | |
Promo | microsoft.crm.coupon.batch.size | 1000 | Cantidad de Cupones a enviar por lote a Microsoft Dynamics CRM (Máximo 1000) |
Promo | microsoft.crm.coupon.endpoint | Endpoint de cupones de Microsoft Dynamics CRM | |
Promo | microsoft.crm.enabled | false | Habilita la funcionalidad de exportación a Microsoft Dynamics CRM |
Promo | microsoft.crm.host | Url de host de Microsoft Dynamics CRM | |
Promo | microsoft.crm.tentantId | TenantId de Microsoft Dynamics CRM | |
Promo | microsoft.crm.urlAuth | Url de autenticación de Microsoft Dynamics CRM | |
Promo | path | C:/napse/promo70/import/ | Directorio para la importación de Mapas de Promociones. |
Promo | benefit.active | false | Utilizar campo numérico incremental para beneficios |
Promo | promotion.code.active | false | Utilizar campo numérico incremental para promociones |
Promo | redeemedPoints | 0 | Determina el mínimo de puntos para beneficios de redención |
Promo | use.item.catalog | 1 | Mapas: algoritmo de cálculo de colisiones |
Promo | cleanEngineStatusHistory | 7 | Tiempo en días que la consola mantendrá el historial de estados del motor |
Promo | dateEditableIfActive | true | Habilita la edición de la fecha de inicio de vigencia de la promoción |
Promo | defeatedEditable.enabled | true | Habilita la edición de promociones vencidas |
Promo | deployedEditable.enabled | false | Habilita la edición de promoción con el estado Deployed. |
Promo | engineLog.FileDirectory | C:\user\mxxxdxxxx\Desktop\ftp | Engine Log: Directorio donde estarán los archivos. |
Promo | file.xls.header.rowStart | 1 | Alta masiva de promociones: número de fila donde se va a ubicar la cabecera de la plantilla de promoción. |
Promo | message.printer.maxLength | Recortar mensaje para la impresora. | |
Promo | promotion.name.code | false | Indica si el código de una promoción, debe ser concatenado al nombre de la misma. |
Promo | promotion.codeKey | false | Campo código de promoción clave. |
Promo | promotion.enginestatus.communication | 600 | Tiempo que transcurre desde el último informe de estatus del motor o consola, para considerarlo offline. Si en ese tiempo no informó se lo considera offline. |
Promo | promotion.images.height | 250 | Promociones: alto default de las imágenes |
Promo | promotion.images.path | C:/napse/promo70/images/promotion/ | Promociones: directorio para almacenamiento de imágenes |
Promo | promotion.images.width | 250 | Promociones: ancho default de las imágenes |
Promo | rabbitMQ.SSL.enabled | false | Activar SSL |
Promo | rabbitMQ.cardhistory.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos de tipo CardHistory | |
Promo | rabbitMQ.enabled | false | Propiedad que indica si está habilitado rabbitMQ |
Promo | rabbitMQ.endpointName | Nombre de la cola de rabbitMQ | |
Promo | rabbitMQ.enginestatus.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos de tipo EngineStatus | |
Promo | rabbitMQ.host | Dirección (host) del RabbitMQ server | |
Promo | rabbitMQ.limitstatus.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos de tipo LimitStatus | |
Promo | rabbitMQ.loyaltyType.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos para el tipo de cupones/Elementos de Fidelidad | |
Promo | rabbitMQ.password | Password para acceder al rabbitMQ | |
Promo | rabbitMQ.port | Puerto del server rabbitMQ | |
Promo | rabbitMQ.producer.SSL.enabled | true | Activar SSL para el posteo de datos |
Promo | rabbitMQ.producer.enabled | false | Propiedad que indica si esta habilitado rabbitMQ para el posteo de datos. |
Promo | rabbitMQ.producer.host | Dirección (host) de RabbitMQ server para el posteo de datos. | |
Promo | rabbitMQ.producer.password | Password para acceder al RabbitMQ server para el posteo de datos. | |
Promo | rabbitMQ.producer.port | Puerto del RabbitMQ server para el posteo de datos | |
Promo | rabbitMQ.producer.uri | URI de conexión completa RabbitMQ server para el posteo de datos | |
Promo | rabbitMQ.producer.username | Usuario para acceder a RabbitMQ server para el posteo de datos | |
Promo | rabbitMQ.producer.virtualHost | Virtual Host RabbitMQ server para el posteo de datos | |
Promo | rabbitMQ.promotion.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos de tipo Promotion | |
Promo | rabbitMQ.promotionsCache.endpointName | Nombre de la cola de RabbitMQ para el posteo de datos de tipo PromotionsCache | |
Promo | rabbitMQ.uri | URI de conexión completa rabbitMQ | |
Promo | rabbitMQ.username | Usuario para acceder al rabbitMQ | |
Promo | rabbitMQ.virtualHost | virtual Host al rabbitMQ | |
Promo | reportParticipants | false | Promociones: valor global que determina si la promoción informa participantes |
Promo | reportParticipantsVisible | true | Determina si se visualiza o no, la opción reportar participantes |
Promo | vtol.url | Url para obtener los planes de pago de Vtol | |
Promo | bankRefundBenefit.method.of.payment | NOTHING= No calcular promociones por medio de pagos. ON_ITEMS_PAID= Calcular promociones sobre ítems pagados ON_PAYMENT_MADE=Calcular promociones sobre pago realizado | Reintegro bancario: Opciones de cálculo de reintegro |
Promo | bankRefundBenefit.method.of.payment.onItemsPaid.class | com.synthesis.promo.engine.partialPayment.hardcoded.promotion. BankRefundPartialPaymentGSPromotion | Reintegro bancario: Clase de la promoción basada en ítems. |
Promo | bankRefundBenefit.method.of.payment.onItemsPaid.name | Promociones basadas en ítems - Reintegro bancario | Reintegro bancario: Nombre de la promoción basada en ítems. |
Promo | bankRefundBenefit.method.of.payment.onItemsPaid.tenderMethodPropertyKey | promo.configuration.tenderMethod.itemMethod | Reintegro bancario: Propiedad basada en ítems a utilizar. |
Promo | bankRefundBenefit.method.of.payment.onPaymentMade.class | com.synthesis.promo.engine.partialPayment.hardcoded.promotion. BankRefundPartialPaymentSSPromotion | Reintegro bancario: Clase de la promoción basada en pagos. |
Promo | bankRefundBenefit.method.of.payment.onPaymentMade.name | Promociones basadas en pagos - Reintegro bancario | Reintegro bancario: Nombre de la promoción basada en pagos. |
Promo | bankRefundBenefit.method.of.payment.onPaymentMade.tenderMethodPropertyKey | promo.configuration.tenderMethod.paymentMethod | Reintegro bancario: Propiedad basada en pagos a utilizar. |
Promo | method.of.payment | NOTHING= No calcular promociones por medios de pago. ON_ITEMS_PAID = calcular promociones sobre ítems pagados. ON_PAYMENT_MADE = Calcular promociones sobre pago realizado. | Promoción Codificada: NOTHING, ON_ITEMS_PAID, ON_PAYMENT_MADE. |
Promo | method.of.payment.onItemsPaid.class | com.synthesis.promo.engine.partialPayment.hardcoded.promotion. PartialPaymentsGSPromotion | Promoción Codificada: nombre de la promoción por medio de pago basada en ítems. |
Promo | method.of.payment.onItemsPaid.name | Promociones basadas en ítems | Promoción Codificada: nombre de la promoción por medio de pago basada en ítems. |
Promo | method.of.payment.onItemsPaid.tenderMethodPropertyKey | promo.configuration.tenderMethod.itemMethod | Promoción Codificada: nombre de la promoción por medio de pago basada en ítems. |
Promo | method.of.payment.onPaymentMade.class | com.synthesis.promo.engine.partialPayment.hardcoded.promotion. PartialPaymentsSSPromotion | Promoción Codificada: nombre de la promoción por medio de pago basada en ítems. |
Promo | method.of.payment.onPaymentMade.name | Promociones basadas en pagos | Promoción Codificada: nombre de la promoción por medio de pago basada en ítems. |
Promo | method.of.payment.onPaymentMade.tenderMethodPropertyKey | promo.configuration.tenderMethod.paymentMethod | Promocion Codificada: nombre de la promoción por medio de pago basada en ítems. |
Promo | ldapAuthentication | false | Determina si se autentica contra un Directory Service. |
Promo | ldapAuthentication.autheticationMode | DIGEST-MD5 | Es el modo de seguridad que se autentica, usar "DIGEST-MD5" como valor default dado que este modo encripta la información contra el Directory Service. |
Promo | ldapAuthentication.urlServer | URL del server contra el que se autentica. | |
Promo | testEngineADDR | localhost | Simulación: Dirección del motor para simulación. |
Promo | testEnginePORT | 3001 | Simulación: puerto en el que corre el motor para simulación |
Promo | testEngineRetries | 2 | Simulación: reintentos de conexión al motor |
Promo | testEngineSalesPath | C:/napse/promo70/engine/sales/ | Simulación: ruta del motor. |
Promo | testEngineTimeout | 8000 | Simulación: timeout de conexión al motor. |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de marcas ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de categorías ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de canales ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de compañia crediticia ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de clientes ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de tipos de clientes ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de transacciones ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de tipos de transacción ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de tipos de familia ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de formatos ante un error |
Promo | continueOnError | true | Permitir continuar la importación del catálogo de información financiera de lista de precios ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de items ante un error |
Promo | continueOnError | true | Permitir continuar la importación del catálogo de stock ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de tipos de Departamento ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de bancos ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de pagos (Código) ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de prefijos ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de tipos de pagos ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de códigos de barra ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de código de productos ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de perfil de cliente ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de Canje de Puntos por Catalogo ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de tiendas ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de cadenas ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de sub categorías ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de subzonas ante un error |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de proveedores ante un error. |
Promo | continueOnError | true | Permitir continuar la importación de catálogo de zonas ante un error. |
Redes sociales | facebook.appId | Id de la aplicación de facebook | |
Redes sociales | facebook.permissions | [pages_show_list, pages_read_engagement, pages_manage_posts] | Permisos de la aplicación de facebook |
Redes sociales | facebook.secret | Clave secreta de la aplicación de facebook | |
Redes sociales | facebook.secure | Protocolo de conexión segura a la aplicación de facebook | |
Redes sociales | twitter.accessToken | Token de acceso a twitter | |
Redes sociales | twitter.accessTokenSecret | Token secreto de acceso a twitter | |
Redes sociales | twitter.consumerKey | Clave consumer key de twitter | |
Redes sociales | twitter.consumerSecret | Clave consumer secret de twitter | |
Tarjetas de fidelidad | max.qty | 999 | Cantidad máxima de tarjetas de fidelidad a generar por cada operación de alta masiva |
Tarjetas de fidelidad | isEditableAfterCardsGeneration | false | Permitir la edición del tipo de tarjeta luego de haber generado una tarjeta activa. |
Tarjetas de fidelidad | prefix.active | false | Utilizar prefijo numérico incremental para tipos de tarjeta |
Tarjetas de fidelidad | code.active | false | Utilizar código numérico incremental para tipos de tarjeta |
Tarjetas de fidelidad | card.nominated.default.option | No | Tipo de tarjetas de fidelidad: Crear por defecto nominadas (default: false = no) |
Tarjetas de fidelidad | continueOnError | true | Permitir continuar la importación del catálogo de tarjetas de fidelidad ante un error. |
Tarjetas de fidelidad | insertionOption | INSERT_OR_UPDATE | Describe la opción de inserción para la importación del catálogo de tarjetas de fidelidad. |
Transacciones | cleanTransactions | 90 | Cantidad de días que permanecerán los registros de transacciones en la base de datos |
Podrán existir cambios correspondientes a:
- actualización de la consola de administración (de existir alguna actualización se entregará la correspondiente documentación y la forma de instalarla),
- depuración de backups de BD.
Informações | ||
---|---|---|
| ||
Tener en cuenta que para realizar el mantenimiento se deberá detener la aplicación, realizar los cambios y luego volver a iniciarla. |
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
La aplicación registra un backup automático diario de la base de datos MongoDB. Es por ello que es necesario realizar un cierto mantenimiento, consistente en la depuración de los mismos periódicamente a fin de que la carpeta de backup no ocupe demasiado en disco.
Alta de cliente durante la transacción
A partir de Promo 7.0.2 -
Para que el alta de clientes pueda efectuarse al momento de procesarse una transacción, deberá de habilitarse en el archivo de configuraciones de la Consola de Promo (“promoplus.properties”) el siguiente atributo:
# Habilita el alta de clientes on the fly promo.allowNonExistingCustomers = true |
Una vez actualizado, deberá de reiniciarse el Wildfly para que los cambios sean tomados correctamente.
Los clientes serán creados utilizando el estado "loyaltyValidation" en el caso de enviarse los datos mínimos y al mismo tiempo Promo detecte que el cliente no existe. Los datos mínimos mencionados son (marcados en Rojo):
<customer-add seq="1"
id="10090504"
identifier="10090504"
type="test"
name="pepe"
lastName="rodrigues"
identifierType="cpf"
email="mimail@
test.com"
/>
Bloco de código | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<message companyId="napse" store="1" terminal="1" date-time="2020-11-03 11:11:22" init-tck="true" messageId="1" void-trx="false" response="true" status="loyaltyValidation" evaluate="true" map-version="2" tckpath="Y" suggest="true">
<customer-add seq="1" id="47001517" identifier="47001517" type="test" name="bruno" lastName="Lopez" identifierType="cpf" email="[email protected]" />
</message> |
Nota: Para mas informacion ver "Manual de Integracion 7.0 - Motor" - LoyaltyValidation.
Enmascarar Contraseña de DB
La clave enmascarada de base de datos se genera mediante la promo-crypto-tool que sera provista.
El programa toma como ingreso a la clave a encriptar y devuelve la clave encriptada que se debe situar en el archivo promoplus.properties en una entrada llamada grails.mongodb.encryptedPassword (por ej. grails.mongodb.encryptedPassword=lYYBAfxLR40=).
En caso de utilizar grails.mongodb.encryptedPassword se debe considerar comentar o eliminar la anterior grails.mongodb.password ya que en caso de existir ambas siempre utilizará grails.mongodb.password. En caso de que el archivo promoplus.properties no exista, se tomará, como valor por defecto, a v9vbhV.
Para encriptar una clave se debe utilizar promo-crypto-tool de la siguiente forma en una consola:
Bloco de código | ||||
---|---|---|---|---|
| ||||
java -jar <nombre del jar> <contraseña a encriptar>, por ej java -jar promo-crypto-tool-1.0.0.jar abcdefg |
o bien
Bloco de código | ||||
---|---|---|---|---|
| ||||
java -jar <nombre del jar> y al ejecutarlo, de modo interactivo, solicitará el ingreso de la contraseña. |
En ambos casos la contraseña encriptada se obtendrá por pantalla.
Al momento de levantar el servidor, se hará uso de Datasource.groovy que mantiene el llamado a assignMongodbPassword() el cual a su vez llama al desencriptador para obtener la contraseña para asignársela a grails.mongodb.password.
Informações | ||
---|---|---|
| ||
Se debe considerar la limitación del algoritmo tripledes, el cual acepta sólo caracteres us-ascii como entrada del encriptador. Utilizar caracteres diferentes genera contraseñas encriptadas inválidas. |
Informações | ||
---|---|---|
| ||
Se asume que si existe, en el archivo promoplus/promoconfig.properties, una contraseña no encriptada (grails.mongodb.password) no debe existir la entrada de contraseña encriptada (grails.mongodb.encryptedPassword) y viceversa. La entrada no deseada se puede eliminar o comentar. |
Configuración Atributos con espacios en Condiciones Simples
En Promo 7 por default no se puede ingresar en Condiciones Simples atributos con espacios, al ingresar el espacio toma como completo el nombre del atributo ingresado, como cuando se presiona la barra espaciadora:
Por configuración se puede cambiar y permitirá ingresar espacios en blanco en los atributos ingresados. Para eso debe editar el archivo promoplus.properties y agregar la siguiente línea:
promo.delimiters = no-space
Con esta configuración para que interprete que se terminó de escribir el elemento debe presionar la tecla tab.
Si ingresa el parámetro: promo.delimiters = space funciona como viene por default, que no permite ingresar espacios dentro del texto ingresado en los atributos.
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Para trabajar con redes sociales PROMO posee una serie de opciones de configuración que se describen a continuación. También es importante aclarar que los servicios de redes sociales están en constante evolución y cambio por lo cual aquí se hace referencia al sitio del servicio en cuestión para obtener la información actualizada al respecto.
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Desde la consola de cada compañía, accediendo con el usuario administrador, y accediendo a "Administración Información de configuración" se encontraran las siguientes configuraciones que serán necesarias completar para la correcta publicación en la red social.
- Generación de Aplicación en Facebook
Para poder utilizar la publicación en Facebook se deberá ingresar a https://developers.facebook.com/, darse de alta como desarrollador de Aplicaciones Facebook y agregar una nueva aplicación siguiendo los pasos indicados en la página.
Al crear una aplicación para Facebook, se comienza en estado de desarrollo y para poder realizar publicaciones hay que dar los permisos de "Administrador" al usuario de FB que realizara las publicaciones.
Por otra parte, si se quiere compartir o que otro usuario pueda realizar publicaciones, es necesario agregarlo al grupo de contactos (amigos) y darle permisos de "Administrador".
Al acceder a la URL indicada más arriba, se accederá a la sección de "Facebook for Developers" de Facebook.
Debe iniciar sesión, desde el botón correspondiente:
Al ingresar, se deberá dar clic en "Mis Apps".
Una vez allí, habrá que dar clic en el botón verde de "Crear app".
Se presentara el siguiente popUp donde se deberá seleccionar el tipo de app que se desea crear. En este caso, seleccionaremos "Negocio", y se deberá presionar "Continuar".
En el siguiente popUp se deberán ingresar los datos solicitados para dar nombre a la app que se esta creando y presionar el botón "Crear app"
Una vez creada la app se mostrara la siguiente pantalla, desde donde podrá accederse, desde la opción "Configuración" >> "Básica", a los datos de identificación de la aplicación recientemente creada.
Aviso | ||
---|---|---|
| ||
Los datos presentes en esta imagen son solo de carácter ilustrativo y deberán ser reemplazados por las credenciales adquiridas con los usuarios de desarrollo de cada aplicación. |
Los datos a considerar y completar en esta sección serán:
- Identificador de la app: Sera requerido en Promo para poder configurar los datos de conexión a la app de Facebook (Los datos mostrados en las imágenes son de carácter ilustrativo y no son validos para la configuracion de ninguna app)
- Clave secreta de la app: Sera requerido en Promo para poder configurar los datos de conexión a la app de Facebook. La clave se mostrará enmascarada y se solicitara la clave de usuario de FB para mostrarla.
- Nombre para mostrar: Sera el nombre de al app que se mostrara a los usuarios de FB.
- Dominio de la app: Deberá indicarse el dominio donde se encuentra Promo.
- Correo electrónico de contacto: Deberá indicarse el mail de contacto para la app.
- URL de la Política de privacidad: Deberá indicarse la política de privacidad de la compañía que desea publicar en FB desde Promo.
Sera necesario tener una pagina de Facebook dada de alta y asociada a la cuenta de usuario de Facebook para poder realizar las publicaciones en esta pagina.
Desde el perfil de usuario con el que se haya generado la app de Facebook, se deberá dar clic "Paginas" que se encuentra a la izquierda de la pagina.
Se presentara la siguiente pagina, donde se deberá dar clic en "Crear nueva pagina"
Al presionar en "Crear nueva pagina", se mostrará la siguiente pantalla, donde deberá de completarse la información solicitada en el margen izquierdo.
Una vez generada la pagina e ingresados los datos de configuracion aportados por la aplicación generada, se podrá proceder a la publicación de las promociones en la red social. (ver Manual de usuario Promo 7 - "Distribución">> "Redes Sociales")
Informações | ||
---|---|---|
| ||
Se deberá ser administrador tanto de la pagina como de la aplicación generada en Facebook para poder realizar las publicaciones desde PROMO. |
Aviso | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Https obligatorio para la publicacion en Facebook Facebook sólo se integra con sistemas que funcionen con https. Promo tendrá que tener configurado su wildfly con https Para la cunfiguracion de wildfly con https sera necesario editar el archivo "standalone.xml" ubicado en ...\synthesis\promo\appserver\standalone\configuration
<security-realm name="ApplicationRealm"/>
<server name="default-server"/>
También sera necesario generar y colocar el archivo "server.keystore" en el directorio ...\synthesis\promo\appserver\standalone\configuration. ( Como son claves de encriptación, tienen que ser generadas dentro del ambiente de instalación. Desde Napse se utilizó la herramienta de pruebas "keytool" de Java para la generación del mismo) Una vez guardados los cambios en el standalone.xml y colocado el archivo "server.keystore.txt" en el directorio indicado, deberá de reiniciarse el wildfly para que los cambios sean tomados correctamente. |
Âncora _Toc473121733 _Toc473121733
Âncora _Toc513638230 _Toc513638230
Configurar Twitter
_Toc473121733 | |
_Toc473121733 |
_Toc513638230 | |
_Toc513638230 |
Desde la consola de cada compañía, accediendo con el usuario administrador, y accediendo a Administración >> Información de configuración se encontraran las configuraciones que serán necesarias completar para la correcta publicación en la red social.
- Generación de perfil en Twitter
Deberá accederse a la URL https://developer.twitter.com/ y presentara la siguiente pantalla:
Deberá darse clic en el botón correspondiente al usuario logueado en Twitter, se desplegara un menú y se dará clic en "Apps"
Se presentara la siguiente pantalla y debera darse clic en "Create an app"
Sera necesario completar los campos con los datos solicitados para poder crear la aplicación en base a las políticas de seguridad de Twitter.
Completos todos los campos, dar clic en "Create" y se mostraran las configuraciones disponibles para la nueva aplicación recientemente generada:
Para obtener los Ids y Tokens deberá darse clic en la solapa "Keys and Tokens" donde se visualizaran los datos necesarios para configurar correctamente los permisos de acceso desde Promo.
Una vez ingresados los datos de configuracion aportados por la aplicación generada, se podrá proceder a la publicación de las promociones en la red social. (ver Manual de usuario Promo 7 - "Distribución">> "Redes Sociales")
Aviso | ||
---|---|---|
| ||
No podrán subirse a las redes sociales imágenes con tamaños motor a 1 MB. |
Validar CVV solo cuando se realiza un consumo en una Tarjeta de Fidelidad
(a partir de Promo 6.5)
Se disponibiliza la posibilidad de poder indicar por configuracion que el CVV de una tarjeta de Fidelidad solo sea validado cuando se realiza un consumo de saldos en ella.
La tarjeta debe de tener activa la opción de CVV requerido en su tipo de tarjeta.
Para habilitar esta opción deberá definirse en el archivo "promoconfig.properties" el parametro promo.general.cvvOnlyForConsume = true
Integración con Syslog/QRADAR
La implementación del envío de eventos a QRadar se apoya en el sistema de logueo log4j utilizado por Promo, agregando un appender específico para syslog "SysLogAppender" disponible en el paquete log4j, y el desarrollo de un clase que presta servicio a tal fin denominada "SysLogService" la cual formatea los mensages en otra clase "SysLogMessageFactory".
Para habilitar el envío a QRadar, se debe editar el archivo de configuracion de logueo "log4j.xml" insertando las siguientes entradas antes del final:
Bloco de código | ||||
---|---|---|---|---|
| ||||
<appender name="syslogappender" class="org.apache.log4j.net.SyslogAppender">
<param name="syslogHost" value="myserver:myport"/>
<param name="facilityPrinting" value="false"/>
<param name="facility" value="AUTHPRIV"/>
<param name="header" value="false"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy-MM-dd'T'HH:mm:ss.SXXX} %m%n"/>
</layout>
</appender>
<logger name="sts.console.audit.SysLogService" additivity="false">
<level value="info"/>
<appender-ref ref="syslogappender"/>
</logger>
</log4j:configuration> |
Cambiar en el parámetro "syslogHost" , el valor "myserver:myport", por el correspondiente a la dirección ip y port del syslog server QRadar. Ejemplo: localhost:514
Luego re-deployar la consola de Promo para que tome la configuración.
Tipos de eventos :
Los eventos que serán enviados a QRadar en una primera instancia son los correspondientes a usuario: login, logout, login failed, nuevo usuario, modificación de usuario.
Configuración de Ambiente
Opción de configuración que afecta al funcionamiento del ambiente en su totalidad y se realiza desde el archivo promoplus.properties.
promo.backupOptions | --gzip | indica que el backup va a ser comprimido a nivel colección. Si tiene un valor diferente la base no va a comprimir a nivel colección. |
promo.card.customersNonNominated | true | Permite que al validar que se considere al CPF como si fuera una tarjeta nominada. |
promo.transaction.flatten.batch.size | 250 | Indica la cantidad de transacciones a aplanar por cada corrida del job aplanado |
Âncora _Toc513638231 _Toc513638231
Resolución de problemas
_Toc513638231 | |
_Toc513638231 |
Durante su funcionamiento, la Consola de administración podrá informar errores inesperados. Los errores que puedan a llegar a ocurrir utilizando la aplicación serán informados mediante un pop-up en rojo indicando la causa del mismo. Asimismo, el log de la aplicación que se encuentra en \synthesis\promo\log indicará más detalle acerca del mismo.
Si el error es por un tema de permisos o página no encontrada, se informará mediante una pantalla aclaratoria con el problema ocurrido. Âncora _Como_crear_una _Como_crear_una Âncora _Cómo_crear_una_base de datos en SQL _Cómo_crear_una_base de datos en SQL
Desinstalación
Para proceder con la des-instalación de la consola y motor de PROMO se deberá:
1- Bajar servicios
- PromoSImEngine
- Wildfly
- MongoDB
- PromoEngine (si se instaló el motor)
- PromoEngineDirector (si se instaló el motor)
2- Borrar directorio C:\Synthesis (ruta donde se instaló la consola)
3- Desinstalar MongoDB
4- Borrar los servicios de PromoSinEngine, Wilfly y MongoDB, y PromoEngine, PromoEngineDirector si se instaló el motor
Reverso de actualizaciones ante problemas en el proceso
Ante algun problema durante la actualizacion de una version de consola o motor, debera de bajarse los servicios involucrados y colocar el archivo .war o .jar anterior, segun se trate de una actualizacion de consola o motor respectivamente y volver a subir los servicios.
Luego de reesablecido el sistema contactar a Sericios de Atencion al Cliente para poner en conocimiento de lo sucedido con el proceso de actualizacion.
Herramienta para métricas de fidelidad
(A partir de Promo 7.2) Con el objetivo de medir los tiempos de proceso de elementos de fidelidad, se han incorporado métricas en el log de aplicación.
Se implementa la actualización en el log a nivel INFO tanto del lado consola como del motor, de las siguientes operaciones:
- LoyaltyValidation
- LoyaltyActivation
- LoyaltyTransfer
- LoyaltyVoid
- LoyaltyAssign
- FINISH
- COMMIT
- ROLLBACK
- TransactionRequest
- ReturnFinish
- CatalogRedeemValidation
LOYALTYVALIDATIONEX
- FINISHEX
- Prices
- voidTotal
- blackList
Para habilitar los cambios realizados se agregaron las siguiente propiedades en los archivos correspondientes al logging tanto del lado consola como del motor:
Habilitar logueo en consola, ir a : ..\synthesis\promo\appserver\modules\system\layers\base\com\synthesis\configuration\main\log4j.xml
Valor por defecto ERROR, pasar a INFO para habilitar la funcionalidad.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<category name="grails.app.services.sts.console.api.ApiService">
<priority value="ERROR" />
</category> |
Habilitar logueo en motor, ir a: ...\synthesis\promo\engine\conf\logging.properties
Valor por defecto SEVERE, pasar a INFO para habilitar la funcionalidad.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
engine.operation.level = INFO |
Adicionalmente, una vez actualizado el valor de la propiedad engine.operation.level, se cambia el nivel de logging de SEVERE a INFO de las siguientes propiedades:
- java.util.logging.FileHandler.level = INFO
- java.util.logging.ConsoleHandler.level = INFO
Resultado del cambio:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
15,52,20,949 INFO [sts.console.api.ApiService@http-nio-8080-exec-2] -->loyaltyTransfer
15,52,20,974 INFO [sts.console.api.ApiService@http-nio-8080-exec-2] <--loyaltyTransfer 0.025 seconds
15,52,23,334 INFO [sts.console.api.ApiService@Actor Thread 5] ApiService.status.mapActives Starting processing at Fri Jul 23 15:52:23 ART 2021
15,52,23,335 INFO [sts.console.api.ApiService@Actor Thread 3] ApiService.status.mapActives processed Finish at Fri Jul 23 15:52:23 ART 2021
15,52,23,357 INFO [sts.console.api.ApiService@http-nio-8080-exec-8] -->processEngineRequest: checking on console type:DYNAMIC_ATTRIBUTES ...
15,52,23,380 INFO [sts.console.api.ApiService@http-nio-8080-exec-1] -->processEngineRequest: checking if console has any pending to be process on engine...
15,52,29,749 INFO [sts.console.api.ApiService@http-nio-8080-exec-2] -->commit
15,52,29,752 INFO [sts.console.api.ApiService@http-nio-8080-exec-2] <--commit 0.003 seconds |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
INFORMACIÓN: -->OperationFinish:remoteEvaluation
jul 23, 2021 3:54:52 PM engine.operation.Operation loggerTimeStop
INFORMACIÓN: <--OperationFinish:remoteEvaluation 0.913 seconds -><?xml version="1.0" encoding="UTF-8"?><message ack="0" companyId="napse" engine="7.1.4-SNAPSHOT" mapversion="44" messageId="1" store="napse" terminal="1" transaction="napse_napse_1_20210723100025">
<loyalty>
<loyaltycards>
<loyaltycard ack="0" amount="1800.00" id="550003" seq="1" type="tdf_001"/>
</loyaltycards>
<coupons/>
<errors/>
<customers/>
<redeemTable/>
</loyalty>
</message>
jul 23, 2021 3:55:04 PM engine.operation.Operation loggerTimeStart
INFORMACIÓN: -->OperationCommit:remoteEvaluation
jul 23, 2021 3:55:04 PM engine.operation.Operation loggerTimeStop
INFORMACIÓN: <--OperationCommit:remoteEvaluation 0.053 seconds
jul 23, 2021 4:13:57 PM engine.operation.Operation loggerTimeStart
INFORMACIÓN: -->OperationLoyaltyValidation:remoteEvaluation
jul 23, 2021 4:13:57 PM engine.operation.OperationLoyaltyvalidation validation
INFORMACIÓN: Se valida que el cuerpo del mensaje no este vacio en LoyaltyValidation
jul 23, 2021 4:13:57 PM engine.operation.Operation loggerTimeStop
INFORMACIÓN: <--OperationLoyaltyValidation:remoteEvaluation 0.373 seconds |
...
Apéndice A: Autenticación de Usuarios Externos (SAML2)
...
Aviso | ||
---|---|---|
| ||
Al utilizar un sistema de autenticacion externos los usuarios dados de alta en la consola no deberán poseer ningún tipo de configuracion de políticas de seguridad de PROMO. |
Para que promo utilice saml2, se deberá agregar, en el directorio donde permanecen los .properties\appserver\modules\system\layers\base\com\synthesis\configuration\main\ , los archivos properties correspondientes. Éstos Estos son:
- saml.properties - Archivo principal de configuraciones.
- saml-keymanager-passwords.properties
- saml-metadata-providers.properties - Archivo correspondiente a la configuración del proveedor de identidad.
- saml-metadata-sp-defaults.properties - Archivo correspondiente a la configuración que utilizará PROMO para generar su archivo xml de metadatos.
...
Consideraciones de la pruebas de Integración
Para realizar pruebas se utilizó https://capriza.github.io/samling/samling.html
- Alta de usuarios en la consola de PROMO por medio del servicio rest correspondiente (createOrUpdateUsers), También podrán darse de alta manualmente desde la consola. En ambos casos deberá de tenerse en cuenta que los usuarios no deberán tener asignadas ninguna restricción en cuanto a políticas de seguridad propias de PROMO.Obtener su xml de metadatos en el menú idp metadata (https://capriza.github.io/samling/samling.html#) y guardarlos en un archivo xml (preferiblemente idp.xml). Debe apuntarse al mismo desde la configuración por properties.ninguna restricción en cuanto a políticas de seguridad propias de PROMO.
Obtener el xml de metadatos del sistema saml proveedor de identidad, del cliente. La ruta donde estará este archivo deberá tener especificada en la configuración properties. Para simplificar se puede renombrar como idp.xml.
- Guardar el archivo idp.xml en C:\synthesis\promo\idp.xml
- Editar el archivo saml-metadata-providers.properties especificando allí la ruta absoluta donde se colocó el archivo idp.xml
- Iniciar PROMO (Wildfly) con los cuatro properties correspondientes a saml.
- Generar el xml de PROMO accediendo a http://localhost:8080/promo/saml/metadata, guardarlo en un xml (preferiblemente sp.xml).
- Se guardó
Guardar sp.xml
enen C:\synthesis\promo\sp.xml.
- Editar el archivo saml.properties especificando allí la ruta absoluta donde se colocó el archivo sp.xml
Editar el archivo saml-metadata-sp-defaults.properties especificando la ruta de promo (por ej. http://localhost:8080/promo).
- Detener PROMO (wildfly)
- Borrar los directorios \temp y \data que se encuentran en el directorio \standalone de la instalacion de PROMO.
- Iniciar PROMO(wildfy)
- Al acceder a la consola de PROMO en lugar de la pantalla de inicio de sesión aparecerá la pantalla de samling. Esta pantalla permite configurar qué se desea enviar al proveedor de servicios, que en este caso es PROMO. Sólo modificar, dentro de "Saml Response Properties" el campo "Name Identifier" con el nombre de usuario con el que se desea acceder a PROMO.Presionar "NEXT"
En la siguiente pantalla que se presenta presionar "Post Response"
Se presentara acceder a la consola de PROMO en lugar de la pantalla de inicio de sesión aparecerá la pantalla de inicio de sesión del proveedor de identidad. - Luego de ingresar usuario y clave en el proveedor de identidad, se presentará la consola de PROMO, logueada con el usuario ingresado:, en la página de inicio correspondiente al rol que tiene asignado.
Si el usuario no corresponde a ningún usuario dado de alta en PROMO el login fallará, y se volverá a la pantalla del punto 13 para volver a intentar a ingresar un usuario valido y poder iniciar sesión en PROMO.
Si el usuario es uno existente iniciará sesión en PROMO sin problemas, presentándose la pantalla de Gestión de Promociones.
Aviso | ||
---|---|---|
| ||
Saml2 funciona con la primer empresa existente y no principal. Todo usuario se verificará con dicha empresa. Para el caso del acceso con la empresa Synthesis, se reservó el usuario synthesis, es decir, si se necesita acceder a la compañía principal se debe utilizar el usuario synthesis. El cliente deberá dar de alta en su proveedor de identidad a este usuario previamentecrea promoAdmin. Este war sólo tiene la finalidad de acceder con synthesis para entornos test/productivos con saml activo. |
Propertis:
saml.properties, debe mantener la ruta absoluta al archivo de metadatos del proveedor de servicios.
Bloco de código language xml theme RDark # # Configuraciones para la utilización de SAML2 # Más info en https://sphoortia.github.io/grails-spring-security-saml/docs/guide/configuration.html # grails.plugin.springsecurity.saml.userGroupAttribute = memberOf grails.plugin.springsecurity.saml.metadata.sp.file = C:\\synthesis\\promo\\sp.xml grails.plugin.springsecurity.saml.metadata.sp.alias = promo_saml grails.plugin.springsecurity.saml.responseSkew = 60 grails.plugin.springsecurity.saml.idpSelectionPath = / grails.plugin.springsecurity.saml.loginFormUrl = /saml/login
saml-metadata-providers.properties, clave ping, debe mantener la ruta absoluta al archivo de metadatos del proveedor de identidad.
Bloco de código language xml theme RDark ping=C:\\synthesis\\promo\\idp.xml
saml-metadata-sp-defaults.properties, clave entityBaseURL, debe mantener la ruta de promo.
Bloco de código language xml theme RDark local=true alias=promo_saml entityBaseURL=http://localhost:8080/promo securityProfile=metaiop signingKey=ping encryptionKey=ping tlsKey=ping requireArtifactResolveSigned=false requireLogoutRequestSigned=false requireLogoutResponseSigned=false idpDiscoveryEnabled=false
- saml-keymanager-passwords.properties
Bloco de código language xml theme RDark #apollo = nalle123
...