openbudget / budgetkey-app-generic-item Goto Github PK

Define a method for specifying that a certain header should be a link.
Links should be displayed as an icon, not with the full url.

Open Office Tender (`WHERE tender_type = 'central')

dynamic values:

in this PR a search bar was added to the ng2-components header, need to integrate the latest ng2-components, enable the search bar in the header and fix the design of the search bar in ng2-components (functionality works)

The purpose of this issue is to translate different purchasing methods into 1-3 words labels + more info to show more (accessible) info of the original raw value, as part of #67

see details at the 2nd tab of: https://docs.google.com/spreadsheets/d/1kF1rGO8_2Siri6UfgmawGBnA5Yu86QOz-P9iguqQNKM/edit#gid=1232287862 (second tab)

new version:

https://docs.google.com/spreadsheets/d/1JkZooBwoxKPlrXWWwUtNHLMdxc-iG0n5tdGZ23I8fYY/edit?ts=5b28da0a#gid=1250185114

reproduction

• open this contract-spending item link
• click on another item from the table, e.g. the first item from 2015-01-12 - שעות ייעוץ

expected

• show the item

actual

• not found
  

This app is supposed to provide information on a single budget item (be it a top-level, 2 digit item or an 8-digit TAKANA).

The basic layout consists of a

1. title,
2. textual area with dynamically generated text
3. analysis area with multiple tabs, each showing a different aspect or visualisation of the item.

The basic design can be seen here: https://projects.invisionapp.com/d/main#/console/7587193/166401746/preview

For now the task is to implement bullets (1) and (2) from above.

follow-up of #72

remove the page title + ", ", leave the decision as is.

page design: https://projects.invisionapp.com/d/main#/console/7587193/272380789/preview

Columns containing currency should be formatted with ',' separators and decimal points, and have ₪ at the end.
(This should not apply to all numbers, as some might be non currency - e.g. years)

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Open Office Tender (`WHERE tender_type = 'office' AND decision='חדש') OR (decision='עודכן'))

dynamic values:

Follow up of #71:

(taken from http://next.obudget.org/i/tenders/central/553418/technology-2-2014?li=15)

When was it opened? closed? documents updated?

might be relevant for tender exemptions and office tenders as well

...follow up of #47

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Open Office Tender (FROM procurement_tender WHERE 'TENDER_TYPE' == 'central')

Dynamic Values:

split the tender's SUBJECT field to a list of values, by the ; separator.

See this example tender subjects list for example:
מחשוב ותקשורת; מכשירי תקשורת ואביזרים; רכיבים לטכנולוגיות מידע ושידור; יחידות אחסון נתונים; מחשבים; תוכנות;מדפסות; מסכי מחשב; ציוד נלווה למחשוב; שרתים; ציוד תקשורת מולטימדיה ו- DataVoice

Edit app/descriptors/org/municipality/text-template.html to make it more descriptive and include all information that we have regarding a municipality.

(This is an overarching issue - should be split into smaller, sub-issues)

The generic item page is the main workhorse of the site. It will show information regarding a single entity stored in our database: it could be a budget item, an organisation or a transaction.

Layout

It will always have the same layout, although it would present things differently depending on the entity type (naturally).
The layout consists of these sections:

• Header
  Containing the name of the element and some main property it has, for example:
  • Monetary amount for a budget item
  • Type of organisation (company / ngo)
• Text blob
  Free text providing extra details regarding the entity. Could have non-trivial logic controlling it (e.g. there would be a different description if this is a new budget item or an old one, if it's big or small etc.)
• Visualisations TBD
• Data query panel (see below)

Getting the data:

Each entity will have a single document will contain all data necessary to render the page.
This means that the flow of the page will always start with a single API call to get the relevant document (based on the path) and no other API calls should be necessary.

How does the page know how to show the document?

The customisation of the page to the different kinds should be (as much as possible) in configuration and not code.
The goal is that changing the page's behaviour for a single kind of page wouldn't require diving into the code, just changing a configuration file.
Configuration files should be simple enough to use and edit, and could be baked into something more comfortable for the code during the build process.

e.g. (just an example, not a spec)

{
    'path-prefix`: '/org/company/',
    'title-template': '{{name}}',
    'subtitle-template': '{{kind}}, received {{amount_received}} from the government',
    'text-template': '{{name}} was founded in year {{founded_year}}, bla bla bla',
    'questions': [{
        'text': 'How much <source> money was received by this company',
        'query': 'SELECT * from funding where company_id={{id}} and source IN ({{source}})',
        'parameters': {
           'source': {'Subsidy': "'s'",
                            'Procurement': "'p'",
                            'All': "'s', 'p'"}
         }
    }]
}

The data to build this configuration object might come from a set of files in a directory, e.g.

+ org/
   + company/
       + title-template.html
       + subtitle-template.html
       + text-template.html
       + questions.json
       + visualisations.json

Data query panel:

The panel will be affixed to the bottom of the page, and when opened will show a few question templates - based on the current entity type. For example, if it's an organisation, the question template might be:
"All the <subsidies/procurement/any> this organisation received between years and "
Each selection would be a dropdown that the user might choose a value.
When selected, the client will generate an SQL query which would be sent to the server, executed and returned to the client to be presented in a table.
The user might then download the data to CSV or get a link to open the query in re:dash.

API Endpoints

None of the APIs are currently implemented.
Please work with mocks, and we'll implement the APIs also based on what this page needs.

Implement a standalone ng2 component providing a sankey visualisation, fit for the initial prototype (Described in #1)

follow-up of #47:

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Closed (finished Office Tender (WHERE tender_type = 'office' AND (decision='הסתיים') dynamic values:

(taken on: http://next.obudget.org/i/tenders/central/553418/technology-2-2014?li=15)

1. No date is shown. If for any reason this is because there is actually no value in the date field, we should change label into: "תאריך פרסום לא ידוע", but this should be a real edge case scenario, as usually we have the date.

2. Make both icons clickable as well.

on page load all is viewable:

when we scroll the page down the site header should stay fixed:

until the item title pushes them out:

and replaces them as the fixed header:

On scroll up the site header should appear immediately (revealing the search):

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Open Office Tender (WHERE tender_type = 'central' AND decision='בתוקף')

dynamic values:

for example 598403/central/Goods-19-2017

This issue to include queries definitions for:

• התקשרות
• מכרז
• פטור

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

(FROM procurement_tenders_exemptions_processed)

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Open Office Tender (WHERE tender_type = 'central' AND decision='בתוקף')

dynamic values:

1 | any of the fields |none| if a value changed during TODAY <= LAST_UPDATE_DATE + 7 daysvalue should be עודכן!, if TODAY <= START_DATE + 7 value should be חדש! | do not use the decision field value here, as it is not reflecting what we intend to show with this label. | Don't use the raw value of the decision field, as it does not consist the required logic! |
2 | decision | none | מכרז פתוח: based on the decision field: if decision == בתוקף ||
3 | LAST_UPDATE_DATE | עדכון אחרון | date | dd.mm.yyyy |
4 | START_DATE | פרסום ראשון | date | dd.mm.yyyy |
5 | page_title (transformed) | | take out the 'מכרז XXXX:', we should transform other types of tenders titles (RFI or Group Agreements) | BOLD |
6 | decision | none | based on the decision בםמאקמא ||
7 | | none | | מנהל הרכש הממשלתי | |
8 | quarterly_contract_spending_reports.supplier_name | none | A. if the tender_id appears in quarterly_contract_spending_reports.manof_ref and count('supplier_name') == 1, display supplier_name). B. if count('supplier_name') > 2, display [num] ספקים. C. Otherwise, leave empty | 9a | quarterly_contract_spending_reports.executed, quarterly_contract_spending_reports.volume| | pie chart || 9b | quarterly_contract_spending_reports.executed, quarterly_contract_spending_reports.volume | 'עד כה בוצעו...% מתוך: | exectued / volume | dd% (round result). Notice this formula should relate to ALL relevant suppliers (using manof_ref) |
9c | quarterly_contract_spending_reports.executed | none | sum of all exectued values for the relevant manof_ref | add NIS symbol to value|
10 | SUBJECTS | | label per each value. Each label should be linked to a search results page of procurement_tenders from the same topic |
11 | 'description' | תיאור | | |
12a | tender_id| מספר מנו"ף | tender_id | |
12b | REGULATION | סוג: | if RFI --> בקשת מידע, if 'מכרז'--> מכרז מרכזי', if 'הסכם מסגרת' --> הסכם מסגרת | |
12c | CLAIM_DATE | מועד סגירה: ... בשעה... | | dd.mm.yyyy + HH:MM: |
12d| CONTACT | אנשי קשר: | | email adresses should be clickable and open user's email client|
13a | actionable A # | | | to be handled on a follow #51 |
13b | actionable B # | | | to be handled on a follow #51 |
14 | (table intro) | table headers : הזוכים במכרז, סכום ההתקשרות, עד כה שולם | values in this block are to be calculated by the intersection between current tender_id and ``quarterly_contract_spending_reports.manof_ref. Table should be sorted by the value` amount (13b) in a decreasing order (biggest value, first row) |
14a | `quarterly_contract_spending_reports.supplier_name` | | | in the future it would be linked to future entity page, currently nothing special |
14b | `quarterly_contract_spending_reports.volume`| none, add a NIS symbol | sum of `quarterly_contract_spending_reports.volume` of the concrete supllier under the concrete `manof_ref` | don't round result, display real number (up to 2 digits after demical point) |
14c | `quarterly_c`quarterly_contract_spending_reports.executed`| none, add a NIS symbol | sum of `quarterly_contract_spending_reports.executed` of the concrete supllier under the concrete `manof_ref` | don't round result, display real number (up to 2 digits after demical point) |
14d | | link to the relevant התקשרות page| |
15 | (table intro) | table shows chronological history of the tender, in a reversed order. Two type of updates to be included: tender status change (bolded), payment (taken from the quarterly report) (bolded row), uploading/updating file (normal text for the entrie row) | |
15a |`quarterly_c`quarterly_contract_spending_reports.volume`, `quarterly_c`quarterly_contract_spending_reports.executed` | no headers | pie chart of the `executed` out of the total `volume` | the pie chart refers to the tender's total exectued out of the total approved values, not to be confused with 13 above |
15b | (update date -- from either `quarterly_c`quarterly_contract_spending_reports` or `procurement_tenders` | | if date == Today --> `היום`, if Today - date <= 7 --> `ימים x לפני`, if Today- date < 4 weeks, divide days number by 7 --> `לפני כ-x שבועות`, otherwise: raw date (DD.MM.YYYY) | |
15c | `quarterly_contract_spending_report.PAGE_URL` or `quarterly_contract_spending_reports.REPORT-URL`| don't show address, just display the icon with a relevant link | | to be opened in a new tab|
15d | update message | | |needs to set logic to be handled in a separate issue, to be hanled in #52 |
16 | grid intro, based on `procurement_tenders.DOCUMENTS` | `הוראות שעה וקבצים מצורפים` | | |
16a | `update_time` | none | (update date -- from either `quarterly_contract_spending_reports` or `procurement_tenders`) if date == Today --> `היום`, if Today - date <= 7 --> `ימים x לפני`, if Today- date < 4 weeks, divide days number by 7 --> `לפני כ-x שבועות`, otherwise: raw date (DD.MM.YYYY) ||
16b | icon + file name | | icon to be set by the file type extention (doc/pdf/xls/csv), each element should be linked to the `link` address. If the number of elements is bigger than 3, start a new row of elements |

Cases:

• no data
• connectivity error
• etc…

Follow up of #71:

(taken from http://next.obudget.org/i/tenders/central/553418/technology-2-2014?li=15)

If the description field length > 34 :

1. Trim the top description after 34 characters (+'....')
2. add a new label ("תיאור") with the full value

followup of #72:

fix the flow pie charts:

If there is not transactions in the step, keep the previous pie chart

In case there is a single supplier, we better omit the percentages column (it will always be 100%) - as it is confusing, when looking at the top right corner of the screen.

Another alternative is to add a table header, but I could not think of a short and clear definition, and therefore would recommend on the conditional display.

Edit app/descriptors/org/budget/*/text-template.html to make them more descriptive and include all information that we have regarding the budget item.

Take into account the differences between 2-digit items, 4-digit items etc. to customise the text to the hierarchy.

Modify the file descriptors/org/questions.json to add the following:

סך התמיכות שהארגון קיבל, לפי שנה) לפי סה״כ כספים ששולמו/אושרו בשנה כלשהי/כלל השנים
כלל ההתקשרויות עם הארגון (מסודרות לפי שנה ותקנה תקציבית) שהתחילו/שהן פעילות בשנה כלשהי/כלל השנים
התקנות מולן יש לארגון התקשרויות, לפי היקף/סה״כ כספים ששולמו שהתחילו/שהן פעילות בשנה כלשהי/כלל השנים
סך ההתקשרויות שיש לארגון (לפי שנה), לפי היקף/סה״כ כספים ששולמו שהתחילו/שהן פעילות בשנה כלשהי/כלל השנים
כלל הפטורים ממכרז עם הארגון (מסודרים לפי היקף), מסיבה מסוימת/כלל הסיבות שהתחילו/שהם פעילים בשנה כלשהי/כלל השנים

• add loader while results are loading
• add indication when no results were received
• add indication when an error occurred

Modify descriptors/budget/.../questions.json to answer these questions:

• היסטוריה תקציבית של הסעיף (מאושר+על שינוייו+ביצוע לפי שנים).
• אחוז הניצול בשנה זו, לאורך שנים, אולי סימון מיוחד כאשר הניצול לאורך זמן נמוך מ50% ("חשוד כרזרבה סמויה")
• פירוט כלל סעיפי הבנים הישירים של הסעיף לשנה כלשהי/כלל השנים
• פירוט כלל סעיפי הבנים הישירים של הסעיף לשנה כלשהי באחוזים מכלל התקציב
• פירוט כלל סעיפי הבנים (גם הלא הישירים) של הסעיף לשנה כלשהי/כלל השנים
• אילו ארגונים מקבלים תמיכות מסעיף זה (מסודר לפי גודל התמיכה) בשנה כלשהי/כלל השנים
• כלל התמיכות מסעיף זה (מסודר לפי שנים ומספר תקנה) ששולמו/אושרו בשנה כלשהי/כלל השנים
• הספקים הגדולים מסעיף זה (מסודר לפי גודל ההתקשרות/סה״כ ששולם) בשנה כלשהי/כלל השנים
• כלל ההתקשרויות מסעיף זה (מסודר לפי שנים ומספר תקנה) שהתחילו/שהן פעילות בשנה כלשהי/כלל השנים
• העברות תקציביות (מסודרות לפי זמן) תחת סעיף זה מסוג מסוים/כלל הסוגים עם/בלי דברי הסבר שממתינים לאישור/כבר אושרו/הכל

currently, we have the aggregated executed amount of payments per order_id + manof_ref.

We need to know per row the exact amount that has been transferred (paid). We can do so by subtracting the current executed amount from the previous (last transaction/reported row) executed.

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Open Office Tender (WHERE tender_type = 'office' AND (decision='הסתיים`) dynamic values:

We want the page title to be indexed correctly in search engines, as well as contain some semantic information.

The solution is to query the referenced document on the server side and render the returned document to contain:

1. The correct title
2. The relevant structured data (https://developers.google.com/search/docs/guides/intro-structured-data)
3. Possibly the entire data, so that the client doesn't need to hit the API.

follow-up of #47

..
Defining critera:

FROM procurement_tenders
WHERE tender_type = 'office'  AND decision='בוטל'

(Invisoin link: https://projects.invisionapp.com/d/main#/console/7587193/276178413/preview )

Open Office Tender (WHERE tender_type = 'office' AND (decision='חדש'` or decision='עודכן') dynamic values:

The table below includes potential updates to the office tender's page chornological block:

a.t.m. it's more or less random.
we want to select a single combination of filters which will be shown by default.

(taken on http://next.obudget.org/i/tenders/central/553418/technology-2-2014?li=15)

Anyhow, we can not show the 'N/A'

Might be relevant for exemptions and office tenders as well (could tell what's the trigger for this behaviour)

Edit app/descriptors/org/association/text-template.html to make it more descriptive and include all information that we have regarding a company.

Add a descriptors/supports/questions.json which implements the following questions:

• סך התמיכות שיצאו מהתקנה הזו לנמען של התמיכה בשנים אחרות (מסודרות לפי שנה) ששולמו/אושרו בשנה כלשהי/כלל השנים
• כלל התמיכות שיצאו מהתקנה הזו (מסודרות לפי שנה ונמען) ששולמו/אושרו בשנה כלשהי/כלל השנים
• סך התמיכות שיצאו מהתקנה הזו (מסודרות לפי שנה) ששולמו/אושרו בשנה כלשהי/כלל השנים
• כלל התמיכות שהנמען של התמיכה קיבל (מסודרות לפי שנה ותקנה תקציבית) ששולמו/אושרו בשנה כלשהי/כלל השנים
• תקנות נוספות מהן הנמען של התמיכה קיבל תמיכות, לפי סה״כ כספים ששולמו/אושרו בשנה כלשהי/כלל השנים
• סך התמיכות שהארגון קיבל (מסודרות לפי שנה ותקנה תקציבית) לפי סה״כ כספים ששולמו/אושרו בשנה כלשהי/כלל השנים

Actual:

• Work in dev mode (npm run dist-serve)
• Update one of the html templates in descriptors/
• Webpack rebuilds the app
• Browser is refreshed manually
• Template changes are not visible
• Restart npm run dist-serve
• Browser is refreshed manually
• Template changes are now visible

Expected:

• Template changes should be visible without having to restart npm

Analysis:
Seems that after a refresh, the returned index.html is an old version and not the updated version (with the updated scripts).

For some predefined scenarios of the process (i.e. procurement_tenders+quarterly spending, we should display user possible actions they can take in the real world. Notice the static text should consist also dynamic (relevant) links for the specific entities.

We should enable up to two actionable recommendations (A and B).

This issue is to define the data structure for the new mechanism, in a way that will enable us to use it also on other spots in the OpenBudget Project (i.e. not only on tenders).

Edit app/descriptors/org/company/text-template.html to make it more descriptive and include all information that we have regarding a company.

at the moment, the headers are alphabetically ordered.

all links to other budgetkey apps should contain theme param

Reference:

https://projects.invisionapp.com/d/main#/console/7587193/253951995/preview

1. optional filters: "הכל", "מכרזים","מכרזים משרדיים","מכרזים מרכזיים","פטור ממכרז","התקשרויות". notice: מכרזים will incldue both מכרזים משרדיים and מכרזים מרכזיים

2. time filter. label: "מועד פרסום", options: שבוע אחרון, חודש אחרון, שנה אחרונה, הכל, טווח תאריכים לבחירתך.

3. cancel the time graph.

4-7: search results items sorting logic:

• in the same weight, an item with the queried item as a subject label will be shown first
• in the same weight, open/active items will be shown before a closed
• in the same weight, different kinds will be weighted by their type (descending order): central --> office --> exemption --> procurement.

4-6(a): type
4-6(b): description
4-6(c): publisher
4-6(d): supplier(s). add +[number] if more than one.
4-6(e): 8(e): label: אופן הרכש:, value: accessilbe (long) version of purchase_method, as implemented on #68.
4-6(f): (optional): approved amount, don't remember to add ILS and to omit the decimal fraction.
4-6(g): start date - [optional: end date]. if now end date, leave empty space after '-'

7 (not in the demo) התקשרות item:
7(a) התקשרות
7(b) purpose
7(c) publisher,purchasing unit (like in #67).
7(d) (optional), supplier(s) - add + [number] if more than one. show the supplier with the biggest approved/executed amount.
8(e): label: סיבת הפטור, value: accessible (long) version, as implemented on #68.
8(f): (optional): approved amount, don't forget to add ILS and to omit the decimal fraction.
8(g): start date - [optional: end date] (end date to be shown only if the status has changed to inactive, otherwise show "התקשרות פעילה")