How to migrate v5 project to v7

For any v5 project, backup index.html file first and copy index.html and template.html from v7 Jam.py Demo application into the application folder. Or, copy the same files from a new v7 project created with jam-project.py.

Uninstall the v5 Jam.py and install the v7. Or run two virtual Python instances with both Jam.py versions.

Start the application as usual with v7 Jam.py version.

Address the following:

  1. The biggest obstacle to move a Jam.py v5 application is the “Edit Lock” (record locking), enabled on the table(s). The Jam.py v7 is expecting a record_version (INT) field for every table with the Edit Lock.

    There are two options when migrating to v7. One is to disable the “Edit Lock” before migration, and the second option is to add the record_version field to affected tables before the migration.

    After the field is added to the database structure, we need to add it to the Application Builder manually, with “DB Manual Mode” turned ON for every table with “Edit Lock” enabled. The “record version” option should be set with record_version field.

    Obviously, disabling the “Edit Lock” does not need anything. There is no option on project Parameters to create the “Lock Item”.

  2. The next issue is templates. The Jam.py v7 is expecting the templates.html file within the application folder. Due to Bootstrap 5 usage, some minor differences will arise with moving the existing templates from Jam.py v5 index.html file to templates.html file.

  3. index.html also needs changing, due to Boostrap 5 dependencies. Please see below example.

  4. Foreign Key support is dropped at v7. This means if there are any Foreign Keys created at v5, there will be no option to manage it at v7.

  5. The Jam.py v7 introduced the calculated field. It is now possible to use the server side functions (SUM, COUNT, MIN, MAX, AVG), for the lookup to a table field in a Master/Detail scenario. The Users might review the server side calculations code and replace it with a calculated fields, if appropriate.

  6. Jam.py v7 is now utilising the Python dependencies and will automatically install needed libraries with the initial install. This is different to v5, where all dependencies were “locked in” with the Jam.py distribution, enabling a single jam folder for deployment with the application.

  7. For applications with Jam.py version 5.x or below, replace the Task/Client module code with Task/Client module code from Demo application or the new v7 project. Than, add a custom code from v5 Task/Client module, if there was any.

For example, Demo application index.html file contains:

<link href="jam/css/bootstrap-cerulean.css" rel="stylesheet">            <!--do not modify-->
<link href="jam/css/bootstrap-responsive.css" rel="stylesheet">
<link href="jam/css/bootstrap-modal.css" rel="stylesheet">
<link href="jam/css/datepicker.css" rel="stylesheet">
...
<script src="jam/js/bootstrap.js"></script>
<script src="jam/js/bootstrap-modal.js"></script>
<script src="jam/js/bootstrap-modalmanager.js"></script>
<script src="jam/js/bootstrap-datepicker.js"></script>
<script src="jam/js/jquery.maskedinput.js"></script>
<script src="jam/js/jam.js"></script>

Change to:

<link href="jam/css/bs5/bootstrap.css" rel="stylesheet">
<link href="jam/css/bs5/bootstrap-icons.css" rel="stylesheet">
<link href="jam/css/zebra_datepicker/bootstrap/zebra_datepicker.min.css" rel="stylesheet">
...
<script src="jam/js/bs5/bootstrap.bundle.js"></script>
<script src="jam/js/zebra_datepicker.js"></script>
<script src="jam/js/jquery.maskedinput.js"></script>
<script type="module" src="jam/js/jam.js"></script>

The rest of index.html file change should be minimal.