To log in using a Windows client, you should double-click on the
xTuple ERP icon wherever it appears on your computer desktop. Likewise,
Macintosh users may click on the xTuple ERP icon from their desktop.
Linux users should run the appropriate xTuple ERP .sh file
to launch the application. The following screen will appear:
Tip
You should always be sure to use a version of xTuple ERP which
matches the version of your xTuple Database. Using mis-matched
versions can lead to errors and loss of data integrity. The system
will issue a warning message whenever you attempt to log in to a
database whose version does not match the client version.
When logging into xTuple ERP, you are presented with the following
options:
- Log in to registered xTuple demo account
Select this option if you are logging in to a demo database
hosted on an xTuple server. If selected, the OPTIONS button will
be disabled.
- Log in to server I specify
Select this option if you are logging in to any database
other than an xTuple demo database. If selected, you can specify
your connection details using the OPTIONS button.
- Username
Enter your assigned username. Usernames are established by
your system administrator. The username is case-sensitive.
- Password
Enter your assigned password. Passwords are established by
your system administrator. The password you type into this field
will not display on your screen, but will be represented by
asterisks (*) for security purposes.
- Server
Displays the name of the server you will be connecting
to.
- Database
Displays the name of the database you will be connecting
to.
To the far right of the screen, the following buttons are
available:
- CANCEL
Closes the screen, returning you to your computer
desktop.
- LOGIN
Click to log in to the application.
- OPTIONS
Select to verify or change your connection settings. This
button will be disabled if logging in to an xTuple demo
database.
Note
Most users will not need to change their Login options. If you
have questions about your option settings, contact your system
administrator.
To verify or change your connection settings, select the OPTIONS
button. The following screen will appear:
When viewing or changing your connection settings, you are
presented with the following options:
- Server
Enter the address of the server where your xTuple Database
is running. The address will consist of either a TCP/IP Address or
a Network Alias Name. If the network address for the xTuple Server
changes, you may need to change the address in this field.
- Database
Enter the name of the xTuple Database you want to connect
to. The application can be used to connect to multiple xTuple
databases. Be sure to enter the correct name of the database you
want to access.
- Port
Displays the default port. The default port for the xTuple
Database is 5432.
- Use Enhanced Authentication
Select if your site requires you to use enhanced
authentication. Enhanced authentication adds a layer to the
authentication process used to log in to xTuple ERP. When this
feature is turned on, user passwords are stored in the xTuple
Database in a modified form. The end result is that you may only
log in to an xTuple Database using xTuple ERP.
Tip
Do not select the enhanced authentication option if your site
does not use this method. You will find you cannot connect to the
database.
- Require SSL Connection
Select if your site requires you to use a Secure Sockets
Layer (SSL) connection. Selecting this option guarantees you will
connect to your xTuple Database with an SSL connection. If your
xTuple Database is not configured to support SSL, you will not be
able to connect if this option is selected. Using SSL for
client-server connections adds a layer of encryption to the
authentication process.
To the far right of the screen, the following buttons are
available:
- CANCEL
Closes the screen, returning you to the previous
screen.
- SAVE
Saves your connection settings. Any settings you save will
become your default connection settings. To change your default
settings, update your Login options and then save them.
Once your username and password have been successfully authenticated, the main application desktop will appear,
as shown below:
Note
The main application desktop may vary from user to user,
depending on the user's granted privileges, preference settings, and
the xTuple ERP version used.
In general, each of the main menu options corresponds to a
different module. There are three exceptions to that rule:
- Window
-
The following options appear under the "Window" menu:
- Cascade
Select to arrange open screens in a cascading
pattern.
- Tile
Select to arrange open screens in a tiled
pattern.
- Close Active Window
Select to close the currently active screen.
- Close All Windows
Select to close all open screens.
- Community
-
If you have an open Internet connection, the following
"Community" menu options will open in your default web
browser:
- xTuple.org Home
Select to launch the xTuple.org home page.
- Register
PostBooks users are given the opportunity to register
with xTuple using this menu option. Registration gives users
access to additional resources not available to unregistered
users—for example, extra documentation, videos, etc.
- New Account
Select to create a new xTuple.org account.
- Edit Account
Select to edit your xTuple.org account.
- Discussion Forums
Select to browse the discussion forums on the
xTuple.org site.
- Blogs
Select to browse the blogs on the xTuple.org
site.
- Bugs and Feature Requests
Select to access the Issue Tracking system on the
xTuple.org site.
- Downloads
Select to access the downloads page on the xTuple.org
site.
- Help
-
The following options appear under the "Help" menu:
- About
Select to view version information.
- Table of Contents
Select to access xTuple ERP Help files. For this to
work, the Help files must be installed on your
system.