Configuração de inicialização no Jitterbit App Builder

Introdução

Esta página descreve os parâmetros e métodos de configuração de inicialização do App Builder. Cada seção é o esquema de nível superior para o método de configuração do formulário JSON (appsettings.json).

Quando o App Builder é iniciado, ele obtém seus valores de configuração de qualquer uma das seguintes fontes, em ordem de precedência:

Variáveis de ambiente do sistema.
Um arquivo JSON appsettings.json do ASP.NET Core.
Um arquivo XML connection.xml com um elemento <ConnectionInfo>.

As variáveis de ambiente do sistema são os esquemas JSON, sub-esquemas (se houver) e chaves separados por dois caracteres de sublinhado. Não há um arquivo appsettings.json padrão. Você pode criar um no diretório de instalação usando os exemplos em C:\inetpub\wwwroot\App Builder\ (Windows) ou no subdiretório samples (Linux), muitos dos quais estão reproduzidos nesta página.

Como exemplo, os seguintes métodos de configuração fornecem valores equivalentes:

Variáveis de ambiente

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

arquivo appsettings.json

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

arquivo connection.xml

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

`AiServices`

Esquema	Chave	Tipo de Valor	Descrição
`AiServices`	`OpenAi`	Esquema	Opções do OpenAI.

Esquema	Chave	Tipo de Valor	Descrição
`OpenAi`	`ApiKey`	String	Chave da conta API do OpenAI.
`OpenAi`	`Timeout`	Inteiro	Tempo limite HTTP (segundos).

Exemplos

JSON

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

`BackgroundService`

Esquema	Chave	Tipo de Valor	Descrição
`BackgroundService`	`DisableScheduler`	Boolean	Defina como `true` para desativar o [agendador de serviços em segundo plano].

Exemplos

JSON

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

Variável de ambiente

BackgroundService__DisableScheduler=true

`ConnectionInfo`

Esquema	Chave	Tipo de Valor	Descrição
`ConnectionInfo`	`DatabaseType`	String	Tipo de banco de dados: `SQLServer`, `MySQL`, `PostgreSql`
	`HostName`	String	Nome do host ou endereço IP do servidor de banco de dados.
	`Port`	Inteiro	Número da porta do servidor de banco de dados.
	`InstanceName`	String	Nome da instância do servidor de banco de dados.
	`TenantName`	String	Para uso interno.
	`DatabaseName`	String	Nome do banco de dados do App Builder.
	`UserName`	String	Nome de usuário do banco de dados do App Builder.
	`Password`	String	Senha do banco de dados do App Builder.
	`ConnectionTimeout`	Inteiro	Tempo limite de conexão com o banco de dados (segundos).
	`CommandTimeout`	Inteiro	Tempo limite de comando do banco de dados (segundos).
	`MaxPoolSize`	Inteiro	Número máximo de conexões de banco de dados no pool.
	`Advanced`	Array de objetos	Pares chave/valor adicionais da string de conexão.

Exemplos

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

`DataEncryption`

A seção DataEncryption configura o armazenamento e a criptografia da Chave de Criptografia de Dados (DEK).

Esquema	Chave	Tipo de Valor	Descrição
`DataEncryption`	`Certificate`	String	Certificado X.509 codificado em Base64, PKCS#12 (PFX).
	`CertificatePassword`	String	Senha do certificado X.509.
	`CertificateThumbprint`	String	Impressão digital do certificado X.509.
	`Directory`	String	Caminho do diretório do sistema de arquivos.
	`Import`	String	Políticas de armazenamento e criptografia para importação de DEKs.
	`KeyEncryption`	String	Estratégia de criptografia de dados: `Certificate`: política de criptografia de certificado X.509. `Kms`: política de criptografia de chave AWS KMS. `None`: Nenhuma política de criptografia de chave. As chaves são armazenadas em texto simples. `Null`: Política de criptografia de chave de passagem. As chaves são armazenadas em texto simples.
	`KeyStorage`	String	Localização de armazenamento da chave de criptografia de dados: `Database`: banco de dados do App Builder. `FileSystem`: sistema de arquivos. `ParameterStore`: AWS System Manager Parameter Store. `S3`: bucket S3.
	`KmsKeyId`	String	ARN da chave AWS KMS.
	`ParameterNamePrefix`	String	Prefixo do nome do parâmetro do AWS System Manager Parameter Store.
	`S3BucketEndpoint`	String	Endpoint do bucket S3.
	`S3KeyPrefix`	String	Prefixo da chave S3.

Exemplos

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

A seção Kestrel configura o servidor web Kestrel.

Schema	Key	Value Type	Description
`Kestrel`	`Limits`	`MaxRequestBodySize`	Veja a Kestrel documentation para uma lista de opções suportadas.

`License`

A seção License especifica a chave de licença do App Builder.

Schema	Key	Value Type	Description
`License`	`LicenseKey`	String	Uma versão codificada em base64 do seu arquivo `vinyl.lic`.

Examples

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

`Packaging`

Esta seção permite que administradores configurem o local de armazenamento do pacote. Existem três opções: um banco de dados (o padrão), o sistema de arquivos ou um bucket AWS S3.

Schema	Key	Value Type	Description
`Packaging`	`PackageStore`	String	O tipo de armazenamento, um de `Database`, `FileSystem` ou `S3`.
	`S3BucketEndpoint`	String	Para armazenamento S3, a [URL do endpoint do bucket].
	`S3KeyPrefix`	String	Para armazenamento S3, o [prefixo da chave do bucket].
	`Directory`	String	Para `FileSystem`, o caminho completo para o armazenamento. Se não fornecido, o diretório de dados padrão é utilizado.

Exemplos

Armazenamento de banco de dados

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

Armazenamento em sistema de arquivos

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

Armazenamento S3

{
  "Packaging": {
    "PackageStore": "S3",
    "S3BucketEndpoint": "https://my-aws-domain.s3.us-east-1.amazonaws.com",
    "S3KeyPrefix": "vinyl/"
  }
}

`PostgreSQL`

Esquema	Chave	Tipo de Valor	Descrição
`PostgreSQL`	`Logging`
`PostgreSQL`	`OpenTelemetry`

`ReverseProxy`

A seção ReverseProxy configura um proxy reverso.

Esquema	Chave	Tipo de Valor	Descrição
`ReverseProxy`	`ForwardedClientIpHeader`	String	Cabeçalho HTTP que encaminha o endereço IP original do cliente.
	`ForwardedSchemeHeader`	String	Cabeçalho HTTP que encaminha o esquema original.
	`ForwardedHostHeader`	String	Cabeçalho HTTP que encaminha o host original e a porta opcional.
	`ForwardedPortHeader`	String	Cabeçalho HTTP que encaminha a porta original.

Exemplos

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

`Segurança`

A seção Segurança configura contas de usuário do App Builder e provedores de segurança.

Esquema	Chave	Tipo de Valor	Descrição
`Segurança`	`Administrator`	Esquema	Opções da conta de administrador.
	`InvitationUrl`	String	Para uso interno.
	`LocalAuthentication`	Esquema	Opções do provedor de segurança de usuário local.
	`Provider`	String	Configuração do provedor de segurança codificada em Base64.
	`Providers`	Array de strings	configuração do provedor de segurança codificada em Base64.
	`AuthenticationExpiry`	Inteiro	Expiração do token de autenticação, em minutos.

Esquema	Chave	Tipo de Valor	Descrição
`Administrator`	`AllowLocalAuthentication`	Boolean	Habilita a autenticação de usuário local.
	`ChangePasswordOnLogin`	Boolean	Força o usuário a mudar a senha no login.
	`DefaultPassword`	String	Senha padrão. Aplicada uma vez na instalação.
	`Password`	String	Senha. Aplicada cada vez que o sistema inicia.

Esquema	Chave	Tipo de Valor	Descrição
`LocalAuthentication`	`Enabled`	Boolean	Habilita o provedor de segurança.
	`ShowOnLoginForm`	Boolean	Determina se o provedor de autenticação de usuário aparece no formulário de login.

Exemplos

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

`Scripting`

A seção Scripting configura o SDK de script C# do App Builder.

Esquema	Chave	Tipo de Valor	Descrição
`Scripting`	`Enabled`	Boolean	Habilita scripts em C#.

Exemplos

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

`SharedState`

A seção SharedState configura o serviço de estado compartilhado que suporta implantações em múltiplos servidores.

Esquema	Chave	Tipo de Valor	Descrição
`SharedState`	`Provider`	String	Provedor de estado compartilhado: `InProcess`: O estado é armazenado em processo para implantações em servidor único. `Redis`: O estado é armazenado no Redis para implantações em múltiplos servidores.
	`RedisConnectionString`	String	String de conexão do Redis.
	`RedisPrefix`	String	Prefixo da chave do Redis.

Exemplo

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

`SignalR`

A seção SignalR configura as comunicações entre cliente e servidor.

Esquema	Chave	Tipo de Valor	Descrição
`SignalR`	`LongPollingTimeout`	String	Tempo limite de long polling, especificado usando um formato de `TimeSpan`. Exemplo: `00:00:30`.
`SignalR`	`Transports`	String	Lista delimitada por vírgulas de tipos de transporte HTTP: `LongPolling`: Long-polling. `None`: Sem transportes. NÃO SUPORTADO. `ServerSentEvents`: Eventos enviados pelo servidor. `WebSockets`: WebSockets .

Exemplos

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

`Site`

A seção Site configura o endereço do site do App Builder e os aliases conhecidos.

Esquema	Chave	Tipo de Valor	Descrição
`Site`	`Url`	String	URL canônica do site.
	`Default`	Boolean	Tratar como o site padrão.
	`Redirect`	Boolean	Redirecionar clientes para a URL do site.
	`RedirectIfHeaderExists`	String	Cabeçalho HTTP que indica que os clientes devem ser redirecionados.
	`AllowCrossOrigin`	Boolean	Permitir solicitações de origem cruzada.
	`Aliases`	Array de String	Aliases do site.

Exemplos

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

`Sku`

Esquema	Chave	Tipo de Valor	Descrição
`Sku`	`Sku`	String

`Tls`

A seção Tls configura o suporte ao protocolo TLS.

Esquema	Chave	Tipo de Valor	Descrição
`Tls`	`SecurityProtocol`	String	Lista delimitada por vírgulas de protocolos de segurança: `Tls12`: TLS 1.2 `Tls13`: TLS 1.3

Exemplos

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

`UrlRewrite`

A seção UrlRewrite configura o suporte à reescrita de URL.

Esquema	Chave	Tipo de Valor	Descrição
`UrlRewrite`	`OriginalUrlHeader`	String	Cabeçalho HTTP que encaminha a URL original.

Exemplos

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