TIBCO EBX® メイン構成ファイル
Related information
概要
EBX® メイン構成ファイル (デフォルト名は
ebx.properties) には、EBX® を実行するための基本パラメーターのほとんどが含まれています。これは、標準の単純な行指向フォーマットを使用する Java プロパティファイルです。
メイン構成ファイルは、Jakarta EE 展開記述子 を補完します。管理者は、ユーザーインターフェイスを通じてさらに構成を行うこともできます。構成は EBX® リポジトリに保存されます。
以下も参照してください。:
ファイルの場所
メイン構成ファイルへのアクセスパスは、いくつかの方法で指定することができます。優先度は降順です。
-
Java システムプロパティ「ebx.properties」を定義します。たとえば、このプロパティは、オプション
-Debx.properties=<filePath>をjavaコマンドラインコマンドに追加することで設定できます。詳細については、Java ドキュメントを参照してください。 -
サーブレット初期化パラメーター「ebx.properties」を定義します。この標準 Jakarta EE 設定は、Web アプリケーション '
ebx' のweb.xmlファイルで指定する必要があります。EBX® は、サーブレットFrontServletのメソッドServletConfig.getInitParameter ("ebx.properties")を呼び出すことによって、このパラメーターにアクセスします。ServletConfigドキュメントの getInitParameter を参照してください。 -
デフォルトでは、何も指定されていない場合、メイン構成ファイルは Web アプリケーション「
ebx」のWEB-INF/ebx.propertiesに格納されます。
注意:
メイン構成ファイルでのプロパティの指定に加え、システムプロパティでプロパティの値を直接設定することもできます。たとえば、
java コマンドラインコマンドの -D 引数を使用します。
カスタムプロパティと変数置換
プロパティの値には、構文
${propertyKey} を使用する 1 つ以上の変数を含めることができます。ここで、propertyKey は、システムプロパティまたはメイン構成ファイルで定義済みのプロパティのいずれかです。
たとえば、EBX® で提供されるデフォルトの構成ファイルは、カスタムプロパティ
ebx.home を使用してデフォルトの共通ディレクトリを設定し、それが他のプロパティに含まれます。
EBX® ライセンスキープロパティファイルの設定
以下も参照してください。:
ライセンスキーは TIBCO eDelivery サイトから取得できます。
##################################################################
## EBX® license file
## Define the license file using one of the following methods.
## If the license file is defined in multiple locations, the
## order of priority is shown below:
## 1. System property -Debx.license.file=<properties-file>.
## 2. Main ebx.properties configuration 'ebx.license.file'
## property value.
## 3. Default: ${ebx.home}/ebx-license.properties
## The file should have an 'ebx.license' property containing
## the license key.
##################################################################
ebx.license.file=location_of_license_properties
ライセンスキープロパティファイルには以下が含まれている必要があります。
##################################################################
## EBX® License Key
## Ensure the file is writable by EBX®
## to enable updates using the UI license key wizard process.
##################################################################
ebx.license=<your_license_key>
EBX® サーバーを再起動せずにライセンスキーを更新できます。サーバーが変更を検出すると、ライセンスステータスを含むカーネルログエントリが書き込まれます。キーが無効な場合、ユーザーがインターフェイスにアクセスするとライセンスウィザードが表示されます。
注意:
期間限定のライセンスキーの場合、有効期限が切れる数日前に、ライセンスが間もなく期限切れになることを知らせる毎日のカーネル WARN ログが通知されます。
初回起動時の自動インストールの設定
リポジトリは、初回起動時に自動的にインストールできます。
#################################################
## Installation on first launch.
## All values are ignored if the repository is already installed.
#################################################
## Enables repository installation on first startup (default is false).
## If true, property ebx.license from ebx.license.file should also be set to a valid license.
ebx.install.enabled=true
## Following properties configure the repository. Values are optional and defaults are
## automatically generated.
ebx.install.repository.id=00275930BB88
ebx.install.repository.label=A Test
## Following properties specify the administrator. These are ignored if a custom
## directory is defined.
ebx.install.admin.login=admin
ebx.install.admin.firstName=admin
ebx.install.admin.lastName=admin
ebx.install.admin.email=adamin@example.com
## Following property specifies the non-encrypted password used for the administrator.
## It is ignored if a custom directory is defined. It cannot be set if
## property ebx.install.admin.password.encrypted is set.
#ebx.install.admin.password=admin
## Following property specifies the encrypted password used for the administrator.
## It is ignored if a custom directory is defined. It cannot be set if
## property ebx.install.admin.password is set.
## Password can be encrypted by using command:
## java -cp ebx.jar com.orchestranetworks.service.directory.EncryptPassword <login> <password_to_encrypt>
ebx.install.admin.password.encrypted=ff297ae08f7eeb63230b55f7c45a720a017bc71d22eaaec...
EBX® ルートディレクトリの設定
EBX® ルートディレクトリには、Lucene インデックスディレクトリ、アーカイブ、およびリポジトリが H2 スタンドアロンモードで永続化されている場合は H2 データベースファイルが含まれます。また、レガシー XML 監査証跡 (非推奨) も含まれています。
#################################################
## Path for EBX® XML repository
#################################################
ebx.repository.directory=${ebx.home}/ebxRepository
以下も参照してください。:
EBX® リポジトリの構成
EBX® リポジトリの永続性プロパティを構成する前に、リポジトリ管理の章のテクニカルアーキテクチャセクションをよくお読みください。
サポート対象の各データベースに必要なライブラリ (ドライバー) については、データベースドライバーの章で説明しています。
以下も参照してください。:
#################################################
## The maximum time to set up the database connection,
## in milliseconds.
#################################################
ebx.persistence.timeout=10000
#################################################
## The prefix to add to all table names of persistence system.
## This may be useful for supporting multiple repositories in the relational database.
## Default value is 'EBX_'.
#################################################
ebx.persistence.table.prefix=
#################################################
## Case EBX® persistence system is H2 'standalone'.
#################################################
ebx.persistence.factory=h2.standalone
ebx.persistence.user=sa
ebx.persistence.password=
#################################################
## Case EBX® persistence system is H2 'server mode',
#################################################
#ebx.persistence.factory=h2.server
## Specific properties to be set only if you want to ignore the standard
## deployment process of 'ebx' web application in the target operational environment
## (see the deployment descriptor 'web.xml' of 'ebx' web application).
#ebx.persistence.url=jdbc:h2:tcp://127.0.0.1/ebxdb
#ebx.persistence.user=xxxxxxxxx
#ebx.persistence.password=yyyyyyyy
#################################################
## Case EBX® persistence system is Oracle database.
#################################################
#ebx.persistence.factory=oracle
## Specific properties to be set only if you want to ignore the standard
## deployment process of 'ebx' web application in the target operational environment
## (see the deployment descriptor 'web.xml' of 'ebx' web application).
#ebx.persistence.url=jdbc:oracle:thin:@127.0.0.1:1521:ebxDatabase
#ebx.persistence.driver=oracle.jdbc.OracleDriver
#ebx.persistence.user=xxxxxxxxx
#ebx.persistence.password=yyyyyyyy
## Activate to use VARCHAR2 instead of NVARCHAR2 on Oracle; never modify on an existing
## repository.
#ebx.persistence.oracle.useVARCHAR2=false
#################################################
## Case EBX® persistence system is Microsoft SQL Server.
#################################################
#ebx.persistence.factory=sqlserver
## Specific properties to be set only if you want to ignore the standard
## deployment process of 'ebx' web application in the target operational environment
## (see the deployment descriptor 'web.xml' of 'ebx' web application).
#ebx.persistence.url= \
#jdbc:sqlserver://127.0.0.1:1036;databasename=ebxDatabase
#ebx.persistence.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
#ebx.persistence.user=xxxxxxxxx
#ebx.persistence.password=yyyyyyyy
#################################################
## Case EBX® persistence system is Microsoft Azure SQL database.
#################################################
#ebx.persistence.factory=azure.sql
## Specific properties to be set only if you want to ignore the standard
## deployment process of 'ebx' web application in the target operational environment
## (see the deployment descriptor 'web.xml' of 'ebx' web application).
#ebx.persistence.url= \
#jdbc:sqlserver://myhost.database.windows.net:1433;database=ebxDatabase;encrypt=true;\
#trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;
#ebx.persistence.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
#ebx.persistence.user=xxxxxxxxx
#ebx.persistence.password=yyyyyyyy
#################################################
## Case EBX® persistence system is PostgreSQL.
#################################################
#ebx.persistence.factory=postgresql
## Specific properties to be set only if you want to ignore the standard
## deployment process of 'ebx' web application in the target operational environment
## (see the deployment descriptor 'web.xml' of 'ebx' web application).
#ebx.persistence.url=jdbc:postgresql://127.0.0.1:5432/ebxDatabase
#ebx.persistence.driver=org.postgresql.Driver
#ebx.persistence.user=xxxxxxxxx
#ebx.persistence.password=yyyyyyyy
ユーザーとロールのディレクトリの構成
ディレクトリを構成するには、次の専用プロパティを設定および更新します。
以下も参照してください。:
################################################################
##
## EBX DIRECTORY CONFIGURATION
##
################################################################
## 1. Choose the main directory implementation.
## EBX operates with a main directory, which serves as the default authentication source.
## This main directory can be the default directory, the built-in LDAP directory,
## or any custom directory.
## The value must be the fully qualified name of the Java class that implements
## com.orchestranetworks.service.directory.DirectoryFactory
## To choose a main directory
## - Default directory : keep empty
## - LDAP build-in directory : com.orchestranetworks.service.directory.ldap.LdapDirectoryFactory
## - Custom directory : the Java directory factory class name
## Depending on the selected directory, additional properties may be required:
## ebx.directory.ldap.*
#################################################
#ebx.directory.factory=
##################################################
## 2. Enabling and configuring SSO if needed.
## any non-empty value from the following enables the SSO:
## - "OIDC" : to use OIDC.
## - "SAML2" : to use SAML2.
## Depending on the selected protocol, additional properties may be required from:
## ebx.directory.saml2.* , ebx.directory.oidc.* and ebx.directory.bearer.*
#ebx.directory.sso.protocol=OIDC
##################################################
## 3- Enable the synchronized directory
## When SSO or Centralized Authentication is enabled, a second directory,
## referred to as the "synchronized directory", can be added to manage users
## authenticated via the identity provider. In this configuration,
## the main directory is preferably reserved for technical or service users,
## while the synchronized directory handles user accounts coming from the external system.
## any non-empty value from the following enables the synchronized directory:
## - "LDAP" : to use the built-in LDAP as source
## - "SCIM" : to use the built-in SCIM as source
## - "OnLogin" : to use an on login strategy that only stores users that already
## logged in once using SSO.
## Depending on the selected synchronized directory, additional properties may be required:
## ebx.directory.synchronized.* , ebx.directory.ldap.* and ebx.directory.scim.*
#ebx.directory.synchronized.source=SCIM
ビルトインロールの「ADMINISTRATOR」を無効にすることもできます。
#################################################
## Specifies whether the built-in role ADMINISTRATOR is disabled.
## Default value is false.
#################################################
#ebx.directory.disableBuiltInAdministrator=true
同期ディレクトリ
同期ディレクトリを構成するには、次の専用プロパティを設定および更新します。
#################################################
## Synchronized directory
#################################################
## Specifies the EBX® external roles mapper.
## Used to map external roles coming from built-in configurations: LDAP, SCIM, OnLogin.
## possible values:
## - "DEFAULT" or empty:
## Default behaviour : External roles are used as specific roles without mapping.
## the built-in roles Administrator and Read Only are mapped through
## the properties : ebx.directory.synchronized.role.mapper.default.*.
## - "SCRIPT" : use of scripts to map external roles.
## - "CUSTOM" : an implementation of com.orchestranetworks.service.directory.api.ExternalRolesMapper
## to mention above
ebx.directory.synchronized.role.mapper=
#ebx.directory.synchronized.role.mapper.default.administrator=
#ebx.directory.synchronized.role.mapper.default.read.only=
## Custom implementation of com.orchestranetworks.service.directory.api.ExternalRolesMapper
#ebx.directory.synchronized.role.mapper.custom.class=
## The allowed attributes to get from the LDAP response
## and persist in the synchronized directory user attributes.
ebx.directory.synchronized.mapping.ldap.attributes=
## The name of an attribute that contains a role.
## An SAML 2.0 assertion may contain multiple attributes with the same name,
## if the name corresponds to the role name attribute each value will be considered as a role.
## Required if SCIM or OnLogin directory is enabled and SAML2 is used.
## Default value is Role.
ebx.directory.synchronized.sso.mapping.saml2.attributes.role.name=Role
## the allowed attributes to get from the saml assertion
## and persist in the synchronized directory user attributes.
ebx.directory.synchronized.sso.mapping.saml2.attributes=username
## The name of the custom clam that contains a table of roles.
## Required if synchronized directory is enabled and OIDC is used.
ebx.directory.synchronized.sso.mapping.oidc.claims.role.name=groups
## The allowed claims to get from the OIDC token
## and persisted in the synchronized directory user attributes.
ebx.directory.synchronized.sso.mapping.oidc.claims=sub,preferred_username,iss
## The name of the custom clam that contains a table of roles.
## Required if synchronized directory is enabled and BEARER authentication is used.
## Comma separated values.
ebx.directory.synchronized.sso.mapping.bearer.claims.role.name=groups
## The allowed claims to get from the token
## and persisted in the synchronized directory user attributes.
## Note: when jwt is not configured, the user should be declared on the
## synchronized directory to retrieve the claims.
ebx.directory.synchronized.sso.mapping.bearer.claims=sub,preferred_username,iss
## The attribute name that corresponds to the user mail.
ebx.directory.synchronized.sso.mapping.attribute.mail=email
## The user display may be created using an expression from the attributes.
ebx.directory.synchronized.sso.display.user={{preferred_username}}
## These listeners are called when a user logs in or logs out using SSO.
## Implementations of com.orchestranetworks.service.directory.sso.api.OnUserLoginListener
## and com.orchestranetworks.service.directory.sso.api.OnUserLogoutListener
## Comma separated values
ebx.directory.synchronized.sso.listeners=
以下も参照してください。:
ビルトイン LDAP ディレクトリ
メインの EBX® 構成ファイルを通じて、ビルトインの LDAP (Lightweight Directory Access Protocol) ディレクトリ実装をアクティブ化して構成します。
LDAP を有効にするには、ebx.directory.factory プロパティを次のように更新します。
ebx.directory.factory=com.orchestranetworks.service.directory.ldap.LdapDirectoryFactory
LDAP を構成するには、次の専用プロパティを設定および更新します。
####################################################################
## Built-in LDAP Directory
####################################################################
## 1- Connection: [ebx.directory.ldap.default]
## required: - .hostName
## - .port
## optional: - .connectionTimeOutInSeconds | default value: '30' | possible values : positive integer
## - .bindDnOrUser | default value is empty
## - .bindPassword | default value is empty
## - .authenticationMethod | default value: 'none' | possible values : 'simple', 'none'
## - .encryptionMethod | default value: 'none' | possible values : 'ssl', 'tls', 'none'
## Note: .bindDnOrUser and .bindPassword are required when using a basic authentication method.
## 2- Mapping: [ebx.directory.ldap.default.mapping]
## required: - .role.referenceAttribute : the ldap attribute that contains the role name
## - .role.memberAttribute : the ldap attribute that contains the users in a group entry
## - .role.builtin.administrator : the ldap group associated with the builtin administrator role
## - .role.builtin.readOnly : the ldap group associated with the builtin read-only role
## - .user.referenceAttribute : the ldap attribute that contains the user name to use as a login
## - .user.referenceComponentInDN : the ldap dn component that contains the username to use
## optional:
## - .role.mailAttribute : the ldap attribute that contains the role mail
## - .user.mailAttribute : the ldap attribute that contains the user mail
## Note: If not defined, the mails will not be handled.
## 3- Display: [ebx.directory.ldap.default.display]
## optional: - .role : an expression using ldap attributes | example: {{cn}}-{{mail}} which gives: sales-salesTeam@mail.com
## - .user : an expression using ldap attributes | example: {{salutation}} {{firstName}} {{lastName}} Mr John Doe
## - .users.all : If true, all users are returned as profiles with the roles.
## Note: Display is not locale dependent yet.
## 4- Search request templates: [ebx.directory.ldap.default.request.{requestTemplateName}.{field}]
## 4.1- properties of each request template ({field}):
## required: - .baseDN : the request base search DN entry
## - .filter : the request filter
## optional: - .scope | default value: 'subtree'
## | possible values : 'base','one','subtree'
## - .cache.expirationInSeconds | default value: '120'
## | possible values : positive 32 bit integer
## - .cache.refreshInSeconds | default value: '60'
## | possible values : positive 32 bit integer
## - .cache.maxSize | default value: '1000' | possible values : positive 64 bit integer
## - .pageSize | default value: '100' | possible values : positive 32 bit integer
## - .timeLimitInSeconds | default value: '30' | possible values : positive 32 bit integer
## Note: Caches are used on every request template to enhance performance.
## Setting a request template's .cache.maxSize and .cache.expirationInSeconds to 0 will
## disable its related cache.
## Changing the .pageSize of a request template at server runtime will
## evict its related cache.
## 4.2- Request templates {requestTemplateName}:
## required: - .userSearch : search a user | allowed placeholders : {{login}}
## - .userGroupsSearch : search groups of a user | allowed placeholders : {{login}},{{dn}}
## - .groupUsersSearch : search the users under a group | allowed placeholders : {{role}}
## - .allGroupsSearch : search all groups | allowed placeholders :
## - .allUsersSearch : search all users | allowed placeholders :
####################################################################
## 1- Connection
ebx.directory.ldap.default.hostName=localhost
ebx.directory.ldap.default.port=389
ebx.directory.ldap.default.connectionTimeOutInSeconds=30
ebx.directory.ldap.default.bindDnOrUser=cn=admin,dc=example,dc=org
ebx.directory.ldap.default.bindPassword=admin
ebx.directory.ldap.default.authenticationMethod=simple
#ebx.directory.ldap.default.encryptionMethod=
## 2- Mapping
ebx.directory.ldap.default.mapping.role.referenceAttribute=cn
ebx.directory.ldap.default.mapping.role.memberAttribute=member
ebx.directory.ldap.default.mapping.user.referenceAttribute=uid
ebx.directory.ldap.default.mapping.role.mailAttribute=mail
ebx.directory.ldap.default.mapping.user.mailAttribute=mail
## 3- Display
ebx.directory.ldap.default.display.role={{cn}}
ebx.directory.ldap.default.display.user={{cn}} ({{mail}})
## 4- Request templates
ebx.directory.ldap.default.request.userSearch.baseDN=dc=example,dc=org
ebx.directory.ldap.default.request.userSearch.filter=(uid={{login}})
ebx.directory.ldap.default.request.userSearch.scope=subtree
ebx.directory.ldap.default.request.userSearch.cache.expirationInSeconds=120
ebx.directory.ldap.default.request.userSearch.cache.refreshInSeconds=60
ebx.directory.ldap.default.request.userSearch.cache.maxSize=1000
ebx.directory.ldap.default.request.userSearch.pageSize=100
ebx.directory.ldap.default.request.userSearch.timeLimitInSeconds=30
ebx.directory.ldap.default.request.userGroupsSearch.baseDN=${ebx.directory.ldap.default.request.userSearch.baseDN}
ebx.directory.ldap.default.request.userGroupsSearch.filter=(&(objectClass=groupOfNames)(member={{dn}}))
ebx.directory.ldap.default.request.userGroupsSearch.scope=subtree
ebx.directory.ldap.default.request.userGroupsSearch.cache.expirationInSeconds=120
ebx.directory.ldap.default.request.userGroupsSearch.cache.refreshInSeconds=60
ebx.directory.ldap.default.request.allGroupsSearch.baseDN=${ebx.directory.ldap.default.request.userSearch.baseDN}
ebx.directory.ldap.default.request.allGroupsSearch.filter=(objectClass=groupOfNames)
ebx.directory.ldap.default.request.allGroupsSearch.scope=subtree
ebx.directory.ldap.default.request.allGroupsSearch.cache.expirationInSeconds=120
ebx.directory.ldap.default.request.allGroupsSearch.cache.refreshInSeconds=60
ebx.directory.ldap.default.request.allGroupsSearch.pageSize=100
ebx.directory.ldap.default.request.allUsersSearch.baseDN=${ebx.directory.ldap.default.request.userSearch.baseDN}
ebx.directory.ldap.default.request.allUsersSearch.filter=(objectClass=inetOrgPerson)
ebx.directory.ldap.default.request.allUsersSearch.scope=subtree
以下も参照してください。:
SCIM ディレクトリ
メインの EBX® 構成ファイルを通じて、SCIM (System for Cross-domain Identity Management) 機能をアクティブ化して構成します。
SCIM を構成するには、次の専用プロパティを設定および更新します。
#################################################
## SCIM properties
## SCIM uses Users and Groups requests that must be configured.
## Authentication info goes in headers which are '%' separated key:value pairs.
## Cache is tuned with max size and expiration.
## Default cache values are 1000 entries and 60 seconds.
#################################################
#ebx.directory.scim.default.request.users.url=\
# http[s]://<hostname>:<port>/<scim-users-path>
#ebx.directory.scim.default.request.users.headers=\
# Authorization: Bearer <token> \
# % Content-Type: application/json
#ebx.directory.scim.default.request.users.page.size=2
#ebx.directory.scim.default.request.users.cache.max.size=1000
#ebx.directory.scim.default.request.users.cacheExpiration=60
#ebx.directory.scim.default.request.groups.url=\
# http[s]://<hostname>:<port>/<scim-groups-path>
#ebx.directory.scim.default.request.groups.headers=
#ebx.directory.scim.default.request.groups.page.size=2
#ebx.directory.scim.default.request.groups.cache.max.size=1000
#ebx.directory.scim.default.request.groups.cache.expiration=60
以下も参照してください。:
SAML 2.0
SAML 2.0 は、メイン構成ファイルを通じてアクティブ化および構成できます。
####################################################################
## SAML 2.0 properties
## The configuration files idp-descriptor.xml should be located under
## {ebx.repository.directory}
## An sp-descriptor.xml would be generated on the system startup and located under
## {ebx.repository.directory}. The final structure:
## {ebx.repository.directory}
## |- saml2
## |- idp-descriptor.xml : to put manually.
## |- sp-descriptor.xml : generated on startup and on property update.
####################################################################
## [Required if no servlet configuration is set {ebx.servlet.http(s).xxx}]
## The base uri of the service provider.
#ebx.directory.saml2.default.sp.base.url=http[s]://<hostname>:<port>
## [Required if SAML2.0 is enabled] The service provider entity ID
#ebx.directory.saml2.default.sp.entity.id=
## Keystore configuration
## The keystore type, default value is PKCS12
#ebx.directory.saml2.default.keystore.type=PKCS12
## The keystore path
#ebx.directory.saml2.default.keystore.path=
## [Required if SAML2.0 is enabled] keystore password
#ebx.directory.saml2.default.keystore.password=
## [Required if SAML2.0 is enabled] keystore alias
#ebx.directory.saml2.default.keystore.key.alias=
## [Required if SAML2.0 is enabled] private key password
#ebx.directory.saml2.default.keystore.key.password=
## [Optional] The Name ID attribute to use as userName.
#ebx.directory.saml2.default.name.id.attribute=
## [Optional] The Name ID format to use as userName if the nameId.attribute is not set or found
#ebx.directory.saml2.default.name.id.format=
## [Optional] Specifies whether the service provider signs authentication
## requests it sends to the identity provider
## default value: true
#ebx.directory.saml2.default.authn.requests.signed=true
## [Optional] Specify whether the service provider signs authentication requests
## it sends to the identity provider
## default value: true
#ebx.directory.saml2.default.want.assertions.signed=true
## [Optional] specify whether the service provider (SP) wants the SAML assertions received from
## the identity provider to be signed or not.
## default value: true
#ebx.directory.saml2.default.want.responses.signed=true
## [Optional] specifies whether the Service Provider signs the logout requests it sends to the
## Identity Provider.
## default value: true
#ebx.directory.saml2.default.sp.logout.request.signed=true
以下も参照してください。:
OpenID Connect
OpenID Connect は、メイン構成ファイルを通じてアクティブ化および構成できます。
####################################################################
## OpenID Connect properties
####################################################################
## [Required if no servlet configuration is set {ebx.servlet.http(s).xxx}] The
## base url of the client.
#ebx.directory.oidc.default.client.base.url=http[s]://<hostname>:<port>
## [Required if oidc is enabled] the oidc client id
#ebx.directory.oidc.default.client.id=ebxoidc
## [Required if oidc is enabled] the oidc client secret
#ebx.directory.oidc.default.client.secret=ZXLYr53k8mPBKDQAqSMX7gdQ2iWMxN9u
## [Required if oidc is enabled] the Discovery URI or the file URI that contains the
## configuration.
#ebx.directory.oidc.default.discovery.uri=\
# http[s]://<hostname>:<port>/<openid-discovery-path>
## [Optional] The OIDC claim to use as a username.
## default value: preferred_username
#ebx.directory.oidc.default.claim.username=preferred_username
## [Optional] Specifies the maximum time to wait in milliseconds for a connection to
## be established
## with the OIDC Provider
## default value: 500
#ebx.directory.oidc.default.http.connect.timeout=1000
## [Optional] Specifies the maximum time to wait in milliseconds for data to be read
## from the input
## stream once the connection is established
## default value: 5000
#ebx.directory.oidc.default.http.read.timeout=5000
以下も参照してください。:
ベアラー認証
ベアラー認証は、メイン構成ファイルを通じてアクティブ化および構成できます。
注意:
JWT の場合、「sub」(サブジェクト) クレームに EBX® で使用するユーザー名が含まれていることを確認してください。
####################################################################
## Bearer authentication properties
## ----------------------------------------------------------------
## Enable the Bearer authentication
## default value: false
#ebx.directory.bearer.default.enabled=true
## [Required to enable JWT] the URI of the file or the link that contains the JWT keys.
#ebx.directory.bearer.default.jwt.jwks.uri=\
# http[s]://<hostname>:<port>/<bearer-certs-path>
## [Required if JWT is enabled] define the issuers to verify on the jwt token
## comma separated values.
#ebx.directory.bearer.default.jwt.issuers=http[s]://<hostname>:<port>/<bearer-issuer-path>
## [Optional] define the scope to verify on the jwt token when authenticating
## in data services.
#ebx.directory.bearer.default.scope.dataservices=ebx-dataservices
## [Optional] The bearer claim to use as a username.
## default value: preferred_username
#ebx.directory.bearer.default.jwt.claim.username=preferred_username
## enables the handling of encrypted JWT.
## default value : false
#ebx.directory.bearer.default.jwt.encryption.enabled=false
## Key store configuration to handle JWT decryption.
## keystore type, default value is PKCS12
#ebx.directory.bearer.default.jwt.encryption.keystore.type=PKCS12
## [Required if encryption is enabled] keystore path
#ebx.directory.bearer.default.jwt.encryption.keystore.path=/home/keystore.p12
## [Required if encryption is enabled] keystore password
#ebx.directory.bearer.default.jwt.encryption.keystore.password=keypass
## [Required if encryption is enabled] key alias
#ebx.directory.bearer.default.jwt.encryption.keystore.key.alias=ebx.jwt
## [Required if encryption is enabled] key password
#ebx.directory.bearer.default.jwt.encryption.keystore.key.password=keypass
## [Optional] an introspection http request pattern to verify a token by the
## Authorization server.
## Http syntax:
## Arguments: @method @uri @header[*] @content.
## Encoding: uri and its query params should be encoded.
## Header: '%' is used as a separator of headers
## Place holder: {{token}} place holder should be used and will be replaced by the
## token to verify on the Authorization server.
## '@' is a reserved character delimiter that should not be used in the request unless
## encoded If an introspection request is set, no local verification is done on the
## bearer token even if it is a JWT and consequently it may cause performance issues.
#ebx.directory.bearer.default.introspection.request=\
# @method [POST] \
# @uri [http[s]://<hostname>:<port>/<bearer-introspection-path>] \
# @header [Content-Type: application/x-www-form-urlencoded] \
# @content [token={{token}}&client_id=oauth2& \
# client_secret=rNvm8412z0o9ZZFvOirUZeOJYIyRz8cK]
EBX® ローカリゼーションの構成
このパラメーターは、実行時に使用されるロケールの構成に使用されます。このリストには、エンドユーザーに公開されているすべてのロケールが含まれています。EBX® は、このリストで宣言されていない言語でラベルおよびメッセージを表示することはできません。
デフォルトのロケールは、リストの最初のロケールになります。
#################################################
## Available locales, separated by a comma.
## The first element in the list is considered as the default locale.
## If not set, available locales are 'en-US, fr-FR'.
##
#################################################
#ebx.locales.available=en-US, fr-FR
以下も参照してください。:
一時ファイルディレクトリの設定
一時ファイルは次のように保存されます。
#################################################
## Directories for temporary resources.
#################################################
## The property ebx.temp.directory allows to specify a directory for temporary files.
## Default value is java.io.tmpdir
#ebx.temp.directory = /tmp/java
ebx.temp.directory = \\${java.io.tmpdir}
## The property ebx.temp.cache.directory allows to specify the directory containing
## temporary files for cache.
## Default value is ${ebx.temp.directory}/ebx.platform.
#ebx.temp.cache.directory = ${ebx.temp.directory}/ebx.platform
## The property ebx.temp.import.directory allows to specify the directory containing
## temporary files for import.
## Default value is ${ebx.temp.directory}/ebx.platform.
#ebx.temp.import.directory = ${ebx.temp.directory}/ebx.platform
監査証跡のアクティブ化
デフォルトでは、監査証跡のログは無効になっています。INFO レベルのメッセージをログに記録するように「監査」ログカテゴリを構成することでアクティブ化できます。たとえば、以下は特定の 「ebxFile」アペンダー を使用して監査証跡メッセージをログに記録します。
ebx.log4j.category.log.audit = INFO, ebxFile:audit
以下も参照してください。:
レガシー XML 監査証跡のアクティブ化 (非推奨)
デフォルトでは、XML 監査証跡は有効化されていません。次の変数を使用して有効化できます。
#################################################
## The XML history has been replaced by an SQL history.
## This old XML history can be activated using the following variable.
## Default is false.
#################################################
ebx.history.xmlaudittrail.activated = false
以下も参照してください。:
-
レガシー XML 監査証跡
EBX® ログの構成
以下も参照してください。:
EBX® メインファイルメカニズム
最も重要なロギングカテゴリは次のとおりです。
|
ebx.log4j.category.log.kernel
|
EBX® の主な機能、モジュールとデータモデルの処理、例外、およびコンパイル結果のログ。
|
|
ebx.log4j.category.log.workflow
|
ワークフローに関する主な機能、警告、および例外のログ。
|
|
ebx.log4j.category.log.persistence
|
基礎となるデータベースとの通信に関連するログ。
|
|
ebx.log4j.category.log.setup
|
モジュールとデータモデルを除くすべての EBX® オブジェクトのコンパイル結果のログ。
|
|
ebx.log4j.category.log.validation
|
データセットの検証結果のログ。
|
|
ebx.log4j.category.log.mail
|
サーバーから送信されたメールに関連するアクティビティのログ (SMTP とメールの有効化と構成を参照)。
注意:このカテゴリでは、無限ループを回避するためにカスタム SMTP アペンダーを使用しないでください。
|
|
ebx.log4j.category.log.d3
|
EBX® の D3 イベントのログ。
|
|
ebx.log4j.category.log.dataservices
|
EBX® のデータサービスイベントのログ。
|
|
ebx.log4j.category.log.monitoring
|
メモリ監視の未加工ログ。
|
|
ebx.log4j.category.log.request
|
EBX® の リクエストおよびクエリイベントのログ:期間が ebx.logs.request.durationThreshold ミリ秒を超える実行、最適化フェーズが ebx.logs.request.optimizationThreshold ミリ秒を超えるリクエスト/クエリ、および結果の反復中に内部的に例外が発生する実行。ログレベルが DEBUG に設定されている場合、すべてのリクエスト/クエリは期間に関係なくログに記録されます。
|
|
ebx.log4j.category.log.restServices
|
REST Toolkit からのイベントを含む、EBX® の REST サービスイベントのログ。
|
|
ebx.log4j.category.log.audit
|
監査証跡機能のログ。
|
|
ebx.log4j.category.log.assistant
|
アシスタント機能のログ。
|
これらのカテゴリの一部は、
LoggingCategory インターフェイスを使用してカスタムコードで書き込むこともできます。
#################################################
## Log4J properties:
##
## We have some specific syntax extensions:
## - Appender ebxFile:<aFileName>
## Defines a file appender with default settings (threshold=DEBUG)
##
## - property log.defaultConversionPattern is set by Java
##
## Note: Apache Log4j 2 native configuration mechanisms may be used instead, or in combination,
## of these ones. For more information, see 'Logs configuration' section in
## 'Administration overview' chapter from EBX® documentation.
#################################################
#ebx.log4j.debug=true
#ebx.log4j.disable=
ebx.log4j.rootCategory= INFO
ebx.log4j.category.log.kernel= INFO, Console, ebxFile:kernel, kernelMail
ebx.log4j.category.log.workflow= INFO, ebxFile:workflow
ebx.log4j.category.log.persistence= INFO, ebxFile:persistence
ebx.log4j.category.log.setup= INFO, Console, ebxFile:kernel
ebx.log4j.category.log.mail= INFO, Console, ebxFile:mail
ebx.log4j.category.log.frontEnd= INFO, Console, ebxFile:kernel
ebx.log4j.category.log.frontEnd.incomingRequest= INFO
ebx.log4j.category.log.frontEnd.requestHistory= INFO
ebx.log4j.category.log.frontEnd.UIComponentInput= INFO
ebx.log4j.category.log.fsm= INFO, Console, ebxFile:fsm
ebx.log4j.category.log.fsm.dispatch= INFO
ebx.log4j.category.log.fsm.pageHistory= INFO
ebx.log4j.category.log.wbp= FATAL, Console
#--------------------------------------------------
ebx.log4j.appender.Console.Threshold = INFO
ebx.log4j.appender.Console=com.onwbp.org.apache.log4j.ConsoleAppender
ebx.log4j.appender.Console.layout=com.onwbp.org.apache.log4j.PatternLayout
ebx.log4j.appender.Console.layout.ConversionPattern=${log.defaultConversionPattern}
#--------------------------------------------------
ebx.log4j.appender.kernelMail.Threshold = ERROR
ebx.log4j.appender.kernelMail = com.onwbp.org.apache.log4j.net.SMTPAppender
ebx.log4j.appender.kernelMail.To = admin@domain.com
ebx.log4j.appender.kernelMail.From=admin${ebx.site.name}
ebx.log4j.appender.kernelMail.Subject=EBX® Error on Site ${ebx.site.name} (VM ${ebx.vm.id})
ebx.log4j.appender.kernelMail.layout.ConversionPattern=**Site ${ebx.site.name} (VM${ebx.vm.id})**%n${log.defaultConversionPattern}
ebx.log4j.appender.kernelMail.layout=com.onwbp.org.apache.log4j.PatternLayout
#--------------------------------------------------
ebx.log4j.category.log.monitoring=INFO, ebxFile:monitoring
ebx.log4j.category.log.dataServices=INFO, ebxFile:dataServices
ebx.log4j.category.log.d3=INFO, ebxFile:d3
ebx.log4j.category.log.request=INFO, ebxFile:request
ebx.log4j.category.log.restServices=INFO, ebxFile:dataServices
ebx.log4j.category.log.audit=INFO, ebxFile:audit
ebx.log4j.category.log.assistant=INFO, ebxFile:assistant
カスタム ebxFile アペンダー
トークン
ebxFile: は、デフォルト設定で毎日のローリングファイルアペンダーを定義するためのショートカットとして使用できます。この後にファイル名を付ける必要があります。次に、ディレクトリ ebx.logs.directory 内のファイルに書き込むアペンダーを有効にします。この場合のしきい値は DEBUG に設定します。
プロパティ
ebx.log4j.appender.ebxFile.backup.Threshold では、毎日のロールオーバーのバックアップファイルの最大サイズ (メガバイト単位) を定義できます。
#################################################
## Directory of log files 'ebxFile:'
## This property is used by special appender prefixed
## by 'ebxFile:' (see log section below)
#################################################
ebx.logs.directory=${ebx.home}/ebxLog
#################################################
## Daily rollover threshold of log files 'ebxFile:'
## Specifies the maximum size (in megabytes) of backup files for daily rollover
## of 'ebxFile:' appenders.
## When set to a negative value, backup log files are never purged.
## Default value is -1.
#################################################
ebx.log4j.appender.ebxFile.backup.Threshold=-1
カスタム SMTP アペンダー
アペンダー
com.onwbp.org.apache.log4j.net.SMTPAppender は、非同期のメール送信者を指定します。
以下も参照してください。:
カスタムモジュールログのしきい値
デフォルトでは、カスタムモジュールに関連付けられているログカテゴリのログレベルのしきい値は、
INFO に設定されています。
このしきい値は、カスタムモジュール
xxxxxx のプロパティ ebx.log4j.category.log.wbp.xxxxxx を設定することでカスタマイズできます。
例:
ebx.log4j.category.log.wbp.mycompany-module=DEBUG
以下も参照してください。:
アドオンモジュールのログしきい値
デフォルトでは、アドオンモジュールのログレベルのしきい値は、
INFO に設定されています。
ログレベルのしきい値は、アドオンモジュール
ebx-addon-xxxxxx のプロパティ ebx.log4j.category.log.addon.xxxxxx を設定することでカスタマイズできます。
例:
ebx.log4j.category.log.addon.daqa=DEBUG
EBX® メインファイルメカニズムから Apache Log4j™ 2 への移行とその逆
Apache Log4j™ 2 がプログラムで構成されていないと仮定すると、あるアプローチから別のアプローチに移行することは、以前に使用していたファイルをクリーンアップし、すべてのロガー構成を新しい形式に変換し、ターゲットファイルを適切な場所にインストールするのと同じくらい簡単です。
EBX® ロガー構成を定義するには、EBX® ログの構成を参照してください。
Apache Log4j™ 2 ロガー構成を定義するには、EBX® ロガー名から ebx.log4j.category プレフィックスを削除し、ebx.log4j.rootCategory 構成をルートロガーに置き換えます。残りの手順については、 Apache Log4j™ 2 構成ドキュメントを参照してください。
基礎となる EBX® ログ構成を考慮すると、次のようになります。
ebx.log4j.appender.Console= com.onwbp.org.apache.log4j.ConsoleAppender
ebx.log4j.appender.Console.layout=com.onwbp.org.apache.log4j.PatternLayout
ebx.log4j.appender.Console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} %-5p %-6pid{[0]} --- [%15.15t] %-40.40c{39} : %m%n
ebx.log4j.category.log.kernel= INFO, Console
ebx.log4j.rootCategory= INFO, Console
Apache Log4j™ 2 と同等の構成は次のようになります。
{
"configuration": {
"appenders": {
"Console": {
"name": "Console",
"PatternLayout": {
"pattern": "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5p %-6pid{[0]} --- [%15.15t] %-40.40c{39} : %m%n"
}
}
},
"loggers": {
"logger": [
{
"name": "log.kernel",
"level": "INFO",
"AppenderRef": {
"ref": "Console"
}
}
],
"root": {
"level": "INFO",
"AppenderRef": {
"ref": "Console"
}
}
}
}
}
注意:
カスタム ebxFile アペンダーは Apache Log4j™ 2 にネイティブには存在しませんが、その動作は模倣することができます。
注意:
あるメカニズムから別のメカニズムに移行する場合は、機能範囲をできるだけ近づけるために、すべてのロガーを移行してください。
SMTP とメールの有効化と構成
内部メールマネージャーは、非同期でメールを送信します。これは、ワークフローエンジンとカスタム SMTP アペンダー
com.onwbp.org.apache.log4j.net.SMTPAppender で使用されます。
以下も参照してください。:
#################################################
## SMTP and emails
#################################################
## Activate emails (true or false, default is false).
## If activated, the deployer must ensure that the entry 'mail/EBX_MAIL_SESSION' is bound
## in the operational environment of the application server (except if a specific email
## configuration is used by setting the property ebx.mail.smtp.host below).
#ebx.mail.activate=false
## Polling interval is in seconds (default is 10).
#ebx.mail.polling.interval=10
## Specific properties to be set only if you want to ignore the standard
## deployment process of 'ebx' web application in the target operational environment
## (see the deployment descriptor 'web.xml' of 'ebx' web application).
#ebx.mail.smtp.host = smtp.domain.com
## SMTP port default is 25.
#ebx.mail.smtp.port= 25
#ebx.mail.smtp.login=
#ebx.mail.smtp.password=
## SMTP socket connection timeout value in milliseconds (default is 600000).
#ebx.mail.smtp.connectionTimeout=600000
## SMTP socket read timeout value in milliseconds (default is 600000).
#ebx.mail.smtp.timeout=600000
## SMTP socket write timeout value in milliseconds (default is 600000).
#ebx.mail.smtp.writeTimeout=600000
## Activate SSL (true or false, default is false).
#ebx.mail.smtp.ssl.activate=true
データサービスの構成
#################################################
## Data services
#################################################
## Specifies the default value of the data services parameter
## 'disableRedirectionToLastBroadcast'.
## Default is false.
#ebx.dataservices.disableRedirectionToLastBroadcast.default=false
## Specifies the default value for deletion at the end of close and
## merge operations.
## If the parameter is set in the request operation, it overrides
## this default setting.
## If unspecified, default is false.
#ebx.dataservices.dataDeletionOnCloseOrMerge.default=false
#ebx.dataservices.historyDeletionOnCloseOrMerge.default=false
## Specifies the default maximum pagination size value for the select
## operations. This configuration is used by SOAP and REST connectors.
## Default value is 10000, maximum recommended value is 100000
#ebx.dataservices.pagination.maxSize.default= 10000
## Specifies the default pagination size value for the select
## operations. This configuration is used by the SOAP connector.
## Default value is 10.
#ebx.dataservices.pagination.pageSize.default=10
## Upon WSDL generation, specifies if the target namespace value
## corresponds to the content before 5.5.0 'ebx-services'
## or 'urn:ebx:ebx-services' in conformity with the URI syntax.
## If the parameter is set to true, there is no check of the target
## namespace as URI at the WSDL generation.
## If unspecified, default is false.
#ebx.dataservices.wsdlTargetNamespace.disabledCheck=false
#################################################
## REST configuration
#################################################
## If activated, the HTTP request header 'Accept' is used to specify
## the accepted content type. If none is supported, an error is
## returned to the client with the HTTP code 406 'Not acceptable'.
## If deactivated, the header is ignored therefore the best content
## type is used.
## Default is false.
#ebx.dataservices.rest.request.checkAccept=false
## If activated, when a REST data service authentication negotiate fails,
## EBX response includes fallback to 'Basic' authentication method by setting
## the HTTP header 'WWW-Authenticate' to 'Basic'.
## Note: This property only activate/deactivate
## the authentication fallback.
## Default is false.
#ebx.dataservices.rest.auth.tryBasicAuthentication=false
## Authorization token timeout is seconds.
## Default value is 1800 seconds (30 minutes)
## This value is ignored if 'Token Authentication Scheme' is not activated.
#ebx.dataservices.rest.auth.token.timeout=1800
# Specifies the maximum size in KB of a response in BO select
# operations. This configuration is used by the REST connector.
# If exceeded, a partial response is returned with a limited number
# of business objects and the HTTP status code 206 Partial Content.
# Default value is 1024 (1MB)
# The minimum value is 56 which is the default buffer size of the
# JSON serializer
# The maximum value is 10MB.
#ebx.dataservices.rest.bo.maxResponseSizeInKB=1024
JMS の有効化と構成
以下も参照してください。:
#################################################
## JMS configuration for Data Services
#################################################
## Activates JMS (true or false, default is false).
## If activated, the deployer must ensure that the entry 'jms/EBX_JMSConnectionFactory'
## are bound in the operational environment of the application server.
## The entry 'jms/EBX_QueueIn' should also be bound to enable handling Data Services
## request using JMS.
#ebx.jms.activate=false
## Activates JMS queue for failures (true or false, default is false).
## If activated, the deployer must ensure that the entry 'jms/EBX_QueueFailure' is bound
## in the operational environment of the application server.
#ebx.jms.activate.queueFailure=false
## Number of concurrent listener(s)
## Default is 3.
## Property is used if ebx.jms.activate is set to true.
#ebx.jms.listeners.count=3
分散データ配信 (D3) の構成
REST Toolkit サービスの構成
#################################################
## REST configuration
#################################################
## Defines the maximum number of bytes that will be extracted
## from the REST request body to build some DEBUG log messages.
## Default value is 8192 bytes.
## This value is ignored if DEBUG level is not activated on the restServices logger.
#ebx.restservices.log.body.content.extract.size=8192
キーストアの機密プロパティファイルの場所
機密プロパティは、キーストアファイルの場所と、シークレットキーのエイリアスやパスワードなどのさまざまな情報を指定します。
##################################################################
## Keystore sensitive property file.
##################################################################
# Specifies the path of the file keystore.
# If the specified path is not absolute, it must be relative to ${ebx.repository.directory}.
# The default file keystore path is 'ebx-keystore-sensitive.properties'.
ebx.keystore.sensitive.properties.path=${ebx.repository.directory}/ebx-keystore-sensitive.properties
以下も参照してください。:
ステージングの有効化と構成
ステージングは構成によって有効化/無効化されます。メモリとディスクの使用を最適化するために、いくつかのオプションを設定できます。プロパティは次のように構成されます。
#################################################
## Staging configuration
#################################################
## Activates staging (true or false, default is true).
#ebx.staging.activated=true
## Defines the max size on disc
## dedicated to staging temporary folders.
## 0 defines an infinite size.
## If unset, the default value is 0.
#ebx.staging.maxTemporaryFolderSizeInBytes=0
## Max size for canonicalization of attachments in bytes.
## Canonicalization consumes memory and CPU on large xml and json for attachments.
## If not set, default value is 10 Mo (10485760).
#ebx.staging.maxCanonicalizationSizeInBytes=10485760
## Defines the maximum number of staging element per list when browsing a repository
## If not defined, the default value is 1000.
#ebx.staging.maxElementPerList=1000
## Defines the maximum number of staging element per selection operation when browsing a repository
## If not defined, the default value is 1000.
#ebx.staging.maxElementSelection=1000
# Defines a set of folder relative paths to ${ebx.repository.directory}/startup, separated by commas,
# used to configure the import of staging archives on startup.
# The folders must be strictly located in the startup folder with no deviations or shortcuts
# Each folder is a configuration of an import which must contain a file
# named "instructions.json" and the staging archives to import.
# Note that the instructions file can only mention archives strictly under the same folder
# and can not be on the root of (${ebx.repository.directory}/startup).
# In case of errors, an error.json report is added to the folder.
# In case of success, an output.json report is added to the folder
# and the folder would be ignored in the next startup.
# The content of the file is a json in the following format:
# {
# "imports": [
# {
# "archiveFilePath": "myArchive1.zip"
# },
# {
# "archiveFilePath": "myArchive2.zip",
# "advanced_options": {
# "forceUpdateOnIdenticalComponent": false,
# "importDefinition": true
# }
# }
# ]
#}
# [forceUpdateOnIdenticalComponent] boolean, when true, forces the update of a component even
# if it is the same in the repository.
# [importDefinition] boolean, when true, imports the domain definition in the staging domain
# configurations to be able to re-export the same domain.
#ebx.staging.importOnStartup=hr,catalog
以下も参照してください。:
エンドユーザーブラウザーからの Web アクセスの構成
HTTP 認証ヘッダーポリシー
EBX® は、HTTP ヘッダーを使用して資格情報を送受信するための 3 つのポリシーをネイティブに提供します。
standard
|
これは、RFC 2617 で説明されている HTTP 認証 ヘッダーを使用した認証スキームに対応します。
|
ebx
|
HTTP 認証ヘッダーのオーバーライド防止のため、このポリシーは standard と同様に機能しますが、資格情報は EBX® 固有の HTTP ヘッダーに保存されます。
|
both
|
これは、前述の 2 つのポリシーの組み合わせです。
|
#################################################
## EBX® authorization header policy for HTTP requests
##
## Possible values are: standard, ebx, both.
## standard:
## the standard HTTP Authorization header holds the credentials
## ebx:
## an EBX® specific HTTP header holds the credentials
## both:
## both (standard and specific) HTTP headers hold the credentials
##
## Default value is: both.
#################################################
#ebx.http.authorization.header.policy=both
URL コンピューティング
デフォルトでは、EBX® は「スタンドアロン」モードで実行され、外部リソース (例、画像、JavaScript) はアプリケーションサーバーによって提供されます。
また、デフォルトでは、メイン構成ファイルの URL 関連のパラメーターを設定する必要はありません。
この場合、サーバー名とポートは、EBX® に送信された初期リクエストから取得されます。
以下も参照してください。:
#################################################
## EBX® FrontServlet: default properties for computing servlet address
##
## {useLocalUrl}:
## If set to true, servlet address is a "local absolute" URL.
## (that is, a relative URL consisting of an absolute path: "/path")
## See RFC 2396, http://www.ietf.org/rfc/rfc2396.txt).
## This property is defined once for HTTP and HTTPS.
## Default value is false.
##
## {host}:
## If neither defined nor adapted, retrieves initial request host
## {port}:
## If neither defined nor adapted, retrieves initial request host
## {path}:
## Mandatory, may be empty
## {ui.path}:
## If not defined, defaults to ebx-ui/
## {http.useHttpsSettings}:
## If true, force the use of SSL security even if the incoming requests do not
## {authentication.redirectToHttps}
## If set to true, an HTTP request to the login form is automatically redirected to force it
## to HTTPS.
## Default is false.
## Usually, this property should be set to false if EBX® is behind a reverse proxy or a firewall
## that takes care of HTTPS encryption.
##
## Resulting address will be:
## EBX®: protocol://{host}:{port}/{path}
## UI: protocol://{host}:{port}/{ui.path}
##
## Each property for HTTP (except {port}) may be inherited from HTTPS property,
## and reciprocally.
#################################################
ebx.servlet.useLocalUrl=true
#ebx.servlet.http.host=
#ebx.servlet.http.port=
ebx.servlet.http.path=ebx/
#ebx.servlet.http.ui.path=ebx-ui/
#ebx.servlet.http.authentication.path=ebx-authentication/
#ebx.servlet.http.authentication.redirectToHttps=false
#ebx.servlet.http.useHttpsSettings=false
#ebx.servlet.https.host=
#ebx.servlet.https.port=
ebx.servlet.https.path=ebx/
#ebx.servlet.https.ui.path=ebx-ui/
#ebx.servlet.https.authentication.path=ebx-authentication/
#################################################
## External resources: default properties for computing external resources address
##
## The same rules apply as EBX® FrontServlet properties (see comments).
##
## Each property may be inherited from EBX® FrontServlet.
#################################################
ebx.externalResources.useLocalUrl=true
#ebx.externalResources.http.host=
#ebx.externalResources.http.port=
#ebx.externalResources.http.path=
#ebx.externalResources.http.useHttpsSettings=false
#ebx.externalResources.https.host=
#ebx.externalResources.https.port=
#ebx.externalResources.https.path=
プロキシモード
プロキシモードでは、フロントエンド HTTP サーバーを使用して静的リソース (例、画像、CSS、JavaScript) を提供できます。このアーキテクチャは、静的 HTTP リクエストでのアプリケーションサーバーの負荷を軽減します。この構成では、フロントエンドサーバーで SSL セキュリティを使用することもできます。
Web サーバーは、URL 内のパスに従ってアプリケーションサーバーにリクエストを送信します。
servletAlias および uiServletAlias パスは、メイン構成ファイルで指定されます。
Web サーバーは、すべての外部リソースを提供します。これらのリソースは、
resourcesAlias パスを使用してアクセス可能な専用ディレクトリに保存されます。
EBX® は、ファイルシステムから外部リソースにもアクセスできる必要があります。これを行うには、プロパティ
ebx.webapps.directory.externalResources を指定する必要があります。
ebx.servlet.http.useHttpsSettings および/または ebx.externalResources.http.useHttpsSettings プロパティが true に設定されている場合、受信リクエストは常に HTTPS であると見なされます。デフォルト値は false です。これらのプロパティは、EBX® がリバースプロキシまたは HTTPS 暗号化を処理するファイアウォールの背後にある場合に役立ちます。
メイン構成ファイルは、次のように構成できます。
#################################################
## Path for external resources if they are not
## delivered within web applications
## This field is mandatory if in proxy mode.
#################################################
ebx.webapps.directory.externalResources=D:/http/resourcesFolder
#################################################
ebx.servlet.useLocalUrl=true
#ebx.servlet.http.host=
#ebx.servlet.http.port=
ebx.servlet.http.path=servletAlias
ebx.servlet.http.ui.path=uiServletAlias
ebx.servlet.http.authentication.path=authenticationServletAlias
#ebx.servlet.http.authentication.redirectToHttps=false
#ebx.servlet.http.useHttpsSettings=false
#ebx.servlet.https.host=
#ebx.servlet.https.port=
ebx.servlet.https.path=servletAlias
ebx.servlet.https.ui.path=uiServletAlias
ebx.servlet.https.authentication.path=authenticationServletAlias
#################################################
ebx.externalResources.useLocalUrl=true
#ebx.externalResources.http.host=
#ebx.externalResources.http.port=
ebx.externalResources.http.path=resourcesAlias
#ebx.externalResources.http.useHttpsSettings=false
#ebx.externalResources.https.host=
#ebx.externalResources.https.port=
ebx.externalResources.https.path=resourcesAlias
注意:
プロキシモードを使用する場合、
ebx-dataservices モジュールへの URL はリネージ管理パネルから構成する必要があります。指定された URL は、パスを /ebx-dataservices で終了する必要があることに注意してください。
リバースプロキシモード
EBX® で生成されたリクエストおよび外部リソースの URL に、受信リクエストとは異なるプロトコル、特定のサーバー名、特定のポート番号、または特定のパスプレフィックスが必要な場合、プロパティは次のように構成できます。
#################################################
#ebx.servlet.useLocalUrl=false
ebx.servlet.http.host=reverseDomain
#ebx.servlet.http.port=
ebx.servlet.http.path=ebx/
#ebx.servlet.http.ui.path=ebx-ui/
#ebx.servlet.http.authentication.path=ebx-authentication/
#ebx.servlet.http.authentication.redirectToHttps=false
#ebx.servlet.http.useHttpsSettings=false
ebx.servlet.https.host=reverseDomain
#ebx.servlet.https.port=
ebx.servlet.https.path=ebx/
#ebx.servlet.https.ui.path=ebx-ui/
#ebx.servlet.https.authentication.path=ebx-authentication/
#################################################
## Web parameters (for external resources)
## if nothing is set, values are taken from servlet.
#################################################
#ebx.externalResources.useLocalUrl=false
#ebx.externalResources.http.host=
#ebx.externalResources.http.port=
#ebx.externalResources.http.path=
ebx.externalResources.http.useHttpsSettings=true
ebx.externalResources.https.host=reverseDomain
#ebx.externalResources.https.port=
ebx.externalResources.https.path=
注意:
リバースプロキシモードを使用する場合、
ebx-dataservices モジュールへの URL はリネージ管理パネルから構成する必要があります。指定された URL は、パスを /ebx-dataservices で終了する必要があることに注意してください。
セキュリティ構成
これらのパラメーターは、EBX® がユーザーをリダイレクトできる外部ページと、認証 Cookie に関するいくつかのオプションを構成するために使用されます。
# Custom login page URL.
# The login page is displayed when an unidentified user accesses EBX.
# If no url is specified, a built-in page will be displayed.
#ebx.security.loginPage.url=
# When using a custom login page, should a 'resume' parameter be appended to the URL?
# Default value is: true
#ebx.security.loginPage.appendResumeUrl=true
# Custom exit page URL.
# The exit page is displayed when a user exits EBX normally (when logging out for instance)
# and, if the 'exit error' page is not defined, when the user exits EBX because of an error.
# If no url is specified, a built-in page will be displayed.
#ebx.security.exitPage.url=
# When using a custom exit page, should a 'resume' parameter be appended to the URL?
# Default value is: true
#ebx.security.exitPage.appendResumeUrl=true
# Custom 'exit error' page URL.
# The 'exit error' page is displayed when a user exits EBX because of an error.
# If no url is specified, the exit page will be displayed.
#ebx.security.exitErrorPage.url=
# When using a custom 'exit error' page, should a 'resume' parameter be appended to the URL?
# Default value is: true
#ebx.security.exitErrorPage.appendResumeUrl=true
# Custom 'access denied' page URL.
# The 'access denied' page is displayed when an exception is thrown when authenticating a user.
# If no url is specified, a built-in page will be displayed.
#ebx.security.accessDeniedPage.url=
# Custom timeout page URL.
# The timeout page is displayed when a user accesses EBX with an outdated session.
# If no url is specified, the login page will be displayed.
#ebx.security.timeoutPage.url=
# List of authorized domains to redirect to.
# This is a list of comma-separated URLs which has as many items as 'ebx.security.exitRestrictions.httpsOnly'.
# For each item in this list, there should be a related item in 'ebx.security.exitRestrictions.httpsOnly'.
# Example: ebx.security.exitRestrictions.domains=my-domain.com,safe-domain.com,trusted-domain.com
#ebx.security.exitRestrictions.domains=
# For each domain declared in 'ebx.security.exitRestrictions.domains', indicates if only the https protocol is allowed.
# This is a list of comma-separated booleans which has as many items as 'ebx.security.exitRestrictions.domains'.
# For each item in this list, there should be a related item in 'ebx.security.exitRestrictions.domains'.
# Example: ebx.security.exitRestrictions.httpsOnly=true,false,false
#ebx.security.exitRestrictions.httpsOnly=
# Indicates if the authorization cookie should have the 'Secure' attribute.
# Accepted values are:
# - true
# - false
# - auto: depends on the of value of 'ebx.https.support' and the protocol of the incoming request
# Default value is: auto
#ebx.security.authorizationCookie.attribute.secure=auto
# Indicates the value of the 'SameSite' attribute of the authorization cookie.
# Accepted values are:
# - Strict
# - Lax
# - None
# Default value is: Strict
#ebx.security.authorizationCookie.attribute.sameSite=Strict
これらのパラメーターは、CSP 除外に追加するルールを追加するために使用されます。
# Raw value to add at the end of the 'script-src' CSP value.
# Example: ebx.security.csp.script-src=https://my-domain.com
#ebx.security.csp.script-src=
# Raw value to add at the end of the 'style-src' CSP value.
# Example: ebx.security.csp.style-src=https://my-domain.com
#ebx.security.csp.style-src=
# Raw value to add at the end of the 'img-src' CSP value.
# Example: ebx.security.csp.img-src=https://my-domain.com
#ebx.security.csp.img-src=
フェールオーバーの構成
これらのパラメーターは、フェールオーバーモードとアクティベーションキー、および
DEBUG モードでのハートビートロギングを構成するために使用されます。
以下も参照してください。:
#################################################
## Mode used to qualify the way in which a server accesses the repository.
## Possible values are: unique, failovermain, failoverstandby.
## Default value is: unique.
#################################################
#ebx.repository.ownership.mode=unique
## Activation key used in case of failover. The backup server must include this
## key in the HTTP request used to transfer exclusive ownership of the repository.
## The activation key must be an alphanumeric ASCII string longer than 8 characters.
#ebx.repository.ownership.activationkey=
## Specifies whether to hide heartbeat logging in DEBUG mode.
## Default value is true.
#ebx.repository.ownership.hideHeartBeatLogForDebug=true
EBX® リポジトリの調整
一部のオプションは、メモリ使用量を最適化するように設定できます。
プロパティは次のように構成されます。
#################################################
## Technical parameters for memory and performance tuning
#################################################
## Import commit threshold allows to specify the commit threshold
## exclusively for the archive import launched directly from Manager.
##
## For more details about the commit threshold,
## see the JavaDoc ProcedureContext.setCommitThreshold().
## Default value is 0.
ebx.manager.import.commit.threshold=100
以下も参照してください。:
高度なインデックス構成
起動時のインデックスロード
インデックスは、EBX® の起動時にロードして、初期テーブルアクセスを高速化できます。インデックスは、欠落している場合 (
open 再構築戦略)、またはインデックスが最新のモデルと一致しない場合 (update 再構築戦略) に再構築されます。
プロパティは次のように構成されます。
# load index at startup. set level to 1 to preload Reference dataspace, 2 to preload Reference dataspace and all it's direct
# children, 3 to preload Reference dataspace and all their children and grandchildren.
# Use higher values to go deeper in dataspace tree but this could be time-consuming.
ebx.index.loader.level=0
# Index load strategy
# open: opens the index as it is stored; the index cannot match the latest model
# update: rebuilds the index to match the latest model
# rebuild: always rebuilds the index. This option is only usable during boot and will block the boot until all indexes are rebuilt
ebx.index.loader.strategy=open
# Block the boot until all indexes are loaded
ebx.index.loader.waitOnBoot=false
# Include the technical dataspace in preload. Unset this only if something goes wrong during boot with loading the technical dataspace.
# This value has no effect if ebx.index.loader.level is set to less than 2
ebx.index.loader.includeTechnical=true
# Include / exclude a rule for index selection
# Each rule is a JSON object, or an array of JSON objects defining regular expressions on a dataspace, dataset, and table.
# Include rules are tested before exclude rules.
# Default rules for include are accept all. The exclude default rule is exclude nothing.
ebx.index.loader.include={"dataspace":".*","dataset":".*","table":".*"}
ebx.index.loader.exclude=
注意:
rebuild 戦略は、細心の注意を払って使用する必要があります。これは、起動時に選択された各インデックスの完全な再構築を強制し、すべての再構築が完了するまで待機します。このモードは、カスタマーサポートから指示された場合にのみ使用し、再起動後に open または update に戻す必要があります。
その他
データワークフローの有効化
このパラメーターは、データワークフローを有効にするかどうかを指定します。このパラメーターは、即時受容されません。値の変更のたびにサーバーを再起動する必要があります。
#################################################
## Workflow activation.
## Default is true.
#################################################
ebx.workflow.activation = true
ユーザータスクレガシーモードの無効化
このパラメーターは、レガシーモードでのユーザータスクの作成サービスをワークフローモデリングで提供するかどうかを指定します。デフォルト値は
false です。
詳細については、
UserTask.UserTaskMode.LEGACY_MODE を参照してください。
#################################################
## Disables legacy work item mode (default is false)
## Specify if the creation service of user task in legacy mode must be offered
## in workflow modeling.
#################################################
#ebx.manager.workflow.legacy.userTaskMode=true
階層プランビューの無効化
このパラメーターは、階層プランビューを非表示にするかどうかを指定します。デフォルト値は
true です。
#################################################
## Activate or deactivate Workflow hierarchy plan view
#################################################
ebx.manager.workflow.hierarchyPlanView.hidden=false
API によるワークフロー起動のための委任の有効化
このパラメーターは、API によるワークフロー起動の委任を有効にします。デフォルト値は
false です。これは、このパラメーターが有効化されていない限り、権限が常にチェックされることを意味します。
#################################################
## Activate delegation to launch workflows by API
#################################################
ebx.workflow.api.processLauncher.permissionCheckDelegated=true
ログプロシージャの開始
このパラメーターは、プロシージャ実行の開始をログに記録するかどうかを指定します。
#################################################
## Specifies whether transaction starts are logged. Default is false.
#################################################
ebx.logs.logTransactionStart = true
ログ検証の開始
このパラメーターは、データセット検証の開始をログに記録するかどうかを指定します。
#################################################
## Specifies whether validation starts are logged. Default is false.
#################################################
ebx.logs.logValidationStart = true
リクエストキャッシュの有効化
このパラメーターは、
リクエストの実行時にクエリエンジンで必要とされる内部のリクエストからクエリへの変換のためにキャッシュをアクティブにするかどうかを指定します。このキャッシュを有効にすると、特に複数回実行される場合に、特定の種類のリクエストのパフォーマンスが向上します。
# Activates the request cache, which can improve the performance of certain requests. Possible values are DISABLED,
# WITH_CHECK (ensures that a cached request executes the same query plan as its non-cached version, recommended),
# EXCEPTION (throws an exception if the query plan for a request differs from its non-cached version), and ENABLED.
# The default value is WITH_CHECK.
#ebx.cache.request.mode=WITH_CHECK
ログのリクエスト期間のしきい値
このパラメーターは、ログに記録される
リクエストおよびクエリの期間のしきい値をミリ秒単位で指定します。ログは、ログカテゴリ ebx.log4j.category.log.request のレベルが INFO 以下の場合に生成されます。レベルが DEBUG の場合、すべてのリクエストとクエリがログに記録されます。
#################################################
## Specifies in milliseconds the threshold of duration of Requests and Queries
## to be logged
## Default value is 1000 ms.
## If unset, the default value is used.
#################################################
#ebx.logs.request.durationThreshold=1000
ログのリクエスト反復のしきい値
このパラメーターは、
リクエストとクエリの 2 つのログ間の期間しきい値を超える遅延をミリ秒単位で指定します。この値が 0 より大きく、クエリ期間が期間しきい値を超えた場合、各ログの間でこの遅延以上になると、繰り返しログに記録されます。ログメッセージには期間が含まれているため、長いクエリ期間を追跡するのに役立ちます。
#################################################
## Specifies in milliseconds the delay between two log entries for Requests and
## Queries that goes beyond the threshold of duration. If this value is greater
## than 0, and the query duration goes beyond the threshold of duration, it will
## be logged again repeatedly with at least this delay between each log.
## Default value is 30000 ms.
#################################################
#ebx.logs.request.logAgainEvery=30000
ログのリクエスト最適化のしきい値
このパラメーターは、ログに記録される
リクエストおよびクエリの最適化フェーズのしきい値をミリ秒単位で指定します。ログは、ログカテゴリ ebx.log4j.category.log.request のレベルが INFO 以下の場合に生成されます。
#################################################
## Specifies in milliseconds the threshold of optimization of Requests and Queries
## to be logged. Default value is 1000 ms.
#################################################
#ebx.logs.request.optimizationThreshold=1000
リクエストログの SQL 表現
このパラメーターは、特定の
リクエストのログに、対応するリクエストの SQL 表現を含めるかどうかを指定します。この変換はパフォーマンスの面で負担が大きく、すべてのリクエストを SQL に変換できるわけではないことに注意してください。デフォルト値は false です。
#################################################
## Specifies if the logs of requests shall include the SQL representation.
## Default is false.
#################################################
#ebx.log4j.category.log.request.enableSQLConversion=false
外部キーラベルでテーブルを並べ替えるためのリクエストの最適化
このパラメーターは、クエリオプティマイザーが、並べ替え操作と結合操作の特定の組み合わせを、並べ替えられた方法で結合を実行する特殊な演算子に書き換えるかどうかを指定します。
#################################################
## Properties to activate/deactivate EnumerableSortedNestedLoopLeft/Right operators,
## which can improve the performance of requests sorted by foreign key labels.
## Default value is true.
#################################################
#ebx.query.sortedNestedLoopLeft.enabled=true
#ebx.query.sortedNestedLoopRight.enabled=true
展開サイトの識別
このパラメーターを使用すると、テクニカルログメールの送信先メールアドレスを指定できます。
#################################################
## Unique Site Name
## --> used by monitoring emails and by the repository
#################################################
ebx.site.name= name@domain.com
メイン構成の動的リロード
一部のパラメーターは、EBX® を再起動せずに動的にリロードできます。パラメーター
thisfile.checks.intervalInSeconds は、メイン構成ファイルの確認頻度を示します。
#################################################
### Checks if this file has been updated
### If value <= 0, no more checks will be done
#################################################
thisfile.checks.intervalInSeconds=1
開発モードでは、このパラメーターを 1 秒まで設定できます。変更の頻度が少ないと予想される実稼働システムでは、値を大きくするか、0 に設定してホットリロードを完全に無効にすることができます。
このプロパティは、モジュールが WAR として展開されている場合は、アプリケーションサーバーに依存するため、常にサポートされるとは限りません。
モジュールの展開解除宣言
アプリケーションサーバーの起動時に、展開済み Web アプリケーション / EBX® モジュールの初期化と EBX® リポジトリの初期化は非同期で実行されます。EBX® リポジトリを適切に初期化するには、少なくとも 1 つのデータセットで使用されるすべてのデータモデルをコンパイルする必要があります。したがって、EBX® は参照されるモジュールが登録されるまで際限なく待機することになります。
モジュールがデータモデルによって参照されているが、未展開 (または展開解除) の場合は、このモジュールを展開解除宣言し、待機ロックを解除して起動プロセスを続行する必要があります。
注意:
kernel ロギングカテゴリは、待機中のモジュールを示します。
注意:
展開解除宣言されたモジュールは、プロパティ
ebx.module.undeployedModules から削除されるまで、EBX® に登録できません。
注意:
未登録のモジュールに基づくデータモデルでは、「展開解除モジュール」のコンパイルエラーが発生します。
以下も参照してください。:
#################################################
## Comma-separated list of EBX® modules declared
## as undeployed.
## If a module is expected by the EBX® repository but is
## not deployed, it must be declared in this property.
## Caution:
## if the "thisfile.checks.intervalInSeconds" property is deactivated,
## a restart is mandatory, otherwise it will be hot-reloaded.
#################################################
ebx.module.undeployedModules=
モジュールのパブリックパスプレフィックス
EBX® モジュールのパブリックパスは、各モジュールの module.xml ファイルで宣言されます。次のプロパティを指定することで、module.xml のコンテンツを変更することなく、すべてのモジュールに対してコンテキストプレフィックスを宣言できます。
このプレフィックスは、コア、アドオン、特定モジュールを含むすべての EBX® モジュールに適用されます。
プロキシモードおよび/またはリバースプロキシモードが使用されている場合、
ebx.servlet.http[s].path および ebx.servlet.http[s].ui.path プロパティは、このモジュールのパブリックパスプレフィックスの設定を考慮に入れる必要があります。逆に、ebx.externalResources.http[s].path プロパティは、潜在的なプレフィックスの直前でパスを終了する必要があります。
#################################################
ebx.servlet.useLocalUrl=true
#ebx.servlet.http.host=
#ebx.servlet.http.port=
ebx.servlet.http.path=reverse-proxy/prefix/ebx/
ebx.servlet.http.ui.path=reverse-proxy/prefix/ebx-ui/
ebx.servlet.http.authentication.path=reverse-proxy/prefix/ebx-authentication/
#ebx.servlet.http.authentication.redirectToHttps=false
#ebx.servlet.http.useHttpsSettings=false
#ebx.servlet.https.host=
#ebx.servlet.https.port=
ebx.servlet.https.path=reverse-proxy/prefix/ebx/
ebx.servlet.https.ui.path=reverse-proxy/prefix/ebx-ui/
ebx.servlet.https.authentication.path=reverse-proxy/prefix/ebx-authentication/
#################################################
## Web parameters (for external resources)
## if nothing is set, values are taken from servlet.
#################################################
ebx.externalResources.useLocalUrl=true
#ebx.externalResources.http.host=
#ebx.externalResources.http.port=
ebx.externalResources.http.path=reverse-proxy/
#ebx.externalResources.http.useHttpsSettings=false
#ebx.externalResources.https.host=
#ebx.externalResources.https.port=
ebx.externalResources.https.path=reverse-proxy/
#################################################
## EBX® Module context path prefix
##
## If defined, applies to all EBX® modules public paths declared in
## any module.xml file (core, add-on and specific).
#################################################
ebx.module.publicPath.prefix=prefix/
詳細については、URL コンピューティングを参照してください。
EBX® 実行モード
このプロパティは、EBX® の実行方法を定義します。開発、統合、実稼働の 3 つの実行モードを使用できます。
開発モードで実行すると、開発ツールが EBX® でアクティブ化されるため、一部の機能に完全にアクセスできるようになり、より多くの技術情報が表示されます。
注意:
管理者は、使用するモードに関係なく、いつでもこの情報にアクセスできます。
開発モードでの実行時にアクセス可能な追加機能には、次のものがあります (非包括リスト)。
|
ドキュメントペイン
|
計算値の場合、Java クラス名が表示されます。ノードのパスへのアクセスを許可するボタンが表示されます。
|
|
コンパイル情報
|
モジュールとスキーマのコンパイル情報は、データセット検証レポートに表示されます。
|
|
Java バインディング
|
データセットのスキーマに 1 つ以上のバインディングが記述されている場合、Java バインディングの生成を利用できます。
|
|
Web コンポーネントリンクジェネレーター
|
Web コンポーネントリンクジェネレーターは、データセットとデータスペースで使用できます。
|
|
データモデルアシスタント
|
データモデルの構成と、サービス、ビジネスオブジェクトとルール、Java バインディング、ツールバー、および一部の高度なプロパティなどの追加オプション。
|
|
ワークフローモデリング
|
特定のスクリプトタスクを宣言します。
|
|
ログ
|
ログには、開発者向けの追加の技術情報が含まれています。たとえば、UI Bean の非列挙ノードでドロップダウンリストが定義されている場合、警告がログに書き込まれます。
|
|
製品ドキュメント
|
製品ドキュメントは、管理と開発の章を含む常に完全 (詳細) なドキュメントです。
|
#################################################
## Server Mode
## Value must be one of: development, integration, production
## Default is production.
#################################################
backend.mode=integration
注意:
統合モードと実稼働モードに違いはありません。
リソースフィルタリング
このプロパティを使用すると、リソースディレクトリのコンテンツ (リソースタイプノード、および使用可能なリソースの格納先ディレクトリを示す関連ファセット) 内の特定のファイルとディレクトリをフィルタリングできます。
#################################################
## list (separated by comma) of regexps excluding resource
## the regexp can be of type [pattern] or "m:[pattern]:".
## the list can be void
#################################################
ebx.resource.exclude=CVS/*
HTML ヘッダー
このプロパティを使用すると、HTML ページに追加の JavaScript ファイルを宣言できます。
#################################################
## HTML header properties
##
#################################################
## Specifies the javascript files to add in the HTML header.
##
## The first property, 'ebx.html.header.javascript', is a declaration of names, which will be used in the details properties.
## Example: ebx.html.header.javascript=example,other
##
## The details properties are formed as follow: 'ebx.html.header.javascript.[name].[property]'.
## Example: ebx.html.header.javascript.example.src=/my-module/www/common/my-script.js
##
## Detail property: 'src'.
## Contains the URL to the javascript file.
## Relative URLs are accepted, start by a "/".
## This property is mandatory.
## Example: ebx.html.header.javascript.example.src=/my-module/www/common/my-script.js
##
## Detail property: 'async'.
## Indicates if the associated javascript file should be loaded asynchronously.
## Accepted values: 'true', 'false'.
## This property is optional.
## Default value is 'false'.
## Example: ebx.html.header.javascript.example.async=true
##
## Full example:
## ebx.html.header.javascript=example,other
## ebx.html.header.javascript.example.src=/my-module/www/common/my-script.js
## ebx.html.header.javascript.example.async=true
## ebx.html.header.javascript.other.src=http://my-domain.com/other-script.js
#ebx.html.header.javascript=
検証レポートページ
検証レポートページには、重大度ごとに有限数の項目を表示できます。この数値は、このプロパティで調整できます。
#################################################
## Defines the maximum item displayed for each severity in the validation report page.
## Default value is 100.
#################################################
ebx.validation.report.maxItemDisplayed=200
以下も参照してください。:
検証レポートログ
このプロパティを使用すると、データセットまたはテーブルの検証時にログに表示する検証メッセージの数を指定できます。
#################################################
## Defines the maximum number of messages displayed in the logs.
## Default value is 100.
## When set to 0 or a negative value, the limit is not considered.
#################################################
ebx.validation.report.maxItemDisplayedInLogs=500
デフォルトでは、データセットまたはテーブルの検証の内容がログに記録されます。検証レポートのコンテンツのログ記録は、次のプロパティを使用して無効にすることができます。
#################################################
## Specifies whether the content of validation reports is logged when validating
## a dataset or a table.
## Default is true.
#################################################
ebx.validation.report.logContent=true
以下も参照してください。:
子データセットの検証モード
このプロパティは、子データセットを検証するアルゴリズムの動作に影響します。パフォーマンスにのみ影響します。結果として得られる検証レポートの内容は、プロパティから独立しています。
# Changes the way how a child dataset is validated. This affects only the performance of the validation,
# but not the content of the resulting validation report. In the FULL mode, the report of the tables
# will be cleared, then the tables will be validated as if performing an initial validation.
# In the DIFF mode, the algorithm calculates the differences since the last validation
# and processes them to perform the necessary updates on the validation report.
# Possible values are: FULL, DIFF.
# The default is DIFF.
#ebx.validation.childDataset.mode=DIFF
APV は無効な入力を DataContext に格納する
ユーザーが検証エラーのある値を入力した場合の APV の動作を指定します。true の場合、値は ValueContext に格納されます。false の場合、値は ValueContext に格納されません。以前の値が保持されます。デフォルト値は false です。
# Specifies the behavior of APV when the user enters a value that has validation errors.
# If true, the value will be stored in the ValueContext.
# If false, the value will not be stored in the ValueContext. The previous value will be kept.
# The default value is false.
#ebx.manager.apv.storeInvalidInputInDataContext=false