View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Show collection (0 pages)
Collections help

Search

ERP 2.50:Functional Documentation/Alerts -1

Contents

Introduction

Alerts are the way Openbravo ERP informs users about virtually any event that happens in the system and the administrator has defined a rule to show it.

The workflow for alerts is as follows:

It is planned to increase alerts functionality with the Intrusive Alerts project.

Components

Alert Rules

Alert rules are the alert definitions, each alert instance is generated by an alert rule.

The main information an alert rule contains is:

SQL

The background process will execute this SQL clause, for each row it returns a new alert instance will be created with the obtained values.

I.e. if we want to know which partners have reached a credit limit, we will have to create a SQL that returns a row for each of these partners.

This SQL clause must return the following fields (that will fit the fields in the alert instance table):

Filter Clause

This clause is a where clause that will be applied to the already existing alert instances, in case the clause is not met the alerts will not be shown.

The purpose of this clause is to have the capability of taking into account session variables in order to know if an alert instance is going to be shown or not. For example, using filters you can display an alert only if the user has logged in to a specific warehouse (i.e. the warehouse inserted in the m_warehouse_id field in the alert instance).

Recipients

Alert recipients define who will be able to see alert instances.

Recipients are defined as roles and users; the role attribute is mandatory while user is optional. If a user is specified, any user accessing the application with the role will see the alert instances of the alert rule; otherwise, the alert instance is displayed only to the specified user logging in with the specified role.

In addition, it is possible to check whether a mail will be sent to the recipients every time an alert instance is generated.

Tab

This section allows you to specify the tab to use as navigation target for the alert instance. The navigation will use the referencekey field as primary key of the record to navigate to.

For example, if your alert rule returns business partners exceeding a credit limit, you can specify here the Business Partner tab so that the recipients of the alert can navigate directly to the Business Partner window where the business partner triggering the rule is automatically retrieved.

Background process

A background process is executed permanently to check alert rules; it creates new alert instances whenever the SQL clause defined in the rule returns at least one record.

This process works as follows:

Alert Instances

Alert instances are the actual alerts. They are what final users will be able to see and manage. They are created by the background process and are dependent of an alert rule.

There is a visualization process that checks if any of the existing active and non fixed alert instances has as recipient the user/role that has made login and meets the filter clause. All the instances with these conditions are counted and displayed to the user.

Known Issues

Retrieved from "http://wiki.openbravo.com/wiki/ERP_2.50:Functional_Documentation/Alerts_-1"

This page has been accessed 22,583 times. This page was last modified on 18 February 2016, at 09:55. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.