Manually Upgrading the Civic Platform Database

This section provides instructions to manually upgrade the Civic Platform database if you did not choose to have the Civic Platform installer automatically upgrade the database (see Managing a Civic Platform Configuration or Configuring the Application Server Database).

Topics

Manually Upgrading the Database

Follow the instruction provided here to manually upgrade an existing 7.1.0 Civic Platform database (or later) to the latest version. If required, upgrade Civic Platform databases earlier than 7.1.0 to 7.1.0 before following this procedure. Refer to the 7.1.0 Accela Automation DBUpdate.pdf document for information on updating Civic Platform databases earlier than 7.1.0 to 7.1.0.

The database update installer extracts SQL script files to the host, sets up batch files to run the SQL scripts, and invokes the scripts to update the database schema or the table data on the specified database. At the end of the upgrade, you can automatically run the database checking scripts and upgrading scripts, or exit the installation and run the scripts manually.

You must install scripts from all previous releases. Refer to the Civic Platform DB Update.pdf, that is applicable to previous releases, to identify other required scripts for your installation.

To manually update the database:

  1. If required, install Civic Platform 19.1.0 (see Installing a Base Civic Platform).

  2. Download the installer to the host from which you want to run the installation. The installer file name is AA_DbUpdate_<release version>_<build_number>.exe. For example, AA_Db_Update_19.1.0_190421.exe.

  3. Run the installer.

  4. Click Next on the Welcome screen.

  5. Read and accept the license agreement by clicking Next.

  6. Select the directory to copy the database update files to. (The default is C:\Accela\730DbUpdate.)

  7. Select the database type you are using (Oracle or MS SQL Server).

  8. Click Yes or No in the pop-up window, “If you are upgrading a multilingual database?”

  9. Follow the appropriate steps for your setup:

    • If you select Oracle, enter the following information:

      1. User is the Oracle user with privileges to do database updates.

      2. Password is the password for the previous user.

      3. TNSname is the TNS name for the database that you want to upgrade.

      4. Click Next after you enter all the information.

    • If you select MS SQL Server, enter the following information:

      1. DB Server is the server that the database is running on. Enter the DB Server information in any of the following formats:

        IP,Port

        ServerName,Port

        IP\DBInstanceName

        ServerName\DBInstanceName

        ServerIP\DBInstanceName, Port

        ServerName\DBInstanceName, Port

      2. Click Next after you enter the information.

      3. User is the MS SQL user with privileges to do database updates.

      4. Password is the password for the previous user.

      5. DB name is the name for the database that you want to upgrade.

      6. Click Next after you enter all the information.

  10. Click Install to copy the files to your host or Back to review your previous settings.

  11. Run the scripts automatically or manually.

    • Run the scripts automatically by selecting the check boxes to run the database health check scripts after the database upgrade script is successful.

      or,

    • Run the scripts manually by de-selecting the check boxes to run the database upgrade scripts.

      The 19.1.0 scripts are located in the following directories.

      Oracle:
       <installdir>\installSQLUtility\sql\19.1.0\oracle\v360
      MS Sql: 
      <installdir>\installSQLUtility\sql\19.1.0\mssql\v360

      Each script contains a release number and sequence number in its name. For example, 19.1.0_3_xxx.sql. The sequence number, 3 in this example, determines the order in which to run the scripts. After the script successfully runs, do not run it again. If a script aborts, until you resolve the problem with the aborted script and run the script successfully, the next script does not run. You can execute this set of scripts by running a BAT file in the version folder, for example, <installdir>\installSQLUtility\sql\19.1.0\run_aa900_oracle.bat.

      Note:

      The scripts create log file in the following directories.

      Oracle: 
      <installdir>\installSQLUtility
      \log
      MS Sql: 
      <installdir>\installSQLUtility\log

      The results of executing these scripts are in the UPGRADE_SCRIPTS database table.

  12. After completing the upgrade, install the latest Civic Platform application code (see Installing the Latest Application Code).

    Note:

    You can run the database installer in remove mode. However, this only removes the SQL script files extracted to your local host. Remove mode does not roll back changes made to the database.

Reviewing Supporting Files

In each version folder, there are two readme text files which describe how to run the scripts manually. For example, the following two files are the readme files in the 19.1.0 version folder:

<installdir>\installSQLUtility\sql\19.1.0\readme_900_oracle.txt 
<installdir>\installSQLUtility\sql\19.1.0\readme_900_mssql.txt

For each version of the database, you can run BAT files to run all SQL script files manually. Before running a BAT file, you need to verify that the correct user/password and database information is in the batch file for your database type. You can execute a set of scripts for the database by running one of the following BAT files in the corresponding version folder.

<installdir>\installSQLUtility\sql\19.1.0\run_aa900_oracle.bat 
<installdir>\installSQLUtility\sql\19.1.0\run_aa900_mssql.bat 
<installdir>\installSQLUtility\sql\19.1.0-i18n\run_aa900_i18n_oracle.bat 
<installdir>\installSQLUtility\sql\19.1.0-i18n\run_aa900_i18n_mssql.bat