lpt logo platform tailorm.logobs.com/supporttest/images/documents/jguar/en/... · logo platform...

58
www.logo.com.tr Document No: LBS.UNO.G/O/LPT.001T.REV4 Document Type Training Document Subject LPT Installation Document Related Product LPT Contact: Önder YÜCEL Document Version: 004 Date: 04.09.2013 LPT LOGO PLATFORM TAILOR Development Platform Installation Document

Upload: others

Post on 20-Sep-2020

7 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

www.logo.com.tr

Document No: LBS.UNO.G/O/LPT.001T.REV4

Document Type Training Document

Subject LPT Installation Document

Related Product LPT

Contact: Önder YÜCEL

Document Version: 004

Date: 04.09.2013

LPT

LOGO PLATFORM TAILOR

Development Platform Installation Document

Page 2: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

2/58

CONTENT CONTENT .......................................................................................................................................................... 2 1. BEFORE Starting ......................................................................................................................................... 3 2. Version Upgrade .......................................................................................................................................... 5 3. LPT Development Platform Installation From Scratch ............................................................................ 6 4. Requirements ............................................................................................................................................... 6

4.1 How to obtain installation files ............................................................................................................. 6 4.2 How to obtain j-guar Solution Partner Set Key and Logosphere Registration .................................... 7 4.3 How to obtain Documents and Supplementary Resources ................................................................ 7 4.4 How to obtain Supplementary Tools ................................................................................................... 7 4.5 Support Process Definition .................................................................................................................. 7

5. Tomcat and Eclipse Installation Steps ...................................................................................................... 7 5.1 Apache Tomcat Server Installation: .................................................................................................... 7 5.2 Eclipse Installation ............................................................................................................................... 8 5.3 Eclipse.ini Setting: ............................................................................................................................... 8 5.4 Eclipse JRE Setting: ............................................................................................................................ 10 5.5 Installation of Eclipse LPT Plug-in Files: ............................................................................................. 11 5.6 Designating Eclipse workspace folder: ............................................................................................... 12 5.7 Installing j-guar EAR file on Eclipse: ................................................................................................... 13 5.8 ECLIPSE SETTINGS - Setting EAR classpath ................................................................................... 17 5.9 ECLIPSE SETTINGS / Adding JDK .................................................................................................... 19 5.10 ECLIPSE SETTINGS / Adding JDK / tools.jar .................................................................................... 21 5.11 ECLIPSE SETTINGS / JDK / Memory Settings .................................................................................. 22 5.12 ECLIPSE SETTINGS / JDK / Activation.............................................................................................. 23 5.13 ECLIPSE SETTINGS / JDK / Compiler 1.6 Selection ........................................................................ 23 5.14 ECLIPSE SETTINGS – Validation Settings ........................................................................................ 24 5.15 ECLIPSE SETTINGS – Apache Tomcat Settings ............................................................................... 26 5.16 ECLIPSE SETTINGS - Debug Configurations – Tomcat Settings ...................................................... 32 5.17 ECLIPSE SETTINGS - Debug Configurations – Tomcat Memory Settings........................................ 33 5.18 Preparing Programmer Parameters .................................................................................................... 35 5.19 Protecting Application Parameters in Version Upgrades .................................................................... 35

6. j-guar Installation Steps .............................................................................................................................. 36 6.1 Database Settings ............................................................................................................................... 36 6.2 j-guar Database Operations ................................................................................................................ 37 6.3 Creating System Tables: ..................................................................................................................... 37 6.4 License Installation Operations ........................................................................................................... 39 6.5 Creating Company Tables: ................................................................................................................. 41

7. Creating Customization Project and Settings .......................................................................................... 46 7.1 Creating LbsDefinitions.jar .................................................................................................................. 46 7.2 creating LPT Customization Project .................................................................................................... 47 7.3 LPT Customization Project / Adding LPT Library Files ....................................................................... 52 7.4 Copying necessary libraries for Controller operations ........................................................................ 53 7.5 LPT Customization Project / Properties / Java Build Path Setting ...................................................... 54 7.6 LPT Customization Project / Properties / Logo / Customization Setting ............................................. 55 7.7 LPT Customization Project / Properties / Logo / Customization / Deploy Setting .............................. 57 7.8 LPT Customization Project / Properties / Logo / Languages Setting .................................................. 57

Page 3: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

3/58

1. BEFORE Starting

In order to prevent any complication in settings, we strongly recommend performing the following steps before starting to use this application whether it is version upgrade or initial installation you want to perform.

Deleting LFS Cache files: Open Start / Run > enter %Temp% > delete LFS folder.

Deleting Java Cache files: Delete java temp files using Control Panel / Java / General / Settings / Delete Files option.

Deleting Executable Jar files under Temp folder: If there are files of “Executable Jar File” type in File %Temp% directory, delete these files.

SQL Server TCPIP Controls: If your SQL Server is already installed, we recommend checking the following settings since we usually encounter problems concerning this issue.

Page 4: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

4/58

After installing SQL Server 2008 R2 Express Edition, TCP/IP connections are disabled by default. Move to the next tab after selecting Enabled value as "Yes" in Protocol tab.

Common settings can be done for physical and virtual hardware under IP Addresses > IP All option. Value of TCP Dynamic Ports key should be deleted, and the port value below should be set as the port value where you want to run SQL Server. (Default value is 1433.) In order to validate these settings, restart SQL server. In order to do so, right click the relevant SQL Server instance name under SQL Server Services option.

Page 5: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

5/58

2. Version Upgrade

j-guar version upgrade means that you need to delete the application and reinstall. Accordingly, first you need to check if there are important files or back-ups in application folders. If there are, you need to save them before upgrading.

Page 6: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

6/58

3. LPT Development Platform Installation From Scratch

Applications and tools that are used to prepare development platform apart from LPT and j-guar product require no charge for license. Generally they can be run by copying. Accordingly, in this document, we will setup development platform with simple copy operations and a few settings. Though it may seem a little complicated if you are new at this, in time you will see that it is actually a quite simple process based upon consecutive steps in a rational order. You will setup your development platform smoothly if you follow our instructions step by step.

4. Requirements

Installed Database (Oracle, MSSQL, etc.)

Java JDK (1.6 and later)

Java JRE (1.7)

Apache Tomcat (v6.0)

Eclipse Kepler

Eclipse LPT Plug-in (Up-to-date)

LPT Library Files

EAR file for j-guar set installation (Up-to-date)

j-guar source codes (Up-to-date)

j-guar Solution Partner set key (new)

Logosphere user code and password

Logosphere dealer password

4.1 How to obtain installation files

Java JDK (1.6 and later) ftp://download.logo.com.tr/Java/jguar/JDK_JRE/

Java JRE (1.7) ftp://download.logo.com.tr/Java/jguar/JDK_JRE/

Apache Tomcat (v6.0) ftp://download.logo.com.tr/Java/jguar/ApacheTomcat/

j-guar EAR (Up-to-date) ftp://download.logo.com.tr/Java/jguar/JGuar_Versions/

j-guar source code (Up-to-date) ftp://CustomizationFiles:[email protected]/j-guarSources/

Eclipse Kepler ftp://CustomizationFiles:[email protected]/EclipseIDE/

Eclipse LPT Plug-in (Up-to-date) ftp://CustomizationFiles:[email protected]/LPTPlugins/

LPT Library Files ftp://CustomizationFiles:[email protected]/Tools/

NOTE : One thing you must pay attention in your development platform is that JavaSDK / JDL and JRE are on the same platform as Eclipse. Both must be 64 or 32 bit. Tomcat can be different.

NOTE : You can use http://www.eclipse.org/downloads/ address to access up-to-date Eclipse javaEE developer versions. NOTE : You can use http://www.java.com/tr/download/windows_offline.jsp address to access up-to-date JDK and JRE versions.

Page 7: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

7/58

4.2 How to obtain j-guar Solution Partner Set Key and Logosphere Registration

Your j-guar Solution Partner set key and LogoSphere dealer user information will be given to you by

Vertical Solutions Sales Specialist, Ersin DÜREN ([email protected]) with whom you will conduct your JAVA Solution Partnership process. If you have not received necessary info after you complete your training registration, please contact him. You need to complete all your installations before training.

This Key will not be sent to you in an installable format. You will need to connect Logosphere

environment and import your key for inter-corporate use and approve it. These steps will be explained for you in detail.

4.3 How to obtain Documents and Supplementary Resources

j-guar Documents ftp://CustomizationFiles:[email protected]/Docs/j-guar_Docs

LPT Documents ftp://CustomizationFiles:[email protected]/Docs/LPT_Docs

LPT Sample Projects ftp://CustomizationFiles:[email protected]/Docs/LPT_SampleProj

4.4 How to obtain Supplementary Tools

j-guar supplementary tools ftp://download.logo.com.tr/Java/Tools/

j-guar installation wizard ftp://download.logo.com.tr/Java/jguar/JGuar_Installer/

4.5 Support Process Definition

You can ask help from Sales Specialist, Ersin Düren ([email protected]) from Vertical Solutions and

Solution Partners department about Trainings, Solution Partner set key, Solution Partnership process and Logosphere registrations.

Product Support Specialist, Özgür Arda AKYILDIZ ([email protected]) from Open Platform Product

Support department will help you on j-guar product installation. You can contact Customization Tools Support Team Leader, Önder Yücel ([email protected]) from

Vertical Products and Solution Partners department about any technical questions, problems or any need of yours on LPT.

5. Tomcat and Eclipse Installation Steps

5.1 Apache Tomcat Server Installation:

As shown below, Apache Tomcat file opens in the relevant installation directory.

Page 8: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

8/58

NOTE : You can delete zip file after opening the file.

5.2 Eclipse Installation

Eclipse 3.7.0 Indigo.rar file opens in the relevant installation directory as shown below.

NOTE : You can delete zip file after opening the file.

5.3 Eclipse.ini Setting:

While working with Eclipse, you may experience problems occurring due to memory settings. In order to

prevent them, we recommend the following memory settings. While installing for the first time, you'd find it useful to check the following parts given in bold in Eclipse folder > Eclipse.ini file, and add them if they are missing.

Page 9: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

9/58

-startup plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar --launcher.library plugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.100.v20110502 -product org.eclipse.epp.package.jee.product --launcher.defaultAction openFile --launcher.XXMaxPermSize 256M -showsplash org.eclipse.platform --launcher.XXMaxPermSize 256m --launcher.defaultAction openFile -vmargs -Duser.language=en -Dosgi.requiredJavaVersion=1.6 -Xmn128m -Dhelp.lucene.tokenizer=standard -XX:PermSize=256m -Xss4m -Xms396m -Xmx1024m veya -Xmx1512m If you forget Eclipse.ini vmargs settings, you may receive the following error message while importing ear.

Page 10: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

10/58

5.4 Eclipse JRE Setting:

In standard use, add "C:\Program Files\Java\jdk1.x.x\bin\" folder (it will change accordingly based on 32 or 64 bit) to path variable in Computer's general environment variables. One thing you must pay attention in your development platform is that JavaSDK (JDK and JRE) are on the same platform as Eclipse IDE. Both must be 64 or 32 bit. Tomcat can be different. If your JDK or JRE files are incompatible with IDE, or Eclipse cannot access these files, the following error message usually pops up when Eclipse is started.

The following steps can be applied as a solution.

METHOD 1: REINSTALLING JAVA APPLICATION

This error may occur due to missing record file settings. After removing Java application in your computer, setup Java Runtime offline version and solve your problem.

METHOD 2: ENVIRONMENT VARIABLES

Download jvm.dll file that is compatible with 32 or 64 bit platform.

Copy this dll file to C:/Windows/System32 folder.

Right click My Computer and select Properties. Click Advanced tab > Environment

Variables.

Search for Path variable. If there is, click Edit, and write directory of your dll file

(C:/Windows/System32;) at the end of the Variable value. If there isn't a Path variable,

create one and write directory address as value.

After these changes, you need to restart your computer.

METHOD 3: PROBLEMS OCCURRING DUE TO PLATFORM DIFFERENCES

If compatible architectures of your JDK and Eclipse are different (x86 / x64), you may encounter this problem. Please download and install a compatible version by viewing information given in How to obtain installation files heading.

Page 11: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

11/58

5.5 Installation of Eclipse LPT Plug-in Files:

Eclipse LPT plug-in is generated with each j-guar set. Eclipse LPT plug-in consists of 4 jar files. These files are:

com.lbs.client_ 2.17.4.1.jar

com.lbs.commons_ 2.17.4.1.jar

com.lbs.customization_ 2.17.4.1.jar

com.lbs.xui.designer_ 2.17.4.1.jar

NOTE 1 : Numbers suffixed to the file names indicates the relevant version. These numbers change with every set. NOTE 2 : “com.lbs.sql.editor_ 2.17.4.1.jar” file is removed from the content of plug-in files in 2.25 and later versions.

These files are copied under Eclipse folder (which we installed in the step 1) under plugins path. (Example: D:\2.17.9.2\Eclipse 3.7.0 Indigo\eclipse\plugins). If there are jar files belonging to the previous version under this directory, they must be deleted.

Page 12: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

12/58

NOTE : Plugin versions do not need to be fully compatible with j-guar version!

5.6 Designating Eclipse workspace folder:

Eclipse is started by right clicking eclipse.exe located in D:\2.17.9.2\Eclipse 3.7.0 Indigo \eclipse and

selecting “Run as administrator” option. The following settings are recommended in order not to encounter any problems.

After setting compatibility, define a shortcut for Eclipse.exe file and open it with -clean parameter as

shown below.

Page 13: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

13/58

While opening Eclipse, the Launcher window above opens. You need to select a folder which you will

use as workspace (example: D:\2.17.9.2\workspace). All of your work will be kept in this folder. Select a folder and click OK button. (A folder named workspace should be created in installation directory beforehand.)

5.7 Installing j-guar EAR file on Eclipse:

You need to run Eclipse and follow the steps below to perform this transaction.

Page 14: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

14/58

Select your EAR file using Browser button in this step.

After selecting EAR, click Next without making any changes.

Page 15: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

15/58

Click Next without making any changes.

Click Finish without making any changes.

NOTE : You can delete EAR file after completing installation.

Page 16: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

16/58

Click OK to approve warning message which will pop up after clicking Finish. Then delete the file named "lbsconfiguratorgwt" under Logo > WebContent. There could be different problems about Logo project. We need to continue our process without focusing on these since they will not affect our work and compilation.

Page 17: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

17/58

5.8 ECLIPSE SETTINGS - Setting EAR classpath

Select Logo menu > Prepare jGuar Workspace while logo is selected.

You need to select the relevant directory in which .src.zip files required for source attachment are kept, and then click OK.

Before 2.23 version, j-guar source codes were provided in the following files. Now, all you need to do is to obtain Platform_v2.25.5.0.src and Unity_v2.25.5.0.src files and copy them to the relevant folder.

Previous j-guar source code files are:

LbsData.Client.src.zip

LbsXUI.src.zip

LbsXUIParser.src.zip

Unity.src.zip

New j-guar source code files are:

Page 18: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

18/58

Platform_v2.25.5.0.src

Unity_v2.25.5.0.src

After seeing this window, you need to refresh logo project fully, which means that you right click and select Refresh while logo is selected.

If “Prepare jGuar Workspace” is performed properly, you can see that the above mentioned 4 source

codes are properly attached when you check logo project referenced Libraries with Package Explorer. We expect icons to change as below. This will indicate that java files are related to the relevant classes

and we can view and debug the relevant parts.

Page 19: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

19/58

This operation will also add 3 definitions (shown below) under the “Debug Configurations/Java Applications” definitions.

5.9 ECLIPSE SETTINGS / Adding JDK

Open the relevant window by clicking Preferences as shown below.

Select “Installed JREs” in Preferences window.

Page 20: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

20/58

Click Add button on the right side. Select Standard VM and click Next.

Click Directory button on the right and select installed JDK 1.6 version from “C:\Program Files\Java”

as shown below, and then click OK.

Page 21: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

21/58

5.10 ECLIPSE SETTINGS / Adding JDK / tools.jar

Click Add External JARs button, and select tools.jar from lib folder in JDK 1.6 (select in the picture above).

Page 22: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

22/58

Move “tools.jar” to the top using Up button as shown below.

5.11 ECLIPSE SETTINGS / JDK / Memory Settings

After moving “tools.jar” to the top, "Default VM Arguments" is changed as below. Add this expression: -Xmx512m -XX:MaxPermSize=384m

Page 23: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

23/58

5.12 ECLIPSE SETTINGS / JDK / Activation

After clicking Finish button, JDK 1.6 will appear as checked as shown below.

5.13 ECLIPSE SETTINGS / JDK / Compiler 1.6 Selection

After this step, go to Java > Complier section and select 1.6 for Complier Compliance Level and then

click OK. Click Yes button in prompt window to start built operation.

Page 24: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

24/58

5.14 ECLIPSE SETTINGS – Validation Settings

After completing these steps, go back to Window >Preferences and Validation settings. First, you

need to remove selections and select only the following settings.

DTD Validator

XML Schema Validator

XML Validator

Page 25: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

25/58

After selection, click Yes button in prompt window and wait for project validation to complete.

Page 26: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

26/58

5.15 ECLIPSE SETTINGS – Apache Tomcat Settings

Click Add button in Window > Preferences menu Server > Runtime Environment settings.

Page 27: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

27/58

Select Apache Tomcat v6.0 in this window as shown below. Check “Create a local server” option and

click Next button.

Page 28: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

28/58

Click “Browse” button in this window and select Apache Tomcat folder which you have located under

“D:\2.17.9.2” directory in Apache Tomcat Server Installation heading. Click Finish button.

Page 29: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

29/58

After these steps, click OK button in window shown below.

Select Servers tab located in the bar of tabs at the bottom of Eclipse. Double click your server and the

following window will open.

Page 30: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

30/58

Select “Serve modules without publishing” option. After this step, right click your server and select

“Add and Remove...” option.

Select logo in this window and then click on "Add >" button. Click Finish button to complete transaction.

Page 31: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

31/58

Click “Modules” tab to view the project you will run in your server.

Finally, select logo in Modules page and click Edit button. Uncheck “Auto reloading enabled” option in Edit Web Module window, and server settings will be completed.

Page 32: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

32/58

5.16 ECLIPSE SETTINGS - Debug Configurations – Tomcat Settings

After this transaction, right click your server in Server tab and select Debug option.

You can check and see whether Server has started in Console or Servers tab.

After starting server, open “Debug Configurations” window.

Page 33: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

33/58

Click Apache Tomcat > logo > Arguments tab. Here you will see that “VM arguments” field is created

automatically after server is started.

5.17 ECLIPSE SETTINGS - Debug Configurations – Tomcat Memory Settings

After creating “VM arguments”, you will add the following expression given below and click Apply button.

Page 34: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

34/58

Add this expression: -Xmx512m -Xms512m -Duser.language=en -Duser.region=US NOTE : As of 2.19.2.0 version, -Duser.language=en -Duser.region=US expression is also added. As for TomCat which is run externally from Eclipse, you should add -Duser.language=en -Duser.region=US codes to the end of “set JAVA_OPTS= ....” line in Startup.bat.

After completing these transactions, you need to restart your server as shown below.

Page 35: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

35/58

5.18 Preparing Programmer Parameters

This product is installed from a standard installation file. We install the product in our customers'

environment using EAR file you just installed. Accordingly, standard set and features of which developers may be in need show differences. For example, each object installed to increase performance is kept under temp folder. An object that is installed previously cannot be installed again. Although this feature helps customers to work easily, it causes problems on developers' behalf because it prevents them seeing modifications or forcing them to clear cache regularly. The following changes will allow you have default settings that our development team use to work.

You need to change the name of the following three files under j-guar set installation folder

(C:\jGuar_SDK\workspace\logo\WebContent\Config\System) as specified below. Then refresh logo project on Eclipse.

ServerConfig.xml ServerConfig_ORG.xml ConsoleConfig.xml ConsoleConfig_ORG.xml Debug.xml Debug_ORG.xml ServerConfig_DEV.xml ServerConfig.xml ConsoleConfig_SAMPLE.xml ConsoleConfig.xml Debug_SAMPLE.xml Debug.xml

5.19 Protecting Application Parameters in Version Upgrades

Let's assume that we DEBUGGED the ERROR definition in consoleConfig.XML file and so we started to

retrieve a detailed log where we can see queries that are sent. However when we upgrade version, folders which store these settings are deleted and reinstalled, and consequently all content will be gone. You'll need to remake all abovementioned settings in XML files and copy necessary files.

This difficulty of use is solved in 2.24 version. Once configuration values are read, they are kept in database

and file is no longer checked. Please note that once a config value is installed, we can no longer change it from files.

Now content of all config files (ConsoleConfig.xml file in our example) is kept in database. If a new config file is found and it is being stored in database, it is written in s_xmlconfigs table. At this point, no modification will apply in the relevant config file. Values are not read from the files, but from database. If there is a record in database, it will be considered dominant. Config files are updated according to their status in database for informative purposes in Server Start/Stop transactions.

If you want to update content of the relevant cfg in database, you need to do it from the relevant section in

Status page as shown below. The relevant config xml files will be updated according to the new content in the first server stop/start transaction and your parameters will be activated.

Page 36: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

36/58

6. j-guar Installation Steps

6.1 Database Settings

Open “Open Resource” using Ctrl+Shift+R key combination. Then search for DBConnection.xml.

After selecting the relevant file from the results list, click “Open” button.

Note: If DBConnection.xml file cannot be found, you can continue after renaming DBConnection_SAMPLE.xml document.

Page 37: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

37/58

Database info that will be used in DBConnection.xml file is defined.

For Oracle: <login-info name="ERP_TEST" database-type="Oracle" service-name="ORCL" server-name="172.16.52.182" database-name="ERPTEST" user-name="ERPTEST" user-password="ERPTEST" /> For MSSQL: <login-info name="LOCAL-MSSQL" database-type="MS-SQL" server-name="localhost" database-name="UNITYOD1" user-name="sa" user-password="qawsed" />

After that the name of “login-info” is written to “active-login-info”. <active-login-info name="LOCAL-MSSQL" /> In this way, j-guar will connect to the specified database. Note: When the content of DBConnection.xml file is changed, server must be stopped and restarted.

6.2 j-guar Database Operations

If connected database is a newly created and empty database, there are 2 steps to take. The first step is

to create system tables, and the second step is to create company tables. Before starting to work, you need to start Apache Tomcat by right clicking Debug in Servers tab if your server is in Stop status.

6.3 Creating System Tables:

As shown below, open Debug Configurations window and click ServerAdminClient > Debug button.

Page 38: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

38/58

Enter the following info in j-guar Server Administration window. This is default login information.

User Name : LOGO Password : LOGO

Double click Database Operations > Create/Update system tables and click OK button in prompt box as shown below.

When "System tables updated" message appears, all necessary system tables for j-guar would be created successfully.

Page 39: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

39/58

NOTE : Especially when you are upgrading or if you've opened a backup database, you'll need to start System Tables Reference Counting and Re-upload Queries operations under the Database Operations menu!

6.4 License Installation Operations

Solution Partner package is a protected package. You've installed solution partner set following

the steps above and completed Server Administration operations. However j-guar Administration and j-

guar Client application will not work until license activation is completed.

In order to use j-guar Administration and j-guar Client applications, you need to complete license

activation using j-guar Solution Partner License Keys which are sent to you by LOGO.

Attention : Since upgrading versions require reinstalling all over again, you need to perform activation with

your current license key after each installation.

Product Activation Operations

Activation is performed at http://localhost:8080/logo/Activation. You must have an active internet

connection to perform activation properly.

First and above all you need to make sure that your Tomcat Server is NOT working in Debug

mode. If your server is working in Debug mode and you perform activation, you will receive the following

error. In this case, you need to stop your server and "Start", and then go to activation page again.

Page 40: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

40/58

After selecting your language, you can start activation by following the instructions on screen.

Page 41: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

41/58

Enter your license key (sent by LOGO) and continue the process.

During activation, you'll need Dealer User, Dealer Password and User Password. You should prepare

this information beforehand to maintain activation. After entering your key in the window above, your key is

checked and if code is correct, you'll be prompted to enter your User Code and Dealer Password. If you

entered all information correctly, an activation page where you will enter and update Customer information

will open. In the next few steps, you don't need to provide data. Continue activation by clicking Next option.

Attention : After activation, you should select this license key to the Administrator group in Group definitions

in jAdmin. Similarly, as you add new groups, you'll need to add this license key to the newly created group

definitions.

When License Renewal Warning is received, you need to renew your license using

http://localhost:8080/logo/LicenseRenewal command.

6.5 Creating Company Tables:

Open "Debug Configurations" window as shown below and click AdminClient > Debug button.

Page 42: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

42/58

Enter the following login information in this window.

User Name : admin Password : logo

After logging in, click Companies button shown below. Click Add button to enter and save company definition.

Page 43: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

43/58

After creating a Company definition, click OK button in j-guar Administration screen and company tables

will be generated.

All operations performed on Company tables and their results are reported at the bottom of screen as

shown below. After receiving completion message, you can continue with your installation.

Page 44: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

44/58

NOTE: You also need to run "Generation of Process Management Database Definition" operation as of 2.19.2.0 version. Then select “Debug Configurations” menu > “JGuarClient” to open j-guar product.

Enter the following information in login window to open j-guar.

User Name : admin Password : logo Company : 1

Page 45: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

45/58

Page 46: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

46/58

7. Creating Customization Project and Settings

7.1 Creating LbsDefinitions.jar

First, you should go to the following address to create LbsDefinitions.jar. You need to make sure that

Tomcat Server is running in START mode. Before taking these steps, you should login to j-guar application. http://localhost:8080/logo/Status

Select All Definitions in this new page and click Create Definition button to start the process. It may take a while.

The process may take half an hour. If it takes longer and process is still not completed, you should check Server log. There may be an error and error content will guide you.

After completing this process, log is listed to see transactions performed and where they are copied to on the same page. LbsDefinitions.jar is copied in ...\workspace\logo\WebContent\Definitions folder by default. You can move it to a different folder by copying from the current folder or using Save button as shown below.

Page 47: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

47/58

After entering the relevant directory in Save in column, enter name of the file in File Name field, and click Save button. LbsDefinitions.jar will be saved in the specified directory.

NOTE : When a project is created in LPT, LbsDefinitions.jar must be loaded. Because LbsDefinitons.jar is used as library in LPT.

7.2 Creating LPT Customization Project

First you need to open “Package Explorer” window if it is not open already. Use the following menu options

to do so.

Page 48: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

48/58

When you write Package in the following window accessed by Other option, the relevant window

definition appears. By clicking OK, you will include Eclipse in window layout. You can drag and drop to the required section

later.

Click right click on Package Explorer > New > Other menu option to add a new project.

Page 49: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

49/58

Select “Logo Customization Wizard” and then “Logo Customization Project" in Wizard window.

Page 50: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

50/58

Wizard will ask for the name of your project. As shown below, you can give any name you want.

Java Settings window will open. Make no changes in this window and click Next button.

Page 51: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

51/58

Logo Customization Project window will open next, and it will ask for the location of your

LBSDefinitions.jar file. If it is a Logo Customization Project, this field is mandatory. Therefore it will not allow you to continue without making a proper selection.

Page 52: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

52/58

7.3 LPT Customization Project / Adding LPT Library Files

You should also add your LPT library files to your project. These files contain several functions which will

help you in project development. First of all, you need to add the relevant package. In order to do so, right click on your project in Package Explorer and then select New and Other options to open the following window. Find the relevant definition named Package and add it.

Enter com.acme.customization in the Name field.

Open the relevant zipped file which you acquired under the "LPT Library Files" heading, and copy files

available. Then paste on the relevant package in Eclipse. In this way, you will include them into your project as shown below.

Page 53: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

53/58

7.4 Copying necessary libraries for Controller operations

If you want to design a structure in your customization project in which you will import cards and slips of j-

guar product, you usually use Controller libraries and these libraries are not included in standard product libraries. You should add these libraries to your project.

Arranging Controller libraries in Customer sets:

As shown in the picture above, you can start copy operation using the Copy Controller Jars in Status window

in Customer environments. This operation copies libraries that you've selected (as shown above) from ...\workspace\logo\WebContent\resources\Jars where you keep project libraries to the target directory ...\workspace\logo\WebContent\WEB-INF\lib folder. After copying, libraries are activated after the first server stop/start. Please note that if you select too many libraries while copying, it will overload Client environment and spend sources (memory, performance) exceedingly.

Arranging Controller libraries in Eclipse development environments: If Controller libraries are not added to your project yet, you'll be informed that codes written using Controller

object could not find the relevant definitions. When you want to generate a controller sample code in product interface, an empty code content will appear. In order to perform development healthily, you should add required controller files directly from the source into your project, as shown above. In order to do so, you will not perform Copy Controller Jar operation, and you will not copy under ...\workspace\logo\WebContent\WEB-INF\lib which is

Page 54: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

54/58

your project library folder. Instead you will find the relevant libraries in the source folder under ...\workspace\logo\WebContent\resources\Jars directory and then add them to your project directly from this path. All Controller libraries are available under ...\workspace\logo\WebContent\resources\Jars, and libraries you need are those listed with *controllersClient filter. You can select the relevant libraries you will need from this list. While designating the names of these libraries, you can direct from the headings in Copy Controller Jar operations and names of card and slip forms to be transferred.

To sum up, you should perform copy controller jar operation only in customer environment. You will

not perform any copy operation in development environments. You will add necessary controller libraries in built path settings to your project using "Add External Jar" option in ...\workspace\logo\WebContent\resources\Jars.

You also need to add all (*controllersserver .jars) and (*controllersclient .jars) libraries under

resource/jars in logo / projects / Deployment Assembly window as shown below. This is not applied in customer sets.

7.5 LPT Customization Project / Properties / Java Build Path Setting

Right click on your LPT Customization Project and select Properties option. The following window opens.

You need to set a few settings to run your project properly. First, you'll select the libraries which your project will use. It is performed over Java Build Path. According to your settings in Libraries section, only “JRE System Library” and “LBSDefinitions.jar” (given in project installation) libraries should appear.

By using Add External Jars button, you include all libraries that are under

C:\jGuar_SDK\workspace\logo\WebContent\WEB-INF\lib path (where you installed your j-guar set) into your project.

Page 55: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

55/58

You will see the following window. In version upgrades, you should delete all libraries except for “JRE System Library” and update this section by replacing them with the new ones.

In sum, you must add the following three components in Java Build Path Setting.

1- LBSDefinition.jar (It must be recreated in Status page. Meanwhile it is recommended to start Server with Start instead of Debug.)

2- All (* .jars) libraries in ...\webcontent\Web-inf\lib folder

3- All (*controllersclient .jars) libraries in ...\webcontent\resources\Jars folder (It is not needed if you will not perform controller transfer!)

7.6 LPT Customization Project / Properties / Logo / Customization Setting

Open "Open Resource" window using Ctrl+Shift+R key combination and search for

ProjectGlobals.java. This is the file you just added under SRC. You can also access to its content by going to SRC folder under Package Explorer and double clicking the file.

Select the following check boxes in Logo / Customization section that you will access by right clicking on

your project.

Page 56: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

56/58

Here, you need to enter GUID value in the relevant section under ProjectGlobals.java as shown below. Otherwise your codes will just not run properly. GUID values will also be different. As a result, it would be the same project, yet different GUID values. This will pose a problem and if you work in this manner, someone can export your settings by ExportSettings and send them to the other project team members, and they might find the opportunity to import this file into their system with Import Settings button and work on the same project in different environments. However they will need to update their ProjectGlobals.java files in all cases.

Page 57: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

57/58

7.7 LPT Customization Project / Properties / Logo / Customization / Deploy Setting

When you deploy your codes, j-guar writes your customization definitions in j-guar database. You can

provide necessary information for the related connection in this window. Load default info using “Restore Defaults” button. If it is not changed, user name is admin and password is logo. Select Silent Deploy to work smoothly.

7.8 LPT Customization Project / Properties / Logo / Languages Setting

LPT projects can support multiple languages. Determine the language of LPT platform using UI Language

option as shown below. You can make additions to all projects in languages selected in the following list. For example, if you selected three languages, you'll be able to enter definition in these three languages when you add a button. Then your definition will be shown in login language on the relevant button automatically.

Page 58: LPT LOGO PLATFORM TAILORm.logobs.com/supporttest/images/Documents/jGUAR/en/... · LOGO PLATFORM TAILOR Development Platform Installation Document. LPT | Kurulum Döküman

LPT | Kurulum Dökümanı

58/58