Referencia de instalación

improve this page | report issue

Visión general

La información de referencia sobre tareas Ant y archivos de ejemplo de configuración para la instalación de IBM MobileFirst Foundation Server, IBM MobileFirst Foundation Application Center y IBM MobileFirst Foundation Operational Analytics.

Ir a

Referencia de tarea configuredatabase Ant

Información de referencia para la tarea Ant configuredatabase. Esta información de referencia es sólo para bases de datos relacionales. No se aplica a Cloudant.

La tarea Ant configuredatabase crea las bases de datos relacionales que utiliza el servicio de administración de MobileFirst Server, el servicio de Live Update de MobileFirst Server, el servicio de envío por push de MobileFirst Server, el tiempo de ejecución de MobileFirst y los servicios de Application Center. Esta tarea Ant configura una base de datos relacional a través de las siguientes acciones:

  • Comprueba si existen las tablas de MobileFirst y las crea si es necesario.
  • Si las tablas existen para una versión posterior de Mobile Foundation, las migra a la versión actual.
  • Si las tablas existen para la versión actual de Mobile Foundation, no haga nada.

Además, si se cumple una de las condiciones siguientes:

  • El tipo de DBMS será Derby.
  • Está presente un elemento interno <dba>.
  • El tipo de DBMS será DB2, y el usuario especificado tendrá los permisos para crear bases de datos.

A continuación, la tarea puede tener los efectos siguientes:

  • Cree la base de datos si es necesario (excepto para Oracle 12c y Cloudant).
  • Cree un usuario, si es necesario, y otórguele derechos de acceso a la base de datos.

Nota: La tarea Ant configuredatabase no tendrá ningún efecto si la utiliza con Cloudant.

Atributos y elementos para la tarea configuredatabase

La tarea configuredatabase tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
kind El tipo de base de datos: En MobileFirst Server: MobileFirstRuntime, MobileFirstConfig, MobileFirstAdmin, o push. En Application Center: ApplicationCenter. Ninguno
includeConfigurationTables Para especificar si se van a realizar operaciones de base de datos en el servicio de Live Update y en el servicio de administración o sólo en el servicio de administración. El valor puede ser true o false. No true
execute Para especificar si se debe ejecutar la tarea Ant configuredatabase. El valor puede ser true o false. No true

kind

Mobile Foundation da soporte a cuatro tipos de bases de datos: el tiempo de ejecución de MobileFirst utiliza la base de datos MobileFirstRuntime. El servicio de administración de MobileFirst Server utiliza la base de datos MobileFirstAdmin. El servicio de Live Update de MobileFirst Server utiliza la base de datos MobileFirstConfig. De forma predeterminada, se crea con el tipo MobileFirstAdmin. El servicio de envío por push de MobileFirst Server utiliza la base de datos push. Application Center utiliza la base de datos ApplicationCenter.

includeConfigurationTables

El atributo includeConfigurationTables sólo se puede utilizar cuando el atributo kind sea MobileFirstAdmin. El valor válido puede ser true o false. Cuando este atributo se establezca en true, la tarea configuredatabase realizará operaciones de base de datos en la base de datos de servicio de administración y en la base de datos de servicio de Live Update en una única ejecución. Cuando este atributo se establezca en false, la tarea configuredatabase realizará operaciones de base de datos sólo en la base de datos del servicio de administración.

execute

El atributo execute habilita o inhabilita la ejecución de la tarea Ant configuredatabase. El valor válido puede ser true o false. Cuando este atributo se establezca en false, la tarea configuredatabase no realizará ninguna operación de configuración ni de base de datos.

La tarea configuredatabase da soporte a los siguientes elementos:

Elemento Descripción Recuento
<derby> Los parámetros para Derby. 0..1
<db2> Los parámetros para DB2. 0..1
<mysql> Los parámetros para MySQL. 0..1
<oracle> Los parámetros para Oracle. 0..1
<driverclasspath> La vía de acceso de clase de controlador JDBC. 0..1

Para cada tipo de base de datos, puede utilizar un elemento <property> para especificar una propiedad de conexión JDBC para el acceso a la base de datos. El elemento <property> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

Apache Derby

El elemento <derby> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
database El nombre de la base de datos. No MFPDATA, MFPADM, MFPCFG, MFPPUSH, o APPCNTR, dependiendo del tipo.
datadir El directorio que contiene las bases de datos. Ninguno
schema El nombre de esquema. No MFPDATA, MFPCFG, MFPADMINISTRATOR, MFPPUSH, o APPCENTER, dependiendo del tipo.

El elemento <derby> da soporte al elemento siguiente:

Elemento Descripción Recuento
<property> La propiedad de conexión JDBC. 0..∞

Para ver las propiedades disponibles, consulte Configuración de atributos para el URL de conexión de base de datos.

DB2

El elemento <db2> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
database El nombre de la base de datos. No MFPDATA, MFPADM, MFPCFG, MFPPUSH, o APPCNTR, dependiendo del tipo.
server El nombre de host del servidor de bases de datos. Ninguno
port El puerto en el servidor de bases de datos. No 50000
user El nombre de usuario para acceder a las bases de datos. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva
instance El nombre de la instancia de DB2. No Depende del servidor
schema El nombre de esquema. No Depende del usuario

Para obtener más información sobre las cuentas de usuario de DB2, consulte Visión general del modelo de seguridad de DB2.
El elemento <db2> da soporte a los elementos siguientes:

Elemento Descripción Recuento
<property> La propiedad de conexión JDBC. 0..∞
<dba> Las credenciales del administrador de bases de datos. 0..1

Para ver las propiedades disponibles, consulte Propiedades para IBM Data Server Driver for JDBC and SQLJ.
El elemento interno <dba> especifica las credenciales para los administradores de bases de datos. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
user El nombre de usuario para acceder a la base de datos. Ninguno
password La contraseña para acceder a la base de datos. No Consultado de forma interactiva

El usuario que se especifica en un elemento <dba> debe tener el privilegio de DB2 SYSADM o SYSCTRL. Para obtener más información, consulte Visión general de Autorizaciones.

El elemento <driverclasspath> debe contener los archivos JAR correspondientes al controlador JDBC de DB2 y a la licencia asociada. Puede recuperar estos archivos de una de las siguientes formas:

  • Descargue los controladores DB2 JDBC desde la página DB2 JDBC Driver Versions
  • O capte el archivo db2jcc4.jar y sus archivos db2jcc_license_*.jar asociados desde el directorio DB2_INSTALL_DIR/java del servidor de DB2.

No puede especificar detalles de las asignaciones de tabla, como por ejemplo el espacio de tabla, utilizando la tarea Ant. Para controlar el espacio de tabla, debe utilizar las instrucciones manuales en la sección Base de datos DB2 y requisitos de usuario.

MySQL

El elemento <mysql> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
database El nombre de la base de datos. No MFPDATA, MFPADM, MFPCFG, MFPPUSH, o APPCNTR, dependiendo del tipo.
server El nombre de host del servidor de bases de datos. Ninguno
port El puerto en el servidor de bases de datos. No 3306
user El nombre de usuario para acceder a las bases de datos. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

Para obtener más información sobre las cuentas de usuario de MySQL, consulte MySQL User Account Management.
El elemento <mysql> da soporte a los elementos siguientes:

Elemento Descripción Recuento
<property> La propiedad de conexión JDBC. 0..∞
<dba> Las credenciales del administrador de bases de datos. 0..1
<client> El host que está autorizado a acceder a la base de datos. 0..∞

Para las propiedades disponibles, consulte Driver/Datasource Class Names, URL Syntax and Configuration Properties for Connector/J.
El elemento interno <dba> especifica las credenciales del administrador de bases de datos. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
user El nombre de usuario para acceder a las bases de datos. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

El usuario que se especifica en un elemento <dba> debe ser una cuenta de superusuario de MySQL. Para obtener más información, consulte Protección de cuentas iniciales de MySQL.

Cada elemento interno de <client> especifica un sistema cliente o un comodín para los sistemas cliente. Estos sistemas tienen permiso para conectarse a la base de datos. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
hostname El nombre de host simbólico, dirección IP, o plantilla con % como marcador. Ninguno

Para obtener más información sobre la sintaxis del nombre de host, consulte Cómo especificar nombres de cuenta.

El elemento <driverclasspath> debe contener un archivo JAR de MySQL Connector/J. Puede descargar dicho archivo desde la página Download Connector/J.

De forma alternativa, puede utilizar el elemento <mysql> con los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
url El URL de conexión de base de datos. Ninguno
user El nombre de usuario para acceder a las bases de datos. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

Nota: Si especifica la base de datos con atributos alternativos, esta base de datos debe existir, la cuenta de usuario debe existir, y la base de datos ya debe estar accesible para el usuario. En este caso, la tarea configuredatabase no intentará crear la base de datos ni el usuario, ni intentará otorgar acceso al usuario. La tarea configuredatabase sólo garantiza que la base de datos tenga las tablas necesarias para la versión actual de MobileFirst Server. No tiene que especificar los elementos internos <dba> ni <client>.

Oracle

El elemento <oracle> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
database El nombre de base de datos, o el nombre de servicio de Oracle. Nota: Siempre debe utilizar un nombre de servicio para conectarse a una base de datos PDB. No ORCL
server El nombre de host del servidor de bases de datos. Ninguno
port El puerto en el servidor de bases de datos. No 1521
user El nombre de usuario para acceder a las bases de datos. Consulte la nota bajo esta tabla. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva
sysPassword La contraseña para el usuario SYS. No Consultado de forma interactiva si la base de datos no existe aún
systemPassword La contraseña para el usuario SYSTEM. No Consultado de forma interactiva si la base de datos o el usuario no existe aún

Nota: Para el atributo de usuario, utilice preferiblemente un nombre de usuario en letras mayúsculas. Los nombres de usuario de Oracle están generalmente en letras mayúsculas. A diferencia de otras herramientas de base de datos, la tarea Ant configuredatabase no convierte las letras en minúscula en letras en mayúscula en el nombre de usuario. Si la tarea Ant configuredatabase no consigue conectarse a la base de datos, intente escribir el valor para el atributo user en letras mayúsculas.

Para obtener más información sobre las cuentas de usuario de Oracle, consulte Visión general de métodos de autenticación.
El elemento <oracle> da soporte a los elementos siguientes:

Elemento Descripción Recuento
<property> La propiedad de conexión JDBC. 0..∞
<dba> Las credenciales del administrador de bases de datos. 0..1

Para obtener información sobre las propiedades de conexión disponibles, consulte Clase OracleDriver.
El elemento interno <dba> especifica las credenciales del administrador de bases de datos. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
user El nombre de usuario para acceder a las bases de datos. Consulte la nota bajo esta tabla. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

El elemento <driverclasspath> debe contener un archivo JAR de controlador JDBC de Oracle. Puede descargar los controladores JDBC de Oracle desde JDBC, SQLJ, Oracle JPublisher y Universal Connection Pool (UCP).

No puede especificar detalles de asignación de tabla, como por ejemplo el espacio de tabla, utilizando la tarea Ant. Para controlar el espacio de tabla, puede crear la cuenta de usuario manualmente y asignarle un espacio de tabla predeterminado antes de ejecutar la tarea Ant. Para controlar otros detalles, debe utilizar las instrucciones manuales de la sección Base de datos Oracle y requisitos de usuario.

Atributo Descripción Obligatorio Predeterminado
url El URL de conexión de base de datos. Ninguno
user El nombre de usuario para acceder a las bases de datos. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

Nota: Si especifica la base de datos con atributos alternativos, esta base de datos debe existir, la cuenta de usuario debe existir, y la base de datos ya debe estar accesible para el usuario. En este caso, la tarea no intentará crear la base de datos ni el usuario, ni intentará otorgar acceso al usuario. La tarea configuredatabase sólo garantiza que la base de datos tenga las tablas necesarias para la versión actual de MobileFirst Server. No tiene que especificar el elemento interno <dba>.

Tareas Ant para la instalación de artefactos de MobileFirst Operations Console, MobileFirst Server, administración de MobileFirst Server y servicios de Live Update

Las tareas Ant installmobilefirstadmin, updatemobilefirstadmin, y uninstallmobilefirstadmin se proporcionan para la instalación de MobileFirst Operations Console, el componente de artefactos, el servicio de administración y el servicio de Live Update.

Efectos de tareas

installmobilefirstadmin

La tarea Ant installmobilefirstadmin configura un servidor de aplicaciones para ejecutar los archivos WAR de la administración y los servicios de Live Update como aplicaciones web y, opcionalmente, para instalar MobileFirst Operations Console. Esta tarea tiene los siguientes efectos:

  • Declara la aplicación web del servicio de administración en la raíz de contexto especificada, de forma predeterminada /mfpadmin.
  • Declara la aplicación web del servicio de Live Update en una raíz de contexto derivada de la raíz de contexto especificada del servicio de administración. De forma predeterminada, /mfpadminconfig.
  • Para las bases de datos relacionales, declara orígenes de datos y en el perfil completo de WebSphere Application Server, proveedores JDBC para los servicios de administración.
  • Despliega el servicio de administración y el servicio de Live Update en el servidor de aplicaciones.
  • Opcionalmente, declara MobileFirst Operations Console como una aplicación web en la raíz de contexto especificada, de forma predeterminada /mfpconsole. Si se especifica la instancia de MobileFirst Operations Console, la tarea Ant declara la entrada de entorno JNDI apropiada para comunicarse con el servicio de gestión correspondiente. Por ejemplo,
<target name="adminstall">
  <installmobilefirstadmin servicewar="${mfp.service.war.file}">
    <console install="${mfp.admin.console.install}" warFile="${mfp.console.war.file}"/>
  • Opcionalmente, declara la aplicación web de artefactos de MobileFirst Server en la raíz de contexto especificada /mfp-dev-artifacts cuando se instala MobileFirst Operations Console.
  • Configura las propiedades de configuración para el servicio de administración utilizando entradas de entorno JNDI. Estas entradas de entorno JNDI también dan alguna información adicional sobre la topología del servidor de aplicaciones, por ejemplo si la topología es una configuración autónoma, un clúster, o una granja de servidores.
  • Opcionalmente, configura usuarios que correlaciona con roles utilizados por MobileFirst Operations Console, y la administración y las aplicaciones web de servicios de Live Update.
  • Configura el servidor de aplicaciones para el uso de JMX.
  • Opcionalmente, configura la comunicación con el servicio de envío por push de MobileFirst Server.
  • Opcionalmente, establece las entradas de entorno JNDI de MobileFirst para configurar el servidor de aplicaciones como un miembro de la granja de servidores para el componente de administración de MobileFirst Server.

updatemobilefirstadmin

La tarea Ant updatemobilefirstadmin actualiza una aplicación web MobileFirst Server ya configurada en un servidor de aplicaciones. Esta tarea tiene los siguientes efectos:

  • Actualiza el archivo WAR del servicio de administración. Este archivo debe tener el mismo nombre base que el archivo WAR correspondiente desplegado anteriormente.
  • Actualiza el archivo WAR del servicio de Live Update. Este archivo debe tener el mismo nombre base que el archivo WAR correspondiente desplegado anteriormente.
  • Actualiza el archivo WAR de MobileFirst Operations Console. Este archivo debe tener el mismo nombre base que el archivo WAR correspondiente desplegado anteriormente. La tarea no cambia la configuración del servidor de aplicaciones, es decir, la configuración de la aplicación web, los orígenes de datos, las entradas de entorno JNDI, las correlaciones de usuario a rol ni la configuración de JMX.

uninstallmobilefirstadmin

La tarea Ant uninstallmobilefirstadmin deshace los efectos de una ejecución anterior de installmobilefirstadmin. Esta tarea tiene los siguientes efectos:

  • Elimina la configuración de la aplicación web del servicio de administración con la raíz de contexto especificada. Como consecuencia, la tarea también elimina los valores que se han añadido manualmente a dicha aplicación.
  • Elimina los archivos WAR de la administración y de los servicios de Live Update, y MobileFirst Operations Console desde el servidor de aplicaciones como una opción.
  • Para el DBMS relacional, elimina los orígenes de datos y en el perfil completo de WebSphere Application Server los proveedores JDBC para la administración y los servicios de Live Update.
  • Para el DBMS relacional, elimina los controladores de base de datos que utilizaron la administración y los servicios de Live Update desde el servidor de aplicaciones.
  • Elimina las entradas de entorno JNDI asociadas.
  • En WebSphere Application Server Liberty y Apache Tomcat, elimina los usuarios configurados por la invocación de installmobilefirstadmin.
  • Elimina la configuración de JMX.

Atributos y elementos

Las tareas Ant installmobilefirstadmin, updatemobilefirstadmin, y uninstallmobilefirstadmin tienen los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
contextroot El prefijo común para URL en el servicio de administración para obtener información sobre los entornos de tiempo de ejecución, las aplicaciones y los adaptadores de MobileFirst. No /mfpadmin
id Para distinguir los distintos despliegues. No Vacío
environmentId Para distinguir los distintos entornos de MobileFirst. No Vacío
servicewar El archivo WAR para el servicio de administración. No El archivo mfp-admin-service.war se encuentra en el mismo directorio que el archivo mfp-ant-deployer.jar.
shortcutsDir El directorio donde se colocarán los atajos. No Ninguno
wasStartingWeight El orden de inicio para WebSphere Application Server. Los valores inferiores comenzarán en primer lugar. No 1

contextroot e id

Los atributos contextroot e id distinguen los diferentes despliegues de MobileFirst Operations Console y el servicio de administración.

En los perfiles de WebSphere Application Server Liberty y en los entornos de Tomcat, el parámetro contextroot es suficiente para esta finalidad. En los entornos de perfil completo de WebSphere Application Server, se utilizará el atributo id en su lugar. Sin este atributo id, pueden entrar en conflicto dos archivos WAR con las mismas raíces de contexto y es posible que estos archivos no se desplieguen.

environmentId

Utilice el atributo environmentId para distinguir varios entornos, cada uno de los cuales consta del servicio de administración de MobileFirst Server y de las aplicaciones web de tiempo de ejecución de MobileFirst, que deben funcionar independientemente. Por ejemplo, con esta opción puede alojar un entorno de prueba, un entorno de preproducción y un entorno de producción en el mismo servidor o en la misma célula de WebSphere Application Server Network Deployment. Este atributo environmentId crea un sufijo que se añade a los nombres de MBean que utiliza el servicio de administración y los proyectos de tiempo de ejecución de MobileFirst cuando se comunican mediante Java Management Extensions (JMX).

servicewar

Utilice el atributo servicewar para especificar un directorio distinto para el archivo WAR del servicio de administración. Puede especificar el nombre de este archivo WAR con una vía de acceso absoluta o relativa.

shortcutsDir

El atributo shortcutsDir especifica dónde colocar atajos en la MobileFirst Operations Console. Si establece este atributo, puede añadir los archivos siguientes a dicho directorio:

  • mobilefirst-console.url: este archivo es un atajo de Windows. Abre la MobileFirst Operations Console en un navegador.
  • mobilefirst-console.sh: este archivo es un script de shell de UNIX y abre la MobileFirst Operations Console en un navegador.
  • mobilefirst-admin-service.url: este archivo es un atajo de Windows. Se abre en un navegador y llama a un servicio REST que devuelve una lista de los proyectos de MobileFirst que se pueden gestionar en formato JSON. Para cada proyecto en la lista de MobileFirst, también hay disponibles algunos detalles sobre sus artefactos, como el número de aplicaciones, de adaptadores, de dispositivos activos, de dispositivos fuera de servicio. La lista también indica si el tiempo de ejecución del proyecto de MobileFirst está en ejecución o no.
  • mobilefirst-admin-service.sh: este archivo es un script de shell de UNIX que proporciona el mismo resultado que el archivo mobilefirst-admin-service.url.

wasStartingWeight

Utilice el atributo wasStartingWeight para especificar un valor que se utiliza en WebSphere Application Server como un peso para asegurarse de que se respeta un orden de inicio. Como resultado del valor de orden de inicio, la aplicación web del servicio de administración se desplegará y se iniciará antes de cualquier otro proyecto de tiempo de ejecución de MobileFirst. Si los proyectos de MobileFirst se despliegan o se inician antes de la aplicación web, no se establecerá la comunicación de JMX y el tiempo de ejecución no se podrá sincronizar con la base de datos del servicio de administración y no podrá manejar las solicitudes del servidor.

Las tareas Ant installmobilefirstadmin, updatemobilefirstadmin, y uninstallmobilefirstadmin dan soporte a los elementos siguientes:

Elemento Descripción Recuento
<applicationserver> El servidor de aplicaciones. 1
<configuration> El servicio de Live Update. 1
<console> La consola de administración. 0..1
<database> Las bases de datos. 1
<jmx> Para habilitar Java Management Extensions. 1
<property> Las propiedades. 0..
<push> El servicio de envío por push. 0..1
<user> El usuario que se correlacionará con un rol de seguridad. 0..

Para especificar una MobileFirst Operations Console

El elemento <console> recopila información para personalizar la instalación de MobileFirst Operations Console. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
contextroot El URI de la MobileFirst Operations Console. No /mfpconsole
install Para indicar si se debe instalar la MobileFirst Operations Console. No
warfile El archivo WAR de la consola. No El archivo mfp-admin-ui.war se encuentra en el mismo directorio que el archivo themfp-ant-deployer.jar.

El elemento <console> da soporte al elemento siguiente:

Elemento Descripción Recuento
<artifacts> Los artefactos de MobileFirst Server. 0..1
<property> Las propiedades. 0..

El elemento <artifacts> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
install Para indicar si se debe instalar el componente de artefactos. No true
warFile El archivo WAR de artefactos. No El archivo mfp-dev-artifacts.war se encuentra en el mismo directorio que el archivo mfp-ant-deployer.jar

Al utilizar este elemento, puede definir sus propias propiedades JNDI o sobrescribir el valor predeterminado de las propiedades JNDI que proporciona el servicio de administración y los archivos WAR de MobileFirst Operations Console.

El elemento <property> especifica una propiedad de despliegue que se va a definir en el servidor de aplicaciones. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

Al utilizar este elemento, puede definir sus propias propiedades JNDI o sobrescribir el valor predeterminado de las propiedades JNDI que proporciona el servicio de administración y los archivos WAR de MobileFirst Operations Console.

Para obtener más información sobre las propiedades JNDI, consulte Lista de propiedades JNDI para el servicio de administración de MobileFirst Server.

Para especificar un servidor de aplicaciones

Utilice el elemento <applicationserver> para definir los parámetros que dependen del servidor de aplicaciones subyacente. El elemento <applicationserver> da soporte a los elementos siguientes.

Elemento Descripción Recuento
<websphereapplicationserver> o <was> Los parámetros para WebSphere Application Server.

El elemento <websphereapplicationserver> (o was> en su forma abreviada) indica una instancia de WebSphere Application Server. Se da soporte al perfil completo de WebSphere Application Server (Base, y Network Deployment), por lo que es WebSphere Application Server Liberty Core y WebSphere Application Server Liberty Network Deployment.
0..1
<tomcat> Los parámetros para Apache Tomcat. 0..1

Los atributos y los elementos internos de estos elementos están descritos en las tablas de Tareas Ant para la instalación de entornos de ejecución de MobileFirst.
Sin embargo, para el elemento interno del elemento <was> del colectivo de Liberty, consulte la tabla siguiente:

Elemento Descripción Recuento
<collectiveController> Un controlador colectivo de Liberty. 0..1

El elemento <collectiveController> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
serverName El nombre del controlador colectivo. Ninguno
controllerAdminName El nombre de usuario administrativo definido en el controlador colectivo. Este es el mismo usuario que se utiliza para unirse a nuevos miembros en el colectivo. Ninguno
controllerAdminPassword La contraseña de usuario administrativo. Ninguno
createControllerAdmin Para indicar si el usuario administrativo debe crearse en el registro básico del controlador colectivo. Los valores posibles son true o false. No true

Para especificar la configuración del servicio de Live Update

Utilice el elemento <configuration> para definir los parámetros que dependen del servicio de actualización activo. El elemento <configuration> tiene los atributos siguientes.

Atributo Descripción Obligatorio Predeterminado
install Para indicar si se debe instalar el servicio de Live Update. true
configAdminUser El administrador para el servicio de Live Update. No. Sin embargo, es necesario para una topología de granja de servidores. Si no está definido, se generará un usuario. En una topología de granja de servidores, el nombre de usuario debe ser el mismo para todos los miembros de la granja de servidores.
configAdminPassword La contraseña del administrador para el usuario de servicio de Live Update. Si se especifica un usuario para configAdminUser. Ninguno. En una topología de granja de servidores, la contraseña debe ser el mismo para todos los miembros de la granja de servidores.
createConfigAdminUser Para indicar si se creará un usuario admin en el registro básico del servidor de aplicaciones, si falta. No true
warFile El archivo WAR del servicio de Live Update. No El archivo mfp-live-update.war se encuentra en el mismo directorio que el archivo mfp-ant-deployer.jar.

El elemento <configuration> da soporte a los elementos siguientes:

Elemento Descripción Recuento
<user> El usuario para el servicio de Live Update. 0..1
<property> Las propiedades. 0..

El elemento <user> recopila los parámetros sobre un usuario para inclulos en un determinado rol de seguridad para una aplicación.

Atributo Descripción Obligatorio Predeterminado
role Un rol de seguridad válido para la aplicación. Valor posible: configadmin. Ninguno
name El nombre de usuario. Ninguno
password La contraseña si el usuario debe crearse. No Ninguno

Después de definir los usuarios mediante el elemento <user>, puede correlacionarlos con cualquiera de los roles siguientes para la autenticación en MobileFirst Operations Console: configadmin.

Para obtener más información sobre qué autorizaciones están implícitas mediante los roles específicos, consulte Configuración de la autenticación de usuario para la administración de MobileFirst Server.

Consejo: Si los usuarios existen en un directorio LDAP externo, establezca sólo los atributos role y name pero no defina ninguna contraseña.

El elemento <property> especifica una propiedad de despliegue que se va a definir en el servidor de aplicaciones. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

Al utilizar este elemento, puede definir sus propias propiedades JNDI o sobrescribir el valor predeterminado de las propiedades JNDI que proporciona el servicio de administración y los archivos WAR de MobileFirst Operations Console. Para obtener más información sobre las propiedades JNDI, consulte Lista de propiedades JNDI para el servicio de administración de MobileFirst Server.

Para especificar un servidor de aplicaciones

Utilice el elemento <applicationserver> para definir los parámetros que dependen del servidor de aplicaciones subyacente. El elemento <applicationserver> da soporte a los elementos siguientes:

Elemento Descripción Recuento
<websphereapplicationserver> o <was> Los parámetros para WebSphere Application Server.

El elemento (o en su forma abreviada) indica una instancia de WebSphere Application Server. Se da soporte al perfil completo de WebSphere Application Server (Base, y Network Deployment), por lo que es WebSphere Application Server Liberty Core y WebSphere Application Server Liberty Network Deployment.
0..1
<tomcat> Los parámetros para Apache Tomcat. 0..1

Los atributos y los elementos internos de estos elementos están descritos en las tablas de Tareas Ant para la instalación de entornos de ejecución de MobileFirst.
Sin embargo, para el elemento interno del elemento para el colectivo de Liberty, consulte la tabla siguiente:

Elemento Descripción Recuento
<collectiveMember> Un miembro de colectivo de Liberty. 0..1

El elemento <collectiveMember> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
serverName El nombre del miembro de colectivo. Ninguno
clusterName El nombre de clúster al que pertenece el miembro de colectivo. Ninguno

Nota: Si el servicio de envío por push y los componentes de tiempo de ejecución están instalados en el mismo miembro de colectivo, deben tener el mismo nombre de clúster. Si estos componentes están instalados en miembros distintos del mismo colectivo, los nombres de clúster pueden ser distintos.

Para especificar Analytics

El elemento <analytics> indica que desea conectar el servicio push MobileFirst a un servicio de MobileFirst Analytics ya instalado. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
install Para indicar si se debe conectar el servicio de envío por push a MobileFirst Analytics. No false
analyticsURL El URL de los servicios de MobileFirst Analytics. Ninguno
username El nombre de usuario. Ninguno
password La contraseña. Ninguno
validate Para validar si se puede acceder a MobileFirst Analytics Console o no. No true

install
Utilice el atributo install para indicar que este servicio de envío por push debe estar conectado y debe enviar sucesos a MobileFirst Analytics. Los valores válidos son true o false.

analyticsURL
Utilice el atributo analyticsURL para especificar el URL expuesto por MobileFirst Analytics, que recibe datos analíticos entrantes.

Por ejemplo: http://<hostname>:<port>/analytics-service/rest

username
Utilice el atributo username para especificar el nombre de usuario que se utilizará si el punto de entrada de datos para MobileFirst Analytics está protegido con autenticación básica.

password
Utilice el atributo password para especificar la contraseña que se utilizará si el punto de entrada de datos para MobileFirst Analytics está protegido con autenticación básica.

validate
Utilice el atributo validate para validar si se puede acceder a MobileFirst Analytics Console o no, y para comprobar la autenticación de nombre de usuario con una contraseña. Los valores posibles son true, o false.

Para especificar una conexión con la base de datos de servicio de envío por push

El elemento <database> recopila los parámetros que especifican una declaración de origen de datos en un servidor de aplicaciones para acceder a la base de datos del servicio push.

Debe declarar una única base de datos: <database kind="Push">. Especifique el elemento <database> de forma parecida a la tarea de Ant configuredatabase, excepto en que el elemento <database> no tiene los elementos <dba> y <client>. Es posible que tenga elementos <property>.

El elemento <database> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
kind El tipo de base de datos (Push). Ninguno
validate Para validar si se puede acceder a la base de datos. No true

El elemento <database> da soporte a los elementos siguientes.Para obtener más información sobre la configuración de estos elementos de base de datos para DBMS relacional, consulte las tablas de tareas Ant para la instalación de entornos de ejecución de MobileFirst.

Elemento Descripción Recuento
El parámetro para bases de datos DB2. 0..1
El parámetro para bases de datos Apache Derby. 0..1
El parámetro para bases de datos MySQL. 0..1
El parámetro para bases de datos Oracle. 0..1
El parámetro para bases de datos Cloudant. 0..1
El parámetro para la vía de acceso de la clase de controlador JDBC (sólo DBMS relacional). 0..1

Nota: Los atributos del elemento <cloudant> son ligeramente distintos de los de tiempo de ejecución. Para obtener más información, consulte la siguiente tabla:

Atributo Descripción Obligatorio Predeterminado
url El URL de la cuenta de Cloudant. No https://user.cloudant.com
user El nombre de usuario de la cuenta de Cloudant. Ninguno
password La contraseña de la cuenta de Cloudant. No Consultado de forma interactiva
dbName El nombre de base de datos de Cloudant. Importante: Este nombre de base de datos debe comenzar por una letra en minúscula y contener sólo caracteres en minúscula (a-z), dígitos (0-9), cualquiera de los caracteres _, $, y -. No mfp_push_db

Tareas Ant para la instalación del servicio de envío por push de MobileFirst Server

Las tareas Ant installmobilefirstpush, updatemobilefirstpush, y uninstallmobilefirstpush se proporcionan para la instalación del servicio de envío por push.

Efectos de tareas

installmobilefirstpush

La tarea Ant installmobilefirstpush configura un servidor de aplicaciones para ejecutar el archivo WAR del servicio de envío por push como una aplicación web. Esta tarea tiene los siguientes efectos: Declara la aplicación web del servicio de envío por push en la raíz de contexto /imfpush. La raíz de contexto no se puede modificar. Para las bases de datos relacionales, declara los orígenes de datos y, en el perfil completo de WebSphere Application Server, los proveedores JDBC para servicio de envío por push. Configura las propiedades de configuración para el servicio de envío por push utilizando entradas de entorno JNDI. Estas entradas de entorno JNDI configuran la comunicación de OAuth con el servidor de autorizaciones de MobileFirst, MobileFirst Analytics, y con Cloudant en caso de que se utilice Cloudant.

updatemobilefirstpush

La tarea Ant updatemobilefirstpush actualiza una aplicación web de MobileFirst Server ya configurada en un servidor de aplicaciones. Esta tarea actualiza el archivo WAR del servicio de envío por push. Este archivo debe tener el mismo nombre base que el archivo WAR correspondiente desplegado anteriormente.

uninstallmobilefirstpush

La tarea Ant uninstallmobilefirstpush deshace los efectos de una ejecución anterior de installmobilefirstpush. Esta tarea tiene los siguientes efectos: Elimina la configuración de la aplicación web del servicio de envío por push con la raíz de contexto especificada. Como consecuencia, la tarea también elimina los valores que se han añadido manualmente a dicha aplicación. Elimina el archivo WAR del servicio de envío por push del servidor de aplicaciones como una opción. Para DBMS relacional, elimina los orígenes de datos y, en el perfil completo de WebSphere Application Server, los proveedores JDBC para el servicio de envío por push. Elimina las entradas de entorno JNDI asociadas.

Atributos y elementos

Las tareas Ant installmobilefirstpush, updatemobilefirstpush, y uninstallmobilefirstpush tienen los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
id Para distinguir los distintos despliegues. No Vacío
warFile El archivo WAR para el servicio de envío por push. No El archivo ../PushService/mfp-push-service.war es relativo al directorio MobileFirstServer que contiene el archivo mfp-ant-deployer.jar.

Id

El atributo id distingue distintos despliegues del servicio de envío por push en la misma célula de WebSphere Application Server. Sin este atributo id, pueden entrar en conflicto dos archivos WAR con las mismas raíces de contexto y es posible que estos archivos no se desplieguen.

warFile

Utilice el atributo warFile para especificar un directorio distinto para el archivo WAR del servicio de envío por push. Puede especificar el nombre de este archivo WAR con una vía de acceso absoluta o relativa.

Las tareas Ant installmobilefirstpush, updatemobilefirstpush, y uninstallmobilefirstpush dan soporte a los siguientes elementos:

Elemento Descripción Recuento
<applicationserver> El servidor de aplicaciones. 1
<analytics> Analytics. 0..1
<authorization> El servidor de autorizaciones para autenticar la comunicación con otros componentes MobileFirst Server. 1
<database> Las bases de datos. 1
<property> Las propiedades. 0..∞

Para especificar el servidor de autorizaciones

El elemento <authorization> recopila información para configurar el servidor de autorización para la comunicación de autenticación con otros componentes de MobileFirst Server. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
auto Para indicar si el URL del servidor de autorizaciones está calculado. Los valores posibles son true o false. Necesario en un clúster o en un nodo de WebSphere Application Server Network Deployment. true
authorizationURL El URL del servidor de autorizaciones. Si la modalidad no es auto. La raíz de contexto del tiempo de ejecución en el servidor local.
runtimeContextRoot La raíz de contexto del tiempo de ejecución. No /mfp
pushClientID El ID confidencial del servicio de envío por push del servidor de autorizaciones. Ninguno
pushClientSecret La contraseña de cliente confidencial del servicio de envío por push del servidor de autorizaciones. Ninguno

auto

Si el valor se establece en true, el URL del servidor de autorizaciones se calculará automáticamente utilizando la raíz de contexto del tiempo de ejecución en el servidor de aplicaciones local. La modalidad automática no estará soportada si despliega en WebSphere Application Server Network Deployment en un clúster.

authorizationURL

El URL del servidor de autorizaciones. Si el servidor de autorizaciones es el tiempo de ejecución de MobileFirst, el URL es el del tiempo de ejecución. Por ejemplo: http://myHost:9080/mfp.

runtimeContextRoot

La raíz de contexto del tiempo de ejecución que se utiliza para calcular el URL del servidor de autorizaciones en la modalidad automática.

pushClientID

El ID de esta instancia del servicio de envío por push como cliente confidencial del servidor de autorizaciones. El ID y el secreto deben estar registrados para el servidor de autorizaciones. Pueden estar registrados por la tarea Ant installmobilefirstadmin, o desde MobileFirst Operations Console.

pushClientSecret

La clave secreta de esta instancia de servicio de envío por push como cliente confidencial del servidor de autorizaciones. El ID y el secreto deben estar registrados para el servidor de autorizaciones. Pueden estar registrados por la tarea Ant installmobilefirstadmin, o desde MobileFirst Operations Console.

El elemento <property> especifica una propiedad de despliegue que se va a definir en el servidor de aplicaciones. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

Al utilizar este elemento, puede definir sus propias propiedades JNDI o sobrescribir el valor predeterminado de las propiedades JNDI que proporciona el archivo WAR del servicio de envío por push.

Para obtener más información sobre las propiedades JNDI, consulte Lista de propiedades JNDI para el servicio de envío por push de MobileFirst Server.

Para especificar un servidor de aplicaciones

Utilice el elemento <applicationserver> para definir los parámetros que dependen del servidor de aplicaciones subyacente. El elemento <applicationserver> da soporte a los elementos siguientes:

Elemento Descripción Recuento  
o Los parámetros para WebSphere Application Server. El elemento <websphereapplicationserver> (o <was> en su forma abreviada) indica una instancia de WebSphere Application Server. Se da soporte al perfil completo de WebSphere Application Server (Base, y Network Deployment), por lo que es WebSphere Application Server Liberty Core y WebSphere Application Server Liberty Network Deployment. 0..1
<tomcat> Los parámetros para Apache Tomcat. 0..1  

Los atributos y los elementos internos de estos elementos están descritos en las tablas de Tareas Ant para la instalación de entornos de ejecución de MobileFirst.

Sin embargo, para el elemento interno del elemento <was> del colectivo de Liberty, consulte la tabla siguiente:

Elemento Descripción Recuento
<collectiveMember> Un miembro de colectivo de Liberty. 0..1

El elemento <collectiveMember> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
serverName El nombre del miembro de colectivo. Ninguno
clusterName El nombre de clúster al que pertenece el miembro de colectivo. Ninguno

Nota: Si el servicio de envío por push y los componentes de tiempo de ejecución están instalados en el mismo miembro de colectivo, deben tener el mismo nombre de clúster. Si estos componentes están instalados en miembros distintos del mismo colectivo, los nombres de clúster pueden ser distintos.

Para especificar Analytics

El elemento <analytics> indica que desea conectar el servicio push MobileFirst a un servicio de MobileFirst Analytics ya instalado. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
install Para indicar si se debe conectar el servicio de envío por push a MobileFirst Analytics. No false
analyticsURL El URL de los servicios de MobileFirst Analytics. Ninguno
username El nombre de usuario. Ninguno
password La contraseña. Ninguno
validate Para validar si se puede acceder a MobileFirst Analytics Console o no. No true

install

Utilice el atributo install para indicar que este servicio de envío por push debe estar conectado y enviar sucesos a MobileFirst Analytics. Los valores válidos son true o false.

analyticsURL

Utilice el atributo analyticsURL para especificar el URL expuesto por MobileFirst Analytics, que recibe datos analíticos entrantes.
Por ejemplo: http://<hostname>:<port>/analytics-service/rest

username

Utilice el atributo username para especificar el nombre de usuario que se utilizará si el punto de entrada de datos para MobileFirst Analytics está protegido con autenticación básica.

password

Utilice el atributo password para especificar la contraseña que se utilizará si el punto de entrada de datos para MobileFirst Analytics está protegido con autenticación básica.

validate

Utilice el atributo validate para validar si se puede acceder a la MobileFirst Analytics Console o no, y para comprobar la autenticación del nombre de usuario con una contraseña. Los valores posibles son true, o false.

Para especificar una conexión con la base de datos de servicio de envío por push

El elemento <database> recopila los parámetros que especifican una declaración de origen de datos en un servidor de aplicaciones para acceder a la base de datos del servicio push.

Debe declarar una única base de datos: <database kind="Push">. Especifique el elemento <database> de forma parecida a la tarea de Ant configuredatabase, excepto en que el elemento <database> no tiene los elementos <dba> y <client>. Es posible que tenga elementos <property>.

El elemento <database> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
kind El tipo de base de datos (Push). Ninguno
validate Para validar si se puede acceder a la base de datos. No true

El elemento <database> da soporte a los elementos siguientes.Para obtener más información sobre la configuración de estos elementos de base de datos para DBMS relacionales, consulte las tablas de las tareas Ant para la instalación de los entornos de ejecución de MobileFirst.

Elemento Descripción Recuento
<db2> El parámetro para bases de datos DB2. 0..1
<derby> El parámetro para bases de datos Apache Derby. 0..1
<mysql> El parámetro para bases de datos MySQL. 0..1
<oracle> El parámetro para bases de datos Oracle. 0..1
<cloudant> El parámetro para bases de datos Cloudant. 0..1
<driverclasspath> El parámetro para la vía de acceso de la clase de controlador JDBC (sólo DBMS relacional). 0..1

Nota: Los atributos del elemento <cloudant> son ligeramente distintos de los de tiempo de ejecución. Para obtener más información, consulte la siguiente tabla:

Atributo Descripción Obligatorio Predeterminado
url El URL de la cuenta de Cloudant. No https://user.cloudant.com
user El nombre de usuario de la cuenta de Cloudant. Ninguno
password La contraseña de la cuenta de Cloudant. No Consultado de forma interactiva
dbName El nombre de base de datos de Cloudant. Importante: Este nombre de base de datos debe comenzar por una letra en minúscula y contener sólo caracteres en minúscula (a-z), dígitos (0-9), cualquiera de los caracteres _, $, y -. No mfp_push_db

Tareas Ant para la instalación de entornos de ejecución de MobileFirst

Información de referencia para las tareas Ant installmobilefirstruntime, updatemobilefirstruntime, y uninstallmobilefirstruntime.

Efectos de tareas

installmobilefirstruntime

La tarea Ant installmobilefirstruntime configura un servidor de aplicaciones para ejecutar un archivo WAR de tiempo de ejecución de MobileFirst como una aplicación web. Esta tarea tiene los siguientes efectos.

  • Declara la aplicación web de MobileFirst en la raíz de contexto especificada, de forma predeterminada /mfp.
  • Despliega el archivo WAR de tiempo de ejecución en el servidor de aplicaciones.
  • Declara orígenes de datos y en el perfil completo de WebSphere Application Server, los proveedores JDBC para el tiempo de ejecución.
  • Despliega los controladores de base de datos en el servidor de aplicaciones.
  • Establece propiedades de configuración de MobileFirst mediante entradas de entorno de JNDI.
  • Opcionalmente, establece las entradas de entorno JNDI de MobileFirst para configurar el servidor de aplicaciones como miembro de la granja de servidores para el tiempo de ejecución.

updatemobilefirstruntime

La tarea Ant updatemobilefirstruntime actualiza un tiempo de ejecución de MobileFirst que ya está configurado en un servidor de aplicaciones. Esta tarea actualiza el archivo WAR de tiempo de ejecución. El archivo debe tener el mismo nombre base que el archivo WAR de tiempo de ejecución que se desplegó anteriormente. Aparte de esto, la tarea no cambia la configuración del servidor de aplicaciones, es decir, la configuración de la aplicación web, de los orígenes de datos ni las entradas de entorno JNDI.

uninstallmobilefirstruntime

La tarea Ant uninstallmobilefirstruntime deshace los efectos de una ejecución anterior de installmobilefirstruntime. Esta tarea tiene los siguientes efectos.

  • Elimina la configuración de la aplicación web de MobileFirst con la raíz de contexto especificada. La tarea también elimina los valores añadidos manualmente a dicha aplicación.
  • Elimina el archivo WAR de tiempo de ejecución del servidor de aplicaciones.
  • Elimina los orígenes de datos y en el perfil completo de WebSphere Application Server, los proveedores JDBC para el tiempo de ejecución.
  • Elimina las entradas de entorno JNDI asociadas.

Atributos y elementos

Las tareas Ant installmobilefirstruntime, updatemobilefirstruntime, y uninstallmobilefirstruntime tienen los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado  
contextroot El prefijo común en los URL con la aplicación (raíz de contexto). No /mfp  
id Para distinguir los distintos despliegues. No Vacío  
environmentId Para distinguir los distintos entornos de MobileFirst. No Vacío  
warFile El archivo WAR para el tiempo de ejecución de MobileFirst. No El archivo mfp-server.war se encuentra en el mismo directorio que el archivo mfp-ant-deployer.jar.  
wasStartingWeight El orden de inicio para WebSphere Application Server. Los valores inferiores comenzarán en primer lugar. No 2  

contextroot e id

Los atributos contextroot e id distinguen entre los distintos proyectos de MobileFirst.

En los perfiles de WebSphere Application Server Liberty y en los entornos de Tomcat, el parámetro contextroot es suficiente para esta finalidad. En los entornos de perfil completo de WebSphere Application Server, se utilizará el atributo id en su lugar.

environmentId

Utilice el atributo environmentId para distinguir varios entornos, cada uno de los cuales consta del servicio de administración de MobileFirst Server y de las aplicaciones web de tiempo de ejecución de MobileFirst, que deben funcionar independientemente. Debe establecer este atributo en el mismo valor para la aplicación de ejecución que el que se estableció en la invocación de , para la aplicación del servicio de administración.

warFile

Utilice el atributo warFile para especificar un directorio distinto para el archivo WAR de tiempo de ejecución de MobileFirst. Puede especificar el nombre de este archivo WAR con una vía de acceso absoluta o relativa.

wasStartingWeight

Utilice el atributo wasStartingWeight para especificar un valor que se utiliza en WebSphere Application Server como un peso para asegurarse de que se respeta un orden de inicio. Como resultado del valor de la orden de inicio, se desplegará la aplicación web del servicio de administración de MobileFirst Server y se iniciará antes que cualquier otro proyecto de tiempo de ejecución de MobileFirst. Si los proyectos de MobileFirst se despliegan o se inician antes que la aplicación web, no se establece la comunicación de JMX y no podrá gestionar los proyectos de MobileFirst.

Las tareas installmobilefirstruntime, updatemobilefirstruntime, y uninstallmobilefirstruntime dan soporte a los siguientes elementos:

Elemento Descripción Recuento
<property> Las propiedades. 0..
<applicationserver> El servidor de aplicaciones. 1
<database> Las bases de datos. 1
<analytics> Las analíticas. 0..1

El elemento <property> especifica una propiedad de despliegue que se va a definir en el servidor de aplicaciones. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

El elemento <applicationserver> describe el servidor de aplicaciones en el que se despliega la aplicación MobileFirst. Es un contenedor para uno de los elementos siguientes:

Elemento Descripción Recuento
<websphereapplicationserver> o <was> Los parámetros para WebSphere Application Server. 0..1
<tomcat> Los parámetros para Apache Tomcat. 0..1

El elemento <websphereapplicationserver> (o <was> en su forma abreviada) indica una instancia de WebSphere Application Server. Se da soporte al perfil completo de WebSphere Application Server (Base, y Network Deployment), por lo que es WebSphere Application Server Liberty Core y WebSphere Application Server Liberty Network Deployment. El elemento <websphereapplicationserver> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado  
installdir Directorio de instalación de WebSphere Application Server. Ninguno  
profile Perfil de WebSphere Application Server, o Liberty. Ninguno  
user Nombre del administrador de WebSphere Application Server. Sí, excepto para Liberty Ninguno  
password Contraseña del administrador de WebSphere Application Server. No Consultado de forma interactiva  
libertyEncoding El algoritmo para codificar las contraseñas de origen de datos para WebSphere Application Server Liberty. Los valores posibles son none, xor, y aes. Ya se utilice la codificación xor o aes, se pasará la contraseña borrada como argumento al programa securityUtility, que se llamará a través de un proceso externo. Puede ver la contraseña con un mandato ps, o en el sistema de archivos /proc en sistemas operativos UNIX. No xor  
jeeVersion Para el perfil de Liberty. Para especificar si se instalarán las características del perfil web de JEE6 o del perfil web de JEE7. Los valores posibles son 6, 7, o auto. No auto  
configureFarm Para WebSphere Application Server Liberty, y el perfil completo de WebSphere Application Server (no para la edición de WebSphere Application Server Network Deployment ni el colectivo de Liberty). Para especificar si el servidor es un miembro de la granja de servidores. Los valores posibles son true o false. No false  
farmServerId Una serie que identifica de forma exclusiva un servidor de la granja de servidores. Los servicios de administración de MobileFirst Server y todos los tiempos de ejecución de MobileFirst que se comunican con él deben compartir el mismo valor. Ninguno  

Da soporte al elemento siguiente para el despliegue en un solo servidor:

Elemento Descripción Recuento
<server> Un único servidor. 0..1

El elemento , que se utiliza en este contexto, tiene el atributo siguiente:

Atributo Descripción Obligatorio Predeterminado
name El nombre del servidor. Ninguno

Se da soporte a los siguientes elementos para el colectivo de Liberty:

Elemento Descripción Recuento
<collectiveMember> Un miembro de colectivo de Liberty. 0..1

El elemento <collectiveMember> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
serverName El nombre del miembro de colectivo. Ninguno
clusterName El nombre de clúster al que pertenece el miembro de colectivo. Ninguno
serverId Un serie que identifica de forma exclusiva al miembro de colectivo. Ninguno
controllerHost El nombre del controlador colectivo. Ninguno
controllerHttpsPort El puerto HTTPS del controlador colectivo. Ninguno
controllerAdminName El nombre de usuario administrativo definido en el controlador colectivo. Este es el mismo usuario que se utiliza para unirse a nuevos miembros en el colectivo. Ninguno
controllerAdminPassword La contraseña de usuario administrativo. Ninguno
createControllerAdmin Para indicar si se debe crear el usuario administrativo en el registro básico del miembro de colectivo. Los valores posibles son true o false. No true

Se da soporte a los siguientes elementos para Network Deployment:

Elemento Descripción Recuento
<cell> La célula completa. 0..1
<cluster> Todos los servidores de un clúster. 0..1
<node> Todos los servidores de un nodo, clústeres excluidos. 0..1
<server> Un único servidor. 0..1

El elemento <cell> no tiene atributos.

El elemento <cluster> tiene el atributo siguiente:

Atributo Descripción Obligatorio Predeterminado
name El nombre de clúster. Ninguno

El elemento <node> tiene el atributo siguiente:

Atributo Descripción Obligatorio Predeterminado
name El nombre de nodo. Ninguno

El elemento <server>, que se utiliza en un contexto de Network Deployment, tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
nodeName El nombre de nodo. Ninguno
serverName El nombre del servidor. Ninguno

El elemento <tomcat> indica un servidor Apache Tomcat. Tiene el atributo siguiente:

Atributo Descripción Obligatorio Predeterminado
installdir El directorio de instalación de Apache Tomcat. Para una instalación de Tomcat que se divide entre un directorio CATALINA_HOME y un directorio CATALINA_BASE, especifique el valor de la variable de entorno CATALINA_BASE. Ninguno
configureFarm Para especificar si el servidor es un miembro de la granja de servidores. Los valores posibles son true o false. No false
farmServerId Una serie que identifica de forma exclusiva un servidor de la granja de servidores. Los servicios de administración de MobileFirst Server y todos los tiempos de ejecución de MobileFirst que se comunican con él deben compartir el mismo valor. Ninguno

El elemento <database> especifica la información necesaria para acceder a una base de datos concreta. El elemento <database> se especifica como la tarea de Ant configuredatabase, excepto en que no tiene los elementos <dba> y <client>. Sin embargo, es posible que tenga elementos <property>. El elemento <database> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
kind El tipo de base de datos (Tiempo de ejecución de MobileFirst). Ninguno
validate Para validar si se puede acceder a la base de datos o no. Los valores posibles son true o false. No true

El elemento <database> da soporte a los elementos siguientes:

Elemento Descripción Recuento
<derby> Los parámetros para Derby. 0..1
<db2> Los parámetros para DB2. 0..1
<mysql> Los parámetros para MySQL. 0..1
<oracle> Los parámetros para Oracle. 0..1
<driverclasspath> La vía de acceso de clase de controlador JDBC. 0..1

El elemento <analytics> indica que desea conectar el entorno de ejecución de MobileFirst a una MobileFirst Analytics Console y a unos servicios ya instalados. Tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
install Para indicar si conectará el tiempo de ejecución de MobileFirst a MobileFirst Analytics. No false
analyticsURL El URL de los servicios de MobileFirst Analytics. Ninguno
consoleURL El URL de MobileFirst Analytics Console. Ninguno
username El nombre de usuario. Ninguno
password La contraseña. Ninguno
validate Para validar si se puede acceder a MobileFirst Analytics Console o no. No true
tenant El arrendatario para los datos de indexación que se recopilan de un tiempo de ejecución de MobileFirst. No Identificador interno

install

Utilice el atributo install para indicar que este tiempo de ejecución de MobileFirst debe estar conectado y enviar sucesos a MobileFirst Analytics. Los valores válidos son true o false.

analyticsURL

Utilice el atributo analyticsURL para especificar el URL expuesto por MobileFirst Analytics, que recibe datos analíticos entrantes.
Por ejemplo: http://<hostname>:<port>/analytics-service/rest

consoleURL

Utilice el atributo consoleURL para el URL que expone MobileFirst Analytics, que enlaza a la MobileFirst Analytics Console.
Por ejemplo: http://<hostname>:<port>/analytics/console

username

Utilice el atributo username para especificar el nombre de usuario que se utilizará si el punto de entrada de datos para MobileFirst Analytics está protegido con autenticación básica.

password

Utilice el atributo password para especificar la contraseña que se utilizará si el punto de entrada de datos para MobileFirst Analytics está protegido con autenticación básica.

validate

Utilice el atributo validate para validar si se puede acceder a la MobileFirst Analytics Console o no, y para comprobar la autenticación del nombre de usuario con una contraseña. Los valores posibles son true o false.

tenant

Para obtener más información sobre este atributo, consulte Propiedades de configuración.

Para especificar una base de datos Apache Derby

El elemento <derby> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
database El nombre de la base de datos. No MFPDATA, MFPADM, MFPCFG, MFPPUSH, o APPCNTR, dependiendo del tipo.
datadir El directorio que contiene las bases de datos. Ninguno
schema El nombre de esquema. No MFPDATA, MFPCFG, MFPADMINISTRATOR, MFPPUSH, o APPCENTER, dependiendo del tipo.

El elemento <derby> da soporte al elemento siguiente:

Elemento Descripción Recuento
<property> La propiedad de origen de datos o la propiedad de conexión JDBC. 0..

Para obtener más información sobre las propiedades disponibles, consulte la documentación para Clase EmbeddedDataSource40. Consulte también la documentación de Clase EmbeddedConnectionPoolDataSource40.

Para obtener más información sobre las propiedades disponibles para un servidor Liberty, consulte la documentación de properties.derby.embedded en Perfil de Liberty: Elementos de configuración en el archivo server.xml.

Cuando se utiliza el archivo mfp-ant-deployer.jar dentro del directorio de instalación de Mobile Foundation, no se necesita un elemento <driverclasspath>.

Para especificar una base de datos DB2

El elemento <db2> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado    
database El nombre de la base de datos. No MFPDATA, MFPADM, MFPCFG, MFPPUSH, o APPCNTR, dependiendo del tipo.    
server El nombre de host del servidor de bases de datos. Ninguno    
port El puerto en el servidor de bases de datos. No 50000    
user El nombre de usuario para acceder a las bases de datos. Este usuario no necesita privilegios ampliado en las bases de datos. Si implementa restricciones en la base de datos, puede establecer un usuario con los privilegios restringidos que se listan en Usuarios de base de datos y privilegios. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva    
schema El nombre de esquema. No Depende del usuario    

Para obtener más información sobre las cuentas de usuario de DB2, consulte Visión general del modelo de seguridad de DB2.
El elemento <db2> da soporte al elemento siguiente:

Elemento Descripción Recuento
<property> La propiedad de origen de datos o la propiedad de conexión JDBC. 0..

Para obtener más información sobre las propiedades disponibles, consulte Propiedades para IBM Data Server Driver for JDBC and SQLJ.

Para obtener más información sobre las propiedades disponibles para un servidor Liberty, consulte la sección properties.db2.jcc en Perfil de Liberty: Elementos de configuración en el archivo server.xml.

El elemento <driverclasspath> debe contener archivos JAR correspondientes al controlador JDBC de DB2 y a la licencia asociada. Puede descargar los controladores de DB2 JDBC desde DB2 JDBC Driver Versions.

Para especificar una base de datos MySQL

El elemento <mysql> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado  
database El nombre de la base de datos. No MFPDATA, MFPADM, MFPCFG, MFPPUSH, o APPCNTR, dependiendo del tipo.  
server El nombre de host del servidor de bases de datos. Ninguno  
port El puerto en el servidor de bases de datos. No 3306  
user El nombre de usuario para acceder a las bases de datos. Este usuario no necesita privilegios ampliado en las bases de datos. Si implementa restricciones en la base de datos, puede establecer un usuario con los privilegios restringidos que se listan en Usuarios de base de datos y privilegios. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva  

En lugar de database, server y port, también puede especificar un URL. En este caso, utilice los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
url El URL para la conexión a la base de datos. Ninguno
user El nombre de usuario para acceder a las bases de datos. Este usuario no necesita privilegios ampliado en las bases de datos. Si implementa restricciones en la base de datos, puede establecer un usuario con los privilegios restringidos que se listan en Usuarios de base de datos y privilegios. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

Para obtener más información sobre las cuentas de usuario de MySQL, consulte MySQL User Account Management.

El elemento <mysql> da soporte al elemento siguiente:

Elemento Descripción Recuento
<property> La propiedad de origen de datos o la propiedad de conexión JDBC. 0..

Para obtener más información sobre las propiedades disponibles, consulte la documentación en Driver/Datasource Class Names, URL Syntax and Configuration Properties for Connector/J.

Para obtener más información sobre las propiedades disponibles para un servidor Liberty, consulte la sección de propiedades en Perfil de Liberty: Elementos de configuración en el archivo server.xml.

El elemento <driverclasspath> debe contener un archivo JAR de MySQL Connector/J. Puede descargarlo desde Descargar Connector/J.

Para especificar una base de datos Oracle

El elemento <oracle> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
database El nombre de base de datos, o el nombre de servicio de Oracle. Nota: Siempre debe utilizar un nombre de servicio para conectarse a una base de datos PDB. No ORCL
server El nombre de host del servidor de bases de datos. Sí Ninguno  
port El puerto en el servidor de bases de datos. No 1521  
user El nombre de usuario para acceder a las bases de datos. Este usuario no necesita privilegios ampliado en las bases de datos. Si implementa restricciones en la base de datos, puede establecer un usuario con los privilegios restringidos que se listan en Usuarios de base de datos y privilegios. Consulte la nota bajo esta tabla. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

Nota: Para el atributo user, utilice preferiblemente un nombre de usuario en letras mayúsculas. Los nombres de usuario de Oracle están generalmente en letras mayúsculas. A diferencia de otras herramientas de base de datos, la tarea Ant installmobilefirstruntime no convierte letras minúsculas a mayúsculas en el nombre de usuario. Si la tarea Ant installmobilefirstruntime no puede conectarse a la base de datos, intente escribir el valor para el atributo user en letras mayúsculas.

En lugar de database, server y port, también puede especificar un URL. En este caso, utilice los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
url El URL para la conexión a la base de datos. Ninguno
user El nombre de usuario para acceder a las bases de datos. Este usuario no necesita privilegios ampliado en las bases de datos. Si implementa restricciones en la base de datos, puede establecer un usuario con los privilegios restringidos que se listan en Usuarios de base de datos y privilegios. Consulte la nota bajo esta tabla. Ninguno
password La contraseña para acceder a las bases de datos. No Consultado de forma interactiva

Nota: Para el atributo user, utilice preferiblemente un nombre de usuario en letras mayúsculas. Los nombres de usuario de Oracle están generalmente en letras mayúsculas. A diferencia de otras herramientas de base de datos, la tarea Ant installmobilefirstruntime no convierte letras minúsculas a mayúsculas en el nombre de usuario. Si la tarea Ant installmobilefirstruntime no puede conectarse a la base de datos, intente escribir el valor para el atributo user en letras mayúsculas.

Para obtener más información sobre las cuentas de usuario de Oracle, consulte Visión general de métodos de autenticación.

Para obtener más información sobre los URL de conexión de base de datos Oracle, consulte la sección Database URLs and Database Specifiers en Data Sources and URLs.

Da soporte al elemento siguiente:

Elemento Descripción Recuento
<property> La propiedad de origen de datos o la propiedad de conexión JDBC. 0..

Para obtener más información sobre las propiedades disponibles, consulte la sección Data Sources and URLs en Data Sources and URLs.

Para obtener más información sobre las propiedades disponibles para un servidor Liberty, consulte la sección properties.oracle en Perfil de Liberty: Elementos de configuración en el archivo server.xml.

El elemento <driverclasspath> debe contener un archivo JAR de controlador JDBC de Oracle. Puede descargar los controladores JDBC de Oracle desde JDBC, SQLJ, Oracle JPublisher y Universal Connection Pool (UCP).

El elemento <property>, que se puede utilizar dentro de los elementos <derby>, <db2>, <mysql> o <oracle>, tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
type Tipo Java de los valores de propiedades, normalmente java.lang.String/Integer/Boolean. No java.lang.String
value El valor de la propiedad. Ninguno

Tareas Ant para la instalación de Application Center

Se proporcionan las tareas de Ant <installApplicationCenter>, <updateApplicationCenter> y <uninstallApplicationCenter> para la instalación de la consola y de los servicios de Application Center.

Efectos de tareas

installApplicationCenter

La tarea <installApplicationCenter> configura un servidor de aplicaciones de modo que ejecute el archivo WAR de los servicios de Application Center como una aplicación web y que instale la consola de Application Center. Esta tarea tiene los siguientes efectos:

  • Declara la aplicación web de Application Center Services en la raíz de contexto /applicationcenter.
  • Declara orígenes de datos, y en el perfil completo de WebSphere Application Server, declara también proveedores JDBC para Application Center Services.
  • Despliega la aplicación web de Application Center Services en el servidor de aplicaciones.
  • Declara la Application Center Console como una aplicación web en la raíz de contexto /appcenterconsole.
  • Despliega el archivo WAR de Application Center Console en el servidor de aplicaciones.
  • Configura propiedades de configuración para Application Center Services utilizando entradas de entorno JNDI. Las entradas de entorno JNDI relacionadas con el punto final y los proxies están comentadas. Debe eliminar el comentario en ellas en algunos casos.
  • Configura usuarios que correlaciona para los roles utilizados por las aplicaciones web de Application Center Console and Services.
  • En WebSphere Application Server, configura la propiedad personalizada necesaria para el contenedor web.

updateApplicationCenter

La tarea <updateApplicationCenter> actualiza una aplicación de Application Center ya configurada en un servidor de aplicaciones. Esta tarea tiene los siguientes efectos:

  • Actualiza el archivo WAR de Application Center Services. Este archivo debe tener el mismo nombre base que el archivo WAR correspondiente desplegado anteriormente.
  • Actualiza el archivo WAR de Application Center Console. Este archivo debe tener el mismo nombre base que el archivo WAR correspondiente desplegado anteriormente.

La tarea no cambia la configuración del servidor de aplicaciones, es decir, la configuración de la aplicación web, los orígenes de datos, las entradas de entorno JNDI ni las correlaciones de usuario a rol. Esta tarea sólo se aplica a una instalación realizada mediante la tarea descrita en este tema.

Nota: En el perfil de WebSphere Application Server Liberty, la tarea no cambia las características, lo que deja una lista de características no mínimas potenciales en el archivo server.xml para la aplicación instalada.

uninstallApplicationCenter

La tarea de Ant <uninstallApplicationCenter> deshace los efectos de una ejecución anterior de <installApplicationCenter>. Esta tarea tiene los siguientes efectos:

  • Elimina la configuración de la aplicación web Application Center Services con la raíz de contexto /applicationcenter. Como consecuencia, la tarea también elimina los valores que se han añadido manualmente a dicha aplicación.
  • Elimina los archivos WAR de Application Center Services and Console del servidor de aplicaciones.
  • Elimina los orígenes de datos y, en el perfil completo de WebSphere Application Server, también elimina los proveedores JDBC para Application Center Services.
  • Elimina los controladores de base de datos que utilizaron los Application Center Services del servidor de aplicaciones.
  • Elimina las entradas de entorno JNDI asociadas.
  • Elimina los usuarios configurados por la invocación de <installApplicationCenter>.

Atributos y elementos

Las tareas <installApplicationCenter>, <updateApplicationCenter> y <uninstallApplicationCenter> tienen los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
id Distingue los diferentes despliegues del perfil completo de WebSphere Application Server. No Vacío
servicewar El archivo WAR para Application Center Services. No El archivo applicationcenter.war se encuentra en el directorio de la consola Center de la aplicación: dir_instal_producto/ApplicationCenter/console.
shortcutsDir El directorio donde coloca los atajos. No Ninguno
aaptDir El directorio que contiene el programa aapt, desde el paquete de herramientas de la plataforma Android SDK. No Ninguno

id

En los entornos del perfil completo de WebSphere Application Server, se utiliza el atributo id para distinguir distintos despliegues de Application Center Console and Services. Sin este atributo id, pueden entrar en conflicto dos archivos WAR con las mismas raíces de contexto y es posible que no se desplieguen estos archivos.

servicewar

Utilice el atributo servicewar para especificar un directorio distinto para el archivo WAR de Application Center Services. Puede especificar el nombre de este archivo WAR con una vía de acceso absoluta o relativa.

shortcutsDir

El atributo shortcutsDir especifica dónde colocar atajos en Application Center Console. Si establece este atributo, se añadirán los archivos siguientes a este directorio:

  • appcenter-console.url: Este archivo es un atajo de Windows. Abre Application Center Console en un navegador.
  • appcenter-console.sh: Este archivo es un script de shell de UNIX. Abre Application Center Console en un navegador.

aaptDir

El programa aapt forma parte de la distribución de Mobile Foundation: dir_instal_producto/ApplicationCenter/tools/android-sdk.
Si este atributo no está establecido, durante la subida de una aplicación apk, Application Center lo analizará utilizando su propio código, que puede tener limitaciones.

Las tareas <installApplicationCenter>, <updateApplicationCenter> y <uninstallApplicationCenter> dan soporte a los elementos siguientes:

Elemento Descripción Recuento
applicationserver El servidor de aplicaciones. 1
console La consola de Application Center. 1
database Las bases de datos. 1
user El usuario que se correlacionará con un rol de seguridad. 0..∞

Para especificar una consola de Application Center

El elemento <console> recopila información para personalizar la instalación de la consola de Application Center. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
warfile El archivo WAR para Application Center Console. No El archivo appcenterconsole.war se encuentra en el directorio de consola de Application Center: dir_instal_producto/ApplicationCenter/console.

Para especificar un servidor de aplicaciones

Utilice el elemento <applicationserver> para definir los parámetros que dependen del servidor de aplicaciones subyacente. El elemento <applicationserver> da soporte a los elementos siguientes.

Elemento Descripción Recuento
websphereapplicationserver o was Los parámetros para WebSphere Application Server. El elemento <websphereapplicationserver> (o <was> en su forma abreviada) indica una instancia de WebSphere Application Server. Se da soporte al perfil completo de WebSphere Application Server (Base, y Network Deployment), por lo que es WebSphere Application Server Liberty Core. El colectivo de Liberty no está soportado para Application Center. 0..1
tomcat Los parámetros para Apache Tomcat. 0..1

Los atributos y elementos internos de estos elementos se describen en las tablas de la página Tareas Ant para la instalación de entornos de ejecución de MobileFirst.

Para especificar una conexión a la base de datos de servicio

El elemento <database> recopila los parámetros que especifican una declaración de origen de datos en un servidor de aplicaciones para acceder a la base de datos de servicios.

Debe declarar una única base de datos: <database kind="ApplicationCenter">. Especifique el elemento <database> de forma parecida a la tarea de Ant <configuredatabase>, excepto en que el elemento <database> no tiene los elementos <dba> y <client>. Es posible que tenga elementos <property>.

El elemento <database> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
kind El tipo de base de datos (ApplicationCenter). Ninguno
validate Para validar si se puede acceder a la base de datos o no. No True

El elemento <database> da soporte a los elementos siguientes.Para obtener más información sobre la configuración de estos elementos de base de datos, consulte las tablas de Tareas Ant para la instalación de entornos de ejecución de MobileFirst.

Elemento Descripción Recuento
db2 El parámetro para bases de datos DB2. 0..1
derby El parámetro para bases de datos Apache Derby. 0..1
mysql El parámetro para bases de datos MySQL. 0..1
oracle El parámetro para bases de datos Oracle. 0..1
driverclasspath El parámetro para la vía de acceso de clase de controlador JDBC. 0..1

Para especificar un usuario y un rol de seguridad

El elemento <user> recopila los parámetros sobre un usuario para inclulos en un determinado rol de seguridad para una aplicación.

Atributo Descripción Obligatorio Predeterminado
role El rol de usuario appcenteradmin. Ninguno
name El nombre de usuario. Ninguno
password La contraseña, si debe crear el usuario. No Ninguno

Tareas Ant para la instalación de MobileFirst Analytics

Las tareas Ant installanalytics, updateanalytics, y uninstallanalytics se proporcionan para la instalación de MobileFirst Analytics.

El objetivo de estas Tareas Ant es configurar el servicio de MobileFirst Analytics Console y de MobileFirst Analytics con el almacenamiento apropiado para los datos en un servidor de aplicaciones. La tarea instala nodos de MobileFirst Analytics que actúan como un maestro y datos. Para obtener más información, consulte Gestión de clústeres y Elasticsearch.

Efectos de tareas

installanalytics

La tarea Ant installanalytics configura un servidor de aplicaciones para ejecutar IBM MobileFirst Analytics. Esta tarea tiene los siguientes efectos:

  • Despliega los archivos WAR de MobileFirst Analytics Service and MobileFirst Analytics Console en el servidor de aplicaciones.
  • Declara la aplicación web de MobileFirst Analytics Service en la raíz de contexto especificada /analytics-service.
  • Declara la aplicación web MobileFirst Analytics Console en la raíz de contexto especificada /analytics.
  • Establece las propiedades de configuración de MobileFirst Analytics Console and MobileFirst Analytics Services mediante entradas de entorno de JNDI.
  • En el perfil de WebSphere Application Server Liberty, configura el contenedor web.
  • Opcionalmente, crea usuarios para que utilicen la MobileFirst Analytics Console.

updateanalytics

La tarea Ant updateanalytics actualiza los archivos WAR de las aplicaciones web de MobileFirst Analytics Service and MobileFirst Analytics Console ya configuradas en un servidor de aplicaciones. Estos archivos deben tener los mismos nombres base que los archivos WAR del proyecto desplegados anteriormente.

La tarea no cambia la configuración del servidor de aplicaciones, es decir, la configuración de la aplicación web ni las entradas de entorno JNDI.

uninstallanalytics

La tarea Ant uninstallanalytics deshace los efectos de una ejecución anterior de installanalytics. Esta tarea tiene los siguientes efectos:

  • Elimina la configuración de las aplicaciones web de MobileFirst Analytics Service and MobileFirst Analytics Console con sus raíces de contexto respectivas.
  • Elimina los archivos WAR de MobileFirst Analytics Service and MobileFirst Analytics Console del servidor de aplicaciones.
  • Elimina las entradas de entorno JNDI asociadas.

Atributos y elementos

Las tareas installanalytics, updateanalytics, y uninstallanalytics tienen los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
serviceWar El archivo WAR para MobileFirst Analytics Service No El archivo analytics-service.war se encuentra en el directorio Analytics.

serviceWar

Utilice el atributo serviceWar para especificar un directorio distinto para el archivo WAR de MobileFirst Analytics Services. Puede especificar el nombre de este archivo WAR con una vía de acceso absoluta o relativa.

Las tareas <installanalytics>, <updateanalytics> y <uninstallanalytics> dan soporte a los elementos siguientes:

Atributo Descripción Obligatorio Predeterminado
console MobileFirst Analytics 1
user El usuario que se correlacionará con un rol de seguridad. No 0..
storage El tipo de almacenamiento. 1
applicationserver El servidor de aplicaciones. 1
property Propiedades. No 0..

Para especificar una MobileFirst Analytics Console

El elemento <console> recopila información para personalizar la instalación de MobileFirst Analytics Console. Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
warfile El archivo WAR de la consola No El archivo analytics-ui.war se encuentra en el directorio Analytics.
shortcutsdir El directorio donde coloca los atajos. No Ninguno

warFile

Utilice el atributo warFile para especificar un directorio distinto para el archivo WAR de MobileFirst Analytics Console. Puede especificar el nombre de este archivo WAR con una vía de acceso absoluta o relativa.

shortcutsDir

El atributo shortcutsDir especifica dónde colocar atajos en la MobileFirst Analytics Console. Si establece este atributo, puede añadir los archivos siguientes a dicho directorio:

  • analytics-console.url: Este archivo es un atajo de Windows. Abre la MobileFirst Analytics Console en un navegador.
  • analytics-console.sh: Este archivo es un script de shell de UNIX. Abre la MobileFirst Analytics Console en un navegador.

Nota: Estos atajos no incluyen el parámetro de arrendatario de ElasticSearch.

El elemento <console> da soporte al siguiente elemento anidado:

Elemento Descripción Recuento
property Propiedades 0..

Con este elemento, puede definir sus propias propiedades JNDI.

El elemento <property> tiene los atributos siguientes:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

Para especificar un usuario y un rol de seguridad

El elemento <user> recopila los parámetros sobre un usuario para inclulos en un determinado rol de seguridad para una aplicación.

Atributo Descripción Obligatorio Predeterminado
role Un rol de seguridad válido para la aplicación. Ninguno
name El nombre de usuario. Ninguno
password La contraseña si el usuario debe crearse. No Ninguno

Después de definir usuarios mediante el elemento <user>, puede correlacionarlos con cualquiera de los roles siguientes para la autenticación en MobileFirst Operations Console:

  • mfpmonitor
  • mfpoperator
  • mfpdeployer
  • mfpadmin

Para especificar un tipo de almacenamiento para MobileFirst Analytics

El elemento <storage> indica el tipo subyacente de almacenamiento que MobileFirst Analytics utiliza para almacenar la información y los datos que recopila.

Da soporte al elemento siguiente:

Elemento Descripción Recuento
elasticsearch ElasticSearch clúster

El elemento <elasticsearch> recopila los parámetros acerca de un clúster ElasticSearch.

Atributo Descripción Obligatorio Predeterminado
clusterName El nombre de clúster de ElasticSearch. No worklight
nodeName El nombre de nodo de ElasticSearch. Este nombre debe ser exclusivo en un clúster de ElasticSearch. No worklightNode_<random number>
mastersList Una serie delimitada por comas que contiene el nombre de host y los puertos de los nodos maestro de ElasticSearch en el clúster de ElasticSearch (Por ejemplo: hostname1:transport-port1,hostname2:transport-port2) No Depende de la topología
dataPath La ubicación del clúster de ElasticSearch. No Depende del servidor de aplicaciones
shards El número de fragmentos que crea el clúster de ElasticSearch. Este valor sólo lo pueden establecer los nodos maestro creados en el clúster de ElasticSearch. No 5
replicasPerShard El número de réplicas para cada fragmento del clúster de ElasticSearch. Este valor sólo lo pueden establecer los nodos maestro creados en el clúster de ElasticSearch. No 1
transportPort El puerto utilizado para la comunicación de nodo a nodo en el clúster de ElasticSearch. No 9600

clusterName

Utilice el atributo clusterName para especificar un nombre de su elección para el clúster de ElasticSearch.

Un clúster de ElasticSearch consta de uno o varios nodos que comparten el mismo nombre de clúster, de forma que es posible especificar el mismo valor para el atributo clusterName si configura varios nodos.

nodeName

Utilice el atributo nodeName para especificar un nombre de su elección para el nodo que se va a configurar en el clúster de ElasticSearch. Cada nombre de nodo debe ser exclusivo en el clúster de ElasticSearch, aún cuando los nodos estén en varias máquinas.

mastersList

Utilice el atributo mastersList para proporcionar una lista separada por comas de los nodos maestro del clúster de ElasticSearch. Cada nodo maestro de la lista debe identificarse por su nombre de host, y el puerto de comunicación de nodo a nodo de ElasticSearch. Este puerto es 9600 de forma predeterminada, o es el número de puerto que ha especificado con el atributo transportPort al configurar dicho nodo maestro.

Por ejemplo: hostname1:transport-port1, hostname2:transport-port2.

Nota:

  • Si especifica un transportPort distinto al valor predeterminado 9600, también debe establecer este valor con el atributo transportPort. De forma predeterminada, cuando se omita el atributo mastersList, se realizará un intento para detectar el nombre de host y el puerto de transporte de ElasticSearch en todos los servidores de aplicaciones soportados.
  • Si el servidor de aplicaciones de destino es el clúster de WebSphere Application Server Network Deployment, y si añade o elimina un servidor de este clúster en un momento posterior, debe editar esta lista manualmente para mantenerla sincronizada con el clúster de ElasticSearch.

dataPath

Utilice el atributo dataPath para especificar un directorio distinto para almacenar datos de ElasticsSearch. Puede especificar una vía de acceso absoluta o una vía de acceso relativa.

Si no se especifica el atributo dataPath, los datos del clúster de ElasticSearch se almacenarán en un directorio predeterminado llamado analyticsData, cuya ubicación depende del servidor de aplicaciones:

  • Para el perfil de WebSphere Application Server Liberty, la ubicación es ${wlp.user.dir}/servers/serverName/analyticsData.
  • Para Apache Tomcat, la ubicación es ${CATALINA_HOME}/bin/analyticsData.
  • En el caso de WebSphere Application Server y WebSphere Application Server Network Deployment, la ubicación es ${was.install.root}/profiles/<profileName>/analyticsData.

El directorio analyticsData y la jerarquía de subdirectorios y archivos que contiene se crearán automáticamente en tiempo de ejecución, si no existen ya cuando el componente de MobileFirst Analytics Service reciba sucesos.

shards

Utilice el atributo shards para especificar el número de fragmentos que se crearán en el clúster de ElasticSearch.

replicasPerShard

Utilice el atributo replicasPerShard para especificar el número de réplicas que se crearán para cada fragmento en el clúster de ElasticSearch.

Cada fragmento puede tener cero o más réplicas. De forma predeterminada, cada fragmento tiene una réplica, pero el número de réplicas puede cambiar de forma dinámica en un índice existente de MobileFirst Analytics. Un fragmento de réplica no se puede iniciar nunca en el mismo nodo que su fragmento.

transportPort

Utilice el atributo transportPort para especificar un puerto que otros nodos del clúster de ElasticSearch deben utilizar al comunicarse con este nodo. Debe asegurarse de que este puerto esté disponible y accesible si este nodo está detrás de un proxy o de un cortafuegos.

Para especificar un servidor de aplicaciones

Utilice el elemento <applicationserver> para definir los parámetros que dependen del servidor de aplicaciones subyacente. El elemento <applicationserver> da soporte a los elementos siguientes.

Nota: Los atributos y los elementos internos de este elemento se describen en las tablas de Tareas Ant para la instalación de entornos de ejecución de MobileFirst.

Elemento Descripción Recuento
websphereapplicationserver o was Los parámetros para WebSphere Application Server. 0..1
tomcat Los parámetros para Apache Tomcat. 0..1

Para especificar propiedades JNDI personalizadas

Los elementos <installanalytics>, <updateanalytics> y <uninstallanalytics> dan soporte al siguiente elemento:

Elemento Descripción Recuento
property Propiedades 0..

Al utilizar este elemento, puede definir sus propias propiedades JNDI.

Este elemento tiene los siguientes atributos:

Atributo Descripción Obligatorio Predeterminado
name El nombre de la propiedad. Ninguno
value El valor de la propiedad. Ninguno

Bases de datos de tiempo de ejecución interno

Obtenga más información acerca de las tablas de base de datos de tiempo de ejecución, su finalidad, y el orden de magnitud de datos almacenados en cada tabla. En bases de datos relacionales, las entidades están organizadas en tablas de base de datos.

Base de datos utilizada por el tiempo de ejecución de MobileFirst Server

En la tabla siguiente se proporciona una lista de tablas de base de datos de tiempo de ejecución, sus descripciones, y cómo se utilizan en bases de datos relacionales.

Nombre de tabla de base de datos relacional Descripción Orden de magnitud
LICENSE_TERMS Almacena las diversas métricas de licencias capturadas cada vez que se ejecuta la tarea de decomisionado de dispositivos. Decenas de filas. Este valor no supera el valor establecido por la propiedad mfp.device.decommission.when de la propiedad JNDI. Para obtener más información sobre propiedades JNDI, consulte Lista de propiedades JNDI para el tiempo de ejecución de MobileFirst
ADDRESSABLE_DEVICE Almacena las métricas de dispositivos dirigibles cada día. También se añade una entrada cada vez que se inicia un clúster. Acerca de 400 filas. Las entradas más antiguas de 13 meses se suprimen cada día.
MFP_PERSISTENT_DATA Almacena instancias de aplicaciones cliente que se han registrado con el servidor OAuth, incluida la información sobre el dispositivo, la aplicación, usuarios asociados con el cliente y el estado del dispositivo. Una fila por par de dispositivos y aplicaciones.
MFP_PERSISTENT_CUSTOM_ATTR Los atributos personalizados que están asociados con las instancias de aplicaciones cliente. Los atributos personalizados son específicos de la aplicación registrados por la aplicación por cada instancia de cliente. Cero o más filas por par de dispositivos y aplicaciones
MFP_TRANSIENT_DATA Contexto de autenticación de clientes y dispositivos Dos filas por par de dispositivos y aplicaciones; si se utiliza el inicio de sesión único de dispositivos en dos filas adicionales por dispositivo. Para obtener más información sobre SSO, consulte Configuración de inicio de sesión único de dispositivo (SSO).
SERVER_VERSION La versión del producto. Una fila

Base de datos utilizada por el servicio de administración de MobileFirst Server

En la tabla siguiente se proporciona una lista de tablas de la base de datos de administración, sus descripciones, y cómo se utilizan en bases de datos relacionales.

Nombre de tabla de base de datos relacional Descripción Orden de magnitud
ADMIN_NODE Almacena información sobre los servidores que ejecutan el servicio de administración. No se utilizará esta entidad en una topología autónoma con sólo un servidor. Una fila por servidor; vacío si se utiliza un servidor autónomo.
AUDIT_TRAIL Almacena un seguimiento de auditoría de todas las acciones administrativas realizadas con el servicio de administración. Miles de filas.
CONFIG_LINKS Almacena los enlaces en el servicio de Live Update. Los adaptadores y las aplicaciones podrían tener configuraciones almacenadas en el servicio de Live Update, y los enlaces se utilizarán para buscar dichas configuraciones. Cientos de filas. Se utilizan de 2 a 3 filas por adaptador. Se utilizan de 4 a 6 filas por aplicación.
FARM_CONFIG Almacena la configuración de nodos de granja de servidores cuando se utiliza una granja de servidores. Decenas de filas; vacío si no se utiliza ninguna granja de servidores.
GLOBAL_CONFIG Almacena algunos datos de configuración global. 1 fila.
PROJECT Almacena los nombres de los proyectos desplegados. Decenas de filas.
PROJECT_LOCK Tareas de sincronización del clúster interno. Decenas de filas.
TRANSACTIONS Tabla de sincronización del clúster interno; almacena el estado de todas las acciones de administración actuales. Decenas de filas.
MFPADMIN_VERSION La versión del producto. Una fila.

Base de datos utilizada por el servicio de Live Update de MobileFirst Server

En la tabla siguiente se proporciona una lista de tablas de base de datos de servicio de Live Update, sus descripciones, y cómo se utilizan en bases de datos relacionales.

Nombre de tabla de base de datos relacional Descripción Orden de magnitud
CS_SCHEMAS Almacena los esquemas versionados que existen en la plataforma. Una fila por esquema.
CS_CONFIGURATIONS Almacena instancias de configuraciones para cada esquema versionado. Una fila por configuración
CS_TAGS Almacena los campos en los que se pueden realizar búsquedas y los valores para cada instancia de configuración. Fila para cada nombre de campo y valor para cada campos en el que se pueden realizar búsquedas en la configuración.
CS_ATTACHMENTS Almacena los archivos adjuntos para cada instancia de la configuración. Una fila por archivo adjunto.
CS_VERSION Almacena la versión del MFP que ha creado las tablas o instancias. Fila única en la tabla con la versión de MFP.

Base de datos utilizada por el servicio de envío por push de MobileFirst Server

En la tabla siguiente se proporciona una lista de tablas de base de datos de servicio de envío por push, sus descripciones, y cómo se utilizan en bases de datos relacionales.

Nombre de tabla de base de datos relacional Descripción Orden de magnitud
PUSH_APPS Tabla de notificaciones push; almacena detalles de aplicaciones push. Una fila por aplicación.
PUSH_ENV Tabla de notificaciones push; almacena detalles de entornos push. Decenas de filas.
PUSH_TAGS Tabla de notificaciones push; almacena detalles de etiquetas definidas. Decenas de filas.
PUSH_DEVICES Tabla de notificaciones push. Almacena un registro por dispositivo. Una fila por dispositivo.
PUSH_SUBSCRIPTIONS Tabla de notificaciones push. Almacena un registro por suscripción de etiquetas. Una fila por suscripción de dispositivos.
PUSH_MESSAGES Tabla de notificaciones push; almacena detalles de mensajes push. Decenas de filas.
PUSH_MESSAGE_SEQUENCE_TABLE Tabla de notificaciones push; almacena el ID de secuencia generado. Una fila.
PUSH_VERSION La versión del producto. Una fila.

Para obtener más información sobre cómo configurar las bases de datos, consulte Configuración de bases de datos.

Archivos de configuración de ejemplo

Mobile Foundation incluye un número de archivos de configuración de ejemplo para ayudarle a comenzar con las tareas Ant para instalar el MobileFirst Server.

La forma más sencilla de empezar con estas tareas Ant es trabajar con los archivos de configuración de ejemplo que se proporcionan en el directorio MobileFirstServer/configuration-samples/ de la distribución de MobileFirst Server. Para obtener más información sobre cómo instalar MobileFirst Server con tareas Ant, consulte Instalación con Tareas Ant.

Lista de archivos de configuración de ejemplo

Elija el archivo de configuración de ejemplo apropiado. Se proporcionan los siguientes archivos.

Tarea Derby DB2 MySQL Oracle  
Crear bases de datos con credenciales de administradores de bases de datos create-database-derby.xml create-database-db2.xml create-database-mysql.xml create-database-oracle.xml  
Instalar MobileFirst Server en Liberty configure-liberty-derby.xml configure-liberty-db2.xml configure-liberty-mysql.xml (Consulte Nota sobre MySQL) configure-liberty-oracle.xml
Instalar MobileFirst Server en el perfil completo de WebSphere Application Server, servidor único configure-was-derby.xml configure-was-db2.xml configure-was-mysql.xml (Consulte Nota sobre MySQL) configure-was-oracle.xml  
Instalar MobileFirst Server en WebSphere Application Server Network Deployment (Consulte Nota sobre los archivos de configuración) configure-wasnd-cluster-derby.xml, configure-wasnd-server-derby.xml, configure-wasnd-node-derby.xml. configure-wasnd-cell-derby.xml configure-wasnd-cluster-db2.xml, configure-wasnd-server-db2.xml, configure-wasnd-node-db2.xml, configure-wasnd-cell-db2.xml configure-wasnd-cluster-mysql.xml (Consulte Nota sobre MySQL), configure-wasnd-server-mysql.xml (Consulte Nota sobre MySQL), configure-wasnd-node-mysql.xml (Consulte Nota sobre MySQL), configure-wasnd-cell-mysql.xml configure-wasnd-cluster-oracle.xml, configure-wasnd-server-oracle.xml, configure-wasnd-node-oracle.xml, configure-wasnd-cell-oracle.xml  
Instalar MobileFirst Server en Apache Tomcat configure-tomcat-derby.xml configure-tomcat-db2.xml configure-tomcat-mysql.xml configure-tomcat-oracle.xml  
Instalar MobileFirst Server en el colectivo de Liberty No relevante configure-libertycollective-db2.xml configure-libertycollective-mysql.xml configure-libertycollective-oracle.xml  

Nota sobre MySQL: MySQL en combinación con el perfil de WebSphere Application Server Liberty o el perfil completo de WebSphere Application Server no se clasifica como una configuración soportada. Para obtener más información, consulte WebSphere Application Server Support Statement. Considere la posibilidad de utilizar IBM DB2 u otra base de datos soportada por WebSphere Application Server para beneficiarse de una configuración que esté completamente soportada por IBM Support.

Nota sobre archivos de configuración para WebSphere Application Server Network Deployment: Los archivos de configuración para wasnd contienen un ámbito que se puede establecer en clúster, nodo, servidor, o célula. Por ejemplo, para configure-wasnd-cluster-derby.xml, el ámbito es clúster. Estos tipos de ámbito definen el destino de despliegue tal como se indica a continuación:

  • clúster: Para desplegar en un clúster.
  • servidor: Para desplegar en un único servidor gestionado por el gestor de despliegue.
  • nodo: Para desplegar en todos los servidores que se ejecutan en un nodo, pero que no pertenecen a un clúster.
  • célula: Para desplegar en todos los servidores en una célula.

Archivos de configuración de ejemplo para MobileFirst Analytics

Mobile Foundation incluye varios archivos de configuración de ejemplo para ayudarle a comenzar con las tareas Ant para instalar los Servicios de MobileFirst Analytics, y la MobileFirst Analytics Console.

La forma más sencilla de comenzar a utilizar las tareas de Ant <installanalytics>, <updateanalytics> y <uninstallanalytics> es trabajar con los archivos de configuración de ejemplo que se proporcionan en el directorio Analytics/configuration-samples/ de la distribución de MobileFirst Server.

Paso 1

Elija el archivo de configuración de ejemplo apropiado. Se proporcionan los siguientes archivos XML. Se les conoce como configure-file.xml en los pasos siguientes.

Tarea Servidor de aplicaciones
Instale MobileFirst Analytics Services and Console en el perfil de WebSphere Application Server Liberty configure-liberty-analytics.xml
Instale MobileFirst Analytics Services and Console en Apache Tomcat configure-tomcat-analytics.xml
Instale MobileFirst Analytics Services and Console en el perfil completo de WebSphere Application Server configure-was-analytics.xml
Instale MobileFirst Analytics Services and Console en WebSphere Application Server Network Deployment, servidor único configure-wasnd-server-analytics.xml
Instale MobileFirst Analytics Services and Console en WebSphere Application Server Network Deployment, célula configure-wasnd-cell-analytics.xml
Instale MobileFirst Analytics Services and Console en WebSphere Application Server Network Deployment, nodo configure-wasnd-node.xml
Instale MobileFirst Analytics Services and Console en WebSphere Application Server Network Deployment, clúster configure-wasnd-cluster-analytics.xml

Nota sobre los archivos de configuración para WebSphere Application Server Network Deployment:
Los archivos de configuración para wasnd contienen un ámbito que se puede establecer en clúster, nodo, servidor, o célula. Por ejemplo, para configure-wasnd-cluster-analytics.xml, el ámbito es clúster. Estos tipos de ámbito definen el destino de despliegue tal como se indica a continuación:

  • clúster: Para desplegar en un clúster.
  • servidor: Para desplegar en un único servidor gestionado por el gestor de despliegue.
  • nodo: Para desplegar en todos los servidores que se ejecutan en un nodo, pero que no pertenecen a un clúster.
  • célula: Para desplegar en todos los servidores en una célula.

Paso 2

Cambie los derechos de acceso del archivo del archivo de ejemplo para que sean lo más restrictivos posible. El paso 3 requiere que proporcione algunas contraseñas. Si debe impedir que otros usuarios del mismo sistema conozcan estas contraseñas, debe eliminar los permisos de lectura del archivo para usuarios distintos a usted mismo. Puede utilizar un mandato, como los ejemplos siguientes:

En UNIX: chmod 600 configure-file.xml En Windows: cacls configure-file.xml /P Administrators:F %USERDOMAIN%\%USERNAME%:F

Paso 3

De forma similar, si el servidor de aplicaciones es el perfil de WebSphere Application Server Liberty, o Apache Tomcat, y el servidor está pensado para iniciarse sólo desde la cuenta de usuario, debe también eliminar los permisos de lectura para usuarios que no sean usted mismo desde los siguientes archivos:

  • Para el perfil de WebSphere Application Server Liberty: wlp/usr/servers/<server>/server.xml
  • Para Apache Tomcat: conf/server.xml

Paso 4

Sustituya los valores de marcador por las propiedades que hay al principio del archivo.

Nota:
Los caracteres especiales siguientes deben escaparse cuando se utilicen en los valores de los scripts Ant XML:

  • El signo de dólar ($) se debe escribir como $$, a no ser que desee hacer referencia explícitamente a una variable Ant mediante la sintaxis ${variable}, tal como se describe en la sección Propiedades de Apache Ant Manual.
  • El carácter ampersand (&) se debe escribir como &amp;, a no ser que desee explícitamente hacer referencia a una entidad XML.
  • Las comillas dobles (") se deben escribir como &quot;, excepto cuando estén dentro de una serie que esté entre comillas simples.

Paso 5

Ejecute el mandato: ant -f configure-file.xml install

Este mandato instala los componentes MobileFirst Analytics Services and MobileFirst Analytics Console en el servidor de aplicaciones. Para instalar componentes actualizados de MobileFirst Analytics Services and MobileFirst Analytics Console, por ejemplo si aplica un fixpack de MobileFirst Server, ejecute el siguiente mandato: ant -f configure-file.xml minimal-update.

Para invertir el paso de instalación, ejecute el mandato: ant -f configure-file.xml uninstall

Este mandato desinstala los componentes MobileFirst Analytics Services and MobileFirst Analytics Console.

Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on May 13, 2020