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 para el método de configuración del formulario JSON (appsettings.json).

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

Variables de entorno del sistema.
Un archivo JSON appsettings.json de ASP.NET Core.
Un archivo XML connection.xml con un elemento <ConnectionInfo>.

Las variables de entorno del sistema son los esquemas JSON, sub-esquemas (si los hay) y claves separados por dos caracteres de subrayado. No hay un archivo appsettings.json por defecto. Puedes crear uno en el directorio de instalación utilizando las muestras en C:\inetpub\wwwroot\App Builder\ (Windows) o en el subdirectorio samples (Linux), muchas de las cuales se reproducen en esta página.

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

Variables de entorno

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

archivo appsettings.json

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

archivo connection.xml

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

`AiServices`

Esquema	Clave	Tipo de Valor	Descripción
`AiServices`	`OpenAi`	Esquema	Opciones de OpenAI.

Esquema	Clave	Tipo de Valor	Descripción
`OpenAi`	`ApiKey`	Cadena	Clave API de la cuenta de OpenAI.
`OpenAi`	`Timeout`	Entero	Tiempo de espera HTTP (segundos).

Ejemplos

JSON

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

`BackgroundService`

Esquema	Clave	Tipo de Valor	Descripción
`BackgroundService`	`DisableScheduler`	Booleano	Establecer en `true` para deshabilitar el programador de servicios en segundo plano.

Ejemplos

JSON

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

Variable de entorno

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 del host 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`	Cadena	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 de comando de la base de datos (segundos).
	`MaxPoolSize`	Entero	Número máximo de conexiones a la base de datos en el grupo.
	`Advanced`	Array de objetos	Pares clave/valor adicionales de la cadena de conexión.

Ejemplos

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

`DataEncryption`

La sección DataEncryption configura el almacenamiento y 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 DEKs.
	`KeyEncryption`	Cadena	Estrategia de cifrado de datos: `Certificate`: política de cifrado con certificado X.509. `Kms`: política de cifrado con clave AWS KMS. `None`: Sin política de cifrado de clave. Las claves se almacenan en texto plano. `Null`: Política de cifrado de clave de paso. Las claves se almacenan en texto plano.
	`KeyStorage`	Cadena	Ubicación de almacenamiento de la clave de cifrado de datos: `Base de datos`: base de datos de App Builder. `Sistema de archivos`: sistema de archivos. `ParameterStore`: AWS System Manager Parameter Store. `S3`: bucket de S3.
	`KmsKeyId`	Cadena	ARN de la clave de AWS KMS.
	`ParameterNamePrefix`	Cadena	Prefijo del nombre del parámetro de AWS System Manager Parameter Store.
	`S3BucketEndpoint`	Cadena	Endpoint del bucket de S3.
	`S3KeyPrefix`	Cadena	Prefijo de clave de 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`

La sección Kestrel configura el servidor web Kestrel.

Esquema	Clave	Tipo de Valor	Descripción
`Kestrel`	`Limits`	`MaxRequestBodySize`	Consulta la documentación de Kestrel para obtener una lista de opciones compatibles.

`License`

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

Esquema	Clave	Tipo de Valor	Descripción
`License`	`LicenseKey`	String	Una versión codificada en base64 de tu archivo `vinyl.lic`.

Examples

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

`Packaging`

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

Esquema	Clave	Tipo de Valor	Descripción
`Packaging`	`PackageStore`	String	El tipo de almacenamiento, uno de `Database`, `FileSystem` o `S3`.
	`S3BucketEndpoint`	String	Para almacenamiento S3, la [URL del endpoint del bucket].
	`S3KeyPrefix`	String	Para almacenamiento S3, el [prefijo de clave del bucket].
	`Directory`	String	Para `FileSystem`, la ruta completa al almacenamiento. Si no se proporciona, se utiliza el directorio de datos predeterminado.

Ejemplos

Almacenamiento en base de datos

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

Almacenamiento en sistema de archivos

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

Almacenamiento en S3

{
  "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`
`PostgreSQL`	`OpenTelemetry`

`ReverseProxy`

La sección ReverseProxy configura un proxy inverso.

Esquema	Clave	Tipo de Valor	Descripción
`ReverseProxy`	`ForwardedClientIpHeader`	String	Encabezado HTTP que reenvía la dirección IP original del cliente.
	`ForwardedSchemeHeader`	String	Encabezado HTTP que reenvía el esquema original.
	`ForwardedHostHeader`	String	Encabezado HTTP que reenvía el host original y el puerto opcional.
	`ForwardedPortHeader`	String	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`

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

Esquema	Clave	Tipo de Valor	Descripción
`Security`	`Administrator`	Esquema	Opciones de cuenta de administrador.
	`InvitationUrl`	String	Para uso interno.
	`LocalAuthentication`	Esquema	Opciones del proveedor de seguridad de usuario local.
	`Provider`	String	Configuración del proveedor de seguridad codificada en Base64.
	`Providers`	Array de strings	configuración del proveedor de seguridad codificada en Base64.
	`AuthenticationExpiry`	Entero	Expiración del token de autenticación, en minutos.

Esquema	Clave	Tipo de Valor	Descripción
`Administrator`	`AllowLocalAuthentication`	Boolean	Habilita la autenticación de usuario local.
	`ChangePasswordOnLogin`	Boolean	Obliga al usuario a cambiar la contraseña al iniciar sesión.
	`DefaultPassword`	String	Contraseña predeterminada. Se aplica una vez en la instalación.
	`Password`	String	Contraseña. Se aplica cada vez que el sistema se inicia.

Esquema	Clave	Tipo de Valor	Descripción
`LocalAuthentication`	`Enabled`	Boolean	Habilita el proveedor de seguridad.
	`ShowOnLoginForm`	Boolean	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`

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

Esquema	Clave	Tipo de Valor	Descripción
`Scripting`	`Enabled`	Boolean	Habilita el scripting en C#.

Ejemplos

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

`SharedState`

La sección SharedState configura el servicio de estado compartido que admite implementaciones de múltiples servidores.

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

Ejemplo

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

`SignalR`

La sección SignalR configura las comunicaciones entre el cliente y el servidor.

Esquema	Clave	Tipo de Valor	Descripción
`SignalR`	`LongPollingTimeout`	Cadena	Tiempo de espera para long polling, especificado usando un formato de `TimeSpan`. Ejemplo: `00:00:30`.
`SignalR`	`Transports`	Cadena	Lista delimitada por comas de tipos de transporte HTTP: `LongPolling`: Long-polling. `None`: Sin transportes. NO SOPORTADO. `ServerSentEvents`: Eventos enviados por el servidor. `WebSockets`: WebSockets .

Ejemplos

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

`Site`

La sección Site 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 canónica del sitio web.
	`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`	Array de cadenas	Alias del sitio.

Ejemplos

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

`Sku`

Esquema	Clave	Tipo de Valor	Descripción
`Sku`	`Sku`	Cadena

`Tls`

La sección Tls configura el soporte para el protocolo TLS.

Esquema	Clave	Tipo de Valor	Descripción
`Tls`	`SecurityProtocol`	Cadena	Lista delimitada por comas de protocolos de seguridad: `Tls12`: TLS 1.2 `Tls13`: TLS 1.3

Ejemplos

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

`UrlRewrite`

La sección UrlRewrite configura el soporte para la 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"
  }
}