Configuração do Banco de Dados

Referência para fluxo de trabalho de criação de banco de dados e comportamento do parâmetro sql.create_db em instalações do Automation Suite.

Fluxo de trabalho de criação de banco de dados

O instalador interativo cria automaticamente bancos de dados usando o seguinte fluxo de trabalho:

1. O script do instalador interativo verifica o valor do parâmetro sql.create_db no arquivo cluster_config.json .

   • Se o parâmetro sql.create_db estiver definido como true, o instalador gerará automaticamente todos os bancos de dados em seu nome. Nesse caso, o instalador usa os nomes de bancos de dados e modelos padrão e ignora quaisquer nomes de bancos de dados personalizados que você forneceu.

     Para obter detalhes, consulte Criar automaticamente os bancos de dados necessários.

   • Se sql.create_db estiver definido como false, você deve trazer seus próprios bancos de dados. Nesse caso, você deve configurar manualmente seus bancos de dados. Observe que você pode usar nomes de banco de dados personalizados, desde que siga as convenções de nomenclatura fornecidas. Essa etapa é fundamental porque usamos o nome do banco de dados em conjunto com o modelo de conexão para formar a string de conexão com banco de dados. Se você não seguir a convenção de nomenclatura recomendada, deve fornecer as strings de conexão SQL por conta própria.

     Para obter detalhes, consulte Traga seus próprios bancos de dados.

2. O instalador interativo gera as strings de conexão da seguinte forma:

   • Se você não definiu uma string de conexão para seu serviço, o instalador usará o modelo de conexão com o banco de dados para gerar todas as strings de conexão com banco de dados.
   • Se você definiu uma string de conexão para seu serviço, o instalador usará a string de conexão fornecida para seu banco de dados.

Cria automaticamente os bancos de dados necessários

Se quiser que o instalador crie os bancos de dados, preencha os seguintes campos do arquivo cluster_config.json :

Parâmetro	Description
sql.create_db	Defina como true para permitir que o instalador crie os bancos de dados. Observe que o instalador usa os nomes de bancos de dados e modelos padrão e ignora quaisquer nomes de bancos de dados personalizados que você forneceu.
sql.server_url	FQDN do SQL Server, onde você deseja que o instalador configure o banco de dados.
sql.port	Número da porta na qual uma instância de banco de dados deve ser hospedada no SQL Server.
sql.username	Nome de usuário/ID do usuário para se conectar ao SQL Server.
sql.password	Senha do nome de usuário fornecido anteriormente para se conectar ao SQL Server.

Observação:

• Certifique-se de que o usuário tenha a função dbcreator. Isso concede a eles permissão para criar o banco de dados no SQL Server. Caso contrário, a instalação falha.
• A criação automática dos bancos de dados necessários não funciona em combinação com a autenticação de diretório. Se você usa a autenticação de diretórios, deve trazer seus próprios bancos de dados.
• A conexão ODBC não aceita nomes de usuário que contenham caracteres especiais. Para nomes de usuário de banco de dados no AI Center, Document Understanding e Apps, use apenas letras maiúsculas e minúsculas.

Importante:

Para o Process Mining no Automation Suite, você precisa criar manualmente o banco de dados PostgreSQL para AutomationSuite_Airflow antes de instalar ou atualizar para o Automation Suite 2.2510 ou superior. O banco de dados PostgreSQL para o Airflow não será criado automaticamente pelo instalador.

Para obter detalhes, consulte Requisitos do SQL para o Process Mining.

Traga seus próprios bancos de dados

Se você optar por trazer seus próprios bancos de dados para uma nova instalação do Automation Suite, recomendamos fortemente a configuração de novos bancos de dados em vez de usar os existentes. Essa precaução é necessária para evitar quaisquer conflitos com a operação do Automation Suite que possam ocorrer devido a metadados restantes de bancos de dados antigos.

Se trouxer seu próprio banco de dados, você deve fornecer as strings de conexão do SQL para cada banco de dados. O Automation Suite oferece suporte aos seguintes formatos de string de conexão SQL:

Observação:

Para o Document Understanding, certifique-se de usar o mesmo banco de dados, a menos que indicado explicitamente de outra forma. Strings de conexão específicas são atribuídas a vários serviços e trabalhos que se conectam ao mesmo banco de dados.

Modelos de strings de conexão

Parâmetro	Description	Produtos
sql_connection_string_template	String de conexão completa do ADO.NET onde o nome do catálogo é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	Plataforma Orchestrator Automation Suite Robots Test Manager Automation Hub Automation Ops Insights Integration Service Studio Web Data Service Process Mining Document Understanding Gateway do LLM Observabilidade de LLM ECS Soluções
sql_connection_string_template_jdbc	String de conexão completa do JDBC onde o nome do banco de dados é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	AI Center 1 Integration Service
sql_connection_string_template_odbc	String de conexão completa do ODBC onde o nome do banco de dados é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	Document Understanding Apps Integration Service
sql_connection_string_template_sqlalchemy_pyodbc	String de conexão SQL alchemy PYODBC completa na qual o nome do banco de dados é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	Document Understanding
postgresql_connection_string_template_sqlalchemy_pyodbc	String de conexão SQL alchemy PSYCOPG2 completa na qual o nome do banco de dados é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	Process Mining

¹ Para instalar o AI Center em uma máquina habilitada para FIPS 140-2, você deve acrescentar a sql_connection_string_template_jdbc o seguinte: encrypt=true;trustServerCertificate=false;fips=true;.

Certifique-se de que a conta do SQL especificada nas strings de conexão tenha a função db_owner para todos os bancos de dados do Automation Suite. Se as restrições de segurança não permitem o uso de db_owner, a conta do SQL deve ter as seguintes funções e permissões em todos os bancos de dados:

• db_securityadmin
• db_ddladmin
• db_datawriter
• db_datareader
• EXECUTE permissão no esquema dbo, dt, authz, e messagebus

Usamos as funções db_securityadmin e db_ddladmin durante a instalação ou se os bancos de dados forem reprovisionados; então, você pode revogar essas permissões posteriormente. O Insights requer que a função db_owner seja atribuída para uma instalação bem-sucedida.

Se você definir manualmente as strings de conexão no arquivo de configuração, poderá usar o caractere de escape em senhas SQL, JDBC, ODBC ou PYODBC da seguinte maneira:

• para SQL: adicione ' no início e no fim da senha, e duplique qualquer outro '.
• para JDBC/ODBC: adicione { no início da senha e } no final, e duplique qualquer outro }
• para PYODBC: username e password devem ser codificados para URL para considerar caracteres especiais. As senhas de banco de dados do Document Understanding não podem começar com {.

The AutomationSuite_ProcessMining_Airflow database for Process Mining product must have READ_COMMITTED_SNAPSHOT enabled.

Por padrão, TrustServerCertificate é definido como False, e você deve fornecer um certificado de CA adicional para o SQL Server. Isso é necessário se o certificado do SQL Server for autoassinado ou assinado por uma CA interna. Se você não fornecer o certificado do SQL Server nesse cenário, a verificação de pré-requisitos falhará. Para obter detalhes, consulte Configuração do certificado nesta página.

sql_connection_string_template

O exemplo a seguir mostra uma string de conexão sql_connection_string_template :

Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;

sql_connection_string_template_jdbc

O exemplo a seguir mostra uma string de conexão sql_connection_string_template_jdbc :

jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"

sql_connection_string_template_odbc

O exemplo a seguir mostra uma string de conexão sql_connection_string_template_odbc :

SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"

sql_connection_string_template_sqlalchemy_pyodbc

O exemplo a seguir mostra uma string de conexão sql_connection_string_template_sqlalchemy_pyodbc :

mssql+pyodbc://testuser%40sfdev3082457-sql.database.windows.net:[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

postgresql_connection_string_template_sqlalchemy_pyodbc

O exemplo a seguir mostra uma string de conexão postgresql_connection_string_template_sqlalchemy_pyodbc para o Process Mining:

postgresql+psycopg2://<user>:<password>@<host>:<port>/DB_NAME_PLACEHOLDER

Modelos combinados do Process Mining

Os exemplos a seguir mostram configurações de modelos combinadas para o Process Mining:

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password='07<l[xj-=~:z`Ds&nl';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"

"postgresql_connection_string_template_sqlalchemy_pyodbc ": 
"postgresql+psycopg2://<user>:<password>@sfdev4515230-postgresql.database.windows.net:5432/DB_NAME_PLACEHOLDER"

"sql_connection_string_template": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password='07<l[xj-=~:z`Ds&nl';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"

"sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

Nomes de banco de dados padrão

O exemplo a seguir mostra os nomes padrão e opcionais do banco de dados para os serviços do Automation Suite:

{
  "orchestrator": "AutomationSuite_Orchestrator",
  "orchestrator_ta": "AutomationSuite_Orchestrator",
  "asrobots": "AutomationSuite_Orchestrator",
  "orchestrator_upd": "AutomationSuite_Platform",
  "platform": "AutomationSuite_Platform",
  "test_manager": "AutomationSuite_Test_Manager",
  "automation_ops": "AutomationSuite_Platform",
  "automation_hub": "AutomationSuite_Automation_Hub",
  "insights": "AutomationSuite_Insights",
  "integrationservices": "AutomationSuite_Integration_Services",
  "dataservice": "AutomationSuite_DataService", 
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
  "processmining_airflow": "AutomationSuite_Airflow",
  "processmining_metadata": "AutomationSuite_ProcessMining_Metadata",
  "processmining_warehouse": "AutomationSuite_ProcessMining_Warehouse",
  "apps": "AutomationSuite_Apps",
  "automationsolutions": "AutomationSuite_AutomationSolutions",
  }

Observação:

Se você quiser substituir a string de conexão de algum dos serviços mencionados, defina sql_connection_str para esse serviço específico.

Você ainda precisa criar esses bancos de dados manualmente antes de executar o instalador.

Substituições de string de conexão específicas do produto

Para substituir as strings de conexão do banco de dados para outros produtos, defina sql_connection_str nos blocos de produto correspondentes. A string de conexão deve ter um formato compatível com o respectivo produto.

Orchestrator e plataforma

O exemplo a seguir mostra como substituir a string de conexão padrão para o Orchestrator e a plataforma:

{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  },
  "platform": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomIDDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

AI Center

A tabela a seguir descreve o parâmetro cluster_config.json para definir a string de conexão do banco de dados do AI Center.

Parâmetro	Description
aicenter.sql_connection_str	String de conexão JDBC do AI Center

Observação:

Certifique-se de que a string de conexão JDBC tenha o formato do seguinte exemplo:

O exemplo a seguir mostra uma amostra de string de conexão do AI Center:

"aicenter": {
    "enabled": true,
    "sql_connection_str": "jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net;database=aicenter;user=[e-mail];password=TFgID_9GsE7_P@srCQp0WemXX_euHQZJ"
}

Document Understanding

O exemplo a seguir mostra uma amostra de string de conexão do Document Understanding:

"documentunderstanding": {
        "enabled": true,
        "sql_connection_str": "Server=SERVER_PLACEHOLDER;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=USER_PLACEHOLDER;Password='PASSWORD_PLACEHOLDER';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
        "datamanager": {
            "sql_connection_str": "SERVER=SERVER_PLACEHOLDER;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=USER_PLACEHOLDER;PWD={PASSWORD_PLACEHOLDER};;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=customer-sql.database.windows.net",
            "pyodbc_sql_connection_str": "mssql+pyodbc://testadmin%40sql.database.windows.net:[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
        }
    }

Observação:

A string de conexão SQL do Data Manager é opcional apenas se você quiser substituir a string padrão por uma própria.

Para obter detalhes, consulte o Arquivo de configuração do Document Understanding.

Process Mining

As strings de conexão do Process Mining têm as seguintes diferenças das strings de conexão do modelo:

• Os nomes das strings de conexão do modelo (postgresql_connection_string_template_sqlalchemy_pyodbc para PostgreSQL e sql_connection_string_template) diferem dos nomes dos bancos de dados que você traz (sqlalchemy_pyodbc_sql_connection_str e sql_connection_str).
• Se você trouxer seu próprio banco de dados e o configurar usando sql_connection_str e sqlalchemy_pyodbc_sql_connection_str na seção processmining de cluster_config.json, as strings de conexão do modelo sql_connection_string_template e postgresql_connection_string_template_sqlalchemy_pyodbc serão ignoradas.

A app_security_mode controla como os usuários SQL são criados para aplicativos do Process Mining. No modo padrão app_security_mode="system_managed" , um novo usuário SQL é criado para cada aplicativo Process Mining, o que requer permissões avançadas para o usuário do banco de dados. No modo app_security_mode="single_account" , uma única conta de usuário SQL é usada para todos os aplicativos de processo. Para obter detalhes, consulte Configuração da segurança do aplicativo de processo.

Se você usar um Multi-AZ com configuração Always On SQL, defina MultiSubnetFailover=True para sql_connection_str e master_sql_connection_str e MultiSubnetFailover=Yes para sqlalchemy_pyodbc_sql_connection_str. Observe que para pyodbc você usa =Yes em vez de =True.

Para autenticação do Kerberos, use os parâmetros Integrated Security e Trusted_Connection em vez de um nome de usuário e senha. Defina Integrated Security como true e Trusted_Connection como yes para autenticar usando as credenciais do usuário atualmente logado.

Exemplos de strings de conexão

O exemplo a seguir mostra uma amostra de string de conexão do Process Mining (PostgreSQL):

  "processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },
    "warehouse": {
      "sql_connection_str": "Server=tcp:kerberossql.autosuitead.local,1433;Initial Catalog=AutomationSuite_Warehouse;Persist Security Info=False;User Id=testadmin;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://testadmin:<password>@kerberossql.autosuitead.local:1433/AutomationSuite_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
      "master_sql_connection_str": "Server=tcp:kerberossql.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;User Id=testadmin;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    }
    "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;User Id=[e-mail];Password='password';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
  }

O exemplo a seguir mostra uma string de conexão do Process Mining para uma configuração com autenticação do Kerberos (PostgreSQL):

"processmining": {
    "enabled": true,
    "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://kerberos_user:@kerberospostgres.AUTOSUITEAD.LOCAL:5432/automationsuite_airflow"
    }
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
  },

O exemplo a seguir mostra uma string de conexão do Process Mining para uma configuração em que o banco de dados de metadados e o data warehouse usam um SQL Server separado (autenticação não Kerberos):

"processmining": {
    "enabled": true,
    "warehouse": {
      "sql_connection_str": "Server=tcp:uipath-integration1.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:[e-mail]:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
      "master_sql_connection_str": "Server=tcp:uipath-integration1.database.windows.net,1433;Initial Catalog=master;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    },
  "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },
    "sql_connection_str": "Server=tcp:uipath-integration2.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",  
},

O exemplo a seguir mostra uma string de conexão do Process Mining para uma configuração usando app_security_mode personalizado:

"processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "warehouse": {
        "sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
        "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:assql2019.autosuitead.local,1433;Initial Catalog=master;Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
      },
   "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },