SQL データベース

注:

専用の「要件」セクションで特に指定がない限り、これらの要件はすべての Automation Suite 製品に適用されます。

Automation Suite と UiPath® 製品をインストールするには、外部 SQL Server を使用する必要があります。Microsoft SQL Server 2016、2017、2019、2022 の Standard および Enterprise エディションがサポートされています。

Additional Microsoft SQL platforms, such as Azure SQL Database, Azure SQL Managed Instance, or Amazon Relational Database Service, are also supported as long as the Microsoft SQL Server database engine meets the requirements. For details, see Compatibility matrix.

注:

SQL Server がクラスター ノードからアクセスできることを確認します。

個々の製品サポートの内容は異なります。

デプロイを計画している各製品について、以下のことが必要です。

• 製品で必要とされる SQL Server のサポート バージョンを確認する
• 製品で必要とされる SQL Server 構成の要件 (SQL Server のユーザー権限を含む) を満たしている

Microsoft SQL Server の一般的な最小ハードウェア要件は次のとおりです。

• 8 (v-)CPU
• 32 GB の RAM
• 256 GB SSD

The minimum requirements are general guidance and do not guarantee reliable operation in a production deployment. Capacity planning is required to determine the hardware requirements that are needed for reliable operation. For details, see Capacity planning.

UiPath® 製品ごとに専用の SQL データベースが必要です。

データベース作成ワークフロー

対話型インストーラーは、以下のワークフローを使用して自動的にデータベースを作成します。

1. 対話型インストーラー スクリプトは、input.json ファイル内の sql.create_db パラメーターの値を確認します。

   • sql.create_db パラメーターが trueに設定されている場合、インストーラーはユーザーに代わってすべてのデータベースを自動的に生成します。この場合、インストーラーは既定のデータベース名と既定のテンプレートを使用し、指定したカスタム データベース名はすべて無視します。

     For details, see Automatically create the necessary databases.

   • sql.create_db が falseに設定されている場合は、独自のデータベースを利用する必要があります。この場合、データベースを手動で設定する必要があります。 カスタム データベース名を使用できるのは、提供されている命名規則に従っている場合です。 データベース名と接続テンプレートを組み合わせて使用してデータベース接続文字列を形成するため、この手順は重要です。 推奨される名前付け規則に従っていない場合は、SQL 接続文字列を自分で指定する必要があります。

     For details, see Bring your own databases.

2. 対話型インストーラーは、次のように接続文字列を生成します。
   • サービスの接続文字列を定義しなかった場合、インストーラーは接続テンプレートを使用してすべてのデータベース接続文字列を生成します。
   • サービスの接続文字列を定義した場合、インストーラーはデータベースに指定された接続文字列を使用します。

必要なデータベースを自動作成する

インストーラーでデータベースを作成する場合は、 input.json ファイルの以下のフィールドに入力します。

パラメーター	説明
sql.create_db	インストーラーでデータベースを作成できるようにするには、 true に設定します。 インストーラーは既定のデータベース名と既定のテンプレートを使用し、指定したカスタム データベース名は無視することに注意してください。
sql.server_url	インストーラーがデータベースを構成する SQL Server の FQDN。
sql.port	SQL Server のデータベース インスタンスをホストするポートの番号です。
sql.username	SQL Server に接続するユーザー名/ユーザー ID。
sql.password	SQL Server に接続するために前に指定したユーザー名のパスワード。

注:

• ユーザーに dbcreator ロールが付与されていることを確認してください。このロールにより、SQL Server 上にデータベースを作成する権限が与えられます。この権限がないと、インストールに失敗します。
• ODBC 接続では、特殊文字を含むユーザー名はサポートされていません。AI Center、Document Understanding、Apps のデータベース ユーザー名に使用できるのは、英字 (大文字と小文字) のみです。

独自のデータベースを利用する

Automation Suite の新規インストールに独自のデータベースを利用する場合は、既存のデータベースを使用するのではなく、新しいデータベースをセットアップすることを強くお勧めします。この予防措置は、古いデータベースのメタデータが残っているために、Automation Suite の動作との競合が発生するのを防ぐために必要です。

独自のデータベースを使用する場合は、すべてのデータベースに対して SQL 接続文字列を指定する必要があります。Automation Suite では、次の形式の SQL 接続文字列をサポートしています。

パラメーター	説明	製品
sql_connection_string_template	カタログ名を DB_NAME_PLACEHOLDER に設定した ADO.NET の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Platform、Orchestrator、Automation Suite ロボット、Test Manager、Automation Hub、Automation Ops、Insights、Task Mining、Data Service、Process Mining, Document Understanding
sql_connection_string_template_jdbc	データベース名を DB_NAME_PLACEHOLDER に設定した JDBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	AI Center
sql_connection_string_template_odbc	データベース名を DB_NAME_PLACEHOLDER に設定した ODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding、Apps
sql_connection_string_template_sqlalchemy_pyodbc	データベース名を DB_NAME_PLACEHOLDER に設定した SQLAlchemy PYODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Process Mining

重要:

接続文字列で指定している SQL アカウントに、すべての Automation Suite データベースに対する db_securityadmin ロールと db_owner ロールが付与されていることを確認してください。セキュリティの制約により db_owner の使用が許可されない場合は、すべてのデータベースに対する次のロールと権限を SQL アカウントに付与する必要があります。

• db_securityadmin
• db_ddladmin
• db_datawriter
• db_datareader
• dbo スキーマに対する EXECUTE 権限

db_securityadmin ロールと db_ddladmin ロールは、インストール中、またはデータベースが再プロビジョニングされる場合にのみ使用されます。このため、ユーザーはこの権限を後で取り消すことができます。

インストールを正常に完了するために Insights で db_owner ロールを割り当てる必要があります。

重要:

構成ファイルに接続文字列を手動で設定する場合、次の方法で SQL、JDBC、ODBC、または PYODBC のパスワードをエスケープできます。

• SQL の場合: パスワードの最初と末尾に ' を追加し、他の ' を 2 個に増やします。
• JDBC/ODBC の場合: パスワードの先頭に { を追加し、末尾に } を追加し、他のすべての } を 2 個に増やします。
• PYODBC の場合: username と password は、特殊文字を考慮して URL エンコードする必要があります。 Document Understanding データベースのパスワードを { で始めることはできません。

重要:

Process Mining 製品の AutomationSuite_ProcessMining_Airflow データベースで READ_COMMITTED_SNAPSHOT が有効化されている必要があります。

注:

既定では TrustServerCertificate は False に設定されており、SQL Server 用に追加の CA 証明書を指定する必要があります。SQL Server の証明書が自己署名証明書の場合、または社内 CA によって署名された証明書の場合はこれが必須になります。このシナリオで SQL Server の証明書を指定しないと、前提条件の確認が失敗します。

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 の例

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 の例

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 の例

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

sql_connection_string_template と sql_connection_string_template_sqlalchemy_pyodbc の例 (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='***';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"

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",
  "task_mining": "AutomationSuite_Task_Mining",
  "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",

}

注:

上記サービスのいずれかの接続文字列を上書きする場合は、その特定のサービスについて sql_connection_str を設定します。

その場合も、インストーラーを実行する前に、これらのデータベースを手動で作成する必要があります。

Orchestrator とプラットフォーム用の既定の接続文字列をオーバーライドする

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

他の製品のデータベース接続文字列をオーバーライドするには、対応する製品ブロックの sql_connection_str を設定します。この接続文字列は、対応する製品がサポートする形式である必要があります。

AI Center 用のデータベース接続文字列の設定例

パラメーター	説明
aicenter.sql_connection_str	AI Center の JDBC 接続文字列 (JDBC 形式については以下を参照)。

注:

JDBC 接続文字列が、次のサンプルの形式であることを確認します。

"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 の接続文字列のサンプル

"documentunderstanding": {
"enabled": true,
"sql_connection_str": "" // dotnet connection string,
"datamanager": {
 "sql_connection_str": "" // odbc connection string
 }
}

注:

データ マネージャーの SQL 接続文字列は、既定値を独自の文字列で上書きする場合にのみ省略可能です。

オンライン インストールでは、手書き文字が常に有効です。

max_cpu_per-pod の既定値は 2 ですが、必要に応じて調整できます。

Process Mining の接続文字列のサンプル

"processmining": {
    "enabled": true,
    "warehouse": {
        "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;User Id=[e-mail];Password='***';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://:@sfdev4515230-sql.database.windows.net:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes",
        "master_sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=master;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://testadmin%40sfdev4515230-sql.database.windows.net:07%3Cl%5Bxj-%3D~[e-mail]:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES"
    "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Metadata;User Id=[e-mail];Password='***';Persist Security Info=False;Integrated Security=true;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
},

重要:

テンプレート PYODBC 接続文字列sql_connection_string_template_sqlalchemy_pyodbcの名前と、独自のデータベースを利用するときに使用される PYODBC 接続文字列sqlalchemy_pyodbc_sql_connection_str名前は異なることに注意してください。また、テンプレート SQL sql_connection_string_templateと、独自のデータベースを利用するときに使用されるsql_connection_str、接続文字列名も異なります。

重要:

独自のデータベースを利用し、input.jsonファイルの processmining セクションのsql_connection_strとsqlalchemy_pyodbc_sql_connection_str接続文字列を使用してそのデータベースを設定した場合、テンプレート接続文字列 sql_connection_string_template と sql_connection_string_template_sqlalchemy_pyodbc は指定しても無視されます。

重要:

MultiSubnetFailover=True はサポートされていません。Process Mining の接続文字列から MultiSubnetFailover=True を削除してください。

注:

Depending on the app_security_mode setting either a new SQL user is created for every Process Mining app by the system (app_security_mode="system_managed"), or a single SQL user account is created that is used for all process apps (app_security_mode="single_account"). Note that app_security_mode="system_managed" is the default setting, and that this requires advanced permissions for the database user. See Configuring process app security.

Process Mining の接続文字列のサンプル

• シナリオ: Kerberos 認証を使用した設定

"processmining": {
    "enabled": true,
    "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;"
      },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=yes"
  },

Process Mining の接続文字列のサンプル

• シナリオ: メタデータ データベースとデータ ウェアハウスで個別の SQL Server (非 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;"
    },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:[e-mail]:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES"
    "sql_connection_str": "Server=tcp:uipath-integration2.database.windows.net,1433;Initial Catalog=AutomationSuite_Airflow;Persist Security Info=False;User Id=userid;Password='password';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
},

Process Mining の接続文字列のサンプル

• シナリオ: カスタム app_security_mode を使用する。

"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;"
      },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://:@assql2019.autosuitead.local:1433/AutomationSuite_Airflow?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES&Trusted_Connection=YES"
  },

SQL 認証

AKS からの SQL への Azure Active Directory ベースのアクセス

AKS クラスターから Azure Active Directory を介して Microsoft SQL Server にアクセスすることができます。次の例に、AAD によるアクセス方法を使用する接続文字列を示します。

  "sql_connection_string_template": "Server=tcp:sfdev3888449-sql.database.windows.net,1433;Authentication=Active Directory Service Principal;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=5c6b8ff1-efb4-48ca-a530-f744f1d438df;Password='I5V8Q~srSTWf0onUYeHLK..qLO69pP7MZ3KIMaB2';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "sql_connection_string_template_jdbc": "jdbc:sqlserver://sfdev3888449-sql.database.windows.net;authentication=ActiveDirectoryServicePrincipal;database=DB_NAME_PLACEHOLDER;user=5c6b8ff1-efb4-48ca-a530-f744f1d438df;password={I5V8Q~srSTWf0onUYeHLK..qLO69pP7MZ3KIMaB2};encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;",
  "sql_connection_string_template_odbc": "SERVER=sfdev3888449-sql.database.windows.net;Authentication=ActiveDirectoryServicePrincipal;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=5c6b8ff1-efb4-48ca-a530-f744f1d438df;PWD={I5V8Q~srSTWf0onUYeHLK..qLO69pP7MZ3KIMaB2};Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;hostNameInCertificate=sfdev3888449-sql.database.windows.net",
  "sql_connection_string_template_sqlalchemy_pyodbc": "mssql+pyodbc://5c6b8ff1-efb4-48ca-a530-f744f1d438df:I5V8Q~[e-mail]:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server&authentication=ActiveDirectoryServicePrincipal",