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 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
365 -- Reserve ids 1-999 for stock reasons
366 -- Reserve ids 1000-1999 for EDI reasons
367 -- 2000+ are available for staff to create
369 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
371 CREATE TABLE acq.purchase_order (
372 id SERIAL PRIMARY KEY,
373 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
374 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
375 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
376 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
377 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
378 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
379 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
380 state TEXT NOT NULL DEFAULT 'new',
381 order_date TIMESTAMP WITH TIME ZONE,
383 cancel_reason INT REFERENCES acq.cancel_reason( id )
384 DEFERRABLE INITIALLY DEFERRED,
385 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE
387 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
388 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
389 CREATE INDEX po_state_idx ON acq.purchase_order (state);
390 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
391 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
392 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
394 -- The name should default to the id, as text. We can't reference a column
395 -- in a DEFAULT clause, so we use a trigger:
397 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
400 IF NEW.name IS NULL THEN
401 NEW.name := NEW.id::TEXT;
408 CREATE TRIGGER po_name_default_trg
409 BEFORE INSERT OR UPDATE ON acq.purchase_order
410 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
412 -- The order name should be unique for a given ordering agency on a given order date
413 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
414 -- this rule requires a check constraint with a subquery. However you can't have a
415 -- subquery in a CHECK constraint, so we fake it with a trigger.
417 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
423 -- If order_date is not null, then make sure we don't have a collision
424 -- on order_date (truncated to day), org, and name
426 IF NEW.order_date IS NULL THEN
430 -- In the WHERE clause, we compare the order_dates without regard to time of day.
431 -- We use a pair of inequalities instead of comparing truncated dates so that the
432 -- query can do an indexed range scan.
434 SELECT 1 INTO collision
435 FROM acq.purchase_order
437 ordering_agency = NEW.ordering_agency
439 AND order_date >= date_trunc( 'day', NEW.order_date )
440 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
443 IF collision IS NULL THEN
444 -- okay, no collision
447 -- collision; nip it in the bud
448 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
449 NEW.ordering_agency, NEW.order_date, NEW.name;
454 CREATE TRIGGER po_org_name_date_unique_trg
455 BEFORE INSERT OR UPDATE ON acq.purchase_order
456 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
458 CREATE TABLE acq.po_note (
459 id SERIAL PRIMARY KEY,
460 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
461 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
462 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
463 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
464 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
466 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
468 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
469 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
470 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
472 CREATE TABLE acq.lineitem (
473 id BIGSERIAL PRIMARY KEY,
474 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
475 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
476 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
477 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
478 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
479 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
480 expected_recv_time TIMESTAMP WITH TIME ZONE,
481 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
482 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
484 eg_bib_id INT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
486 state TEXT NOT NULL DEFAULT 'new',
487 cancel_reason INT REFERENCES acq.cancel_reason( id )
488 DEFERRABLE INITIALLY DEFERRED,
489 estimated_unit_price NUMERIC,
490 claim_policy INT REFERENCES acq.claim_policy
491 DEFERRABLE INITIALLY DEFERRED,
492 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
494 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
495 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
496 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
497 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
498 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
500 CREATE TABLE acq.lineitem_alert_text (
501 id SERIAL PRIMARY KEY,
504 owning_lib INT NOT NULL
505 REFERENCES actor.org_unit(id)
506 DEFERRABLE INITIALLY DEFERRED,
507 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
510 CREATE TABLE acq.lineitem_note (
511 id SERIAL PRIMARY KEY,
512 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
513 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
514 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
515 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
516 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
518 alert_text INT REFERENCES acq.lineitem_alert_text(id)
519 DEFERRABLE INITIALLY DEFERRED,
520 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
522 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
523 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
524 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
526 CREATE TABLE acq.lineitem_detail (
527 id BIGSERIAL PRIMARY KEY,
528 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
529 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
530 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
531 eg_copy_id BIGINT REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
535 collection_code TEXT,
536 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
537 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
538 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
539 recv_time TIMESTAMP WITH TIME ZONE,
540 cancel_reason INT REFERENCES acq.cancel_reason( id ) DEFERRABLE INITIALLY DEFERRED
543 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
545 CREATE TABLE acq.lineitem_attr_definition (
546 id BIGSERIAL PRIMARY KEY,
548 description TEXT NOT NULL,
549 remove TEXT NOT NULL DEFAULT '',
550 ident BOOL NOT NULL DEFAULT FALSE
553 CREATE TABLE acq.lineitem_marc_attr_definition (
554 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
556 ) INHERITS (acq.lineitem_attr_definition);
558 CREATE TABLE acq.lineitem_provider_attr_definition (
559 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
561 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
562 ) INHERITS (acq.lineitem_attr_definition);
564 CREATE TABLE acq.lineitem_generated_attr_definition (
565 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
567 ) INHERITS (acq.lineitem_attr_definition);
569 CREATE TABLE acq.lineitem_usr_attr_definition (
570 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
571 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
572 ) INHERITS (acq.lineitem_attr_definition);
573 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
575 CREATE TABLE acq.lineitem_local_attr_definition (
576 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
577 ) INHERITS (acq.lineitem_attr_definition);
579 CREATE TABLE acq.lineitem_attr (
580 id BIGSERIAL PRIMARY KEY,
581 definition BIGINT NOT NULL,
582 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
583 attr_type TEXT NOT NULL,
584 attr_name TEXT NOT NULL,
585 attr_value TEXT NOT NULL
588 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
589 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
590 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
596 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
597 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)]');
598 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
599 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
600 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
601 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
602 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
604 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
605 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
606 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
608 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
611 CREATE TABLE acq.distribution_formula (
612 id SERIAL PRIMARY KEY,
614 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
616 skip_count INT NOT NULL DEFAULT 0,
617 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
620 CREATE TABLE acq.distribution_formula_entry (
621 id SERIAL PRIMARY KEY,
622 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
624 DEFERRABLE INITIALLY DEFERRED,
625 position INTEGER NOT NULL,
626 item_count INTEGER NOT NULL,
627 owning_lib INTEGER REFERENCES actor.org_unit(id)
628 DEFERRABLE INITIALLY DEFERRED,
629 location INTEGER REFERENCES asset.copy_location(id),
630 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
631 CONSTRAINT acqdfe_must_be_somewhere
632 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
635 CREATE TABLE acq.distribution_formula_application (
636 id BIGSERIAL PRIMARY KEY,
637 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
638 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
640 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
641 lineitem INT NOT NULL
642 REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
645 CREATE INDEX acqdfa_df_idx
646 ON acq.distribution_formula_application(formula);
647 CREATE INDEX acqdfa_li_idx
648 ON acq.distribution_formula_application(lineitem);
649 CREATE INDEX acqdfa_creator_idx
650 ON acq.distribution_formula_application(creator);
652 CREATE TABLE acq.fund_tag (
653 id SERIAL PRIMARY KEY,
655 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
657 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
660 CREATE TABLE acq.fund_tag_map (
661 id SERIAL PRIMARY KEY,
662 fund INTEGER NOT NULL REFERENCES acq.fund(id)
663 DEFERRABLE INITIALLY DEFERRED,
664 tag INTEGER REFERENCES acq.fund_tag(id)
666 DEFERRABLE INITIALLY DEFERRED,
667 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
670 CREATE TABLE acq.fund_transfer (
671 id SERIAL PRIMARY KEY,
672 src_fund INT NOT NULL REFERENCES acq.fund( id )
673 DEFERRABLE INITIALLY DEFERRED,
674 src_amount NUMERIC NOT NULL,
675 dest_fund INT NOT NULL REFERENCES acq.fund( id )
676 DEFERRABLE INITIALLY DEFERRED,
677 dest_amount NUMERIC NOT NULL,
678 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
679 transfer_user INT NOT NULL REFERENCES actor.usr( id )
680 DEFERRABLE INITIALLY DEFERRED,
682 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
683 DEFERRABLE INITIALLY DEFERRED
686 CREATE INDEX acqftr_usr_idx
687 ON acq.fund_transfer( transfer_user );
689 COMMENT ON TABLE acq.fund_transfer IS $$
691 * Copyright (C) 2009 Georgia Public Library Service
692 * Scott McKellar <scott@esilibrary.com>
696 * Each row represents the transfer of money from a source fund
697 * to a destination fund. There should be corresponding entries
698 * in acq.fund_allocation. The purpose of acq.fund_transfer is
699 * to record how much money moved from which fund to which other
702 * The presence of two amount fields, rather than one, reflects
703 * the possibility that the two funds are denominated in different
704 * currencies. If they use the same currency type, the two
705 * amounts should be the same.
709 * This program is free software; you can redistribute it and/or
710 * modify it under the terms of the GNU General Public License
711 * as published by the Free Software Foundation; either version 2
712 * of the License, or (at your option) any later version.
714 * This program is distributed in the hope that it will be useful,
715 * but WITHOUT ANY WARRANTY; without even the implied warranty of
716 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
717 * GNU General Public License for more details.
721 CREATE TABLE acq.fiscal_calendar (
722 id SERIAL PRIMARY KEY,
726 -- Create a default calendar (though we don't specify its contents).
727 -- Create a foreign key in actor.org_unit, initially pointing to
728 -- the default calendar.
730 INSERT INTO acq.fiscal_calendar (
737 ALTER TABLE actor.org_unit ADD FOREIGN KEY
738 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
739 DEFERRABLE INITIALLY DEFERRED;
741 CREATE TABLE acq.fiscal_year (
742 id SERIAL PRIMARY KEY,
743 calendar INT NOT NULL
744 REFERENCES acq.fiscal_calendar
746 DEFERRABLE INITIALLY DEFERRED,
748 year_begin TIMESTAMPTZ NOT NULL,
749 year_end TIMESTAMPTZ NOT NULL,
750 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
751 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
754 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
755 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
756 in_dir TEXT -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
757 ) INHERITS (config.remote_account);
759 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
760 ALTER TABLE acq.edi_account ADD CONSTRAINT acq_edi_account_id_unique UNIQUE (id);
762 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
763 -- the table, assigning ids programmatically instead of using a sequence.
764 CREATE TABLE acq.debit_attribution (
765 id INT NOT NULL PRIMARY KEY,
766 fund_debit INT NOT NULL
767 REFERENCES acq.fund_debit
768 DEFERRABLE INITIALLY DEFERRED,
769 debit_amount NUMERIC NOT NULL,
770 funding_source_credit INT REFERENCES acq.funding_source_credit
771 DEFERRABLE INITIALLY DEFERRED,
772 credit_amount NUMERIC
775 CREATE INDEX acq_attribution_debit_idx
776 ON acq.debit_attribution( fund_debit );
778 CREATE INDEX acq_attribution_credit_idx
779 ON acq.debit_attribution( funding_source_credit );
783 CREATE TABLE acq.invoice_method (
784 code TEXT PRIMARY KEY,
785 name TEXT NOT NULL -- i18n-ize
788 CREATE TABLE acq.invoice_payment_method (
789 code TEXT PRIMARY KEY,
790 name TEXT NOT NULL -- i18n-ize
793 CREATE TABLE acq.invoice (
794 id SERIAL PRIMARY KEY,
795 receiver INT NOT NULL REFERENCES actor.org_unit (id),
796 provider INT NOT NULL REFERENCES acq.provider (id),
797 shipper INT NOT NULL REFERENCES acq.provider (id),
798 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
799 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
800 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
801 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
803 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
804 DEFERRABLE INITIALLY DEFERRED,
806 complete BOOL NOT NULL DEFAULT FALSE,
807 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
810 CREATE TABLE acq.invoice_entry (
811 id SERIAL PRIMARY KEY,
812 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
813 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
814 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
815 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
816 phys_item_count INT, -- and how many did staff count
818 billed_per_item BOOL,
819 cost_billed NUMERIC(8,2),
820 actual_cost NUMERIC(8,2),
821 amount_paid NUMERIC (8,2)
824 CREATE TABLE acq.invoice_item_type (
825 code TEXT PRIMARY KEY,
826 name TEXT NOT NULL, -- i18n-ize
827 prorate BOOL NOT NULL DEFAULT FALSE
830 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
831 id SERIAL PRIMARY KEY,
832 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
833 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
834 fund_debit INT REFERENCES acq.fund_debit (id),
835 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
839 cost_billed NUMERIC(8,2),
840 actual_cost NUMERIC(8,2),
841 fund INT REFERENCES acq.fund (id)
842 DEFERRABLE INITIALLY DEFERRED,
843 amount_paid NUMERIC (8,2)
846 CREATE TABLE acq.po_item (
847 id SERIAL PRIMARY KEY,
848 purchase_order INT REFERENCES acq.purchase_order (id)
849 ON UPDATE CASCADE ON DELETE SET NULL
850 DEFERRABLE INITIALLY DEFERRED,
851 fund_debit INT REFERENCES acq.fund_debit (id)
852 DEFERRABLE INITIALLY DEFERRED,
853 inv_item_type TEXT NOT NULL
854 REFERENCES acq.invoice_item_type (code)
855 DEFERRABLE INITIALLY DEFERRED,
859 estimated_cost NUMERIC(8,2),
860 fund INT REFERENCES acq.fund (id)
861 DEFERRABLE INITIALLY DEFERRED
865 CREATE TABLE acq.user_request_type (
866 id SERIAL PRIMARY KEY,
867 label TEXT NOT NULL UNIQUE -- i18n-ize
870 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
871 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
872 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
873 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
874 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
876 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
878 CREATE TABLE acq.user_request (
879 id SERIAL PRIMARY KEY,
880 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
881 hold BOOL NOT NULL DEFAULT TRUE,
883 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
884 holdable_formats TEXT, -- nullable, for use in hold creation
886 email_notify BOOL NOT NULL DEFAULT TRUE,
887 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
888 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
889 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
890 need_before TIMESTAMPTZ, -- don't create holds after this
893 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
905 cancel_reason INT REFERENCES acq.cancel_reason( id )
906 DEFERRABLE INITIALLY DEFERRED
912 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
913 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
916 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
919 SELECT COUNT(*) INTO counter
920 FROM oils_xpath_table(
924 '//*[@tag="' || tag || '"]',
926 ) as t(i int,c text);
928 FOR i IN 1 .. counter LOOP
931 FROM ( SELECT id,i,t,v
932 FROM oils_xpath_table(
936 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
937 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
939 ) as t(id int,t text,v text)
950 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
951 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
955 lida acq.flat_lineitem_detail%ROWTYPE;
957 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
958 IF NOT FOUND THEN RETURN; END IF;
960 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
961 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
968 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
969 JOIN acq.provider_holding_subfield_map a USING (subfield)
970 WHERE a.provider = prov_i
979 -- select * from acq.extract_provider_holding_data(699);
981 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
982 SELECT public.extract_marc_field('acq.lineitem', $1, $2, $3);
986 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
987 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
990 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
991 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
995 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
998 Suggested vendor fields:
1006 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1015 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1017 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1019 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1020 IF (atype = 'lineitem_provider_attr_definition') THEN
1021 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1022 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1025 IF (atype = 'lineitem_provider_attr_definition') THEN
1026 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1027 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1028 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1029 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1030 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1033 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1038 SELECT extract_acq_marc_field(id, xpath_string || '[' || pos || ']', adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1040 IF (value IS NOT NULL AND value <> '') THEN
1041 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1042 VALUES (NEW.id, adef.id, atype, adef.code, value);
1056 $function$ LANGUAGE PLPGSQL;
1058 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1060 IF TG_OP = 'UPDATE' THEN
1061 DELETE FROM acq.lineitem_attr
1062 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1065 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1069 $$ LANGUAGE PLPGSQL;
1071 CREATE TRIGGER cleanup_lineitem_trigger
1072 BEFORE UPDATE OR DELETE ON acq.lineitem
1073 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1075 CREATE TRIGGER ingest_lineitem_trigger
1076 AFTER INSERT OR UPDATE ON acq.lineitem
1077 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1079 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1083 IF from_ex = to_ex THEN
1087 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1092 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1101 $$ LANGUAGE PLPGSQL;
1103 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1104 SELECT $3 * acq.exchange_ratio($1, $2);
1107 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1109 Examine the acq.fiscal_year table, comparing successive years.
1110 Report any inconsistencies, i.e. years that overlap, have gaps
1111 between them, or are out of sequence.
1113 RETURNS SETOF RECORD AS $$
1137 ELSIF curr_year.calendar = prev_year.calendar THEN
1138 IF curr_year.year_begin > prev_year.year_end THEN
1139 -- This ugly kludge works around the fact that older
1140 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1141 FOR return_rec IN SELECT
1144 'Gap between fiscal years'::TEXT
1146 RETURN NEXT return_rec;
1148 ELSIF curr_year.year_begin < prev_year.year_end THEN
1149 FOR return_rec IN SELECT
1152 'Overlapping fiscal years'::TEXT
1154 RETURN NEXT return_rec;
1156 ELSIF curr_year.year < prev_year.year THEN
1157 FOR return_rec IN SELECT
1160 'Fiscal years out of order'::TEXT
1162 RETURN NEXT return_rec;
1167 prev_year := curr_year;
1172 $$ LANGUAGE plpgsql;
1174 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1176 old_amount IN NUMERIC, -- in currency of old fund
1178 new_amount IN NUMERIC, -- in currency of new fund
1180 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1181 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1182 ) RETURNS VOID AS $$
1183 /* -------------------------------------------------------------------------------
1185 Function to transfer money from one fund to another.
1187 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1188 negative amount for the old (losing) fund and a positive amount for the new
1189 (gaining) fund. In some cases there may be more than one such pair of entries
1190 in order to pull the money from different funding sources, or more specifically
1191 from different funding source credits. For each such pair there is also an
1192 entry in acq.fund_transfer.
1194 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1195 choose a funding source for the transferred money to come from. This choice
1196 must meet two constraints, so far as possible:
1198 1. The amount transferred from a given funding source must not exceed the
1199 amount allocated to the old fund by the funding source. To that end we
1200 compare the amount being transferred to the amount allocated.
1202 2. We shouldn't transfer money that has already been spent or encumbered, as
1203 defined by the funding attribution process. We attribute expenses to the
1204 oldest funding source credits first. In order to avoid transferring that
1205 attributed money, we reverse the priority, transferring from the newest funding
1206 source credits first. There can be no guarantee that this approach will
1207 avoid overcommitting a fund, but no other approach can do any better.
1209 In this context the age of a funding source credit is defined by the
1210 deadline_date for credits with deadline_dates, and by the effective_date for
1211 credits without deadline_dates, with the proviso that credits with deadline_dates
1212 are all considered "older" than those without.
1216 In the signature for this function, there is one last parameter commented out,
1217 named "funding_source_in". Correspondingly, the WHERE clause for the query
1218 driving the main loop has an OR clause commented out, which references the
1219 funding_source_in parameter.
1221 If these lines are uncommented, this function will allow the user optionally to
1222 restrict a fund transfer to a specified funding source. If the source
1223 parameter is left NULL, then there will be no such restriction.
1225 ------------------------------------------------------------------------------- */
1227 same_currency BOOLEAN;
1228 currency_ratio NUMERIC;
1229 old_fund_currency TEXT;
1230 old_remaining NUMERIC; -- in currency of old fund
1231 new_fund_currency TEXT;
1232 new_fund_active BOOLEAN;
1233 new_remaining NUMERIC; -- in currency of new fund
1234 curr_old_amt NUMERIC; -- in currency of old fund
1235 curr_new_amt NUMERIC; -- in currency of new fund
1236 source_addition NUMERIC; -- in currency of funding source
1237 source_deduction NUMERIC; -- in currency of funding source
1238 orig_allocated_amt NUMERIC; -- in currency of funding source
1239 allocated_amt NUMERIC; -- in currency of fund
1245 IF old_fund IS NULL THEN
1246 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1249 IF old_amount IS NULL THEN
1250 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1253 -- The new fund and its amount must be both NULL or both not NULL.
1255 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1256 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1259 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1260 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1263 IF user_id IS NULL THEN
1264 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1267 -- Initialize the amounts to be transferred, each denominated
1268 -- in the currency of its respective fund. They will be
1269 -- reduced on each iteration of the loop.
1271 old_remaining := old_amount;
1272 new_remaining := new_amount;
1274 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1275 -- old_amount, old_fund, new_amount, new_fund;
1277 -- Get the currency types of the old and new funds.
1288 IF old_fund_currency IS NULL THEN
1289 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1292 IF new_fund IS NOT NULL THEN
1304 IF new_fund_currency IS NULL THEN
1305 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1306 ELSIF NOT new_fund_active THEN
1308 -- No point in putting money into a fund from whence you can't spend it
1310 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1313 IF new_amount = old_amount THEN
1314 same_currency := true;
1315 currency_ratio := 1;
1318 -- We'll have to translate currency between funds. We presume that
1319 -- the calling code has already applied an appropriate exchange rate,
1320 -- so we'll apply the same conversion to each sub-transfer.
1322 same_currency := false;
1323 currency_ratio := new_amount / old_amount;
1327 -- Identify the funding source(s) from which we want to transfer the money.
1328 -- The principle is that we want to transfer the newest money first, because
1329 -- we spend the oldest money first. The priority for spending is defined
1330 -- by a sort of the view acq.ordered_funding_source_credit.
1335 ofsc.funding_source,
1337 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1341 acq.ordered_funding_source_credit AS ofsc,
1342 acq.funding_source fs
1344 ofsc.funding_source = fs.id
1345 and ofsc.funding_source IN
1347 SELECT funding_source
1348 FROM acq.fund_allocation
1349 WHERE fund = old_fund
1353 -- ofsc.funding_source = funding_source_in
1354 -- OR funding_source_in IS NULL
1357 ofsc.sort_priority desc,
1358 ofsc.sort_date desc,
1362 -- Determine how much money the old fund got from this funding source,
1363 -- denominated in the currency types of the source and of the fund.
1364 -- This result may reflect transfers from previous iterations.
1367 COALESCE( sum( amount ), 0 ),
1368 COALESCE( sum( amount )
1369 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1371 orig_allocated_amt, -- in currency of the source
1372 allocated_amt -- in currency of the old fund
1377 and funding_source = source.funding_source;
1379 -- Determine how much to transfer from this credit, in the currency
1380 -- of the fund. Begin with the amount remaining to be attributed:
1382 curr_old_amt := old_remaining;
1384 -- Can't attribute more than was allocated from the fund:
1386 IF curr_old_amt > allocated_amt THEN
1387 curr_old_amt := allocated_amt;
1390 -- Can't attribute more than the amount of the current credit:
1392 IF curr_old_amt > source.converted_amt THEN
1393 curr_old_amt := source.converted_amt;
1396 curr_old_amt := trunc( curr_old_amt, 2 );
1398 old_remaining := old_remaining - curr_old_amt;
1400 -- Determine the amount to be deducted, if any,
1401 -- from the old allocation.
1403 IF old_remaining > 0 THEN
1405 -- In this case we're using the whole allocation, so use that
1406 -- amount directly instead of applying a currency translation
1407 -- and thereby inviting round-off errors.
1409 source_deduction := - orig_allocated_amt;
1411 source_deduction := trunc(
1412 ( - curr_old_amt ) *
1413 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1417 IF source_deduction <> 0 THEN
1419 -- Insert negative allocation for old fund in fund_allocation,
1420 -- converted into the currency of the funding source
1422 INSERT INTO acq.fund_allocation (
1429 source.funding_source,
1433 'Transfer to fund ' || new_fund
1437 IF new_fund IS NOT NULL THEN
1439 -- Determine how much to add to the new fund, in
1440 -- its currency, and how much remains to be added:
1442 IF same_currency THEN
1443 curr_new_amt := curr_old_amt;
1445 IF old_remaining = 0 THEN
1447 -- This is the last iteration, so nothing should be left
1449 curr_new_amt := new_remaining;
1452 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1453 new_remaining := new_remaining - curr_new_amt;
1457 -- Determine how much to add, if any,
1458 -- to the new fund's allocation.
1460 IF old_remaining > 0 THEN
1462 -- In this case we're using the whole allocation, so use that amount
1463 -- amount directly instead of applying a currency translation and
1464 -- thereby inviting round-off errors.
1466 source_addition := orig_allocated_amt;
1467 ELSIF source.currency_type = old_fund_currency THEN
1469 -- In this case we don't need a round trip currency translation,
1470 -- thereby inviting round-off errors:
1472 source_addition := curr_old_amt;
1474 source_addition := trunc(
1476 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1480 IF source_addition <> 0 THEN
1482 -- Insert positive allocation for new fund in fund_allocation,
1483 -- converted to the currency of the founding source
1485 INSERT INTO acq.fund_allocation (
1492 source.funding_source,
1496 'Transfer from fund ' || old_fund
1501 IF trunc( curr_old_amt, 2 ) <> 0
1502 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1504 -- Insert row in fund_transfer, using amounts in the currency of the funds
1506 INSERT INTO acq.fund_transfer (
1513 funding_source_credit
1516 trunc( curr_old_amt, 2 ),
1518 trunc( curr_new_amt, 2 ),
1525 if old_remaining <= 0 THEN
1526 EXIT; -- Nothing more to be transferred
1530 $$ LANGUAGE plpgsql;
1532 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1534 Function to attribute expenditures and encumbrances to funding source credits,
1535 and thereby to funding sources.
1537 Read the debits in chonological order, attributing each one to one or
1538 more funding source credits. Constraints:
1540 1. Don't attribute more to a credit than the amount of the credit.
1542 2. For a given fund, don't attribute more to a funding source than the
1543 source has allocated to that fund.
1545 3. Attribute debits to credits with deadlines before attributing them to
1546 credits without deadlines. Otherwise attribute to the earliest credits
1547 first, based on the deadline date when present, or on the effective date
1548 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1549 This ordering is defined by an ORDER BY clause on the view
1550 acq.ordered_funding_source_credit.
1552 Start by truncating the table acq.debit_attribution. Then insert a row
1553 into that table for each attribution. If a debit cannot be fully
1554 attributed, insert a row for the unattributable balance, with the
1555 funding_source_credit and credit_amount columns NULL.
1558 curr_fund_source_bal RECORD;
1559 seqno INT; -- sequence num for credits applicable to a fund
1560 fund_credit RECORD; -- current row in temp t_fund_credit table
1561 fc RECORD; -- used for loading t_fund_credit table
1562 sc RECORD; -- used for loading t_fund_credit table
1564 -- Used exclusively in the main loop:
1566 deb RECORD; -- current row from acq.fund_debit table
1567 curr_credit_bal RECORD; -- current row from temp t_credit table
1568 debit_balance NUMERIC; -- amount left to attribute for current debit
1569 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1570 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1571 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1572 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1573 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1574 attrib_count INT; -- populates id of acq.debit_attribution
1577 -- Load a temporary table. For each combination of fund and funding source,
1578 -- load an entry with the total amount allocated to that fund by that source.
1579 -- This sum may reflect transfers as well as original allocations. We will
1580 -- reduce this balance whenever we attribute debits to it.
1582 CREATE TEMP TABLE t_fund_source_bal
1586 funding_source AS source,
1587 sum( amount ) AS balance
1596 CREATE INDEX t_fund_source_bal_idx
1597 ON t_fund_source_bal( fund, source );
1598 -------------------------------------------------------------------------------
1600 -- Load another temporary table. For each fund, load zero or more
1601 -- funding source credits from which that fund can get money.
1603 CREATE TEMP TABLE t_fund_credit (
1610 SELECT DISTINCT fund
1611 FROM acq.fund_allocation
1613 LOOP -- Loop over the funds
1619 acq.ordered_funding_source_credit AS ofsc
1621 ofsc.funding_source IN
1623 SELECT funding_source
1624 FROM acq.fund_allocation
1625 WHERE fund = fc.fund
1631 LOOP -- Add each credit to the list
1632 INSERT INTO t_fund_credit (
1641 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1643 END LOOP; -- Loop over credits for a given fund
1644 END LOOP; -- Loop over funds
1646 CREATE INDEX t_fund_credit_idx
1647 ON t_fund_credit( fund, seq );
1648 -------------------------------------------------------------------------------
1650 -- Load yet another temporary table. This one is a list of funding source
1651 -- credits, with their balances. We shall reduce those balances as we
1652 -- attribute debits to them.
1654 CREATE TEMP TABLE t_credit
1658 fsc.funding_source AS source,
1659 fsc.amount AS balance,
1660 fs.currency_type AS currency_type
1662 acq.funding_source_credit AS fsc,
1663 acq.funding_source fs
1665 fsc.funding_source = fs.id
1668 CREATE INDEX t_credit_idx
1669 ON t_credit( credit );
1671 -------------------------------------------------------------------------------
1673 -- Now that we have loaded the lookup tables: loop through the debits,
1674 -- attributing each one to one or more funding source credits.
1676 truncate table acq.debit_attribution;
1694 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1696 debit_balance := deb.amount;
1698 -- Loop over the funding source credits that are eligible
1699 -- to pay for this debit
1711 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1713 -- Look up the balance for this credit. If it's zero, then
1714 -- it's not useful, so treat it as if you didn't find it.
1715 -- (Actually there shouldn't be any zero balances in the table,
1716 -- but we check just to make sure.)
1719 INTO curr_credit_bal
1722 credit = fund_credit.credit
1725 IF curr_credit_bal IS NULL THEN
1727 -- This credit is exhausted; try the next one.
1733 -- At this point we have an applicable credit with some money left.
1734 -- Now see if the relevant funding_source has any money left.
1736 -- Look up the balance of the allocation for this combination of
1737 -- fund and source. If you find such an entry, but it has a zero
1738 -- balance, then it's not useful, so treat it as unfound.
1739 -- (Actually there shouldn't be any zero balances in the table,
1740 -- but we check just to make sure.)
1743 INTO curr_fund_source_bal
1744 FROM t_fund_source_bal
1747 AND source = curr_credit_bal.source
1750 IF curr_fund_source_bal IS NULL THEN
1752 -- This fund/source doesn't exist or is already exhausted,
1753 -- so we can't use this credit. Go on to the next one.
1758 -- Convert the available balances to the currency of the fund
1760 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1761 curr_credit_bal.currency_type, deb.currency_type );
1762 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1763 curr_credit_bal.currency_type, deb.currency_type );
1765 -- Determine how much we can attribute to this credit: the minimum
1766 -- of the debit amount, the fund/source balance, and the
1769 --RAISE NOTICE ' deb bal %', debit_balance;
1770 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1771 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1773 conv_attr_amount := NULL;
1774 attr_amount := debit_balance;
1776 IF attr_amount > conv_alloc_balance THEN
1777 attr_amount := conv_alloc_balance;
1778 conv_attr_amount := curr_fund_source_bal.balance;
1780 IF attr_amount > conv_cred_balance THEN
1781 attr_amount := conv_cred_balance;
1782 conv_attr_amount := curr_credit_bal.balance;
1785 -- If we're attributing all of one of the balances, then that's how
1786 -- much we will deduct from the balances, and we already captured
1787 -- that amount above. Otherwise we must convert the amount of the
1788 -- attribution from the currency of the fund back to the currency of
1789 -- the funding source.
1791 IF conv_attr_amount IS NULL THEN
1792 conv_attr_amount := attr_amount * acq.exchange_ratio(
1793 deb.currency_type, curr_credit_bal.currency_type );
1796 -- Insert a row to record the attribution
1798 attrib_count := attrib_count + 1;
1799 INSERT INTO acq.debit_attribution (
1803 funding_source_credit,
1809 curr_credit_bal.credit,
1813 -- Subtract the attributed amount from the various balances
1815 debit_balance := debit_balance - attr_amount;
1816 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1818 IF curr_fund_source_bal.balance <= 0 THEN
1820 -- This allocation is exhausted. Delete it so
1821 -- that we don't waste time looking at it again.
1823 DELETE FROM t_fund_source_bal
1825 fund = curr_fund_source_bal.fund
1826 AND source = curr_fund_source_bal.source;
1828 UPDATE t_fund_source_bal
1829 SET balance = balance - conv_attr_amount
1831 fund = curr_fund_source_bal.fund
1832 AND source = curr_fund_source_bal.source;
1835 IF curr_credit_bal.balance <= 0 THEN
1837 -- This funding source credit is exhausted. Delete it
1838 -- so that we don't waste time looking at it again.
1840 --DELETE FROM t_credit
1842 -- credit = curr_credit_bal.credit;
1844 DELETE FROM t_fund_credit
1846 credit = curr_credit_bal.credit;
1849 SET balance = curr_credit_bal.balance
1851 credit = curr_credit_bal.credit;
1854 -- Are we done with this debit yet?
1856 IF debit_balance <= 0 THEN
1857 EXIT; -- We've fully attributed this debit; stop looking at credits.
1859 END LOOP; -- End loop over credits
1861 IF debit_balance <> 0 THEN
1863 -- We weren't able to attribute this debit, or at least not
1864 -- all of it. Insert a row for the unattributed balance.
1866 attrib_count := attrib_count + 1;
1867 INSERT INTO acq.debit_attribution (
1871 funding_source_credit,
1881 END LOOP; -- End of loop over debits
1883 $$ LANGUAGE 'plpgsql';
1885 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit(
1889 ) RETURNS VOID AS $$
1900 IF old_year IS NULL THEN
1901 RAISE EXCEPTION 'Input year argument is NULL';
1902 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1903 RAISE EXCEPTION 'Input year is out of range';
1906 IF user_id IS NULL THEN
1907 RAISE EXCEPTION 'Input user id argument is NULL';
1910 IF org_unit_id IS NULL THEN
1911 RAISE EXCEPTION 'Org unit id argument is NULL';
1913 SELECT TRUE INTO org_found
1915 WHERE id = org_unit_id;
1917 IF org_found IS NULL THEN
1918 RAISE EXCEPTION 'Org unit id is invalid';
1922 -- Loop over the applicable funds
1924 FOR old_fund in SELECT * FROM acq.fund
1928 AND org = org_unit_id
1931 INSERT INTO acq.fund (
1939 balance_warning_percent,
1940 balance_stop_percent
1945 old_fund.currency_type,
1949 old_fund.balance_warning_percent,
1950 old_fund.balance_stop_percent
1952 RETURNING id INTO new_id;
1954 WHEN unique_violation THEN
1955 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
1958 --RAISE NOTICE 'Propagating fund % to fund %',
1959 -- old_fund.code, new_id;
1962 $$ LANGUAGE plpgsql;
1964 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1968 ) RETURNS VOID AS $$
1979 IF old_year IS NULL THEN
1980 RAISE EXCEPTION 'Input year argument is NULL';
1981 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1982 RAISE EXCEPTION 'Input year is out of range';
1985 IF user_id IS NULL THEN
1986 RAISE EXCEPTION 'Input user id argument is NULL';
1989 IF org_unit_id IS NULL THEN
1990 RAISE EXCEPTION 'Org unit id argument is NULL';
1992 SELECT TRUE INTO org_found
1994 WHERE id = org_unit_id;
1996 IF org_found IS NULL THEN
1997 RAISE EXCEPTION 'Org unit id is invalid';
2001 -- Loop over the applicable funds
2003 FOR old_fund in SELECT * FROM acq.fund
2008 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2012 INSERT INTO acq.fund (
2020 balance_warning_percent,
2021 balance_stop_percent
2026 old_fund.currency_type,
2030 old_fund.balance_warning_percent,
2031 old_fund.balance_stop_percent
2033 RETURNING id INTO new_id;
2035 WHEN unique_violation THEN
2036 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2039 --RAISE NOTICE 'Propagating fund % to fund %',
2040 -- old_fund.code, new_id;
2043 $$ LANGUAGE plpgsql;
2045 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit(
2049 ) RETURNS VOID AS $$
2053 new_year INT := old_year + 1;
2055 xfer_amount NUMERIC;
2064 IF old_year IS NULL THEN
2065 RAISE EXCEPTION 'Input year argument is NULL';
2066 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2067 RAISE EXCEPTION 'Input year is out of range';
2070 IF user_id IS NULL THEN
2071 RAISE EXCEPTION 'Input user id argument is NULL';
2074 IF org_unit_id IS NULL THEN
2075 RAISE EXCEPTION 'Org unit id argument is NULL';
2078 -- Validate the org unit
2083 WHERE id = org_unit_id;
2085 IF org_found IS NULL THEN
2086 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2090 -- Loop over the propagable funds to identify the details
2091 -- from the old fund plus the id of the new one, if it exists.
2095 oldf.id AS old_fund,
2101 newf.id AS new_fund_id
2104 LEFT JOIN acq.fund AS newf
2105 ON ( oldf.code = newf.code )
2107 oldf.org = org_unit_id
2108 and oldf.year = old_year
2110 and newf.year = new_year
2112 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2114 IF roll_fund.new_fund_id IS NULL THEN
2116 -- The old fund hasn't been propagated yet. Propagate it now.
2118 INSERT INTO acq.fund (
2126 balance_warning_percent,
2127 balance_stop_percent
2132 roll_fund.currency_type,
2136 roll_fund.balance_warning_percent,
2137 roll_fund.balance_stop_percent
2139 RETURNING id INTO new_fund;
2141 new_fund = roll_fund.new_fund_id;
2144 -- Determine the amount to transfer
2148 FROM acq.fund_spent_balance
2149 WHERE fund = roll_fund.old_fund;
2151 IF xfer_amount <> 0 THEN
2152 IF roll_fund.rollover THEN
2154 -- Transfer balance from old fund to new
2156 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2158 PERFORM acq.transfer_fund(
2168 -- Transfer balance from old fund to the void
2170 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2172 PERFORM acq.transfer_fund(
2183 IF roll_fund.rollover THEN
2185 -- Move any lineitems from the old fund to the new one
2186 -- where the associated debit is an encumbrance.
2188 -- Any other tables tying expenditure details to funds should
2189 -- receive similar treatment. At this writing there are none.
2191 UPDATE acq.lineitem_detail
2194 fund = roll_fund.old_fund -- this condition may be redundant
2200 fund = roll_fund.old_fund
2204 -- Move encumbrance debits from the old fund to the new fund
2206 UPDATE acq.fund_debit
2209 fund = roll_fund.old_fund
2213 -- Mark old fund as inactive, now that we've closed it
2217 WHERE id = roll_fund.old_fund;
2220 $$ LANGUAGE plpgsql;
2222 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2226 ) RETURNS VOID AS $$
2230 new_year INT := old_year + 1;
2232 xfer_amount NUMERIC;
2241 IF old_year IS NULL THEN
2242 RAISE EXCEPTION 'Input year argument is NULL';
2243 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2244 RAISE EXCEPTION 'Input year is out of range';
2247 IF user_id IS NULL THEN
2248 RAISE EXCEPTION 'Input user id argument is NULL';
2251 IF org_unit_id IS NULL THEN
2252 RAISE EXCEPTION 'Org unit id argument is NULL';
2255 -- Validate the org unit
2260 WHERE id = org_unit_id;
2262 IF org_found IS NULL THEN
2263 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2267 -- Loop over the propagable funds to identify the details
2268 -- from the old fund plus the id of the new one, if it exists.
2272 oldf.id AS old_fund,
2278 newf.id AS new_fund_id
2281 LEFT JOIN acq.fund AS newf
2282 ON ( oldf.code = newf.code )
2284 oldf.year = old_year
2286 AND newf.year = new_year
2288 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2291 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2293 IF roll_fund.new_fund_id IS NULL THEN
2295 -- The old fund hasn't been propagated yet. Propagate it now.
2297 INSERT INTO acq.fund (
2305 balance_warning_percent,
2306 balance_stop_percent
2311 roll_fund.currency_type,
2315 roll_fund.balance_warning_percent,
2316 roll_fund.balance_stop_percent
2318 RETURNING id INTO new_fund;
2320 new_fund = roll_fund.new_fund_id;
2323 -- Determine the amount to transfer
2327 FROM acq.fund_spent_balance
2328 WHERE fund = roll_fund.old_fund;
2330 IF xfer_amount <> 0 THEN
2331 IF roll_fund.rollover THEN
2333 -- Transfer balance from old fund to new
2335 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2337 PERFORM acq.transfer_fund(
2347 -- Transfer balance from old fund to the void
2349 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2351 PERFORM acq.transfer_fund(
2362 IF roll_fund.rollover THEN
2364 -- Move any lineitems from the old fund to the new one
2365 -- where the associated debit is an encumbrance.
2367 -- Any other tables tying expenditure details to funds should
2368 -- receive similar treatment. At this writing there are none.
2370 UPDATE acq.lineitem_detail
2373 fund = roll_fund.old_fund -- this condition may be redundant
2379 fund = roll_fund.old_fund
2383 -- Move encumbrance debits from the old fund to the new fund
2385 UPDATE acq.fund_debit
2388 fund = roll_fund.old_fund
2392 -- Mark old fund as inactive, now that we've closed it
2396 WHERE id = roll_fund.old_fund;
2399 $$ LANGUAGE plpgsql;
2401 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2402 SELECT funding_source,
2403 SUM(amount) AS amount
2404 FROM acq.funding_source_credit
2407 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2408 SELECT funding_source,
2409 SUM(a.amount)::NUMERIC(100,2) AS amount
2410 FROM acq.fund_allocation a
2413 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2414 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2415 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2416 FROM acq.funding_source_credit_total c
2417 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2420 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2422 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2423 FROM acq.fund_allocation a
2424 JOIN acq.fund f ON (a.fund = f.id)
2425 JOIN acq.funding_source s ON (a.funding_source = s.id)
2428 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2429 SELECT fund.id AS fund,
2430 fund_debit.encumbrance AS encumbrance,
2431 SUM( COALESCE( fund_debit.amount, 0 ) ) AS amount
2432 FROM acq.fund AS fund
2433 LEFT JOIN acq.fund_debit AS fund_debit
2434 ON ( fund.id = fund_debit.fund )
2437 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2439 SUM(amount) AS amount
2440 FROM acq.fund_debit_total
2441 WHERE encumbrance IS TRUE
2444 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2446 SUM(amount) AS amount
2447 FROM acq.fund_debit_total
2448 WHERE encumbrance IS FALSE
2451 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2453 c.amount - COALESCE(d.amount,0.0) AS amount
2454 FROM acq.fund_allocation_total c
2455 LEFT JOIN acq.fund_debit_total d USING (fund);
2457 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2459 c.amount - COALESCE(d.amount,0.0) AS amount
2460 FROM acq.fund_allocation_total c
2461 LEFT JOIN acq.fund_spent_total d USING (fund);
2463 -- For each fund: the total allocation from all sources, in the
2464 -- currency of the fund (or 0 if there are no allocations)
2466 CREATE VIEW acq.all_fund_allocation_total AS
2469 COALESCE( SUM( a.amount * acq.exchange_ratio(
2470 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2474 LEFT JOIN acq.fund_allocation a
2476 LEFT JOIN acq.funding_source s
2477 ON a.funding_source = s.id
2481 -- For every fund: the total encumbrances (or 0 if none),
2482 -- in the currency of the fund.
2484 CREATE VIEW acq.all_fund_encumbrance_total AS
2487 COALESCE( encumb.amount, 0 ) AS amount
2493 sum( amount ) AS amount
2500 ON f.id = encumb.fund;
2502 -- For every fund: the total spent (or 0 if none),
2503 -- in the currency of the fund.
2505 CREATE VIEW acq.all_fund_spent_total AS
2508 COALESCE( spent.amount, 0 ) AS amount
2514 sum( amount ) AS amount
2521 ON f.id = spent.fund;
2523 -- For each fund: the amount not yet spent, in the currency
2524 -- of the fund. May include encumbrances.
2526 CREATE VIEW acq.all_fund_spent_balance AS
2529 c.amount - d.amount AS amount
2530 FROM acq.all_fund_allocation_total c
2531 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2533 -- For each fund: the amount neither spent nor encumbered,
2534 -- in the currency of the fund
2536 CREATE VIEW acq.all_fund_combined_balance AS
2539 a.amount - COALESCE( c.amount, 0 ) AS amount
2541 acq.all_fund_allocation_total a
2545 SUM( amount ) AS amount
2550 ) AS c USING ( fund );
2552 CREATE TABLE acq.claim_type (
2553 id SERIAL PRIMARY KEY,
2554 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2555 DEFERRABLE INITIALLY DEFERRED,
2557 description TEXT NOT NULL,
2558 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2561 CREATE TABLE acq.claim (
2562 id SERIAL PRIMARY KEY,
2563 type INT NOT NULL REFERENCES acq.claim_type
2564 DEFERRABLE INITIALLY DEFERRED,
2565 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2566 DEFERRABLE INITIALLY DEFERRED
2569 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2571 CREATE TABLE acq.claim_event (
2572 id BIGSERIAL PRIMARY KEY,
2573 type INT NOT NULL REFERENCES acq.claim_event_type
2574 DEFERRABLE INITIALLY DEFERRED,
2575 claim SERIAL NOT NULL REFERENCES acq.claim
2576 DEFERRABLE INITIALLY DEFERRED,
2577 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2578 creator INT NOT NULL REFERENCES actor.usr
2579 DEFERRABLE INITIALLY DEFERRED,
2583 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );