Image Removed
MANUAL DE INSTALACIÓNImage Added

PROMO 7.1

...

- Manual de Instalación

Âncora
_Toc513638194 _Toc513638194

Introducción

...

>use promo
>db.createUser({user:"promousr", pwd:"thepassword", roles:[{role:"dbOwner", db:"promo"}]})

...

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.

Se describe la instalación de la base de datos y del Jdk en Referencias Prácticas

...

Ejecución del Instalador (Windows)

...

Documentación relacionada

PROMO 7.1 - Manual de Usuario

PROMO 7.1 -Guía Inicial de Integración

PROMO 7.1 - Manual de Integración - Motor

PROMO 7.1 - Manual de Integración - Servicios

PROMO 7.1 - Manual de Integración - Colas de Mensajes

PROMO 7.1 - Manual del Administrador

PROMO 7.1 - Manual de Lenguaje de Promociones

PROMO 7.1 - Manual de Usuario Promo Lite

Ejecución del Instalador (Windows)

Deberá ejecutarse como administrador desde modo comando el Instalador "promo-console-installer-7.1.3.jar" para proceder a la instalación y configuración de la consola y motor de simulación de PROMO. Para esto deberá ejecutarse el comando java –jar promo-console-installer-7.1.3.jar
También se instalarán los siguientes componentes indispensables para el correcto funcionamiento de la aplicación:

...

Se presentara la siguiente pantalla donde se deberá presionar "Siguiente":

Image RemovedImage Added

Luego se solicitará la aceptación de los términos y condiciones de uso de la aplicación.

Image RemovedImage Added

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.

Presione el botón siguiente.

Image RemovedImage Added

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 También se deberá indicar el directorio donde se instalara la base de datos (MongoDb)

...

 Se solicitara se informe si se desea instalar o solo activar los servicios que se instalan con PROMO.

Image RemovedImage Added

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.

Image RemovedImage Added

Image Removed

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.

Image RemovedImage Added

Âncora
_Toc513638200 _Toc513638200

Estructura de directorios

...

Âncora
_Toc513638209 _Toc513638209

Errores en la instalación de la consola

• 404 – ERROR de Inicializacion Inicialización en Instalador

  
  
  
  Este error pude se produce al no iniciarse la instalación de la consola desde una pantalla de comando ejecutada como administrador. Se deberá ejecutar como administrador, en modo comando el instalador de PROMO (promo-console-installer-6.x.x.jar)

...

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
_Toc513638213 _Toc513638213

Pre-Requisitos del sistema

...

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 (Ej. : 7.1.3x).
Se deberá ejecutar como administrador, en modo comando el instalador del Motor de PROMO (Ej: java –jar promo-gengine-installer-7.1.3x.jar)

Al ejecutarse el instalador aparecerá la siguiente ventana:

Image Removed
Image Added

y luego la siguiente:

Image Added
Presionar "Siguiente" para continuar.

Se deberán aceptar los términos y condiciones para continuar con la instalación del motor de PROMO.

Image Removed Image Added
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.

Image Removed Image Added
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.

Image Removed Image Added
Presionar "Siguiente" para continuar.

Si se desea instalar el motor como aplicacionaplicación, se debe tildar el cheeckbox

Image Removed

Luego de presionar el botón Siguiente, debe indicarse la ruta donde está la carpeta webapps de la instalación de apache TomEE.

Image Removed

Luego de presionar Siguiente, debe completar los parámetros solicitados:

Image Removed

Si no se elige la opción de Instalar el motor como aplicacion al presionar el botón Siguiente, en el siguiente Pop-UP

Image Added

Luego de presionar "Siguiente", aparecerá el siguiente Pop-UP , donde se deberá indicar la URL de acceso a "Director" para futuras actualización actualizaciones y el código de tienda que tomara tomará el motor A continuación se deberá indicar

Image Removed
Presionar "Siguiente" para continuar.

Image Removed

Image Removed. 

Image Added

Luego de presionar "Siguiente", debe completar los parámetros solicitados:

Image Added

Si se presiona "Siguiente"

Image Added

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.

Image RemovedImage Added

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. 

Image Removed Image Added

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.

...

stores

...

...

Los parámetros de configuración de la sección Response afectan a la respuesta y calculos cálculos internos del motor.  Estos son:

Los parámetros de configuración de la sección Server, afectan la comunicación del motor como servvidorservidor.  Estos parámetros son:

keyStore

./conf/keystore

...

...

Los parámetros de configuración de la sección Extensions afectan la definicion definición e entidades que manejará el motor.  Los parámetros son:

...

Los parámetros de configuración de la sección cacjeData cacheData son:

...

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 índices 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.

...

• [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

...

_

...

Âncora
_Toc513638226 _Toc513638226

Información de Configuración

...

Configuraciones disponibles para el Usuario Principal:

Configuraciones disponibles para el Usuario Admin. de cada compañía:

Podrán existir cambios correspondientes a:

...

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.encriptedPasswordencryptedPassword=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.

...

Al acceder a la URL indicada más arriba, se accederá a la sección de "Facebook for Developers" de Facebook.Se

Image Added

Debe iniciar sesión, desde el botón correspondiente:

Image Added

Al ingresar, se deberá dar clic en "Mis Apps".Image Removed

Image Added

Una vez allí, habrá que dar clic en el botón verde de "Crear app".
Image RemovedImage Added

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".

...

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.

Image RemovedImage Added

...

Aviso
title IMPORTANTE
Https obligatorio para la publicacion publicación en FacebbokFacebook 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 Alli sera requerido agregar los siguientes tags en: <security-realm name="ApplicationRealm"/> Bloco de código language xml theme Emacs title Para Promo sobre Wildfly 9 <security-realm name="ApplicationRealm"> <server-identities> <ssl> <keystore path="server.keystore" relative-to="jboss.server.config.dir" keystore-password="Promo2020" alias="jbossWildFly" key-password="Promo2020" /> </ssl> ... </server-identities> Bloco de código language xml theme Emacs title Para Promo sobre Wildfly 12 <security-realm name="ApplicationRealm"> <server-identities> <ssl> <keystore path="server.keystore" relative-to="jboss.server.config.dir" keystore-password="Promo2020" alias="jbossWildFly" key-password="Promo2020" generate-self-signed-certificate-host="localhost"/> </ssl> ... </server-identities> <server name="default-server"/> Bloco de código language xml theme Emacs <https-listener name="https" socket-binding="https" security-realm="ApplicationRealm" enable-http2="true"/> 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.

...

Parámetros de Configuración de Ambiente

En esta sección se enumeran las opciones de configuración que afectan al funcionamiento del ambiente en su totalidad y se realiza desde el archivo promoplus.properties.

...

...

1. Validar CVV solo cuando se realiza un consumo en una Tarjeta de Fidelidad

Se disponibiliza la posibilidad de poder indicar por configuracion configuración que el CVV de una tarjeta de Fidelidad solo sea validado cuando se realiza un consumo de saldos en ella.

...

Reverso de actualizaciones ante problemas en el proceso

Ante algun algún problema durante la actualizacion actualización de una version versión de consola o motor, debera de deberá  bajarse los servicios involucrados y colocar el archivo .war o .jar anterior,  segun según se trate de una actualizacion actualización de consola o motor respectivamente y volver a subir los servicios.

Luego de reesablecido reestablecido el sistema contactar a Sericios Servicios de Atencion Atención al Cliente para poner en conocimiento de lo sucedido con el proceso de actualizacionactualización

...

Apéndice A: Autenticación de Usuarios Externos (SAML2)

Por medio de la implementacion implementación en PROMO de SAML2 se lograra la integración de PROMO con un sistema de autenticacion externos autenticación externos de usuarios de la consola 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:

1. saml.properties - Archivo principal de configuraciones.
2. saml-keymanager-passwords.properties
3. saml-metadata-providers.properties - Archivo correspondiente a la configuración del proveedor de identidad.
4. 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

...

1. 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.de PROMO.

2. 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.

3. Guardar el archivo idp.xml en C:\synthesis\promo\idp.xml
4. Editar el archivo saml-metadata-providers.properties especificando allí la ruta absoluta donde se colocó el archivo idp.xml
5. Iniciar PROMO (Wildfly) con los cuatro properties correspondientes a saml.
6. Generar el xml de PROMO accediendo a http://localhost:8080/promo/saml/metadata, guardarlo en un xml (preferiblemente sp.xml).
7. Se guardó

   Guardar sp.xml

   en 

   en C:\synthesis\promo\sp.xml.

8. Editar el archivo saml.properties especificando allí la ruta absoluta donde se colocó el archivo sp.xml

9. Editar el archivo saml-metadata-sp-defaults.properties especificando la ruta de promo (por ej. http://localhost:8080/promo).

10. Detener PROMO (wildfly)
11. Borrar los directorios \temp y \data que se encuentran en el directorio \standalone de la instalacion de PROMO.
12. Iniciar PROMO(wildfy)

13. 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"
    Image Removed
    En la siguiente pantalla que se presenta presionar "Post Response"
    Image Removed
    Se presentara

    inicio de sesión del proveedor de identidad. 

14. 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
title IMPORTANTE
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.

Properties:

• 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

  
  

...