Using Oracle as the External Configuration Database

  • Last update: 2026-04-09
  • Overview

    In FanRuan applications, you (the admin) typically configure users, mount directories, assign permissions, and set scheduling plans. All the configuration is stored in a configuration database.

    In production environments, you can prepare an Oracle database to connect it with FanRuan applications for configuration storage. A stable external database ensures the reliable operation of FanRuan applications under high load.

    This document explains how to connect a FanRuan project to an Oracle database to store project configuration information:

    • You can prepare a tablespace in an Oracle database and tune parameters.

    • When deploying a new project or after deploying a project, you can connect the project to this configuration database.

    Preparing the Configuration Database

    You must prepare and deploy the Oracle database and tablespace by yourself.

    FanRuan does not provide detailed guidance on database deployment. Only essential requirements are specified. Refer to the official Oracle documentation for additional assistance.

    iconNote:
    If you lack database O&M expertise, select Deploy Mysql8 when deploying a new project via FineOps. This eliminates the need for manual deployment and tuning. 

    Database Version

    The following table lists FanRuan-tested environments.

    • Databases of earlier versions not mentioned are generally not supported or contain known issues; thus, they are not recommended.

    • You can test databases of higher versions that are not mentioned. If issues arise, premium customers can contact technical support. For details about how to contact technical support, see Technical Support Channel Introduction.

    Database Type
    Database VersionDescription
    Oracle

    Oracle Standalone
    10g (10.2), 10.2.0.1.0

    A manual driver upload is required.
    Therefore, connection is only supported after the project is deployed.

    Oracle Standalone:
    11g (11.0.2.1), 11g (11.0.2.4), 11.0.2.4, 11.2.0.2.0

    12c, 12c V12.2, 19c

    Oracle RAC:
    11g, 12c

    The driver is already built into the project.

    You can connect to the database when deploying a new project or after deployment.

    Server Configuration

    Configuration Type
    Minimum ConfigurationRecommended ConfigurationNotes
    Memory1 GB2 GB

    It refers to the memory allocated to the configuration database, not total server memory.

    A dedicated server for the configuration database is recommended. 

    If resources are limited, ensure that no content other than the FanRuan application is deployed on the server hosting the configuration database, and ensure sufficient memory is allocated to the configuration database.

    CPU4 cores8 cores/
    Network speed50 Mbps100 Mbps

    The configuration database, application, and other components should be on the same network segment to avoid network instability.

    Ensure network connectivity and accessible ports between the configuration database, application, and other components.

    FineDB-used space1 GB2 GB

    Adjust it based on usage.

    Allocate 1 to 2 times the recommended size of space.

    Disk space100 GB200 GB/
    Disk I/O speed50 MB/s100 MB/s/

    Creating a Tablespace

    Different FanRuan projects cannot share the same database tablespace as the configuration database. Otherwise, data corruption may occur.

    Create a new tablespace specifically for storing configuration data in the database.

    Do not store other data, such as business data or logs, in this tablespace.

    1. Create a tablespace and a corresponding user.

    Step
    Statement
    Example

    Create a user named FANRUAN with a password 123456 and default tablespace FINEDB:

    CREATE USER "FANRUAN" IDENTIFIED BY "123456" ACCOUNT UNLOCK DEFAULT TABLESPACE "FINEDB"
    Notes

    1. Username:

    • Creating a user is recommended but not required. You can also create a tablespace directly and assign it to an existing user.

    • For Oracle 12c, the username must start with C##; otherwise, it will not work.

    • Since the database schema is usually named after the user, you are advised to use only letters and numbers. Special characters are not recommended.

    2. Password: 

    • After the configuration database is successfully connected, do not change the database username or password. Otherwise, the project will fail to start.

    3. Tablespace name: 

    • You are advised to use an all-English tablespace name. The tablespace name supports only letters, numbers, underscores (_), and dots (.).

    2. Grant privileges.

    Step
    Statement
    ExampleGrant the FANRUAN user privileges on the tablespace FINEDB:
    GRANT "CONNECT","RESOURCE" TO "FANRUAN" ALTER USER "FANRUAN" QUOTA UNLIMITED ON "FINEDB"
    NotesThe user must at least have CREATE, DELETE, ALTER, UPDATE, SELECT, INSERT, and INDEX privileges.

    Preparing Configuration Database Information

    Prepare the following tablespace information for connection:

    Setting Item
    Description
    Database name

    Name of the tablespace created in the "Creating a Tablespace" section

    You are advised to use an all-English tablespace name. The tablespace name supports only letters, numbers, underscores (_), and dots (.).

    Host

    IP address of the database server

    The host name supports only letters, numbers, underscores (_), and dots (.).

    PortDatabase port on the server
    Username

    Database username

    1. The user must have CREATE, DELETE, ALTER, UPDATE, SELECT, INSERT, and INDEX privileges to support configuration table structure changes and configuration updates. 

    2. For Oracle 12c, the username must start with C##; otherwise, it will not work.

    3. Since the database schema is usually named after the user, you are advised to use only letters and numbers. Special characters are not recommended.

    Password

    Database user password

    After the configuration database is successfully connected, do not change the username or password. Otherwise, the project will fail to start.

    SchemaName of the prepared database user (same as the username)

    Connecting the Project to the Configuration Database

    Choose the appropriate connection method based on the actual conditions.

    Connection During New Project Deployment

    In the Project Setting step during new project deployment, you can connect to a self-prepared Oracle database as the configuration database.

    iconNote:

    1. You must ensure the database tablespace is empty; otherwise, the connection will fail.

    2. In this case, only Oracle 11g and 12c are supported. Oracle 10g is not supported.

    1. Select Connect to Existing External Database in External Configuration Database.

    2. Fill in the external configuration database information:

    • Database Type: Select oracle.

    • Driver: No change is required. Keep oracle.jdbc.driver.OracleDriver.

    • Database NameHostPortUsername, and Password: Enter the information prepared in the "Preparing the Configuration Database" section.

    3. Set Schema:

    • After filling in all the above information correctly, click Click to Connect Database in the drop-down list of Schema. The system will automatically connect to the database and read the schema.

    • Prefer the schema that matches the database username.

    4. Click Test Connection. The message "Connected successfully" indicates a normal connection

    Connection via FineOps Cluster Management

    You can configure a self-prepared Oracle database as the configuration database in FineOps’s Cluster Management.

    Uploading a Driver for the FanRuan Application (Optional)

    iconNote:

    1. If you are connecting to Oracle 11g or 12c, skip this section. The driver is already built into the project.

    2. If you are connecting to Oracle 10g, you must follow this section; otherwise, the connection will fail.

    1. Navigate to the Oracle official website and download ojdbc14.jarOracle JDBC Download.

    2. Upload the driver to the project. For details, see Driver Management.

    Confirming the FineOps Version

    This document provides instructions based on FineOps of the latest version. Ensure FineOps is of V2.31.0 or later versions.

    • For projects requiring no configuration data migration, FineOps of V2.30.0 and earlier versions cannot restart projects automatically.

    • For multi-application projects, FineOps of V2.29.0 and earlier versions require ensuring only one application node is active during configuration service connection or migration.

    For details, see Extranet-Based FineOps Upgrade and Intranet-Based FineOps Upgrade.

    Configuring the External Configuration Database

    1. Log in to FineOps as the admin. Select the target project, choose Maintenance > Cluster Management, and configure External Configuration Database.

    2. Set Database Type to Oracle.

    3. Select a driver:

    Database VersionDescription
    11g, 12cNo change is required. Keep oracle.jdbc.driver.OracleDriver.
    10gSelect the driver name you set when uploading ojdbc14.jar in Driver Management.

    4. Database NameHostPortUsernamePassword: Enter the information prepared in the "Preparing the Configuration Database" section.

    5. Set Schema:

    • After filling in all the above information correctly, click Click to Connect Database in the drop-down list of Schema. The system will automatically connect to the database and read the schema.

    • Prefer the schema that matches the database username.

    6. Database Connection URL: You can manually edit it. Multiple formats are supported. Select one based on actual conditions.

    Type
    Format
    Oracle standalonejdbc:oracle:thin:@<Host IP address>:<Port number>:<SID>
    Oracle RACjdbc:oracle:thin:@//<Host IP address>:<Port number>/<Service name>
    Oracle RACjdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=First node address)(PORT=Port number))(ADDRESS=(PROTOCOL=TCP)(HOST=Second node address)(PORT=Port number)))(LOAD_BALANCE=yes)(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=Service name)))

    7. Choose whether to tick Migrate Data to Database to Be Enabled:

    Scenario
    New Oracle Configuration Database Status
    Use the current project's existing configuration.

    1. Migrate Data to Database to Be Enabled must be ticked.

    2. After a successful connection, the existing configuration data of the project will be migrated to the tablespace.

    3. Any existing data in the new Oracle tablespace will be cleared and cannot be recovered.

    Use the configuration from another project. (For example, copy the production environment configuration to a test environment.)

    1. Upload the prepared configuration data to the new Oracle tablespace.

    Ensure the JAR package version of the source project exactly matches the JAR package version of the current project

    2. Do not tick Migrate Data to Database to Be Enabled

    3. After a successful connection, the project will use the data in the tablespace as its configuration. 

    4. Original connection information will be backed up to the db.properties.bak file in the config directory of the project

    5. Historical configuration cache exists in the project. Restart the project after a successful configuration database switchover to clear the cached configuration.

    8. Click Enable Database.

    Restarting the Project (with Migrate Data to Database to Be Enabled Unticked)

    If Migrate Data to Database to Be Enabled is unticked, the historical configuration cache will remain in the project after the configuration database switchover. You must restart the project to clear the cache.

    • FineOps-deployed projects: FineOps automatically restarts the project after a successful configuration database switchover.

    • Projects not deployed via FineOps: Manually restart the project after the switchover. For details, see Closing or Restarting the FineBI Project.

    Connection via System Management

    You can configure a self-prepared Oracle database as the configuration database under System Management > System Setting > General of the FanRuan application.

    Uploading the Driver (Optional)

    iconNote:

    If you are connecting to Oracle 11g or 12c, skip this section. The driver is already built into the project.

    If you are connecting to Oracle 10g, you must follow this section; otherwise, the connection will fail.

    1. Navigate to the Oracle official website and download ojdbc14.jarOracle JDBC Download.

    2. Upload the driver to the project. For details, see Driver Management.

    Ensuring a Single Active Application (Required for Multi-application Projects)

    For multi-application projects, ensure only one application node is active during configuration service connection or migration.

    Log in to FineOps as the admin. Select the target project and choose Maintenance > Component Management. Check if multiple bi-web/fr/fdl containers are active.

    If multiple containers exist, click the  icon of each container to stop other containers, leaving only one in active status.

    iconNote:
    For projects not deployed via FineOps, stop other main applications by referring to Closing or Restarting the FineBI Project and keep only one active.

    Configuring the External Configuration Database

    1. Log in to the FanRuan application as the admin. Choose System Management > System Setting > General

    2. Locate External Database and configure it.

    3. Set Database Type to Oracle.

    4. Select a driver:

    Database VersionDescription
    11g, 12cNo change is required. Keep oracle.jdbc.driver.OracleDriver.
    10gSelect the driver name you set when uploading ojdbc14.jar in Driver Management.

    5. Database NameHostPortUsernamePassword: Enter the information prepared in the "Preparing the Configuration Database" section.

    6. Set Schema:

    • After filling in all the above information correctly, click Click to Connect Database in the drop-down list of Schema. The system will automatically connect to the database and read the schema.

    • Prefer the schema that matches the database username.

    6. Database Connection URL: You can manually edit it. Multiple formats are supported. Select one based on actual conditions.

    Type
    Format
    Oracle standalonejdbc:oracle:thin:@<Host IP address>:<Port number>:<SID>
    Oracle RACjdbc:oracle:thin:@//<Host IP address>:<Port number>/<Service name>
    Oracle RACjdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=First node address)(PORT=Port number))(ADDRESS=(PROTOCOL=TCP)(HOST=Second node address)(PORT=Port number)))(LOAD_BALANCE=yes)(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=Service name)))

    8. Choose whether to tick Migrate Data to Database to Be Enabled:

    Scenario
    New Oracle Configuration Database Status
    Use the current project's existing configuration.

    1. Migrate Data to Database to Be Enabled must be ticked.

    2. After a successful connection, the existing configuration data of the project will be migrated to the tablespace.

    3. Any existing data in the new Oracle tablespace will be cleared and cannot be recovered.

    Use the configuration from another project. (For example, copy the production environment configuration to a test environment.)

    1. Upload the prepared configuration data to the new Oracle tablespace.

    Ensure the JAR package version of the source project exactly matches the JAR package version of the current project

    2. Do not tick Migrate Data to Database to Be Enabled

    3. After a successful connection, the project will use the data in the tablespace as its configuration. 

    4. Original connection information will be backed up to the db.properties.bak file in the config directory of the project

    5. Historical configuration cache exists in the project. Restart the project after a successful configuration database switchover to clear the cached configuration.

    8. Click Enable New DatabaseThe message "Migrated successfully" indicates a normal connection.

    Ensuring Multi-application Configuration Synchronization (Required for Multi-application Projects)

    1. Copy the db.properties file.

    Navigate to the server hosting the single active bi-web/fr/fdl container and copy the db.properties file in the component mounting path /config.

    Paste the file to the same location on all other bi-web/fr/fdl container servers.

    iconNote:
    For projects not deployed via FineOps, copy db.properties from /webroot/WEB-INF/embed in the single active application directory to the same location in all other application directories.


    2. Stop all applications.

    Log in to FineOps as the admin and choose Maintenance > Component Management.

    Click Stop on all FineBI - Application Node/FineReport/FineDataLink components. Ensure all bi-web/fr/fdl containers are in the exited status.

    iconNote:
    For projects not deployed via FineOps, stop the single active application by referring to Closing or Restarting the FineBI Project.

    3. Restart all applications.

    Click Start on all FineBI - Application Node/FineReport/FineDataLink components under Maintenance > Component Management. Ensure all bi-web/fr/fdl containers are in the running status.

    iconNote:
    For projects not deployed via FineOps, start all main applications in the cluster one by one by referring to Closing or Restarting the FineBI Project.

    Attachment List


    Theme: Project Management
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy