Skip to main content

La referencia del archivo appSettings.json

El archivo appSettings.json es un archivo de configuración utilizado por el centro de documentación de ArcGIS para almacenar configuraciones de aplicaciones. Los administradores de TI pueden crear y desplegar un archivo personalizado appSettings.json para configurar la aplicación para varios usuarios. Este tema describe todos los ajustes del archivo.

Estructura de appSettings.json

El archivo appSettings.json es un archivo JSON con la siguiente estructura:

{
  "init": <boolean>,
  "allowedHosts": <string>,
  "endpoints": {
    "documentationSets": {
      "url": <string>
    },
    "webHelp": {
      "url": <string>
    },
    "softwareUpdate": {
      "url": <string>
    }
  },
  "webServer": {
    "defaultFileNames": [<string>, ...],
    "portPreferences": [
      {
        "order": <number>,
        "port": <number>
      },
      ...
    ],
    "portScan": {
      "minValue": <number>,
      "maxValue": <number>,
      "limit": <number>
    },
    "rootFolder": <string>
  },
  "language": <string>,
  "theme": <string>

Parámetros de appSettings.json

init

  • Tipo: booleano

Indica si la aplicación se ha inicializado con los ajustes. Esto se establece en truedespués de que el asistente de configuración se complete por primera vez. Los administradores de TI pueden establecerlo en true para saltarse el asistente de configuración cuando la aplicación se inicia por primera vez. Si init se establece en false, el asistente de configuración se abrirá cuando el usuario inicie la aplicación; por lo tanto, si va a implementar un archivo appSettings.json personalizado, debe establecer init entrue para evitar que se abra el asistente de configuración y, con ello, que se sobrescriban tus ajustes personalizados.

allowedHosts

  • Tipo: cadena de caracteres

Especifique a qué hosts puede acceder la aplicación. Utilice esta configuración para controlar el acceso a la red. El valor puede establecerse en lo siguiente:

  • * (asterisco) para permitir el acceso a todos los anfitriones.

  • Una lista separada por comas de anfitriones específicos, como doc.esri.com,example.com. Por lo general, no es necesario especificar varios hosts.

  • Un solo host permite el acceso a un solo host, como doc.esri.com.

  • Una cadena vacía ("") para bloquear todo acceso a la red. Esto desactiva funciones que requieren acceso a la red, como descargar conjuntos de documentación. Es posible que desee utilizar esta configuración para impedir que la aplicación acceda a Internet. También es posible que desee evitar que los usuarios descarguen conjuntos de documentación si utiliza una carpeta raíz compartida.

endpoints

  • Tipo: objeto

Contiene los puntos finales de URL de varios servicios que utiliza la aplicación. Cada punto final tiene una propiedad url que especifica la URL de ese servicio. Por lo general, no es necesario modificar estas URL.

Puede especificar cadenas vacías para las URL de los puntos finales con el fin de desactivar el acceso a esos servicios, pero si desea impedir por completo que la aplicación acceda a Internet, es mejor establecer allowedHosts en una cadena vacía tal y como se ha descrito anteriormente.

endpoints.documentationSets.url

  • Tipo: cadena de caracteres

La URL que utiliza la aplicación para la pestaña Biblioteca, donde los usuarios pueden consultar y descargar conjuntos de documentación. La URL predeterminada es https://doc.esri.com/offline-help/packages/all, que es el repositorio en línea de conjuntos de documentación de Esri.

Por lo general, no es necesario modificar esta URL.

Si se accede directamente a la URL predeterminada en un navegador web, no se mostrarán los conjuntos de documentación. Solo la aplicación puede acceder a la URL.

endpoints.webHelp.url

  • Tipo: cadena de caracteres

La URL de la versión en línea de la documentación a la que se accede cuando un usuario abre la ayuda del Centro de documentación de ArcGIS desde el botón Menú > Ayuda.

Por lo general, no es necesario modificar esta URL.

endpoints.softwareUpdate.url

  • Tipo: cadena de caracteres

La aplicación no utiliza esta propiedad en este momento.

webServer

  • Tipo: objeto

Contiene la configuración del servidor web local que se incluye con la aplicación. Las subpropiedades incluyen defaultFileNames, portPreferences, portScan y rootFolder, que se describen con más detalle a continuación.

webServer.defaultFileNames

  • Tipo: matriz de cadenas de caracteres

Especifica los nombres y tipos de archivo que se abrirán cuando no se haya definido una ruta concreta. Modificar este objeto no suele ser necesario.

El valor predeterminado es ["index.html", "default.html"].

webServer.portPreferences

  • Tipo: matriz de objetos con las propiedades order y port

La propiedad order define el orden de preferencia para que el servidor local utilice el especificado port. La aplicación intentará utilizar primero el puerto order 0, y después order 1 y 2.

La propiedad port especifica el número de puerto a usar para el servidor local. Los números de puerto predeterminados son 13774, 13322 y 14357.

Si ninguno de los puertos preferidos está disponible, la aplicación buscará automáticamente un puerto disponible utilizando la configuración webServer.portScan.

Si todos los números de puerto son iguales, la aplicación solo intentará conectarse a ese número de puerto concreto y, si no está disponible, pasará a buscar automáticamente un puerto disponible.

webServer.portScan

  • Tipo: objeto con las propiedades minValue, maxValue y limit

Las propiedades minValue y maxValue definen el rango de números de puerto que se debe analizar para buscar un puerto disponible en caso de que los puertos preferidos definidos en webServer.portPreferences no estén disponibles. La propiedad limit define cuántos puertos aleatorios se deben probar dentro de ese rango antes de dar por perdido el intento.

El rango predeterminado es de 20000 a 30000, y el número predeterminado de intentos es 10.

Para limitar a un solo puerto de reserva, establezca minValue y maxValue en el mismo número de puerto, y establezca limit en 1.

webServer.rootFolder

  • Tipo: cadena de caracteres

Especifica la carpeta raíz en la que se descargarán los conjuntos de documentación y desde la que se accederá a ellos. Puede tratarse de una ruta local o de una ruta de red. El valor predeterminado es C:\\Users\\<username>\\Documents\\ArcGIS\\DocCenter\\rootFolder, donde <username> es nombre de usuario de Windows.

Para especificar una ruta de red para una carpeta raíz compartida, utilice el formato UNC: \\\\<server_name>\\<folder_path>. Por ejemplo, un servidor llamado Polaris tiene una carpeta raíz compartida doc_share\arcgis_docsets en la que se almacenarán los conjuntos de documentos: \\\\Polaris\\doc_share\\arcgis_docsets.

language

  • Tipo: cadena de caracteres

Especifica el idioma de visualización de la interfaz de la aplicación. Los valores válidos son los códigos de idioma que se indican a continuación.

  • de: alemán

  • en: inglés

  • es: español

  • fr: francés

  • ja: japonés

  • ru: ruso

  • zh-CN: chino simplificado

Tenga en cuenta que el idioma de la interfaz puede diferir del idioma de los conjuntos de documentación descargados. Por ejemplo, un usuario puede optar por visualizar la interfaz de la aplicación en inglés mientras descarga conjuntos de documentación en japonés.

Se aplica un filtro predeterminado a la lista de conjuntos de documentación de la aplicación en función del idioma de visualización. Por ejemplo, si el idioma de visualización es el inglés, en la aplicación solo se mostrarán de forma predeterminada los conjuntos de documentación con contenido en inglés. Los usuarios pueden desactivar el filtro para ver y descargar conjuntos de documentación en otros idiomas.

theme

  • Tipo: cadena de caracteres

Especifica el tema de la interfaz de la aplicación. Los valores válidos son:

  • Theme.Auto: la aplicación utilizará el mismo tema que el del sistema operativo. Si el usuario ha configurado el tema de Windows en claro, la aplicación utilizará un tema claro. Si el usuario ha configurado el tema de Windows en oscuro, la aplicación utilizará un tema oscuro.

  • Theme.Light: la aplicación utilizará un tema claro.

  • Theme.Dark: la aplicación utilizará un tema oscuro.