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 (fix link)
Line 1: Line 1:
 +
{{Breadcrumb|next=Logging In to the Client}}
 +
[[Category:User documentation]]
 
{{Cleanup}}
 
{{Cleanup}}
  
==README==
+
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.
 
+
*Further requests for assistance please direct to the [http://sourceforge.net/forum/forum.php?forum_id=610547 HELP Forum]. This wiki provides only written and publishable support.
+
*Further private, local, or commercial assistance can be sought at [[World-wide Directory]] where consultants all over register themselves. The fees charged are up to the respective consultants and under their own responsibility or control.
+
*Please adhere to our bazaar [[etiquette]] to enjoy better support from us.
+
 
+
===Introduction===
+
*This '''Install Client HELP''' is for setting up ''Clients'' as in any ''Client-Server system''. It allows the application to run from a ''client'' or a remote PC connected to the ''application-server''.
+
*The term '''Client''' also means the '''Business Entity''' using the ERP System. If you want to learn how to set that, you can refer to [[ManPageX_InitialClientSetup|Initial Client Setup]].
+
  
 
== Installing the ADempiere Client ==
 
== Installing the ADempiere Client ==
  
If you are in the server you can just run the HTML Client, as it is installed in the Server Install process.
+
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 (http://<your server name, IP or URL>:<your port number>/admin).
Once you have the Application Server (utils/RUN_Server2.bat|sh) running,  
+
* point your browser to your application server (http://localhost/admin):
+
{{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.}}
  
 
[[Image:Adempiere_Home.png|center|800px]]
 
[[Image:Adempiere_Home.png|center|800px]]
  
So, you have two options:
+
To install the ADempiere client on a remote computer, you have two options:
  
 
==='''Option 1: Web Start'''===
 
==='''Option 1: Web Start'''===
  
Note: You need to have Java installed before this
+
{{Note|You need to have Java installed on the remote computer before the Web Start will work.}}
This WebStart option automatically makes sure that you use the latest version.
+
 
 +
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.
  
*Just click on the ''WebStart'' button and you 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:Web_Start1.PNG|center|400px]]  
  
then you will see the Security window:
+
*Then you will see the Security window:
 
[[Image:Web_Start_Security.PNG|center|400px]]
 
[[Image:Web_Start_Security.PNG|center|400px]]
 
<center><small>Note: Screen sample text is in Spanish. Yours should be in your language.</small></center>
 
<center><small>Note: Screen sample text is in Spanish. Yours should be in your language.</small></center>
  
*after you check it, the application start.
+
*After you login, the application will start.
  
 
==='''Option 2: Local Install'''===
 
==='''Option 2: Local Install'''===
In order to 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  
 
*click on the '''''zip''''' link and  
 
**extract the file content to a local directory.  
 
**extract the file content to a local directory.  
  
You need to have setted the system environment variables:
+
You will need to set the following system environment variables:
 
* '''JAVA_HOME'''  
 
* '''JAVA_HOME'''  
 
* '''ADEMPIERE_HOME'''
 
* '''ADEMPIERE_HOME'''
 
* '''PATH'''
 
* '''PATH'''
  
You can set it manually, for example:
+
You can set these manually, for example:
  
 
Windows...
 
Windows...
Line 61: Line 57:
  
 
You can also set this in ~/.bashrc so it is set on each login.
 
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 thats the local directory you unzipped to.
+
* 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.
 
* 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
 
   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.
  
 
+
{{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.}}
* Add ''C:\jdk1.5.0_05\bin;C:\Adempiere\lib;'' at the beginning of the '''PATH''' system environment variable.
+
If you did not set those 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==
*Start the ADempiere Client via the script '''RUN_Adempiere''' (.bat or .sh) . Then you will see the '''ADempiere Login''' window:
+
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]]
 
[[Image:IC_ADempiere_Login.PNG|center]]
*There you shall see that the server field is in red backlight
+
If you see that the server field background is red either:
**this is due to default '''validate connection on startup''' option that is defaulted to ''off''.
+
*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  option is a new feature in ADempiere 312 onwards where the user saves time during login.
+
*the database or application server has a problem. Click the Host/Server field and you will see the Connection dialog:
***It is defaulted to ''off''. You can check this option back ''on'' in the ''Preferences'' window.
+
*You may proceed by clicking on the ''OK'' sign.
+
**or press the Host/Server field and you can see the Connection dialog:
+
 
[[Image:IC_Adempiere_Connection.PNG|center]]
 
[[Image:IC_Adempiere_Connection.PNG|center]]
Now you must enter the Application Host name and the Application Port (default is 1099).  
+
Check/correct the Application Host name and the Application Port (default is 1099).  
*Press the ''Test Application Server'' button.
+
*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 found, then information like the database server is returned.  
+
 
*If the application server is not running, then  
 
*If the application server is not running, then  
 
**enter the Database Host/server name,  
 
**enter the Database Host/server name,  
Line 89: Line 79:
 
**the user name and  
 
**the user name and  
 
**the database password.
 
**the database password.
(Please check [[Logging In to the Client]] for more detail info). After you filled up the fields,  
+
*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.
*press the ''Test Database'' button to connect:
+
 
[[Image:IC_ADempiere_TestDatabase.PNG|center]]
 
[[Image:IC_ADempiere_TestDatabase.PNG|center]]
You will see the Ok icon (in green) if the connection was successful.
 
 
*Click the ''Ok'' button to get back to the Login screen:
 
*Click the ''Ok'' button to get back to the Login screen:
 
[[Image:IC_ADempiere_TestDB_OK.PNG|center]]  
 
[[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).  
 
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).  
For default Application Users and Passwords see [[Logging In to the Client]].
+
{{Note|For default Application Users and Passwords see [[Logging In to the Client]].}}
*Click the ''Ok'' button to see the Login Default tab
+
*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]]
 
[[Image:IC_ADempiere_Login_Default.PNG|center]]
and then you can select the Role, Client and Organization.
 
 
*Press the ''Ok'' button and you will see the ADempiere menu:
 
*Press the ''Ok'' button and you will see the ADempiere menu:
 
[[Image:IC_ADempiere.PNG|center]]
 
[[Image:IC_ADempiere.PNG|center]]
Line 107: Line 93:
 
You can login into the HTML client alternative via the ADempiere Web Application. To do it,  
 
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.
+
*click the Web Application link to start the HTML client. The log-in process is the same as with the Application Client.
The process is the same as with the Application Client.
+
  
 
[[Image:IC_Web_Application.png|center|800px]]
 
[[Image:IC_Web_Application.png|center|800px]]
  
NoteThe HTML UI is Beta Functionality.
+
{{Note|The HTML UI requires a maintainer.}}
  
 
==Links==
 
==Links==
Line 119: Line 104:
 
*[[ADempiere_Installing|Installing ADempiere]] Tutorial on how to setup and configure ADempiere.
 
*[[ADempiere_Installing|Installing ADempiere]] Tutorial on how to setup and configure ADempiere.
 
*[[Tutorials|Tutorials]] on many things from basic to advanced.
 
*[[Tutorials|Tutorials]] on many things from basic to advanced.
 
[[Category:OnLineHelp]]
 

Revision as of 13:04, 11 July 2010

Table of Contents{{#if: | | [[{{{2}}}]] }}{{#if: | | [[{{{3}}}]] }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | Launching the ADempiere Application{{#if: Logging In to the Client| | Logging In to the Client }} ⇒

Cleanup.png This article may require cleanup to meet the Wiki Documents standards. It may contain obsolete information or is in need of organization. Please improve this page if you can.


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.

Installing the ADempiere 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 (http://<your server name, IP or URL>:<your port number>/admin).


Note.gif Note:

You have to have the Application Server (<ADempiere Home>/utils/RUN_Server2.bat

Adempiere Home.png

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

Option 1: Web Start

Note.gif 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.

  • From the Application Server web page, click on the WebStart button and you will see the WebStart Dialog:
Web Start1.PNG
  • Then you will see the Security window:
Web Start Security.PNG
Note: Screen sample text is in Spanish. Yours should be in your language.
  • After you login, the application will start.

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.

You will need to set the following system environment variables:

  • JAVA_HOME
  • ADEMPIERE_HOME
  • PATH

You can set these manually, for example:

Windows...

  • Set the JAVA_HOME system environment variable to 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 C:\jdk1.5.0_05\bin;C:\Adempiere\lib; (or your equivalent) at the beginning of the PATH system environment variable.


Note.gif 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:

IC ADempiere Login.PNG

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:
IC Adempiere Connection.PNG

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.
IC ADempiere TestDatabase.PNG
  • Click the Ok button to get back to the Login screen:
IC ADempiere TestDB OK.PNG

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.gif 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.
IC ADempiere Login Default.PNG
  • Press the Ok button and you will see the ADempiere menu:
IC ADempiere.PNG

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.
IC Web Application.png


Note.gif Note:

The HTML UI requires a maintainer.

Links