Design#

The Internal Resource Module introduces the following concepts:

Note

For historical reasons the module’s technical name is ir.

Model#

The Model stores a record of each subclass of Model that is registered in the Pool.

A model is composed of Fields that represents each Field it contains.

The administrator can enable global search for records of the model by checking the Global Search box.

See also

Models are found by opening the main menu item:

Reports#

Workflow Graph#

The Workflow Graph prints a state diagram for each selected Workflow Model.

Wizards#

Graph#

The Graph wizard prints an object diagram that shows the relationships between the selected Models down to the specified depth.

Model Field#

The Model Field keeps a record for each subclass of Field that a Model contains.

See also

Model Fields are found by opening the main menu item:

Model Access#

The Model Access defines the access rights to Models for each Group.

See also

Models Access are found by opening the main menu item:

Model Field Access#

The Model Field Access defines the access rights to Model Fields for each group.

See also

Model Fields Access are found by opening the main menu item:

Model Button#

The Model Button stores the buttons defined in the Models. It also contains a list of Groups that have access to the button and a list of rules that must be satisfied to trigger the button’s action.

See also

Model Buttons are found by opening the main menu item:

Model Data#

The Model Data keeps track of the ModelStorage records created by modules via XML files. If a Model Data is out of sync (i.e. the values in the database do not match the values in the XML definition), it is possible to force synchronisation using the Sync button.

See also

Model Data are found by opening the main menu item:

Model Log#

The Model Log records events such as modification, suppression, click, launch and transition that happened to a ModelStorage record.

See also

Model Logs are found by opening the main menu item:

The logs related to a record are found by opening the View Logs… menu item of the toolbar.

Action#

The Action concept contains common user interface behavior properties. The list of keywords specifies where the action is available and for which Model. If any Groups are added to the action, then only members of at least one of these groups will have access to the action.

See also

The Actions can be found by opening the main menu item:

Report Action#

The Report Action stores the properties needed to execute the named Report.

See also

The Report Actions can be found by opening the main menu item:

Window Action#

The Window Action stores the properties necessary for the client to open a tab for a ModelStorage. It consists of a list of Views and domains.

See also

The Window Actions can be found by opening the main menu item:

Wizard Action#

The Wizard Action defines how the client should run the named Wizard.

See also

The Wizard Actions can be found by opening the main menu item:

URL Action#

Each URL Action stores a URL to open.

See also

The URL Actions can be found by opening the main menu item:

Module#

Every Tryton Module has one entry. The Module keeps track of whether it is activated or not.

See also

Modules are found by opening the main menu item:

Wizards#

Activate / Upgrade Module#

The Activate / Upgrade Module wizard performs the activation or upgrade of the Modules marked as “To Upgrade”, “To Remove” and “To Activate”. It then launches the Config Module wizard.

Module Config Wizard Item#

The Module Config Wizard Item keeps track of the configuration Actions to be launched after the Activate / Upgrade Module wizard.

See also

Module Config Wizard Items are found by opening the main menu item:

Wizards#

Config Modules#

The Config Modules wizard launches all the pending Items sequentially.

Attachment#

Attachment is a ResourceMixin that stores documents for any ModelStorage record.

See also

Attachments are found by opening the main menu item:

The attachments related to a record are found by opening the Attachment menu item of the toolbar.

Avatar#

Avatar is a ResourceMixin that stores a single avatar for any avatar_mixin() record. Each Avatar record has a UUID which is used to construct a URL that returns the picture. A version of the picture is stored in a cache for each size requested.

Cache#

The Cache stores when the named Cache was last invalidated.

Calendar Month#

The Calendar Month stores each month of the Gregorian calendar.

Note

Its goal is to provide a target for Many2One fields with localized month names.

Calendar Day#

The Calendar Day stores each day of the week.

Note

Its goal is to provide a target for Many2One fields with localized week day names.

Configuration#

The Configuration is a ModelSingleton that stores configuration from the database setup, like the default language and the host name.

Cron#

The Cron stores the configuration for scheduled actions.

See also

The Scheduled Actions can be found by opneing the main menu item:

Date#

The Date Model provides the current date.

Email#

The Email is a ResourceAccessMixin that stores a copy of the emails sent from a ModelStorage record.

See also

Emails are found by opening the main menu item:

The emails related to a record are found by opening the Emails Archives menu item from the relate toolbar.

Email Template#

The Email Template stores templates per Model and is used to fill in the client’s Email form.

See also

Email Templates are found by opening the main menu item:

Error#

The Error stores exceptions raised by non interactive processes. An Error can be processed and then solved by a User. When an Error is solved the process that originally reported the error is run again.

Note

A scheduled task deletes the errors after the configured number of days.

See also

The Errors can be found by opening the main menu item:

Export#

The Export stores the saved exports for each User. An export is composed of a list of Field names. When an Export is associated with a Group, it becomes available for all the Users of that Group.

See also

The exports can be found by opening the main menu item:

Language#

The Language defines the properties such as the direction and the formatting of the supported languages. By loading the translations for a Language, it becomes translatable and can be used to translate the user interface.

See also

The Languages can be found by opening the main menu item:

Message#

The Message stores translatable text that is shown to the Users.

See also

The Messages can be found by opening the main menu item:

Note#

Note is a ResourceMixin that stores User’s messages associated with any ModelStorage record. The Note keeps track of who has read each message.

See also

Notes are found by opening the main menu item:

The notes related to a record are found by opening the Note menu item of the toolbar.

Queue#

The Queue stores the tasks to be run asynchronously. An expected datetime can be set to define when the task should be run.

Rule Group#

The Rule Group stores a set of Rules that define the access rights for records of a Model.

See also

The Rule Group can be found by opening the main menu item:

Rule#

The Rule defines a Domain for a Rule Group.

Sequence#

The Sequence defines the properties to generate unique and sequential strings with numbers. A prefix and suffix can be added to the generated sequence string. These support formatting that can include the current Date.

See also

The Sequences can be found by opening the main menu item:

Sequence Strict#

The Sequence Strict is similar to the Sequence but it prevents any gaps in the generated numbers.

See also

The Sequences Strict can be found by opening the main menu item:

Sequence Type#

The Sequence Type is used to categorize the Sequences and defines the Groups allowed to edit them.

See also

The Sequence Types can be found by opening the main menu item:

Session#

The Session generates and stores the session keys for connected Users.

Session Wizard#

The Session Wizard stores the data from active State of the Wizard.

Translation#

The Translation stores the translated strings for each Language.

Wizards#

Set Translation#

The Set Translation wizard creates missing entries for the en language for the activated modules.

Clean Translation#

The Clean Translation wizard deletes obsolete entries.

Update Translation#

The Update Translation wizard creates missing entries for other languages based on the en entries.

Export Translation#

The Export Translation wizard generates a PO-file for the selected module and language.

Open Report Translation#

The Open Report Translation wizard opens the list of translations for the Reports.

Trigger#

The Trigger registers the conditions and the action to execute when a Model record is modified.

See also

The Triggers can be found by opening the main menu item:

UI Menu#

The Menu defines the tree structure for the client menu. Each entry may be linked to one or more Actions via the tree_open keyword. Also, each User can add menu records to their favorites.

See also

The Menu entries can be found by opening the main menu item:

UI View#

The View stores the definitions of the different types of view for each Model. A View can inherit from another View to extend its content.

See also

The Views can be found by opening the main menu item:

Wizards#

Show View#

The Show View wizard renders the form View.

UI View Tree Width#

The View Tree Width stores the User’s desired column widths for each Field of the Model.

See also

The View Tree Widths can be found by opening the View Tree Width from the Model’s Open related records menu.

UI View Tree Optional#

The View Tree Optional stores whether a User wants an optional field to be displayed or not for a View.

See also

The View Tree Optionals can be found by opening the View Tree Optional from the Model’s Open related records menu.

UI View Tree State#

The View Tree State stores, for each User, the tree view’s expanded and selected nodes for a Model, Domain and children.

See also

The View Tree States can be found by opening the View Tree State from the Model’s Open related records menu.

UI Icon#

The Icon defines the path where a named icon is stored.

See also

The Icons can be found by opening the main menu item: