Install a new system

...

You need to decide the hosting servers (Web Server, Database Server, and Application Server) before you start with the following steps:

1. Download Meridix Studio (meridix_studio_service_console_binaries.zip or MSI build, meridix_studio_webdeploy_package.zip) from TeamCity.meridix.se Master version.

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

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

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

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

5. Be ready to use

   1. If it is an Azure Database then check the Appendix on how to create the user for Azure SQL Database. Ask operations@meridix.se under which database pool/ database server will host this database. 

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

6. Download meridix_data.dacpac received from operations@meridix.semaster version from TeamCity under Meridix Studio

   1. Create an empty database named meridix_data on the MSSQL server that should host MXDDB.

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

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

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

7. Install On Web hosting server, Windows Server 2019 or earlier install Microsoft .NET 4.7 or later on Windows Server 2016 or earlier (https://www.microsoft.com/net/download/framework). On Windows Server 2019 has 2016 or later .NET 4.7.2 + is already installed.

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

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

9. Install IIS Web Deploy 3.5 or later from the following link (included in the (drive):\meridix\dist\ folder or http://www.iis.net/downloads/microsoft/web-deploy)

10. Create a folder with the customer name and other two folders beneath the customer folder with the following names: meridixstudio, meridixstudio_service 

11. 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):\meridixcustomer folder\webappmeridixstudio

    3. Bind it to port 80 (or any other port) and port 443 and assign the right SSL certificate. Mandatory to check on Require Server Name Indication if you have different SSL wildcards installed .

       Image Added

    4. In the hostname section, you write the full domain name provided by the customer Ex. reports.customer.se (you need to ask the customer to point the domain name to our web-hosting server) or add it as our subdomain Ex. customer.meridix.se (ask operations@meridix.se to add the domain name and server name in DNS portal) 

       If the customer needs to add their own domain then always ask the customer point external domain eg report.customer.com to CustomerName.meridix.se that points to nodexx.meridix.se or IP etc.

       So that we can move them to another server without them having to change their DNS.

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

13. Edit the Create a BAT file (drive):\meridix\dist\deploy_webpackage.bat bat and edit it with a text editor (e.g. Notepad++/Notepad)

    1. Add the following command

       
       

       Code Block
       "F:\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 with HERE with the full rooted path to the (drive):\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 79.a.

    4. Save the updated bat file.

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

15. Open the web application folder (defined in step 9.b)

    1. Open the web application folder (defined in step

    7

    1. 9.b)

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

    3. 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 using the SQL Server Authentication login created in step 3.a.
          E.g.  
          

          Code Block
          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. companyxcompanyX.reporting etc.

       3. Change Set TelepoBcs as the value for the keyMeridix Meridix.Studio.Enabled.Exchanges to the module-specific key. (See Appendix for available module keys..(Only if you need Telepo Module activated)

16. Open a web browser and browse to the site created in step 79.

    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 Logs folder under the web application folder and review the logs for more information about the error.

17. 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, check with the development team first.

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

       Branding and theming  

    2. Upload the Telepo_3_8_0_0.zip found in the below SharePoint link: 

       https://meridix.sharepoint.com/:u:/g/Company/EbYG9qY9SL1EtDOJ9s4APjUB7XtLGDo9vGs6JfcM-aFNjg?e=8XcahC

    3. Change the Theme name to zip and make sure the Theme package type is set to the Theme package. Click on Save.

    4. Click save and hit 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).

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

       Note: The customer’s custom theme settings must be configured the same as the above example.

18. 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. (Check with the customer if they have SMTP server otherwise, use Meridix SMTP server settings)

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

19. Enable the Telepo BCS (or the required module) module by navigation to System administration → Module settings

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

    2. Define the connection string against the database that 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. Code Block
       Server=SERVER,PORT; Database=DATABASE; Integrated security=False; User id=USER; Password=PASSWORD;

       Security Tip

       Alternatively, you can add the connection string in the basic.config file edited in step 13 under web application and in the in Step 20 for Studio service basic.config folder in the Webhosting server under <AppSettings> instead of having it accessible by System administrators in Meridix Web Studio under Modules

       Image Added

       Code Block
       <add key="exchange.telepobcs.connectionstring" value="Server=SERVER,PORT; Database=DATABASE; Integrated security=False; User id=USER; Password=PASSWORD;" />

    5. Click on Validate connection to check if the connection to the database is valid 

    6. Check on Loaded and Enabled then save the changes.

20. Configure the feature set from System Administration>Feature Set> Add new set. We define two sets, Basic, and Advanced as below:

    •  

21. The web application is now installed and configured.

22. Install the meridix_studio_service downloaded in STEP 1  (drive):\meridix\dist\VERSION_AND_DATE_ Meridixmeridix_Platformstudio_Serviceservice_setup.msi msi

    1. ((install it into the default directory specified in the MSI) and browse to the installation directory preferably next to the web application folder created in step 9.b.)

    2. Alternatively, you can unzip the xxxxxxx_meridix_studio_service_console_binaries.zip into the meridixstudio_service created in step 8

23. 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 1013.b. Note that some properties are not available in the non-web context.

24. 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 S + 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.

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

26. 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 Telepo/Customer 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.

27. Extract the (drive):\meridix\dist\”Module”CatalogSyncClientCatalogSyncClient_DATE.zip into the directory (drive):\meridix\”module”Telepo_catalog_sync

28. Edit the file (drive):\meridix\”module”Telepo_catalog_sync\”Module”CatalogSyncClientCatalogSyncClient.exe.config with 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;Set the meridix:server_base_url to the Meridix Web UI URI e.g. http://localhost (defined in step 5.cthe telepo_base_url to the IP address of the management node.

    1. Set telepo_token and Telepo_secret to access the management node (provided by customer)

    2. Set the meridix:server_token to the token created in step 1920.

    3. Set the meridix:server_secret to the secret created in step 1920.

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

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

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

    7. Execute the (drive):\meridix\”module”Telepo_catalog_sync\”Module”CatalogSyncClientTelepoCatalogSyncClient.exe executable and verify that it runs successfully.

    8. Any errors are reported both in the console UI and in the

       sub folder

       subfolder Logs.

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

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

29. Add a System administrator user/s. Ex. Johan@meridix.se.

30. Deactivate admin@meridix.se user

31. Under System Administration add property force_https and value True to enable https only. 

32. If the customer wishes to have a module name other than the default see article : Rebrand Modules to customer preferences

33. Confirm the time zone settings with the customer, if they are in different time zone than Sweden/Europe then you need to update property management and Sync config file accordingly.
    Example: Marleycomms system must show in the GMT zone, the data and the organizations we import from Soluno are saved in Europe time zone so we configured the properties in the property management as the following:

    Edit the sync application config file and add the following key:

    Code Block
    <add key="default_time_zone" value="GMT Standard Time"/>

    The above key will update the customers to the GMT zone and the time zone list is available at
    https://stackoverflow.com/questions/7908343/list-of-timezone-ids-for-use-with-findtimezonebyid-in-c

34. A Meridix Telepo system is now fully setup.set up.

35. Add a monitor check (OP5 or Meridix monitor) for the newly created studio. 

36. Add the information for this customer to the System List and CRM.

37. Create a folder for this customer in Sharepoint under \Company - Dokument\Customers\ and save all related materials there. 

38. Inform the customer to provide us with the current version of MiCloud Telepo and to inform us as well as include us in the upgrading process.

Image AddedImage AddedImage AddedImage AddedImage Added

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 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
      If ppnIf 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. If it does not start successfully review the log files in the Logs folder under the installation directory

   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.

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

   console_binaries.zip into the folder called Customer\meridixstudio_service.

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

10. Update Meridix version for this customer in System List, and a monitor check (OP5 or Meridix monitor) if not exist.

11. The system is now updated.

12. Inform the customer about the fixed bugs or newly added features when it is relevant.