Difference between revisions of "Launching the ADempiere Application"

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.
m (→‎Installing the ADempiere Client)
m
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Breadcrumb|next=Logging In to the Client}}
+
{{Breadcrumb|Table of Contents|Getting Started|InstallComplete|next=Logging In to the Client}}
 
[[Category:User documentation]]
 
[[Category:User documentation]]
−
{{Cleanup}}
+
[[Category:Installation]]
 +
[[Category:Documentation]]
 +
[[Category:Table of Contents]]
  
−
The ADempiere Application runs as a ''client'' that communicates with the ADempiere Application Server. It can run on the server, on a remote machine or via a web interface.
+
There are two ways of accessing the ADempiere Application: through a java software ''client'' that runs on the user's computer or through a web user interface (webui) which can be accessed through a browser. Both these applications communicate with the ADempiere Application Server.   This article describes how to install the client software and launch the client application.
  
−
== Installing the ADempiere Client ==
+
== Windows Installer ==
 +
If you used the [[Windows Installer]] for 380LTS+ for a demo, both the client application and the webui can be access using the shortcuts in the start menu. To log in, see [[Logging In to the Client]].  Read [[Finding Your Way Around]] and then explore the [[Garden World]] demo client.
  
−
If you are in the server, the Client software is already installed as part of the Server Install process. Depending on your operating system, you can access the client directly (<Adempiere Home>/utils/RUN_ADempiere.bat/sh), via a system menu or via the Application Server.  To access the server from a browser, point your browser to your application server URL (<nowiki>http://<your server name, IP or URL>:<your port number>/admin</nowiki>).
+
[[image:ADempiereStartMenu.PNG]]
−
   
+
 
−
{{Note|You have to have the Application Server (<ADempiere Home>/utils/RUN_Server2.bat|sh) running. Don't forget the port number in the URL.}}
+
== Prerequisites ==
 +
 
 +
Before running the client, ensure the the ADempiere Application Server is running on the Server computer.  See [[InstallComplete|Launching the Application Server]] for details.  For computers with Windows operating systems, it is helpful to install the application server as a service.  The Windows installer does this for you automatically.  The service is not installed to start automatically so you may need to go to the Control Panel, System and Security, Administrative Tools, Services and start the service or set it to run automatically.
 +
 
 +
Each client/remote computer will need to have Java installed Visit [http://www.java.com http://www.java.com] to download and install the latest version.
 +
{{Note|The Client software is automatically installed on the Server as part of the Server Install process. Depending on your operating system and installation process, you can access the Client software on the Server from a shell directly (<Adempiere_Home>/utils/RUN_ADempiere.bat/sh) or via a system menu or desktop shortcut. You can also use the process described below.}}
 +
 
 +
== Accessing the Application Server ==
 +
 
 +
To access the ADempiere Application Server from a browser, point your browser to your server URL (<nowiki>http://<your server name, IP or URL>:<your port number>/admin</nowiki> e.g. <nowiki>http://myservername:8080/admin</nowiki>)
 +
 
 +
[[Image:Adempiere_Home.png|center|640px]]
 +
 
 +
== Running ADempiere as a Web Application ==
 +
 
 +
The ADempiere Client can be accessed as a web application from the application server. The server page lists several methods:
 +
* ADempiere ZK webUI - contributed by Posterita and consistently supported by the community.
 +
* ADempiere old UI HTML (alpha) (alternative)
 +
* Web Based Point of Sale (POS)
 +
 
 +
The ZK webUI is the most popular as it represents ADempiere being used in a cloud. The webui can be accessed directly with the url (<nowiki>http://<your server name, IP or URL>:<your port number>/webui</nowiki> e.g. <nowiki>http://myservername:8080/webui</nowiki>).
 +
 
 +
The Windows installer will have created a link to the webui for you in the Windows Start Menu.  
 +
 
 +
== Installing the ADempiere Client ==
  
−
[[Image:Adempiere_Home.png|center|800px]]
+
If you are using a single computer, the ADempiere Client software is already installed along with the Application Server.
  
 
To install the ADempiere client on a remote computer, you have two options:
 
To install the ADempiere client on a remote computer, you have two options:
 +
# [[#Option 1: Web Start|Web Start]]
 +
# [[#Option 2: Local Install|Local Install]]
  
 
==='''Option 1: Web Start'''===
 
==='''Option 1: Web Start'''===
−
 
−
{{Note|You need to have Java installed on the remote computer before the Web Start will work.}}
 
  
 
The WebStart option automatically makes sure that the client computer will use the latest version.  This is very handy in large installations as you will only need to update the software on the server and all the clients will automatically update their local copies the next time the client is launched.
 
The WebStart option automatically makes sure that the client computer will use the latest version.  This is very handy in large installations as you will only need to update the software on the server and all the clients will automatically update their local copies the next time the client is launched.
 +
  
 
*From the Application Server web page, click on the ''WebStart'' button and you will see the WebStart Dialog:
 
*From the Application Server web page, click on the ''WebStart'' button and you will see the WebStart Dialog:
−
[[Image:Web_Start1.PNG|center|400px]]  
+
[[Image:Webstart_download_progress.jpg|center|400px]]  
  
−
*Then you will see the Security window:
 
−
[[Image:Web_Start_Security.PNG|center|400px]]
 
−
<center><small>Note: Screen sample text is in Spanish. Yours should be in your language.</small></center>
 
  
−
*After you login, the application will start.
+
*You may need to associate the jnlp file which the WebStart uses with the appropriate java application. If so you will see a window like the one below.  Click on "Do this automatically for files like this from now on.":
 +
[[Image:Webstart_jnlp_file.jpg|center|400px]]
 +
{{Note|You can change the association for JNLP files in the Advanced properties of the Java Control Panel ({{MenuRef|Control Panel|Java|Advanced}}).}}
 +
 
 +
*Then you will see the Security window. Click on "Always trust content from this publisher.":
 +
[[Image:Webstart_digital_sig.jpg|center|400px]]
 +
 
 +
*The very first time the application starts, you will see a license dialog.
 +
[[Image:Webstart_license.jpg|center|400px]]
 +
 
 +
*The application will start once you accept the license terms.  Move on to [[Logging In to the Client]].
 +
{{Note|In windows, the Web Start installs a menu link in your start menu.  You can restart the application by clicking this link. The next time you start the application by clicking on Web Start, the application will check for a newer version on the Application Server and automatically download it if it exists.  After downloading the application will start automatically.}}
  
 
==='''Option 2: Local Install'''===
 
==='''Option 2: Local Install'''===
Line 36: Line 72:
 
**extract the file content to a local directory.  
 
**extract the file content to a local directory.  
  
−
You will need to set the following system environment variables:
+
Refer to the [[Getting Started#Manual Installation|Manual Installation]] Instructions for your operating system as the installation process is similar to the installation of the server software.  Specifically, you will need to set the following system environment variables:
 
* '''JAVA_HOME'''  
 
* '''JAVA_HOME'''  
 
* '''ADEMPIERE_HOME'''
 
* '''ADEMPIERE_HOME'''
 
* '''PATH'''
 
* '''PATH'''
  
−
You can set these manually, for example:
+
==== Start the ADempiere Client====
 +
If you've used the Windows Installer, use the shortcut for ADempiere in the Start Menu.
 +
 
 +
Start the ADempiere Client via the script '''RUN_Adempiere''' (.bat or .sh) . Then you will see the '''ADempiere Login''' window:
 +
 
 +
Move on to [[Logging In to the Client]] for log in instructions.
 +
 
 +
== Troubleshooting Tips ==
 +
 
 +
If you did not set the environment variables, you might receive an error message that the '''JAVA_HOME''' or '''ADEMPIERE_HOME''' variable has not been set.
  
 
Windows...
 
Windows...
−
* Set the '''JAVA_HOME''' system environment variable to ''C:\jdk1.5.0_05''
+
* Set the '''JAVA_HOME''' system environment variable to your java installation directory e.g. ''C:\jdk1.5.0_05''  
 
* Set the '''ADEMPIERE_HOME''' system environment variable to ''C:\Adempiere''
 
* Set the '''ADEMPIERE_HOME''' system environment variable to ''C:\Adempiere''
  
Line 61: Line 106:
 
   chmod a+x /opt/Adempiere/RUN_Adempiere.sh
 
   chmod a+x /opt/Adempiere/RUN_Adempiere.sh
  
−
* Add ''C:\jdk1.5.0_05\bin;C:\Adempiere\lib;'' (or your equivalent) at the beginning of the '''PATH''' system environment variable.
+
* Add ''%JAVA_HOME%\bin;%ADEMPIER_HOME%\lib;'' to your '''PATH''' system environment variable.
−
 
+
−
{{Note|If you did not set the environment variables, you might receive an error message with the '''JAVA_HOME''' or '''ADEMPIERE_HOME''' variables as not been set. So, just make sure that you do the steps above.}}
+
−
 
+
−
== Start the ADempiere Client==
+
−
Start the ADempiere Client via the script '''RUN_Adempiere''' (.bat or .sh) . Then you will see the '''ADempiere Login''' window:
+
−
[[Image:IC_ADempiere_Login.PNG|center]]
+
−
If you see that the server field background is red either:
+
−
*the '''validate connection on startup''' option that is set to ''off''. You can check turn the option back ''on'' in the ''Preferences'' window once you log in. OR
+
−
*the database or application server has a problem. Click the Host/Server field and you will see the Connection dialog:
+
−
[[Image:IC_Adempiere_Connection.PNG|center]]
+
−
Check/correct the Application Host name and the Application Port (default is 1099).
+
−
*Press the ''Test Application Server'' button.  If the application server is found, then information about the database server is returned.
+
−
*If the application server is not running, then
+
−
**enter the Database Host/server name,
+
−
**database name,
+
−
**the user name and
+
−
**the database password.
+
−
*After you filled up the fields, press the ''Test Database'' button to connect. You will see the Ok icon (in green) if the connection was successful.
+
−
[[Image:IC_ADempiere_TestDatabase.PNG|center]]
+
−
*Click the ''Ok'' button to get back to the Login screen:
+
−
[[Image:IC_ADempiere_TestDB_OK.PNG|center]]
+
−
If the Host information is all white, you connected to the application server. If the left side is a bit red, you connected to the database, but not to the application server (the case in our example).
+
−
{{Note|For default Application Users and Passwords see [[Logging In to the Client]].}}
+
−
*Click the ''Ok'' button to see the Login Default tab and then you can select the Role, Client and Organization.
+
−
[[Image:IC_ADempiere_Login_Default.PNG|center]]
+
−
*Press the ''Ok'' button and you will see the ADempiere menu:
+
−
[[Image:IC_ADempiere.PNG|center]]
+
−
 
+
−
== The Adempiere Web Application Login (alternative) ==
+
−
You can login into the HTML client alternative via the ADempiere Web Application. To do it,
+
−
 
+
−
*click the Web Application link to start the HTML client.  The log-in process is the same as with the Application Client.
+
−
 
+
−
[[Image:IC_Web_Application.png|center|800px]]
+
−
 
+
−
{{Note|The HTML UI requires a maintainer.}}
+
−
 
+
−
==Links==
+
−
*[[ManPageX_InitialClientSetup|Initial Client Setup]] For Business Client Setup in ADempiere.
+
−
*[[InstallServer|Server Setup]] that happened earlier.
+
−
*[[ADempiere_Installing|Installing ADempiere]] Tutorial on how to setup and configure ADempiere.
+
−
*[[Tutorials|Tutorials]] on many things from basic to advanced.
+

Latest revision as of 10:02, 1 March 2016

⇐ Table of Contents{{#if: Getting Started| | Getting Started }}{{#if: InstallComplete| | InstallComplete }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | Launching the ADempiere Application{{#if: Logging In to the Client| | Logging In to the Client }} ⇒

There are two ways of accessing the ADempiere Application: through a java software client that runs on the user's computer or through a web user interface (webui) which can be accessed through a browser. Both these applications communicate with the ADempiere Application Server. This article describes how to install the client software and launch the client application.

Windows Installer

If you used the Windows Installer for 380LTS+ for a demo, both the client application and the webui can be access using the shortcuts in the start menu. To log in, see Logging In to the Client. Read Finding Your Way Around and then explore the Garden World demo client.

ADempiereStartMenu.PNG

Prerequisites

Before running the client, ensure the the ADempiere Application Server is running on the Server computer. See Launching the Application Server for details. For computers with Windows operating systems, it is helpful to install the application server as a service. The Windows installer does this for you automatically. The service is not installed to start automatically so you may need to go to the Control Panel, System and Security, Administrative Tools, Services and start the service or set it to run automatically.

Each client/remote computer will need to have Java installed Visit http://www.java.com to download and install the latest version.

Note.gif Note:

The Client software is automatically installed on the Server as part of the Server Install process. Depending on your operating system and installation process, you can access the Client software on the Server from a shell directly (<Adempiere_Home>/utils/RUN_ADempiere.bat/sh) or via a system menu or desktop shortcut. You can also use the process described below.

Accessing the Application Server

To access the ADempiere Application Server from a browser, point your browser to your server URL (http://<your server name, IP or URL>:<your port number>/admin e.g. http://myservername:8080/admin)

Adempiere Home.png

Running ADempiere as a Web Application

The ADempiere Client can be accessed as a web application from the application server. The server page lists several methods:

  • ADempiere ZK webUI - contributed by Posterita and consistently supported by the community.
  • ADempiere old UI HTML (alpha) (alternative)
  • Web Based Point of Sale (POS)

The ZK webUI is the most popular as it represents ADempiere being used in a cloud. The webui can be accessed directly with the url (http://<your server name, IP or URL>:<your port number>/webui e.g. http://myservername:8080/webui).

The Windows installer will have created a link to the webui for you in the Windows Start Menu.

Installing the ADempiere Client

If you are using a single computer, the ADempiere Client software is already installed along with the Application Server.

To install the ADempiere client on a remote computer, you have two options:

  1. Web Start
  2. Local Install

Option 1: Web Start

The WebStart option automatically makes sure that the client computer will use the latest version. This is very handy in large installations as you will only need to update the software on the server and all the clients will automatically update their local copies the next time the client is launched.


  • From the Application Server web page, click on the WebStart button and you will see the WebStart Dialog:
Webstart download progress.jpg


  • You may need to associate the jnlp file which the WebStart uses with the appropriate java application. If so you will see a window like the one below. Click on "Do this automatically for files like this from now on.":
Webstart jnlp file.jpg
Note.gif Note:

You can change the association for JNLP files in the Advanced properties of the Java Control Panel (Control Panel{{#if: Java | →Java }}{{#if: Advanced | →Advanced }}{{#if: | → }}).

  • Then you will see the Security window. Click on "Always trust content from this publisher.":
Webstart digital sig.jpg
  • The very first time the application starts, you will see a license dialog.
Webstart license.jpg
Note.gif Note:

In windows, the Web Start installs a menu link in your start menu. You can restart the application by clicking this link. The next time you start the application by clicking on Web Start, the application will check for a newer version on the Application Server and automatically download it if it exists. After downloading the application will start automatically.

Option 2: Local Install

A local install makes a local copy of the client software that is not automatically updated. In order to perform the Local Install:

  • click on the zip link and
    • extract the file content to a local directory.

Refer to the Manual Installation Instructions for your operating system as the installation process is similar to the installation of the server software. Specifically, you will need to set the following system environment variables:

  • JAVA_HOME
  • ADEMPIERE_HOME
  • PATH

Start the ADempiere Client

If you've used the Windows Installer, use the shortcut for ADempiere in the Start Menu.

Start the ADempiere Client via the script RUN_Adempiere (.bat or .sh) . Then you will see the ADempiere Login window:

Move on to Logging In to the Client for log in instructions.

Troubleshooting Tips

If you did not set the environment variables, you might receive an error message that the JAVA_HOME or ADEMPIERE_HOME variable has not been set.

Windows...

  • Set the JAVA_HOME system environment variable to your java installation directory e.g. C:\jdk1.5.0_05
  • Set the ADEMPIERE_HOME system environment variable to C:\Adempiere

Linux...

  • Set the JAVA_HOME system environment variable to /usr/lib/jvm/java-6-sun/jre if that's where your java is.

For Debian based systems do this to check 

   ls -l /etc/alternatives/java

Use this command 

   export JAVA_HOME=/usr/lib/jvm/java-6-sun/jre

You can also set this in ~/.bashrc so it is set on each login.

  • Set the ADEMPIERE_HOME system environment variable to /opt/Adempiere if that is the local directory you unzipped to.
  • Make the shell script that starts Adempiere client runable, by giving it the eXecute attribute for All users.
 chmod a+x /opt/Adempiere/RUN_Adempiere.sh
  • Add %JAVA_HOME%\bin;%ADEMPIER_HOME%\lib; to your PATH system environment variable.
Retrieved from "http://www.adempiere.com/index.php5?title=Launching_the_ADempiere_Application&oldid=17014"