GXportal UC le permite al desarrollador GeneXus interactuar con GXportal desde su aplicación.
Se exponen funciones de uso habitual entre las que se encuentran:
-
Redimensionamiento del contenedor de la aplicación.
-
Autenticar un usuario a GXportal.
-
Cerrar la sesión de un usuario en GXportal.
-
Redireccionar a una url o catálogo.
-
Abrir un objeto de forma modal respecto a toda la página.
Instalar
Puede obtener GXportal UC desde GeneXus Marketplace o instalarlo directamente desde el IDE de GeneXus.
Compatibilidad
El UserControl funciona con las siguientes versiones de GXportal:
Propiedades
SiteDomain
Se configura la url de producción del sitio.
El valor debe coincidir con el configurado en la propiedad "Url del portal en producción" (Configuración->Panel de control->Configuración general).
Ejemplo: http://www.example.com
Es imprescindible la configuración de esta propiedad para que funcione el UserControl. Únicamente va a funcionar cuando la aplicación esté ejecutando embebida dentro de una página GXportal que ejecuta en la url base indicada en esta propiedad.
A los efectos de desarrollo se puede configurar la propiedad con el valor "*" (asterisco, sin las comillas), para que el UserControl funcione en cualquier página de GXportal sin importar la url base de la misma.
Importante: este valor no debe usarse con el valor "*" en ambientes de producción ya que la aplicación quedaría expuesta a ataques de "phishing", especialmente si se utiliza el método "Login", donde un atacante podría obtener los datos de usuario/clave ingresados por un usuario.
AutoNotifyResize
Indica que se notifique de forma automática a GXportal que hubo un cambio en el tamaño de la aplicación, de forma tal que GXportal ajuste el tamaño del GXportlet que contiene la aplicación.
Métodos
NotifyResize
Permite notificar a GXportal que hubo un cambio en el tamaño de la aplicación, de forma tal que GXportal ajuste el tamaño del GXportlet que contiene la aplicación.
Login
Permite autenticar a un usuario en GXportal.
Parámetros:
-
usuario (obligatorio) - indica el usuario.
-
contraseña (obligatorio) - indica la contraseña.
-
catálogo (opcional) - indica el Id de catálogo al cual redireccionar una vez completada la autenticación.
-
parámetros (opcional) - parámetros a pasar a aplicaciones que están integradas en la página.
Logout
Permite finalizar la sesión del usuario actual.
Parámetros:
-
catálogo (opcional) - indica el Id de catálogo al cual redireccionar una vez completado el cierre de la sesión.
-
parámetros (opcional) - parámetros a pasar a aplicaciones que están integradas en la página.
RedirectToUrl
Permite redireccionar a una url dada.
Parámetros:
-
url (obligatorio) - indica la url a la cual redireccionar.
RedirectToCatalog
Permite redireccionar a un catálogo dado.
Parámetros:
-
catálogo (obligatorio) - indica el Id de catálogo al cual redireccionar.
-
parámetros (opcional) - parámetros a pasar a aplicaciones que están integradas en la página.
OpenPopupUrl
Permite abrir una url como diálogo modal.
Parámetros:
-
url (obligatorio) - indica la url.
ClosePopup
Permite cerrar un diálogo modal.