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] [url]

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

URL

When an url is passed, the client will try to find already running client that could handle it and send to this one to open the url. If it doesn’t find one then it will start the GUI and open the url itself.

The url schemes are:

tryton://<hostname>[:<port>]/<database>/model/<model name>[/<id>][;parameters]

tryton://<hostname>[:<port>]/<database>/wizard/<wizard name>[;parameters]

tryton://<hostname>[:<port>]/<database>/report/<report name>[;parameters]

where parameters are the corresponding fields of actions encoded in JSON.

Note

model is for act_window

Note

report must have at least a data parameter with ids, id and model name

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 Options Plugins Shortcuts Help                       |
                   |________________________________________________________________|
                   |             |          ______                                  |
Tabs               | Menu        |  [Tab1] |[Tab2]| [Tab3]...                       |
                   |-------------| +-------+      +--------------------------------+|
                   | +           | | Menu Tab2                                     ||
                   | |-+         | |-----------------------------------------------||
Tool bar           | | |-        | | New Save Switch Reload | Prev Next | Attach v ||
                   | | |-        | |-----------------------------------------------||
                   | +           | |        ____________________                   ||
Search widget      | |-+         | | Search |                   | <- -> Find Clear ||
                   | | |-        | |-----------------------------------------------||
                   | | |-        | |                                               ||
                   | +           | |                                               ||
View               | |-+         | |                                               ||
                   |   |-        | |                                               ||
                   |   |-        | |                                               ||
                   |             | |                                               ||
                   |             | |                                               ||
                   |             | |                                               ||
                   |             | |                                               ||
                   |             | |                                               ||
                   |_____________| |_______________________________________________||
                   |________________________________________________________________|
Status bar         |username company           Waiting requests...         login@...|
                   |________________________________________________________________|

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

A tab opens during the startup of the Tryton client: the home. It is usually an item of the 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

Tool Bar

The tool bar contains the functionalities linked to the current tab. The tool bar contains functions for the current tab. Some operations are working with one record or with a selection of records. In form view the actual record is selected for operations. In tree view all selected records are used for operations.

New:
Creates a new record.
Save:
Saves the actual record.
Duplicate:
Duplicates the content of the actual record in a newly created record.
Delete:
Deletes the selected or actual record.
Find…:

Opens a dialog for finding fields with search criteria and operators.

  • Search criteria: Defines the aspects to seek for.
  • General search operators:
    • Equals: Search for results which are exactly the same as the following term.
    • Does Not Equal: Search for results which are different from the following term.
  • Additional search operators on numbers, amounts and strings:
    • Contains: Search for results which contain the following term.
    • Does Not Contain: Search for results which do not include the following term.
    • Starts With: Search for results beginning with the following term.
    • Ends With: Search for results ending with the following term.
  • Additional search operators for numbers and amounts:
    • Is Between: Search for results inside a range (from - to).
    • Is Not Between: Search for results outside a range (from - to).
    • Is Different: Same as ‘Does Not Equal’, see above.
  • Advanced Search expander opens additional search criteria.
    • Limit: Limits the count of results.
    • Offset: Skips a number of results and show only the following.
  • Actions:
    • Find: Search for results of the given criteria.
    • New: Create a new record (used when search was fruitless, to create quickly a new record).
    • Ok: Open the selected results.
    • Cancel

Note

To search for deactivated records the Active search criteria must be set to No.

Next:
Goes to the next record in a list (sequence).
Previous:
Goes to the last record in a list (sequence).
Switch View:

Switches the actual view aspect to:

Not all views provide all aspects.

Close Tab:
Closes the current tab. A Request Dialog opens in case of unsaved changes.
Previous Tab:
Shows the previous (left) tab of the actual tab.
Next Tab:
Shows the next (right) tab of the actual tab.
View Logs…:
Shows generic information of the current record.
Go to Record ID…:
Opens specific record id in the current view.
Reload/Undo:
Reloads the content of the actual tab. Undoes changes, if save request for the current record is denied.
Actions…:
Shows all actions for the actual view, model and record.
Print…:
Shows all print actions for the actual view, model and record.
Export Data…:

Export of current/selected records into CSV-file or open it in Excel.

  • Predefined exports
    • Choose preferences of already saved exports.
  • All Fields: Fields available from the model.
  • Fields to export: Defines the specific fields to export.
  • Options:
    • Save: Save export as a CSV file.
    • Open: Open export in spread sheet application.
  • Add field names: Add a header row with field names to the export data.
  • Actions:
    • Add: Adds selected fields to Fields to export.
    • Remove: Removes selected fields from Fields to export.
    • Clear: Removes all fields from Fields to export.
    • Save Export: Saves field mapping to a Predefined export with a name.
    • Delete Export: Deletes a selected Predefined export.
    • Ok: Exports the data (action depending on Options).
    • Cancel
Import Data…:

Import records from CSV-file.

  • All Fields: Fields available in the model (required fields are marked up).
  • Fields to Import: Exact sequence of all columns in the CSV file.
  • File to Import: File dialog for choosing a CSV file to import.
  • CSV Parameters: Setup specific parameters for chosen CSV file.
    • Field Separator: Character which separates CSV fields.
    • Text Delimiter: Character which encloses text in CSV.
    • Encoding: Character encoding of CSV file.
    • Lines to Skip: Count of lines to skip a headline or another offset.
  • Actions:
    • Add: Adds fields to Fields to Import.
    • Remove: Deletes fields from Fields to Import.
    • Clear: Removes all fields from Fields to Import.
    • Auto-Detect: Tries to auto detect fields in the CSV File to Import.
    • Ok: Proceeds the data import.
    • Cancel
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.

Search Widget

The search widget adds the ability to easily search for records on the current tab. This widget is visible only on tree view.

The Syntax

A query is composed of search clauses. A clause is composed of a field name (with : at the end), an operator and a value. The field name is optional and defaults to the record name. The operator is also optional and defaults to like or equal depending on the type of the field. The default operator is = except for fields of type char, text and many2one which is ilike.

Field Names

All field names shown in the tree view can be searched. Field names must be followed by a :

For example: Name:

If the field name contains spaces, it is possible to escape it using double quotes.

For example: "Receivable Today":

Operators

The following operators can be used:

  • =: equal to
  • <: less then
  • <=: less then or equal to
  • >: greater then
  • >=: greater then or equal to
  • !=: not equal
  • !: not equal or not like (depending of the type of field)

For example: Name: != Dwight

Note

The ilike operator is never explicit and % is appended to the value to make it behaves like starts with

Values

The format of the value depends on the type of the field. A list of values can be set using ; as separator.

For example: Name: Michael; Pam

It will find all records having the Name starting with Michael or Pam.

A range of number values can be set using ...

For example: Amount: 100..500

It will find all records with Amount between 100 and 500 (left included and right excluded)

There are two wildcards:

  • %: matches any string of zero or more characters.
  • _: matches any single character.

It is possible to escape special characters in values by using double quotes.

For example: Name: "Michael:Scott"

Here it will search with the value Michael:Scott.

Clause composition

The clauses can be composed using the two boolean operators and and or. By default, there is an implicit and between each clause if no operator is specified.

For example: Name: Michael Amount: 100

is the same as Name: Michael and Amount: 100

The and operator has a highest precedence than or but you can change it by using parenthesis.

For example: (Name: Michael or Name: Pam) and Amount: 100

is different than Name: Michael or Name: Pam and Amount: 100

which is evaluated as Name: Michael or (Name: Pam and Amount: 100)

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)
~/.config/tryton/x.y/profiles.cfg     # Profile configuration