Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

The guide below expected the content of the folders release_base and release_DATE to be extracted into a local folder called (drive):\meridix\dist\ the drive can vary e.g. C: or D: and the full path can differ but in that case the guide below need to be read with that in mind i.e. (drive):\meridix\dist\ should be replaced with the custom path.

It's recommended to use the conventions below for consistency if possible.

Install a new system

  1. Request the latest release from operations@meridix.se

  2. Make sure the content of the folders development_release_date_merdixs_studio_webdeploy_package and development_release_date_meridix_studio_service_console_binaries are extracted to (drive):\meridix\dist\

  3. Create an empty database named meridix_sys on the MSSQL server that should host the MXSDB.

    1. Create a SQL Server Authentication login and user with db_owner rights on the meridix_sys database.

  4. Install Microsoft .NET 4.7 or later on Windows Server 2016 or earlier (https://www.microsoft.com/net/download/framework). Windows Server 2019 has .NET 4.7.2 is already installed.

  5. Install Internet Informations Service (IIS) with the Web Server (IIS) - Role 

    1. Make sure ASP.NET 4.5/4.6 Feature is installed. 

  6. Install IIS Web Deploy 3.5 or later from the following link http://www.iis.net/downloads/microsoft/web-deploy)

  7. Create an IIS Site (or reconfigure the default)

    1. Set the site name to Meridix (can be named differently)

    2. Set the physical path to (drive):\meridix\webapp

    3. Bind it to port 80 (or any other port)

  8. Unzip the file 
    (drive):\meridix\dist\VERSION_AND_DATE_meridix_studio_webdeploy_package.zip into a folder on the server called (drive):\meridix\dist\_webdeploypackage.

  9. Edit the BAT file (drive):\meridix\dist\deploy_webpackage.bat with a text editor (e.g. Notepad++/Notepad)

    1. Replace the placeholder PATH_HERE with the full rooted path to the (drive):\meridix\dist\_webdeploypackage folder created in the previous step.

    2. Replace the placeholder NAME_HERE with the IIS Site name (default: Meridix) created in step 7.a.

    3. Save the updated bat file.

  10. Execute the deploy_webpackage.bat file with administrator rights (right-click > Run as administrator).

  11. Open the web application folder (defined in step 7.b)

    1. Rename the file NOT_SET.basic.config to basic.config

    2. Open basic.config in a text editor and change the following settings

      1. Change the connection string to target the meridix_sys database created in step 3 using the SQL Server Authentication login created in step 3.a.
        E.g. server=localhost;database=meridix_sys;integrated security=false;user id=meridix;password=meridix;

      2. Define a unique application id (Meridix.Studio.Application.Id) - Can be any value but should be system unique e.g. companyx.reporting etc.

      3. Change the value for the key Meridix.Studio.Enabled.Exchanges to the module-specific key. (See Appendix for available module keys.)

  12. Open a web browser and browse to the site created in step 7.

    1. The first time the application is started it might take a couple of minutes before it loads due to internal initialization operations, database schema updates, etc.

    2. If everything works as expected a login page will be loaded - Log in with the default credentials U: admin@meridix.se and P: ppn
      If you get an error message open the (drive):\meridix\webapp\App_Data\Logs folder under the web application folder and review the logs for more information about the error.

  13. Once logged in the system it can be module branded. If desired contact Meridix, or use the default branding.

  14. Configure the system by navigating to System administration → Application settings

    1. Define the System location (a descriptive name e.g. Module Reports) - This value will be used in initialization e-mails etc. to identify the system for end-users.

    2. Set the System public URL to the public/internal URI that the end-user will access the system through.

    3. Configure the SMTP server settings to use. Will be used for user initialization e-mails, report distribution etc.

    4. Verify that the security settings comply with the customers policy (minimum password lengths etc.).

  15. Enable the module by navigation to System administration → Module settings

    1. Expand the module specific section and check both the Loaded and Enabled check boxes.

    2. Define the connection string against the database that should be used as the report data source.

    3. Go the the Reports section in the menu and verify that you can see the module.

  16. The web application is now installed and configured.

  17. Install the (drive):\meridix\dist\VERSION_AND_DATE_ Meridix_Platform_Service_setup.msi (install it into the default directory specified in the MSI) and browse to the installation directory.

  18. Open the installation directory defined in the previous step and do the same configuration with the file NOT_SET.basic.config as described in step 10.b. Note that some properties are not available in the non-web context.

  19. Open the Meridix Studio Service Administration GUI from the start menu and start the windows service through the GUI.

    1. If it does not start successfully review the log files in the Logs folder under the installation directory.

  20. The back-end service is now installed, configured and started.
    (It will load additional settings such as SMTP etc. from the same source as the web application).

  21. Next step is to create the API ticket/credentials used to synchronize the catalog.
    Login into the Meridix Web UI and go to System Administration → System API Tickets

    1. Create a new API ticket called sync (or any other descriptive name)

    2. Check the admin rights checkbox under the newly created ticket and click save.

    3. The token and secret will be used in a later step.

  22. Extract the (drive):\meridix\dist\”Module”CatalogSyncClient_DATE.zip into the directory (drive):\meridix\”module”_catalog_sync

  23. Edit the file (drive):\meridix\”module”_catalog_sync\”Module”CatalogSyncClient.exe.config with a text editor.(“module” is the module chosen in previous steps)

    1. Set the connection string to a connection string pointing to the desired Database.
      E.g. server=localhost;database=database;integrated security=false;user id=meridix;password=meridix;

    2. Set the meridix:server_base_url to the Meridix Web UI URI e.g. http://localhost (defined in step 5.c)

    3. Set the meridix:server_token to the token created in step 19.

    4. Set the meridix:server_secret to the secret created in step 19.

    5. Set the module:customer_name to a descriptive customer name e.g. Company X.

    6. Set the module:customer_sync_id to a identifier that will be used to identify the customer in Meridix, this value needs to be unique and will not change. A good example is the customer domain or name e.g. companyx.com or companyx.

    7. Verify that the module:group_users is set to false unles a custom grouping should be used in the Meridix catalog.

    8. Execute the (drive):\meridix\”module”_catalog_sync\”Module”CatalogSyncClient.exe executable and verify that it runs successfully.

      1. Any errors are reported both in the console UI and in the sub folder Logs.

    9. After an successful execution log into the Meridix Web UI and verify that a new customer (tenant) is created and contains the queues, agents and ivrs defined in the ZyDB.

    10. Schedule an execution of the (drive):\meridix\”module”_catalog_sync\”Module”CatalogSyncClient.exe with Windows built in task scheduler with the interval(s) that the sync should be run (usually once every 24 hours).

  24. A Meridix system is now fully setup.


Upgrade an existing system

This section describe how to upgrade an existing system installed using the steps described in the section Install a new system (above).

  1. Retrieve the latest release from the Meridix partner SFTP.

  2. If there are a text file called upgrade_instructions.txt (or. md) in the release_DATE_HERE follow any custom instructions in that document (it has precedence over this content)

  3. Unzip the file (drive):\meridix\dist\VERSION_AND_DATE_meridix_studio_webdeploy_package.zip into a folder on the server called (drive):\meridix\dist\_webdeploypackage replacing any existing files in the target folder.

  4. Execute the the (drive):\meridix\dist\deploy_webpackage.bat file with administrator rights (right click and click Run as administrator).

  5. Open a web browser and browse to the Meridix login page.

    1. The first time the application is started after an update it might take a couple of minutes before it loads due to internal initialization operations, database schema updates etc.

    2. If everything works as expected a login page will be loaded - Log in with the default credentials U: admin@meridix.se and P: ppn
      If you get an error message open the (drive):\meridix\webapp\App_Data\Logs folder under the web application folder and review the logs for more information about the error.

  6. Uninstall the currently installed Meridix Studio Service through the control panel or through the old MSI - Note that this step will be removed once upgrade functionality is added to the setup (shortly).

  7. Install the (drive):\meridix\dist\VERSION_AND_DATE_meridix_studio_service_setup.msi (install it into the default directory specified in the MSI) and browse to the installation directory.

  8. Open the Meridix Studio Service Administration GUI from the start menu and start the windows service through the GUI.

    1. If it does not start successfully review the log files in the Logs folder under the installation directory.

  9. The system is now updated.


  • No labels

Webpage: www.meridix.se
Email: support@meridix.se
Tel: +46 (0) 21 38 30 32