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 (
789 id SERIAL PRIMARY KEY,
790 receiver INT NOT NULL REFERENCES actor.org_unit (id),
791 provider INT NOT NULL REFERENCES acq.provider (id),
792 shipper INT NOT NULL REFERENCES acq.provider (id),
793 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
794 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
795 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
796 inv_ident TEXT NOT NULL -- vendor-supplied invoice id/number
799 CREATE TABLE acq.invoice_entry (
800 id SERIAL PRIMARY KEY,
801 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
802 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
803 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
804 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
805 phys_item_count INT, -- and how many did staff count
807 billed_per_item BOOL,
808 cost_billed NUMERIC(8,2),
809 actual_cost NUMERIC(8,2)
812 CREATE TABLE acq.invoice_item_type (
813 code TEXT PRIMARY KEY,
814 name TEXT NOT NULL, -- i18n-ize
815 prorate BOOL NOT NULL DEFAULT FALSE
818 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
819 id SERIAL PRIMARY KEY,
820 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
821 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
822 fund_debit INT REFERENCES acq.fund_debit (id),
823 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
827 cost_billed NUMERIC(8,2),
828 actual_cost NUMERIC(8,2),
829 fund INT REFERENCES acq.fund (id)
830 DEFERRABLE INITIALLY DEFERRED
834 CREATE TABLE acq.user_request_type (
835 id SERIAL PRIMARY KEY,
836 label TEXT NOT NULL UNIQUE -- i18n-ize
839 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
840 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
841 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
842 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
843 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
845 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
847 CREATE TABLE acq.user_request (
848 id SERIAL PRIMARY KEY,
849 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
850 hold BOOL NOT NULL DEFAULT TRUE,
852 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
853 holdable_formats TEXT, -- nullable, for use in hold creation
855 email_notify BOOL NOT NULL DEFAULT TRUE,
856 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
857 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
858 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
859 need_before TIMESTAMPTZ, -- don't create holds after this
862 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
874 cancel_reason INT REFERENCES acq.cancel_reason( id )
875 DEFERRABLE INITIALLY DEFERRED
881 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
882 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
885 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
888 SELECT COUNT(*) INTO counter
889 FROM oils_xpath_table(
893 '//*[@tag="' || tag || '"]',
895 ) as t(i int,c text);
897 FOR i IN 1 .. counter LOOP
900 FROM ( SELECT id,i,t,v
901 FROM oils_xpath_table(
905 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
906 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
908 ) as t(id int,t text,v text)
919 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
920 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
924 lida acq.flat_lineitem_detail%ROWTYPE;
926 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
927 IF NOT FOUND THEN RETURN; END IF;
929 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
930 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
937 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
938 JOIN acq.provider_holding_subfield_map a USING (subfield)
939 WHERE a.provider = prov_i
948 -- select * from acq.extract_provider_holding_data(699);
950 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
951 SELECT public.extract_marc_field('acq.lineitem', $1, $2, $3);
955 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
956 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
959 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
960 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
964 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
967 Suggested vendor fields:
975 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
984 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
986 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
988 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
989 IF (atype = 'lineitem_provider_attr_definition') THEN
990 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
991 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
994 IF (atype = 'lineitem_provider_attr_definition') THEN
995 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
996 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
997 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
998 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
999 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1002 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1007 SELECT extract_acq_marc_field(id, xpath_string || '[' || pos || ']', adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1009 IF (value IS NOT NULL AND value <> '') THEN
1010 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1011 VALUES (NEW.id, adef.id, atype, adef.code, value);
1025 $function$ LANGUAGE PLPGSQL;
1027 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1029 IF TG_OP = 'UPDATE' THEN
1030 DELETE FROM acq.lineitem_attr
1031 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1034 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1038 $$ LANGUAGE PLPGSQL;
1040 CREATE TRIGGER cleanup_lineitem_trigger
1041 BEFORE UPDATE OR DELETE ON acq.lineitem
1042 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1044 CREATE TRIGGER ingest_lineitem_trigger
1045 AFTER INSERT OR UPDATE ON acq.lineitem
1046 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1048 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1052 IF from_ex = to_ex THEN
1056 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1061 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1070 $$ LANGUAGE PLPGSQL;
1072 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1073 SELECT $3 * acq.exchange_ratio($1, $2);
1076 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1078 Examine the acq.fiscal_year table, comparing successive years.
1079 Report any inconsistencies, i.e. years that overlap, have gaps
1080 between them, or are out of sequence.
1082 RETURNS SETOF RECORD AS $$
1106 ELSIF curr_year.calendar = prev_year.calendar THEN
1107 IF curr_year.year_begin > prev_year.year_end THEN
1108 -- This ugly kludge works around the fact that older
1109 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1110 FOR return_rec IN SELECT
1113 'Gap between fiscal years'::TEXT
1115 RETURN NEXT return_rec;
1117 ELSIF curr_year.year_begin < prev_year.year_end THEN
1118 FOR return_rec IN SELECT
1121 'Overlapping fiscal years'::TEXT
1123 RETURN NEXT return_rec;
1125 ELSIF curr_year.year < prev_year.year THEN
1126 FOR return_rec IN SELECT
1129 'Fiscal years out of order'::TEXT
1131 RETURN NEXT return_rec;
1136 prev_year := curr_year;
1141 $$ LANGUAGE plpgsql;
1143 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1145 old_amount IN NUMERIC, -- in currency of old fund
1147 new_amount IN NUMERIC, -- in currency of new fund
1149 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1150 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1151 ) RETURNS VOID AS $$
1152 /* -------------------------------------------------------------------------------
1154 Function to transfer money from one fund to another.
1156 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1157 negative amount for the old (losing) fund and a positive amount for the new
1158 (gaining) fund. In some cases there may be more than one such pair of entries
1159 in order to pull the money from different funding sources, or more specifically
1160 from different funding source credits. For each such pair there is also an
1161 entry in acq.fund_transfer.
1163 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1164 choose a funding source for the transferred money to come from. This choice
1165 must meet two constraints, so far as possible:
1167 1. The amount transferred from a given funding source must not exceed the
1168 amount allocated to the old fund by the funding source. To that end we
1169 compare the amount being transferred to the amount allocated.
1171 2. We shouldn't transfer money that has already been spent or encumbered, as
1172 defined by the funding attribution process. We attribute expenses to the
1173 oldest funding source credits first. In order to avoid transferring that
1174 attributed money, we reverse the priority, transferring from the newest funding
1175 source credits first. There can be no guarantee that this approach will
1176 avoid overcommitting a fund, but no other approach can do any better.
1178 In this context the age of a funding source credit is defined by the
1179 deadline_date for credits with deadline_dates, and by the effective_date for
1180 credits without deadline_dates, with the proviso that credits with deadline_dates
1181 are all considered "older" than those without.
1185 In the signature for this function, there is one last parameter commented out,
1186 named "funding_source_in". Correspondingly, the WHERE clause for the query
1187 driving the main loop has an OR clause commented out, which references the
1188 funding_source_in parameter.
1190 If these lines are uncommented, this function will allow the user optionally to
1191 restrict a fund transfer to a specified funding source. If the source
1192 parameter is left NULL, then there will be no such restriction.
1194 ------------------------------------------------------------------------------- */
1196 same_currency BOOLEAN;
1197 currency_ratio NUMERIC;
1198 old_fund_currency TEXT;
1199 old_remaining NUMERIC; -- in currency of old fund
1200 new_fund_currency TEXT;
1201 new_fund_active BOOLEAN;
1202 new_remaining NUMERIC; -- in currency of new fund
1203 curr_old_amt NUMERIC; -- in currency of old fund
1204 curr_new_amt NUMERIC; -- in currency of new fund
1205 source_addition NUMERIC; -- in currency of funding source
1206 source_deduction NUMERIC; -- in currency of funding source
1207 orig_allocated_amt NUMERIC; -- in currency of funding source
1208 allocated_amt NUMERIC; -- in currency of fund
1214 IF old_fund IS NULL THEN
1215 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1218 IF old_amount IS NULL THEN
1219 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1222 -- The new fund and its amount must be both NULL or both not NULL.
1224 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1225 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1228 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1229 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1232 IF user_id IS NULL THEN
1233 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1236 -- Initialize the amounts to be transferred, each denominated
1237 -- in the currency of its respective fund. They will be
1238 -- reduced on each iteration of the loop.
1240 old_remaining := old_amount;
1241 new_remaining := new_amount;
1243 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1244 -- old_amount, old_fund, new_amount, new_fund;
1246 -- Get the currency types of the old and new funds.
1257 IF old_fund_currency IS NULL THEN
1258 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1261 IF new_fund IS NOT NULL THEN
1273 IF new_fund_currency IS NULL THEN
1274 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1275 ELSIF NOT new_fund_active THEN
1277 -- No point in putting money into a fund from whence you can't spend it
1279 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1282 IF new_amount = old_amount THEN
1283 same_currency := true;
1284 currency_ratio := 1;
1287 -- We'll have to translate currency between funds. We presume that
1288 -- the calling code has already applied an appropriate exchange rate,
1289 -- so we'll apply the same conversion to each sub-transfer.
1291 same_currency := false;
1292 currency_ratio := new_amount / old_amount;
1296 -- Identify the funding source(s) from which we want to transfer the money.
1297 -- The principle is that we want to transfer the newest money first, because
1298 -- we spend the oldest money first. The priority for spending is defined
1299 -- by a sort of the view acq.ordered_funding_source_credit.
1304 ofsc.funding_source,
1306 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1310 acq.ordered_funding_source_credit AS ofsc,
1311 acq.funding_source fs
1313 ofsc.funding_source = fs.id
1314 and ofsc.funding_source IN
1316 SELECT funding_source
1317 FROM acq.fund_allocation
1318 WHERE fund = old_fund
1322 -- ofsc.funding_source = funding_source_in
1323 -- OR funding_source_in IS NULL
1326 ofsc.sort_priority desc,
1327 ofsc.sort_date desc,
1331 -- Determine how much money the old fund got from this funding source,
1332 -- denominated in the currency types of the source and of the fund.
1333 -- This result may reflect transfers from previous iterations.
1336 COALESCE( sum( amount ), 0 ),
1337 COALESCE( sum( amount )
1338 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1340 orig_allocated_amt, -- in currency of the source
1341 allocated_amt -- in currency of the old fund
1346 and funding_source = source.funding_source;
1348 -- Determine how much to transfer from this credit, in the currency
1349 -- of the fund. Begin with the amount remaining to be attributed:
1351 curr_old_amt := old_remaining;
1353 -- Can't attribute more than was allocated from the fund:
1355 IF curr_old_amt > allocated_amt THEN
1356 curr_old_amt := allocated_amt;
1359 -- Can't attribute more than the amount of the current credit:
1361 IF curr_old_amt > source.converted_amt THEN
1362 curr_old_amt := source.converted_amt;
1365 curr_old_amt := trunc( curr_old_amt, 2 );
1367 old_remaining := old_remaining - curr_old_amt;
1369 -- Determine the amount to be deducted, if any,
1370 -- from the old allocation.
1372 IF old_remaining > 0 THEN
1374 -- In this case we're using the whole allocation, so use that
1375 -- amount directly instead of applying a currency translation
1376 -- and thereby inviting round-off errors.
1378 source_deduction := - orig_allocated_amt;
1380 source_deduction := trunc(
1381 ( - curr_old_amt ) *
1382 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1386 IF source_deduction <> 0 THEN
1388 -- Insert negative allocation for old fund in fund_allocation,
1389 -- converted into the currency of the funding source
1391 INSERT INTO acq.fund_allocation (
1398 source.funding_source,
1402 'Transfer to fund ' || new_fund
1406 IF new_fund IS NOT NULL THEN
1408 -- Determine how much to add to the new fund, in
1409 -- its currency, and how much remains to be added:
1411 IF same_currency THEN
1412 curr_new_amt := curr_old_amt;
1414 IF old_remaining = 0 THEN
1416 -- This is the last iteration, so nothing should be left
1418 curr_new_amt := new_remaining;
1421 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1422 new_remaining := new_remaining - curr_new_amt;
1426 -- Determine how much to add, if any,
1427 -- to the new fund's allocation.
1429 IF old_remaining > 0 THEN
1431 -- In this case we're using the whole allocation, so use that amount
1432 -- amount directly instead of applying a currency translation and
1433 -- thereby inviting round-off errors.
1435 source_addition := orig_allocated_amt;
1436 ELSIF source.currency_type = old_fund_currency THEN
1438 -- In this case we don't need a round trip currency translation,
1439 -- thereby inviting round-off errors:
1441 source_addition := curr_old_amt;
1443 source_addition := trunc(
1445 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1449 IF source_addition <> 0 THEN
1451 -- Insert positive allocation for new fund in fund_allocation,
1452 -- converted to the currency of the founding source
1454 INSERT INTO acq.fund_allocation (
1461 source.funding_source,
1465 'Transfer from fund ' || old_fund
1470 IF trunc( curr_old_amt, 2 ) <> 0
1471 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1473 -- Insert row in fund_transfer, using amounts in the currency of the funds
1475 INSERT INTO acq.fund_transfer (
1482 funding_source_credit
1485 trunc( curr_old_amt, 2 ),
1487 trunc( curr_new_amt, 2 ),
1494 if old_remaining <= 0 THEN
1495 EXIT; -- Nothing more to be transferred
1499 $$ LANGUAGE plpgsql;
1501 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1503 Function to attribute expenditures and encumbrances to funding source credits,
1504 and thereby to funding sources.
1506 Read the debits in chonological order, attributing each one to one or
1507 more funding source credits. Constraints:
1509 1. Don't attribute more to a credit than the amount of the credit.
1511 2. For a given fund, don't attribute more to a funding source than the
1512 source has allocated to that fund.
1514 3. Attribute debits to credits with deadlines before attributing them to
1515 credits without deadlines. Otherwise attribute to the earliest credits
1516 first, based on the deadline date when present, or on the effective date
1517 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1518 This ordering is defined by an ORDER BY clause on the view
1519 acq.ordered_funding_source_credit.
1521 Start by truncating the table acq.debit_attribution. Then insert a row
1522 into that table for each attribution. If a debit cannot be fully
1523 attributed, insert a row for the unattributable balance, with the
1524 funding_source_credit and credit_amount columns NULL.
1527 curr_fund_source_bal RECORD;
1528 seqno INT; -- sequence num for credits applicable to a fund
1529 fund_credit RECORD; -- current row in temp t_fund_credit table
1530 fc RECORD; -- used for loading t_fund_credit table
1531 sc RECORD; -- used for loading t_fund_credit table
1533 -- Used exclusively in the main loop:
1535 deb RECORD; -- current row from acq.fund_debit table
1536 curr_credit_bal RECORD; -- current row from temp t_credit table
1537 debit_balance NUMERIC; -- amount left to attribute for current debit
1538 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1539 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1540 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1541 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1542 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1543 attrib_count INT; -- populates id of acq.debit_attribution
1546 -- Load a temporary table. For each combination of fund and funding source,
1547 -- load an entry with the total amount allocated to that fund by that source.
1548 -- This sum may reflect transfers as well as original allocations. We will
1549 -- reduce this balance whenever we attribute debits to it.
1551 CREATE TEMP TABLE t_fund_source_bal
1555 funding_source AS source,
1556 sum( amount ) AS balance
1565 CREATE INDEX t_fund_source_bal_idx
1566 ON t_fund_source_bal( fund, source );
1567 -------------------------------------------------------------------------------
1569 -- Load another temporary table. For each fund, load zero or more
1570 -- funding source credits from which that fund can get money.
1572 CREATE TEMP TABLE t_fund_credit (
1579 SELECT DISTINCT fund
1580 FROM acq.fund_allocation
1582 LOOP -- Loop over the funds
1588 acq.ordered_funding_source_credit AS ofsc
1590 ofsc.funding_source IN
1592 SELECT funding_source
1593 FROM acq.fund_allocation
1594 WHERE fund = fc.fund
1600 LOOP -- Add each credit to the list
1601 INSERT INTO t_fund_credit (
1610 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1612 END LOOP; -- Loop over credits for a given fund
1613 END LOOP; -- Loop over funds
1615 CREATE INDEX t_fund_credit_idx
1616 ON t_fund_credit( fund, seq );
1617 -------------------------------------------------------------------------------
1619 -- Load yet another temporary table. This one is a list of funding source
1620 -- credits, with their balances. We shall reduce those balances as we
1621 -- attribute debits to them.
1623 CREATE TEMP TABLE t_credit
1627 fsc.funding_source AS source,
1628 fsc.amount AS balance,
1629 fs.currency_type AS currency_type
1631 acq.funding_source_credit AS fsc,
1632 acq.funding_source fs
1634 fsc.funding_source = fs.id
1637 CREATE INDEX t_credit_idx
1638 ON t_credit( credit );
1640 -------------------------------------------------------------------------------
1642 -- Now that we have loaded the lookup tables: loop through the debits,
1643 -- attributing each one to one or more funding source credits.
1645 truncate table acq.debit_attribution;
1663 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1665 debit_balance := deb.amount;
1667 -- Loop over the funding source credits that are eligible
1668 -- to pay for this debit
1680 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1682 -- Look up the balance for this credit. If it's zero, then
1683 -- it's not useful, so treat it as if you didn't find it.
1684 -- (Actually there shouldn't be any zero balances in the table,
1685 -- but we check just to make sure.)
1688 INTO curr_credit_bal
1691 credit = fund_credit.credit
1694 IF curr_credit_bal IS NULL THEN
1696 -- This credit is exhausted; try the next one.
1702 -- At this point we have an applicable credit with some money left.
1703 -- Now see if the relevant funding_source has any money left.
1705 -- Look up the balance of the allocation for this combination of
1706 -- fund and source. If you find such an entry, but it has a zero
1707 -- balance, then it's not useful, so treat it as unfound.
1708 -- (Actually there shouldn't be any zero balances in the table,
1709 -- but we check just to make sure.)
1712 INTO curr_fund_source_bal
1713 FROM t_fund_source_bal
1716 AND source = curr_credit_bal.source
1719 IF curr_fund_source_bal IS NULL THEN
1721 -- This fund/source doesn't exist or is already exhausted,
1722 -- so we can't use this credit. Go on to the next one.
1727 -- Convert the available balances to the currency of the fund
1729 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1730 curr_credit_bal.currency_type, deb.currency_type );
1731 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1732 curr_credit_bal.currency_type, deb.currency_type );
1734 -- Determine how much we can attribute to this credit: the minimum
1735 -- of the debit amount, the fund/source balance, and the
1738 --RAISE NOTICE ' deb bal %', debit_balance;
1739 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1740 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1742 conv_attr_amount := NULL;
1743 attr_amount := debit_balance;
1745 IF attr_amount > conv_alloc_balance THEN
1746 attr_amount := conv_alloc_balance;
1747 conv_attr_amount := curr_fund_source_bal.balance;
1749 IF attr_amount > conv_cred_balance THEN
1750 attr_amount := conv_cred_balance;
1751 conv_attr_amount := curr_credit_bal.balance;
1754 -- If we're attributing all of one of the balances, then that's how
1755 -- much we will deduct from the balances, and we already captured
1756 -- that amount above. Otherwise we must convert the amount of the
1757 -- attribution from the currency of the fund back to the currency of
1758 -- the funding source.
1760 IF conv_attr_amount IS NULL THEN
1761 conv_attr_amount := attr_amount * acq.exchange_ratio(
1762 deb.currency_type, curr_credit_bal.currency_type );
1765 -- Insert a row to record the attribution
1767 attrib_count := attrib_count + 1;
1768 INSERT INTO acq.debit_attribution (
1772 funding_source_credit,
1778 curr_credit_bal.credit,
1782 -- Subtract the attributed amount from the various balances
1784 debit_balance := debit_balance - attr_amount;
1785 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1787 IF curr_fund_source_bal.balance <= 0 THEN
1789 -- This allocation is exhausted. Delete it so
1790 -- that we don't waste time looking at it again.
1792 DELETE FROM t_fund_source_bal
1794 fund = curr_fund_source_bal.fund
1795 AND source = curr_fund_source_bal.source;
1797 UPDATE t_fund_source_bal
1798 SET balance = balance - conv_attr_amount
1800 fund = curr_fund_source_bal.fund
1801 AND source = curr_fund_source_bal.source;
1804 IF curr_credit_bal.balance <= 0 THEN
1806 -- This funding source credit is exhausted. Delete it
1807 -- so that we don't waste time looking at it again.
1809 --DELETE FROM t_credit
1811 -- credit = curr_credit_bal.credit;
1813 DELETE FROM t_fund_credit
1815 credit = curr_credit_bal.credit;
1818 SET balance = curr_credit_bal.balance
1820 credit = curr_credit_bal.credit;
1823 -- Are we done with this debit yet?
1825 IF debit_balance <= 0 THEN
1826 EXIT; -- We've fully attributed this debit; stop looking at credits.
1828 END LOOP; -- End loop over credits
1830 IF debit_balance <> 0 THEN
1832 -- We weren't able to attribute this debit, or at least not
1833 -- all of it. Insert a row for the unattributed balance.
1835 attrib_count := attrib_count + 1;
1836 INSERT INTO acq.debit_attribution (
1840 funding_source_credit,
1850 END LOOP; -- End of loop over debits
1852 $$ LANGUAGE 'plpgsql';
1854 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit(
1858 ) RETURNS VOID AS $$
1869 IF old_year IS NULL THEN
1870 RAISE EXCEPTION 'Input year argument is NULL';
1871 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1872 RAISE EXCEPTION 'Input year is out of range';
1875 IF user_id IS NULL THEN
1876 RAISE EXCEPTION 'Input user id argument is NULL';
1879 IF org_unit_id IS NULL THEN
1880 RAISE EXCEPTION 'Org unit id argument is NULL';
1882 SELECT TRUE INTO org_found
1884 WHERE id = org_unit_id;
1886 IF org_found IS NULL THEN
1887 RAISE EXCEPTION 'Org unit id is invalid';
1891 -- Loop over the applicable funds
1893 FOR old_fund in SELECT * FROM acq.fund
1897 AND org = org_unit_id
1900 INSERT INTO acq.fund (
1908 balance_warning_percent,
1909 balance_stop_percent
1914 old_fund.currency_type,
1918 old_fund.balance_warning_percent,
1919 old_fund.balance_stop_percent
1921 RETURNING id INTO new_id;
1923 WHEN unique_violation THEN
1924 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
1927 --RAISE NOTICE 'Propagating fund % to fund %',
1928 -- old_fund.code, new_id;
1931 $$ LANGUAGE plpgsql;
1933 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1937 ) RETURNS VOID AS $$
1948 IF old_year IS NULL THEN
1949 RAISE EXCEPTION 'Input year argument is NULL';
1950 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1951 RAISE EXCEPTION 'Input year is out of range';
1954 IF user_id IS NULL THEN
1955 RAISE EXCEPTION 'Input user id argument is NULL';
1958 IF org_unit_id IS NULL THEN
1959 RAISE EXCEPTION 'Org unit id argument is NULL';
1961 SELECT TRUE INTO org_found
1963 WHERE id = org_unit_id;
1965 IF org_found IS NULL THEN
1966 RAISE EXCEPTION 'Org unit id is invalid';
1970 -- Loop over the applicable funds
1972 FOR old_fund in SELECT * FROM acq.fund
1977 SELECT id FROM actor.org_unit_descendants( org_unit_id )
1981 INSERT INTO acq.fund (
1989 balance_warning_percent,
1990 balance_stop_percent
1995 old_fund.currency_type,
1999 old_fund.balance_warning_percent,
2000 old_fund.balance_stop_percent
2002 RETURNING id INTO new_id;
2004 WHEN unique_violation THEN
2005 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2008 --RAISE NOTICE 'Propagating fund % to fund %',
2009 -- old_fund.code, new_id;
2012 $$ LANGUAGE plpgsql;
2014 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit(
2018 ) RETURNS VOID AS $$
2022 new_year INT := old_year + 1;
2024 xfer_amount NUMERIC;
2033 IF old_year IS NULL THEN
2034 RAISE EXCEPTION 'Input year argument is NULL';
2035 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2036 RAISE EXCEPTION 'Input year is out of range';
2039 IF user_id IS NULL THEN
2040 RAISE EXCEPTION 'Input user id argument is NULL';
2043 IF org_unit_id IS NULL THEN
2044 RAISE EXCEPTION 'Org unit id argument is NULL';
2047 -- Validate the org unit
2052 WHERE id = org_unit_id;
2054 IF org_found IS NULL THEN
2055 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2059 -- Loop over the propagable funds to identify the details
2060 -- from the old fund plus the id of the new one, if it exists.
2064 oldf.id AS old_fund,
2070 newf.id AS new_fund_id
2073 LEFT JOIN acq.fund AS newf
2074 ON ( oldf.code = newf.code )
2076 oldf.org = org_unit_id
2077 and oldf.year = old_year
2079 and newf.year = new_year
2081 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2083 IF roll_fund.new_fund_id IS NULL THEN
2085 -- The old fund hasn't been propagated yet. Propagate it now.
2087 INSERT INTO acq.fund (
2095 balance_warning_percent,
2096 balance_stop_percent
2101 roll_fund.currency_type,
2105 roll_fund.balance_warning_percent,
2106 roll_fund.balance_stop_percent
2108 RETURNING id INTO new_fund;
2110 new_fund = roll_fund.new_fund_id;
2113 -- Determine the amount to transfer
2117 FROM acq.fund_spent_balance
2118 WHERE fund = roll_fund.old_fund;
2120 IF xfer_amount <> 0 THEN
2121 IF roll_fund.rollover THEN
2123 -- Transfer balance from old fund to new
2125 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2127 PERFORM acq.transfer_fund(
2137 -- Transfer balance from old fund to the void
2139 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2141 PERFORM acq.transfer_fund(
2152 IF roll_fund.rollover THEN
2154 -- Move any lineitems from the old fund to the new one
2155 -- where the associated debit is an encumbrance.
2157 -- Any other tables tying expenditure details to funds should
2158 -- receive similar treatment. At this writing there are none.
2160 UPDATE acq.lineitem_detail
2163 fund = roll_fund.old_fund -- this condition may be redundant
2169 fund = roll_fund.old_fund
2173 -- Move encumbrance debits from the old fund to the new fund
2175 UPDATE acq.fund_debit
2178 fund = roll_fund.old_fund
2182 -- Mark old fund as inactive, now that we've closed it
2186 WHERE id = roll_fund.old_fund;
2189 $$ LANGUAGE plpgsql;
2191 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2195 ) RETURNS VOID AS $$
2199 new_year INT := old_year + 1;
2201 xfer_amount NUMERIC;
2210 IF old_year IS NULL THEN
2211 RAISE EXCEPTION 'Input year argument is NULL';
2212 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2213 RAISE EXCEPTION 'Input year is out of range';
2216 IF user_id IS NULL THEN
2217 RAISE EXCEPTION 'Input user id argument is NULL';
2220 IF org_unit_id IS NULL THEN
2221 RAISE EXCEPTION 'Org unit id argument is NULL';
2224 -- Validate the org unit
2229 WHERE id = org_unit_id;
2231 IF org_found IS NULL THEN
2232 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2236 -- Loop over the propagable funds to identify the details
2237 -- from the old fund plus the id of the new one, if it exists.
2241 oldf.id AS old_fund,
2247 newf.id AS new_fund_id
2250 LEFT JOIN acq.fund AS newf
2251 ON ( oldf.code = newf.code )
2253 oldf.year = old_year
2255 AND newf.year = new_year
2257 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2260 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2262 IF roll_fund.new_fund_id IS NULL THEN
2264 -- The old fund hasn't been propagated yet. Propagate it now.
2266 INSERT INTO acq.fund (
2274 balance_warning_percent,
2275 balance_stop_percent
2280 roll_fund.currency_type,
2284 roll_fund.balance_warning_percent,
2285 roll_fund.balance_stop_percent
2287 RETURNING id INTO new_fund;
2289 new_fund = roll_fund.new_fund_id;
2292 -- Determine the amount to transfer
2296 FROM acq.fund_spent_balance
2297 WHERE fund = roll_fund.old_fund;
2299 IF xfer_amount <> 0 THEN
2300 IF roll_fund.rollover THEN
2302 -- Transfer balance from old fund to new
2304 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2306 PERFORM acq.transfer_fund(
2316 -- Transfer balance from old fund to the void
2318 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2320 PERFORM acq.transfer_fund(
2331 IF roll_fund.rollover THEN
2333 -- Move any lineitems from the old fund to the new one
2334 -- where the associated debit is an encumbrance.
2336 -- Any other tables tying expenditure details to funds should
2337 -- receive similar treatment. At this writing there are none.
2339 UPDATE acq.lineitem_detail
2342 fund = roll_fund.old_fund -- this condition may be redundant
2348 fund = roll_fund.old_fund
2352 -- Move encumbrance debits from the old fund to the new fund
2354 UPDATE acq.fund_debit
2357 fund = roll_fund.old_fund
2361 -- Mark old fund as inactive, now that we've closed it
2365 WHERE id = roll_fund.old_fund;
2368 $$ LANGUAGE plpgsql;
2370 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2371 SELECT funding_source,
2372 SUM(amount) AS amount
2373 FROM acq.funding_source_credit
2376 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2377 SELECT funding_source,
2378 SUM(a.amount)::NUMERIC(100,2) AS amount
2379 FROM acq.fund_allocation a
2382 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2383 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2384 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2385 FROM acq.funding_source_credit_total c
2386 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2389 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2391 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2392 FROM acq.fund_allocation a
2393 JOIN acq.fund f ON (a.fund = f.id)
2394 JOIN acq.funding_source s ON (a.funding_source = s.id)
2397 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2398 SELECT fund.id AS fund,
2399 fund_debit.encumbrance AS encumbrance,
2400 SUM( COALESCE( fund_debit.amount, 0 ) ) AS amount
2401 FROM acq.fund AS fund
2402 LEFT JOIN acq.fund_debit AS fund_debit
2403 ON ( fund.id = fund_debit.fund )
2406 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2408 SUM(amount) AS amount
2409 FROM acq.fund_debit_total
2410 WHERE encumbrance IS TRUE
2413 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2415 SUM(amount) AS amount
2416 FROM acq.fund_debit_total
2417 WHERE encumbrance IS FALSE
2420 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2422 c.amount - COALESCE(d.amount,0.0) AS amount
2423 FROM acq.fund_allocation_total c
2424 LEFT JOIN acq.fund_debit_total d USING (fund);
2426 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2428 c.amount - COALESCE(d.amount,0.0) AS amount
2429 FROM acq.fund_allocation_total c
2430 LEFT JOIN acq.fund_spent_total d USING (fund);
2432 -- For each fund: the total allocation from all sources, in the
2433 -- currency of the fund (or 0 if there are no allocations)
2435 CREATE VIEW acq.all_fund_allocation_total AS
2438 COALESCE( SUM( a.amount * acq.exchange_ratio(
2439 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2443 LEFT JOIN acq.fund_allocation a
2445 LEFT JOIN acq.funding_source s
2446 ON a.funding_source = s.id
2450 -- For every fund: the total encumbrances (or 0 if none),
2451 -- in the currency of the fund.
2453 CREATE VIEW acq.all_fund_encumbrance_total AS
2456 COALESCE( encumb.amount, 0 ) AS amount
2462 sum( amount ) AS amount
2469 ON f.id = encumb.fund;
2471 -- For every fund: the total spent (or 0 if none),
2472 -- in the currency of the fund.
2474 CREATE VIEW acq.all_fund_spent_total AS
2477 COALESCE( spent.amount, 0 ) AS amount
2483 sum( amount ) AS amount
2490 ON f.id = spent.fund;
2492 -- For each fund: the amount not yet spent, in the currency
2493 -- of the fund. May include encumbrances.
2495 CREATE VIEW acq.all_fund_spent_balance AS
2498 c.amount - d.amount AS amount
2499 FROM acq.all_fund_allocation_total c
2500 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2502 -- For each fund: the amount neither spent nor encumbered,
2503 -- in the currency of the fund
2505 CREATE VIEW acq.all_fund_combined_balance AS
2508 a.amount - COALESCE( c.amount, 0 ) AS amount
2510 acq.all_fund_allocation_total a
2514 SUM( amount ) AS amount
2519 ) AS c USING ( fund );
2521 CREATE TABLE acq.claim_type (
2522 id SERIAL PRIMARY KEY,
2523 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2524 DEFERRABLE INITIALLY DEFERRED,
2526 description TEXT NOT NULL,
2527 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2530 CREATE TABLE acq.claim (
2531 id SERIAL PRIMARY KEY,
2532 type INT NOT NULL REFERENCES acq.claim_type
2533 DEFERRABLE INITIALLY DEFERRED,
2534 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2535 DEFERRABLE INITIALLY DEFERRED
2538 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2540 CREATE TABLE acq.claim_event (
2541 id BIGSERIAL PRIMARY KEY,
2542 type INT NOT NULL REFERENCES acq.claim_event_type
2543 DEFERRABLE INITIALLY DEFERRED,
2544 claim SERIAL NOT NULL REFERENCES acq.claim
2545 DEFERRABLE INITIALLY DEFERRED,
2546 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2547 creator INT NOT NULL REFERENCES actor.usr
2548 DEFERRABLE INITIALLY DEFERRED,
2552 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );