2 * Copyright (C) 2009 Georgia Public Library Service
3 * Scott McKellar <scott@esilibrary.com>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 DROP SCHEMA IF EXISTS acq CASCADE;
26 CREATE TABLE acq.currency_type (
27 code TEXT PRIMARY KEY,
31 -- Use the ISO 4217 abbreviations for currency codes
32 INSERT INTO acq.currency_type (code, label) VALUES ('USD','US Dollars');
33 INSERT INTO acq.currency_type (code, label) VALUES ('CAN','Canadian Dollars');
34 INSERT INTO acq.currency_type (code, label) VALUES ('EUR','Euros');
36 CREATE TABLE acq.exchange_rate (
37 id SERIAL PRIMARY KEY,
38 from_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
39 to_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
40 ratio NUMERIC NOT NULL,
41 CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
44 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','CAN',1.2);
45 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','EUR',0.5);
47 CREATE TABLE acq.claim_policy (
48 id SERIAL PRIMARY KEY,
49 org_unit INT NOT NULL REFERENCES actor.org_unit
50 DEFERRABLE INITIALLY DEFERRED,
52 description TEXT NOT NULL,
53 CONSTRAINT name_once_per_org UNIQUE (org_unit, name)
56 CREATE TABLE acq.claim_event_type (
57 id SERIAL PRIMARY KEY,
58 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
59 DEFERRABLE INITIALLY DEFERRED,
61 description TEXT NOT NULL,
62 library_initiated BOOL NOT NULL DEFAULT FALSE,
63 CONSTRAINT event_type_once_per_org UNIQUE ( org_unit, code )
66 CREATE TABLE acq.claim_policy_action (
67 id SERIAL PRIMARY KEY,
68 claim_policy INT NOT NULL REFERENCES acq.claim_policy
70 DEFERRABLE INITIALLY DEFERRED,
71 action_interval INTERVAL NOT NULL,
72 action INT NOT NULL REFERENCES acq.claim_event_type
73 DEFERRABLE INITIALLY DEFERRED,
74 CONSTRAINT action_sequence UNIQUE (claim_policy, action_interval)
77 CREATE TABLE acq.provider (
78 id SERIAL PRIMARY KEY,
80 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
81 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
85 edi_default INT, -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
86 active BOOL NOT NULL DEFAULT TRUE,
87 prepayment_required BOOL NOT NULL DEFAULT FALSE,
92 default_claim_policy INT REFERENCES acq.claim_policy
93 DEFERRABLE INITIALLY DEFERRED,
94 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
95 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
98 CREATE TABLE acq.provider_holding_subfield_map (
99 id SERIAL PRIMARY KEY,
100 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
101 name TEXT NOT NULL, -- barcode, price, etc
102 subfield TEXT NOT NULL,
103 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
106 CREATE TABLE acq.provider_address (
107 id SERIAL PRIMARY KEY,
108 valid BOOL NOT NULL DEFAULT TRUE,
110 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
111 street1 TEXT NOT NULL,
116 country TEXT NOT NULL,
117 post_code TEXT NOT NULL,
121 CREATE TABLE acq.provider_contact (
122 id SERIAL PRIMARY KEY,
123 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
125 role TEXT, -- free-form.. e.g. "our sales guy"
130 CREATE TABLE acq.provider_contact_address (
131 id SERIAL PRIMARY KEY,
132 valid BOOL NOT NULL DEFAULT TRUE,
134 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
135 street1 TEXT NOT NULL,
140 country TEXT NOT NULL,
141 post_code TEXT NOT NULL,
145 CREATE TABLE acq.provider_note (
146 id SERIAL PRIMARY KEY,
147 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
148 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
149 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
150 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
151 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
154 CREATE INDEX acq_pro_note_pro_idx ON acq.provider_note ( provider );
155 CREATE INDEX acq_pro_note_creator_idx ON acq.provider_note ( creator );
156 CREATE INDEX acq_pro_note_editor_idx ON acq.provider_note ( editor );
159 CREATE TABLE acq.funding_source (
160 id SERIAL PRIMARY KEY,
162 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
163 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
165 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
168 CREATE TABLE acq.funding_source_credit (
169 id SERIAL PRIMARY KEY,
170 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
171 amount NUMERIC NOT NULL,
173 deadline_date TIMESTAMPTZ,
174 effective_date TIMESTAMPTZ NOT NULL default now()
177 CREATE VIEW acq.ordered_funding_source_credit AS
179 CASE WHEN deadline_date IS NULL THEN
183 END AS sort_priority,
184 CASE WHEN deadline_date IS NULL THEN
194 acq.funding_source_credit;
196 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
197 The acq.ordered_funding_source_credit view is a prioritized
198 ordering of funding source credits. When ordered by the first
199 three columns, this view defines the order in which the various
200 credits are to be tapped for spending, subject to the allocations
201 in the acq.fund_allocation table.
203 The first column reflects the principle that we should spend
204 money with deadlines before spending money without deadlines.
206 The second column reflects the principle that we should spend the
207 oldest money first. For money with deadlines, that means that we
208 spend first from the credit with the earliest deadline. For
209 money without deadlines, we spend first from the credit with the
210 earliest effective date.
212 The third column is a tie breaker to ensure a consistent
216 CREATE TABLE acq.fund (
217 id SERIAL PRIMARY KEY,
218 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
220 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
221 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
223 rollover BOOL NOT NULL DEFAULT FALSE,
224 propagate BOOL NOT NULL DEFAULT TRUE,
225 active BOOL NOT NULL DEFAULT TRUE,
226 balance_warning_percent INT,
227 balance_stop_percent INT,
228 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
229 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
230 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
233 CREATE TABLE acq.fund_debit (
234 id SERIAL PRIMARY KEY,
235 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
236 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
237 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
238 amount NUMERIC NOT NULL,
239 encumbrance BOOL NOT NULL DEFAULT TRUE,
240 debit_type TEXT NOT NULL,
241 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
242 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
245 CREATE TABLE acq.fund_allocation (
246 id SERIAL PRIMARY KEY,
247 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
248 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
249 amount NUMERIC NOT NULL,
250 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
252 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
254 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
256 CREATE TABLE acq.fund_allocation_percent
258 id SERIAL PRIMARY KEY,
259 funding_source INT NOT NULL REFERENCES acq.funding_source
260 DEFERRABLE INITIALLY DEFERRED,
261 org INT NOT NULL REFERENCES actor.org_unit
262 DEFERRABLE INITIALLY DEFERRED,
264 percent NUMERIC NOT NULL,
265 allocator INTEGER NOT NULL REFERENCES actor.usr
266 DEFERRABLE INITIALLY DEFERRED,
268 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
269 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
270 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
273 -- Trigger function to validate combination of org_unit and fund_code
275 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
276 RETURNS TRIGGER AS $$
291 AND code = NEW.fund_code
297 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
302 CREATE TRIGGER acq_fund_alloc_percent_val_trig
303 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
304 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
306 -- To do: trigger to verify that percentages don't add up to more than 100
308 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
309 RETURNS TRIGGER AS $$
312 total_percent numeric;
320 acq.fund_allocation_percent AS fap
322 fap.funding_source = NEW.funding_source;
324 IF total_percent > 100 THEN
325 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
333 CREATE TRIGGER acqfap_limit_100_trig
334 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
335 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
337 CREATE TABLE acq.picklist (
338 id SERIAL PRIMARY KEY,
339 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
340 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
341 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
342 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
344 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
345 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
346 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
348 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
349 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
350 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
352 CREATE TABLE acq.cancel_reason (
353 id SERIAL PRIMARY KEY,
354 org_unit INTEGER NOT NULL REFERENCES actor.org_unit( id )
355 DEFERRABLE INITIALLY DEFERRED,
357 description TEXT NOT NULL,
358 keep_debits BOOL NOT NULL DEFAULT FALSE,
359 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
362 -- Reserve ids 1-999 for stock reasons
363 -- Reserve ids 1000-1999 for EDI reasons
364 -- 2000+ are available for staff to create
366 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
368 CREATE TABLE acq.purchase_order (
369 id SERIAL PRIMARY KEY,
370 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
371 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
372 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
373 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
374 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
375 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
376 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
377 state TEXT NOT NULL DEFAULT 'new',
378 order_date TIMESTAMP WITH TIME ZONE,
380 cancel_reason INT REFERENCES acq.cancel_reason( id )
381 DEFERRABLE INITIALLY DEFERRED,
382 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE
384 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
385 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
386 CREATE INDEX po_state_idx ON acq.purchase_order (state);
387 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
388 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
389 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
391 -- The name should default to the id, as text. We can't reference a column
392 -- in a DEFAULT clause, so we use a trigger:
394 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
397 IF NEW.name IS NULL THEN
398 NEW.name := NEW.id::TEXT;
405 CREATE TRIGGER po_name_default_trg
406 BEFORE INSERT OR UPDATE ON acq.purchase_order
407 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
409 -- The order name should be unique for a given ordering agency on a given order date
410 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
411 -- this rule requires a check constraint with a subquery. However you can't have a
412 -- subquery in a CHECK constraint, so we fake it with a trigger.
414 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
420 -- If order_date is not null, then make sure we don't have a collision
421 -- on order_date (truncated to day), org, and name
423 IF NEW.order_date IS NULL THEN
427 -- In the WHERE clause, we compare the order_dates without regard to time of day.
428 -- We use a pair of inequalities instead of comparing truncated dates so that the
429 -- query can do an indexed range scan.
431 SELECT 1 INTO collision
432 FROM acq.purchase_order
434 ordering_agency = NEW.ordering_agency
436 AND order_date >= date_trunc( 'day', NEW.order_date )
437 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
440 IF collision IS NULL THEN
441 -- okay, no collision
444 -- collision; nip it in the bud
445 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
446 NEW.ordering_agency, NEW.order_date, NEW.name;
451 CREATE TRIGGER po_org_name_date_unique_trg
452 BEFORE INSERT OR UPDATE ON acq.purchase_order
453 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
455 CREATE TABLE acq.po_note (
456 id SERIAL PRIMARY KEY,
457 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
458 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
459 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
460 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
461 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
463 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
465 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
466 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
467 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
469 CREATE TABLE acq.lineitem (
470 id BIGSERIAL PRIMARY KEY,
471 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
472 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
473 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
474 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
475 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
476 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
477 expected_recv_time TIMESTAMP WITH TIME ZONE,
478 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
479 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
481 eg_bib_id BIGINT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
483 state TEXT NOT NULL DEFAULT 'new',
484 cancel_reason INT REFERENCES acq.cancel_reason( id )
485 DEFERRABLE INITIALLY DEFERRED,
486 estimated_unit_price NUMERIC,
487 claim_policy INT REFERENCES acq.claim_policy
488 DEFERRABLE INITIALLY DEFERRED,
489 queued_record BIGINT REFERENCES vandelay.queued_bib_record (id)
490 ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
491 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
493 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
494 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
495 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
496 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
497 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
499 CREATE TABLE acq.lineitem_alert_text (
500 id SERIAL PRIMARY KEY,
503 owning_lib INT NOT NULL
504 REFERENCES actor.org_unit(id)
505 DEFERRABLE INITIALLY DEFERRED,
506 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
509 CREATE TABLE acq.lineitem_note (
510 id SERIAL PRIMARY KEY,
511 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
512 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
513 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
514 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
515 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
517 alert_text INT REFERENCES acq.lineitem_alert_text(id)
518 DEFERRABLE INITIALLY DEFERRED,
519 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
521 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
522 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
523 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
525 CREATE TABLE acq.lineitem_detail (
526 id BIGSERIAL PRIMARY KEY,
527 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
528 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
529 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
530 eg_copy_id BIGINT, -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
534 collection_code TEXT,
535 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
536 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
537 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
538 recv_time TIMESTAMP WITH TIME ZONE,
539 receiver INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
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, remove ) VALUES ('upc', 'UPC', '//*[@tag="024" and @ind1="1"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
604 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
605 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
606 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
607 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
609 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
612 CREATE TABLE acq.distribution_formula (
613 id SERIAL PRIMARY KEY,
615 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
617 skip_count INT NOT NULL DEFAULT 0,
618 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
621 CREATE TABLE acq.distribution_formula_entry (
622 id SERIAL PRIMARY KEY,
623 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
625 DEFERRABLE INITIALLY DEFERRED,
626 position INTEGER NOT NULL,
627 item_count INTEGER NOT NULL,
628 owning_lib INTEGER REFERENCES actor.org_unit(id)
629 DEFERRABLE INITIALLY DEFERRED,
630 location INTEGER REFERENCES asset.copy_location(id),
631 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
632 CONSTRAINT acqdfe_must_be_somewhere
633 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
636 CREATE TABLE acq.distribution_formula_application (
637 id BIGSERIAL PRIMARY KEY,
638 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
639 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
641 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
642 lineitem INT NOT NULL
643 REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
646 CREATE INDEX acqdfa_df_idx
647 ON acq.distribution_formula_application(formula);
648 CREATE INDEX acqdfa_li_idx
649 ON acq.distribution_formula_application(lineitem);
650 CREATE INDEX acqdfa_creator_idx
651 ON acq.distribution_formula_application(creator);
653 CREATE TABLE acq.fund_tag (
654 id SERIAL PRIMARY KEY,
656 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
658 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
661 CREATE TABLE acq.fund_tag_map (
662 id SERIAL PRIMARY KEY,
663 fund INTEGER NOT NULL REFERENCES acq.fund(id)
664 DEFERRABLE INITIALLY DEFERRED,
665 tag INTEGER REFERENCES acq.fund_tag(id)
667 DEFERRABLE INITIALLY DEFERRED,
668 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
671 CREATE TABLE acq.fund_transfer (
672 id SERIAL PRIMARY KEY,
673 src_fund INT NOT NULL REFERENCES acq.fund( id )
674 DEFERRABLE INITIALLY DEFERRED,
675 src_amount NUMERIC NOT NULL,
676 dest_fund INT REFERENCES acq.fund( id )
677 DEFERRABLE INITIALLY DEFERRED,
679 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
680 transfer_user INT NOT NULL REFERENCES actor.usr( id )
681 DEFERRABLE INITIALLY DEFERRED,
683 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
684 DEFERRABLE INITIALLY DEFERRED
687 CREATE INDEX acqftr_usr_idx
688 ON acq.fund_transfer( transfer_user );
690 COMMENT ON TABLE acq.fund_transfer IS $$
692 Each row represents the transfer of money from a source fund
693 to a destination fund. There should be corresponding entries
694 in acq.fund_allocation. The purpose of acq.fund_transfer is
695 to record how much money moved from which fund to which other
698 The presence of two amount fields, rather than one, reflects
699 the possibility that the two funds are denominated in different
700 currencies. If they use the same currency type, the two
701 amounts should be the same.
704 CREATE TABLE acq.fiscal_calendar (
705 id SERIAL PRIMARY KEY,
709 -- Create a default calendar (though we don't specify its contents).
710 -- Create a foreign key in actor.org_unit, initially pointing to
711 -- the default calendar.
713 INSERT INTO acq.fiscal_calendar (
720 ALTER TABLE actor.org_unit ADD FOREIGN KEY
721 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
722 DEFERRABLE INITIALLY DEFERRED;
724 CREATE TABLE acq.fiscal_year (
725 id SERIAL PRIMARY KEY,
726 calendar INT NOT NULL
727 REFERENCES acq.fiscal_calendar
729 DEFERRABLE INITIALLY DEFERRED,
731 year_begin TIMESTAMPTZ NOT NULL,
732 year_end TIMESTAMPTZ NOT NULL,
733 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
734 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
737 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
738 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
739 in_dir TEXT, -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
742 ) INHERITS (config.remote_account);
744 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
745 ALTER TABLE acq.edi_account ADD PRIMARY KEY (id);
747 CREATE TABLE acq.edi_message (
748 id SERIAL PRIMARY KEY,
749 account INTEGER REFERENCES acq.edi_account(id)
750 DEFERRABLE INITIALLY DEFERRED,
752 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
753 translate_time TIMESTAMPTZ,
754 process_time TIMESTAMPTZ,
755 error_time TIMESTAMPTZ,
756 status TEXT NOT NULL DEFAULT 'new'
757 CONSTRAINT status_value CHECK
759 'new', -- needs to be translated
760 'translated', -- needs to be processed
761 'trans_error', -- error in translation step
762 'processed', -- needs to have remote_file deleted
763 'proc_error', -- error in processing step
764 'delete_error', -- error in deletion
765 'retry', -- need to retry
771 purchase_order INT REFERENCES acq.purchase_order
772 DEFERRABLE INITIALLY DEFERRED,
773 message_type TEXT NOT NULL CONSTRAINT valid_message_type CHECK
783 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
784 -- the table, assigning ids programmatically instead of using a sequence.
785 CREATE TABLE acq.debit_attribution (
786 id INT NOT NULL PRIMARY KEY,
787 fund_debit INT NOT NULL
788 REFERENCES acq.fund_debit
789 DEFERRABLE INITIALLY DEFERRED,
790 debit_amount NUMERIC NOT NULL,
791 funding_source_credit INT REFERENCES acq.funding_source_credit
792 DEFERRABLE INITIALLY DEFERRED,
793 credit_amount NUMERIC
796 CREATE INDEX acq_attribution_debit_idx
797 ON acq.debit_attribution( fund_debit );
799 CREATE INDEX acq_attribution_credit_idx
800 ON acq.debit_attribution( funding_source_credit );
804 CREATE TABLE acq.invoice_method (
805 code TEXT PRIMARY KEY,
806 name TEXT NOT NULL -- i18n-ize
809 CREATE TABLE acq.invoice_payment_method (
810 code TEXT PRIMARY KEY,
811 name TEXT NOT NULL -- i18n-ize
814 CREATE TABLE acq.invoice (
815 id SERIAL PRIMARY KEY,
816 receiver INT NOT NULL REFERENCES actor.org_unit (id),
817 provider INT NOT NULL REFERENCES acq.provider (id),
818 shipper INT NOT NULL REFERENCES acq.provider (id),
819 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
820 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
821 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
822 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
824 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
825 DEFERRABLE INITIALLY DEFERRED,
827 complete BOOL NOT NULL DEFAULT FALSE,
828 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
831 CREATE TABLE acq.invoice_entry (
832 id SERIAL PRIMARY KEY,
833 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
834 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
835 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
836 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
837 phys_item_count INT, -- and how many did staff count
839 billed_per_item BOOL,
840 cost_billed NUMERIC(8,2),
841 actual_cost NUMERIC(8,2),
842 amount_paid NUMERIC (8,2)
845 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
846 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
847 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
849 CREATE TABLE acq.invoice_item_type (
850 code TEXT PRIMARY KEY,
851 name TEXT NOT NULL, -- i18n-ize
852 prorate BOOL NOT NULL DEFAULT FALSE
855 CREATE TABLE acq.po_item (
856 id SERIAL PRIMARY KEY,
857 purchase_order INT REFERENCES acq.purchase_order (id)
858 ON UPDATE CASCADE ON DELETE SET NULL
859 DEFERRABLE INITIALLY DEFERRED,
860 fund_debit INT REFERENCES acq.fund_debit (id)
861 DEFERRABLE INITIALLY DEFERRED,
862 inv_item_type TEXT NOT NULL
863 REFERENCES acq.invoice_item_type (code)
864 DEFERRABLE INITIALLY DEFERRED,
868 estimated_cost NUMERIC(8,2),
869 fund INT REFERENCES acq.fund (id)
870 DEFERRABLE INITIALLY DEFERRED,
874 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
876 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
877 id SERIAL PRIMARY KEY,
878 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
879 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
880 fund_debit INT REFERENCES acq.fund_debit (id),
881 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
885 cost_billed NUMERIC(8,2),
886 actual_cost NUMERIC(8,2),
887 fund INT REFERENCES acq.fund (id)
888 DEFERRABLE INITIALLY DEFERRED,
889 amount_paid NUMERIC (8,2),
890 po_item INT REFERENCES acq.po_item (id)
891 DEFERRABLE INITIALLY DEFERRED,
895 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
896 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
897 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
900 CREATE TABLE acq.user_request_type (
901 id SERIAL PRIMARY KEY,
902 label TEXT NOT NULL UNIQUE -- i18n-ize
905 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
906 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
907 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
908 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
909 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
911 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
913 CREATE TABLE acq.user_request (
914 id SERIAL PRIMARY KEY,
915 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
916 hold BOOL NOT NULL DEFAULT TRUE,
918 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
919 holdable_formats TEXT, -- nullable, for use in hold creation
921 email_notify BOOL NOT NULL DEFAULT TRUE,
922 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
923 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
924 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
925 need_before TIMESTAMPTZ, -- don't create holds after this
928 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
940 cancel_reason INT REFERENCES acq.cancel_reason( id )
941 DEFERRABLE INITIALLY DEFERRED
947 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
948 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
951 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
954 SELECT COUNT(*) INTO counter
955 FROM oils_xpath_table(
959 '//*[@tag="' || tag || '"]',
961 ) as t(i int,c text);
963 FOR i IN 1 .. counter LOOP
966 FROM ( SELECT id,i,t,v
967 FROM oils_xpath_table(
971 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
972 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
974 ) as t(id int,t text,v text)
985 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
986 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
990 lida acq.flat_lineitem_detail%ROWTYPE;
992 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
993 IF NOT FOUND THEN RETURN; END IF;
995 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
996 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1003 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1004 JOIN acq.provider_holding_subfield_map a USING (subfield)
1005 WHERE a.provider = prov_i
1012 $$ LANGUAGE PLPGSQL;
1014 -- select * from acq.extract_provider_holding_data(699);
1016 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1017 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1021 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1022 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1025 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1026 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1030 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1033 Suggested vendor fields:
1041 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1050 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1052 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1054 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1055 IF (atype = 'lineitem_provider_attr_definition') THEN
1056 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1057 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1060 IF (atype = 'lineitem_provider_attr_definition') THEN
1061 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1062 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1063 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1064 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1065 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1068 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1070 IF (adef.code = 'title' OR adef.code = 'author') THEN
1071 -- title and author should not be split
1072 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1073 -- string-join in the xpath and remove this special case
1074 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1075 IF (value IS NOT NULL AND value <> '') THEN
1076 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1077 VALUES (NEW.id, adef.id, atype, adef.code, value);
1083 SELECT extract_acq_marc_field(id, xpath_string || '[' || pos || ']', adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1085 IF (value IS NOT NULL AND value <> '') THEN
1086 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1087 VALUES (NEW.id, adef.id, atype, adef.code, value);
1102 $function$ LANGUAGE PLPGSQL;
1104 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1106 IF TG_OP = 'UPDATE' THEN
1107 DELETE FROM acq.lineitem_attr
1108 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1111 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1115 $$ LANGUAGE PLPGSQL;
1117 CREATE TRIGGER cleanup_lineitem_trigger
1118 BEFORE UPDATE OR DELETE ON acq.lineitem
1119 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1121 CREATE TRIGGER ingest_lineitem_trigger
1122 AFTER INSERT OR UPDATE ON acq.lineitem
1123 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1125 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1129 IF from_ex = to_ex THEN
1133 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1138 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1147 $$ LANGUAGE PLPGSQL;
1149 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1150 SELECT $3 * acq.exchange_ratio($1, $2);
1153 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1155 Examine the acq.fiscal_year table, comparing successive years.
1156 Report any inconsistencies, i.e. years that overlap, have gaps
1157 between them, or are out of sequence.
1159 RETURNS SETOF RECORD AS $$
1183 ELSIF curr_year.calendar = prev_year.calendar THEN
1184 IF curr_year.year_begin > prev_year.year_end THEN
1185 -- This ugly kludge works around the fact that older
1186 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1187 FOR return_rec IN SELECT
1190 'Gap between fiscal years'::TEXT
1192 RETURN NEXT return_rec;
1194 ELSIF curr_year.year_begin < prev_year.year_end THEN
1195 FOR return_rec IN SELECT
1198 'Overlapping fiscal years'::TEXT
1200 RETURN NEXT return_rec;
1202 ELSIF curr_year.year < prev_year.year THEN
1203 FOR return_rec IN SELECT
1206 'Fiscal years out of order'::TEXT
1208 RETURN NEXT return_rec;
1213 prev_year := curr_year;
1218 $$ LANGUAGE plpgsql;
1220 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1222 old_amount IN NUMERIC, -- in currency of old fund
1224 new_amount IN NUMERIC, -- in currency of new fund
1226 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1227 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1228 ) RETURNS VOID AS $$
1229 /* -------------------------------------------------------------------------------
1231 Function to transfer money from one fund to another.
1233 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1234 negative amount for the old (losing) fund and a positive amount for the new
1235 (gaining) fund. In some cases there may be more than one such pair of entries
1236 in order to pull the money from different funding sources, or more specifically
1237 from different funding source credits. For each such pair there is also an
1238 entry in acq.fund_transfer.
1240 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1241 choose a funding source for the transferred money to come from. This choice
1242 must meet two constraints, so far as possible:
1244 1. The amount transferred from a given funding source must not exceed the
1245 amount allocated to the old fund by the funding source. To that end we
1246 compare the amount being transferred to the amount allocated.
1248 2. We shouldn't transfer money that has already been spent or encumbered, as
1249 defined by the funding attribution process. We attribute expenses to the
1250 oldest funding source credits first. In order to avoid transferring that
1251 attributed money, we reverse the priority, transferring from the newest funding
1252 source credits first. There can be no guarantee that this approach will
1253 avoid overcommitting a fund, but no other approach can do any better.
1255 In this context the age of a funding source credit is defined by the
1256 deadline_date for credits with deadline_dates, and by the effective_date for
1257 credits without deadline_dates, with the proviso that credits with deadline_dates
1258 are all considered "older" than those without.
1262 In the signature for this function, there is one last parameter commented out,
1263 named "funding_source_in". Correspondingly, the WHERE clause for the query
1264 driving the main loop has an OR clause commented out, which references the
1265 funding_source_in parameter.
1267 If these lines are uncommented, this function will allow the user optionally to
1268 restrict a fund transfer to a specified funding source. If the source
1269 parameter is left NULL, then there will be no such restriction.
1271 ------------------------------------------------------------------------------- */
1273 same_currency BOOLEAN;
1274 currency_ratio NUMERIC;
1275 old_fund_currency TEXT;
1276 old_remaining NUMERIC; -- in currency of old fund
1277 new_fund_currency TEXT;
1278 new_fund_active BOOLEAN;
1279 new_remaining NUMERIC; -- in currency of new fund
1280 curr_old_amt NUMERIC; -- in currency of old fund
1281 curr_new_amt NUMERIC; -- in currency of new fund
1282 source_addition NUMERIC; -- in currency of funding source
1283 source_deduction NUMERIC; -- in currency of funding source
1284 orig_allocated_amt NUMERIC; -- in currency of funding source
1285 allocated_amt NUMERIC; -- in currency of fund
1291 IF old_fund IS NULL THEN
1292 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1295 IF old_amount IS NULL THEN
1296 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1299 -- The new fund and its amount must be both NULL or both not NULL.
1301 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1302 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1305 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1306 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1309 IF user_id IS NULL THEN
1310 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1313 -- Initialize the amounts to be transferred, each denominated
1314 -- in the currency of its respective fund. They will be
1315 -- reduced on each iteration of the loop.
1317 old_remaining := old_amount;
1318 new_remaining := new_amount;
1320 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1321 -- old_amount, old_fund, new_amount, new_fund;
1323 -- Get the currency types of the old and new funds.
1334 IF old_fund_currency IS NULL THEN
1335 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1338 IF new_fund IS NOT NULL THEN
1350 IF new_fund_currency IS NULL THEN
1351 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1352 ELSIF NOT new_fund_active THEN
1354 -- No point in putting money into a fund from whence you can't spend it
1356 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1359 IF new_amount = old_amount THEN
1360 same_currency := true;
1361 currency_ratio := 1;
1364 -- We'll have to translate currency between funds. We presume that
1365 -- the calling code has already applied an appropriate exchange rate,
1366 -- so we'll apply the same conversion to each sub-transfer.
1368 same_currency := false;
1369 currency_ratio := new_amount / old_amount;
1373 -- Identify the funding source(s) from which we want to transfer the money.
1374 -- The principle is that we want to transfer the newest money first, because
1375 -- we spend the oldest money first. The priority for spending is defined
1376 -- by a sort of the view acq.ordered_funding_source_credit.
1381 ofsc.funding_source,
1383 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1387 acq.ordered_funding_source_credit AS ofsc,
1388 acq.funding_source fs
1390 ofsc.funding_source = fs.id
1391 and ofsc.funding_source IN
1393 SELECT funding_source
1394 FROM acq.fund_allocation
1395 WHERE fund = old_fund
1399 -- ofsc.funding_source = funding_source_in
1400 -- OR funding_source_in IS NULL
1403 ofsc.sort_priority desc,
1404 ofsc.sort_date desc,
1408 -- Determine how much money the old fund got from this funding source,
1409 -- denominated in the currency types of the source and of the fund.
1410 -- This result may reflect transfers from previous iterations.
1413 COALESCE( sum( amount ), 0 ),
1414 COALESCE( sum( amount )
1415 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1417 orig_allocated_amt, -- in currency of the source
1418 allocated_amt -- in currency of the old fund
1423 and funding_source = source.funding_source;
1425 -- Determine how much to transfer from this credit, in the currency
1426 -- of the fund. Begin with the amount remaining to be attributed:
1428 curr_old_amt := old_remaining;
1430 -- Can't attribute more than was allocated from the fund:
1432 IF curr_old_amt > allocated_amt THEN
1433 curr_old_amt := allocated_amt;
1436 -- Can't attribute more than the amount of the current credit:
1438 IF curr_old_amt > source.converted_amt THEN
1439 curr_old_amt := source.converted_amt;
1442 curr_old_amt := trunc( curr_old_amt, 2 );
1444 old_remaining := old_remaining - curr_old_amt;
1446 -- Determine the amount to be deducted, if any,
1447 -- from the old allocation.
1449 IF old_remaining > 0 THEN
1451 -- In this case we're using the whole allocation, so use that
1452 -- amount directly instead of applying a currency translation
1453 -- and thereby inviting round-off errors.
1455 source_deduction := - orig_allocated_amt;
1457 source_deduction := trunc(
1458 ( - curr_old_amt ) *
1459 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1463 IF source_deduction <> 0 THEN
1465 -- Insert negative allocation for old fund in fund_allocation,
1466 -- converted into the currency of the funding source
1468 INSERT INTO acq.fund_allocation (
1475 source.funding_source,
1479 'Transfer to fund ' || new_fund
1483 IF new_fund IS NOT NULL THEN
1485 -- Determine how much to add to the new fund, in
1486 -- its currency, and how much remains to be added:
1488 IF same_currency THEN
1489 curr_new_amt := curr_old_amt;
1491 IF old_remaining = 0 THEN
1493 -- This is the last iteration, so nothing should be left
1495 curr_new_amt := new_remaining;
1498 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1499 new_remaining := new_remaining - curr_new_amt;
1503 -- Determine how much to add, if any,
1504 -- to the new fund's allocation.
1506 IF old_remaining > 0 THEN
1508 -- In this case we're using the whole allocation, so use that amount
1509 -- amount directly instead of applying a currency translation and
1510 -- thereby inviting round-off errors.
1512 source_addition := orig_allocated_amt;
1513 ELSIF source.currency_type = old_fund_currency THEN
1515 -- In this case we don't need a round trip currency translation,
1516 -- thereby inviting round-off errors:
1518 source_addition := curr_old_amt;
1520 source_addition := trunc(
1522 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1526 IF source_addition <> 0 THEN
1528 -- Insert positive allocation for new fund in fund_allocation,
1529 -- converted to the currency of the founding source
1531 INSERT INTO acq.fund_allocation (
1538 source.funding_source,
1542 'Transfer from fund ' || old_fund
1547 IF trunc( curr_old_amt, 2 ) <> 0
1548 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1550 -- Insert row in fund_transfer, using amounts in the currency of the funds
1552 INSERT INTO acq.fund_transfer (
1559 funding_source_credit
1562 trunc( curr_old_amt, 2 ),
1564 trunc( curr_new_amt, 2 ),
1571 if old_remaining <= 0 THEN
1572 EXIT; -- Nothing more to be transferred
1576 $$ LANGUAGE plpgsql;
1578 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1580 Function to attribute expenditures and encumbrances to funding source credits,
1581 and thereby to funding sources.
1583 Read the debits in chonological order, attributing each one to one or
1584 more funding source credits. Constraints:
1586 1. Don't attribute more to a credit than the amount of the credit.
1588 2. For a given fund, don't attribute more to a funding source than the
1589 source has allocated to that fund.
1591 3. Attribute debits to credits with deadlines before attributing them to
1592 credits without deadlines. Otherwise attribute to the earliest credits
1593 first, based on the deadline date when present, or on the effective date
1594 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1595 This ordering is defined by an ORDER BY clause on the view
1596 acq.ordered_funding_source_credit.
1598 Start by truncating the table acq.debit_attribution. Then insert a row
1599 into that table for each attribution. If a debit cannot be fully
1600 attributed, insert a row for the unattributable balance, with the
1601 funding_source_credit and credit_amount columns NULL.
1604 curr_fund_source_bal RECORD;
1605 seqno INT; -- sequence num for credits applicable to a fund
1606 fund_credit RECORD; -- current row in temp t_fund_credit table
1607 fc RECORD; -- used for loading t_fund_credit table
1608 sc RECORD; -- used for loading t_fund_credit table
1610 -- Used exclusively in the main loop:
1612 deb RECORD; -- current row from acq.fund_debit table
1613 curr_credit_bal RECORD; -- current row from temp t_credit table
1614 debit_balance NUMERIC; -- amount left to attribute for current debit
1615 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1616 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1617 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1618 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1619 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1620 attrib_count INT; -- populates id of acq.debit_attribution
1623 -- Load a temporary table. For each combination of fund and funding source,
1624 -- load an entry with the total amount allocated to that fund by that source.
1625 -- This sum may reflect transfers as well as original allocations. We will
1626 -- reduce this balance whenever we attribute debits to it.
1628 CREATE TEMP TABLE t_fund_source_bal
1632 funding_source AS source,
1633 sum( amount ) AS balance
1642 CREATE INDEX t_fund_source_bal_idx
1643 ON t_fund_source_bal( fund, source );
1644 -------------------------------------------------------------------------------
1646 -- Load another temporary table. For each fund, load zero or more
1647 -- funding source credits from which that fund can get money.
1649 CREATE TEMP TABLE t_fund_credit (
1656 SELECT DISTINCT fund
1657 FROM acq.fund_allocation
1659 LOOP -- Loop over the funds
1665 acq.ordered_funding_source_credit AS ofsc
1667 ofsc.funding_source IN
1669 SELECT funding_source
1670 FROM acq.fund_allocation
1671 WHERE fund = fc.fund
1677 LOOP -- Add each credit to the list
1678 INSERT INTO t_fund_credit (
1687 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1689 END LOOP; -- Loop over credits for a given fund
1690 END LOOP; -- Loop over funds
1692 CREATE INDEX t_fund_credit_idx
1693 ON t_fund_credit( fund, seq );
1694 -------------------------------------------------------------------------------
1696 -- Load yet another temporary table. This one is a list of funding source
1697 -- credits, with their balances. We shall reduce those balances as we
1698 -- attribute debits to them.
1700 CREATE TEMP TABLE t_credit
1704 fsc.funding_source AS source,
1705 fsc.amount AS balance,
1706 fs.currency_type AS currency_type
1708 acq.funding_source_credit AS fsc,
1709 acq.funding_source fs
1711 fsc.funding_source = fs.id
1714 CREATE INDEX t_credit_idx
1715 ON t_credit( credit );
1717 -------------------------------------------------------------------------------
1719 -- Now that we have loaded the lookup tables: loop through the debits,
1720 -- attributing each one to one or more funding source credits.
1722 truncate table acq.debit_attribution;
1740 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1742 debit_balance := deb.amount;
1744 -- Loop over the funding source credits that are eligible
1745 -- to pay for this debit
1757 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1759 -- Look up the balance for this credit. If it's zero, then
1760 -- it's not useful, so treat it as if you didn't find it.
1761 -- (Actually there shouldn't be any zero balances in the table,
1762 -- but we check just to make sure.)
1765 INTO curr_credit_bal
1768 credit = fund_credit.credit
1771 IF curr_credit_bal IS NULL THEN
1773 -- This credit is exhausted; try the next one.
1779 -- At this point we have an applicable credit with some money left.
1780 -- Now see if the relevant funding_source has any money left.
1782 -- Look up the balance of the allocation for this combination of
1783 -- fund and source. If you find such an entry, but it has a zero
1784 -- balance, then it's not useful, so treat it as unfound.
1785 -- (Actually there shouldn't be any zero balances in the table,
1786 -- but we check just to make sure.)
1789 INTO curr_fund_source_bal
1790 FROM t_fund_source_bal
1793 AND source = curr_credit_bal.source
1796 IF curr_fund_source_bal IS NULL THEN
1798 -- This fund/source doesn't exist or is already exhausted,
1799 -- so we can't use this credit. Go on to the next one.
1804 -- Convert the available balances to the currency of the fund
1806 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1807 curr_credit_bal.currency_type, deb.currency_type );
1808 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1809 curr_credit_bal.currency_type, deb.currency_type );
1811 -- Determine how much we can attribute to this credit: the minimum
1812 -- of the debit amount, the fund/source balance, and the
1815 --RAISE NOTICE ' deb bal %', debit_balance;
1816 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1817 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1819 conv_attr_amount := NULL;
1820 attr_amount := debit_balance;
1822 IF attr_amount > conv_alloc_balance THEN
1823 attr_amount := conv_alloc_balance;
1824 conv_attr_amount := curr_fund_source_bal.balance;
1826 IF attr_amount > conv_cred_balance THEN
1827 attr_amount := conv_cred_balance;
1828 conv_attr_amount := curr_credit_bal.balance;
1831 -- If we're attributing all of one of the balances, then that's how
1832 -- much we will deduct from the balances, and we already captured
1833 -- that amount above. Otherwise we must convert the amount of the
1834 -- attribution from the currency of the fund back to the currency of
1835 -- the funding source.
1837 IF conv_attr_amount IS NULL THEN
1838 conv_attr_amount := attr_amount * acq.exchange_ratio(
1839 deb.currency_type, curr_credit_bal.currency_type );
1842 -- Insert a row to record the attribution
1844 attrib_count := attrib_count + 1;
1845 INSERT INTO acq.debit_attribution (
1849 funding_source_credit,
1855 curr_credit_bal.credit,
1859 -- Subtract the attributed amount from the various balances
1861 debit_balance := debit_balance - attr_amount;
1862 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1864 IF curr_fund_source_bal.balance <= 0 THEN
1866 -- This allocation is exhausted. Delete it so
1867 -- that we don't waste time looking at it again.
1869 DELETE FROM t_fund_source_bal
1871 fund = curr_fund_source_bal.fund
1872 AND source = curr_fund_source_bal.source;
1874 UPDATE t_fund_source_bal
1875 SET balance = balance - conv_attr_amount
1877 fund = curr_fund_source_bal.fund
1878 AND source = curr_fund_source_bal.source;
1881 IF curr_credit_bal.balance <= 0 THEN
1883 -- This funding source credit is exhausted. Delete it
1884 -- so that we don't waste time looking at it again.
1886 --DELETE FROM t_credit
1888 -- credit = curr_credit_bal.credit;
1890 DELETE FROM t_fund_credit
1892 credit = curr_credit_bal.credit;
1895 SET balance = curr_credit_bal.balance
1897 credit = curr_credit_bal.credit;
1900 -- Are we done with this debit yet?
1902 IF debit_balance <= 0 THEN
1903 EXIT; -- We've fully attributed this debit; stop looking at credits.
1905 END LOOP; -- End loop over credits
1907 IF debit_balance <> 0 THEN
1909 -- We weren't able to attribute this debit, or at least not
1910 -- all of it. Insert a row for the unattributed balance.
1912 attrib_count := attrib_count + 1;
1913 INSERT INTO acq.debit_attribution (
1917 funding_source_credit,
1927 END LOOP; -- End of loop over debits
1929 $$ LANGUAGE 'plpgsql';
1931 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit(
1935 ) RETURNS VOID AS $$
1946 IF old_year IS NULL THEN
1947 RAISE EXCEPTION 'Input year argument is NULL';
1948 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1949 RAISE EXCEPTION 'Input year is out of range';
1952 IF user_id IS NULL THEN
1953 RAISE EXCEPTION 'Input user id argument is NULL';
1956 IF org_unit_id IS NULL THEN
1957 RAISE EXCEPTION 'Org unit id argument is NULL';
1959 SELECT TRUE INTO org_found
1961 WHERE id = org_unit_id;
1963 IF org_found IS NULL THEN
1964 RAISE EXCEPTION 'Org unit id is invalid';
1968 -- Loop over the applicable funds
1970 FOR old_fund in SELECT * FROM acq.fund
1974 AND org = org_unit_id
1977 INSERT INTO acq.fund (
1985 balance_warning_percent,
1986 balance_stop_percent
1991 old_fund.currency_type,
1995 old_fund.balance_warning_percent,
1996 old_fund.balance_stop_percent
1998 RETURNING id INTO new_id;
2000 WHEN unique_violation THEN
2001 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2004 --RAISE NOTICE 'Propagating fund % to fund %',
2005 -- old_fund.code, new_id;
2008 $$ LANGUAGE plpgsql;
2010 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
2014 ) RETURNS VOID AS $$
2025 IF old_year IS NULL THEN
2026 RAISE EXCEPTION 'Input year argument is NULL';
2027 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2028 RAISE EXCEPTION 'Input year is out of range';
2031 IF user_id IS NULL THEN
2032 RAISE EXCEPTION 'Input user id argument is NULL';
2035 IF org_unit_id IS NULL THEN
2036 RAISE EXCEPTION 'Org unit id argument is NULL';
2038 SELECT TRUE INTO org_found
2040 WHERE id = org_unit_id;
2042 IF org_found IS NULL THEN
2043 RAISE EXCEPTION 'Org unit id is invalid';
2047 -- Loop over the applicable funds
2049 FOR old_fund in SELECT * FROM acq.fund
2054 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2058 INSERT INTO acq.fund (
2066 balance_warning_percent,
2067 balance_stop_percent
2072 old_fund.currency_type,
2076 old_fund.balance_warning_percent,
2077 old_fund.balance_stop_percent
2079 RETURNING id INTO new_id;
2081 WHEN unique_violation THEN
2082 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2085 --RAISE NOTICE 'Propagating fund % to fund %',
2086 -- old_fund.code, new_id;
2089 $$ LANGUAGE plpgsql;
2091 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit(
2095 ) RETURNS VOID AS $$
2099 new_year INT := old_year + 1;
2101 xfer_amount NUMERIC;
2110 IF old_year IS NULL THEN
2111 RAISE EXCEPTION 'Input year argument is NULL';
2112 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2113 RAISE EXCEPTION 'Input year is out of range';
2116 IF user_id IS NULL THEN
2117 RAISE EXCEPTION 'Input user id argument is NULL';
2120 IF org_unit_id IS NULL THEN
2121 RAISE EXCEPTION 'Org unit id argument is NULL';
2124 -- Validate the org unit
2129 WHERE id = org_unit_id;
2131 IF org_found IS NULL THEN
2132 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2136 -- Loop over the propagable funds to identify the details
2137 -- from the old fund plus the id of the new one, if it exists.
2141 oldf.id AS old_fund,
2147 newf.id AS new_fund_id
2150 LEFT JOIN acq.fund AS newf
2151 ON ( oldf.code = newf.code )
2153 oldf.org = org_unit_id
2154 and oldf.year = old_year
2156 and newf.year = new_year
2158 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2160 IF roll_fund.new_fund_id IS NULL THEN
2162 -- The old fund hasn't been propagated yet. Propagate it now.
2164 INSERT INTO acq.fund (
2172 balance_warning_percent,
2173 balance_stop_percent
2178 roll_fund.currency_type,
2182 roll_fund.balance_warning_percent,
2183 roll_fund.balance_stop_percent
2185 RETURNING id INTO new_fund;
2187 new_fund = roll_fund.new_fund_id;
2190 -- Determine the amount to transfer
2194 FROM acq.fund_spent_balance
2195 WHERE fund = roll_fund.old_fund;
2197 IF xfer_amount <> 0 THEN
2198 IF roll_fund.rollover THEN
2200 -- Transfer balance from old fund to new
2202 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2204 PERFORM acq.transfer_fund(
2214 -- Transfer balance from old fund to the void
2216 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2218 PERFORM acq.transfer_fund(
2229 IF roll_fund.rollover THEN
2231 -- Move any lineitems from the old fund to the new one
2232 -- where the associated debit is an encumbrance.
2234 -- Any other tables tying expenditure details to funds should
2235 -- receive similar treatment. At this writing there are none.
2237 UPDATE acq.lineitem_detail
2240 fund = roll_fund.old_fund -- this condition may be redundant
2246 fund = roll_fund.old_fund
2250 -- Move encumbrance debits from the old fund to the new fund
2252 UPDATE acq.fund_debit
2255 fund = roll_fund.old_fund
2259 -- Mark old fund as inactive, now that we've closed it
2263 WHERE id = roll_fund.old_fund;
2266 $$ LANGUAGE plpgsql;
2268 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2272 ) RETURNS VOID AS $$
2276 new_year INT := old_year + 1;
2278 xfer_amount NUMERIC;
2287 IF old_year IS NULL THEN
2288 RAISE EXCEPTION 'Input year argument is NULL';
2289 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2290 RAISE EXCEPTION 'Input year is out of range';
2293 IF user_id IS NULL THEN
2294 RAISE EXCEPTION 'Input user id argument is NULL';
2297 IF org_unit_id IS NULL THEN
2298 RAISE EXCEPTION 'Org unit id argument is NULL';
2301 -- Validate the org unit
2306 WHERE id = org_unit_id;
2308 IF org_found IS NULL THEN
2309 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2313 -- Loop over the propagable funds to identify the details
2314 -- from the old fund plus the id of the new one, if it exists.
2318 oldf.id AS old_fund,
2324 newf.id AS new_fund_id
2327 LEFT JOIN acq.fund AS newf
2328 ON ( oldf.code = newf.code )
2330 oldf.year = old_year
2332 AND newf.year = new_year
2334 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2337 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2339 IF roll_fund.new_fund_id IS NULL THEN
2341 -- The old fund hasn't been propagated yet. Propagate it now.
2343 INSERT INTO acq.fund (
2351 balance_warning_percent,
2352 balance_stop_percent
2357 roll_fund.currency_type,
2361 roll_fund.balance_warning_percent,
2362 roll_fund.balance_stop_percent
2364 RETURNING id INTO new_fund;
2366 new_fund = roll_fund.new_fund_id;
2369 -- Determine the amount to transfer
2373 FROM acq.fund_spent_balance
2374 WHERE fund = roll_fund.old_fund;
2376 IF xfer_amount <> 0 THEN
2377 IF roll_fund.rollover THEN
2379 -- Transfer balance from old fund to new
2381 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2383 PERFORM acq.transfer_fund(
2393 -- Transfer balance from old fund to the void
2395 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2397 PERFORM acq.transfer_fund(
2408 IF roll_fund.rollover THEN
2410 -- Move any lineitems from the old fund to the new one
2411 -- where the associated debit is an encumbrance.
2413 -- Any other tables tying expenditure details to funds should
2414 -- receive similar treatment. At this writing there are none.
2416 UPDATE acq.lineitem_detail
2419 fund = roll_fund.old_fund -- this condition may be redundant
2425 fund = roll_fund.old_fund
2429 -- Move encumbrance debits from the old fund to the new fund
2431 UPDATE acq.fund_debit
2434 fund = roll_fund.old_fund
2438 -- Mark old fund as inactive, now that we've closed it
2442 WHERE id = roll_fund.old_fund;
2445 $$ LANGUAGE plpgsql;
2447 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2448 SELECT funding_source,
2449 SUM(amount) AS amount
2450 FROM acq.funding_source_credit
2453 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2454 SELECT funding_source,
2455 SUM(a.amount)::NUMERIC(100,2) AS amount
2456 FROM acq.fund_allocation a
2459 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2460 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2461 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2462 FROM acq.funding_source_credit_total c
2463 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2466 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2468 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2469 FROM acq.fund_allocation a
2470 JOIN acq.fund f ON (a.fund = f.id)
2471 JOIN acq.funding_source s ON (a.funding_source = s.id)
2474 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2475 SELECT fund.id AS fund,
2476 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2478 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2481 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2484 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2486 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2487 WHERE fund_debit.encumbrance GROUP BY fund.id;
2489 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2490 SELECT fund.id AS fund,
2491 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2493 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2494 WHERE NOT fund_debit.encumbrance
2497 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2499 c.amount - COALESCE(d.amount, 0.0) AS amount
2500 FROM acq.fund_allocation_total c
2501 LEFT JOIN acq.fund_debit_total d USING (fund);
2503 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2505 c.amount - COALESCE(d.amount,0.0) AS amount
2506 FROM acq.fund_allocation_total c
2507 LEFT JOIN acq.fund_spent_total d USING (fund);
2509 -- For each fund: the total allocation from all sources, in the
2510 -- currency of the fund (or 0 if there are no allocations)
2512 CREATE VIEW acq.all_fund_allocation_total AS
2515 COALESCE( SUM( a.amount * acq.exchange_ratio(
2516 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2520 LEFT JOIN acq.fund_allocation a
2522 LEFT JOIN acq.funding_source s
2523 ON a.funding_source = s.id
2527 -- For every fund: the total encumbrances (or 0 if none),
2528 -- in the currency of the fund.
2530 CREATE VIEW acq.all_fund_encumbrance_total AS
2533 COALESCE( encumb.amount, 0 ) AS amount
2539 sum( amount ) AS amount
2546 ON f.id = encumb.fund;
2548 -- For every fund: the total spent (or 0 if none),
2549 -- in the currency of the fund.
2551 CREATE VIEW acq.all_fund_spent_total AS
2554 COALESCE( spent.amount, 0 ) AS amount
2560 sum( amount ) AS amount
2567 ON f.id = spent.fund;
2569 -- For each fund: the amount not yet spent, in the currency
2570 -- of the fund. May include encumbrances.
2572 CREATE VIEW acq.all_fund_spent_balance AS
2575 c.amount - d.amount AS amount
2576 FROM acq.all_fund_allocation_total c
2577 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2579 -- For each fund: the amount neither spent nor encumbered,
2580 -- in the currency of the fund
2582 CREATE VIEW acq.all_fund_combined_balance AS
2585 a.amount - COALESCE( c.amount, 0 ) AS amount
2587 acq.all_fund_allocation_total a
2591 SUM( amount ) AS amount
2596 ) AS c USING ( fund );
2598 CREATE TABLE acq.claim_type (
2599 id SERIAL PRIMARY KEY,
2600 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2601 DEFERRABLE INITIALLY DEFERRED,
2603 description TEXT NOT NULL,
2604 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2607 CREATE TABLE acq.claim (
2608 id SERIAL PRIMARY KEY,
2609 type INT NOT NULL REFERENCES acq.claim_type
2610 DEFERRABLE INITIALLY DEFERRED,
2611 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2612 DEFERRABLE INITIALLY DEFERRED
2615 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2617 CREATE TABLE acq.claim_event (
2618 id BIGSERIAL PRIMARY KEY,
2619 type INT NOT NULL REFERENCES acq.claim_event_type
2620 DEFERRABLE INITIALLY DEFERRED,
2621 claim SERIAL NOT NULL REFERENCES acq.claim
2622 DEFERRABLE INITIALLY DEFERRED,
2623 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2624 creator INT NOT NULL REFERENCES actor.usr
2625 DEFERRABLE INITIALLY DEFERRED,
2629 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2631 -- And the serials version of claiming
2632 CREATE TABLE acq.serial_claim (
2633 id SERIAL PRIMARY KEY,
2634 type INT NOT NULL REFERENCES acq.claim_type
2635 DEFERRABLE INITIALLY DEFERRED,
2636 item BIGINT NOT NULL REFERENCES serial.item
2637 DEFERRABLE INITIALLY DEFERRED
2640 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2642 CREATE TABLE acq.serial_claim_event (
2643 id BIGSERIAL PRIMARY KEY,
2644 type INT NOT NULL REFERENCES acq.claim_event_type
2645 DEFERRABLE INITIALLY DEFERRED,
2646 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2647 DEFERRABLE INITIALLY DEFERRED,
2648 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2649 creator INT NOT NULL REFERENCES actor.usr
2650 DEFERRABLE INITIALLY DEFERRED,
2654 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );