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 CREATE TABLE acq.exchange_rate (
32 id SERIAL PRIMARY KEY,
33 from_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
34 to_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
35 ratio NUMERIC NOT NULL,
36 CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
39 CREATE TABLE acq.claim_policy (
40 id SERIAL PRIMARY KEY,
41 org_unit INT NOT NULL REFERENCES actor.org_unit
42 DEFERRABLE INITIALLY DEFERRED,
44 description TEXT NOT NULL,
45 CONSTRAINT name_once_per_org UNIQUE (org_unit, name)
48 CREATE TABLE acq.claim_event_type (
49 id SERIAL PRIMARY KEY,
50 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
51 DEFERRABLE INITIALLY DEFERRED,
53 description TEXT NOT NULL,
54 library_initiated BOOL NOT NULL DEFAULT FALSE,
55 CONSTRAINT event_type_once_per_org UNIQUE ( org_unit, code )
58 CREATE TABLE acq.claim_policy_action (
59 id SERIAL PRIMARY KEY,
60 claim_policy INT NOT NULL REFERENCES acq.claim_policy
62 DEFERRABLE INITIALLY DEFERRED,
63 action_interval INTERVAL NOT NULL,
64 action INT NOT NULL REFERENCES acq.claim_event_type
65 DEFERRABLE INITIALLY DEFERRED,
66 CONSTRAINT action_sequence UNIQUE (claim_policy, action_interval)
69 CREATE TABLE acq.provider (
70 id SERIAL PRIMARY KEY,
72 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
73 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
77 edi_default INT, -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
78 active BOOL NOT NULL DEFAULT TRUE,
79 prepayment_required BOOL NOT NULL DEFAULT FALSE,
84 default_copy_count INT NOT NULL DEFAULT 0,
85 default_claim_policy INT REFERENCES acq.claim_policy
86 DEFERRABLE INITIALLY DEFERRED,
87 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
88 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
91 CREATE TABLE acq.provider_holding_subfield_map (
92 id SERIAL PRIMARY KEY,
93 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
94 name TEXT NOT NULL, -- barcode, price, etc
95 subfield TEXT NOT NULL,
96 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
99 CREATE TABLE acq.provider_address (
100 id SERIAL PRIMARY KEY,
101 valid BOOL NOT NULL DEFAULT TRUE,
103 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
104 street1 TEXT NOT NULL,
109 country TEXT NOT NULL,
110 post_code TEXT NOT NULL,
114 CREATE TABLE acq.provider_contact (
115 id SERIAL PRIMARY KEY,
116 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
118 role TEXT, -- free-form.. e.g. "our sales guy"
123 CREATE TABLE acq.provider_contact_address (
124 id SERIAL PRIMARY KEY,
125 valid BOOL NOT NULL DEFAULT TRUE,
127 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
128 street1 TEXT NOT NULL,
133 country TEXT NOT NULL,
134 post_code TEXT NOT NULL,
138 CREATE TABLE acq.provider_note (
139 id SERIAL PRIMARY KEY,
140 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
141 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
142 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
143 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
144 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
147 CREATE INDEX acq_pro_note_pro_idx ON acq.provider_note ( provider );
148 CREATE INDEX acq_pro_note_creator_idx ON acq.provider_note ( creator );
149 CREATE INDEX acq_pro_note_editor_idx ON acq.provider_note ( editor );
152 CREATE TABLE acq.funding_source (
153 id SERIAL PRIMARY KEY,
155 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
156 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
158 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
161 CREATE TABLE acq.funding_source_credit (
162 id SERIAL PRIMARY KEY,
163 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
164 amount NUMERIC NOT NULL,
166 deadline_date TIMESTAMPTZ,
167 effective_date TIMESTAMPTZ NOT NULL default now()
170 CREATE VIEW acq.ordered_funding_source_credit AS
172 CASE WHEN deadline_date IS NULL THEN
176 END AS sort_priority,
177 CASE WHEN deadline_date IS NULL THEN
187 acq.funding_source_credit;
189 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
190 The acq.ordered_funding_source_credit view is a prioritized
191 ordering of funding source credits. When ordered by the first
192 three columns, this view defines the order in which the various
193 credits are to be tapped for spending, subject to the allocations
194 in the acq.fund_allocation table.
196 The first column reflects the principle that we should spend
197 money with deadlines before spending money without deadlines.
199 The second column reflects the principle that we should spend the
200 oldest money first. For money with deadlines, that means that we
201 spend first from the credit with the earliest deadline. For
202 money without deadlines, we spend first from the credit with the
203 earliest effective date.
205 The third column is a tie breaker to ensure a consistent
209 CREATE TABLE acq.fund (
210 id SERIAL PRIMARY KEY,
211 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
213 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
214 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
216 rollover BOOL NOT NULL DEFAULT FALSE,
217 propagate BOOL NOT NULL DEFAULT TRUE,
218 active BOOL NOT NULL DEFAULT TRUE,
219 balance_warning_percent INT,
220 balance_stop_percent INT,
221 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
222 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
223 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
226 CREATE TABLE acq.fund_debit (
227 id SERIAL PRIMARY KEY,
228 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
229 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
230 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
231 amount NUMERIC NOT NULL,
232 encumbrance BOOL NOT NULL DEFAULT TRUE,
233 debit_type TEXT NOT NULL,
234 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
235 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
238 CREATE TABLE acq.fund_allocation (
239 id SERIAL PRIMARY KEY,
240 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
241 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
242 amount NUMERIC NOT NULL,
243 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
245 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
247 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
249 CREATE TABLE acq.fund_allocation_percent
251 id SERIAL PRIMARY KEY,
252 funding_source INT NOT NULL REFERENCES acq.funding_source
253 DEFERRABLE INITIALLY DEFERRED,
254 org INT NOT NULL REFERENCES actor.org_unit
255 DEFERRABLE INITIALLY DEFERRED,
257 percent NUMERIC NOT NULL,
258 allocator INTEGER NOT NULL REFERENCES actor.usr
259 DEFERRABLE INITIALLY DEFERRED,
261 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
262 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
263 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
266 -- Trigger function to validate combination of org_unit and fund_code
268 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
269 RETURNS TRIGGER AS $$
284 AND code = NEW.fund_code
290 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
295 CREATE TRIGGER acq_fund_alloc_percent_val_trig
296 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
297 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
299 -- To do: trigger to verify that percentages don't add up to more than 100
301 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
302 RETURNS TRIGGER AS $$
305 total_percent numeric;
313 acq.fund_allocation_percent AS fap
315 fap.funding_source = NEW.funding_source;
317 IF total_percent > 100 THEN
318 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
326 CREATE TRIGGER acqfap_limit_100_trig
327 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
328 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
330 CREATE TABLE acq.picklist (
331 id SERIAL PRIMARY KEY,
332 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
333 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
334 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
335 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
337 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
338 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
339 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
341 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
342 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
343 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
345 CREATE TABLE acq.cancel_reason (
346 id SERIAL PRIMARY KEY,
347 org_unit INTEGER NOT NULL REFERENCES actor.org_unit( id )
348 DEFERRABLE INITIALLY DEFERRED,
350 description TEXT NOT NULL,
351 keep_debits BOOL NOT NULL DEFAULT FALSE,
352 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
355 -- Reserve ids 1-999 for stock reasons
356 -- Reserve ids 1000-1999 for EDI reasons
357 -- 2000+ are available for staff to create
359 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
361 CREATE TABLE acq.purchase_order (
362 id SERIAL PRIMARY KEY,
363 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
364 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
365 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
366 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
367 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
368 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
369 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
370 state TEXT NOT NULL DEFAULT 'new',
371 order_date TIMESTAMP WITH TIME ZONE,
373 cancel_reason INT REFERENCES acq.cancel_reason( id )
374 DEFERRABLE INITIALLY DEFERRED,
375 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE,
376 CONSTRAINT valid_po_state CHECK (state IN ('new','pending','on-order','received','cancelled'))
378 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
379 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
380 CREATE INDEX po_state_idx ON acq.purchase_order (state);
381 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
382 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
383 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
385 -- The name should default to the id, as text. We can't reference a column
386 -- in a DEFAULT clause, so we use a trigger:
388 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
391 IF NEW.name IS NULL THEN
392 NEW.name := NEW.id::TEXT;
399 CREATE TRIGGER po_name_default_trg
400 BEFORE INSERT OR UPDATE ON acq.purchase_order
401 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
403 -- The order name should be unique for a given ordering agency on a given order date
404 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
405 -- this rule requires a check constraint with a subquery. However you can't have a
406 -- subquery in a CHECK constraint, so we fake it with a trigger.
408 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
414 -- If order_date is not null, then make sure we don't have a collision
415 -- on order_date (truncated to day), org, and name
417 IF NEW.order_date IS NULL THEN
421 -- In the WHERE clause, we compare the order_dates without regard to time of day.
422 -- We use a pair of inequalities instead of comparing truncated dates so that the
423 -- query can do an indexed range scan.
425 SELECT 1 INTO collision
426 FROM acq.purchase_order
428 ordering_agency = NEW.ordering_agency
430 AND order_date >= date_trunc( 'day', NEW.order_date )
431 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
434 IF collision IS NULL THEN
435 -- okay, no collision
438 -- collision; nip it in the bud
439 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
440 NEW.ordering_agency, NEW.order_date, NEW.name;
445 CREATE TRIGGER po_org_name_date_unique_trg
446 BEFORE INSERT OR UPDATE ON acq.purchase_order
447 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
449 CREATE TABLE acq.po_note (
450 id SERIAL PRIMARY KEY,
451 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
452 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
453 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
454 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
455 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
457 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
459 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
460 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
461 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
463 CREATE TABLE acq.lineitem (
464 id BIGSERIAL PRIMARY KEY,
465 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
466 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
467 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
468 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
469 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
470 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
471 expected_recv_time TIMESTAMP WITH TIME ZONE,
472 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
473 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
475 eg_bib_id BIGINT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
477 state TEXT NOT NULL DEFAULT 'new',
478 cancel_reason INT REFERENCES acq.cancel_reason( id )
479 DEFERRABLE INITIALLY DEFERRED,
480 estimated_unit_price NUMERIC,
481 claim_policy INT REFERENCES acq.claim_policy
482 DEFERRABLE INITIALLY DEFERRED,
483 queued_record BIGINT REFERENCES vandelay.queued_bib_record (id)
484 ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
485 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
487 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
488 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
489 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
490 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
491 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
492 CREATE INDEX li_queued_record_idx ON acq.lineitem ( queued_record );
494 CREATE TABLE acq.lineitem_alert_text (
495 id SERIAL PRIMARY KEY,
498 owning_lib INT NOT NULL
499 REFERENCES actor.org_unit(id)
500 DEFERRABLE INITIALLY DEFERRED,
501 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
504 CREATE TABLE acq.lineitem_note (
505 id SERIAL PRIMARY KEY,
506 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
507 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
508 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
509 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
510 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
512 alert_text INT REFERENCES acq.lineitem_alert_text(id)
513 DEFERRABLE INITIALLY DEFERRED,
514 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
516 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
517 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
518 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
520 CREATE TABLE acq.lineitem_detail (
521 id BIGSERIAL PRIMARY KEY,
522 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
523 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
524 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
525 eg_copy_id BIGINT, -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
529 collection_code TEXT,
530 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
531 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
532 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
533 recv_time TIMESTAMP WITH TIME ZONE,
534 receiver INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
535 cancel_reason INT REFERENCES acq.cancel_reason( id ) DEFERRABLE INITIALLY DEFERRED
538 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
540 CREATE TABLE acq.lineitem_attr_definition (
541 id BIGSERIAL PRIMARY KEY,
543 description TEXT NOT NULL,
544 remove TEXT NOT NULL DEFAULT '',
545 ident BOOL NOT NULL DEFAULT FALSE
548 CREATE TABLE acq.lineitem_marc_attr_definition (
549 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
551 ) INHERITS (acq.lineitem_attr_definition);
553 CREATE TABLE acq.lineitem_provider_attr_definition (
554 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
556 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
557 ) INHERITS (acq.lineitem_attr_definition);
559 CREATE TABLE acq.lineitem_generated_attr_definition (
560 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
562 ) INHERITS (acq.lineitem_attr_definition);
564 CREATE TABLE acq.lineitem_usr_attr_definition (
565 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
566 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
567 ) INHERITS (acq.lineitem_attr_definition);
568 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
570 CREATE TABLE acq.lineitem_local_attr_definition (
571 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
572 ) INHERITS (acq.lineitem_attr_definition);
574 CREATE TABLE acq.lineitem_attr (
575 id BIGSERIAL PRIMARY KEY,
576 definition BIGINT NOT NULL,
577 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
578 attr_type TEXT NOT NULL,
579 attr_name TEXT NOT NULL,
580 attr_value TEXT NOT NULL,
581 order_ident BOOLEAN NOT NULL DEFAULT FALSE
584 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
585 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
586 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
592 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
593 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)]');
594 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
595 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
596 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
597 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
598 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('upc', 'UPC', '//*[@tag="024" and @ind1="1"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
599 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
600 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
601 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
602 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
605 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
608 CREATE TABLE acq.distribution_formula (
609 id SERIAL PRIMARY KEY,
611 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
613 skip_count INT NOT NULL DEFAULT 0,
614 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
617 CREATE TABLE acq.distribution_formula_entry (
618 id SERIAL PRIMARY KEY,
619 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
621 DEFERRABLE INITIALLY DEFERRED,
622 position INTEGER NOT NULL,
623 item_count INTEGER NOT NULL,
624 owning_lib INTEGER REFERENCES actor.org_unit(id)
625 DEFERRABLE INITIALLY DEFERRED,
626 location INTEGER REFERENCES asset.copy_location(id),
627 fund INTEGER REFERENCES acq.fund (id),
628 circ_modifier TEXT REFERENCES config.circ_modifier (code),
629 collection_code TEXT,
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 REFERENCES acq.fund( id )
676 DEFERRABLE INITIALLY DEFERRED,
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 Each row represents the transfer of money from a source fund
692 to a destination fund. There should be corresponding entries
693 in acq.fund_allocation. The purpose of acq.fund_transfer is
694 to record how much money moved from which fund to which other
697 The presence of two amount fields, rather than one, reflects
698 the possibility that the two funds are denominated in different
699 currencies. If they use the same currency type, the two
700 amounts should be the same.
703 CREATE TABLE acq.fiscal_calendar (
704 id SERIAL PRIMARY KEY,
708 -- Create a default calendar (though we don't specify its contents).
709 -- Create a foreign key in actor.org_unit, initially pointing to
710 -- the default calendar.
712 INSERT INTO acq.fiscal_calendar (
719 ALTER TABLE actor.org_unit ADD FOREIGN KEY
720 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
721 DEFERRABLE INITIALLY DEFERRED;
723 CREATE TABLE acq.fiscal_year (
724 id SERIAL PRIMARY KEY,
725 calendar INT NOT NULL
726 REFERENCES acq.fiscal_calendar
728 DEFERRABLE INITIALLY DEFERRED,
730 year_begin TIMESTAMPTZ NOT NULL,
731 year_end TIMESTAMPTZ NOT NULL,
732 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
733 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
736 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
737 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
738 in_dir TEXT, -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
741 ) INHERITS (config.remote_account);
743 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
744 ALTER TABLE acq.edi_account ADD PRIMARY KEY (id);
746 CREATE TABLE acq.edi_message (
747 id SERIAL PRIMARY KEY,
748 account INTEGER REFERENCES acq.edi_account(id)
749 DEFERRABLE INITIALLY DEFERRED,
751 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
752 translate_time TIMESTAMPTZ,
753 process_time TIMESTAMPTZ,
754 error_time TIMESTAMPTZ,
755 status TEXT NOT NULL DEFAULT 'new'
756 CONSTRAINT status_value CHECK
758 'new', -- needs to be translated
759 'translated', -- needs to be processed
760 'trans_error', -- error in translation step
761 'processed', -- needs to have remote_file deleted
762 'proc_error', -- error in processing step
763 'delete_error', -- error in deletion
764 'retry', -- need to retry
770 purchase_order INT REFERENCES acq.purchase_order
771 DEFERRABLE INITIALLY DEFERRED,
772 message_type TEXT NOT NULL CONSTRAINT valid_message_type CHECK
781 CREATE INDEX edi_message_account_status_idx ON acq.edi_message (account,status);
782 CREATE INDEX edi_message_po_idx ON acq.edi_message (purchase_order);
784 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
785 -- the table, assigning ids programmatically instead of using a sequence.
786 CREATE TABLE acq.debit_attribution (
787 id INT NOT NULL PRIMARY KEY,
788 fund_debit INT NOT NULL
789 REFERENCES acq.fund_debit
790 DEFERRABLE INITIALLY DEFERRED,
791 debit_amount NUMERIC NOT NULL,
792 funding_source_credit INT REFERENCES acq.funding_source_credit
793 DEFERRABLE INITIALLY DEFERRED,
794 credit_amount NUMERIC
797 CREATE INDEX acq_attribution_debit_idx
798 ON acq.debit_attribution( fund_debit );
800 CREATE INDEX acq_attribution_credit_idx
801 ON acq.debit_attribution( funding_source_credit );
805 CREATE TABLE acq.invoice_method (
806 code TEXT PRIMARY KEY,
807 name TEXT NOT NULL -- i18n-ize
810 CREATE TABLE acq.invoice_payment_method (
811 code TEXT PRIMARY KEY,
812 name TEXT NOT NULL -- i18n-ize
815 CREATE TABLE acq.invoice (
816 id SERIAL PRIMARY KEY,
817 receiver INT NOT NULL REFERENCES actor.org_unit (id),
818 provider INT NOT NULL REFERENCES acq.provider (id),
819 shipper INT NOT NULL REFERENCES acq.provider (id),
820 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
821 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
822 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
823 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
825 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
826 DEFERRABLE INITIALLY DEFERRED,
828 complete BOOL NOT NULL DEFAULT FALSE,
829 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
832 CREATE TABLE acq.invoice_entry (
833 id SERIAL PRIMARY KEY,
834 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
835 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
836 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
837 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
838 phys_item_count INT, -- and how many did staff count
840 billed_per_item BOOL,
841 cost_billed NUMERIC(8,2),
842 actual_cost NUMERIC(8,2),
843 amount_paid NUMERIC (8,2)
846 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
847 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
848 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
850 CREATE TABLE acq.invoice_item_type (
851 code TEXT PRIMARY KEY,
852 name TEXT NOT NULL, -- i18n-ize
853 prorate BOOL NOT NULL DEFAULT FALSE
856 CREATE TABLE acq.po_item (
857 id SERIAL PRIMARY KEY,
858 purchase_order INT REFERENCES acq.purchase_order (id)
859 ON UPDATE CASCADE ON DELETE SET NULL
860 DEFERRABLE INITIALLY DEFERRED,
861 fund_debit INT REFERENCES acq.fund_debit (id)
862 DEFERRABLE INITIALLY DEFERRED,
863 inv_item_type TEXT NOT NULL
864 REFERENCES acq.invoice_item_type (code)
865 DEFERRABLE INITIALLY DEFERRED,
869 estimated_cost NUMERIC(8,2),
870 fund INT REFERENCES acq.fund (id)
871 DEFERRABLE INITIALLY DEFERRED,
875 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
877 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
878 id SERIAL PRIMARY KEY,
879 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
880 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
881 fund_debit INT REFERENCES acq.fund_debit (id),
882 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
886 cost_billed NUMERIC(8,2),
887 actual_cost NUMERIC(8,2),
888 fund INT REFERENCES acq.fund (id)
889 DEFERRABLE INITIALLY DEFERRED,
890 amount_paid NUMERIC (8,2),
891 po_item INT REFERENCES acq.po_item (id)
892 DEFERRABLE INITIALLY DEFERRED,
896 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
897 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
898 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
901 CREATE TABLE acq.user_request_type (
902 id SERIAL PRIMARY KEY,
903 label TEXT NOT NULL UNIQUE -- i18n-ize
906 CREATE TABLE acq.user_request (
907 id SERIAL PRIMARY KEY,
908 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
909 hold BOOL NOT NULL DEFAULT TRUE,
911 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
912 holdable_formats TEXT, -- nullable, for use in hold creation
914 email_notify BOOL NOT NULL DEFAULT TRUE,
915 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
916 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
917 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
918 need_before TIMESTAMPTZ, -- don't create holds after this
921 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
933 cancel_reason INT REFERENCES acq.cancel_reason( id )
934 DEFERRABLE INITIALLY DEFERRED
940 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
941 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
944 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
947 SELECT COUNT(*) INTO counter
948 FROM oils_xpath_table(
952 '//*[@tag="' || tag || '"]',
954 ) as t(i int,c text);
956 FOR i IN 1 .. counter LOOP
959 FROM ( SELECT id,i,t,v
960 FROM oils_xpath_table(
964 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
965 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
967 ) as t(id int,t text,v text)
978 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
979 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
983 lida acq.flat_lineitem_detail%ROWTYPE;
985 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
986 IF NOT FOUND THEN RETURN; END IF;
988 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
989 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
996 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
997 JOIN acq.provider_holding_subfield_map a USING (subfield)
998 WHERE a.provider = prov_i
1005 $$ LANGUAGE PLPGSQL;
1007 -- select * from acq.extract_provider_holding_data(699);
1009 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1010 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1013 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field_set ( BIGINT, TEXT, TEXT) RETURNS SETOF TEXT AS $$
1014 SELECT extract_marc_field_set('acq.lineitem', $1, $2, $3);
1019 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1020 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1023 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1024 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1028 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1031 Suggested vendor fields:
1039 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1048 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1050 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1052 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1053 IF (atype = 'lineitem_provider_attr_definition') THEN
1054 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1055 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1058 IF (atype = 'lineitem_provider_attr_definition') THEN
1059 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1060 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1061 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1062 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1063 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1066 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1068 IF (adef.code = 'title' OR adef.code = 'author') THEN
1069 -- title and author should not be split
1070 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1071 -- string-join in the xpath and remove this special case
1072 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1073 IF (value IS NOT NULL AND value <> '') THEN
1074 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1075 VALUES (NEW.id, adef.id, atype, adef.code, value);
1080 -- each application of the regex may produce multiple values
1082 SELECT * FROM extract_acq_marc_field_set(
1083 NEW.id, xpath_string || '[' || pos || ']', adef.remove)
1086 IF (value IS NOT NULL AND value <> '') THEN
1087 INSERT INTO acq.lineitem_attr
1088 (lineitem, definition, attr_type, attr_name, attr_value)
1089 VALUES (NEW.id, adef.id, atype, adef.code, value);
1107 $function$ LANGUAGE PLPGSQL;
1109 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1111 IF TG_OP = 'UPDATE' THEN
1112 DELETE FROM acq.lineitem_attr
1113 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1116 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1120 $$ LANGUAGE PLPGSQL;
1122 CREATE TRIGGER cleanup_lineitem_trigger
1123 BEFORE UPDATE OR DELETE ON acq.lineitem
1124 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1126 CREATE TRIGGER ingest_lineitem_trigger
1127 AFTER INSERT OR UPDATE ON acq.lineitem
1128 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1130 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1134 IF from_ex = to_ex THEN
1138 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1143 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1152 $$ LANGUAGE PLPGSQL;
1154 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1155 SELECT $3 * acq.exchange_ratio($1, $2);
1158 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1160 Examine the acq.fiscal_year table, comparing successive years.
1161 Report any inconsistencies, i.e. years that overlap, have gaps
1162 between them, or are out of sequence.
1164 RETURNS SETOF RECORD AS $$
1188 ELSIF curr_year.calendar = prev_year.calendar THEN
1189 IF curr_year.year_begin > prev_year.year_end THEN
1190 -- This ugly kludge works around the fact that older
1191 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1192 FOR return_rec IN SELECT
1195 'Gap between fiscal years'::TEXT
1197 RETURN NEXT return_rec;
1199 ELSIF curr_year.year_begin < prev_year.year_end THEN
1200 FOR return_rec IN SELECT
1203 'Overlapping fiscal years'::TEXT
1205 RETURN NEXT return_rec;
1207 ELSIF curr_year.year < prev_year.year THEN
1208 FOR return_rec IN SELECT
1211 'Fiscal years out of order'::TEXT
1213 RETURN NEXT return_rec;
1218 prev_year := curr_year;
1223 $$ LANGUAGE plpgsql;
1225 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1227 old_amount IN NUMERIC, -- in currency of old fund
1229 new_amount IN NUMERIC, -- in currency of new fund
1231 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1232 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1233 ) RETURNS VOID AS $$
1234 /* -------------------------------------------------------------------------------
1236 Function to transfer money from one fund to another.
1238 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1239 negative amount for the old (losing) fund and a positive amount for the new
1240 (gaining) fund. In some cases there may be more than one such pair of entries
1241 in order to pull the money from different funding sources, or more specifically
1242 from different funding source credits. For each such pair there is also an
1243 entry in acq.fund_transfer.
1245 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1246 choose a funding source for the transferred money to come from. This choice
1247 must meet two constraints, so far as possible:
1249 1. The amount transferred from a given funding source must not exceed the
1250 amount allocated to the old fund by the funding source. To that end we
1251 compare the amount being transferred to the amount allocated.
1253 2. We shouldn't transfer money that has already been spent or encumbered, as
1254 defined by the funding attribution process. We attribute expenses to the
1255 oldest funding source credits first. In order to avoid transferring that
1256 attributed money, we reverse the priority, transferring from the newest funding
1257 source credits first. There can be no guarantee that this approach will
1258 avoid overcommitting a fund, but no other approach can do any better.
1260 In this context the age of a funding source credit is defined by the
1261 deadline_date for credits with deadline_dates, and by the effective_date for
1262 credits without deadline_dates, with the proviso that credits with deadline_dates
1263 are all considered "older" than those without.
1267 In the signature for this function, there is one last parameter commented out,
1268 named "funding_source_in". Correspondingly, the WHERE clause for the query
1269 driving the main loop has an OR clause commented out, which references the
1270 funding_source_in parameter.
1272 If these lines are uncommented, this function will allow the user optionally to
1273 restrict a fund transfer to a specified funding source. If the source
1274 parameter is left NULL, then there will be no such restriction.
1276 ------------------------------------------------------------------------------- */
1278 same_currency BOOLEAN;
1279 currency_ratio NUMERIC;
1280 old_fund_currency TEXT;
1281 old_remaining NUMERIC; -- in currency of old fund
1282 new_fund_currency TEXT;
1283 new_fund_active BOOLEAN;
1284 new_remaining NUMERIC; -- in currency of new fund
1285 curr_old_amt NUMERIC; -- in currency of old fund
1286 curr_new_amt NUMERIC; -- in currency of new fund
1287 source_addition NUMERIC; -- in currency of funding source
1288 source_deduction NUMERIC; -- in currency of funding source
1289 orig_allocated_amt NUMERIC; -- in currency of funding source
1290 allocated_amt NUMERIC; -- in currency of fund
1296 IF old_fund IS NULL THEN
1297 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1300 IF old_amount IS NULL THEN
1301 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1304 -- The new fund and its amount must be both NULL or both not NULL.
1306 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1307 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1310 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1311 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1314 IF user_id IS NULL THEN
1315 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1318 -- Initialize the amounts to be transferred, each denominated
1319 -- in the currency of its respective fund. They will be
1320 -- reduced on each iteration of the loop.
1322 old_remaining := old_amount;
1323 new_remaining := new_amount;
1325 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1326 -- old_amount, old_fund, new_amount, new_fund;
1328 -- Get the currency types of the old and new funds.
1339 IF old_fund_currency IS NULL THEN
1340 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1343 IF new_fund IS NOT NULL THEN
1355 IF new_fund_currency IS NULL THEN
1356 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1357 ELSIF NOT new_fund_active THEN
1359 -- No point in putting money into a fund from whence you can't spend it
1361 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1364 IF new_amount = old_amount THEN
1365 same_currency := true;
1366 currency_ratio := 1;
1369 -- We'll have to translate currency between funds. We presume that
1370 -- the calling code has already applied an appropriate exchange rate,
1371 -- so we'll apply the same conversion to each sub-transfer.
1373 same_currency := false;
1374 currency_ratio := new_amount / old_amount;
1378 -- Identify the funding source(s) from which we want to transfer the money.
1379 -- The principle is that we want to transfer the newest money first, because
1380 -- we spend the oldest money first. The priority for spending is defined
1381 -- by a sort of the view acq.ordered_funding_source_credit.
1386 ofsc.funding_source,
1388 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1392 acq.ordered_funding_source_credit AS ofsc,
1393 acq.funding_source fs
1395 ofsc.funding_source = fs.id
1396 and ofsc.funding_source IN
1398 SELECT funding_source
1399 FROM acq.fund_allocation
1400 WHERE fund = old_fund
1404 -- ofsc.funding_source = funding_source_in
1405 -- OR funding_source_in IS NULL
1408 ofsc.sort_priority desc,
1409 ofsc.sort_date desc,
1413 -- Determine how much money the old fund got from this funding source,
1414 -- denominated in the currency types of the source and of the fund.
1415 -- This result may reflect transfers from previous iterations.
1418 COALESCE( sum( amount ), 0 ),
1419 COALESCE( sum( amount )
1420 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1422 orig_allocated_amt, -- in currency of the source
1423 allocated_amt -- in currency of the old fund
1428 and funding_source = source.funding_source;
1430 -- Determine how much to transfer from this credit, in the currency
1431 -- of the fund. Begin with the amount remaining to be attributed:
1433 curr_old_amt := old_remaining;
1435 -- Can't attribute more than was allocated from the fund:
1437 IF curr_old_amt > allocated_amt THEN
1438 curr_old_amt := allocated_amt;
1441 -- Can't attribute more than the amount of the current credit:
1443 IF curr_old_amt > source.converted_amt THEN
1444 curr_old_amt := source.converted_amt;
1447 curr_old_amt := trunc( curr_old_amt, 2 );
1449 old_remaining := old_remaining - curr_old_amt;
1451 -- Determine the amount to be deducted, if any,
1452 -- from the old allocation.
1454 IF old_remaining > 0 THEN
1456 -- In this case we're using the whole allocation, so use that
1457 -- amount directly instead of applying a currency translation
1458 -- and thereby inviting round-off errors.
1460 source_deduction := - curr_old_amt;
1462 source_deduction := trunc(
1463 ( - curr_old_amt ) *
1464 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1468 IF source_deduction <> 0 THEN
1470 -- Insert negative allocation for old fund in fund_allocation,
1471 -- converted into the currency of the funding source
1473 INSERT INTO acq.fund_allocation (
1480 source.funding_source,
1484 'Transfer to fund ' || new_fund
1488 IF new_fund IS NOT NULL THEN
1490 -- Determine how much to add to the new fund, in
1491 -- its currency, and how much remains to be added:
1493 IF same_currency THEN
1494 curr_new_amt := curr_old_amt;
1496 IF old_remaining = 0 THEN
1498 -- This is the last iteration, so nothing should be left
1500 curr_new_amt := new_remaining;
1503 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1504 new_remaining := new_remaining - curr_new_amt;
1508 -- Determine how much to add, if any,
1509 -- to the new fund's allocation.
1511 IF old_remaining > 0 THEN
1513 -- In this case we're using the whole allocation, so use that amount
1514 -- amount directly instead of applying a currency translation and
1515 -- thereby inviting round-off errors.
1517 source_addition := curr_new_amt;
1518 ELSIF source.currency_type = old_fund_currency THEN
1520 -- In this case we don't need a round trip currency translation,
1521 -- thereby inviting round-off errors:
1523 source_addition := curr_old_amt;
1525 source_addition := trunc(
1527 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1531 IF source_addition <> 0 THEN
1533 -- Insert positive allocation for new fund in fund_allocation,
1534 -- converted to the currency of the founding source
1536 INSERT INTO acq.fund_allocation (
1543 source.funding_source,
1547 'Transfer from fund ' || old_fund
1552 IF trunc( curr_old_amt, 2 ) <> 0
1553 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1555 -- Insert row in fund_transfer, using amounts in the currency of the funds
1557 INSERT INTO acq.fund_transfer (
1564 funding_source_credit
1567 trunc( curr_old_amt, 2 ),
1569 trunc( curr_new_amt, 2 ),
1576 if old_remaining <= 0 THEN
1577 EXIT; -- Nothing more to be transferred
1581 $$ LANGUAGE plpgsql;
1583 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1585 Function to attribute expenditures and encumbrances to funding source credits,
1586 and thereby to funding sources.
1588 Read the debits in chonological order, attributing each one to one or
1589 more funding source credits. Constraints:
1591 1. Don't attribute more to a credit than the amount of the credit.
1593 2. For a given fund, don't attribute more to a funding source than the
1594 source has allocated to that fund.
1596 3. Attribute debits to credits with deadlines before attributing them to
1597 credits without deadlines. Otherwise attribute to the earliest credits
1598 first, based on the deadline date when present, or on the effective date
1599 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1600 This ordering is defined by an ORDER BY clause on the view
1601 acq.ordered_funding_source_credit.
1603 Start by truncating the table acq.debit_attribution. Then insert a row
1604 into that table for each attribution. If a debit cannot be fully
1605 attributed, insert a row for the unattributable balance, with the
1606 funding_source_credit and credit_amount columns NULL.
1609 curr_fund_source_bal RECORD;
1610 seqno INT; -- sequence num for credits applicable to a fund
1611 fund_credit RECORD; -- current row in temp t_fund_credit table
1612 fc RECORD; -- used for loading t_fund_credit table
1613 sc RECORD; -- used for loading t_fund_credit table
1615 -- Used exclusively in the main loop:
1617 deb RECORD; -- current row from acq.fund_debit table
1618 curr_credit_bal RECORD; -- current row from temp t_credit table
1619 debit_balance NUMERIC; -- amount left to attribute for current debit
1620 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1621 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1622 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1623 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1624 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1625 attrib_count INT; -- populates id of acq.debit_attribution
1628 -- Load a temporary table. For each combination of fund and funding source,
1629 -- load an entry with the total amount allocated to that fund by that source.
1630 -- This sum may reflect transfers as well as original allocations. We will
1631 -- reduce this balance whenever we attribute debits to it.
1633 CREATE TEMP TABLE t_fund_source_bal
1637 funding_source AS source,
1638 sum( amount ) AS balance
1647 CREATE INDEX t_fund_source_bal_idx
1648 ON t_fund_source_bal( fund, source );
1649 -------------------------------------------------------------------------------
1651 -- Load another temporary table. For each fund, load zero or more
1652 -- funding source credits from which that fund can get money.
1654 CREATE TEMP TABLE t_fund_credit (
1661 SELECT DISTINCT fund
1662 FROM acq.fund_allocation
1664 LOOP -- Loop over the funds
1670 acq.ordered_funding_source_credit AS ofsc
1672 ofsc.funding_source IN
1674 SELECT funding_source
1675 FROM acq.fund_allocation
1676 WHERE fund = fc.fund
1682 LOOP -- Add each credit to the list
1683 INSERT INTO t_fund_credit (
1692 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1694 END LOOP; -- Loop over credits for a given fund
1695 END LOOP; -- Loop over funds
1697 CREATE INDEX t_fund_credit_idx
1698 ON t_fund_credit( fund, seq );
1699 -------------------------------------------------------------------------------
1701 -- Load yet another temporary table. This one is a list of funding source
1702 -- credits, with their balances. We shall reduce those balances as we
1703 -- attribute debits to them.
1705 CREATE TEMP TABLE t_credit
1709 fsc.funding_source AS source,
1710 fsc.amount AS balance,
1711 fs.currency_type AS currency_type
1713 acq.funding_source_credit AS fsc,
1714 acq.funding_source fs
1716 fsc.funding_source = fs.id
1719 CREATE INDEX t_credit_idx
1720 ON t_credit( credit );
1722 -------------------------------------------------------------------------------
1724 -- Now that we have loaded the lookup tables: loop through the debits,
1725 -- attributing each one to one or more funding source credits.
1727 truncate table acq.debit_attribution;
1745 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1747 debit_balance := deb.amount;
1749 -- Loop over the funding source credits that are eligible
1750 -- to pay for this debit
1762 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1764 -- Look up the balance for this credit. If it's zero, then
1765 -- it's not useful, so treat it as if you didn't find it.
1766 -- (Actually there shouldn't be any zero balances in the table,
1767 -- but we check just to make sure.)
1770 INTO curr_credit_bal
1773 credit = fund_credit.credit
1776 IF curr_credit_bal IS NULL THEN
1778 -- This credit is exhausted; try the next one.
1784 -- At this point we have an applicable credit with some money left.
1785 -- Now see if the relevant funding_source has any money left.
1787 -- Look up the balance of the allocation for this combination of
1788 -- fund and source. If you find such an entry, but it has a zero
1789 -- balance, then it's not useful, so treat it as unfound.
1790 -- (Actually there shouldn't be any zero balances in the table,
1791 -- but we check just to make sure.)
1794 INTO curr_fund_source_bal
1795 FROM t_fund_source_bal
1798 AND source = curr_credit_bal.source
1801 IF curr_fund_source_bal IS NULL THEN
1803 -- This fund/source doesn't exist or is already exhausted,
1804 -- so we can't use this credit. Go on to the next one.
1809 -- Convert the available balances to the currency of the fund
1811 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1812 curr_credit_bal.currency_type, deb.currency_type );
1813 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1814 curr_credit_bal.currency_type, deb.currency_type );
1816 -- Determine how much we can attribute to this credit: the minimum
1817 -- of the debit amount, the fund/source balance, and the
1820 --RAISE NOTICE ' deb bal %', debit_balance;
1821 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1822 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1824 conv_attr_amount := NULL;
1825 attr_amount := debit_balance;
1827 IF attr_amount > conv_alloc_balance THEN
1828 attr_amount := conv_alloc_balance;
1829 conv_attr_amount := curr_fund_source_bal.balance;
1831 IF attr_amount > conv_cred_balance THEN
1832 attr_amount := conv_cred_balance;
1833 conv_attr_amount := curr_credit_bal.balance;
1836 -- If we're attributing all of one of the balances, then that's how
1837 -- much we will deduct from the balances, and we already captured
1838 -- that amount above. Otherwise we must convert the amount of the
1839 -- attribution from the currency of the fund back to the currency of
1840 -- the funding source.
1842 IF conv_attr_amount IS NULL THEN
1843 conv_attr_amount := attr_amount * acq.exchange_ratio(
1844 deb.currency_type, curr_credit_bal.currency_type );
1847 -- Insert a row to record the attribution
1849 attrib_count := attrib_count + 1;
1850 INSERT INTO acq.debit_attribution (
1854 funding_source_credit,
1860 curr_credit_bal.credit,
1864 -- Subtract the attributed amount from the various balances
1866 debit_balance := debit_balance - attr_amount;
1867 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1869 IF curr_fund_source_bal.balance <= 0 THEN
1871 -- This allocation is exhausted. Delete it so
1872 -- that we don't waste time looking at it again.
1874 DELETE FROM t_fund_source_bal
1876 fund = curr_fund_source_bal.fund
1877 AND source = curr_fund_source_bal.source;
1879 UPDATE t_fund_source_bal
1880 SET balance = balance - conv_attr_amount
1882 fund = curr_fund_source_bal.fund
1883 AND source = curr_fund_source_bal.source;
1886 IF curr_credit_bal.balance <= 0 THEN
1888 -- This funding source credit is exhausted. Delete it
1889 -- so that we don't waste time looking at it again.
1891 --DELETE FROM t_credit
1893 -- credit = curr_credit_bal.credit;
1895 DELETE FROM t_fund_credit
1897 credit = curr_credit_bal.credit;
1900 SET balance = curr_credit_bal.balance
1902 credit = curr_credit_bal.credit;
1905 -- Are we done with this debit yet?
1907 IF debit_balance <= 0 THEN
1908 EXIT; -- We've fully attributed this debit; stop looking at credits.
1910 END LOOP; -- End loop over credits
1912 IF debit_balance <> 0 THEN
1914 -- We weren't able to attribute this debit, or at least not
1915 -- all of it. Insert a row for the unattributed balance.
1917 attrib_count := attrib_count + 1;
1918 INSERT INTO acq.debit_attribution (
1922 funding_source_credit,
1932 END LOOP; -- End of loop over debits
1934 $$ LANGUAGE 'plpgsql';
1936 CREATE OR REPLACE FUNCTION acq.copy_fund_tags(
1937 old_fund_id INTEGER,
1939 ) RETURNS VOID AS $$
1941 fund_tag_rec RECORD;
1944 FOR fund_tag_rec IN SELECT * FROM acq.fund_tag_map WHERE fund=old_fund_id LOOP
1946 INSERT INTO acq.fund_tag_map(fund, tag) VALUES(new_fund_id, fund_tag_rec.tag);
1948 WHEN unique_violation THEN
1949 -- RAISE NOTICE 'Fund tag already propagated', old_fund.id;
1955 $$ LANGUAGE plpgsql;
1957 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1960 org_unit_id INTEGER,
1961 include_desc BOOL DEFAULT TRUE
1962 ) RETURNS VOID AS $$
1973 IF old_year IS NULL THEN
1974 RAISE EXCEPTION 'Input year argument is NULL';
1975 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1976 RAISE EXCEPTION 'Input year is out of range';
1979 IF user_id IS NULL THEN
1980 RAISE EXCEPTION 'Input user id argument is NULL';
1983 IF org_unit_id IS NULL THEN
1984 RAISE EXCEPTION 'Org unit id argument is NULL';
1986 SELECT TRUE INTO org_found
1988 WHERE id = org_unit_id;
1990 IF org_found IS NULL THEN
1991 RAISE EXCEPTION 'Org unit id is invalid';
1995 -- Loop over the applicable funds
1997 FOR old_fund in SELECT * FROM acq.fund
2001 AND ( ( include_desc AND org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2002 OR (NOT include_desc AND org = org_unit_id ) )
2006 INSERT INTO acq.fund (
2014 balance_warning_percent,
2015 balance_stop_percent
2020 old_fund.currency_type,
2024 old_fund.balance_warning_percent,
2025 old_fund.balance_stop_percent
2027 RETURNING id INTO new_id;
2029 WHEN unique_violation THEN
2030 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2034 PERFORM acq.copy_fund_tags(old_fund.id,new_id);
2036 --RAISE NOTICE 'Propagating fund % to fund %',
2037 -- old_fund.code, new_id;
2040 $$ LANGUAGE plpgsql;
2042 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER ) RETURNS VOID AS $$
2043 SELECT acq.propagate_funds_by_org_tree( $1, $2, $3, FALSE );
2046 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2049 org_unit_id INTEGER,
2050 encumb_only BOOL DEFAULT FALSE,
2051 include_desc BOOL DEFAULT TRUE
2052 ) RETURNS VOID AS $$
2056 new_year INT := old_year + 1;
2059 xfer_amount NUMERIC := 0;
2063 roll_distrib_forms BOOL;
2069 IF old_year IS NULL THEN
2070 RAISE EXCEPTION 'Input year argument is NULL';
2071 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2072 RAISE EXCEPTION 'Input year is out of range';
2075 IF user_id IS NULL THEN
2076 RAISE EXCEPTION 'Input user id argument is NULL';
2079 IF org_unit_id IS NULL THEN
2080 RAISE EXCEPTION 'Org unit id argument is NULL';
2083 -- Validate the org unit
2088 WHERE id = org_unit_id;
2090 IF org_found IS NULL THEN
2091 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2092 ELSIF encumb_only THEN
2093 SELECT INTO perm_ous value::BOOL FROM
2094 actor.org_unit_ancestor_setting(
2095 'acq.fund.allow_rollover_without_money', org_unit_id
2097 IF NOT FOUND OR NOT perm_ous THEN
2098 RAISE EXCEPTION 'Encumbrance-only rollover not permitted at org %', org_unit_id;
2103 -- Loop over the propagable funds to identify the details
2104 -- from the old fund plus the id of the new one, if it exists.
2108 oldf.id AS old_fund,
2114 newf.id AS new_fund_id
2117 LEFT JOIN acq.fund AS newf
2118 ON ( oldf.code = newf.code )
2120 oldf.year = old_year
2122 AND newf.year = new_year
2123 AND ( ( include_desc AND oldf.org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2124 OR (NOT include_desc AND oldf.org = org_unit_id ) )
2126 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2128 IF roll_fund.new_fund_id IS NULL THEN
2130 -- The old fund hasn't been propagated yet. Propagate it now.
2132 INSERT INTO acq.fund (
2140 balance_warning_percent,
2141 balance_stop_percent
2146 roll_fund.currency_type,
2150 roll_fund.balance_warning_percent,
2151 roll_fund.balance_stop_percent
2153 RETURNING id INTO new_fund;
2155 PERFORM acq.copy_fund_tags(roll_fund.id,new_fund);
2158 new_fund = roll_fund.new_fund_id;
2161 -- Determine the amount to transfer
2165 FROM acq.fund_spent_balance
2166 WHERE fund = roll_fund.old_fund;
2168 IF xfer_amount <> 0 THEN
2169 IF NOT encumb_only AND roll_fund.rollover THEN
2171 -- Transfer balance from old fund to new
2173 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2175 PERFORM acq.transfer_fund(
2185 -- Transfer balance from old fund to the void
2187 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2189 PERFORM acq.transfer_fund(
2195 'Rollover into the void'
2200 IF roll_fund.rollover THEN
2202 -- Move any lineitems from the old fund to the new one
2203 -- where the associated debit is an encumbrance.
2205 -- Any other tables tying expenditure details to funds should
2206 -- receive similar treatment. At this writing there are none.
2208 UPDATE acq.lineitem_detail
2211 fund = roll_fund.old_fund -- this condition may be redundant
2217 fund = roll_fund.old_fund
2221 -- Move encumbrance debits from the old fund to the new fund
2223 UPDATE acq.fund_debit
2226 fund = roll_fund.old_fund
2230 -- Rollover distribution formulae funds
2231 SELECT INTO roll_distrib_forms value::BOOL FROM
2232 actor.org_unit_ancestor_setting(
2233 'acq.fund.rollover_distrib_forms', org_unit_id
2236 IF roll_distrib_forms THEN
2237 UPDATE acq.distribution_formula_entry
2238 SET fund = roll_fund.new_fund_id
2239 WHERE fund = roll_fund.old_fund;
2243 -- Mark old fund as inactive, now that we've closed it
2247 WHERE id = roll_fund.old_fund;
2250 $$ LANGUAGE plpgsql;
2255 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER, encumb_only BOOL DEFAULT FALSE ) RETURNS VOID AS $$
2256 SELECT acq.rollover_funds_by_org_tree( $1, $2, $3, $4, FALSE );
2259 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2260 SELECT funding_source,
2261 SUM(amount) AS amount
2262 FROM acq.funding_source_credit
2265 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2266 SELECT funding_source,
2267 SUM(a.amount)::NUMERIC(100,2) AS amount
2268 FROM acq.fund_allocation a
2271 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2272 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2273 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2274 FROM acq.funding_source_credit_total c
2275 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2278 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2280 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2281 FROM acq.fund_allocation a
2282 JOIN acq.fund f ON (a.fund = f.id)
2283 JOIN acq.funding_source s ON (a.funding_source = s.id)
2286 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2287 SELECT fund.id AS fund,
2288 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2290 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2293 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2296 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2298 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2299 WHERE fund_debit.encumbrance GROUP BY fund.id;
2301 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2302 SELECT fund.id AS fund,
2303 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2305 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2306 WHERE NOT fund_debit.encumbrance
2309 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2311 c.amount - COALESCE(d.amount, 0.0) AS amount
2312 FROM acq.fund_allocation_total c
2313 LEFT JOIN acq.fund_debit_total d USING (fund);
2315 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2317 c.amount - COALESCE(d.amount,0.0) AS amount
2318 FROM acq.fund_allocation_total c
2319 LEFT JOIN acq.fund_spent_total d USING (fund);
2321 -- For each fund: the total allocation from all sources, in the
2322 -- currency of the fund (or 0 if there are no allocations)
2324 CREATE VIEW acq.all_fund_allocation_total AS
2327 COALESCE( SUM( a.amount * acq.exchange_ratio(
2328 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2332 LEFT JOIN acq.fund_allocation a
2334 LEFT JOIN acq.funding_source s
2335 ON a.funding_source = s.id
2339 -- For every fund: the total encumbrances (or 0 if none),
2340 -- in the currency of the fund.
2342 CREATE VIEW acq.all_fund_encumbrance_total AS
2345 COALESCE( encumb.amount, 0 ) AS amount
2351 sum( amount ) AS amount
2358 ON f.id = encumb.fund;
2360 -- For every fund: the total spent (or 0 if none),
2361 -- in the currency of the fund.
2363 CREATE VIEW acq.all_fund_spent_total AS
2366 COALESCE( spent.amount, 0 ) AS amount
2372 sum( amount ) AS amount
2379 ON f.id = spent.fund;
2381 -- For each fund: the amount not yet spent, in the currency
2382 -- of the fund. May include encumbrances.
2384 CREATE VIEW acq.all_fund_spent_balance AS
2387 c.amount - d.amount AS amount
2388 FROM acq.all_fund_allocation_total c
2389 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2391 -- For each fund: the amount neither spent nor encumbered,
2392 -- in the currency of the fund
2394 CREATE VIEW acq.all_fund_combined_balance AS
2397 a.amount - COALESCE( c.amount, 0 ) AS amount
2399 acq.all_fund_allocation_total a
2403 SUM( amount ) AS amount
2408 ) AS c USING ( fund );
2410 CREATE TABLE acq.claim_type (
2411 id SERIAL PRIMARY KEY,
2412 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2413 DEFERRABLE INITIALLY DEFERRED,
2415 description TEXT NOT NULL,
2416 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2419 CREATE TABLE acq.claim (
2420 id SERIAL PRIMARY KEY,
2421 type INT NOT NULL REFERENCES acq.claim_type
2422 DEFERRABLE INITIALLY DEFERRED,
2423 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2424 DEFERRABLE INITIALLY DEFERRED
2427 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2429 CREATE TABLE acq.claim_event (
2430 id BIGSERIAL PRIMARY KEY,
2431 type INT NOT NULL REFERENCES acq.claim_event_type
2432 DEFERRABLE INITIALLY DEFERRED,
2433 claim SERIAL NOT NULL REFERENCES acq.claim
2434 DEFERRABLE INITIALLY DEFERRED,
2435 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2436 creator INT NOT NULL REFERENCES actor.usr
2437 DEFERRABLE INITIALLY DEFERRED,
2441 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2443 -- And the serials version of claiming
2444 CREATE TABLE acq.serial_claim (
2445 id SERIAL PRIMARY KEY,
2446 type INT NOT NULL REFERENCES acq.claim_type
2447 DEFERRABLE INITIALLY DEFERRED,
2448 item BIGINT NOT NULL REFERENCES serial.item
2449 DEFERRABLE INITIALLY DEFERRED
2452 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2454 CREATE TABLE acq.serial_claim_event (
2455 id BIGSERIAL PRIMARY KEY,
2456 type INT NOT NULL REFERENCES acq.claim_event_type
2457 DEFERRABLE INITIALLY DEFERRED,
2458 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2459 DEFERRABLE INITIALLY DEFERRED,
2460 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2461 creator INT NOT NULL REFERENCES actor.usr
2462 DEFERRABLE INITIALLY DEFERRED,
2466 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );
2468 CREATE OR REPLACE VIEW acq.lineitem_summary AS
2472 SELECT COUNT(lid.id)
2473 FROM acq.lineitem_detail lid
2474 WHERE lineitem = li.id
2477 SELECT COUNT(lid.id)
2478 FROM acq.lineitem_detail lid
2479 WHERE recv_time IS NOT NULL AND lineitem = li.id
2482 SELECT COUNT(lid.id)
2483 FROM acq.lineitem_detail lid
2484 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2485 WHERE acqcr.keep_debits IS FALSE AND lineitem = li.id
2488 SELECT COUNT(lid.id)
2489 FROM acq.lineitem_detail lid
2490 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2491 WHERE acqcr.keep_debits IS TRUE AND lineitem = li.id
2494 SELECT COUNT(lid.id)
2495 FROM acq.lineitem_detail lid
2496 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2497 WHERE NOT debit.encumbrance AND lineitem = li.id
2500 SELECT COUNT(DISTINCT(lid.id))
2501 FROM acq.lineitem_detail lid
2502 JOIN acq.claim claim ON (claim.lineitem_detail = lid.id)
2503 WHERE lineitem = li.id
2506 SELECT (COUNT(lid.id) * li.estimated_unit_price)::NUMERIC(8,2)
2507 FROM acq.lineitem_detail lid
2508 WHERE lid.cancel_reason IS NULL AND lineitem = li.id
2509 ) AS estimated_amount,
2511 SELECT SUM(debit.amount)::NUMERIC(8,2)
2512 FROM acq.lineitem_detail lid
2513 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2514 WHERE debit.encumbrance AND lineitem = li.id
2515 ) AS encumbrance_amount,
2517 SELECT SUM(debit.amount)::NUMERIC(8,2)
2518 FROM acq.lineitem_detail lid
2519 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2520 WHERE NOT debit.encumbrance AND lineitem = li.id
2523 FROM acq.lineitem AS li;