===== install meta database manually ===== 

To assist you in setting up the meta database several scripts are provided in ..\bin folder of tools.\\

|** ''do_setup_metadb'' ** |creates the schemas and all objects needed in these schemas|
|** ''do_setup_importdb'' ** |creates the schemas and all objects needed for import/export/deploy feature|
|** ''do_populate_metadb'' ** |inserts and updates all entries needed in the config tables|
|** ''do_configure_application'' ** |inserts and updates all entries needed for specific system applications provided with the install|
|** ''do_manage_metadb'' ** |assists you for backup and restore tasks|

Please check below how to call and in which order to call.

----
** important **
  * In case you want to run these scripts on a windows system the password you use must not contain "!" exclamation mark as this cannot be forwarded through batch scripts in windows
  * Make sure that your my.ini file establishes client connection with the proper character set option.

<code>
[client]
default-character-set=utf8mb4
</code>

  * Make sure that your local settings are set correctly in ''niota_setenv.bat''.
----

==== set environment ====

  * Edit file ''niota_setenv.bat'' to set your current values for environment variables mentioned below.

|** ''nMySQLHome'' ** |must be set to your \bin folder of the MySQL tools you need to use.|
|** ''nMySQLPort'' ** |must set to your port number|
|** ''nMySQLServer'' **  |must be set to your MySQL server|
|** ''nMySQLAdmin'' ** |must be set to a user on your MySQL server that has administration rights and is allowed to create databases, tables, views.|

** please check/set our configuration settings in niota_setenv.bat **\\
<code>
:: could be valid settings - check your local environment
set nMySQLHome=C:\mysql-8.0.26-winx64\bin
set nMySQLServer=localhost
set nMySQLPort=3366
set nMySQLAdmin=admin_niota
</code>
==== create meta database schemas ====

Once your environment settings are done correctly you can run the scripts to build up your meta database and populate it with content.

run script ''do_setup_metadb'' with option ''schemas''

This script creates your\\
  * meta database \\
  * deploy database \\

Mind that there are default names set for schemas. If you must change these defaults for any valid reason, you have to edit ''..\metadata_schemas.sql''. We don't recommend at all to change the default names.
 
** You have to connect to an existing schema to create a new schema. **


<code bat setup_metadb.cmd>
...\bin>do_setup_metadb sys ***** schemas
</code>

To achieve this, user "admin_niota" has ''ALL PRIVILEGES ON `niota%`.*'' and ''SELECT ON `sys`.*''


==== to have a client or not to have a client? ====

You can run niota from system meta db ''niota_meta'' or you can define an one meta database for your local clients.
** We strongly recommend to create your own client specific meta database! **

Set up has then later be done for both - the system client in niota_meta and for every own client meta database.


==== set up a meta database for a logical local "client" ====

Set desired meta database suffix for your local client. Default name is "niota_meta_c100" -- you can change the suffix to your needs e.g. niota_meta_IBM
Suffix should match the 5 characters client ID
Set your desired client meta database name in 

''..\tools\database\object\clients\client_schemas.sql'' and run script below and run the script

<code setup_metadb2.cmd> 
...\bin>do_setup_metadb sys ***** clients
</code>

or
execute DDL directly in your workbench
<code sql create_db.sql>
CREATE DATABASE if not exists niota_meta_<myID> CHARACTER SET UTF8MB4 COLLATE UTF8MB4_general_ci; 
</code>

** Please double check if your database exists now on the desired server. **

==== create database object in meta data database(s) ====

Now create tables, ...  \\

You can run every part of the setup process separately by setting the proper option or 

** run all at once with option "allobjects" **

''allobjects'' invokes creation of 
  * tables 
  * functions 
  * views 
  * ... 
  * 
in database niota_meta

<code bat setup_metadb_allobjects.cmd>
...\bin>do_setup_metadb niota_meta ***** allobjects
</code>

==== populate the meta database(s) ====

Now insert values for configuration and formats into the previously created tables.

run do_populate_metadb.bat <your metadata db> <mypw> <myoption>

You can run every part of the setup process separately by setting the proper option or run all at once with option ''allcontent''
When you run it separately these options are valid:
  * config
  * format

<code bat setup_metadb_allcontent.cmd>
...\bin>do_populate_metadb niota_meta_c100 ***** allcontent
</code>


<code bat setup_metadb_config.cmd>
...\bin>do_populate_metadb niota_meta_c100 ***** config
</code>



==== create import database =====
In case you want to use deploy/import feature you need an addition import/deploy database on your MySQL server. This database is also mandatory when you use application ''SPOCK''.
 

<code bat setup_importdb.cmd>
...\bin>do_setup_importdb information_schema ***** schemas

</code>

==== create objects in import database =====
To allow some scripts to copy data from one meta database to another meta database the need to be copied to the corresponding table in the import/deploy database.\\
** Tables in import database do not have constraints, therefore it can lead to inconsistencies in case you edit this tables manually ** 


<code>
...\bin>do_setup_importdb niota_deploy ***** allobjects
</code>

==== create database users(s) ====

We strongly recommend to create dedicated database users to access your meta database via niota web.
** DO NOT USE root or admin users. **

Configure provided scripts in folder user and run the scripts to create users and grant minimum privileges required.


==== install the applications ====

Now you have to install at least one application to be able to configure niota locally.
The most basic tool for this is ''adminpages''. 
Advanced features are contained in application ''spock'' Store Procedures Operations and Configuration Kit.

To install an application into you local meta database you have to run

''do_configure_application.bat'' <myMetadataDB> <myPW> <myApp>

<code>
...\bin>do_configure_application niota_meta_c100 *** adminpages
</code> 

<code>
...\bin>do_configure_application niota_meta_c100 *** spock
</code> 

After loading the applications please check for further details how to log in via niota web application.