Client Usage

This document is the reference about the concepts of the graphical user interface (also known as Tryton client ) of the Tryton application framework.

Name

tryton - Graphical user client of the Tryton application framework

Synopsis

tryton [options]

After startup, there raises the login dialog and optionally a tips dialog.

Options

--version Show program version number and exit
-h, --help Show help message and exit
-c FILE, --config=FILE
 Specify alternate configuration file
-v, --verbose Enable basic debugging
-d LOG_LOGGER, --log=LOG_LOGGER
 Specify channels to log (ex: rpc.request, rpc.result, …)
-l LOG_LEVEL, --log-level=LOG_LEVEL
 Specify the log level: INFO, DEBUG, WARNING, ERROR, CRITICAL
-u LOGIN, --user=LOGIN
 Specify the login user
-p PORT, --port=PORT
 Specify the server port
-s SERVER, --server=SERVER
 Specify the server hostname

Overview

The following schematic illustration of the Tryton client shows the names of all important visual parts.

Figure: Tryton client application:

Client Window       _______________________________________________________
                   |                      Tryton                      _ o x|
                   |-------------------------------------------------------|
Menu bar           | File User Form Options Plugins Shortcuts Help         |
                   |_______________________________________________________|
                   |                                                       |
Tool bar           | New Save | Delete | Find Previous Next Switch    v    |
                   |-------------------------------------------------------|
                   |          ______                                       |
Tab bar            | [Menu]  |[Tab1]| [Tab2] ...                           |
                   |---------|      | -------------------------------------|
                   | .-------        ------------------------------------. |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
View               | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |                                                   | |
                   | |___________________________________________________| |
                   |_______________________________________________________|
Status bar         |username company      Waiting requests...     login@...|
                   |_______________________________________________________|

Tool Bar

The tool bar contains some often used menu functions mapped to icons. In addition to the menu bar the tool bar contains a button called Attachment.

Attachment

The attachment item handles the document management system of Tryton which is able to attach files to any arbitrary model. On click it opens the attachments dialog. The default dialog shows a list view of the attached files and links.

A single Attachment has the following Options:

  • Attachment Name: The name of the attachment.
  • Datas: The attached File. The file size is displayed as text.
  • Link: Link to an external site as URL.
  • Preview tab: Shows a preview picture of the selected attachment.
  • Description tab: Shows and and provides editing of a free text description for the selected attachment.
  • Actions:
    • OK: Closes the Dialog and saves the attachment(s).

Tabbed Main Frame

This part of the client contains all the related contents and functions provided by the Tryton server modules. All aspects inside the main frame depend at least on the individual set of installed modules.

The main frame provides a tabbed document interface to arrange different views side by side. New tabs are opened by special actions, like choosing a menu item or clicking some action buttons. All tabs include titles which show the name of the provided view.

Tabs can be arranged by Drag and Drop.

Note

Inside views there can be tabs, too.

Home Action

Another tab opens during the startup of the Tryton client: the home action. It is usually an item of the Main Menu opening when the user calls his Home action defined in the preferences.

Status bar

The status bar provides general informations of the state of the Tryton client. It is divided in three parts.

  • On its left side the real name and company name of the users actual company is shown.

  • In the center of the status bar the number of waiting requests for the actual user are displayed.

  • On its right side are details of the server connection shown including database and user informations if connected. It is also noted there, if there is no connection to a Tryton server at all. The right side information of the status bar is build with the following pattern:

    <user-name>@<tryton-server-address>:<port>/<database-name>
    

    If the client is connected to the server with an SSL-secured connection, an additional lock icon appears rightmost some certificate details in a mouse hover popup.

The Status bar can be enabled and disabled in the menu at Options > Form > Status bar

Appendix

Configuration File

~/.config/tryton/x.y/tryton.conf      # General configuration
~/.config/tryton/x.y/accel.map        # Accelerators configuration
~/.config/tryton/x.y/known_hosts      # Fingerprints
~/.config/tryton/x.y/ca_certs         # Certification Authority (http://docs.python.org/library/ssl.html#ssl-certificates)