App Builder
App_Builder
Startkonfiguration in Jitterbit App Builder
Einführung
Diese Seite beschreibt die Startkonfigurationsparameter und -methoden von App Builder. Jeder Abschnitt ist das Schema der obersten Ebene für die JSON-Formularkonfigurationsmethode (appsettings.json).
Beim Start von App Builder werden die Konfigurationswerte aus einer der folgenden Quellen in dieser Reihenfolge abgerufen:
Systemumgebungsvariablen.
Eine ASP.NET Core appsettings.json JSON-Datei.
Eine connection.xml XML-Datei mit einem <ConnectionInfo>-Element.
Systemumgebungsvariablen sind die JSON-Schemas, Unterschemas (falls vorhanden) und Schlüssel, getrennt durch zwei Unterstriche. Es gibt keine Standard-appsettings.json-Datei. Sie können eine im Installationsverzeichnis erstellen, indem Sie die Beispiele in C:\inetpub\wwwroot\App Builder\ (Windows) oder das Unterverzeichnis samples (Linux) verwenden. Viele davon werden auf dieser Seite reproduziert.
Als Beispiel stellen die folgenden Konfigurationsmethoden äquivalente Werte bereit:
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
OpenAI-Konto-API-Schlüssel.
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 [Hintergrund-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
Nur zur internen Verwendung.
DatabaseName
String
App Builder-Datenbankname.
UserName
String
App Builder-Datenbankbenutzername.
Password
String
App Builder-Datenbankpasswort.
ConnectionTimeout
Integer
Datenbankverbindungs-Timeout (Sekunden).
CommandTimeout
Integer
Datenbankbefehl-Timeout (Sekunden).
MaxPoolSize
Integer
Maximale Anzahl von Datenbankverbindungen im Pool.
Advanced
Objektarray
Zusätzliche Verbindungszeichenfolgen-Schlüssel/Wert-Paare.
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-codiertes X.509-Zertifikat im PKCS#12-Format (PFX).
CertificatePassword
String
X.509-Zertifikatpasswort.
CertificateThumbprint
String
X.509-Zertifikat-Fingerabdruck.
Directory
String
Dateisystem-Verzeichnispfad.
Import
String
Speicher- und Verschlüsselungsrichtlinien zum Importieren von DEKs.
KeyEncryption
String
Datenverschlüsselungsstrategie: Certificate: X.509-Zertifikatverschlüsselungsrichtlinie. Kms: AWS KMS-Schlüsselverschlüsselungsrichtlinie.None: Keine Schlüsselverschlüsselungsrichtlinie. Schlüssel werden im Klartext gespeichert.Null: Passthrough-Schlüsselverschlüsselungsrichtlinie. Schlüssel werden im Klartext gespeichert.
KeyStorage
String
Speicherort des Datenverschlüsselungsschlüssels:Database: App Builder-Datenbank. FileSystem: Dateisystem. ParameterStore: AWS System Manager Parameter Store. S3: S3-Bucket.
KmsKeyId
String
AWS KMS-Schlüssel-ARN.
ParameterNamePrefix
String
Präfix für Parameternamen 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"
}
}
HttpRequestPolicy
Der Abschnitt HttpRequestPolicy konfiguriert Richtlinien, die ausgehende HTTP-Anfragen von App Builder blockieren oder zulassen. Standardmäßig blockiert App Builder Anfragen an den AWS Instance Metadata Service (IMDS) bei der Bereitstellung auf AWS Elastic Beanstalk.
Schema
Schlüssel
Werttyp
Beschreibung
HttpRequestPolicy
BlockedAddresses
String-Array
Blockierte IP-Adressen und Netzwerke im CIDR-Format.
AllowedHosts
String-Array
Zulässige IP-Adressen und Hostnamen.
Wichtig
Diese Richtlinie wird nur durchgesetzt, wenn App Builder selbst eine Verbindung zu Datenquellen und anderen Drittanbietern herstellt. Sie wird nicht auf Plugins durchgesetzt. Um zu verhindern, dass ein Plugin auf eine blockierte Ressource zugreift, deaktiviere Scripting .
Beispiele
AWS Instance Metadata Service blockieren {
"HttpRequestPolicy" : {
"BlockedAddresses" : [
"169.254.169.254" ,
"fd00:ec2::254"
]
}
}
Ein internes Netzwerk blockieren {
"HttpRequestPolicy" : {
"BlockedAddresses" : [
"10.0.0.0/8"
]
}
}
Bestimmte Hosts zulassen {
"HttpRequestPolicy" : {
"AllowedHosts" : [
"api.example.com"
]
}
}
Kestrel
Der Abschnitt Kestrel konfiguriert den Kestrel-Webserver. Es gibt mindestens zwei Ebenen:
Schema
Key
Value Type
Description
Kestrel
Limits
KestrelLimits
Das Schema Kestrel entspricht der Klasse KestrelServerOptions. Weitere Informationen findest du in der Kestrel-Dokumentation .
Schema
Key
Value Type
Description
KestrelLimits
MaxRequestBodySize
Integer
Das KestrelLimits-Schema entspricht der KestrelServerLimits-Klasse. Weitere Informationen finden Sie in der Kestrel-Dokumentation .
Beispiel
{
"Kestrel" : {
"Limits" : {
"MaxRequestBodySize" : 100000000
}
}
}
License
Der Abschnitt License gibt den App Builder-Lizenzschlüssel an.
Schema
Key
Value Type
Description
License
LicenseKey
String
Eine Base64-codierte Version der Lizenzdatei.
Beispiele
{
"License" : {
"LicenseKey" : "TWF1cmlzIGFjIGZlbGlzIHZlbCB2ZWxpdCB0cmlzdGlxdWUgaW1wZXJkaWV0LiAgTnVsbGFtIGV1IGFudGUgdmVsIGVzdCBjb252YWxsaXMgZGlnbmlzc2ltLiAgRnVzY2Ugc3VzY2lwaXQsIHdpc2kgbmVjIGZhY2lsaXNpcyBmYWNpbGlzaXMsIGVzdCBkdWkgZmVybWVudHVtIGxlbywgcXVpcyB0ZW1wb3IgbGlndWxhIGVyYXQgcXVpcyBvZGlvLiAgTnVuYyBwb3J0YSB2dWxwdXRhdGUgdGVsbHVzLiAgTnVuYyBydXRydW0gdHVycGlzIHNlZCBwZWRlLiAgU2VkIGJpYmVuZHVtLiAgQWxpcXVhbSBwb3N1ZXJlLiAgTnVuYyBhbGlxdWV0LCBhdWd1ZSBuZWMgYWRpcGlzY2luZyBpbnRlcmR1bSwgbGFjdXMgdGVsbHVzIG1hbGVzdWFkYSBtYXNzYSwgcXVpcyB2YXJpdXMgbWkgcHVydXMgbm9uIG9kaW8uICBQZWxsZW50ZXNxdWUgY29uZGltZW50dW0sIG1hZ25hIHV0IHN1c2NpcGl0IGhlbmRyZXJpdCwgaXBzdW0gYXVndWUgb3JuYXJlIG51bGxhLCBub24gbHVjdHVzIGRpYW0gbmVxdWUgc2l0IGFtZXQgdXJuYS4gIEN1cmFiaXR1ciB2dWxwdXRhdGUgdmVzdGlidWx1bSBsb3JlbS4gIEZ1c2NlIHNhZ2l0dGlzLCBsaWJlcm8gbm9uIG1vbGVzdGllIG1vbGxpcywgbWFnbmEgb3JjaSB1bHRyaWNlcyBkb2xvciwgYXQgdnVscHV0YXRlIG5lcXVlIG51bGxhIGxhY2luaWEgZXJvcy4gIFNlZCBpZCBsaWd1bGEgcXVpcyBlc3QgY29udmFsbGlzIHRlbXBvci4gIEN1cmFiaXR1ciBsYWNpbmlhIHB1bHZpbmFyIG5pYmguICBOYW0gYSBzYXBpZW4uCg=="
}
}
Packaging
In diesem Abschnitt können Administratoren den Speicherort für Pakete konfigurieren. Es gibt drei Optionen: eine Datenbank (Standard), das Dateisystem oder einen AWS S3-Bucket.
Schema
Key
Value Type
Description
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. Falls nicht angegeben, wird das Standard-Datenverzeichnis verwendet.
Beispiele
Datenbankspeicher {
"Packaging" : {
"PackageStore" : "Database"
}
}
Dateisystemspeicher {
"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
Key
Value Type
Description
PostgreSQL
Logging
OpenTelemetry
ReverseProxy
Der Abschnitt ReverseProxy konfiguriert einen Reverse Proxy.
Schema
Key
Value Type
Description
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"
}
}
Security
Der Abschnitt Security konfiguriert App Builder-Benutzerkonten und Sicherheitsanbieter.
Schema
Key
Value Type
Description
Security
Administrator
Schema
Optionen für das Admin-Konto.
InvitationUrl
String
Nur zur internen Verwendung.
LocalAuthentication
Schema
Optionen für den lokalen Sicherheitsanbieter.
Provider
String
Base64-codierte Sicherheitsanbieter -Konfiguration.
Providers
String array
Base64-codierte Sicherheitsanbieter-Konfiguration.
AuthenticationExpiry
Integer
Ablauf des Authentifizierungstokens in Minuten.
Schema
Key
Value Type
Description
Administrator
AllowLocalAuthentication
Boolean
Aktiviert die lokale Benutzerauthentifizierung.
ChangePasswordOnLogin
Boolean
Erzwingt, dass der Benutzer das Passwort bei der Anmeldung ändert.
DefaultPassword
String
Standardpasswort. Wird einmalig bei der Installation angewendet.
Password
String
Passwort. Wird bei jedem Systemstart angewendet.
Schema
Key
Value Type
Description
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
Description
Scripting
Enabled
Boolean
Standardmäßig aktiviert. Auf false setzen, um C#-Scripting zu deaktivieren.
Beispiele
{
"Scripting" : {
"Enabled" : false
}
}
SharedState
Der Abschnitt SharedState konfiguriert den Shared-State-Service, der Multi-Server-Bereitstellungen unterstützt.
Schema
Key
Value Type
Description
SharedState
Provider
String
Anbieter für gemeinsamen Status: InProcess: Der Status wird prozessintern für Single-Server-Bereitstellungen gespeichert. Redis: Der Status wird in Redis für Multi-Server-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 Client-Server-Kommunikation.
Schema
Key
Value Type
Description
SignalR
LongPollingTimeout
String
Long-Polling-Timeout, angegeben im TimeSpan-Format . Beispiel: 00:00:30.
Transports
String
Kommagetrennte Liste von HTTP-Transporttypen : LongPolling: Long-Polling. None: Keine Transporte. 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 App-Builder-Website-Adresse und bekannte Aliase.
Schema
Key
Value Type
Description
Site
Url
String
Kanonische Website-URL.
Default
Boolean
Als Standard-Website behandeln.
Redirect
Boolean
Clients zur Website-URL umleiten.
RedirectIfHeaderExists
String
HTTP-Header, der angibt, dass Clients umgeleitet werden sollten.
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
String
Tls
Der Abschnitt Tls konfiguriert die TLS-Protokollunterstützung.
Schema
Schlüssel
Werttyp
Beschreibung
Tls
SecurityProtocol
String
Kommagetrennte 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-Umschreibung.
Schema
Schlüssel
Werttyp
Beschreibung
UrlRewrite
OriginalUrlHeader
String
HTTP-Header, der die ursprüngliche URL weiterleitet.
Beispiele
{
"UrlRewrite" : {
"OriginalUrlHeader" : "X-Original-URL"
}
}