Upgrading the Access Management database

If you have Access Management installed as a part of your implementation, upgrade your existing Oracle or Microsoft SQL Server database by running a PowerShell script.

Before you begin

To upgrade the Access Management database itself, you need details of DBA and user credentials and the name of the database.

To run PowerShell database scripts for databases on the Content Manager side, you require a machine that meets the following requirements:
PowerShell
You require Microsoft Windows PowerShell 5.1. You can download Microsoft Windows Management Framework 5.1, which includes Microsoft Windows PowerShell 5.1, from this location: http://aka.ms/wmf5download
Operating system
You require an operating system that supports both the required PowerShell software and any software for the database you intend to install. As a general rule, ensure that the latest (security) updates are installed on your operating system.
Database client software
For Oracle databases, you require both of the following:
  • Oracle Services for Microsoft Transaction Server (ORAMTS)
  • Oracle Data Provider for .NET (ODP.NET)
For maintenance, configuration and debugging purposes, RWS recommends that you also install the Oracle SQL Developer PL/SQL IDE (or SQL*Plus) and Oracle Net.
Environment variables
For Oracle databases where you have defined a Net Service Name for each database in a tnsnames.ora file, you must also have defined a TNS_ADMIN environment variable. Set it to the directory where tnsnames.ora resides.
Microsoft .NET Framework
You require a .NET Framework version. The one to use depends on your Windows Server operating system version:
Security
You need to be logged in as a user with sufficient security clearance. For example, to run a script that installs a database, you must be logged in as a user with rights to create that database.

Procedure

  1. Close all connections to your database server.
  2. If you have not done so already, make a back-up of your database for safety reasons.
  3. On a system that meets the prerequisites for database installation and upgrade scripts, open PowerShell.
  4. In PowerShell, depending on your database navigate to one of the following folders on the installation media:
    • For a Microsoft SQL Server, AWS RDS-MSSQL or Microsoft Azure database, navigate to Database\MSSQL\
    • For an Oracle database, navigate to Database\Oracle\
  5. For a Microsoft SQL Server database, you can add an -IntegratedSecurity switch to let the script know that you want to use the current Windows account credentials to access the database, rather than specifying a database username and password.
  6. For Oracle databases, specify a host, port, service name and other connection information for the PowerShell script, either before or while running the script:
    • Before you run the script, you can define a variable in PowerShell, let's say $MyDatabaseServer, and set it to your connection string. When you invoke the script, you then append the string -DatabaseServer $MyDatabaseServer to the PowerShell command.
    • Alternatively, you can just invoke the script as is, and while you run the script, PowerShell prompts you for a value for Net Service, and you can then enter one of the following:
      • Enter the Net Service Name for this database if you have defined a Net Service Name in a tnsnames.ora file and specified the location of that file in a TNS_ADMIN environment variable.
      • Enter the string %manual% to let the script prompt you for the following: Host name, Port and Service name.
      • Enter the actual connection string directly on a single line if you have more to provide than just a host, port and service name. For example:
        (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = myhost)(PORT = 1521))(CONNECT_DATA = (SERVICE_NAME = ora)))
  7. Type the following command to upgrade your Access Management database:
    & '.\Upgrade Access Management database.ps1'
  8. Follow the instructions in the PowerShell console to upgrade the database.

What to do next

If you encounter problems during the upgrade, restore your backup and try again. If your second attempt fails as well, consult RWS Customer Support for assistance. Do not attempt to fix the database.