Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

The purpose of this article is to guide you through the installation of the Meridix system.

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

...

Request the latest Web deployment, Import service and meridix_data.dacpac releases from operations@meridix.se.

...

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

Table of Contents

Prerequisites

Meridix Web Application, Meridix Studio Service, Meridix Backend services needs to be installed on a Windows Server 2012 or later with .NET Framework 4.7.x installed or later. The recommended minimum hardware is 4 CPU Cores and 8 GB RAM. The server needs to have network access to the Microsoft SQL Server-which hosts the system database and CDRs database.

Meridix Databases needs to be hosted on a Microsoft SQL Server 2012 or later (Express, Web, Standard or Enterprise edition).

The recommended minimum hardware is 4 CPU Cores and 16 GB RAM for Microsoft SQL Server.

Request the installation bundle from operations@meridix.se which include the following:

  1. meridix_studio_service_console_binaries.zip or MSI build

  2. meridix_studio_webdeploy_package.zip

  3. meridix_data.dacpac

  4. Theme zipped file.

  5. Meridix Sync Client with an installation guide for the required module.

Install a new system

You need to decide the hosting servers (Web Server, Database Server, and Application Server) and the following guides will assist you through the installation process on each server.

Table of Contents
excludePrerequisites|Install a new system|Upgrade an existing system|Appendix

Configuring_the_Database_Server

  1. Create an empty database named meridix_sys on the MSSQL server that should to host the MXSDB (Meridix Studio Database).

    Be ready to use
    1. Create a an SQL Server Authentication login  login and user with db_owner rights on the meridix_sys studio database.

  2. If using Zylinc do this step and skip step 5, otherwise jump to step 5.

    1. Note: The password for database users should not include the following characters: (<, >,&,",')

  3. Copy meridix_data.dacpac received from operations@meridix.semaster to the database server and do the following steps:

    1. Create an empty database named meridix_data on the MSSQL server that should to host MXDDB (Meridix Data database).

    2. Meridix_data> tasks> Register as data-tier application

    3. Meridix_data database > tasks > Upgrade Data-tier application > meridix_data.dacpac

    4. Create a an SQL Server Authentication login and user with db_owner rights on the meridix_data database.

Configuring the Web Server

  1. Extract the file VERSION_AND_DATE_meridix_studio_webdeploy_package.zip to (drive):\meridix\dist\

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

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

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

    2. In the IIS GUI, find IIS server Logging -> Actions. Press “disable” so the system drive will not be filled up with log files. If logging is needed for troubleshooting, enable logging temporarily or set a suitable drive or folder for the log files.

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

  5. Create a folder with the customer name and other two folders beneath the customer folder with the following names: meridixstudiomeridixstudio_service 

  6. 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)the folder you created in step 5 example C:\meridix\webappcustomer folder\meridixstudio

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

    Unzip the file 
    (drive):\meridix\dist\
    1. and port 443 and assign the right SSL certificate accordingly.
      It is mandatory to check on Require Server Name Indication if you have different SSL wildcards installed.

      Image Added

    2. In the hostname section, you write the full domain name. (Ex. reports.customer.se

    3. Add the domain name and server name in your DNS portal.

  7. Create a folder and name it, Ex. _webdeploypackage.
    Unzip the file VERSION_AND_DATE_meridix_studio_webdeploy_package.zip into a folder on the server called (drive)zip into a folder you created Ex. F:\meridix\dist\_webdeploypackage.Edit the BAT file (drive):\meridix\dist\

  8. Create an empty BAT file, name it deploy_webpackage.bat bat, edit it with a text editor (e.g. Notepad++/Notepad)

    1. Replace the placeholder PATH_HERE with Add the following command

      Code Block
      "PATH_HERE\meridix_studio_webdeploy.deploy.cmd" /Y -enableRule:DoNotDeleteRule "-setParam:name='IIS Web Application Name',value='NAME_HERE'"
    2. Replace the placeholder PATH_HERE in the above command with the full rooted path to the (drive)the folder you created in step 7 F:\meridix\dist\_webdeploypackage folder created in the previous step.

    3. Replace the placeholder NAME_HERE with HERE with the IIS Site name (default: Meridix) created in step 76.a.

    4. Save the updated bat file.

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

  10. Open the web application folder (defined in step 76.b)

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

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

      1. Change the connection string to target the meridix_sys database (created in step 3 1 under Configuring the Database server) using the SQL Server Authentication login (created in step 31.a.
        E.g. server=localhost under Configuring the Database server)
        Example:

        Code Block
        server=DbServer;database=meridix_sys;integrated security=false;user id=
        meridix
        DbUser;password=
        meridix
        DbPassword;
      2. Define a unique application id (Meridix.Studio.Application.Id) - Can be any value but should be system unique e.g. companyxcompanyX.reporting etc.Change the value for the key Meridix.Studio.Enabled.Exchanges to the module-specific key. (See Appendix for available module keys.)

  11. Open a web browser and browse to the site created in step 76.

    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 everything works as expected and a login page are loaded. If you get an error message open the (drive):\meridix\webapp\App_Data\Logs folder Logs folder under the web application folder and review the logs for more information . Contact support@meridix.se if you have any questions about the error.

  12. Once logged in, the system it can must be module branded. If desired contact Meridix, or use the default brandingcustom branded which is achieved by applying the default theme package or customer-specific theme.

    1. Read more on custom themes in the following link:

      Branding and theming  

    2. Upload the theme package example “Telepo_3_8_0_0.zip” to the website by navigating to system administration → Theme settings. Scroll down and press “Choose File” and locate your Theme file.

    3. Press “Upload theme package”

      Image Added
    4. Write the theme nameyou uploaded in the previous with no extension (Ex.Telepo_3_8_0_0 instead of Telepo_3_8_0_0.zip) under the “Theme name”.

      1. Make sure the Theme package type is set to the Theme package.

      2. Click on Save.

        Image Added
    5. Press Ctrl+Shift+R or Ctrl+F5 to make sure the new theme package content is loaded. (If that does not work, clear the browser cache manually).

    6. The UI should now have a specific theme look and feel instead of the default Meridix theme.

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

    1. Define the System location (a descriptive name e.g. Module Telepo/Customer 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 your policy (minimum password lengths etc.).

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

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

    2. Define the Add a connection string against the database that to the Data DB  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.


    4. Image Added
      Code Block
      Server=Server,1433;Database=Database;User ID=User ID;Password=Password;Trusted_Connection=False;Encrypt=True;Connection Timeout=30;
    5. Press Save Changes and click on Validate connection to check if the connection to the database is valid. Check your connection string values and the accessibility to the database server network if the connection fails.

      Image Added


  15. Configure the feature set from System Administration>Feature Set> Add new set. We define two sets, Basic, and Advanced as below: //Necessary to have this to make the installation? Maybe better to have just as a link? How to configure feature sets

...

The web application is now installed and configured.

...

Configuring Meridix Studio service

  1. Unzip the VERSION_AND_DATE_meridix_ Meridixstudio_Platformservice_Serviceconsole_setup.msi (install it into the default directory specified in the MSI) and browse to the installation directorybinaries.zip into the meridixstudio_service folder you created in step 5.

  2. 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 contextand add the same connection string as in step 10.

  3. Open the Meridix Studio Service Administration GUI from the start menu and start the windows service through the GUI or explore the meridixstudio_service folder and start Meridix.Studio.Service.Console.exe and type + Enter

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

    2. Create a scheduled task to run Studio.Service.Console.exe with arguments /send every 10 minutes.

  4. 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).

  5. 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.

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

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

  8. 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;

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

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

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

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

  13. 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.

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

  15. 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.

  16. 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.

  17. 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)

    Add a System administrator user/s. (Ex. administrator@company.com) by navigating to Administration → users and press Add new user or follow the steps of Grant system level rights to a user (System administrator)

  18. Deactivate admin@meridix.se user

    Image Added
  19. ِِGo to System Administration->Property Management, add property force_https and set the value to True to enable https only. 

    Image Added
  20. You can rename the module name by following the article: /wiki/spaces/OS/pages/1349910576

  21. If you are in a different time zone than Sweden/Europe/CET, or your date exists in different time zone than your system then you need to update property management accordingly.
    Check the timezone values in TimeZones.
    Use case: the x-Customer system receives the CDRs call in CET time zone and needs to show it in the GMT zone, configure the properties in the property management as the following:

    Image Added

    Go to System Administration > Application settings and change the default timezone for new users to GMT.

    Image Added
  22. Provide Technical contact person information to Operations@meridix.se.

Configuring the Application Server

  1. Follow the guide on /wiki/spaces/OS/pages/1413218305 To configure Meridix Import Service.

  2. Install the Sync application and following the guidelines comes with it.

  3. In case you update the time zone in the application, edit the sync application config file and add the following key but replace System Time Zone to the correct time zone.

    Code Block
    <add key="default_time_zone" value="System Time Zone"/>

    The above key will update the customers to the chosen time zone. The time zone list is available at TimeZones.

A Meridix system is now fully

...

set up.

Upgrade an existing system

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

  1. Backup the current system files. 

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

  3. If there are is 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)

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

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

  6. 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
      your credentials. 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.

  7. 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).

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

  9. 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.

  10. The system is now updated.console_binaries.zip into the folder called Customer\meridixstudio_service.

  11. Check Meridix studio if the studio service is running.

The system is now updated.

Appendix

Available modules :

  • TelepoBCS

  • Centrex

  • Broadworks

  • Businessphone

  • Cisco

  • Cs1000

  • Intelligate

  • Lg

  • Mxone

  • Nec

  • Servit

  • Trio

TimeZones

Expand
titleA

Afghanistan Standard Time

Alaskan Standard Time

Arab Standard Time

Arabian Standard Time

Arabic Standard Time

Argentina Standard Time

Atlantic Standard Time

AUS Central Standard Time

AUS Eastern Standard Time

Azerbaijan Standard Time

Azores Standard Time

Expand
titleB

Bangladesh Standard Time

Expand
titleC

Canada Central Standard Time

Cape Verde Standard Time

Caucasus Standard Time

Cen. Australia Standard Time

Central America Standard Time

Central Asia Standard Time

Central Brazilian Standard Time

Central Europe Standard Time

Central European Standard Time

Central Pacific Standard Time

Central Standard Time

Central Standard Time (Mexico)

China Standard Time

Expand
titleD

Dateline Standard Time

Expand
titleE

E. Africa Standard Time

E. Australia Standard Time

E. Europe Standard Time

E. South America Standard Time

Eastern Standard Time

Egypt Standard Time

Ekaterinburg Standard Time

Expand
titleF

Fiji Standard Time

FLE Standard Time

Expand
titleG

Georgian Standard Time

GMT Standard Time

Greenland Standard Time

Greenwich Standard Time

GTB Standard Time

Expand
titleH

Hawaiian Standard Time

Expand
titleI

India Standard Time

Iran Standard Time

Israel Standard Time

Expand
titleJ

Jordan Standard Time

Expand
titleK

Kamchatka Standard Time

Korea Standard Time

Expand
titleM

Mauritius Standard Time

Mid-Atlantic Standard Time

Middle East Standard Time

Montevideo Standard Time

Morocco Standard Time

Mountain Standard Time

Mountain Standard Time (Mexico)

Myanmar Standard Time

Expand
titleN

N. Central Asia Standard Time

Namibia Standard Time

Nepal Standard Time

New Zealand Standard Time

Newfoundland Standard Time

North Asia East Standard Time

North Asia Standard Time

Expand
titleP

Pacific SA Standard Time

Pacific Standard Time

Pacific Standard Time (Mexico)

Pakistan Standard Time

Paraguay Standard Time

Romance Standard Time

Expand
titleR

Russian Standard Time

Expand
titleS

SA Eastern Standard Time

SA Pacific Standard Time

SA Western Standard Time

Samoa Standard Time

SE Asia Standard Time

Singapore Standard Time

South Africa Standard Time

Sri Lanka Standard Time

Syria Standard Time

Expand
titleT

Taipei Standard Time

Tasmania Standard Time

Tokyo Standard Time

Tonga Standard Time

Expand
titleU

Ulaanbaatar Standard Time

US Eastern Standard Time

US Mountain Standard Time

UTC

UTC+12

UTC-02

UTC-11

Expand
titleV

Venezuela Standard Time

Vladivostok Standard Time

Expand
titleW

W. Australia Standard Time

W. Central Africa Standard Time

W. Europe Standard Time

West Asia Standard Time

West Pacific Standard Time

Expand
titleY

Yakutsk Standard Time