Configuración de inicio en Jitterbit App Builder

Introducción

Esta página describe los parámetros y métodos de configuración de inicio de App Builder. Cada sección es el esquema de nivel superior del formulario JSON (appsettings.json) método de configuración.

Cuando se inicia App Builder, obtiene sus valores de configuración de cualquiera de las siguientes fuentes, en orden de precedencia:

1. Variables de ambiente del sistema.
2. Un ASP.NET Core appsettings.jsonArchivo JSON.
3. A connection.xml Archivo XML con un <ConnectionInfo> elemento.

Las variables de ambiente del sistema son los esquemas JSON, los subesquemas (si los hay) y las claves, separadas por dos guiones bajos. No hay un valor predeterminado. appsettings.jsonarchivo. Puede crear uno en el directorio de instalación usando los ejemplos en C:\inetpub\wwwroot\App Builder\ (Windows) o el samples subdirectorio (Linux), muchos de los cuales se reproducen en esta página.

A modo de ejemplo, los siguientes métodos de configuración proporcionan valores equivalentes:

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

Esquema	Clave	Tipo de valor	Descripción
BackgroundService	DisableScheduler	Booleano	Establecer en true para deshabilitar el background services scheduler.

Ejemplos

JSON

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

Environment variable

BackgroundService__DisableScheduler=true

ConnectionInfo

Esquema	Clave	Tipo de valor	Descripción
ConnectionInfo	DatabaseType	Cadena	Tipo de base de datos: SQLServer, MySQL, PostgreSql
	HostName	Cadena	Nombre de alojar o dirección IP del servidor de base de datos.
	Port	Entero	Número de puerto del servidor de base de datos.
	InstanceName	Cadena	Nombre de la instancia del servidor de base de datos.
	TenantName	Cuerda	Para uso interno.
	DatabaseName	Cadena	Nombre de la base de datos de App Builder.
	UserName	Cadena	Nombre de usuario de la base de datos de App Builder.
	Password	Cadena	Contraseña de la base de datos de App Builder.
	ConnectionTimeout	Entero	Tiempo de espera de conexión a la base de datos (segundos).
	CommandTimeout	Entero	Tiempo de espera del comando de base de datos (segundos).
	MaxPoolSize	Entero	Número máximo de conexiones de base de datos en el grupo.
	Advanced	Matriz de objetos	Pares clave/valor de cadena de conexión adicionales.

Ejemplos

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

DataEncryption

El DataEncryption La sección configura el almacenamiento y el cifrado de la clave de cifrado de datos (DEK).

Esquema	Clave	Tipo de valor	Descripción
DataEncryption	Certificate	Cadena	Certificado X.509 codificado en Base64, PKCS#12 (PFX).
	CertificatePassword	Cadena	Contraseña del certificado X.509.
	CertificateThumbprint	Cadena	Huella digital del certificado X.509.
	Directory	Cadena	Ruta del directorio del sistema de archivos.
	Import	Cadena	Políticas de almacenamiento y cifrado para importar DEK.
	KeyEncryption	Cuerda	Estrategia de cifrado de datos: Certificate:Política de cifrado del certificado X.509. Kms:Política de cifrado de claves de AWS KMS. None No existe una política de cifrado de claves. Las claves se almacenan en texto plano.Null Política de cifrado de claves de paso. Las claves se almacenan en texto plano.
	KeyStorage	Cuerda	Ubicación de almacenamiento de la clave de cifrado de datos: Database:Base de datos de App Builder. FileSystem:Sistema de archivos. ParameterStore: Almacén de parámetros de AWS System Manager. S3: Cubo S3.
	KmsKeyId	Cadena	ARN de clave AWS KMS.
	ParameterNamePrefix	Cadena	Prefijo del nombre del parámetro del almacén de parámetros de AWS System Manager.
	S3BucketEndpoint	Cadena	extremo del bucket S3.
	S3KeyPrefix	Cadena	Prefijo de clave S3.

Ejemplos

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

El Kestrel La sección configura el servidor web Kestrel.

Esquema	Clave	Tipo de valor	Descripción
Kestrel	Limits	MaxRequestBodySize	Ver el Kestrel documentation para obtener una lista de las opciones admitidas.

License

El License La sección especifica la clave de licencia de App Builder.

Esquema	Clave	Tipo de valor	Descripción
License	LicenseKey	Cadena	Una versión codificada en base64 de su vinyl.lic archivo.

Ejemplos

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

Packaging

Esta sección permite a los administradores configurar la ubicación de almacenamiento de los paquetes. Hay tres opciones: una base de datos (predeterminada), el sistema de archivos o un bucket de AWS S3.

Esquema	Clave	Tipo de valor	Descripción
Packaging	PackageStore	Cadena	El tipo de almacenamiento, uno de Database, FileSystem, o S3.
	S3BucketEndpoint	Cadena	Para el almacenamiento S3, el bucket endpoint URL.
	S3KeyPrefix	Cadena	Para el almacenamiento S3, el bucket key prefix.
	Directory	Cadena	Para FileSystem La ruta completa a la tienda. Si no se proporciona, se utiliza el directorio de datos predeterminado.

Ejemplos

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

Esquema	Clave	Tipo de valor	Descripción
PostgreSQL	Logging
	OpenTelemetry

ReverseProxy

El ReverseProxy La sección configura un proxy inverso.

Esquema	Clave	Tipo de valor	Descripción
ReverseProxy	ForwardedClientIpHeader	Cadena	encabezado HTTP que reenvía la dirección IP del cliente original.
	ForwardedSchemeHeader	Cadena	encabezado HTTP que reenvía el esquema original.
	ForwardedHostHeader	Cadena	encabezado HTTP que reenvía el alojar original y el puerto opcional.
	ForwardedPortHeader	Cadena	encabezado HTTP que reenvía el puerto original.

Ejemplos

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

El Security La sección configura las cuentas de usuario y los proveedores de seguridad de App Builder.

Esquema	Clave	Tipo de valor	Descripción
Security	Administrator	Esquema	Opciones de la cuenta de administrador.
	InvitationUrl	Cuerda	Para uso interno.
	LocalAuthentication	Esquema	Opciones del proveedor de seguridad del usuario local.
	Provider	Cadena	Proveedor de seguridad codificado en Base64 configuración.
	Providers	Matriz de cadenas	Configuración del proveedor de seguridad codificado en base64.
	AuthenticationExpiry	Entero	Vencimiento del token de autenticación, en minutos.
Esquema	Clave	Tipo de valor	Descripción
-----------------	----------------------------	------------	-------------------------------------------------
Administrator	AllowLocalAuthentication	Booleano	Habilita la autenticación de usuario local.
	ChangePasswordOnLogin	Booleano	Obliga al usuario a cambiar la contraseña al iniciar sesión.
	DefaultPassword	Cadena	Contraseña predeterminada. Se aplica una sola vez durante la instalación.
	Password	Cadena	Contraseña. Se aplica cada vez que se inicia el sistema.
Esquema	Clave	Tipo de valor	Descripción
----------------------	-------------------	------------	----------------------------------------------------------------------
LocalAuthentication	Enabled	Booleano	Habilita el proveedor de seguridad.
	ShowOnLoginForm	Booleano	Determina si el proveedor de autenticación de usuario aparece en el formulario de inicio de sesión.

Ejemplos

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

Scripting

El Scripting La sección configura el SDK de scripting de C# de App Builder.

Esquema	Clave	Tipo de valor	Descripción
Scripting	Enabled	Booleano	Habilita scripts en C#.

Ejemplos

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

SharedState

El SharedState La sección configura el servicio de estado compartido que admite implementaciones multiservidor.

Esquema	Clave	Tipo de valor	Descripción
SharedState	Provider	Cuerda	Proveedor de estado compartido: InProcess:El estado se almacena durante el proceso para implementaciones de un solo servidor. Redis:El estado se almacena en Redis para implementaciones de múltiples servidores.
	RedisConnectionString	Cadena	Cadena de conexión de Redis.
	RedisPrefix	Cadena	Prefijo de clave de Redis.

Ejemplo

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

SignalR

El SignalR La sección configura las comunicaciones cliente-servidor.

Esquema	Clave	Tipo de valor	Descripción
SignalR	LongPollingTimeout	Cadena	Tiempo de espera de sondeo largo, especificado mediante un TimeSpan formato. Ejemplo: 00:00:30.
	Transports	Cuerda	Lista delimitada por comas de tipos de transporte HTTP: LongPolling: Sondeo largo. None: Sin transportes. NO SOPORTADO. ServerSentEvents:Eventos enviados por el servidor. WebSockets: WebSockets .

Ejemplos

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

Site

El Site La sección configura la dirección del sitio web de App Builder y los alias conocidos.

Esquema	Clave	Tipo de valor	Descripción
Site	Url	Cadena	URL del sitio web canónico.
	Default	Booleano	Tratar como el sitio web predeterminado.
	Redirect	Booleano	Redirigir a los clientes a la URL del sitio.
	RedirectIfHeaderExists	Cadena	encabezado HTTP que indica que los clientes deben ser redirigidos.
	AllowCrossOrigin	Booleano	Permitir solicitudes de origen cruzado.
	Aliases	Matriz de cadenas	Alias del sitio.

Ejemplos

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

Sku

Esquema	Clave	Tipo de valor	Descripción
Sku	Sku	Cuerda

Tls

El Tls La sección configura la compatibilidad con el protocolo TLS.

Esquema	Clave	Tipo de valor	Descripción
Tls	SecurityProtocol	Cuerda	Lista delimitada por comas de [protocolos de seguridad][]securityprotocoltype]: Tls12:TLS 1.2 Tls13: TLS 1.3

Ejemplos

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

UrlRewrite

El UrlRewrite La sección configura el soporte de reescritura de URL.

Esquema	Clave	Tipo de valor	Descripción
UrlRewrite	OriginalUrlHeader	Cadena	encabezado HTTP que reenvía la URL original.

Ejemplos

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