Installation

Installation Matrix#

Prudle Studio translation management portal( P-TMS) is an IIS based application which can be installed on Microsoft Windows Server 2016 or higher.

Prudle Studio Portal can also be installed on IIS server running on Windows 7, 8 and 10. However, Prudle Labs recommends to use Microsoft Windows Server in production environment.

Component Operating System Database Build Server Web Server Installation Type
Prudle-I18N Windows 2007 N/A Jenkins 1.0.2 or higher N/A On-premise
Windows 2008 N/A Jenkins 1.0.2 or higher N/A On-premise
Linux - Ubuntu 16.04 or higher N/A Jenkins 1.0.2 or higher N/A On-premise
Prudle-I18N VS Plugin Visual Studio 2015 N/A N/A N/A On-premise
Visual Studio 2015 N/A N/A N/A On-premise
Prudle Studio Portal MySQL 8.0 or higher N/A N/A IIS 8.0 or higher On-premise

System Architecture#

A typical system architecture for P-TMS on-prem installation looks like the following diagram -


Installing P-TMS#

To use Prudle-I18N module with local on-premises deployment of report server following are the prerequisite :

  1. Window server 2016 with minimum 4GB RAM with Processor 2.40GHz, 2394 Mhz, 2 Core(s) or equivalent.
  2. Prudle-I18N Report Server is an IIS based application hence it is advised to enable IIS configuration before installing report server.
  3. MySQL 5.5 and above database is required to store User Management and I18N Scan Reports.
  4. Local or remote installation of MySQL database.
  5. Local or remote installation of MySQL database.
    • Any configuration of system where Google Chrome is running or can be run.

Follow the following steps to install Prudle report server in your local environment :

Prerequisite:-
  • MySQL database installed and running either on same hardware or remote server. In case MySQL is installed remotely, make sure that it is accessible from the server where you are installing report server.
  • IIS is enabled on the server. You can do that from 'Program and Features' in 'Control Panel' of your window server.
Installation Steps:-
  1. Download report server installer from your download page at Prudle Customer page - PrudleReportServer.msi.
  2. Install the PrudleReportServer. On succesfull installation, run the newly installed application which run as installation wizard to help you set the application on local IIS.
  3. Click on " New Installation" button to deploy a new instance of Prudle Portal on IIS ( Internet Information Services).
  4. Provide unique Website Name and Port Number.
  5. Click on "Create Website" button which will perform a website deployment on local IIS
  6. In this case, Website Name is Prudlelabs_User and Port Number is 96.
  7. Once the website is created successfully, next step is to connect to MySQL instance and initialize required database :-
    • Server Name
    • Port Number
    • Username
    • Password
    In this case username will be root and password is abcd1234
  8. After configuring MySQL click on "INITIALIZE DATABASE"
  9. Once the database is successfully initiated, success message will display on user's screen.

    After installation configure email related config in web.config

                                              
                                             <add key="username" value="" />
                                                <add key="password" value="" />
                                                    <add key="portno" value="" />
                                                
                                             
                                            
  10. Copy the url http://localhost:96/account/login and paste it in browser. Prudle's Login Page will open
  11. User now have to register as a first user by clicking on "Sign Up" button.
  12. At registration step, fill up the required information which will be used at the time of Sign-in.
  13. Click on "Next" button
  14. Select role from drop-down which user assigned to himself while signing-up. In case of I18N user select "Organization" role and click on "Register" button.
  15. Congratulations !! You have successfully registered. Now user can login with the valid credentials which was used at the time of registration.
  16. User will get licence related error message if licence is not present in the website folder. Licence.lic file can be downloaded from the download section.
  17. User will get licence related error message if licence is not present in the website folder. Licence.lic file can be downloaded from the download section
  18. After downloading the licence, create a new folder naming "Licence" in this path of folder "C:\inetpub\wwwroot\Prudlelabs_User\appviews" and paste it.
  19. Once license folder is created and .lic file is copied user can now Sign-in. After Sign-in, user will be asked for to update login credentials.
  20. After successfully updating the details, user now signed- in as an Organization user.
  21. User can create a new project by clicking on "Create Project" button.
  22. Application is now ready to use. Configure PrudleConfig.xml accordingly and user should be able to access reports on local server.
  23. If administrator user don't have access to P-I18N or P-TMS after logging into the portal then update the valid Licence file by replacing old licence file in this folder : C:\inetpub\wwwroot\Prudlelabs_User\appviews\Licence

Configure TM and NLP API#

To use Prudle-TMS Python TM and NLP api Please follow this prerequisite:
  1. Enable CGI in IIS Manager and enable all option under Application Development. Open server manager and enable CGI option in ADD ROLES AND FEATURE WIZARD as follows:
  2. Install MySQL Community Latest Version (after Installation setup my sql server with some user and password)
  3. Install Latest Python Version and also check include in Path Variable while starting installing.
  4. While installing on first window after double clicking the exe remember to select the check box for automatic setting the path variables. After Python make sure installed folder have Full control permission for IIS_IUSRS.
  5. Download and Install Visual C++ build Tool
  6. After installation python install all supported python library as mention below
  7. Make sure have the latest pip
    • python.exe -m pip install --upgrade pip
    Install wfastcgi :
    • p pip3 install wfastcgi
    Install below required python library:
    • Pandas: pip3 install pandas
    • numpy: pip3 install numpy
    • nltk.corpus : pip3 install nltk (now for downloading every dependencies of nltk)
    • Open cmd type Python (ENTER) Write bellow lines:
      • import nltk
      • import nltk
    • pprint: pip3 install pprintpp
    • re2: pip3 install re2
    • glob: pip3 install glob2
    • json: pip3 install jsonlib --- ERROR
    • flask_caching: pip3 install Flask-Caching
    • flask: pip3 install Flask
    • configparser: pip3 install configparser
    • MySql: pip3 install mysql
    • MySql Connector: pip3 install mysql-connector-python
  8. Fast CGI setting under IIS
  9. Add FastCGI application Setting under IIS
  10. Now Place web.config under respected python api folder with proper python and wfastcgi path
  11. For TMAPI:

    Folder Path: C:\inetpub\wwwroot\TMAPI

    web.config

    After installation configure email related config in web.config

                                    
                                        <?xml version="1.0" encoding="UTF-8"?>
                                        <configuration>
                                        <system.webServer>
                                        <handlers accessPolicy="Read, Execute, Script">
                                        <add name="TMapi_Handler" path="*" verb="*" modules="FastCgiModule" scriptProcessor="C:\Users\Administrator\AppData\Local\Programs\Python\Python38\python.exe|C:\Users\Administrator\AppData\Local\Programs\Python\Python38\Lib\site-packages\wfastcgi.py" resourceType="Unspecified" requireAccess="Script" />
                                        </handlers>
                                        </system.webServer>
                        
                                        <appSettings>
                                        <!-- Required settings -->
                                        <add key="WSGI_HANDLER" value="api.app" />
                                        <add key="PYTHONPATH" value="C:\inetpub\wwwroot\TMAPI" />
                                        </appSettings>
                                        </configuration>
                                    
                                 
                                

After placing web.config make sure folder have Full control permission for IIS_IUSRS.

For NLP PythonAPI

Folder for Python API: C:\inetpub\wwwroot\NLPAPI

web.config

                                
                                    <?xml version="1.0" encoding="UTF-8"?>
                                    <configuration>
                                    <system.webServer>
                                    <handlers accessPolicy="Read, Execute, Script">
                                    <add name="NLPapi_Handler" path="*" verb="*" modules="FastCgiModule" scriptProcessor="C:\Users\Administrator\AppData\Local\Programs\Python\Python38\python.exe|C:\Users\Administrator\AppData\Local\Programs\Python\Python38\Lib\site-packages\wfastcgi.py" resourceType="Unspecified" requireAccess="Script" />
                                    </handlers>
                                    </system.webServer>
                    
                                    <appSettings>
                                    <!-- Required settings -->
                                    <add key="WSGI_HANDLER" value="I18N_API.app" />
                                    <add key="PYTHONPATH" value="C:\inetpub\wwwroot\NLPAPI" />
                                    </appSettings>
                                    </configuration>
                                
                             
                            

After placing web.config make sure folder have Full control permission for IIS_IUSRS.


Installing Database#

Setting Up the MySQL Database Server in the Windows Operating System.

The MySQL database server is one of the most popular open-source database servers commonly used in web application development.

Following are steps to set up the MySQL database server 5.7 versions in the Windows operating system.

Starting the Download
Starting the Installation

After the download completes, run the installer as follows:

  1. Right-click the downloaded installation file (for example, mysql-installer-community-5.6.14.0.msi) and click Run. The MySQL Installer starts.
  2. On the Welcome panel, select Install MySQL Products.
  3. On the License Information panel, review the license agreement, click the acceptance checkbox, and click Next.
  4. On the Find latest products panel, click Execute.
    When the operation is complete, click Next.
  5. On the Setup Type panel, choose the Custom option and click Next.
  6. On the Feature Selection panel, ensure MySQL Server 5.6.x is selected, and click Next.
  7. On the Check Requirements panel, click Next.
  8. On the Installation panel, click Execute.
    When the server installation is completed successfully, the information message appears on the Installation panel. Click Next.
  9. On the Configuration panel, click Next.
  10. At the first MySQL Server Configuration page (1/3), set the following options:
    • Server Configuration Type. Select the Development Machine option.
    • Enable TCP/IP Networking. Ensure the checkbox is selected and specify the options below:
      • Port Number. Specify the connection port. The default setting is 3306 - leave it unchanged if there is not special reason to change it.
      • Open Firewall port for network access. Select to add firewall exception for the specified port.
    • Advanced Configuration. Select the Show Advanced Options checkbox to display an additional configuration page for setting advanced options for the server instance if required.
  11. Click Next.

  12. At the second MySQL Server Configuration page (2/3), set the following options:
    • Root Account Password.
      • MySQL Root Password. Enter the root user's password.
      • Repeat Password. Retype the root user's password.
    • MySQL User Accounts. Click Add User to create a user account. In the MySQL User Details dialog box, enter a user name, a database role, and a password (for example, !phpuser). Click OK.
    • Click Next.

  13. At the third MySQL Server Configuration page (3/3), set the following options:
    • Windows Service Name. Specify a Windows Service Name to be used for the MySQL server instance.
    • Start the MySQL Server at System Startup. Leave the checkbox selected if the MySQL server is required to automatically start at system startup time.
    • Run Windows Service as. Choose either:
      • Standard System Account. Recommended for most scenarios.
      • Custom User. An existing user account recommended for advanced scenarios.

      Click Next.

  14. At the Configuration Overview page, click Next.
  15. When the configuration is completed successfully, the information message appears on the Complete panel. Click Finish.

Enabling License#