Environment Settings

About the wildcard in LIKE expressions
Starting from 11.2.0.3.0, the feature of the wildcard in LIKE expression has changed.
Since then, full Width ％ and ＿ are not wildcard anymore, they will be perceived as normal character.
To solve the compatibility issue for older versions due to this changes, we provided a escapeFullwidthWildcard flag in OracleRdbAdapter.
The default value is false (as 11.2.0.3.0 or higher has no such problem).
Say, if you are using 11.2.0.2.0, then you should set this flag to true.

<service>
  <interface>org.iplass.mtp.impl.rdb.adapter.RdbAdapterService</interface>
  <property name="adapter" class="org.iplass.mtp.impl.rdb.oracle.OracleRdbAdapter">
    <property name="escapeFullwidthWildcard" value="true" />
  </property>
</service>

Storage Engine: InnoDB, which require the File Format: Barracuda(with innodb_large_prefix)

Pleas use [utf8mb4] as the standard character set.

Disable the query cache
When query cache is enabled, the table will be locked when writing in. Updating with time consuming tasks may affect the process form other sessions. So it is necessary to disable query cache.

[mysqld]
query_cache_size=0

Set the storage destination for LOB data
For MySQL, it is recommended to store LOB data outside RDB. LOB can be stored in the file system, or in the AWS S3 storages. Then it is necessary to change the storage destination, please refer to the part of LOB Storage Destination.

Using GTID
To use GTID for group replications, the configuration about temporary table is necessary.
Under the standard of iPLAss, the temporary tables are created and deleted inside the transactions. However, in the case of GTID, it is impossible to create or delete temporary tables inside the transaction. Therefore, iPLAss provides the options to perform the creation and deletion of temporary tables outside the transactions, or on the data source side.

<service>
  <interfaceName>org.iplass.mtp.impl.rdb.adapter.RdbAdapterService</interfaceName>
  <property name="adapter" className="org.iplass.mtp.impl.rdb.mysql.MysqlRdbAdaptor">
    <property name="localTemporaryTableManageOutsideTransaction" value="true" />
  </property>
</service>

<service>
  <interfaceName>org.iplass.mtp.impl.rdb.adapter.RdbAdapterService</interfaceName>
  <property name="adapter" className="org.iplass.mtp.impl.rdb.mysql.MysqlRdbAdaptor">
    <property name="localTemporaryTableCreatedByDataSource" value="true" />
  </property>
</service>

CREATE TEMPORARY TABLE `obj_store_tmp` (`obj_id` VARCHAR(64) NOT NULL, `obj_ver` BIGINT(10) DEFAULT 0 NOT NULL) ENGINE = MEMORY;

Settings of internal temporary table
Starting from MySQL5.7, the storage engine for the internal temporary table is by defaultInnoDB. For this reason, when using internal temporary tables, there could be errors because of exceeding size.
This issue can be avoided by switching the storage engine to MyISAM.

[mysqld]
internal_tmp_disk_storage_engine=MyISAM

Importing Timezone Data
It is necessary to import timezone data for the system. For more about importing the timezone, please refer to the MySQL timezone Download Site.

specifying the timezone
Connector/J 8.0 or higher require this timezone settings.
For Windows environment, the system timezone is not employed by MySQL, so it is mandatory to specify the timezone for MySQL.
For Linux, the system timezone can be utilized by MySQL, therefore there is no need to specify the timezone except changing to a different timezone.

Settings to support window functions
For MySQL8.0 or higher version, MySQL can use the native window function. In order to utilize MySQL native Window function feature, the following settings are required.

<service>
  <interface>org.iplass.mtp.impl.rdb.adapter.RdbAdapterService</interface>
  <property name="adapter" class="org.iplass.mtp.impl.rdb.mysql.MysqlRdbAdaptor">
    <property name="supportWindowFunction" value="true" />
  </property>
</service>

<service>
  <interface>org.iplass.mtp.impl.datastore.StoreService</interface>
  <property name="dataStore" class="org.iplass.mtp.impl.datastore.grdb.EnterpriseGRdbDataStore">
    <property name="enableWindowFunctionEmulation" value="true" />
  </property>
</service>

Settings for using decimal places
When using the Decimal type as the property type of Entity or the DIV operator in EQL, set the MySQL system variable div_precision_increment to the fifth decimal place.
Even if the Decimal type does not use the DIV operator, it is necessary to set div_precision_increment since iPLAss automatically performs DIV to adjust the number of digits internally.

Settings of LOB data storage destination
For PostgreSQL, it is recommended to store the LOB data outside the RDB system. LOB data can be stored in the file system, or in the AWS S3 storages. To do so, the storage destination should be changed, please refer to the part of LOB Storage Destination.

Settings of connection pool
In order to config about connection pool, please configure the following items in mtp-service-config.xml.

<service>
  <interface>org.iplass.mtp.impl.rdb.connection.ConnectionFactory</interface>
  <class>org.iplass.mtp.impl.rdb.connection.DataSourceConnectionFactory</class>
  <property name="dataSourceName" value="java:comp/env/yourDataSource" />
</service>

Recommended value for maximum connection pool size
To avoid deadlocks in the connection pool, it is recommended to set the maximum pool size to at least the following value.

(Tomcat's maximum number of threads) × (Maximum number of connections allocated per thread - 1) + 1 + Number of connections allocated to non-Tomcat threads (such as asynchronous commands)

(Tomcat's maximum number of threads) + 1 + Number of connections allocated to non-Tomcat threads (such as asynchronous commands)

<service>
    <interface>org.iplass.mtp.impl.rdb.connection.ConnectionFactory</interface>
    <class>org.iplass.mtp.impl.rdb.connection.DataSourceConnectionFactory</class>
    <property name="dataSource" class="com.zaxxer.hikari.HikariDataSource">
        <property name="jdbcUrl" value="jdbc:mysql://server:3306/mtdb" />
        <property name="username" value="user" />
        <property name="password" value="pass" />
        <property name="maximumPoolSize" value="100" />
        <property name="minimumIdle" value="10" />
    </property>
</service>

Bypass setting towards JavaServlet environment of web client information
This setting is to let web client to bypass the JavaServlet environment, when there is Proxy such as HTTP server at the frontal end of AP Server.

Root path settings for static contents
If you want to map WebApplicaton name (=war name) into another name by setting the proxy server such as Apache, then this root path should also be changed. If not set, servletContextPath will be used as the root path for static content.

<service>
  <interface>org.iplass.mtp.impl.web.WebFrontendService</interface>
  <class>org.iplass.mtp.impl.web.WebFrontendService</class>
  <property name="staticContentPath" value="/static" />
</service>

Temporary storage destination when uploading files
The place to store the temporary objects when uploading files can be specified.

<service>
  <interface>org.iplass.mtp.impl.web.WebFrontendService</interface>
  <class>org.iplass.mtp.impl.web.WebFrontendService</class>
  <property name="tempFileDir" value="/tmp" />
</service>

Size limit for upload files
It is possible to restrict the size limit for the files to be uploaded.

<service>
  <interface>org.iplass.mtp.impl.web.WebFrontendService</interface>
  <class>org.iplass.mtp.impl.web.WebFrontendService</class>
  <property name="maxUploadFileSize" value="10000" />
</service>

Magic byte check for upload file
If you want to register the file without checking the magic byte (whether the file extension matches the file contents), you can set the following to false.
(Depending on how the file is created, this magic byte check may rise error even if the file is correct.)

<service>
  <interface>org.iplass.mtp.impl.web.WebFrontendService</interface>
  <class>org.iplass.mtp.impl.web.WebFrontendService</class>
  <property name="isExecMagicByteCheck" value="false" />
</service>

Settings of LOB Storage Destination
The data for Binary type and LongText type can be stored either in files, in RDB(as binary data such as BLOB), or in AWS S3 storage.
To change the method to store the data, please do the following configurations.

<service>
  <interface>org.iplass.mtp.impl.lob.LobStoreService</interface>
  <property name="binaryStore" class="org.iplass.mtp.impl.lob.lobstore.file.FileLobStore">
    <property name="rootDir" value="D:\tmp\fileLobStore" />
  </property>
  <property name="longTextStore" class="org.iplass.mtp.impl.lob.lobstore.rdb.RdbLobStore" />
</service>

<service>
  <interface>org.iplass.mtp.impl.lob.LobStoreService</interface>
  <property name="binaryStore" class="org.iplass.mtp.impl.aws.lobstore.s3.S3LobStore">
    <property name="region" value="ap-northeast-1" />
    <property name="endpoint" value="s3.ap-northeast-1.amazonaws.com" />
    <property name="bucketName" value="yourBucketName" />
  </property>
  <property name="longTextStore" class="org.iplass.mtp.impl.lob.lobstore.rdb.RdbLobStore" />
</service>

Settings when AP server was made redundant
To make the AP server redundant, it is necessary to configure iPLAss in addition to the cluster setting on the AP server. iPLAss caches and stores metadata etc. in the memory of the AP server. Therefore it is necessary to share the cached object and make sure they are synchronized over all clusters.

If it is needed to set X-Frame-Options header, please set it to [SAMEORIGIN] directive
Since iPLAss uses iframe, it should be [SAMEORIGIN] directive when setting the X-Frame-Options header .

Adding the Dependency Library
Based on the wanted features, please uncomment the commands in build.gradle to add dependency libraries.

Copying the Dependency Library
Please run the Gradle task:"copyRuntimeLibs" to copy the necessary libraries to the [lib] directory.

gradlew copyRuntimeLibs

Settings of Batch Based DB Connections
It is necessary to configure DB to use batches.

<service>
  <interface>org.iplass.mtp.impl.rdb.connection.ConnectionFactory</interface>
  <class>org.iplass.mtp.impl.rdb.connection.DriverManagerConnectionFactory</class>
  <property name="url" value="XXXXXXXXXX" />
  <property name="user" value="XXXXX" />
  <property name="password" value="XXXXX" />
  <property name="driver" value="XXXXXXXX" />
</service>

Configure tool_env.sh or tool_env.bat
It is necessary to modify the following variables from tool_env.sh or tool_env.bat.