Upgrade from coreBOS 5.4.0 to coreBOS 5.5.0

This release is about updating and stabilizing our code base along with enhancements in two directions:

  • open the application to third party projects through a much more powerful REST interface, so we can grow upon the core system creating incredible applications on top of it
  • change the package distribution system, so it is much easier to distribute new modules and new changes without having to go through a traumatic process of patching and manually executing code

But we still slipped in a few interesting features on reporting and importing among others :-)

You can find the full details of the changes made on this page.

Upgrading is still a work better suited for a developer who is comfortable playing with the code, but I will try to explain the process in detail to make it easier.

Backup your files and database, there should be no problem, all the code is tested and the process is not invasive, if there is a problem we will help, this is just a precautionary step and another good reason to make a backup of your information

You have a clean coreBOS 5.4

You can proceed in two ways, either use the fully patched zip upgrade package or apply the patch.

Fully patched zip upgrade

  1. backup your files and database, there should be no problem, all the code is tested, if there is a problem we will help, this is just a precautionary step and another good reason to make a backup of your information
  2. copy it to the root of your current coreBOS 5.4
  3. unzip it overwriting all files
    unzip -o corebos54_to_corebos55.zip
  4. you can also uncompress the files locally and upload them to your server via FTP

    PLEASE, make sure your code base is totally clean, this step will overwrite your files and any change they may contain. Although you may not have done any changes to the files you know of, some extensions in the market do this and require those changes. If you have any code change at all, or some extension already installed that modify base files, use the patch upgrade procedure detailed below. If you are in doubt, ask in the forum.

  5. execute the database changes, this is done using the coreBOS Updater, which is a module that will take care of managing all the updates from now on. It will read the set of changes that need to be done and will permit you to apply them and undo some of them. In this first release of the module we must install it.
    1. Go to your browser
    2. login to your coreBOS 5.4
    3. edit the URL box and eliminate all the text starting from index.php
    4. add installupdater.php

      It should look like this:

      http://your_server/your_crm/installupdater.php
    5. execute the script and you should get a green screen with some messages about the actions executed
    6. edit the URL box again and go to your coreBOS:
      http://your_server/your_crm/index.php
    7. open the menu and go to coreBOS Updater
    8. click on the Get Updates button
    9. go back to the list view and click on the Apply All button
  6. manually change your config.inc.php, 120 for speed optimization we have require adding a line to your config.inc.php, THIS IS VERY IMPORTANT or some parts of the application may not work correctly.
    1. edit config.inc.php and look for the lines
      // default charset default value = 'UTF-8' or 'ISO-8859-1'
      $default_charset = 'UTF-8';

      note that your value may be different from UTF-8, now add this line after the assignment

      $default_charset = strtoupper($default_charset);  // DO NOT MODIFY THIS LINE, IT IS IMPORTANT

      so it all ends up looking like this:

      // default charset default value = 'UTF-8' or 'ISO-8859-1'
      $default_charset = 'UTF-8';
      $default_charset = strtoupper($default_charset);  // DO NOT MODIFY THIS LINE, IT IS IMPORTANT
    2. save the file

Your done. Enjoy!

Apply patch file with changes upgrade

  1. backup your files and database, there should be no problem, all the code is tested, if there is a problem we will help, this is just a precautionary step and another good reason to make a backup of your information
  2. copy it to the root of your current coreBOS 5.4
  3. apply the patch with the git apply command
    git apply --reject corebos54_to_corebos55.patch
  4. you can also do this locally on your file system and then upload the files to your server via FTP

    The git apply command will give some errors and warnings. This is normal because in this release we are changing the distribution method of modules and extensions, now we have them all laid out in the code instead of packed in .zip files. This requires us to put all the files in place and we do this for all files, many of which you already have in place and those do not get overwritten, thus the error/warnings. What you do have to pay attention to is any message of REJECT, those are indicating a problem you need to attend.

  5. execute the database changes, this is done using the coreBOS Updater, which is a module that will take care of managing all the updates from now on. It will read the set of changes that need to be done and will permit you to apply them and undo some of them. In this first release of the module we must install it.
    1. Go to your browser
    2. login to your coreBOS 5.4
    3. edit the URL box and eliminate all the text starting from index.php
    4. add installupdater.php

      It should look like this:

      http://your_server/your_crm/installupdater.php
    5. execute the script and you should get a green screen with some messages about the actions executed
    6. edit the URL box again and go to your coreBOS:
      http://your_server/your_crm/index.php
    7. open the menu and go to coreBOS Updater
    8. click on the Get Updates button
    9. go back to the list view and click on the Apply All button
  6. manually change your config.inc.php, 120 for speed optimization we have require adding a line to your config.inc.php, THIS IS VERY IMPORTANT or some parts of the application may not work correctly.
    1. edit config.inc.php and look for the lines
      // default charset default value = 'UTF-8' or 'ISO-8859-1'
      $default_charset = 'UTF-8';

      note that your value may be different from UTF-8, now add this line after the assignment

      $default_charset = strtoupper($default_charset);  // DO NOT MODIFY THIS LINE, IT IS IMPORTANT

      so it all ends up looking like this:

      // default charset default value = 'UTF-8' or 'ISO-8859-1'
      $default_charset = 'UTF-8';
      $default_charset = strtoupper($default_charset);  // DO NOT MODIFY THIS LINE, IT IS IMPORTANT
    2. save the file

Your done. Enjoy!

You have a modified coreBOS 5.4

There is not much I can say here; you need a developer to weed through the changes and adapt your version with the new changes. We are tending towards making these updates less traumatic but, at this moment, we still have a little bit to go.

Your developer will have to evaluate which of the previous two scenarios is best for him and take it from there.

Remember to install the coreBOS Updater and apply all the changes to the database.

You have your coreBOS 5.4 under GIT version control

This is ideal as you can add a remote to our GitHub project (https://github.com/tsolucio/corebos) and follow our development as we move along. You still have to play around with the code and apply patches but GIT is going to help you a lot.

So the steps here are identical to the three situations described before just that GIT will do the patching for you and help you along the way once you have added the remote link.

REALLY high level steps would be:

  • git remote add corebos https://github.com/tsolucio/corebos
  • git merge corebos/master
  • fixes conflcts
  • execute installupdater.php from the browser
  • log in to application and go to the new coreBOS Updater module
  • click on Get Updates
  • click on Apply All

Remember to apply the database changes using coreBOS Updater and to manually change your config.inc.php 120, for speed optimization we require adding a line to your config.inc.php, THIS IS VERY IMPORTANT or some parts of the application may not work correctly.

  1. edit config.inc.php and look for the lines
    // default charset default value = 'UTF-8' or 'ISO-8859-1'
    $default_charset = 'UTF-8';

    note that your value may be different from UTF-8, now add this line after the assignment

    $default_charset = strtoupper($default_charset);  // DO NOT MODIFY THIS LINE, IT IS IMPORTANT

    so it all ends up looking like this:

    // default charset default value = 'UTF-8' or 'ISO-8859-1'
    $default_charset = 'UTF-8';
    $default_charset = strtoupper($default_charset);  // DO NOT MODIFY THIS LINE, IT IS IMPORTANT
  2. save the file

coreBOS Documentación