Install Framework

This chapter describes how to install and update the ExMeX Framework Core.
First the initial installation is explained, then the configuration as well as the update of the ExMeX Framework Core.

How to install a new ExMeX Framework Core (as of release 2.13.0) ?

Valid as of release 2.13.0 To install ExMeX Framework Core in a new database, please download first the current version…

Valid as of release 2.13.0

To install ExMeX Framework Core in a new database, please download first the current version of the ExMeX Framework Core. An existing installed SQL Server 2017 (14.x) and later is required.

How to update to a new ExMeX Framework Core release, see the following section.

Now that you have downloaded the latest release, please follow all the steps below:

  1. Unpack the downloaded 7z file and copy the files to the new root directory, e.g. c:/GitRepos/<YourGitClone>/Tutorial ExMeX Framework/.
  2. Switch to your new root directory.
  3. Create a database (SQL Server 2017 (14.x) and later), e.g. a database named Tutorial-ExMeX-Metadata with script CreateTutorialDatabase.sql. Available for download here (You can put the file in the ./opt/tutorial folder):
  4. Switch to folder ./etc/config in root directory.
  5. Copy all files and remove "orig.", e.g.: ConfigExMeXFramework.orig.sql to ConfigExMeXFramework.sql
  6. Open the ConfigExMeXFramework.sql file.
  7. Change variable MetadataDatabase to the database where your ExMeX Framwork Core is installed. Example:
    :setvar MetadataDatabase <YourTEDAMOHExMeXDatabase>
    to e.g.
    :setvar MetadataDatabase Tutorial-ExMeX-Metadata
  8. Change variable MetadataPath to your metadata directory ./var/TEDAMOH-ExMeX. Keep the folder TEDAMOH-ExMeX at the end of the path if you will use a directory outside of your root directory! Example:
    :setvar MetadataPath "<YourTEDAMOHExMeXMetadataDirectory>\TEDAMOH-ExMeX"
    to e.g.
    :setvar MetadataPath "C:\…\Tutorial ExMeX Framework Core\var\TEDAMOH-ExMeX"
  9. Open the ‘ExMeX Set Config Variable.orig.sql’ file and configure the global variables as needed. All available global variables are described in detail in the following section Getting Started -> Configuration -> How do you set global variables and what is their purpose?.
    If you don't know what exactly to do here, skip the step for now and the default setting will be applied.
  10. Save and close file.
  11. Switch to folder ./usr/config in root directory.
  12. Copy all files and remove "orig.", e.g.: UsrConfigExMeXFramework.orig.sql to UsrConfigExMeXFramework.sql
  13. Switch back to your root directory.
  14. Copy all files and remove "orig.", e.g.: “Install TEDAMOH ExMeX Database Framework CMD.orig.sql” to “Install TEDAMOH ExMeX Database Framework CMD.sql”
  15. Open the "Install TEDAMOH ExMeX Database Framework CMD.sql" file.
  16. Set variable InitPath to your new root directory. Example:
    :setvar InitPath "<YourRootDirectory>"
    to e.g.
    :setvar InitPath "C:\…\Tutorial ExMeX Framework Core"
  17. Save and close file.
  18. Finally, to install a complete current version of the ExMeX Framework Core database, run the script Install TEDAMOH ExMeX Database Framework CMD.sql in SSMS with SQLCMD Mode on.
  19. Done.

It is recommended to ignore all modified files located in ./usr/config within your code versioning tool, e.g.: .gitignore

Posted 2 years agoby Dirk.Lerner

How to install a new ExMeX Framework Core (until release 2.12.x) ?

Valid until release 2.12.0 To install ExMeX Framework Core in a new database, please download first the current version of…

Valid until release 2.12.0

To install ExMeX Framework Core in a new database, please download first the current version of the ExMeX Framework Core. An existing installed SQL Server 2017 (14.x) and later is required.

How to update to a new ExMeX Framework Core release, see the following section.

Now that you have downloaded the latest release, please follow all the steps below:

  1. Unpack the downloaded 7z file and copy the files to the new root directory, e.g. c:/GitRepos/<YourGitClone>/Tutorial ExMeX Framework/.
  2. Switch to your new root directory.
  3. Create a database (SQL Server 2017 (14.x) and later), e.g. a database named Tutorial-ExMeX-Metadata with script CreateTutorialDatabase.sql. Available for download here (You can put the file in the ./opt/tutorial folder):
  4. Switch to folder ./etc/config in root directory.
  5. Copy all files and remove "orig.", e.g.: ConfigExMeXFramework.orig.sql to ConfigExMeXFramework.sql
  6. Open the ConfigExMeXFramework.sql file.
  7. Change variable MetadataDatabase to the database where your ExMeX Framwork Core is installed. Example:
    :setvar MetadataDatabase <YourTEDAMOHExMeXDatabase>
    to e.g.
    :setvar MetadataDatabase Tutorial-ExMeX-Metadata
  8. Change variable MetadataPath to your metadata directory ./var/TEDAMOH-ExMeX. Keep the folder TEDAMOH-ExMeX at the end of the path if you will use a directory outside of your root directory! Example:
    :setvar MetadataPath "<YourTEDAMOHExMeXMetadataDirectory>\TEDAMOH-ExMeX"
    to e.g.
    :setvar MetadataPath "C:\…\Tutorial ExMeX Framework Core\var\TEDAMOH-ExMeX"
  9. Save and close file.
  10. Switch to folder ./usr/config in root directory.
  11. Copy all files and remove "orig.", e.g.: UsrConfigExMeXFramework.orig.sql to UsrConfigExMeXFramework.sql
  12. Switch back to your root directory.
  13. Copy all files and remove "orig.", e.g.: “Install TEDAMOH ExMeX Database Framework CMD.orig.sql” to “Install TEDAMOH ExMeX Database Framework CMD.sql”
  14. Open the "Install TEDAMOH ExMeX Database Framework CMD.sql" file.
  15. Set variable InitPath to your new root directory. Example:
    :setvar InitPath "<YourRootDirectory>"
    to e.g.
    :setvar InitPath "C:\…\Tutorial ExMeX Framework Core"
  16. Save and close file.
  17. Finally, to install a complete current version of the ExMeX Framework Core database, run the script Install TEDAMOH ExMeX Database Framework CMD.sql in SSMS with SQLCMD Mode on.
  18. Done.

It is recommended to ignore all modified files located in ./usr/config within your code versioning tool, e.g.: .gitignore

Posted 2 years agoby Dirk.Lerner

How do you set global variables for initial installation?

Valid as of release 2.13.0 In the ExMeX Framework Core, there are global variables for controlling various processes and for…

Valid as of release 2.13.0

In the ExMeX Framework Core, there are global variables for controlling various processes and for configuration. These include general settings, data logistics in batches and (Load Process Steps (LPS) or also the configuration of data for historisation.

Purpose

A dynamic access to global variables from all parts of the ExMeX Framework Core at runtime.

Motivation

Instead of configuring the global variables in the database after each installation of the ExMeX Framework Core on different environments, such as development, test and production, this can be done once in the initialization script of the installation. This way a rollout via GIT is possible at any time and all environments have the identical configuration inital.

Applicability

For installation of the ExMeX Framework Core on different environments, such as development, test and production, all global variables can be set by the data modeller or the DevOp in the script ‘./etc/config/ExMeX Set Config Variable.sql’.

Check if the settings made in the script ‘./etc/config/ExMeX Set Config Variable.sql’ match the values set in the ExMeX Framework Core database after installation:

SELECT *
FROM MetadataZone.ConfigExMeXFramework
Content

All available global variables are described in detail in the following section Getting Started -> Configuration -> How do you set global variables and what is their purpose?.

Considerations and consequences

Since a change in global variables usually has far-reaching consequences for all parts of the ExMeX Framework Core, they should be chosen carefully.
At this point the global variables are configured exclusively for the installation or update (new global variables) of the framework. Afterwards the configuration set here has no more effects.

Later necessary changes, e.g. for the target database in which an LPS is to be executed (UseTargetEntityDB) can be carried out by a data modeler or DevOp as described in section Getting Started -> Configuration -> How do you set global variables and what is their purpose?.

Posted 11 months agoby Dirk.Lerner

How to update ExMeX Framework Core?

To update ExMeX Framework Core to the latest release we always recommend to perform the following three steps: Backup, Update…

To update ExMeX Framework Core to the latest release we always recommend to perform the following three steps: Backup, Update and Housekeeping.

Backup ExMeX Framework Core

Before updating an exiting ExMeX Framework Core to the newest release, it is recommend to backup your

  • ExMeX Framework Core Database,
  • ExMeX Framework Core root folder and
  • User specific add ons

If you do not backup, well it’s up to you.

Update ExMeX Framework Core

To update the ExMeX Framework Core to the newest release, please follow the install notes in the latest release notes!

Housekeeping ExMeX Framework Core Database

When the installation of the release is done, there are some final tasks to do. If everything is installed fine, there will temporary tables remaining in you ExMeX Framework Core database.

These tables are backups of tables which structure was changed during the update process. They can be identifies by their prefix: tmp_<TableName>.

You can clean up your ExMeX Framework Core database by deleting all temporary backup tables.

Posted 10 months agoby Dirk.Lerner