データベースの構成

Automation Suite のデータベース構成オプション、および cluster_config.json パラメーターによって制御されるデータベース自動作成ワークフローのリファレンスです。

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

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

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 2023.10.9 以降の Process Mining では、Airflow データベースに PostgreSQL を使用することをお勧めします。PostgreSQL データベースの使用を選択した場合は、Automation Suite 2023.10.9 以降をインストールまたはアップグレードする前に、 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 の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	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 1
sql_connection_string_template_odbc	データベース名を DB_NAME_PLACEHOLDER に設定した ODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding、Apps
sql_connection_string_template_sqlalchemy_pyodbc	データベース名を DB_NAME_PLACEHOLDER に設定した SQLAlchemy PYODBC の完全な接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Document Understanding、Process Mining
postgresql_connection_string_template_sqlalchemy_pyodbc	データベース名を DB_NAME_PLACEHOLDER に設定した完全な SQL alchemy PSYCOPG2 接続文字列。インストーラーは、このプレースホルダーを、インストールするスイートのサービスの既定データベース名に置き換えます。	Process Mining (2023.10.9 以降)

¹ 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
• DBO スキーマに対するEXECUTE権限 UiPath では、インストール時またはデータベースを再プロビジョニングした場合にのみ 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;

注:

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

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:<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+psycopg2://<user>:<password>@<host>:<port>/DB_NAME_PLACEHOLDER

sql_connection_string_template と postgresql_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='<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 と 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='<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"

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

Process Mining の接続文字列のサンプル (SQL Server)

"processmining": {
    "enabled": true,
    "app_security_mode": "system_managed",
    "warehouse": {
        "sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=AutomationSuite_ProcessMining_Warehouse;User Id=[e-mail];Password='<your-password>';Persist Security Info=False;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:<your-password>:@sfdev4515230-sql.database.windows.net:1433/AutomationSuite_ProcessMining_Warehouse?driver=ODBC+Driver+17+for+SQL+Server&TrustServerCertificate=YES&Encrypt=YES",
        "master_sql_connection_str": "Server=tcp:sfdev4515230-sql.database.windows.net,1433;Initial Catalog=master;Persist Security Info=False;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:<your-password>@sfdev4515230-sql.database.windows.net: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='<your-password>';Persist Security Info=False;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;Max Pool Size=100;",  
},

注:

Kerberos 認証を使用する場合は、 Integrated Security および Trusted_Connection パラメーターを使用します。 [ Integrated Security ] を [ true ] に設定し、[ Trusted_Connection ] を [ yes] に設定すると、現在ログインしているユーザーの認証情報が接続に使用されます。 この場合、ユーザ名とパスワードを別途指定する必要はありません。

重要:

テンプレート PYODBC 接続文字列 postgresql_connection_string_template_sqlalchemy_pyodbc (PostgreSQL の場合) sql_connection_string_template_sqlalchemy_pyodbc (MS SQL Server の場合) の名前と、独自のデータベースを利用するときに使用される PYODBC 接続文字列sqlalchemy_pyodbc_sql_connection_str名前が異なることに注意してください。また、テンプレート SQL sql_connection_string_templateと、独自のデータベースを利用するときに使用される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(PostgreSQLの場合)sql_connection_string_template_sqlalchemy_pyodbc(MS SQL Serverの場合)は指定しても無視されます。

注:

接続文字列を [sql_connection_strとmaster_sql_connection_str] に [MultiSubnetFailover=True] と [MultiSubnetFailover=Yes] sqlalchemy_pyodbc_sql_connection_strに設定します。pyodbcでは、'=True' の代わりに '=Yes' を使用することに注意してください。

注:

app_security_modeの設定に応じ、システムによって Process Mining アプリごとに新しい SQL ユーザーが作成されるか (app_security_mode="system_managed")、すべてのプロセス アプリで使用される単一の SQL ユーザー アカウントが作成されます (app_security_mode="single_account")。既定の設定は [ app_security_mode="system_managed" ] であり、この設定はデータベース ユーザーに対して高い権限を要求する点に注意してください。詳しくは、「 プロセス アプリのセキュリティを設定する」をご覧ください。

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

• シナリオ: 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;"
      },
  },

• シナリオ: Kerberos 認証を使用したセットアップ (Microsoft SQL Server)

"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='<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;"
    },
    "sqlalchemy_pyodbc_sql_connection_str": "mssql+pyodbc://userid:<your-password>@uipath-integration2.database.windows.net: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_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;",  
},

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