Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

OSM Database Tools

Using the Upgrade Database Tool

  • Last UpdatedSep 10, 2024
  • 5 minute read

Upgrade OSM DB

This database tool can perform a set of operations to upgrade an OSM database.

  • It is not necessary to do all steps at same time. This means for example that when a database has been upgraded and User privileges operation should be performed a second time, then it is possible to skip steps that are not necessary by using Skip step button.

  • Check boxes are not selectable but are used to indicate which operations/steps that have been performed.

  • Button in lower right corner will change its name according to different steps on right side of window.

Set the Working folder

It is required to set Working folder before performing any steps. This is the folder that the tool will look in for create or upgrade scripts.

Working folder is the top-level folder where the scripts reside that will be used by OSM Database Tools.

Select the version number of OSM Database as being created or upgraded.

Set the working folder

  1. Select the Browse (...) button and then navigate to the folder for correct database version.

  2. Click OK.

Using the tool without upgrading

If the entered version number is equal to current version number, then no upgrade is taking place, just reapplying some steps.

Only the following choices will be accessible:

  • Load program units

  • Run OSM privileges

  • Load translation

    Steps

The following steps are possible.

Step 1. Connect to OSM database

This step is mandatory since any of the other steps require a database connection.

The user name is preset to cow_owner and cannot be changed.

  1. Enter Oracle SID, user password, host name, and port number. You can view the password in clear text by clicking the eye icon.

  2. Select Connect to establish the connection.

    After the connection is established, the upgrade version number will be verified by tool. If there is an error, the tool window will be closed.

    Step 2. Load system privileges

    This step will load system privileges into database. These privileges are required for database user cow_owner.

    • You must enter the password for database user sys to perform this step of loading system privileges.

    • You can skip this step, but then system privileges will not be loaded. However, you can still load standard privileges in step 7.

      If you are upgrading between major versions, then you should run system privileges. However, if you are just upgrading a service pack or a patch, then you don't need to run system privileges. If you do not have the password for sys and are upgrading between minor versions, you can skip this step.

    Step 3. Upgrade database objects (part 1)

    These steps will upgrade OSM database with changes and add new objects.

    Objects that are upgraded or created will be tables, indexes, and constraints.

    Data can also be changed, moved, or deleted.

    Database will be set in upgrade mode during these steps.

    Pre-upgrade scripts

    If selected database version has a pre-upgrade script, you will be given the choice if tool should perform pre-upgrade script before starting on part 1.

    We recommend performing the pre-upgrade script, but it only needs to performed once per upgrade.

    • A pre-upgrade script is a script that should be performed before actual upgrade of database is started.

    • When pre-upgrade script is finished, then either upgrade can continue or upgrade should be postponed if the database version requires additional configuration before the upgrade can continue.

    • If upgrade scripts require a certain version of OSM Database Tools, then the validation of scripts will fail if the version of OSM Database Tools is not correct.

    • OSM Database Tools must be equal to the required version or a higher version.

    Upgrade part 1

    Before Upgrade part 1 scripts are to be performed, the application will ask if all jobs regarding OSM should be stopped.

    • If you choose to stop OSM jobs, then after the last step is finished you will be given the option to restart OSM jobs.

    • It is not necessary to start jobs between each upgrade if OSM is to be upgraded several times.

    Step 4. Load OSM program units

    Note This operation requires access to PowerShell execution.

    This step will load all OSM program units into the database. Program units are packages, triggers, and object types. In addition, some standard data will be inserted to some tables.

    Database will be set in upgrade mode during this step.

    Step 5. Upgrade database objects (part 2)

    This step finalizes the data changes that were made as part of Upgrade database objects (part 1).

    Step 6. Upgrade database objects (part 3)

    Part 3 is an optional step that is enabled only if the database version to be upgraded has scripts for part 3. If no part 3 scripts exist, then the check box for this step will be disabled.

    This step can consist of several database scripts. Each script will be performed independent of other scripts. Part 3 will upgrade the OSM database with changes. Data can be changed, moved, or deleted.

    Database will be set in upgrade mode during this step.

    Step 7. Run OSM standard privileges

    This step will run the necessary scripts for adding/creating standard privileges that are required for database users cow_owner, cow_read, and cow_user.

    You will be required to enter the password for database users cow_read and cow_user.

    The step will ask if standard/default password for database users should be applied.

    Step 8. Load translation

    This step will load translation data into OSM database. Translations are for OSM database messages and notifications.

    This step is only enabled for upgrading to a major or minor release. It is not available for service pack or patches. For example, the version number will be X.Y.0.0.

    Language

    You will be asked which language to use for messages that come from the OSM database.

    • When uploading ENG (English) language, then all other languages will be deleted.

    • However, after uploading English, you can choose to upload other supported languages.

    In This Topic
    TitleResults for “How to create a CRG?”Also Available in