データベースの構成

Automation Suite インストールにおけるデータベース作成ワークフローとsql.create_dbパラメーターの動作のリファレンス。

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

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

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

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

     詳しくは、「 必要なデータベースを自動的に作成する」をご覧ください。

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

     詳しくは、「 独自のデータベースを利用する」をご覧ください。

2. 対話型インストーラーは、次のように接続文字列を生成します。

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

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

インストーラーでデータベースを作成する場合は、 cluster_config.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 の Process Mining の場合は、Automation Suite 2.2510 をインストールするか、Automation Suite 2.2510 にアップグレードする前に、 AutomationSuite_Airflow 用の PostgreSQL データベースを手動で作成する必要があります。Airflow の PostgreSQL データベースは、インストーラーによって自動的には作成されません。

詳しくは、「 Process Mining のための SQL の要件」をご覧ください。

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

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

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

注:

Document Understanding では、特に明記されていない限り、同じデータベースを使用していることを確認してください。同じデータベースに接続するさまざまなサービスやジョブに、特定の接続文字列が割り当てられます。

接続文字列テンプレート

パラメーター	説明	製品
sql_connection_string_template	カタログ名を DB_NAME_PLACEHOLDER に設定した ADO.NET の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	プラットフォーム Orchestrator Automation Suite ロボット Test Manager Automation Hub Automation Ops Insights Integration Service Studio Web Data Service Process Mining Document Understanding LLM ゲートウェイ LLM の可観測性 ECSの Solutions (ソリューション)
sql_connection_string_template_jdbc	データベース名を DB_NAME_PLACEHOLDER に設定した JDBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	AI Center 1 Integration Service
sql_connection_string_template_odbc	データベース名を DB_NAME_PLACEHOLDER に設定した ODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding Apps (アプリ) Integration Service
sql_connection_string_template_sqlalchemy_pyodbc	データベース名を DB_NAME_PLACEHOLDER に設定した SQLAlchemy PYODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding
postgresql_connection_string_template_sqlalchemy_pyodbc	データベース名を DB_NAME_PLACEHOLDER に設定した完全な SQL alchemy PSYCOPG2 接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Process Mining

¹ FIPS 140-2 が有効化されたマシンに AI Center をインストールするには、 sql_connection_string_template_jdbcに「 encrypt=true;trustServerCertificate=false;fips=true;」を追加する必要があります。

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

• db_securityadmin
• db_ddladmin
• db_datawriter
• db_datareader
• EXECUTE dbo、dt、authz、および msgbus スキーマに対する権限

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

次の例は、 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=<your-password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;

注:

接続文字列の User Id 値は大文字と小文字が区別されます。

sql_connection_string_template_jdbc

次の例は、 sql_connection_string_template_jdbc 接続文字列を示しています。

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

sql_connection_string_template_odbc

次の例は、 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=<your-password>;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"

sql_connection_string_template_sqlalchemy_pyodbc

次の例は、 sql_connection_string_template_sqlalchemy_pyodbc 接続文字列を示しています。

mssql+pyodbc://testuser%40sfdev3082457-sql.database.windows.net:<your-password>@sfdev3082457-sql.database.windows.net:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

postgresql_connection_string_template_sqlalchemy_pyodbc

次の例は、Process Mining の postgresql_connection_string_template_sqlalchemy_pyodbc 接続文字列を示しています。

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

Process Mining の結合テンプレート

次の例は、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='<your-password>';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"

"postgresql_connection_string_template_sqlalchemy_pyodbc ":
"postgresql+psycopg2://<user>:<your-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='<your-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:<your-password>@sfdev4515230-sql.database.windows.net:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"

既定のデータベース名

次の例は、Automation Suite サービスの既定とオプションの DB 名を示しています。

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

注:

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

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

製品固有の接続文字列の上書き

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

Orchestrator とプラットフォーム

次の例は、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=<your-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=<your-password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

AI Center

次の表で、AI Center データベースの接続文字列を設定するための cluster_config.json パラメーターについて説明します。

パラメーター	説明
aicenter.sql_connection_str	AI Center の JDBC 接続文字列

注:

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

次の例は、AI Center の接続文字列の例を示しています。

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

Document Understanding

次の例は、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:<your-password>@sql.database.windows.net:1433/DB_NAME_PLACEHOLDER?driver=ODBC+Driver+17+for+SQL+Server"
        }
    }

注:

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

詳細については、「 Document Understanding 構成ファイル」を参照してください。

Process Mining

Process Mining の接続文字列は、テンプレートの接続文字列と次の点で異なります。

• テンプレート接続文字列名 ( PostgreSQL および sql_connection_string_templateの場合はpostgresql_connection_string_template_sqlalchemy_pyodbc ) は、 Bring Your Own Database 名 (sqlalchemy_pyodbc_sql_connection_str および sql_connection_str) とは異なります。
• 独自のデータベースを利用し、cluster_config.jsonの processmining セクションでsql_connection_strとsqlalchemy_pyodbc_sql_connection_strを使用してそのデータベースを設定する場合、テンプレート接続文字列 sql_connection_string_template とpostgresql_connection_string_template_sqlalchemy_pyodbcは無視されます。

app_security_mode設定は、Process Mining アプリ用の SQL ユーザーの作成方法を制御します。既定の app_security_mode="system_managed" モードでは、Process Mining アプリごとに新しい SQL ユーザーが作成されます。このため、データベース ユーザーに対して高い権限が必要になります。app_security_mode="single_account" モードでは、すべてのプロセス アプリで 1 つの SQL ユーザー アカウントが使用されます。詳しくは、「 プロセス アプリのセキュリティを設定する」をご覧ください。

Always On SQL セットアップでマルチ AZ を使用する場合は、sql_connection_str と master_sql_connection_strに MultiSubnetFailover=True を設定し、sqlalchemy_pyodbc_sql_connection_strに MultiSubnetFailover=Yes を設定します。pyodbcでは、=Trueの代わりに =Yes を使用することに注意してください。

Kerberos 認証では、ユーザー名とパスワードの代わりに Integrated Security パラメーターと Trusted_Connection パラメーターを使用します。現在ログインしているユーザーの資格情報を使用して認証するには、[ Integrated Security ] を [ true ] に、[ Trusted_Connection ] を [ yes ] に設定します。

接続文字列の例

次の例は、Process Mining の接続文字列 (PostgreSQL) の例を示しています。

  "processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<your-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='<your-password>';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://testadmin:<your-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='<your-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='<your-password>';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
  }

次の例は、Kerberos 認証 (PostgreSQL) を使用した設定の Process Mining 接続文字列を示しています。

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

次の例は、メタデータ データベースとデータ ウェアハウスで個別の SQL Server (非 Kerberos 認証) を使用する場合の設定の Process Mining 接続文字列を示しています。

"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='<your-password>';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
      "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:<your-password>@uipath-integration1.database.windows.net: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='<your-password>';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;"
    },
  "airflow": {
      "metadata_db_connection_str": "postgresql+psycopg2://testadmin:<your-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='<your-password>';MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",
},

次の例は、カスタム app_security_modeを使用した設定の Process Mining 接続文字列を示しています。

"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:<your-password>@sfdev8454496-postgresql.postgres.database.azure.com:5432/AutomationSuite_Airflow"
    },