Difference between revisions of "Launching the ADempiere Application"
m (fix link) |
|||
Line 1: | Line 1: | ||
+ | {{Breadcrumb|next=Logging In to the Client}} | ||
+ | [[Category:User documentation]] | ||
{{Cleanup}} | {{Cleanup}} | ||
− | + | 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 == | == Installing the ADempiere Client == | ||
− | If you are in the server | + | 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|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]] | ||
− | + | 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 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: |
[[Image:Web_Start1.PNG|center|400px]] | [[Image:Web_Start1.PNG|center|400px]] | ||
− | + | *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 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 | + | You will need to set the following system environment variables: |
* '''JAVA_HOME''' | * '''JAVA_HOME''' | ||
* '''ADEMPIERE_HOME''' | * '''ADEMPIERE_HOME''' | ||
* '''PATH''' | * '''PATH''' | ||
− | You can set | + | 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 | + | * 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.}} | |
− | + | ||
− | If you did not set | + | |
== 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: | |
[[Image:IC_ADempiere_Login.PNG|center]] | [[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]] | [[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. | + | *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 | + | |
*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. | ||
− | + | *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]] | [[Image:IC_ADempiere_TestDatabase.PNG|center]] | ||
− | |||
*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]] | ||
− | |||
*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]] | ||
− | Note | + | {{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. | ||
− | |||
− |
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 }} ⇒
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.
Contents
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: You have to have the Application Server (<ADempiere Home>/utils/RUN_Server2.bat
To install the ADempiere client on a remote computer, you have two options:
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.
- From the Application Server web page, click on the WebStart button and you will see the WebStart Dialog:
- Then you will see the Security window:
- 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: 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:
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:
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.
- Click the Ok button to get back to the Login screen:
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.
- Press the Ok button and you will see the ADempiere menu:
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.
Note: The HTML UI requires a maintainer.
Links
- Initial Client Setup For Business Client Setup in ADempiere.
- Server Setup that happened earlier.
- Installing ADempiere Tutorial on how to setup and configure ADempiere.
- Tutorials on many things from basic to advanced.