server.hsconf構成ファイルのリファレンス
この記事の適用対象: OutSystems 11 その他のバージョンに関する記事: 10
server.hsconfは、OutSystemsプラットフォームの必要な構成をすべて含むXMLファイルです。server.hsconf構成ファイルの設定はConfiguration Toolのユーザーインターフェイスで利用可能な設定に対応しています。
server.hsconf構成ファイルのテンプレートを生成するには、以下のConfiguration Toolのコマンドラインを使用し、ご利用のデータベース管理システムに対応するテンプレートを選択します。
ConfigurationTool.com /GenerateTemplates
server.hsconf構成ファイルでは、カテゴリで整理されたキーと値のペアの設定を定義します。構文は以下のとおりです。
<EnvironmentConfiguration>
<CATEGORY [ProviderKey="[SqlServer|Oracle]"]>
<KEY [encrypted="[false|true]"]>VALUE</KEY>
...
</CATEGORY>
...
</EnvironmentConfiguration>
以下のセクションでは、構成ファイルの各カテゴリで利用可能な構成の詳細を説明します。
プラットフォームデータベース構成
以下のXML要素は、Platform Database構成カテゴリの構成を定義します。
<PlatformDatabaseConfiguration ProviderKey="[SqlServer|Oracle]">
<KEY [encrypted="[false|true]"]>VALUE</KEY>
...
</PlatformDatabaseConfiguration>
ProviderKeyアトリビュートは、構成を適用するデータベース管理システムを指定します。
共通構成
以下は、データベース管理システムに依存しない構成です。
| キー | 値 | 説明 |
|---|---|---|
| AdminUser | OutSystemsメタモデルテーブルの所有者の名前。 | |
| AdminPassword | OutSystemsメタモデルテーブルの所有者のパスワード。 | Configuration Toolはクリアテキストのパスワードを読み取り、暗号化されたバージョンを保存します。 |
| RuntimeUser | Development環境で作成されたテーブルの所有者の名前。 | |
| RuntimePassword | Development環境で作成されたテーブルの所有者のパスワード。 | Configuration Toolはクリアテキストのパスワードを読み取り、暗号化されたバージョンを保存します。 |
| RuntimeAdvancedSettings | OutSystemsサービスの接続文字列に追加されるADO.NET形式の設定。 | これにより、OutSystemsアプリケーションで特定の接続文字列を使用することができます。 |
| ServicesAdvancedSettings | OutSystemsサービスの接続文字列に追加されるADO.NET形式の設定。 | これにより、OutSystemsサービスで特定の接続文字列を使用することができます。 |
SQL Server/Azure SQL Database
以下は、SQL ServerとAzure SQL Databaseに固有の構成です。
| キー | 値 | 説明 |
|---|---|---|
| Unicode | 「true」または「false」。 このフィールドはカスタマイズしないでください。OutSystemsはレガシーシステムでは非Unicodeのみをサポートします。 |
データベースがUnicodeをサポートするかどうかを定義します。 |
| UsedAuthenticationMode | 「Database Authentication」または「Windows Authentication」。 | 使用する認証プロトコル。 |
| Server | データベースサーバーのホスト名またはIPアドレス。 | |
| Catalog | OutSystemsが使用するデータベースカタログ。 |
Oracle
以下は、Oracleに固有の構成です。
| キー | 値 | 説明 |
|---|---|---|
| IntrospectionMethod | 内部用。カスタマイズしないでください。 | |
| CI_AI | 「true」または「false」。 内部用。カスタマイズしないでください。 |
大文字と小文字およびアクセントを区別しないモード。 |
| DateFunction | 日付の取得に使用する関数。 内部用。カスタマイズしないでください。 |
|
| DDLLockTimeout | 数値。 内部用。カスタマイズしないでください。 |
DDLロック操作で使用するタイムアウト。 |
| NamingType | 「Service Name」または「TNS Name」。 | 使用する接続モード。 |
| TNSName | tnsnames.ora構成ファイルで定義されているアドレス名。このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| Host | データベースサーバーのホスト名またはIPアドレス。 このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| Port | データベースサービスが検出を行うポート。 このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| ServiceName | Oracleデータベースサービスの名前。 このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| NLS_Language | NLS_LANG Oracleの言語環境のパラメータ。 | Oracleドライバから返されるメッセージのロケールを変更します。 |
| NLS_Territory | NLS_LANG OracleのTerritory環境のパラメータ。 | Oracleドライバから返されるメッセージのロケールを変更します。 |
| AdminTablespace | システムテーブルの保存先となるテーブルスペース。 | |
| IndexTablespace | プラットフォームの全インデックスの保存先となるテーブルスペース。 | |
| RuntimeTablespace | 開発環境で作成されたテーブルの保存先となるテーブルスペース。 |
ロギングデータベース構成
以下のXML要素は、ロギングデータベース構成カテゴリの構成を定義します。
<LoggingDatabaseConfiguration ProviderKey="[SqlServer|Oracle]">
<KEY [encrypted="[false|true]"]>VALUE</KEY>
...
</LoggingDatabaseConfiguration>
ProviderKeyアトリビュートは、Platform Database構成で設定されたProviderKey値と一致している必要があります。このアトリビュートは、構成を適用するデータベース管理システムを指定します。
共通構成
以下は、データベース管理システムに依存しない構成です。
| キー | 値 | 説明 |
|---|---|---|
| AdminUser | OutSystemsロギングメタモデルテーブルの所有者の名前。 | |
| AdminPassword | OutSystemsロギングメタモデルテーブルの所有者のパスワード。 | Configuration Toolはクリアテキストのパスワードを読み取り、暗号化されたバージョンを保存します。 |
| RuntimeUser | アプリケーション実行時にログにアクセスするときに使用するユーザーの名前。 | |
| RuntimePassword | アプリケーション実行時にログにアクセスするときに使用するユーザーのパスワード。 | Configuration Toolはクリアテキストのパスワードを読み取り、暗号化されたバージョンを保存します。 |
| RuntimeAdvancedSettings | OutSystemsサービスの接続文字列に追加されるADO.NET形式の設定。 | これにより、OutSystemsアプリケーションで特定の接続文字列を使用することができます。 |
SQL Server/Azure SQL Database
以下は、SQL ServerとAzure SQL Databaseに固有の構成です。
| キー | 値 | 説明 |
|---|---|---|
| Unicode | 「true」または「false」。 このフィールドはカスタマイズしないでください。OutSystemsはレガシーシステムでは非Unicodeのみをサポートします。 |
データベースがUnicodeをサポートするかどうかを定義します。 |
| UsedAuthenticationMode | 「Database Authentication」または「Windows Authentication」。 | 使用する認証プロトコル。Platform Database構成と一致している必要があります。 |
| Server | データベースサーバーのホスト名またはIPアドレス。 | |
| Catalog | ロギングで使用するデータベースカタログ。 |
Oracle
以下は、Oracleに固有の構成です。
| キー | 値 | 説明 |
|---|---|---|
| IntrospectionMethod | 内部用。カスタマイズしないでください。 | |
| CI_AI | 「true」または「false」。 内部用。カスタマイズしないでください。 |
大文字と小文字およびアクセントを区別しないモード。 |
| DateFunction | 日付の取得に使用する関数。 内部用。カスタマイズしないでください。 |
|
| DDLLockTimeout | 数値。 内部用。カスタマイズしないでください。 |
DDLロック操作で使用するタイムアウト。 |
| NamingType | 「Service Name」または「TNS Name」。 | 使用する接続モード。 |
| TNSName | tnsnames.ora構成ファイルで定義されているアドレス名。このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| Host | データベースサーバーのホスト名またはIPアドレス。 このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| Port | データベースサービスが検出を行うポート。 このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| ServiceName | Oracleデータベースサービスの名前。 このオプションは、NamingTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| NLS_Language | NLS_LANG Oracleの言語環境のパラメータ。 | Oracleドライバから返されるメッセージのロケールを変更します。 |
| NLS_Territory | NLS_LANG OracleのTerritory環境のパラメータ。 | Oracleドライバから返されるメッセージのロケールを変更します。 |
| AdminTablespace | システムテーブルの保存先となるテーブルスペース。 | |
| IndexTablespace | プラットフォームの全インデックスの保存先となるテーブルスペース。 | |
| RuntimeTablespace | 開発環境で作成されたテーブルの保存先となるテーブルスペース。 | |
| LogTablespace | ロギングテーブルを保存するテーブルスペース。 |
セッションデータベース構成
以下のXML要素は、セッションデータベース構成カテゴリの構成を定義します。
<SessionDatabaseConfiguration ProviderKey="[SqlServer|Oracle]">
<KEY [encrypted="[false|true]"]>VALUE</KEY>
...
</SessionDatabaseConfiguration>
ProviderKeyアトリビュートは、Platform Database構成で設定されたProviderKey値と一致している必要があります。このアトリビュートは、構成を適用するデータベース管理システムを指定します。
共通構成
以下は、データベース管理システムに依存しない構成です。
| キー | 値 | 説明 |
|---|---|---|
| SessionUser | OutSystemsセッションメタモデルテーブルの所有者の名前。 | |
| SessionPassword | OutSystemsセッションメタモデルテーブルの所有者のパスワード。 | Configuration Toolはクリアテキストのパスワードを読み取り、暗号化されたバージョンを保存します。 |
| SessionAdvancedSettings | OutSystemsサービスの接続文字列に追加されるADO.NET形式の設定。 | これにより、OutSystemsアプリケーションで特定の接続文字列を使用することができます。 |
| DeleteExpiredSessionsAvoidLockRowCount | 数値。 内部用。カスタマイズしないでください。 |
SQL Server/Azure SQL Database
以下は、SQL ServerとAzure SQL Databaseに固有の構成です。
| キー | 値 | 説明 |
|---|---|---|
| UsedAuthenticationMode | 「Database Authentication」または「Windows Authentication」。 | 使用する認証プロトコル。 Platform Database構成と一致している必要があります。 |
| Server | データベースサーバーのホスト名またはIPアドレス。 | |
| Catalog | OutSystemsが使用するデータベースカタログ。 |
Oracle
以下は、Oracleに固有の構成です。
| キー | 値 | 説明 |
|---|---|---|
| IntrospectionMethod | 内部用。カスタマイズしないでください。 | |
| CI_AI | 「true」または「false」。 内部用。カスタマイズしないでください。 |
大文字と小文字およびアクセントを区別しないモード。 |
| DateFunction | 日付の取得に使用する関数。 内部用。カスタマイズしないでください。 |
|
| DDLLockTimeout | 数値。 内部用。カスタマイズしないでください。 |
DDLロック操作で使用するタイムアウト。 |
| IdType | 「Service Name」または「TNS Name」。 | 使用する接続モード。 |
| TNSName | tnsnames.ora構成ファイルで定義されているアドレス名。このオプションは、IdTypeが「TNS Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| Host | データベースサーバーのホスト名またはIPアドレス。 このオプションは、IdTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| Port | データベースサービスが検出を行うポート。 このオプションは、IdTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| ServiceName | Oracleデータベースサービスの名前。 このオプションは、IdTypeが「Service Name」に設定されている場合のみ利用可能です。詳細については、こちらをご覧ください。 |
|
| NLS_Language | NLS_LANG Oracleの言語環境のパラメータ。 | Oracleドライバから返されるメッセージのロケールを変更します。 |
| NLS_Territory | NLS_LANG OracleのTerritory環境のパラメータ。 | Oracleドライバから返されるメッセージのロケールを変更します。 |
| SessionTablespace | セッションテーブルの保存先となるテーブルスペース。 |
サービス構成
以下のXML要素は、サービス構成カテゴリの構成を定義します。
<ServiceConfiguration>
<KEY>VALUE</KEY>
...
</ServiceConfiguration>
利用可能な構成は以下のとおりです。
| キー | 値 | 説明 |
|---|---|---|
| CompilerServerHostname | デプロイメントコントローラサーバーのホスト名またはIPアドレス。 | 後でフロントエンドサーバーを簡単に追加できるようにするため、ホスト名として値localhostを使用することは推奨されません。 |
| CompilerServerPort | Numeric value | デプロイメントコントローラサーバーにおいてデプロイメントコントローラサービスが使用するポート。 |
| DeploymentServerPort | Numeric value. | フロントエンドサーバーにおいてデプロイサービスが使用するポート。 |
| SchedulerServerPort | Numeric value. | フロントエンドサーバーにおいてスケジューラサービスが使用するポート。 |
| SupportAsynchronousLog | 「true」または「false」。 内部用。カスタマイズしないでください。 |
|
| ServiceInitializationTimeoutInSeconds | 数値。 | サービスを再起動するまでのタイムアウト。デフォルト値は180秒です。 |
サーバー構成
以下のXML要素は、サーバー構成カテゴリの構成を定義します。
<ServerConfiguration>
<KEY>VALUE</KEY>
...
</ServerConfiguration>
利用可能な構成は以下のとおりです。
| キー | 値 | 説明 |
|---|---|---|
| ApplicationServerPort | 内部用。カスタマイズしないでください。 | デフォルトポートは80です。 |
| ApplicationServerSecurePort | 内部用。カスタマイズしないでください。 | デフォルトポートは443です。 |
| MaxConcurrentTimers | 数値。各フロントエンドサーバーで同時に実行できるタイマー（非同期ジョブ）の最大数。 | |
| PlatformServerAdminPassword | Platform Serverの管理者ユーザーのパスワード。 | Configuration Toolはこのキーのクリアテキストのパスワードを読み取って、暗号化されたバージョンをデータベースに保存し、それをPlatform Serverの管理者ユーザーのパスワードとして設定します。また、このキーをファイルから削除します。 パスワードがこのファイルに直接記述されている場合、Configuration Toolは検証を一切行いません。つまり、どのような値でもパスワードとして許容されます。 一方、コマンドラインで実行されるConfiguration Toolでこのパスワードを定義する場合、パスワードは6文字以上の長さで、ユーザー名を含まないものにする必要があります。 |
| WeeksToKeep | 数値。 | ログファイルが保管される期間を表示します。この期間を過ぎるとログテーブルがローテーションされ、情報は失われます。 |
ネットワーク構成
以下のXML要素は、ネットワーク構成カテゴリの構成を定義します。
<NetworkConfiguration>
<KEY>VALUE</KEY>
...
</NetworkConfiguration>
利用可能な構成は以下のとおりです。
| キー | 値 | 説明 |
|---|---|---|
| ApplicationServerVersion | 内部用。カスタマイズしないでください。 | |
| OutgoingIPAddress | フロントエンドサーバーがDeployment Controller Serviceで登録するIPアドレス。自動にする場合は空のままにします。 | |
| RequiresSoapHeadersSlowRetrieval | 内部用。カスタマイズしないでください。 | |
| ServerKind | 内部用。カスタマイズしないでください。 |
キャッシュ無効化構成
以下のXML要素は、キャッシュ無効化構成カテゴリの構成を定義します。
<CacheInvalidationConfiguration>
<KEY [encrypted="[false|true]"]>VALUE</KEY>
...
</CacheInvalidationConfiguration>
アプリケーションおよびOutSystemsサービスによるキャッシュ無効化サービス（RabbitMQなど）への通信を構成するときに使用します。
利用可能な構成は以下のとおりです。
| キー | 値 | 説明 |
|---|---|---|
| ServiceHost | キャッシュ無効化サービスのホスト名またはIPアドレス。 | 後でフロントエンドサーバーを簡単に追加できるようにするため、ホスト名として値localhostを使用することは推奨されません。 |
| ServicePort | 数値。 | アプリケーションやサービスがキャッシュ無効化サービスと通信するときに使用するポート。 |
| ServiceUsername | OutSystemsプラットフォームが使用する無効化サービスのユーザーの名前。 | |
| ServicePassword | OutSystemsプラットフォームが使用する無効化サービスのユーザーのパスワード。 | Configuration Toolはクリアテキストのパスワードを読み取り、暗号化されたバージョンを保存します。 |
| VirtualHost | OutSystemsプラットフォームが使用する無効化サービスの仮想ホストの名前。「/outsystems」など。 | OutSystemsロジックに接続しないその他の目的のためにキャッシュ無効化サービスを再利用できるようにします。 |
| TlsEnabled | Boolean | アプリケーションとキャッシュ無効化サービスの間のセキュアな接続の使用を有効にします。 |
| TlsServerCanonicalName | キャッシュ無効化サービスが使用する証明書の正式名。 |
その他の構成
以下のXML要素は、その他の構成カテゴリの構成を定義します。
<OtherConfigurations>
<KEY>VALUE</KEY>
...
</OtherConfigurations>
利用可能な構成は以下のとおりです。
| キー | 値 | 説明 |
|---|---|---|
| DBIntrospectionTimeout | 数値。 | メタモデルイントロスペクションを実行するデータベースクエリのデフォルトのタイムアウト。 |
| DBTimeout | 数値。 | データベースクエリを完了するまでのデフォルトのタイムアウト。 |
| DBUpdateTimeout | Numeric value. | アプリケーションを1-Click Publishした際に、データベース更新を実行するまでのデフォルト時間を設定します。 |
| InstallationDir | OutSystemsプラットフォームのインストールパス。 | この設定はそのままにしておいてください。構成する必要はありません。 |
| InstanceName | 内部用。カスタマイズしないでください。 | この設定はそのままにしておいてください。構成する必要はありません。 |
| PlatformVersion | OutSystemsプラットフォームのバージョン。 | この設定はそのままにしておいてください。構成する必要はありません。 |
| QueuesAvailable | 「true」または「false」。 | メッセージキューをインストールするかどうかを示します。 |