Skip to main content

Référence du fichier appSettings.json

Le fichier appSettings.json est un fichier de configuration utilisé par ArcGIS Documentation Center pour stocker les paramètres de l’application. Les administrateurs informatiques peuvent créer et déployer un fichier appSettings.json personnalisé pour configurer l’application pour plusieurs utilisateurs. Cette rubrique décrit tous les paramètres du fichier.

Structure du fichier appSettings.json

Le fichier appSettings.json est un fichier JSON avec la structure suivante :

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

Paramètres appSettings.json

init

  • Type : booléen

Indique si l’application a été initialisée avec des paramètres. Cette fonction est définie sur true après la première exécution de l’assistant de configuration. Les administrateurs informatiques peuvent définir ce paramètre sur true pour ignorer l’exécution de l’assistant de configuration lors du lancement initial de l’application. Si vous définissez init sur false, l’assistant de configuration s’ouvre lorsque l’utilisateur lance l’application. Par conséquent, si vous déployez un fichier appSettings.json personnalisé, vous devez définir init sur true pour empêcher l’ouverture de l’assistant de configuration et l’éventuel remplacement de vos paramètres personnalisés.

allowedHosts

  • Type : chaîne

Précise les hôtes auxquels l’application peut accéder. Utilisez ce paramètre pour contrôler l’accès au réseau. Les valeurs suivantes peuvent être définies :

  • * (astérisque) pour permettre l’accès à tous les hôtes.

  • Liste d’hôtes spécifiques, séparée par une virgule, comme doc.esri.com,example.com. En général, il n’est pas nécessaire de spécifier plusieurs hôtes.

  • Un hôte unique permet d’accéder à un seul hôte, tel que doc.esri.com.

  • Une chaîne vide ("") permet de bloquer l’accès au réseau. Cela désactive les fonctionnalités nécessitant un accès au réseau, comme le téléchargement de kits de documentation. Vous pouvez utiliser ce paramètre pour empêcher l’application d’accéder à Internet. Vous pouvez aussi empêcher les utilisateurs de télécharger des kits de documentation si vous utilisez un dossier racine partagé.

endpoints

  • Type : objet

Contient des points de terminaison d’URL pour divers services utilisés par l’application. Chaque point de terminaison possède une propriété url qui spécifie l’URL de ce service. Il n’est généralement pas nécessaire de modifier ces URL.

Vous pouvez spécifier des chaînes vides pour les URL des points de terminaison afin de désactiver l’accès à ces services, mais si vous souhaitez empêcher l’application d’accéder à Internet, il vaut mieux définir allowedHosts sur une chaîne vide, comme décrit ci-dessus.

endpoints.documentationSets.url

  • Type : chaîne

URL que l’application utilise pour l’onglet Library (Bibliothèque), où les utilisateurs peuvent parcourir et télécharger les kits de documentation. L’URL par défaut est https://doc.esri.com/offline-help/packages/all, qui est le référentiel en ligne des kits de documentation d’Esri.

Il n’est généralement pas nécessaire de modifier cette URL.

Si vous accédez directement à l’URL par défaut dans un navigateur Web, les kits de documentation ne s’affichent pas. Seule l’application peut accéder à l’URL.

endpoints.webHelp.url

  • Type : chaîne

URL de la version en ligne de la documentation, qui est utilisée lorsqu’un utilisateur ouvre l’aide d’ArcGIS Documentation Center à partir du bouton Menu > Help (Aide).

Il n’est généralement pas nécessaire de modifier cette URL.

endpoints.softwareUpdate.url

  • Type : chaîne

Cette propriété n’est pas utilisée actuellement par l’application.

webServer

  • Type : objet

Contient les paramètres du serveur Web local inclus avec l’application. Les sous-propriétés sont les suivantes : defaultFileNames, portPreferences, portScan et rootFolder. Elles sont décrites de façon plus détaillée ci-dessous.

webServer.defaultFileNames

  • Type : tableau de chaînes

Spécifie les noms et types des fichiers qui sont ouverts lorsqu’aucun chemin d’accès spécifique n’est défini. Il n’est généralement pas nécessaire de modifier cet objet.

La valeur par défaut est ["index.html", "default.html"].

webServer.portPreferences

  • Type : tableau d’objets avec les propriétés order et port

La propriété order définit l’ordre de préférence utilisé par le serveur local pour le fichier port spécifié. L’application tente d’abord d’utiliser le port avec la propriété order 0, puis order 1 et 2.

La propriété port spécifie le numéro de port que le serveur local doit utiliser. Les numéros de port par défaut sont 13774, 13322 et 14357.

Si aucun des ports préférés n’est disponible, l’application trouve automatiquement un port disponible à l’aide des paramètres webServer.portScan.

Si tous les numéros de port sont identiques, l’application n’essaie que ce numéro de port, puis revient trouver automatiquement un port disponible si celui-ci ne l’est pas.

webServer.portScan

  • Type : objet avec les propriétés minValue, maxValue et limit

Les propriétés minValue et maxValue définissent la plage inclusive des numéros de port à scanner pour rechercher un port disponible, si les ports préférés définis dans webServer.portPreferences ne le sont pas. La propriété limit définit le nombre de ports aléatoires à essayer dans cette plage avant d’abandonner.

La plage par défaut est comprise entre 20000 et 30000, et le nombre de tentatives par défaut est 10.

Pour limiter l’opération à un seul port de secours, définissez minValue et maxValue sur le même numéro de port, puis définissez limit sur 1.

webServer.rootFolder

  • Type : chaîne

Spécifie le dossier racine où les kits de documentation seront téléchargés et consultés. Il peut s’agir d’un chemin d’accès local ou réseau. La valeur par défaut est C:\\Users\\<username>\\Documents\\ArcGIS\\DocCenter\\rootFolder, où <username> est le nom d’utilisateur Windows.

Pour spécifier un chemin réseau pour un dossier racine partagé, utilisez le format UNC : \\\\<server_name>\\<folder_path>. Par exemple, un serveur nommé Polaris possède un dossier racine partagé doc_share\arcgis_docsets, où seront stockés les kits de documentation : \\\\Polaris\\doc_share\\arcgis_docsets.

language

  • Type : chaîne

Spécifie la langue d’affichage de l’interface de l’application. Les valeurs valides sont les codes de langue répertoriés ci-dessous.

  • de : allemand

  • en : anglais

  • es : espagnol

  • fr : français

  • ja : japonais

  • ru : russe

  • zh-CN : chinois simplifié

Notez que la langue d’affichage peut être différente de celle des kits de documentation téléchargés. Par exemple, un utilisateur peut choisir d’afficher l’interface de l’application en anglais tout en téléchargeant les kits de documentation en japonais.

Un filtre par défaut est appliqué à la liste des kits de documentation dans l’application en fonction de la langue d’affichage. Par exemple, si la langue d’affichage est l’anglais, seuls les kits de documentation avec un contenu en anglais sont affichés par défaut dans l’application. Les utilisateurs peuvent effacer le filtre pour consulter et télécharger des kits de documentation dans d’autres langues.

theme

  • Type : chaîne

Spécifie le thème de l’interface de l’application. Les valeurs valides sont :

  • Theme.Auto : l’application utilise le même thème que le système d’exploitation. Si l’utilisateur a défini son thème Windows sur clair, l’application utilise un thème clair. Si l’utilisateur a défini son thème Windows sur foncé, l’application utilise un thème foncé.

  • Theme.Light : l’application utilise un thème clair.

  • Theme.Dark : l’application utilise un thème foncé.