Branding Behavior

Branding behavior has changed for AhsayCBS v10.1 which may influence your workflow.

Recap of pre-v10.1 Branding Behavior

• Self-contained Branding profile (text properties, graphics, branding settings) are stored in $CBSHOME\conf\Branding\*.json; where the filename is either ROOT or the ID number of the Sub Admin.
• JSON rollback copies are generated whenever there are any branding setting changes saved in AhsayCBS. It is denoted by the file extension ".json.1" being the first recent (cycling up to a maximum of 11, the oldest).
• When a new Sub Admin is created, it initially inherits branding from ROOT.json, afterwards Sub Admin branding is independent and saved within its own JSON.
• Behavior under any new installation of AhsayCBS version (v8/v9/v10), using branded cbs-win.exe, $CBSHOME\webapps\cbs\images\ will contain the custom branded images that were packaged with the installer. This also applies to using a branded cbs-nix.tar.gz.
• Under upgrade behavior, using branded or Ahsay standard Windows installer cbs-win.exe, $CBSHOME\webapps\cbs\images\ will retain existing images and will not be replaced (overwrite) from the installation, however, additional new images may be added if upgrade is to a higher AhsayCBS version that requires them.
• Under upgrade behavior, using branded or Ahsay standard cbs-nix.tar.gz when following upgrade procedures from CLI, you will be swapping out the current AhsayCBS images ($CBSHOME\webapps\cbs\images\) with that from the TAR meaning "images" will be that from the swap; therefore if there are custom images to retain then you should transfer (merge) them over afterwards.

Generally, the branding JSON is still around but no longer used by AhsayCBS v10.1 for storing branding changes.

AhsayCBS v10.1 Branding Behavior

Upgraded AhsayCBS

Upon upgrade from AhsayCBS pre-v10.1, AhsayCBS v10.1 will:

1. Automatically convert all branding JSON ($CBSHOME\conf\Branding\*.json).
2. Import the properties into $CBSHOME\conf\cbs.db.
3. Export remaining assets into $CBSHOME\conf\Branding\{ID} structure containing branded graphics, XML, and metadata (where {ID} = SubAdmin ID# or {ID} = “ROOT” for Admin profile).

The migration is triggered when the branding settings is loaded for the first time (e.g. access sub admin console, build client installer) or by daily Auto Save routine (06:00), whichever occur first, after handling, the JSON will rename to “.json.bak” to signify it was migrated. The files will remain until future enhancement is available to automatically purge. You may opt to manually remove the migrated JSONs to save space or archive as you see fit.

Newly installed AhsayCBS

From AhsayCBS v10.1 onwards, Branding will store relevant changes into their new locations:

• cbs.db (temp files cbs.db-wal and cbs.db-shm)
• $CBSHOME\conf\Branding\{ID}

These are needed if troubleshooting is necessary.

Best practice to avoid branding leakage is to ensure you have uploaded custom graphics to replace all editable images via AhsayCBS Branding UI. Then export the JSON and retain it in a safe location.

AhsayCBS v10.1 behavior change within $CBSHOME\CONF\BRANDING\

• Branding JSON are no longer generated, nor existing JSON updated. Any "*.json.*" found here (i.e. ROOT.json, ROOT.json.2) are pre-v10.1, and will remain here until future enhancement to remove them.
• Branding JSON rollback files (the .1, .2) are no longer generated whenever you save Branding changes from the AhsayCBS UI. Automatic creation of previous JSON copy no longer exist.
• The Export / Import of branding JSON is still available; however, the exported JSON will omit exporting graphics that are unchanged (i.e. no custom graphic uploaded), thus reducing the JSON export file size [unchanged graphics source from $CBSHOME\webapps\cbs\images\ if the graphic is not found within {ID} structure after import]. JSON exported from AhsayCBS v10.1 is not backwards compatible with earlier AhsayCBS version.
• Routine AhsayCBS conf backup and Auto Save will still bundle exported branding JSON file(s), along with the cbs.db; however, the $CBSHOME\conf\Branding\{ID} directory is not packaged.

AhsayCBS v10.1 behavior change affecting language and GUI feature of AhsayOBM/AhsayACB

The current settings for Language and GUI Feature will re-apply during AUA (i.e. version upgrade and hotfix). If there were changes to either of these, clients will receive the latest values applied after AUA.