Initialize or update the meta-model of the Alfabet database

If you are using a new database, the database must be initialized via an ADBZ file delivered with the release to generate the required database tables. If you are using an existing Alfabet 10 database, you must update the meta-model of the database.

• Initialize a new database

  An Alfabet database that provides the initial state of Alfabet including example data is delivered with the software as an Alfabet_Accelerator_Showcase_11.11.0.A.adbz database archive file in the Database directory of the Alfabet installation folder. This database archive file is required to initially populate the Alfabet database.

  To read the ADBZ file to the Alfabet database:

  1. Start the Alfabet Administrator from the Windows® Start Menu.
  2. Expand the Alfabet Aliases node in the explorer.
  3. Right-click the server alias that connects to the Alfabet database and select Restore Database Archive.
  4. In the dialog box that opens, select the Alfabet_Accelerator_Showcase_11.11.0.A.adbz archive file in the Database directory of the Alfabet installation folder.
  5. The following options can be selected when restoring the Alfabet database:
     •  Include Audit: If the checkbox is selected, audit tables which are part of the ADBZ are restored in the target database. You can select this option if you want to test the audit history functionality with the example data.
     • Squeeze Audit Tables: If the checkbox is selected, the audit tables are scanned for obsolete entries. Any entries that were generated ,for example, during the batch update of data via batch utilities without documenting any audit relevant changes are deleted from the audit tables restored from the ADBZ file.
  6. Click Restore to start the restore process. It may take a few minutes before the restore process is completed.
  7. In the Info window that opens, click OK.
  8. Explore the functionality with the example data. Delete the example data prior to entering your own data.
• Update the meta-model of an existing Alfabet 10.15.x database

  Between Alfabet 10 and Alfabet 11, the configuration of the user interface has changed considerably. When you update the meta-model of an existing Alfabet 10 database, your customized configuration must be adapted to the changes. This is an individual process which requires customized restructuring efforts. During update of the meta-model, some configurations can be adapted to the new structure . But due to the significant changes to usability and the user interface in Alfabet 11, a one-to-one migration will not be possible. Please contact the Alfabet team in Bizzdesign BV to help you plan your transition to Alfabet 11.

  There are three methods to do the update:

  • Update of the meta-model with running scripts for adapting existing configuration automatically to the Alfabet 11.11 configuration structure. Click for an overview of automatic migration steps.
  • Update of the meta-model migration without changing the current configuration. All adaptations to the new way of configuring Alfabet must be done manually.
  • Skip the Alfabet 10.15.x custom configuration and start with the standard Alfabet 11 Accellerator configuration. This option is recommended for customers who used an Alfabet Accellerator configuration without or with only minor customizations in Alfabet 10.15. The new Alfabet Accellerator 11 configuration is then fully available with your data.

  The implementation of the standard widget card templates used for indicator visualization require an additional update of the meta-model with the provided Indicator_Cards_AddOnPackage.amm file and a change in the class settings. Details are given in the documentation of widget card templates. . This is only required if you do not use the standard Alfabet 11 Accellerator configuration.

  The required changes to upgrade the meta-model to the new release are stored in AMM files delivered with the new release.

  The following procedure describes the update with the Alfabet Administrator tool. Alternatively, you can update the meta-model using the AlfabetAdministratorConsole.exe command line tool. The order of updates with different AMM files described below also applies to update via the command line tool. If you would like to take advantage of automatic migration scripts run during update of the meta-model (see step 5), you must use the Alfabet Administrator tool.

  1. Start the Alfabet Administrator from the Windows® Start Menu.
  2. Expand the Alfabet Aliases node in the explorer.
  3. Right-click the server alias that connects to the Alfabet database, select Update Meta-Model and log in to the database either via Windows sign-on or user name and password.
  4. In the dialog box that opens, select the UpdateFile_11.11.0.amm file in the Database directory of the Alfabet installation folder.
  5. Decide on the migration method setting the Execute configuration migration scripts option:
     • Execute configuration migration scripts is selected: Parts of your existing configuration will be automatically adapted to the Alfabet 11.11 configuration structure.
     • Execute configuration migration scripts is not selected: Migration is done without changing the current configuration. All adaptations to the new way of configuring Alfabet must be done manually. Deselect the checkbox if you want to use the standard Alfabet 11.11 Accelerator configuration or do all adaptations of your configuration manually.
  6. Click Update to start the meta-model update.
  7. If you want to use the standard Alfabet Accellerator 11 configuration, update the meta-model again with the Alfabet_Accelerator_Configuration_Update_11.11.0.A.amm file in the Database directory of the Alfabet installation folder.
  8. If you do not want to use the standard Alfabet Accellerator 11 configuration, update the meta-model again with the Indicator_Cards_AddOnPackage.amm file in the Database directory of the Alfabet installation folder. This update is required to activate widgets for indicator cards and user defined content items in content areas.

  If issues occur during update of the meta-model via the AMM file, a log file is created during update of the meta-model. The log file is written to the directory that contains the AMM file and has the name <Name of the AMM file>_<Time Stamp>.log. Consult the log file to view any issues that occurred during update.

  If configurations not matching the meta-model after update are detected in the database, the update meta-model process will write the problems into a Microsoft® Excel® file. The file is written to the directory that contains the AMM file and has the name <Name of the AMM file>_<Time Stamp>.xlsx. Open the Excel file and check for issues that require correction. The file only includes relevant sheets. If a specific issue does not occure, the respective sheet is not available in the file. The file may consist of the following sheets:

  • Translation Errors: Lists issues detected during vocabulary update such as original strings that exceed the maximum allowed character number of 600 characters.
  • Queries: Lists all queries defined in Alfabet configuration that are no longer valid because of meta-model changes.
  • Class Settings Editor: Lists all class settings with an incorrect editor configuration.
  • User Profile Errors: Lists all user profiles with a missing or incorrect view scheme configuration. User profiles are listed here if the View Scheme attribute is either empty or set to a view scheme that does not exist. The view scheme configuration is required to apply the correct class settings to the user profile, thus ensuring that the correct settings are applied for the object class property and button configuration, for example.
  • Performance Optimization Hints: Lists configurations potentially affecting system performance. Currently, the list includes all object class properties defined as shadow references that do not have an index configured to optimize search operations. Additional configuration patterns identified as performance-relevant in future releases will also be added to this list.

  The way the user interface is configured has considerably changed between Alfabet 10 and Alfabet 11 releases. After update of the meta-model, the existing configuration must be revised and adapted to the new configuration elements.

• Update the meta-model of an existing Alfabet 11.x database

  The required changes to upgrade the meta-model to the new release are stored in an AMM file delivered with the new release. You can update directly from any previous Alfabet 11.x version to Alfabet 11.11.0.

  The following procedure describes the update with the Alfabet Administrator tool. Alternatively, you can update the meta-model using the AlfabetAdministratorConsole.exe command line tool. . If you upgrade from Alfabet 11.7.1 or Alfabet 11.7.2, you must use the Alfabet Administrator tool.

  1. Start the Alfabet Administrator from the Windows® Start Menu.
  2. Expand the Alfabet Aliases node in the explorer.
  3. Right-click the server alias that connects to the Alfabet database and select Update Meta-Model.
  4. In the dialog box that opens, select the file name and location of the .amm file for upgrade to Alfabet 11.11.
  5. When upgrading from Alfabet 11.7.1 or Alfabet 11.7.2, you will see a Execute configuration migration scripts checkbox.
     • Select the checkbox if you have migrated the current database with execution of migration scripts from an Alfabet 10.15.x database.
     • Do not select the checkbox if you have decided to use the standard Alfabet 11 Accellerator, migrated an Alfabet 10.15.x database without running migration scripts, or started using Alfabet with Alfabet 11.x.
  6. Click Update to start the meta-model update.
  7. If you use the standard Alfabet Accellerator 11 configuration without customization, update the meta-model again with the Alfabet_Accelerator_Configuration_Update_11.11.0.A.amm file in the Database directory of the Alfabet installation folder.

     If you have based your configuration on one the standard Alfabet Accellerator configuration via the Alfabet_Accelerator_Configuration_Update_11.<version numer>.amm file, and afterwards added own configurations to the meta-model configuration, do not update to a new Alfabet Accellerator configuration the Alfabet_Accelerator_Configuration_Update_11.11.0.A.amm file. The update would overwrite your customizations. Contact Alfabet Support to request an update ensuring that new features are included while your customizations are maintained.

  8. Update the meta-model again with the Indicator_Cards_AddOnPackage.amm file in the Database directory of the Alfabet installation folder. This update is required to update widgets for indicator cards and user defined content items in content areas.

  If issues occur during update of the meta-model via the AMM file, a log file is created during update of the meta-model. The log file is written to the directory that contains the AMM file and has the name <Name of the AMM file>_<Time Stamp>.log. Consult the log file to view any issues that occurred during update.

  If configurations not matching the meta-model after update are detected in the database, the update meta-model process will write the problems into a Microsoft® Excel® file. The file is written to the directory that contains the AMM file and has the name <Name of the AMM file>_<Time Stamp>.xlsx. Open the Excel file and check for issues that require correction. The file consists of the following sheets:

  • Translation Errors: Lists issues detected during vocabulary update such as original strings that exceed the maximum allowed character number of 600 characters.
  • Queries: Lists all queries defined in Alfabet configuration that are no longer valid because of meta-model changes.
  • Class Settings Editor: Lists all class settings with an incorrect editor configuration.
  • User Profile Errors: Lists all user profiles with a missing or incorrect view scheme configuration. User profiles are listed here if the View Scheme attribute is either empty or set to a view scheme that does not exist. The view scheme configuration is required to apply the correct class settings to the user profile, thus ensuring that the correct settings are applied for the object class property and button configuration, for example.
  • Performance Optimization Hints: Lists configurations potentially affecting system performance. Currently, the list includes all object class properties defined as shadow references that do not have an index configured to optimize search operations. Additional configuration patterns identified as performance-relevant in future releases will also be added to this list.

  The update of the meta-model, check the following for migration to 11.11: