Upgrading to Brand Mobiliser 1.3 SP01

Upgrade Brand Mobiliser Version 1.3 by installing support pack 01.

The name of the software patch file is brand-patch-1.3-PATCH1.zip.

  1. On the deployment system, in BRAND_HOME, create a patches directory.
    SAP® recommends that you keep a separate directory with applied patches, as a reminder of the current application version.
  2. Copy brand-patch-1.3-PATCH1.zip to the patches directory, and unzip the file.
    The brand-patch-1.3-PATCH1 directory is created.
  3. In the BRAND_HOME/patches/brand-patch-1.3-PATCH1 directory, create a backup directory.
  4. Copy the BRAND_HOME/conf/config.properties file to the backup directory.
  5. Copy the contents of the BRAND_HOME/patches/brand-patch-1.3.1-PATCH1/bundle/application directory to the BRAND_HOME/bundle/application directory.
    The contents are JAR and WAR files.
  6. Update the Brand Mobiliser configuration:
    1. Open the BRAND_HOME/conf/config.properties file, and locate these lines:
      ${aims.app.dir}/mobiliser-brand-jpa-1.3.1.jar
      ${aims.app.dir}/mobiliser-brand-jpa-eclipselink-1.3.1.jar
      ${aims.app.dir}/mobiliser-brand-processing-1.3.1.jar
      ${aims.app.dir}/mobiliser-brand-rest-core-1.3.1.war
      ${aims.app.dir}/mobiliser-brand-webadmin-ui-1.3.1.war
    2. In each line, update the version number to 1.3.2, and save your changes:
      ${aims.app.dir}/mobiliser-brand-jpa-1.3.2.jar
      ${aims.app.dir}/mobiliser-brand-jpa-eclipselink-1.3.2.jar
      ${aims.app.dir}/mobiliser-brand-processing-1.3.2.jar
      ${aims.app.dir}/mobiliser-brand-rest-core-1.3.2.war
      ${aims.app.dir}/mobiliser-brand-webadmin-ui-1.3.2.war
  7. Optional. Update the Apache Derby database. If you are patching a production system that uses a database other than Apache Derby, skip this step.

    Brand Mobiliser includes an embedded Derby database out of the box. The default configuration runs using the embedded database, and is intended for use in development environments. The default configuration is not recommended for production environments.

    The Derby database that was released with Brand Mobiliser version 1.3 was missing scripts that are required for setting unique column constraints for some tables.

    To update the database, use one of these methods:
    • Back up and upgrade – if there is nothing in the current database that you need, or if you can reproduce everything easily:
      1. Copy the BRAND_HOME/derby/mwiz2 directory to the /backup directory that you created in step 3. Backing up the directory enables rollback if needed.
      2. Copy the /mwiz2 directory from BRAND_HOME/patches/brand-patch-1.3.1-PATCH1/derby to BRAND_HOME/derby.
    • Export applications, back up, and upgrade – if you have multiple applications that cannot be easily reproduced:
      1. Export your applications to XML files. You can reimport the XML files after the database has been upgraded. See the Brand Mobiliser Developer Guide for information about how to export and import applications.
      2. After you export your applications, follow the "Back up and upgrade" instructions, above.
    • Patch with SQL scripts – if you cannot use either of the first two methods:
      1. Download SQL client software that can connect to the database using JDBC, for example, SQuirrel SQL. You need access to the embedded database file located in the BRAND_HOME/derby/mwiz2 directory.
      2. Run the following scripts:
        ALTER TABLE M_LANGUAGES ADD CONSTRAINT LANGAUGES_UQ_NAME UNIQUE (NAME);
        ALTER TABLE M_PERMISSIONS ADD CONSTRAINT PERMISSIONS_NAME_UQ UNIQUE (NAME);
        ALTER TABLE M_USERS ADD CONSTRAINT USERS_UQ UNIQUE (USERNAME);
        ALTER TABLE M_CLIENTS ADD CONSTRAINT CLIENTS_UK_NAME UNIQUE (NAME);
        ALTER TABLE M_CLIENT_MSISDNS ADD CONSTRAINT CLIENT_MSISDNS_UQ UNIQUE (MSISDN);
        ALTER TABLE M_PLUGIN_INSTANCES ADD CONSTRAINT M_PLUGIN_INSTANCES_UQ UNIQUE (NAME);
        ALTER TABLE M_CUSTOMERS ADD CONSTRAINT CUSTOMERS_UQ_EMAIL UNIQUE (EMAIL);
        ALTER TABLE M_CUSTOMERS ADD CONSTRAINT CUSTOMERS_UQ_MSISDN UNIQUE (MSISDN);
        ALTER TABLE M_CUSTOMER_ATTRIBUTES ADD CONSTRAINT CUST_ATTR_UQ UNIQUE (CLIENTS_ID, CUSTOMERS_ID);
        ALTER TABLE M_SESSIONS_ACTIVE ADD CONSTRAINT SESSIONS_ACTIVE_UQ UNIQUE (CUSTOMERS_ID, CLIENTS_ID);
        ALTER TABLE M_SESSION_ATTRIBUTES ADD CONSTRAINT SESSION_ATTRIBUTES_UQ UNIQUE (SESSIONS_ID, KEY2);
        ALTER TABLE M_SMAPP_STATE_TYPES ADD CONSTRAINT SMAPP_STATE_TYPES_UQ UNIQUE (NAME);
        ALTER TABLE M_SMAPP_STATE_ATTRIBUTES ADD CONSTRAINT M_SMAPP_STATE_ATTRIBUTES_UK1 UNIQUE (SMAPP_STATES_ID, VERSION_ID, 
        ALTER TABLE M_SMAPP_STATE_LANGS ADD CONSTRAINT M_SMAPP_STATE_LANGS_UK1 UNIQUE (SMAPP_STATES_ID, LANGUAGES_ID, VERSION_ALTER TABLE M_SMAPP_APPLICATIONS ADD CONSTRAINT SMAPP_APP_FK_SN_UQ UNIQUE (SHORT_NAME, VERSION_ID, CLIENTS_ID);
        ALTER TABLE M_SMAPP_TRANSITION_TYPES ADD CONSTRAINT SMAPP_TRANSITION_TYPES_UQ UNIQUE (NAME);
        ALTER TABLE M_MENU_PAGES ADD CONSTRAINT MENU_PAGES_UQ UNIQUE (CLIENTS_ID, SHORTNAME, VERSION_ID);
        ALTER TABLE M_MENU_PAGES_LANGS ADD CONSTRAINT MENU_PAGES_LANGS_UQ UNIQUE (LANGUAGES_ID, VERSION_ID, MENU_PAGES_ID);
        ALTER TABLE M_MENU_TEXT_TYPES ADD CONSTRAINT TEXT_TYPES_UQ UNIQUE (NAME);
        ALTER TABLE M_MENU_TEXTS_LANGS ADD CONSTRAINT MENU_TEXTS_LANGS_UQ UNIQUE (LANGUAGES_ID, VERSION_ID, MENU_TEXTS_ID);
        ALTER TABLE M_PATTERN_TYPES ADD CONSTRAINT PATTERN_TYPES_UQ_NAME UNIQUE (NAME);
        ALTER TABLE M_PROGRAM_EVENTS ADD CONSTRAINT PROGRAM_EVENTS_FK_SN_UQ UNIQUE (ID, VERSION_ID, CLIENTS_ID);
        ALTER TABLE M_PROGRAM_EVENT_SCHEDULE ADD CONSTRAINT PRG_EVENT_SCHED_FK_SN_UQ UNIQUE (ID, VERSION_ID, PROGRAM_EVENTS_ID);
        ALTER TABLE M_SUBSCRIBER_MASTER ADD CONSTRAINT UNIQUE_MSISDN UNIQUE (MSISDN, LIST_ID)
  8. Start Brand Mobiliser:
    • On Windows – run.bat
    • On Linux or AIX – run start

    If Brand Mobiliser is already running, restart it – run restart.

    To stop Brand Mobiliser – run stop.

    To get the status of Brand Mobiliser – run status.