Startkonfiguration im Jitterbit App Builder

Einführung

Auf dieser Seite werden die Startkonfigurationsparameter und -methoden des App Builders beschrieben. Jeder Abschnitt stellt das Top-Level Schema für das JSON-Formular dar (appsettings.json) Konfigurationsmethode.

Wenn App Builder gestartet wird, erhält es seine Konfigurationseinstellungen in der Reihenfolge ihrer Priorität aus einer der folgenden Quellen:

1. Umfeld.
2. Ein ASP.NET Core appsettings.jsonJSON-Datei.
3. A connection.xml XML-Datei mit einer <ConnectionInfo> Element.

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

Beispielsweise liefern die folgenden Konfigurationsmethoden gleichwertige Werte:

Environment variables

ConnectionInfo__DatabaseType=SQLServer
ConnectionInfo__HostName=localhost
ConnectionInfo__DatabaseName=App Builder
ConnectionInfo__UserName=vinyl
ConnectionInfo__Password=P@5$w0rD

appsettings.json file

{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "vinyl",
    "Password": "P@5$w0rD"
  }
}

connection.xml file

<ConnectionInfo DatabaseType="MySQL" HostName="localhost" DatabaseName="App Builder" UserName="vinyl" Password="P@5$w0rD"/>

BackgroundService

Schema	Schlüssel	Werttyp	Beschreibung
BackgroundService	DisableScheduler	Boolesch	Eingestellt auf true zum Deaktivieren der background services scheduler.

Beispiele

JSON

{
  "BackgroundService": {
    "DisableScheduler": true
  }
}

Environment variable

BackgroundService__DisableScheduler=true

ConnectionInfo

Schema	Schlüssel	Werttyp	Beschreibung
ConnectionInfo	DatabaseType	Zeichenfolge	Datenbanktyp: SQLServer, MySQL, PostgreSql
	HostName	Zeichenfolge	Host oder IP-Adresse des Datenbankservers.
	Port	Ganzzahl	Port des Datenbankservers.
	InstanceName	Zeichenfolge	Name der Datenbankserverinstanz.
	TenantName	Zeichenfolge	Für den internen Gebrauch.
	DatabaseName	Zeichenfolge	Name der App Builder Datenbank.
	UserName	Zeichenfolge	Benutzername der App Builder-Datenbank.
	Password	Zeichenfolge	Passwort für die App Builder Datenbank.
	ConnectionTimeout	Ganzzahl	Timeout der Datenbankverbindung (Sekunden).
	CommandTimeout	Ganzzahl	Timeout des Datenbankbefehls (Sekunden).
	MaxPoolSize	Ganzzahl	Maximale Anzahl von Datenbankverbindungen im Pool.
	Advanced	Objekt-Array	Zusätzliche Schlüssel/Wert-Paare für Verbindungszeichenfolgen.

Beispiele

{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "App Builder",
    "Password": "password"
  }
}

DataEncryption

Die DataEncryption Der Abschnitt konfiguriert die Speicherung und Verschlüsselung des Data Encryption Key (DEK).

Schema	Schlüssel	Werttyp	Beschreibung
DataEncryption	Certificate	Zeichenfolge	Base64-codiertes PKCS#12 (PFX) X.509-Zertifikat.
	CertificatePassword	Zeichenfolge	Kennwort für X.509-Zertifikat.
	CertificateThumbprint	Zeichenfolge	Fingerabdruck des X.509-Zertifikats.
	Directory	Zeichenfolge	Verzeichnispfad des Dateisystems.
	Import	Zeichenfolge	Speicher- und Verschlüsselung für den Import von DEKs.
	KeyEncryption	Zeichenfolge	Verschlüsselung: Certificate: X.509- Verschlüsselung. Kms: AWS KMS- Verschlüsselung. None: Keine Verschlüsselung. Schlüssel werden im Klartext gespeichert. Null: Passthrough-Verschlüsselung. Schlüssel werden im Klartext gespeichert.
	KeyStorage	Zeichenfolge	Speicherort des Verschlüsselung: Database: App Builder Datenbank. FileSystem: Dateisystem. ParameterStore: AWS System Manager Parameter Store. S3: S3-Bucket.
	KmsKeyId	Zeichenfolge	AWS KMS-Schlüssel-ARN.
	ParameterNamePrefix	Zeichenfolge	Präfix des Parameternamens des AWS System Manager Parameter Store.
	S3BucketEndpoint	Zeichenfolge	S3-Bucket-Endpoint.
	S3KeyPrefix	Zeichenfolge	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 Im Abschnitt wird der Kestrel-Webserver konfiguriert.

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 App Builder Lizenzschlüssel an.

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

Beispiele

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

Packaging

In diesem Abschnitt können Administratoren den Speicherort des Pakets konfigurieren. Es stehen drei Optionen zur Verfügung: eine Datenbank (Standard), das Dateisystem oder ein AWS S3-Bucket.

Schema	Schlüssel	Werttyp	Beschreibung
Packaging	PackageStore	Zeichenfolge	Der Speichertyp, einer von Database, FileSystem, oder S3.
	S3BucketEndpoint	Zeichenfolge	Für S3-Speicher, die bucket endpoint URL.
	S3KeyPrefix	Zeichenfolge	Für S3-Speicher, die bucket key prefix.
	Directory	Zeichenfolge	Für FileSystem, der vollständige Pfad zum Store. Wenn nicht angegeben, wird das Standarddatenverzeichnis verwendet.

Beispiele

Database storage

{
  "Packaging": {
    "PackageStore": "Database"
  }
}

File system storage

{
  "Packaging": {
    "PackageStore": "FileSystem",
    "Directory": "C:\\Packages"
  }
}

S3 storage

{
  "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 ReverseProxy Dieser Abschnitt konfiguriert einen Reverse-Proxy.

Schema	Schlüssel	Werttyp	Beschreibung
ReverseProxy	ForwardedClientIpHeader	Zeichenfolge	HTTP- Header, der die ursprüngliche Client-IP-Adresse weiterleitet.
	ForwardedSchemeHeader	Zeichenfolge	HTTP- Header, der das ursprüngliche Schema weiterleitet.
	ForwardedHostHeader	String	HTTP Header, der den ursprünglichen Host und optional den 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 Security Abschnitt konfiguriert App Builder Benutzerkonten und Sicherheitsanbieter.

Schema	Schlüssel	Werttyp	Beschreibung
Security	Administrator	Schema	Optionen für das Administratorkonto.
	InvitationUrl	Zeichenfolge	Für den internen Gebrauch.
	LocalAuthentication	Schema	Optionen des lokalen Benutzersicherheitsanbieters.
	Provider	Zeichenfolge	Base64-codiert Sicherheitsanbieter Konfiguration.
	Providers	Zeichenfolgenarray	Base64-codierte Sicherheitsanbieterkonfiguration.
	AuthenticationExpiry	Ganzzahl	Ablauf des Authentifizierungstokens in Minuten.

Schema	Schlüssel	Werttyp	Beschreibung
Administrator	AllowLocalAuthentication	Boolean	Aktiviert die lokale Benutzerauthentifizierung.
	ChangePasswordOnLogin	Boolean	Zwingt den Benutzer, beim Anmelden sein Passwort zu ändern.
	DefaultPassword	Zeichenfolge	Standardkennwort. Wird einmalig bei der Installation angewendet.
	Password	Zeichenfolge	Kennwort. Wird bei jedem Systemstart angewendet.

Schema	Schlüssel	Werttyp	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 Scripting Dieser Abschnitt konfiguriert das C#-Skripting-SDK des App Builders.

Schema	Schlüssel	Werttyp	Beschreibung
Scripting	Enabled	Boolean	Aktiviert C#-Skripting.

Beispiele

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

SharedState

Der SharedState Dieser Abschnitt konfiguriert den Shared-State-Dienst, der Multiserver-Bereitstellungen unterstützt.

Schema	Schlüssel	Werttyp	Beschreibung
SharedState	Provider	Zeichenfolge	Shared State Provider: InProcess: Der Status wird bei Einzelserverbereitstellungen prozessintern gespeichert. Redis: Der Status wird für Bereitstellungen auf mehreren Servern in Redis gespeichert.
	RedisConnectionString	Zeichenfolge	Redis-Verbindungszeichenfolge.
	RedisPrefix	Zeichenfolge	Redis-Schlüsselpräfix.

Beispiel

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

SignalR

Die SignalR Dieser Abschnitt konfiguriert die Client-Server-Kommunikation.

Schema	Schlüssel	Werttyp	Beschreibung
SignalR	LongPollingTimeout	Zeichenfolge	Langes Polling-Timeout, angegeben mit einem TimeSpan Format. Beispiel: 00:00:30.
	Transports	Zeichenfolge	Komma-getrennte Liste von HTTP-Transporttypen: LongPolling: Langes 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 Site Der Abschnitt konfiguriert die Websiteadresse und bekannten Aliase des App Builder.

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

Beispiele

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

Sku

Schema	Schlüssel	Werttyp	Beschreibung
Sku	Sku	Zeichenfolge

Tls

Die Tls Der Abschnitt konfiguriert die TLS-Protokollunterstützung.

Schema	Schlüssel	Werttyp	Beschreibung
Tls	SecurityProtocol	Zeichenfolge	Komma-getrennte Liste von Sicherheitsprotokollen: Tls12: TLS 1.2 Tls13: TLS 1.3

Beispiele

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

UrlRewrite

Der UrlRewrite Der Abschnitt konfiguriert die Unterstützung zum Umschreiben von URL.

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

Beispiele

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