Zum Inhalt springen

Startkonfiguration im Jitterbit App Builder

Einführung

Diese Seite beschreibt die Startkonfigurationsparameter und -methoden des App Builders. Jeder Abschnitt ist das oberste Schema für die JSON-Form (appsettings.json) Konfigurationsmethode.

Wenn der App Builder startet, erhält er seine Konfigurationswerte aus einer der folgenden Quellen, in der Reihenfolge der Priorität:

  1. Systemumgebungsvariablen.
  2. Eine ASP.NET Core appsettings.json JSON-Datei.
  3. Eine connection.xml XML-Datei mit einem <ConnectionInfo> Element.

Systemumgebungsvariablen sind die JSON-Schemas, Unterschemas (falls vorhanden) und Schlüssel, die durch zwei Unterstriche getrennt sind. Es gibt keine Standard-appsettings.json Datei. Sie können eine im Installationsverzeichnis mit den Beispielen in C:\inetpub\wwwroot\App Builder\ (Windows) oder im Unterverzeichnis samples (Linux) erstellen, von denen viele auf dieser Seite reproduziert sind.

Als Beispiel bieten die folgenden Konfigurationsmethoden äquivalente Werte:

Umgebungsvariablen
ConnectionInfo__DatabaseType=SQLServer
ConnectionInfo__HostName=localhost
ConnectionInfo__DatabaseName=App Builder
ConnectionInfo__UserName=vinyl
ConnectionInfo__Password=P@5$w0rD
appsettings.json Datei
{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "vinyl",
    "Password": "P@5$w0rD"
  }
}
connection.xml Datei
<ConnectionInfo DatabaseType="MySQL" HostName="localhost" DatabaseName="App Builder" UserName="vinyl" Password="P@5$w0rD"/>

AiServices

Schema Schlüssel Werttyp Beschreibung
AiServices OpenAi Schema OpenAI-Optionen.
Schema Schlüssel Werttyp Beschreibung
OpenAi ApiKey String API-Schlüssel des OpenAI-Kontos.
Timeout Integer HTTP-Timeout (Sekunden).

Beispiele

JSON
{
  "AiServices": {
    "OpenAi": {
      "ApiKey": "[OpenAiKey]",
      "Timeout": 300
    }
  }
}

BackgroundService

Schema Schlüssel Werttyp Beschreibung
BackgroundService DisableScheduler Boolean Auf true setzen, um den background services scheduler zu deaktivieren.

Beispiele

JSON
{
  "BackgroundService": {
    "DisableScheduler": true
  }
}
Umgebungsvariable
BackgroundService__DisableScheduler=true

ConnectionInfo

Schema Schlüssel Werttyp Beschreibung
ConnectionInfo DatabaseType String Datenbanktyp: SQLServer, MySQL, PostgreSql
HostName String Hostname oder IP-Adresse des Datenbankservers.
Port Integer Portnummer des Datenbankservers.
InstanceName String Instanzname des Datenbankservers.
TenantName String Für interne Verwendung.
DatabaseName String Datenbankname des App Builders.
UserName String Benutzername der Datenbank des App Builders.
Password String Passwort der Datenbank des App Builders.
ConnectionTimeout Integer Zeitüberschreitung für die Datenbankverbindung (Sekunden).
CommandTimeout Integer Zeitüberschreitung für Datenbankbefehle (Sekunden).
MaxPoolSize Integer Maximale Anzahl von Datenbankverbindungen im Pool.
Advanced Objektarray Zusätzliche Schlüssel/Wert-Paare für die Verbindungszeichenfolge.

Beispiele

{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "App Builder",
    "Password": "password",
    "Advanced": "MultiSubnetFailover=true;TrustServerCertificate=true;"
  }
}

DataEncryption

Der Abschnitt DataEncryption konfiguriert die Speicherung und Verschlüsselung des Datenverschlüsselungsschlüssels (DEK).

Schema Schlüssel Werttyp Beschreibung
DataEncryption Certificate String Base64-kodiertes, PKCS#12 (PFX) X.509-Zertifikat.
CertificatePassword String Passwort für das X.509-Zertifikat.
CertificateThumbprint String Fingerabdruck des X.509-Zertifikats.
Directory String Pfad zum Verzeichnis im Dateisystem.
Import String Speicher- und Verschlüsselungsrichtlinien für den Import von DEKs.
KeyEncryption String Datenverschlüsselungsstrategie:
  • Certificate: X.509-Zertifikatverschlüsselungspolitik.
  • Kms: AWS KMS-Schlüsselverschlüsselungspolitik.
  • None: Keine Schlüsselverschlüsselungspolitik. Schlüssel werden im Klartext gespeichert.
  • Null: Durchlauf-Schlüsselverschlüsselungspolitik. Schlüssel werden im Klartext gespeichert.
KeyStorage String Speicherort des Datenverschlüsselungsschlüssels:
  • Datenbank: App Builder-Datenbank.
  • Dateisystem: Dateisystem.
  • ParameterStore: AWS System Manager Parameter Store.
  • S3: S3-Bucket.
KmsKeyId String AWS KMS-Schlüssel-ARN.
ParameterNamePrefix String Präfix für den Parametername im AWS System Manager Parameter Store.
S3BucketEndpoint String S3-Bucket-Endpunkt.
S3KeyPrefix String S3-Schlüsselpräfix.

Beispiele

{
  "DataEncryption": {
    "KeyEncryption": "Certificate",
    "CertificateThumbprint": "a909502dd82ae41433e6f83886b00d4277a32a7b",
    "Certificate": "{base64-pfx-data}",
    "CertificatePassword": "your-certificate-password"
  }
}

{
  "DataEncryption": {
    "KeyEncryption": "Kms",
    "KmsKeyId": "{kms-key-arn}"
  }
}

{
  "DataEncryption": {
    "KeyEncryption": "None"
  }
}

{
  "DataEncryption": {
    "KeyEncryption": "Null"
  }
}

{
  "DataEncryption": {
    "KeyStorage": "Database"
  }
}

{
  "DataEncryption": {
    "KeyStorage": "FileSystem",
    "Directory": "C:\\Path\\To\\Keys"
  }
}

{
  "DataEncryption": {
    "KeyStorage": "ParameterStore",
    "ParameterNamePrefix": "/production"
  }
}

{
  "DataEncryption": {
    "KeyStorage": "S3",
    "S3BucketEndpoint": "https://{bucket}.s3{-aws-region}.amazonaws.com",
    "S3KeyPrefix": "production"
  }
}

Kestrel

Der Kestrel-Abschnitt konfiguriert den Kestrel-Webserver.

Schema Schlüssel Werttyp Beschreibung
Kestrel Limits MaxRequestBodySize Siehe die Kestrel documentation für eine Liste der unterstützten Optionen.

License

Der License-Abschnitt gibt den Lizenzschlüssel des App Builders an.

Schema Schlüssel Werttyp Beschreibung
License LicenseKey String Eine base64-codierte Version Ihrer vinyl.lic-Datei.

Examples

{
  "License": {
    "LicenseKey": "TWF1cmlzIGFjIGZlbGlzIHZlbCB2ZWxpdCB0cmlzdGlxdWUgaW1wZXJkaWV0LiAgTnVsbGFtIGV1IGFudGUgdmVsIGVzdCBjb252YWxsaXMgZGlnbmlzc2ltLiAgRnVzY2Ugc3VzY2lwaXQsIHdpc2kgbmVjIGZhY2lsaXNpcyBmYWNpbGlzaXMsIGVzdCBkdWkgZmVybWVudHVtIGxlbywgcXVpcyB0ZW1wb3IgbGlndWxhIGVyYXQgcXVpcyBvZGlvLiAgTnVuYyBwb3J0YSB2dWxwdXRhdGUgdGVsbHVzLiAgTnVuYyBydXRydW0gdHVycGlzIHNlZCBwZWRlLiAgU2VkIGJpYmVuZHVtLiAgQWxpcXVhbSBwb3N1ZXJlLiAgTnVuYyBhbGlxdWV0LCBhdWd1ZSBuZWMgYWRpcGlzY2luZyBpbnRlcmR1bSwgbGFjdXMgdGVsbHVzIG1hbGVzdWFkYSBtYXNzYSwgcXVpcyB2YXJpdXMgbWkgcHVydXMgbm9uIG9kaW8uICBQZWxsZW50ZXNxdWUgY29uZGltZW50dW0sIG1hZ25hIHV0IHN1c2NpcGl0IGhlbmRyZXJpdCwgaXBzdW0gYXVndWUgb3JuYXJlIG51bGxhLCBub24gbHVjdHVzIGRpYW0gbmVxdWUgc2l0IGFtZXQgdXJuYS4gIEN1cmFiaXR1ciB2dWxwdXRhdGUgdmVzdGlidWx1bSBsb3JlbS4gIEZ1c2NlIHNhZ2l0dGlzLCBsaWJlcm8gbm9uIG1vbGVzdGllIG1vbGxpcywgbWFnbmEgb3JjaSB1bHRyaWNlcyBkb2xvciwgYXQgdnVscHV0YXRlIG5lcXVlIG51bGxhIGxhY2luaWEgZXJvcy4gIFNlZCBpZCBsaWd1bGEgcXVpcyBlc3QgY29udmFsbGlzIHRlbXBvci4gIEN1cmFiaXR1ciBsYWNpbmlhIHB1bHZpbmFyIG5pYmguICBOYW0gYSBzYXBpZW4uCg=="
  }
}

Packaging

Dieser Abschnitt ermöglicht es Administratoren, den Speicherort für Pakete zu konfigurieren. Es gibt drei Optionen: eine Datenbank (die Standardoption), das Dateisystem oder einen AWS S3-Bucket.

Schema Schlüssel Werttyp Beschreibung
Packaging PackageStore String Der Speichertyp, einer von Database, FileSystem oder S3.
S3BucketEndpoint String Für S3-Speicher, die [Bucket-Endpunkt-URL].
S3KeyPrefix String Für S3-Speicher, das [Bucket-Schlüsselpräfix].
Directory String Für FileSystem, der vollständige Pfad zum Speicher. Wenn nicht angegeben, wird das Standarddatenverzeichnis verwendet.

Beispiele

Datenbankspeicher
{
  "Packaging": {
    "PackageStore": "Database"
  }
}
Dateispeicher
{
  "Packaging": {
    "PackageStore": "FileSystem",
    "Directory": "C:\\Packages"
  }
}
S3-Speicher
{
  "Packaging": {
    "PackageStore": "S3",
    "S3BucketEndpoint": "https://my-aws-domain.s3.us-east-1.amazonaws.com",
    "S3KeyPrefix": "vinyl/"
  }
}

PostgreSQL

Schema Schlüssel Werttyp Beschreibung
PostgreSQL Logging
OpenTelemetry

ReverseProxy

Der Abschnitt ReverseProxy konfiguriert einen Reverse-Proxy.

Schema Schlüssel Werttyp Beschreibung
ReverseProxy ForwardedClientIpHeader String HTTP-Header, der die ursprüngliche Client-IP-Adresse weiterleitet.
ForwardedSchemeHeader String HTTP-Header, der das ursprüngliche Schema weiterleitet.
ForwardedHostHeader String HTTP-Header, der den ursprünglichen Host und optionalen Port weiterleitet.
ForwardedPortHeader String HTTP-Header, der den ursprünglichen Port weiterleitet.

Beispiele

{
  "ReverseProxy": {
    "ForwardedClientIpHeader": "X-Forwarded-For",
    "ForwardedSchemeHeader": "X-Forwarded-Proto",
    "ForwardedHostHeader": "X-Forwarded-Host"
  }
}

{
  "ReverseProxy": {
    "ForwardedClientIpHeader": "X-Forwarded-For",
    "ForwardedSchemeHeader": "X-Forwarded-Proto",
    "ForwardedPortHeader": "X-Forwarded-Port"
  }
}

Sicherheit

Der Abschnitt Sicherheit konfiguriert Benutzerkonten und Sicherheitsanbieter für den App Builder.

Schema Schlüssel Werttyp Beschreibung
Sicherheit Administrator Schema Optionen für Admin-Konten.
InvitationUrl String Nur für interne Verwendung.
LocalAuthentication Schema Optionen für lokale Benutzer-Sicherheitsanbieter.
Provider String Base64-kodierte Sicherheitsanbieter Konfiguration.
Providers String-Array base64-kodierte Sicherheitsanbieter-Konfiguration.
AuthenticationExpiry Integer Ablauf der Authentifizierungstoken in Minuten.
Schema Key Value Type Beschreibung
Administrator AllowLocalAuthentication Boolean Ermöglicht die lokale Benutzerauthentifizierung.
ChangePasswordOnLogin Boolean Zwingt den Benutzer, das Passwort bei der Anmeldung zu ändern.
DefaultPassword String Standardpasswort. Wird einmal bei der Installation angewendet.
Password String Passwort. Wird jedes Mal angewendet, wenn das System startet.
Schema Key Value Type Beschreibung
LocalAuthentication Enabled Boolean Aktiviert den Sicherheitsanbieter.
ShowOnLoginForm Boolean Bestimmt, ob der Benutzerauthentifizierungsanbieter im Anmeldeformular angezeigt wird.

Beispiele

{
  "Security": {
    "Administrator": {
      "Password": "s3cr3t",
      "ChangePasswordOnLogin": false
    },
    "LocalAuthentication": {
      "ShowOnLoginForm": false
    },
    "Provider": "Tm90aGluZyBjYW4gY29tZSBvZiBub3RoaW5nLCBzcGVhayBhZ2Fpbi4="
  }
}

Scripting

Der Abschnitt Scripting konfiguriert das C# Scripting SDK von App Builder.

Schema Key Value Type Beschreibung
Scripting Enabled Boolean Aktiviert C# Scripting.

Beispiele

{
  "Scripting": {
    "Enabled": false
  }
}

SharedState

Der Abschnitt SharedState konfiguriert den Dienst für den gemeinsamen Zustand, der Mehrserver-Bereitstellungen unterstützt.

Schema Key Value Type Beschreibung
SharedState Provider String Anbieter für gemeinsamen Zustand:
  • InProcess: Zustand wird im Prozess für Einzelserver-Bereitstellungen gespeichert.
  • Redis: Zustand wird in Redis für Mehrserver-Bereitstellungen gespeichert.
RedisConnectionString String Redis-Verbindungszeichenfolge.
RedisPrefix String Redis-Schlüsselpräfix.

Beispiel

{
  "SharedState": {
    "Provider": "Redis",
    "RedisConnectionString": "localhost:6379"
  }
}

SignalR

Der Abschnitt SignalR konfiguriert die Kommunikation zwischen Client und Server.

Schema Schlüssel Werttyp Beschreibung
SignalR LongPollingTimeout String Timeout für Long-Polling, angegeben im TimeSpan-Format. Beispiel: 00:00:30.
Transports String Durch Kommas getrennte Liste von HTTP-Transporttypen:
  • LongPolling: Long-Polling.
  • None: Keine Transports. NICHT UNTERSTÜTZT.
  • ServerSentEvents: Vom Server gesendete Ereignisse.
  • WebSockets: WebSockets
.

Beispiele

{
  "SignalR": {
    "Transports": "WebSockets,LongPolling",
    "LongPollingTimeout": "00:00:30"
  }
}

Site

Der Abschnitt Site konfiguriert die Adresse der App Builder-Website und bekannte Aliase.

Schema Schlüssel Werttyp Beschreibung
Site Url String Kanonische URL der Website.
Default Boolean Als Standard-Website behandeln.
Redirect Boolean Clients zur Website-URL umleiten.
RedirectIfHeaderExists String HTTP-Header, der angibt, dass Clients umgeleitet werden sollen.
AllowCrossOrigin Boolean Cross-Origin-Anfragen zulassen.
Aliases String-Array Website-Aliase.

Beispiele

{
  "Site": {
    "Url": "https://example.com/Vinyl",
    "Default": true,
    "Redirect": true,
    "RedirectIfHeaderExists": "X-Forwarded-For",
    "Aliases": [
      {
        "Url": "https://vinyl.example.com"
      }
    ]
  }
}

Sku

Schema Schlüssel Werttyp Beschreibung
Sku Sku Zeichenfolge

Tls

Der Abschnitt Tls konfiguriert die Unterstützung des TLS-Protokolls.

Schema Schlüssel Werttyp Beschreibung
Tls SecurityProtocol Zeichenfolge Durch Kommas getrennte Liste von Sicherheitsprotokollen:
  • Tls12: TLS 1.2
  • Tls13: TLS 1.3

Beispiele

{
  "Tls": {
    "SecurityProtocol": "Tls,Tls11,Tls12"
  }
}

UrlRewrite

Der Abschnitt UrlRewrite konfiguriert die Unterstützung für URL-Umschreibungen.

Schema Schlüssel Werttyp Beschreibung
UrlRewrite OriginalUrlHeader Zeichenfolge HTTP-Header, der die ursprüngliche URL weiterleitet.

Beispiele

{
  "UrlRewrite": {
    "OriginalUrlHeader": "X-Original-URL"
  }
}