This is an old revision of the document!
Table of Contents
CHECKLIST
Definition of the checklist functions that are developed in Eubrewnet
The users with the right permissions have access to some functions to directly check some tests that can be do to Brewers. The root of the access functions is the same for all http://rbcce.aemet.es/eubrewnet/data/checklist. From this point users can select different function. As Example Check SI.
The SI check function tests if the Brewer Operators perform Sittings periodically. The Regional Brewer Calibration Center Europe has stablished a standard of one test every week. The check is OK (returns True as result) if the number of Sittings per week is greater or equal to one. It is possible to modify the reference to change the number of sittings per week.
- It receives as inputs brewerid, date and enddate: Use of check SI with brewerid, date and enddate
- Optionally, a reference (v2) input parameter can be provided (The 1.0 default value is changed by v2, if there's no need to perform at least one Sitting per week): Use of check SI changing
Description of the SI Check Function:
- Function: SI
- Description: The Sitting tests have to be done periodically. The RBCCE has stablished a standard of one test every week. The test is passed if the number of sittings per week during period is greater or equal to v2 (1 by default). v2 can be passed as parameter to change the reference value. For less than a sitting per week, use decimal values: for example, 0.25 means 1 sitting every month.
- Inputs:
- brewerid: see Brewerid in common inputs
- date: see Date in common inputs
- enddate: see Enddate in common inputs
- v2: see V2. New reference to compare if there are enough Sittings during period
- Output: Number of sittings during daterange and dates
- result: True if the number of Sittings is greater or equal
- v1: Number of Sittings during period
- v2: Reference value (1.0 by default)
- comments: List of dates when the sittings have been done
There is a Check Function Table with a summary of the available functions to perform tests and their links as example. The extended documentation for each function can be directly access from the table using the links in the column Long Description. There is a Google Spread Sheet with the complete table with all the information in one view.
There are common inputs for the functions as the parameter brewerid wich can be used in almost every function are listed in codes:checklist#common_inputs. The description can be found in the COMMON SECTION.
For security purposes user authentication has been added to this tools and their use is registered.
COMMON
Common Inputs
Almost all functions receive the following inputs, too:
- brewerid: Brewer identification number
- date: Start date of a period (yyyy-mm-dd format)
- enddate: End date of a period (yyyy-mm-dd format). If it is not provided, the period will be only one day.
- v2 (optional): There are functions with reference values that can change depending on Brewer. Commonly