Skip to main content

Die Referenz für die appSettings.json-Datei

Die appSettings.json-Datei ist eine Konfigurationsdatei, die von ArcGIS Documentation Center zum Speichern von Anwendungseinstellungen verwendet wird. IT-Administratoren können eine benutzerdefinierte appSettings.json-Datei erstellen und bereitstellen, um die App für mehrere Benutzer zu konfigurieren. In diesem Thema werden alle Einstellungen in der Datei beschrieben.

Struktur der appSettings.json-Datei

Die appSettings.json-Datei ist eine JSON-Datei mit der folgenden Struktur:

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

appSettings.json-Parameter

init

  • Typ: Boolesch

Gibt an, ob die App mit den Einstellungen initialisiert wurde. Dieser Parameter wird auf true festgelegt, nachdem der Konfigurationsassistent zum ersten Mal ausgeführt wurde. IT-Administratoren können ihn auf true festlegen, um den Konfigurationsassistenten zu überspringen, wenn die App zum ersten Mal gestartet wird. Wenn init auf false festgelegt wird, wird der Konfigurationsassistent geöffnet, sobald der Benutzer die App startet. Wenn Sie also eine benutzerdefinierte appSettings.json-Datei bereitstellen, müssen Sie init auf true festlegen, um zu verhindern, dass der Konfigurationsassistent geöffnet wird und Ihre benutzerdefinierten Einstellungen womöglich überschrieben werden.

allowedHosts

  • Typ: String

Gibt an, auf welche Hosts die App zugreifen kann. Verwenden Sie diese Einstellung, um den Netzwerkzugang zu steuern. Der Wert kann wie folgt festgelegt werden:

  • * (Sternchen), um den Zugriff auf alle Hosts zuzulassen.

  • Eine durch Kommas getrennte Liste mit bestimmten Hosts, z. B. doc.esri.com,example.com. Mehrere Hosts anzugeben ist in der Regel nicht notwendig.

  • Ein einzelner Host, um den Zugriff auf nur einen Host zuzulassen, z. B. doc.esri.com.

  • Eine leere Zeichenkette (""), um den gesamten Netzwerkzugriff zu blockieren. Damit werden Funktionen deaktiviert, für die Netzwerkzugriff erforderlich ist, wie das Herunterladen von Dokumentationspaketen. Sie können diese Einstellung verwenden, um zu verhindern, dass die App auf das Internet zugreift. Wenn Sie einen freigegebenen Stammordner verwenden, möchten Sie möglicherweise auch verhindern, dass Benutzer Dokumentationspakete herunterladen.

endpoints

  • Typ: Objekt

Enthält URL-Endpunkte für verschiedene, von der App verwendete Services. Jeder Endpunkt verfügt über eine url-Eigenschaft, die die URL für den jeweiligen Service angibt. Diese URLs müssen in der Regel nicht geändert werden.

Sie können für die Endpunkt-URLs leere Zeichenfolgen angeben, um den Zugriff auf diese Services zu deaktivieren. Wenn Sie jedoch verhindern möchten, dass die App überhaupt auf das Internet zugreift, sollten Sie allowedHosts wie oben beschrieben auf eine leere Zeichenfolge festlegen.

endpoints.documentationSets.url

  • Typ: String

Die URL, die von der App für die Registerkarte Bibliothek verwendet wird, auf der Benutzer nach Dokumentationspaketen suchen und diese herunterladen können. Die Standard-URL lautet https://doc.esri.com/offline-help/packages/all, das Online-Repository von Esri für Dokumentationspakete.

Diese URL muss in der Regel nicht geändert werden.

Wenn Sie die Standard-URL direkt in einem Webbrowser aufrufen, werden keine Dokumentationspakete angezeigt. Nur die App kann auf die URL zugreifen.

endpoints.webHelp.url

  • Typ: String

Die URL für die Online-Version der Dokumentation, die verwendet wird, wenn ein Benutzer die Hilfe für ArcGIS Documentation Center über die Schaltfläche Menü > Hilfe öffnet.

Diese URL muss in der Regel nicht geändert werden.

endpoints.softwareUpdate.url

  • Typ: String

Diese Eigenschaft wird von der App derzeit nicht verwendet.

webServer

  • Typ: Objekt

Enthält Einstellungen für den lokalen Webserver, der in der App enthalten ist. Zu den Untereigenschaften gehören defaultFileNames, portPreferences, portScan und rootFolder. Diese werden im Folgenden ausführlicher beschrieben.

webServer.defaultFileNames

  • Typ: Array aus Zeichenfolgen

Gibt die Namen und Typen der Dateien an, die geöffnet werden, wenn ein bestimmter Pfad nicht definiert ist. Dieses Objekt muss in der Regel nicht geändert werden.

Der Standardwert ist ["index.html", "default.html"].

webServer.portPreferences

  • Typ: Array von Objekten mit den Eigenschaften order und port

Die Eigenschaft order legt die Priorität fest, mit der der lokale Server die angegebene Eigenschaft port verwenden soll. Die App versucht zuerst den Port mit order 0, dann order 1 und 2 zu verwenden.

Die Eigenschaft port gibt die Portnummer an, die für den lokalen Server verwendet werden soll. Die Standard-Portnummern lauten 13774, 13322 und 14357.

Wenn keiner der bevorzugten Ports verfügbar ist, sucht die App mithilfe der webServer.portScan-Einstellungen automatisch nach einem verfügbaren Port.

Wenn alle Portnummern identisch sind, probiert die App nur diese eine Portnummer aus und weicht dann auf die automatische Suche nach einem verfügbaren Port aus, falls dieser nicht verfügbar ist.

webServer.portScan

  • Typ: Objekt mit den Eigenschaften minValue, maxValue, und limit

Die Eigenschaften minValue und maxValue legen den einschließenden Bereich der Portnummern fest, der durchsucht wird, um einen verfügbaren Port zu finden, wenn die in webServer.portPreferences definierten bevorzugten Ports nicht verfügbar sind. Die Eigenschaft limit legt fest, wie viele zufällige Ports innerhalb dieses Bereichs ausprobiert werden sollen, bevor die Versuche abgebrochen werden.

Der Standardbereich liegt zwischen 20000 und 30000, und die Standardanzahl der Versuche beträgt 10.

Wenn Sie die Auswahl auf einen einzigen Fallback-Port beschränken möchten, legen Sie für minValue und maxValue dieselbe Portnummer fest, und legen Sie limit auf 1 fest.

webServer.rootFolder

  • Typ: String

Gibt den Stammordner an, in den Dokumentationspakete heruntergeladen und von dem aus auf sie zugegriffen wird. Das kann ein lokaler Pfad oder ein Netzwerkpfad sein. Der Standardwert lautet C:\\Users\\<username>\\Documents\\ArcGIS\\DocCenter\\rootFolder, wobei <username> der Windows-Benutzername ist.

Zum Angeben eines Netzwerkpfads für einen freigegebenen Stammordner verwenden Sie das UNC-Format: \\\\<server_name>\\<folder_path>. Auf einem Server mit dem Namen Polaris befindet sich beispielsweise der freigegebene Stammordner doc_share\arcgis_docsets, in dem Dokumentationspakete gespeichert werden: \\\\Polaris\\doc_share\\arcgis_docsets.

language

  • Typ: String

Gibt die Anzeigesprache für die Bedienoberfläche der App an. Gültige Werte sind die unten aufgeführten Sprachcodes.

  • de: Deutsch

  • en: Englisch

  • es: Spanisch

  • fr: Französisch

  • ja: Japanisch

  • ru: Russisch

  • zh-CN: Vereinfachtes Chinesisch

Beachten Sie, dass die Anzeigesprache von der Sprache der heruntergeladenen Dokumentationspakete abweichen kann. So kann ein Benutzer beispielsweise die Bedienoberfläche der App auf Englisch anzeigen lassen, während er Dokumentationspakete auf Japanisch herunterlädt.

Auf die Liste der Dokumentationspakete in der App wird standardmäßig ein Filter angewendet, der sich nach der Anzeigesprache richtet. Wenn die Anzeigesprache beispielsweise Englisch ist, werden in der App standardmäßig nur Dokumentationspakete mit englischen Inhalten angezeigt. Benutzer können den Filter löschen, um Dokumentationspakete in anderen Sprachen anzuzeigen und herunterzuladen.

theme

  • Typ: String

Gibt das Design für die Bedienoberfläche der App an. Gültige Werte:

  • Theme.Auto: Für die App wird dasselbe Design wie für das Betriebssystem verwendet. Wenn der Benutzer für Windows das helle Design ausgewählt hat, wird für die App das helle Design verwendet. Wenn der Benutzer für Windows das dunkle Design ausgewählt hat, wird für die App das dunkle Design verwendet.

  • Theme.Light: Für die App wird das helle Design verwendet.

  • Theme.Dark: Für die App wird das dunkle Design verwendet.