Knowledge Base | Upgrading SaveToDB Framework 7 to SaveToDB Framework 8/9

Concept

SaveToDB 8 introduces the redesigned SaveToDB Framework 8.

It has a more robust structure with fewer configuration objects:

  • xls.objects
  • xls.handlers
  • xls.translations
  • xls.formats
  • xls.workbooks
  • xls.queries

SaveToDB 9 introduces the SaveToDB Framework 9, an enhanced version of the SaveToDB Framework 8.

We recommend using SaveToDB Framework 8/9 for new applications depending on your SaveToDB version.

SaveToDB 8.0 or higher has better support for previous versions of the SaveToDB Framework in the Application Installer wizard.

So, you can continue to use previous SaveToDB Framework versions as well.

However, you can upgrade SaveToDB Framework 7 to SaveToDB Framework 8 or 9 to get new benefits.

Here is a comparison table of SaveToDB Framework objects:

SaveToDB Framework 7SaveToDB Framework 8/9
Schemas:
dbo01xls
etl01xls
xls01xls
Roles:
SaveToDB_developersxls_developers
SaveToDB_usersxls_users
Tables:
dbo01.QueryListxls.objects
dbo01.EventHandlersxls.handlers
dbo01.ParameterValuesxls.handlers
dbo01.ColumnTranslationxls.translations
dbo01.ObjectTranslationxls.translations
dbo01.TableFormatsxls.formats
Views:
dbo01.viewQueryListxls.queries
xls01.viewQueryListxls.queries
xls01.viewEventHandlersxls.handlers
xls01.viewParameterValuesxls.handlers
xls01.viewColumnTranslationxls.translations
xls01.viewObjectTranslationxls.translations
xls01.viewTableFormatsxls.formats
xls01.viewObjectDescriptionremoved
Procedures:
dbo01.uspUpdateTableFormatxls.formats
etl01.uspUpdateColumnTranslationremoved
etl01.uspUpdateColumnTranslation_Groupremoved
etl01.uspUpdateObjectTranslationremoved
etl01.uspUpdateObjectTranslationAbsentremoved

Upgrade Steps

Upgrade steps include:

  1. Upgrading the SaveToDB add-in to version 8.7 or higher on users' computers
  2. Installing SaveToDB Framework 8
  3. Exporting SaveToDB Framework 7 settings to SaveToDB Framework 8
  4. Removing SaveToDB Framework 7
  5. Changing application objects to SaveToDB Framework 8
  6. Upgrading SaveToDB Framework 8 to version 9 if required

Installing SaveToDB Framework 8

Run Wizards, Application Installer, connect to your database, and select SaveToDB Framework 8.

Check that the framework is not installed and select the Install operation:

Install SaveToDB Framework 8

In the next step, check that you have SaveToDB Framework 8.7 or higher, and click the Execute button:

Execute the SaveToDB Framework 8 installation code

You will see the installation results. Click Back.

Check SaveToDB Framework 8 installation results

Now you have to see that the SaveToDB Framework 8 has been installed:

Check SaveToDB Framework 8 objects

Exporting SaveToDB Framework 7 to SaveToDB Framework 8

Select SaveToDB Framework 7 and the Upgrade 7 to 8.0 operation. Click Next.

Export SaveToDB Framework 7 to SaveToDB Framework 8

This page contains the upgrade SQL code. Click Execute.

Execute the SaveToDB Framework 7 to SaveToDB Framework 8 export code

You will see the upgrade results.

Check SaveToDB Framework 7 to SaveToDB Framework 8 export results

You can check imported settings in the SaveToDB Framework 8 tables (xls.objects, xls.handlers, etc.).

Please note that migrating roles work in Microsoft SQL Server only.

For other database platforms, add roles and users to the xls_developers and xls_users roles manually.

Removing SaveToDB Framework 7

You can remove SaveToDB Framework 7 after checking SaveToDB Framework 8 tables.

We recommend saving the configuration workbook with the latest SaveToDB Framework 7 settings (Wizards, Application Workbooks) before.

To remove it, select SaveToDB Framework 7 and the Remove operation. Click Next.

Remove SaveToDB Framework 7

Cross fingers, and click the Execute button.

Execute the SaveToDB Framework 7 remove code

You will see the uninstalling results:

Check SaveToDB Framework 7 remove results

The uninstaller removes users from roles in Microsoft SQL Server only.

Changing Application Objects to SaveToDB Framework 8

Your database applications can contain application configuration objects that extend SaveToDB Framework objects.

The most used, for example, are query list views.

You can use Search and Replace in your database IDE to change the framework objects used in the FROM clause:

SaveToDB Framework 7SaveToDB Framework 8
Tables:
dbo01.QueryListxls.queries
dbo01.EventHandlersxls.handlers
dbo01.ParameterValuesxls.handlers
dbo01.ColumnTranslationxls.translations
dbo01.ObjectTranslationxls.translations
dbo01.TableFormatsxls.formats
Views:
dbo01.viewQueryListxls.queries
xls01.viewQueryListxls.queries
xls01.viewEventHandlersxls.handlers
xls01.viewParameterValuesxls.handlers
xls01.viewColumnTranslationxls.translations
xls01.viewObjectTranslationxls.translations
xls01.viewTableFormatsxls.formats

The objects have the same column names except for the dbo01.ParameterValues and xls.handlers tables.

Also, add the COLUMN_NAME IS NULL to JOIN statements for queries from the ObjectTranslation tables and views as the new xls.translations table contains translations for both objects and columns.

Upgrading SaveToDB Framework 8 to version 9

SaveToDB Framework 9 is based on SaveToDB Framework 8 and includes new features of SaveToDB 9.

To upgrade SaveToDB Framework 8, run the Application Installer as shown above and execute step-by-step upgrade operations like 8.0 to 8.6, 8.6 to 8.7, and so on.

Finally, you will have version 8.19, which is version 9.0.

Starting SaveToDB 9, the wizard's upgrade operation detects the current version and updates to latest version automatically.

This website is using cookies. By continuing to browse, you give us your consent to our use of cookies as explained in our Cookie Policy.OK