1 DROP SCHEMA acq CASCADE;
11 CREATE TABLE acq.currency_type (
12 code TEXT PRIMARY KEY,
16 -- Use the ISO 4217 abbreviations for currency codes
17 INSERT INTO acq.currency_type (code, label) VALUES ('USD','US Dollars');
18 INSERT INTO acq.currency_type (code, label) VALUES ('CAN','Canadian Dollars');
19 INSERT INTO acq.currency_type (code, label) VALUES ('EUR','Euros');
21 CREATE TABLE acq.exchange_rate (
22 id SERIAL PRIMARY KEY,
23 from_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
24 to_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
25 ratio NUMERIC NOT NULL,
26 CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
29 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','CAN',1.2);
30 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','EUR',0.5);
32 CREATE TABLE acq.claim_policy (
33 id SERIAL PRIMARY KEY,
34 org_unit INT NOT NULL REFERENCES actor.org_unit
35 DEFERRABLE INITIALLY DEFERRED,
37 description TEXT NOT NULL,
38 CONSTRAINT name_once_per_org UNIQUE (org_unit, name)
41 CREATE TABLE acq.claim_event_type (
42 id SERIAL PRIMARY KEY,
43 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
44 DEFERRABLE INITIALLY DEFERRED,
46 description TEXT NOT NULL,
47 library_initiated BOOL NOT NULL DEFAULT FALSE,
48 CONSTRAINT event_type_once_per_org UNIQUE ( org_unit, code )
51 CREATE TABLE acq.claim_policy_action (
52 id SERIAL PRIMARY KEY,
53 claim_policy INT NOT NULL REFERENCES acq.claim_policy
55 DEFERRABLE INITIALLY DEFERRED,
56 action_interval INTERVAL NOT NULL,
57 action INT NOT NULL REFERENCES acq.claim_event_type
58 DEFERRABLE INITIALLY DEFERRED,
59 CONSTRAINT action_sequence UNIQUE (claim_policy, action_interval)
62 CREATE TABLE acq.provider (
63 id SERIAL PRIMARY KEY,
65 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
66 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
70 edi_default INT, -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
71 active BOOL NOT NULL DEFAULT TRUE,
72 prepayment_required BOOL NOT NULL DEFAULT FALSE,
77 default_claim_policy INT REFERENCES acq.claim_policy
78 DEFERRABLE INITIALLY DEFERRED,
79 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
80 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
83 CREATE TABLE acq.provider_holding_subfield_map (
84 id SERIAL PRIMARY KEY,
85 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
86 name TEXT NOT NULL, -- barcode, price, etc
87 subfield TEXT NOT NULL,
88 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
91 CREATE TABLE acq.provider_address (
92 id SERIAL PRIMARY KEY,
93 valid BOOL NOT NULL DEFAULT TRUE,
95 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
96 street1 TEXT NOT NULL,
101 country TEXT NOT NULL,
102 post_code TEXT NOT NULL,
103 fax_phone TEXT NOT NULL
106 CREATE TABLE acq.provider_contact (
107 id SERIAL PRIMARY KEY,
108 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
110 role TEXT, -- free-form.. e.g. "our sales guy"
115 CREATE TABLE acq.provider_contact_address (
116 id SERIAL PRIMARY KEY,
117 valid BOOL NOT NULL DEFAULT TRUE,
119 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
120 street1 TEXT NOT NULL,
125 country TEXT NOT NULL,
126 post_code TEXT NOT NULL,
130 CREATE TABLE acq.provider_note (
131 id SERIAL PRIMARY KEY,
132 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
133 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
134 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
135 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
136 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
139 CREATE INDEX acq_pro_note_pro_idx ON acq.provider_note ( provider );
140 CREATE INDEX acq_pro_note_creator_idx ON acq.provider_note ( creator );
141 CREATE INDEX acq_pro_note_editor_idx ON acq.provider_note ( editor );
144 CREATE TABLE acq.funding_source (
145 id SERIAL PRIMARY KEY,
147 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
148 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
150 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
153 CREATE TABLE acq.funding_source_credit (
154 id SERIAL PRIMARY KEY,
155 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
156 amount NUMERIC NOT NULL,
158 deadline_date TIMESTAMPTZ,
159 effective_date TIMESTAMPTZ NOT NULL default now()
162 CREATE VIEW acq.ordered_funding_source_credit AS
164 CASE WHEN deadline_date IS NULL THEN
168 END AS sort_priority,
169 CASE WHEN deadline_date IS NULL THEN
179 acq.funding_source_credit;
181 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
183 * Copyright (C) 2009 Georgia Public Library Service
184 * Scott McKellar <scott@gmail.com>
186 * The acq.ordered_funding_source_credit view is a prioritized
187 * ordering of funding source credits. When ordered by the first
188 * three columns, this view defines the order in which the various
189 * credits are to be tapped for spending, subject to the allocations
190 * in the acq.fund_allocation table.
192 * The first column reflects the principle that we should spend
193 * money with deadlines before spending money without deadlines.
195 * The second column reflects the principle that we should spend the
196 * oldest money first. For money with deadlines, that means that we
197 * spend first from the credit with the earliest deadline. For
198 * money without deadlines, we spend first from the credit with the
199 * earliest effective date.
201 * The third column is a tie breaker to ensure a consistent
206 * This program is free software; you can redistribute it and/or
207 * modify it under the terms of the GNU General Public License
208 * as published by the Free Software Foundation; either version 2
209 * of the License, or (at your option) any later version.
211 * This program is distributed in the hope that it will be useful,
212 * but WITHOUT ANY WARRANTY; without even the implied warranty of
213 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
214 * GNU General Public License for more details.
218 CREATE TABLE acq.fund (
219 id SERIAL PRIMARY KEY,
220 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
222 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
223 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
225 rollover BOOL NOT NULL DEFAULT FALSE,
226 propagate BOOL NOT NULL DEFAULT TRUE,
227 active BOOL NOT NULL DEFAULT TRUE,
228 balance_warning_percent INT CONSTRAINT balance_warning_percent_limit
229 CHECK( balance_warning_percent <= 100 ),
230 balance_stop_percent INT CONSTRAINT balance_stop_percent_limit
231 CHECK( balance_stop_percent <= 100 ),
232 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
233 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
234 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
237 CREATE TABLE acq.fund_debit (
238 id SERIAL PRIMARY KEY,
239 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
240 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
241 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
242 amount NUMERIC NOT NULL,
243 encumbrance BOOL NOT NULL DEFAULT TRUE,
244 debit_type TEXT NOT NULL,
245 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
246 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
249 CREATE TABLE acq.fund_allocation (
250 id SERIAL PRIMARY KEY,
251 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
252 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
253 amount NUMERIC NOT NULL,
254 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
256 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
258 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
260 CREATE TABLE acq.fund_allocation_percent
262 id SERIAL PRIMARY KEY,
263 funding_source INT NOT NULL REFERENCES acq.funding_source
264 DEFERRABLE INITIALLY DEFERRED,
265 org INT NOT NULL REFERENCES actor.org_unit
266 DEFERRABLE INITIALLY DEFERRED,
268 percent NUMERIC NOT NULL,
269 allocator INTEGER NOT NULL REFERENCES actor.usr
270 DEFERRABLE INITIALLY DEFERRED,
272 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
273 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
274 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
277 -- Trigger function to validate combination of org_unit and fund_code
279 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
280 RETURNS TRIGGER AS $$
295 AND code = NEW.fund_code
301 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
306 CREATE TRIGGER acq_fund_alloc_percent_val_trig
307 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
308 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
310 -- To do: trigger to verify that percentages don't add up to more than 100
312 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
313 RETURNS TRIGGER AS $$
316 total_percent numeric;
324 acq.fund_allocation_percent AS fap
326 fap.funding_source = NEW.funding_source;
328 IF total_percent > 100 THEN
329 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
337 CREATE TRIGGER acqfap_limit_100_trig
338 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
339 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
341 CREATE TABLE acq.picklist (
342 id SERIAL PRIMARY KEY,
343 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
344 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
345 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
346 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
348 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
349 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
350 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
352 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
353 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
354 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
356 CREATE TABLE acq.cancel_reason (
357 id SERIAL PRIMARY KEY,
358 org_unit INTEGER NOT NULL REFERENCES actor.org_unit( id )
359 DEFERRABLE INITIALLY DEFERRED,
361 description TEXT NOT NULL,
362 keep_debits BOOL NOT NULL DEFAULT FALSE,
363 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
366 -- Reserve ids 1-999 for stock reasons
367 -- Reserve ids 1000-1999 for EDI reasons
368 -- 2000+ are available for staff to create
370 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
372 CREATE TABLE acq.purchase_order (
373 id SERIAL PRIMARY KEY,
374 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
375 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
376 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
377 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
378 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
379 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
380 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
381 state TEXT NOT NULL DEFAULT 'new',
382 order_date TIMESTAMP WITH TIME ZONE,
384 cancel_reason INT REFERENCES acq.cancel_reason( id )
385 DEFERRABLE INITIALLY DEFERRED,
386 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE
388 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
389 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
390 CREATE INDEX po_state_idx ON acq.purchase_order (state);
391 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
392 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
393 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
395 -- The name should default to the id, as text. We can't reference a column
396 -- in a DEFAULT clause, so we use a trigger:
398 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
401 IF NEW.name IS NULL THEN
402 NEW.name := NEW.id::TEXT;
409 CREATE TRIGGER po_name_default_trg
410 BEFORE INSERT OR UPDATE ON acq.purchase_order
411 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
413 -- The order name should be unique for a given ordering agency on a given order date
414 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
415 -- this rule requires a check constraint with a subquery. However you can't have a
416 -- subquery in a CHECK constraint, so we fake it with a trigger.
418 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
424 -- If order_date is not null, then make sure we don't have a collision
425 -- on order_date (truncated to day), org, and name
427 IF NEW.order_date IS NULL THEN
431 -- In the WHERE clause, we compare the order_dates without regard to time of day.
432 -- We use a pair of inequalities instead of comparing truncated dates so that the
433 -- query can do an indexed range scan.
435 SELECT 1 INTO collision
436 FROM acq.purchase_order
438 ordering_agency = NEW.ordering_agency
440 AND order_date >= date_trunc( 'day', NEW.order_date )
441 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
444 IF collision IS NULL THEN
445 -- okay, no collision
448 -- collision; nip it in the bud
449 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
450 NEW.ordering_agency, NEW.order_date, NEW.name;
455 CREATE TRIGGER po_org_name_date_unique_trg
456 BEFORE INSERT OR UPDATE ON acq.purchase_order
457 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
459 CREATE TABLE acq.po_note (
460 id SERIAL PRIMARY KEY,
461 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
462 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
463 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
464 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
465 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
467 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
469 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
470 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
471 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
473 CREATE TABLE acq.lineitem (
474 id BIGSERIAL PRIMARY KEY,
475 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
476 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
477 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
478 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
479 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
480 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
481 expected_recv_time TIMESTAMP WITH TIME ZONE,
482 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
483 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
485 eg_bib_id INT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
487 state TEXT NOT NULL DEFAULT 'new',
488 cancel_reason INT REFERENCES acq.cancel_reason( id )
489 DEFERRABLE INITIALLY DEFERRED,
490 estimated_unit_price NUMERIC,
491 claim_policy INT REFERENCES acq.claim_policy
492 DEFERRABLE INITIALLY DEFERRED,
493 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
495 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
496 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
497 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
498 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
499 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
501 CREATE TABLE acq.lineitem_alert_text (
502 id SERIAL PRIMARY KEY,
505 owning_lib INT NOT NULL
506 REFERENCES actor.org_unit(id)
507 DEFERRABLE INITIALLY DEFERRED,
508 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
511 CREATE TABLE acq.lineitem_note (
512 id SERIAL PRIMARY KEY,
513 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
514 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
515 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
516 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
517 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
519 alert_text INT REFERENCES acq.lineitem_alert_text(id)
520 DEFERRABLE INITIALLY DEFERRED,
521 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
523 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
524 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
525 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
527 CREATE TABLE acq.lineitem_detail (
528 id BIGSERIAL PRIMARY KEY,
529 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
530 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
531 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
532 eg_copy_id BIGINT REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
536 collection_code TEXT,
537 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
538 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
539 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
540 recv_time TIMESTAMP WITH TIME ZONE,
541 cancel_reason INT REFERENCES acq.cancel_reason( id ) DEFERRABLE INITIALLY DEFERRED
544 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
546 CREATE TABLE acq.lineitem_attr_definition (
547 id BIGSERIAL PRIMARY KEY,
549 description TEXT NOT NULL,
550 remove TEXT NOT NULL DEFAULT '',
551 ident BOOL NOT NULL DEFAULT FALSE
554 CREATE TABLE acq.lineitem_marc_attr_definition (
555 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
557 ) INHERITS (acq.lineitem_attr_definition);
559 CREATE TABLE acq.lineitem_provider_attr_definition (
560 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
562 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
563 ) INHERITS (acq.lineitem_attr_definition);
565 CREATE TABLE acq.lineitem_generated_attr_definition (
566 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
568 ) INHERITS (acq.lineitem_attr_definition);
570 CREATE TABLE acq.lineitem_usr_attr_definition (
571 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
572 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
573 ) INHERITS (acq.lineitem_attr_definition);
574 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
576 CREATE TABLE acq.lineitem_local_attr_definition (
577 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
578 ) INHERITS (acq.lineitem_attr_definition);
580 CREATE TABLE acq.lineitem_attr (
581 id BIGSERIAL PRIMARY KEY,
582 definition BIGINT NOT NULL,
583 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
584 attr_type TEXT NOT NULL,
585 attr_name TEXT NOT NULL,
586 attr_value TEXT NOT NULL
589 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
590 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
591 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
597 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
598 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('author','Author of work','//*[@tag="100" or @tag="110" or @tag="113"]/*[contains("ad",@code)]');
599 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
600 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
601 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
602 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
604 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
605 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
606 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
607 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
609 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
612 CREATE TABLE acq.distribution_formula (
613 id SERIAL PRIMARY KEY,
615 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
617 skip_count INT NOT NULL DEFAULT 0,
618 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
621 CREATE TABLE acq.distribution_formula_entry (
622 id SERIAL PRIMARY KEY,
623 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
625 DEFERRABLE INITIALLY DEFERRED,
626 position INTEGER NOT NULL,
627 item_count INTEGER NOT NULL,
628 owning_lib INTEGER REFERENCES actor.org_unit(id)
629 DEFERRABLE INITIALLY DEFERRED,
630 location INTEGER REFERENCES asset.copy_location(id),
631 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
632 CONSTRAINT acqdfe_must_be_somewhere
633 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
636 CREATE TABLE acq.distribution_formula_application (
637 id BIGSERIAL PRIMARY KEY,
638 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
639 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
641 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
642 lineitem INT NOT NULL
643 REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
646 CREATE INDEX acqdfa_df_idx
647 ON acq.distribution_formula_application(formula);
648 CREATE INDEX acqdfa_li_idx
649 ON acq.distribution_formula_application(lineitem);
650 CREATE INDEX acqdfa_creator_idx
651 ON acq.distribution_formula_application(creator);
653 CREATE TABLE acq.fund_tag (
654 id SERIAL PRIMARY KEY,
656 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
658 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
661 CREATE TABLE acq.fund_tag_map (
662 id SERIAL PRIMARY KEY,
663 fund INTEGER NOT NULL REFERENCES acq.fund(id)
664 DEFERRABLE INITIALLY DEFERRED,
665 tag INTEGER REFERENCES acq.fund_tag(id)
667 DEFERRABLE INITIALLY DEFERRED,
668 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
671 CREATE TABLE acq.fund_transfer (
672 id SERIAL PRIMARY KEY,
673 src_fund INT NOT NULL REFERENCES acq.fund( id )
674 DEFERRABLE INITIALLY DEFERRED,
675 src_amount NUMERIC NOT NULL,
676 dest_fund INT NOT NULL REFERENCES acq.fund( id )
677 DEFERRABLE INITIALLY DEFERRED,
678 dest_amount NUMERIC NOT NULL,
679 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
680 transfer_user INT NOT NULL REFERENCES actor.usr( id )
681 DEFERRABLE INITIALLY DEFERRED,
683 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
684 DEFERRABLE INITIALLY DEFERRED
687 CREATE INDEX acqftr_usr_idx
688 ON acq.fund_transfer( transfer_user );
690 COMMENT ON TABLE acq.fund_transfer IS $$
692 * Copyright (C) 2009 Georgia Public Library Service
693 * Scott McKellar <scott@esilibrary.com>
697 * Each row represents the transfer of money from a source fund
698 * to a destination fund. There should be corresponding entries
699 * in acq.fund_allocation. The purpose of acq.fund_transfer is
700 * to record how much money moved from which fund to which other
703 * The presence of two amount fields, rather than one, reflects
704 * the possibility that the two funds are denominated in different
705 * currencies. If they use the same currency type, the two
706 * amounts should be the same.
710 * This program is free software; you can redistribute it and/or
711 * modify it under the terms of the GNU General Public License
712 * as published by the Free Software Foundation; either version 2
713 * of the License, or (at your option) any later version.
715 * This program is distributed in the hope that it will be useful,
716 * but WITHOUT ANY WARRANTY; without even the implied warranty of
717 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
718 * GNU General Public License for more details.
722 CREATE TABLE acq.fiscal_calendar (
723 id SERIAL PRIMARY KEY,
727 -- Create a default calendar (though we don't specify its contents).
728 -- Create a foreign key in actor.org_unit, initially pointing to
729 -- the default calendar.
731 INSERT INTO acq.fiscal_calendar (
738 ALTER TABLE actor.org_unit ADD FOREIGN KEY
739 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
740 DEFERRABLE INITIALLY DEFERRED;
742 CREATE TABLE acq.fiscal_year (
743 id SERIAL PRIMARY KEY,
744 calendar INT NOT NULL
745 REFERENCES acq.fiscal_calendar
747 DEFERRABLE INITIALLY DEFERRED,
749 year_begin TIMESTAMPTZ NOT NULL,
750 year_end TIMESTAMPTZ NOT NULL,
751 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
752 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
755 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
756 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
757 in_dir TEXT -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
758 ) INHERITS (config.remote_account);
760 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
761 ALTER TABLE acq.edi_account ADD CONSTRAINT acq_edi_account_id_unique UNIQUE (id);
763 CREATE TABLE acq.edi_message (
764 id SERIAL PRIMARY KEY,
765 account INTEGER REFERENCES acq.edi_account(id)
766 DEFERRABLE INITIALLY DEFERRED,
768 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
769 translate_time TIMESTAMPTZ,
770 process_time TIMESTAMPTZ,
771 error_time TIMESTAMPTZ,
772 status TEXT NOT NULL DEFAULT 'new'
773 CONSTRAINT status_value CHECK
775 'new', -- needs to be translated
776 'translated', -- needs to be processed
777 'trans_error', -- error in translation step
778 'processed', -- needs to have remote_file deleted
779 'proc_error', -- error in processing step
780 'delete_error', -- error in deletion
781 'retry', -- need to retry
787 purchase_order INT REFERENCES acq.purchase_order
788 DEFERRABLE INITIALLY DEFERRED,
789 message_type TEXT NOT NULL CONSTRAINT valid_type CHECK
799 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
800 -- the table, assigning ids programmatically instead of using a sequence.
801 CREATE TABLE acq.debit_attribution (
802 id INT NOT NULL PRIMARY KEY,
803 fund_debit INT NOT NULL
804 REFERENCES acq.fund_debit
805 DEFERRABLE INITIALLY DEFERRED,
806 debit_amount NUMERIC NOT NULL,
807 funding_source_credit INT REFERENCES acq.funding_source_credit
808 DEFERRABLE INITIALLY DEFERRED,
809 credit_amount NUMERIC
812 CREATE INDEX acq_attribution_debit_idx
813 ON acq.debit_attribution( fund_debit );
815 CREATE INDEX acq_attribution_credit_idx
816 ON acq.debit_attribution( funding_source_credit );
820 CREATE TABLE acq.invoice_method (
821 code TEXT PRIMARY KEY,
822 name TEXT NOT NULL -- i18n-ize
825 CREATE TABLE acq.invoice_payment_method (
826 code TEXT PRIMARY KEY,
827 name TEXT NOT NULL -- i18n-ize
830 CREATE TABLE acq.invoice (
831 id SERIAL PRIMARY KEY,
832 receiver INT NOT NULL REFERENCES actor.org_unit (id),
833 provider INT NOT NULL REFERENCES acq.provider (id),
834 shipper INT NOT NULL REFERENCES acq.provider (id),
835 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
836 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
837 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
838 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
840 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
841 DEFERRABLE INITIALLY DEFERRED,
843 complete BOOL NOT NULL DEFAULT FALSE,
844 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
847 CREATE TABLE acq.invoice_entry (
848 id SERIAL PRIMARY KEY,
849 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
850 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
851 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
852 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
853 phys_item_count INT, -- and how many did staff count
855 billed_per_item BOOL,
856 cost_billed NUMERIC(8,2),
857 actual_cost NUMERIC(8,2),
858 amount_paid NUMERIC (8,2)
861 CREATE TABLE acq.invoice_item_type (
862 code TEXT PRIMARY KEY,
863 name TEXT NOT NULL, -- i18n-ize
864 prorate BOOL NOT NULL DEFAULT FALSE
867 CREATE TABLE acq.po_item (
868 id SERIAL PRIMARY KEY,
869 purchase_order INT REFERENCES acq.purchase_order (id)
870 ON UPDATE CASCADE ON DELETE SET NULL
871 DEFERRABLE INITIALLY DEFERRED,
872 fund_debit INT REFERENCES acq.fund_debit (id)
873 DEFERRABLE INITIALLY DEFERRED,
874 inv_item_type TEXT NOT NULL
875 REFERENCES acq.invoice_item_type (code)
876 DEFERRABLE INITIALLY DEFERRED,
880 estimated_cost NUMERIC(8,2),
881 fund INT REFERENCES acq.fund (id)
882 DEFERRABLE INITIALLY DEFERRED
885 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
886 id SERIAL PRIMARY KEY,
887 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
888 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
889 fund_debit INT REFERENCES acq.fund_debit (id),
890 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
894 cost_billed NUMERIC(8,2),
895 actual_cost NUMERIC(8,2),
896 fund INT REFERENCES acq.fund (id)
897 DEFERRABLE INITIALLY DEFERRED,
898 amount_paid NUMERIC (8,2),
899 po_item INT REFERENCES acq.po_item (id)
900 DEFERRABLE INITIALLY DEFERRED
904 CREATE TABLE acq.user_request_type (
905 id SERIAL PRIMARY KEY,
906 label TEXT NOT NULL UNIQUE -- i18n-ize
909 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
910 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
911 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
912 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
913 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
915 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
917 CREATE TABLE acq.user_request (
918 id SERIAL PRIMARY KEY,
919 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
920 hold BOOL NOT NULL DEFAULT TRUE,
922 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
923 holdable_formats TEXT, -- nullable, for use in hold creation
925 email_notify BOOL NOT NULL DEFAULT TRUE,
926 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
927 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
928 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
929 need_before TIMESTAMPTZ, -- don't create holds after this
932 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
944 cancel_reason INT REFERENCES acq.cancel_reason( id )
945 DEFERRABLE INITIALLY DEFERRED
951 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
952 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
955 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
958 SELECT COUNT(*) INTO counter
959 FROM oils_xpath_table(
963 '//*[@tag="' || tag || '"]',
965 ) as t(i int,c text);
967 FOR i IN 1 .. counter LOOP
970 FROM ( SELECT id,i,t,v
971 FROM oils_xpath_table(
975 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
976 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
978 ) as t(id int,t text,v text)
989 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
990 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
994 lida acq.flat_lineitem_detail%ROWTYPE;
996 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
997 IF NOT FOUND THEN RETURN; END IF;
999 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
1000 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1007 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1008 JOIN acq.provider_holding_subfield_map a USING (subfield)
1009 WHERE a.provider = prov_i
1016 $$ LANGUAGE PLPGSQL;
1018 -- select * from acq.extract_provider_holding_data(699);
1020 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1021 SELECT public.extract_marc_field('acq.lineitem', $1, $2, $3);
1025 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1026 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1029 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1030 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1034 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1037 Suggested vendor fields:
1045 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1054 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1056 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1058 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1059 IF (atype = 'lineitem_provider_attr_definition') THEN
1060 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1061 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1064 IF (atype = 'lineitem_provider_attr_definition') THEN
1065 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1066 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1067 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1068 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1069 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1072 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1077 SELECT extract_acq_marc_field(id, xpath_string || '[' || pos || ']', adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1079 IF (value IS NOT NULL AND value <> '') THEN
1080 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1081 VALUES (NEW.id, adef.id, atype, adef.code, value);
1095 $function$ LANGUAGE PLPGSQL;
1097 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1099 IF TG_OP = 'UPDATE' THEN
1100 DELETE FROM acq.lineitem_attr
1101 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1104 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1108 $$ LANGUAGE PLPGSQL;
1110 CREATE TRIGGER cleanup_lineitem_trigger
1111 BEFORE UPDATE OR DELETE ON acq.lineitem
1112 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1114 CREATE TRIGGER ingest_lineitem_trigger
1115 AFTER INSERT OR UPDATE ON acq.lineitem
1116 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1118 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1122 IF from_ex = to_ex THEN
1126 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1131 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1140 $$ LANGUAGE PLPGSQL;
1142 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1143 SELECT $3 * acq.exchange_ratio($1, $2);
1146 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1148 Examine the acq.fiscal_year table, comparing successive years.
1149 Report any inconsistencies, i.e. years that overlap, have gaps
1150 between them, or are out of sequence.
1152 RETURNS SETOF RECORD AS $$
1176 ELSIF curr_year.calendar = prev_year.calendar THEN
1177 IF curr_year.year_begin > prev_year.year_end THEN
1178 -- This ugly kludge works around the fact that older
1179 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1180 FOR return_rec IN SELECT
1183 'Gap between fiscal years'::TEXT
1185 RETURN NEXT return_rec;
1187 ELSIF curr_year.year_begin < prev_year.year_end THEN
1188 FOR return_rec IN SELECT
1191 'Overlapping fiscal years'::TEXT
1193 RETURN NEXT return_rec;
1195 ELSIF curr_year.year < prev_year.year THEN
1196 FOR return_rec IN SELECT
1199 'Fiscal years out of order'::TEXT
1201 RETURN NEXT return_rec;
1206 prev_year := curr_year;
1211 $$ LANGUAGE plpgsql;
1213 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1215 old_amount IN NUMERIC, -- in currency of old fund
1217 new_amount IN NUMERIC, -- in currency of new fund
1219 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1220 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1221 ) RETURNS VOID AS $$
1222 /* -------------------------------------------------------------------------------
1224 Function to transfer money from one fund to another.
1226 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1227 negative amount for the old (losing) fund and a positive amount for the new
1228 (gaining) fund. In some cases there may be more than one such pair of entries
1229 in order to pull the money from different funding sources, or more specifically
1230 from different funding source credits. For each such pair there is also an
1231 entry in acq.fund_transfer.
1233 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1234 choose a funding source for the transferred money to come from. This choice
1235 must meet two constraints, so far as possible:
1237 1. The amount transferred from a given funding source must not exceed the
1238 amount allocated to the old fund by the funding source. To that end we
1239 compare the amount being transferred to the amount allocated.
1241 2. We shouldn't transfer money that has already been spent or encumbered, as
1242 defined by the funding attribution process. We attribute expenses to the
1243 oldest funding source credits first. In order to avoid transferring that
1244 attributed money, we reverse the priority, transferring from the newest funding
1245 source credits first. There can be no guarantee that this approach will
1246 avoid overcommitting a fund, but no other approach can do any better.
1248 In this context the age of a funding source credit is defined by the
1249 deadline_date for credits with deadline_dates, and by the effective_date for
1250 credits without deadline_dates, with the proviso that credits with deadline_dates
1251 are all considered "older" than those without.
1255 In the signature for this function, there is one last parameter commented out,
1256 named "funding_source_in". Correspondingly, the WHERE clause for the query
1257 driving the main loop has an OR clause commented out, which references the
1258 funding_source_in parameter.
1260 If these lines are uncommented, this function will allow the user optionally to
1261 restrict a fund transfer to a specified funding source. If the source
1262 parameter is left NULL, then there will be no such restriction.
1264 ------------------------------------------------------------------------------- */
1266 same_currency BOOLEAN;
1267 currency_ratio NUMERIC;
1268 old_fund_currency TEXT;
1269 old_remaining NUMERIC; -- in currency of old fund
1270 new_fund_currency TEXT;
1271 new_fund_active BOOLEAN;
1272 new_remaining NUMERIC; -- in currency of new fund
1273 curr_old_amt NUMERIC; -- in currency of old fund
1274 curr_new_amt NUMERIC; -- in currency of new fund
1275 source_addition NUMERIC; -- in currency of funding source
1276 source_deduction NUMERIC; -- in currency of funding source
1277 orig_allocated_amt NUMERIC; -- in currency of funding source
1278 allocated_amt NUMERIC; -- in currency of fund
1284 IF old_fund IS NULL THEN
1285 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1288 IF old_amount IS NULL THEN
1289 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1292 -- The new fund and its amount must be both NULL or both not NULL.
1294 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1295 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1298 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1299 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1302 IF user_id IS NULL THEN
1303 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1306 -- Initialize the amounts to be transferred, each denominated
1307 -- in the currency of its respective fund. They will be
1308 -- reduced on each iteration of the loop.
1310 old_remaining := old_amount;
1311 new_remaining := new_amount;
1313 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1314 -- old_amount, old_fund, new_amount, new_fund;
1316 -- Get the currency types of the old and new funds.
1327 IF old_fund_currency IS NULL THEN
1328 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1331 IF new_fund IS NOT NULL THEN
1343 IF new_fund_currency IS NULL THEN
1344 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1345 ELSIF NOT new_fund_active THEN
1347 -- No point in putting money into a fund from whence you can't spend it
1349 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1352 IF new_amount = old_amount THEN
1353 same_currency := true;
1354 currency_ratio := 1;
1357 -- We'll have to translate currency between funds. We presume that
1358 -- the calling code has already applied an appropriate exchange rate,
1359 -- so we'll apply the same conversion to each sub-transfer.
1361 same_currency := false;
1362 currency_ratio := new_amount / old_amount;
1366 -- Identify the funding source(s) from which we want to transfer the money.
1367 -- The principle is that we want to transfer the newest money first, because
1368 -- we spend the oldest money first. The priority for spending is defined
1369 -- by a sort of the view acq.ordered_funding_source_credit.
1374 ofsc.funding_source,
1376 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1380 acq.ordered_funding_source_credit AS ofsc,
1381 acq.funding_source fs
1383 ofsc.funding_source = fs.id
1384 and ofsc.funding_source IN
1386 SELECT funding_source
1387 FROM acq.fund_allocation
1388 WHERE fund = old_fund
1392 -- ofsc.funding_source = funding_source_in
1393 -- OR funding_source_in IS NULL
1396 ofsc.sort_priority desc,
1397 ofsc.sort_date desc,
1401 -- Determine how much money the old fund got from this funding source,
1402 -- denominated in the currency types of the source and of the fund.
1403 -- This result may reflect transfers from previous iterations.
1406 COALESCE( sum( amount ), 0 ),
1407 COALESCE( sum( amount )
1408 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1410 orig_allocated_amt, -- in currency of the source
1411 allocated_amt -- in currency of the old fund
1416 and funding_source = source.funding_source;
1418 -- Determine how much to transfer from this credit, in the currency
1419 -- of the fund. Begin with the amount remaining to be attributed:
1421 curr_old_amt := old_remaining;
1423 -- Can't attribute more than was allocated from the fund:
1425 IF curr_old_amt > allocated_amt THEN
1426 curr_old_amt := allocated_amt;
1429 -- Can't attribute more than the amount of the current credit:
1431 IF curr_old_amt > source.converted_amt THEN
1432 curr_old_amt := source.converted_amt;
1435 curr_old_amt := trunc( curr_old_amt, 2 );
1437 old_remaining := old_remaining - curr_old_amt;
1439 -- Determine the amount to be deducted, if any,
1440 -- from the old allocation.
1442 IF old_remaining > 0 THEN
1444 -- In this case we're using the whole allocation, so use that
1445 -- amount directly instead of applying a currency translation
1446 -- and thereby inviting round-off errors.
1448 source_deduction := - orig_allocated_amt;
1450 source_deduction := trunc(
1451 ( - curr_old_amt ) *
1452 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1456 IF source_deduction <> 0 THEN
1458 -- Insert negative allocation for old fund in fund_allocation,
1459 -- converted into the currency of the funding source
1461 INSERT INTO acq.fund_allocation (
1468 source.funding_source,
1472 'Transfer to fund ' || new_fund
1476 IF new_fund IS NOT NULL THEN
1478 -- Determine how much to add to the new fund, in
1479 -- its currency, and how much remains to be added:
1481 IF same_currency THEN
1482 curr_new_amt := curr_old_amt;
1484 IF old_remaining = 0 THEN
1486 -- This is the last iteration, so nothing should be left
1488 curr_new_amt := new_remaining;
1491 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1492 new_remaining := new_remaining - curr_new_amt;
1496 -- Determine how much to add, if any,
1497 -- to the new fund's allocation.
1499 IF old_remaining > 0 THEN
1501 -- In this case we're using the whole allocation, so use that amount
1502 -- amount directly instead of applying a currency translation and
1503 -- thereby inviting round-off errors.
1505 source_addition := orig_allocated_amt;
1506 ELSIF source.currency_type = old_fund_currency THEN
1508 -- In this case we don't need a round trip currency translation,
1509 -- thereby inviting round-off errors:
1511 source_addition := curr_old_amt;
1513 source_addition := trunc(
1515 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1519 IF source_addition <> 0 THEN
1521 -- Insert positive allocation for new fund in fund_allocation,
1522 -- converted to the currency of the founding source
1524 INSERT INTO acq.fund_allocation (
1531 source.funding_source,
1535 'Transfer from fund ' || old_fund
1540 IF trunc( curr_old_amt, 2 ) <> 0
1541 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1543 -- Insert row in fund_transfer, using amounts in the currency of the funds
1545 INSERT INTO acq.fund_transfer (
1552 funding_source_credit
1555 trunc( curr_old_amt, 2 ),
1557 trunc( curr_new_amt, 2 ),
1564 if old_remaining <= 0 THEN
1565 EXIT; -- Nothing more to be transferred
1569 $$ LANGUAGE plpgsql;
1571 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1573 Function to attribute expenditures and encumbrances to funding source credits,
1574 and thereby to funding sources.
1576 Read the debits in chonological order, attributing each one to one or
1577 more funding source credits. Constraints:
1579 1. Don't attribute more to a credit than the amount of the credit.
1581 2. For a given fund, don't attribute more to a funding source than the
1582 source has allocated to that fund.
1584 3. Attribute debits to credits with deadlines before attributing them to
1585 credits without deadlines. Otherwise attribute to the earliest credits
1586 first, based on the deadline date when present, or on the effective date
1587 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1588 This ordering is defined by an ORDER BY clause on the view
1589 acq.ordered_funding_source_credit.
1591 Start by truncating the table acq.debit_attribution. Then insert a row
1592 into that table for each attribution. If a debit cannot be fully
1593 attributed, insert a row for the unattributable balance, with the
1594 funding_source_credit and credit_amount columns NULL.
1597 curr_fund_source_bal RECORD;
1598 seqno INT; -- sequence num for credits applicable to a fund
1599 fund_credit RECORD; -- current row in temp t_fund_credit table
1600 fc RECORD; -- used for loading t_fund_credit table
1601 sc RECORD; -- used for loading t_fund_credit table
1603 -- Used exclusively in the main loop:
1605 deb RECORD; -- current row from acq.fund_debit table
1606 curr_credit_bal RECORD; -- current row from temp t_credit table
1607 debit_balance NUMERIC; -- amount left to attribute for current debit
1608 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1609 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1610 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1611 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1612 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1613 attrib_count INT; -- populates id of acq.debit_attribution
1616 -- Load a temporary table. For each combination of fund and funding source,
1617 -- load an entry with the total amount allocated to that fund by that source.
1618 -- This sum may reflect transfers as well as original allocations. We will
1619 -- reduce this balance whenever we attribute debits to it.
1621 CREATE TEMP TABLE t_fund_source_bal
1625 funding_source AS source,
1626 sum( amount ) AS balance
1635 CREATE INDEX t_fund_source_bal_idx
1636 ON t_fund_source_bal( fund, source );
1637 -------------------------------------------------------------------------------
1639 -- Load another temporary table. For each fund, load zero or more
1640 -- funding source credits from which that fund can get money.
1642 CREATE TEMP TABLE t_fund_credit (
1649 SELECT DISTINCT fund
1650 FROM acq.fund_allocation
1652 LOOP -- Loop over the funds
1658 acq.ordered_funding_source_credit AS ofsc
1660 ofsc.funding_source IN
1662 SELECT funding_source
1663 FROM acq.fund_allocation
1664 WHERE fund = fc.fund
1670 LOOP -- Add each credit to the list
1671 INSERT INTO t_fund_credit (
1680 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1682 END LOOP; -- Loop over credits for a given fund
1683 END LOOP; -- Loop over funds
1685 CREATE INDEX t_fund_credit_idx
1686 ON t_fund_credit( fund, seq );
1687 -------------------------------------------------------------------------------
1689 -- Load yet another temporary table. This one is a list of funding source
1690 -- credits, with their balances. We shall reduce those balances as we
1691 -- attribute debits to them.
1693 CREATE TEMP TABLE t_credit
1697 fsc.funding_source AS source,
1698 fsc.amount AS balance,
1699 fs.currency_type AS currency_type
1701 acq.funding_source_credit AS fsc,
1702 acq.funding_source fs
1704 fsc.funding_source = fs.id
1707 CREATE INDEX t_credit_idx
1708 ON t_credit( credit );
1710 -------------------------------------------------------------------------------
1712 -- Now that we have loaded the lookup tables: loop through the debits,
1713 -- attributing each one to one or more funding source credits.
1715 truncate table acq.debit_attribution;
1733 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1735 debit_balance := deb.amount;
1737 -- Loop over the funding source credits that are eligible
1738 -- to pay for this debit
1750 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1752 -- Look up the balance for this credit. If it's zero, then
1753 -- it's not useful, so treat it as if you didn't find it.
1754 -- (Actually there shouldn't be any zero balances in the table,
1755 -- but we check just to make sure.)
1758 INTO curr_credit_bal
1761 credit = fund_credit.credit
1764 IF curr_credit_bal IS NULL THEN
1766 -- This credit is exhausted; try the next one.
1772 -- At this point we have an applicable credit with some money left.
1773 -- Now see if the relevant funding_source has any money left.
1775 -- Look up the balance of the allocation for this combination of
1776 -- fund and source. If you find such an entry, but it has a zero
1777 -- balance, then it's not useful, so treat it as unfound.
1778 -- (Actually there shouldn't be any zero balances in the table,
1779 -- but we check just to make sure.)
1782 INTO curr_fund_source_bal
1783 FROM t_fund_source_bal
1786 AND source = curr_credit_bal.source
1789 IF curr_fund_source_bal IS NULL THEN
1791 -- This fund/source doesn't exist or is already exhausted,
1792 -- so we can't use this credit. Go on to the next one.
1797 -- Convert the available balances to the currency of the fund
1799 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1800 curr_credit_bal.currency_type, deb.currency_type );
1801 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1802 curr_credit_bal.currency_type, deb.currency_type );
1804 -- Determine how much we can attribute to this credit: the minimum
1805 -- of the debit amount, the fund/source balance, and the
1808 --RAISE NOTICE ' deb bal %', debit_balance;
1809 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1810 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1812 conv_attr_amount := NULL;
1813 attr_amount := debit_balance;
1815 IF attr_amount > conv_alloc_balance THEN
1816 attr_amount := conv_alloc_balance;
1817 conv_attr_amount := curr_fund_source_bal.balance;
1819 IF attr_amount > conv_cred_balance THEN
1820 attr_amount := conv_cred_balance;
1821 conv_attr_amount := curr_credit_bal.balance;
1824 -- If we're attributing all of one of the balances, then that's how
1825 -- much we will deduct from the balances, and we already captured
1826 -- that amount above. Otherwise we must convert the amount of the
1827 -- attribution from the currency of the fund back to the currency of
1828 -- the funding source.
1830 IF conv_attr_amount IS NULL THEN
1831 conv_attr_amount := attr_amount * acq.exchange_ratio(
1832 deb.currency_type, curr_credit_bal.currency_type );
1835 -- Insert a row to record the attribution
1837 attrib_count := attrib_count + 1;
1838 INSERT INTO acq.debit_attribution (
1842 funding_source_credit,
1848 curr_credit_bal.credit,
1852 -- Subtract the attributed amount from the various balances
1854 debit_balance := debit_balance - attr_amount;
1855 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1857 IF curr_fund_source_bal.balance <= 0 THEN
1859 -- This allocation is exhausted. Delete it so
1860 -- that we don't waste time looking at it again.
1862 DELETE FROM t_fund_source_bal
1864 fund = curr_fund_source_bal.fund
1865 AND source = curr_fund_source_bal.source;
1867 UPDATE t_fund_source_bal
1868 SET balance = balance - conv_attr_amount
1870 fund = curr_fund_source_bal.fund
1871 AND source = curr_fund_source_bal.source;
1874 IF curr_credit_bal.balance <= 0 THEN
1876 -- This funding source credit is exhausted. Delete it
1877 -- so that we don't waste time looking at it again.
1879 --DELETE FROM t_credit
1881 -- credit = curr_credit_bal.credit;
1883 DELETE FROM t_fund_credit
1885 credit = curr_credit_bal.credit;
1888 SET balance = curr_credit_bal.balance
1890 credit = curr_credit_bal.credit;
1893 -- Are we done with this debit yet?
1895 IF debit_balance <= 0 THEN
1896 EXIT; -- We've fully attributed this debit; stop looking at credits.
1898 END LOOP; -- End loop over credits
1900 IF debit_balance <> 0 THEN
1902 -- We weren't able to attribute this debit, or at least not
1903 -- all of it. Insert a row for the unattributed balance.
1905 attrib_count := attrib_count + 1;
1906 INSERT INTO acq.debit_attribution (
1910 funding_source_credit,
1920 END LOOP; -- End of loop over debits
1922 $$ LANGUAGE 'plpgsql';
1924 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit(
1928 ) RETURNS VOID AS $$
1939 IF old_year IS NULL THEN
1940 RAISE EXCEPTION 'Input year argument is NULL';
1941 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1942 RAISE EXCEPTION 'Input year is out of range';
1945 IF user_id IS NULL THEN
1946 RAISE EXCEPTION 'Input user id argument is NULL';
1949 IF org_unit_id IS NULL THEN
1950 RAISE EXCEPTION 'Org unit id argument is NULL';
1952 SELECT TRUE INTO org_found
1954 WHERE id = org_unit_id;
1956 IF org_found IS NULL THEN
1957 RAISE EXCEPTION 'Org unit id is invalid';
1961 -- Loop over the applicable funds
1963 FOR old_fund in SELECT * FROM acq.fund
1967 AND org = org_unit_id
1970 INSERT INTO acq.fund (
1978 balance_warning_percent,
1979 balance_stop_percent
1984 old_fund.currency_type,
1988 old_fund.balance_warning_percent,
1989 old_fund.balance_stop_percent
1991 RETURNING id INTO new_id;
1993 WHEN unique_violation THEN
1994 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
1997 --RAISE NOTICE 'Propagating fund % to fund %',
1998 -- old_fund.code, new_id;
2001 $$ LANGUAGE plpgsql;
2003 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
2007 ) RETURNS VOID AS $$
2018 IF old_year IS NULL THEN
2019 RAISE EXCEPTION 'Input year argument is NULL';
2020 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2021 RAISE EXCEPTION 'Input year is out of range';
2024 IF user_id IS NULL THEN
2025 RAISE EXCEPTION 'Input user id argument is NULL';
2028 IF org_unit_id IS NULL THEN
2029 RAISE EXCEPTION 'Org unit id argument is NULL';
2031 SELECT TRUE INTO org_found
2033 WHERE id = org_unit_id;
2035 IF org_found IS NULL THEN
2036 RAISE EXCEPTION 'Org unit id is invalid';
2040 -- Loop over the applicable funds
2042 FOR old_fund in SELECT * FROM acq.fund
2047 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2051 INSERT INTO acq.fund (
2059 balance_warning_percent,
2060 balance_stop_percent
2065 old_fund.currency_type,
2069 old_fund.balance_warning_percent,
2070 old_fund.balance_stop_percent
2072 RETURNING id INTO new_id;
2074 WHEN unique_violation THEN
2075 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2078 --RAISE NOTICE 'Propagating fund % to fund %',
2079 -- old_fund.code, new_id;
2082 $$ LANGUAGE plpgsql;
2084 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit(
2088 ) RETURNS VOID AS $$
2092 new_year INT := old_year + 1;
2094 xfer_amount NUMERIC;
2103 IF old_year IS NULL THEN
2104 RAISE EXCEPTION 'Input year argument is NULL';
2105 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2106 RAISE EXCEPTION 'Input year is out of range';
2109 IF user_id IS NULL THEN
2110 RAISE EXCEPTION 'Input user id argument is NULL';
2113 IF org_unit_id IS NULL THEN
2114 RAISE EXCEPTION 'Org unit id argument is NULL';
2117 -- Validate the org unit
2122 WHERE id = org_unit_id;
2124 IF org_found IS NULL THEN
2125 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2129 -- Loop over the propagable funds to identify the details
2130 -- from the old fund plus the id of the new one, if it exists.
2134 oldf.id AS old_fund,
2140 newf.id AS new_fund_id
2143 LEFT JOIN acq.fund AS newf
2144 ON ( oldf.code = newf.code )
2146 oldf.org = org_unit_id
2147 and oldf.year = old_year
2149 and newf.year = new_year
2151 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2153 IF roll_fund.new_fund_id IS NULL THEN
2155 -- The old fund hasn't been propagated yet. Propagate it now.
2157 INSERT INTO acq.fund (
2165 balance_warning_percent,
2166 balance_stop_percent
2171 roll_fund.currency_type,
2175 roll_fund.balance_warning_percent,
2176 roll_fund.balance_stop_percent
2178 RETURNING id INTO new_fund;
2180 new_fund = roll_fund.new_fund_id;
2183 -- Determine the amount to transfer
2187 FROM acq.fund_spent_balance
2188 WHERE fund = roll_fund.old_fund;
2190 IF xfer_amount <> 0 THEN
2191 IF roll_fund.rollover THEN
2193 -- Transfer balance from old fund to new
2195 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2197 PERFORM acq.transfer_fund(
2207 -- Transfer balance from old fund to the void
2209 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2211 PERFORM acq.transfer_fund(
2222 IF roll_fund.rollover THEN
2224 -- Move any lineitems from the old fund to the new one
2225 -- where the associated debit is an encumbrance.
2227 -- Any other tables tying expenditure details to funds should
2228 -- receive similar treatment. At this writing there are none.
2230 UPDATE acq.lineitem_detail
2233 fund = roll_fund.old_fund -- this condition may be redundant
2239 fund = roll_fund.old_fund
2243 -- Move encumbrance debits from the old fund to the new fund
2245 UPDATE acq.fund_debit
2248 fund = roll_fund.old_fund
2252 -- Mark old fund as inactive, now that we've closed it
2256 WHERE id = roll_fund.old_fund;
2259 $$ LANGUAGE plpgsql;
2261 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2265 ) RETURNS VOID AS $$
2269 new_year INT := old_year + 1;
2271 xfer_amount NUMERIC;
2280 IF old_year IS NULL THEN
2281 RAISE EXCEPTION 'Input year argument is NULL';
2282 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2283 RAISE EXCEPTION 'Input year is out of range';
2286 IF user_id IS NULL THEN
2287 RAISE EXCEPTION 'Input user id argument is NULL';
2290 IF org_unit_id IS NULL THEN
2291 RAISE EXCEPTION 'Org unit id argument is NULL';
2294 -- Validate the org unit
2299 WHERE id = org_unit_id;
2301 IF org_found IS NULL THEN
2302 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2306 -- Loop over the propagable funds to identify the details
2307 -- from the old fund plus the id of the new one, if it exists.
2311 oldf.id AS old_fund,
2317 newf.id AS new_fund_id
2320 LEFT JOIN acq.fund AS newf
2321 ON ( oldf.code = newf.code )
2323 oldf.year = old_year
2325 AND newf.year = new_year
2327 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2330 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2332 IF roll_fund.new_fund_id IS NULL THEN
2334 -- The old fund hasn't been propagated yet. Propagate it now.
2336 INSERT INTO acq.fund (
2344 balance_warning_percent,
2345 balance_stop_percent
2350 roll_fund.currency_type,
2354 roll_fund.balance_warning_percent,
2355 roll_fund.balance_stop_percent
2357 RETURNING id INTO new_fund;
2359 new_fund = roll_fund.new_fund_id;
2362 -- Determine the amount to transfer
2366 FROM acq.fund_spent_balance
2367 WHERE fund = roll_fund.old_fund;
2369 IF xfer_amount <> 0 THEN
2370 IF roll_fund.rollover THEN
2372 -- Transfer balance from old fund to new
2374 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2376 PERFORM acq.transfer_fund(
2386 -- Transfer balance from old fund to the void
2388 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2390 PERFORM acq.transfer_fund(
2401 IF roll_fund.rollover THEN
2403 -- Move any lineitems from the old fund to the new one
2404 -- where the associated debit is an encumbrance.
2406 -- Any other tables tying expenditure details to funds should
2407 -- receive similar treatment. At this writing there are none.
2409 UPDATE acq.lineitem_detail
2412 fund = roll_fund.old_fund -- this condition may be redundant
2418 fund = roll_fund.old_fund
2422 -- Move encumbrance debits from the old fund to the new fund
2424 UPDATE acq.fund_debit
2427 fund = roll_fund.old_fund
2431 -- Mark old fund as inactive, now that we've closed it
2435 WHERE id = roll_fund.old_fund;
2438 $$ LANGUAGE plpgsql;
2440 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2441 SELECT funding_source,
2442 SUM(amount) AS amount
2443 FROM acq.funding_source_credit
2446 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2447 SELECT funding_source,
2448 SUM(a.amount)::NUMERIC(100,2) AS amount
2449 FROM acq.fund_allocation a
2452 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2453 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2454 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2455 FROM acq.funding_source_credit_total c
2456 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2459 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2461 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2462 FROM acq.fund_allocation a
2463 JOIN acq.fund f ON (a.fund = f.id)
2464 JOIN acq.funding_source s ON (a.funding_source = s.id)
2467 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2468 SELECT fund.id AS fund,
2469 fund_debit.encumbrance AS encumbrance,
2470 SUM( COALESCE( fund_debit.amount, 0 ) ) AS amount
2471 FROM acq.fund AS fund
2472 LEFT JOIN acq.fund_debit AS fund_debit
2473 ON ( fund.id = fund_debit.fund )
2476 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2478 SUM(amount) AS amount
2479 FROM acq.fund_debit_total
2480 WHERE encumbrance IS TRUE
2483 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2485 SUM(amount) AS amount
2486 FROM acq.fund_debit_total
2487 WHERE encumbrance IS FALSE
2490 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2492 c.amount - COALESCE(d.amount,0.0) AS amount
2493 FROM acq.fund_allocation_total c
2494 LEFT JOIN acq.fund_debit_total d USING (fund);
2496 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2498 c.amount - COALESCE(d.amount,0.0) AS amount
2499 FROM acq.fund_allocation_total c
2500 LEFT JOIN acq.fund_spent_total d USING (fund);
2502 -- For each fund: the total allocation from all sources, in the
2503 -- currency of the fund (or 0 if there are no allocations)
2505 CREATE VIEW acq.all_fund_allocation_total AS
2508 COALESCE( SUM( a.amount * acq.exchange_ratio(
2509 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2513 LEFT JOIN acq.fund_allocation a
2515 LEFT JOIN acq.funding_source s
2516 ON a.funding_source = s.id
2520 -- For every fund: the total encumbrances (or 0 if none),
2521 -- in the currency of the fund.
2523 CREATE VIEW acq.all_fund_encumbrance_total AS
2526 COALESCE( encumb.amount, 0 ) AS amount
2532 sum( amount ) AS amount
2539 ON f.id = encumb.fund;
2541 -- For every fund: the total spent (or 0 if none),
2542 -- in the currency of the fund.
2544 CREATE VIEW acq.all_fund_spent_total AS
2547 COALESCE( spent.amount, 0 ) AS amount
2553 sum( amount ) AS amount
2560 ON f.id = spent.fund;
2562 -- For each fund: the amount not yet spent, in the currency
2563 -- of the fund. May include encumbrances.
2565 CREATE VIEW acq.all_fund_spent_balance AS
2568 c.amount - d.amount AS amount
2569 FROM acq.all_fund_allocation_total c
2570 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2572 -- For each fund: the amount neither spent nor encumbered,
2573 -- in the currency of the fund
2575 CREATE VIEW acq.all_fund_combined_balance AS
2578 a.amount - COALESCE( c.amount, 0 ) AS amount
2580 acq.all_fund_allocation_total a
2584 SUM( amount ) AS amount
2589 ) AS c USING ( fund );
2591 CREATE TABLE acq.claim_type (
2592 id SERIAL PRIMARY KEY,
2593 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2594 DEFERRABLE INITIALLY DEFERRED,
2596 description TEXT NOT NULL,
2597 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2600 CREATE TABLE acq.claim (
2601 id SERIAL PRIMARY KEY,
2602 type INT NOT NULL REFERENCES acq.claim_type
2603 DEFERRABLE INITIALLY DEFERRED,
2604 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2605 DEFERRABLE INITIALLY DEFERRED
2608 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2610 CREATE TABLE acq.claim_event (
2611 id BIGSERIAL PRIMARY KEY,
2612 type INT NOT NULL REFERENCES acq.claim_event_type
2613 DEFERRABLE INITIALLY DEFERRED,
2614 claim SERIAL NOT NULL REFERENCES acq.claim
2615 DEFERRABLE INITIALLY DEFERRED,
2616 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2617 creator INT NOT NULL REFERENCES actor.usr
2618 DEFERRABLE INITIALLY DEFERRED,
2622 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );