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 TABLE acq.invoice_item_type (
846 code TEXT PRIMARY KEY,
847 name TEXT NOT NULL, -- i18n-ize
848 prorate BOOL NOT NULL DEFAULT FALSE
851 CREATE TABLE acq.po_item (
852 id SERIAL PRIMARY KEY,
853 purchase_order INT REFERENCES acq.purchase_order (id)
854 ON UPDATE CASCADE ON DELETE SET NULL
855 DEFERRABLE INITIALLY DEFERRED,
856 fund_debit INT REFERENCES acq.fund_debit (id)
857 DEFERRABLE INITIALLY DEFERRED,
858 inv_item_type TEXT NOT NULL
859 REFERENCES acq.invoice_item_type (code)
860 DEFERRABLE INITIALLY DEFERRED,
864 estimated_cost NUMERIC(8,2),
865 fund INT REFERENCES acq.fund (id)
866 DEFERRABLE INITIALLY DEFERRED,
870 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
871 id SERIAL PRIMARY KEY,
872 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
873 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
874 fund_debit INT REFERENCES acq.fund_debit (id),
875 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
879 cost_billed NUMERIC(8,2),
880 actual_cost NUMERIC(8,2),
881 fund INT REFERENCES acq.fund (id)
882 DEFERRABLE INITIALLY DEFERRED,
883 amount_paid NUMERIC (8,2),
884 po_item INT REFERENCES acq.po_item (id)
885 DEFERRABLE INITIALLY DEFERRED,
890 CREATE TABLE acq.user_request_type (
891 id SERIAL PRIMARY KEY,
892 label TEXT NOT NULL UNIQUE -- i18n-ize
895 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
896 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
897 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
898 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
899 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
901 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
903 CREATE TABLE acq.user_request (
904 id SERIAL PRIMARY KEY,
905 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
906 hold BOOL NOT NULL DEFAULT TRUE,
908 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
909 holdable_formats TEXT, -- nullable, for use in hold creation
911 email_notify BOOL NOT NULL DEFAULT TRUE,
912 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
913 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
914 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
915 need_before TIMESTAMPTZ, -- don't create holds after this
918 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
930 cancel_reason INT REFERENCES acq.cancel_reason( id )
931 DEFERRABLE INITIALLY DEFERRED
937 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
938 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
941 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
944 SELECT COUNT(*) INTO counter
945 FROM oils_xpath_table(
949 '//*[@tag="' || tag || '"]',
951 ) as t(i int,c text);
953 FOR i IN 1 .. counter LOOP
956 FROM ( SELECT id,i,t,v
957 FROM oils_xpath_table(
961 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
962 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
964 ) as t(id int,t text,v text)
975 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
976 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
980 lida acq.flat_lineitem_detail%ROWTYPE;
982 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
983 IF NOT FOUND THEN RETURN; END IF;
985 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
986 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
993 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
994 JOIN acq.provider_holding_subfield_map a USING (subfield)
995 WHERE a.provider = prov_i
1002 $$ LANGUAGE PLPGSQL;
1004 -- select * from acq.extract_provider_holding_data(699);
1006 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1007 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1011 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1012 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1015 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1016 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1020 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1023 Suggested vendor fields:
1031 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1040 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1042 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1044 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1045 IF (atype = 'lineitem_provider_attr_definition') THEN
1046 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1047 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1050 IF (atype = 'lineitem_provider_attr_definition') THEN
1051 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1052 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1053 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1054 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1055 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1058 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1060 IF (adef.code = 'title' OR adef.code = 'author') THEN
1061 -- title and author should not be split
1062 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1063 -- string-join in the xpath and remove this special case
1064 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1065 IF (value IS NOT NULL AND value <> '') THEN
1066 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1067 VALUES (NEW.id, adef.id, atype, adef.code, value);
1073 SELECT extract_acq_marc_field(id, xpath_string || '[' || pos || ']', 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);
1092 $function$ LANGUAGE PLPGSQL;
1094 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1096 IF TG_OP = 'UPDATE' THEN
1097 DELETE FROM acq.lineitem_attr
1098 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1101 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1105 $$ LANGUAGE PLPGSQL;
1107 CREATE TRIGGER cleanup_lineitem_trigger
1108 BEFORE UPDATE OR DELETE ON acq.lineitem
1109 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1111 CREATE TRIGGER ingest_lineitem_trigger
1112 AFTER INSERT OR UPDATE ON acq.lineitem
1113 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1115 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1119 IF from_ex = to_ex THEN
1123 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1128 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1137 $$ LANGUAGE PLPGSQL;
1139 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1140 SELECT $3 * acq.exchange_ratio($1, $2);
1143 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1145 Examine the acq.fiscal_year table, comparing successive years.
1146 Report any inconsistencies, i.e. years that overlap, have gaps
1147 between them, or are out of sequence.
1149 RETURNS SETOF RECORD AS $$
1173 ELSIF curr_year.calendar = prev_year.calendar THEN
1174 IF curr_year.year_begin > prev_year.year_end THEN
1175 -- This ugly kludge works around the fact that older
1176 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1177 FOR return_rec IN SELECT
1180 'Gap between fiscal years'::TEXT
1182 RETURN NEXT return_rec;
1184 ELSIF curr_year.year_begin < prev_year.year_end THEN
1185 FOR return_rec IN SELECT
1188 'Overlapping fiscal years'::TEXT
1190 RETURN NEXT return_rec;
1192 ELSIF curr_year.year < prev_year.year THEN
1193 FOR return_rec IN SELECT
1196 'Fiscal years out of order'::TEXT
1198 RETURN NEXT return_rec;
1203 prev_year := curr_year;
1208 $$ LANGUAGE plpgsql;
1210 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1212 old_amount IN NUMERIC, -- in currency of old fund
1214 new_amount IN NUMERIC, -- in currency of new fund
1216 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1217 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1218 ) RETURNS VOID AS $$
1219 /* -------------------------------------------------------------------------------
1221 Function to transfer money from one fund to another.
1223 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1224 negative amount for the old (losing) fund and a positive amount for the new
1225 (gaining) fund. In some cases there may be more than one such pair of entries
1226 in order to pull the money from different funding sources, or more specifically
1227 from different funding source credits. For each such pair there is also an
1228 entry in acq.fund_transfer.
1230 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1231 choose a funding source for the transferred money to come from. This choice
1232 must meet two constraints, so far as possible:
1234 1. The amount transferred from a given funding source must not exceed the
1235 amount allocated to the old fund by the funding source. To that end we
1236 compare the amount being transferred to the amount allocated.
1238 2. We shouldn't transfer money that has already been spent or encumbered, as
1239 defined by the funding attribution process. We attribute expenses to the
1240 oldest funding source credits first. In order to avoid transferring that
1241 attributed money, we reverse the priority, transferring from the newest funding
1242 source credits first. There can be no guarantee that this approach will
1243 avoid overcommitting a fund, but no other approach can do any better.
1245 In this context the age of a funding source credit is defined by the
1246 deadline_date for credits with deadline_dates, and by the effective_date for
1247 credits without deadline_dates, with the proviso that credits with deadline_dates
1248 are all considered "older" than those without.
1252 In the signature for this function, there is one last parameter commented out,
1253 named "funding_source_in". Correspondingly, the WHERE clause for the query
1254 driving the main loop has an OR clause commented out, which references the
1255 funding_source_in parameter.
1257 If these lines are uncommented, this function will allow the user optionally to
1258 restrict a fund transfer to a specified funding source. If the source
1259 parameter is left NULL, then there will be no such restriction.
1261 ------------------------------------------------------------------------------- */
1263 same_currency BOOLEAN;
1264 currency_ratio NUMERIC;
1265 old_fund_currency TEXT;
1266 old_remaining NUMERIC; -- in currency of old fund
1267 new_fund_currency TEXT;
1268 new_fund_active BOOLEAN;
1269 new_remaining NUMERIC; -- in currency of new fund
1270 curr_old_amt NUMERIC; -- in currency of old fund
1271 curr_new_amt NUMERIC; -- in currency of new fund
1272 source_addition NUMERIC; -- in currency of funding source
1273 source_deduction NUMERIC; -- in currency of funding source
1274 orig_allocated_amt NUMERIC; -- in currency of funding source
1275 allocated_amt NUMERIC; -- in currency of fund
1281 IF old_fund IS NULL THEN
1282 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1285 IF old_amount IS NULL THEN
1286 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1289 -- The new fund and its amount must be both NULL or both not NULL.
1291 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1292 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1295 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1296 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1299 IF user_id IS NULL THEN
1300 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1303 -- Initialize the amounts to be transferred, each denominated
1304 -- in the currency of its respective fund. They will be
1305 -- reduced on each iteration of the loop.
1307 old_remaining := old_amount;
1308 new_remaining := new_amount;
1310 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1311 -- old_amount, old_fund, new_amount, new_fund;
1313 -- Get the currency types of the old and new funds.
1324 IF old_fund_currency IS NULL THEN
1325 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1328 IF new_fund IS NOT NULL THEN
1340 IF new_fund_currency IS NULL THEN
1341 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1342 ELSIF NOT new_fund_active THEN
1344 -- No point in putting money into a fund from whence you can't spend it
1346 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1349 IF new_amount = old_amount THEN
1350 same_currency := true;
1351 currency_ratio := 1;
1354 -- We'll have to translate currency between funds. We presume that
1355 -- the calling code has already applied an appropriate exchange rate,
1356 -- so we'll apply the same conversion to each sub-transfer.
1358 same_currency := false;
1359 currency_ratio := new_amount / old_amount;
1363 -- Identify the funding source(s) from which we want to transfer the money.
1364 -- The principle is that we want to transfer the newest money first, because
1365 -- we spend the oldest money first. The priority for spending is defined
1366 -- by a sort of the view acq.ordered_funding_source_credit.
1371 ofsc.funding_source,
1373 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1377 acq.ordered_funding_source_credit AS ofsc,
1378 acq.funding_source fs
1380 ofsc.funding_source = fs.id
1381 and ofsc.funding_source IN
1383 SELECT funding_source
1384 FROM acq.fund_allocation
1385 WHERE fund = old_fund
1389 -- ofsc.funding_source = funding_source_in
1390 -- OR funding_source_in IS NULL
1393 ofsc.sort_priority desc,
1394 ofsc.sort_date desc,
1398 -- Determine how much money the old fund got from this funding source,
1399 -- denominated in the currency types of the source and of the fund.
1400 -- This result may reflect transfers from previous iterations.
1403 COALESCE( sum( amount ), 0 ),
1404 COALESCE( sum( amount )
1405 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1407 orig_allocated_amt, -- in currency of the source
1408 allocated_amt -- in currency of the old fund
1413 and funding_source = source.funding_source;
1415 -- Determine how much to transfer from this credit, in the currency
1416 -- of the fund. Begin with the amount remaining to be attributed:
1418 curr_old_amt := old_remaining;
1420 -- Can't attribute more than was allocated from the fund:
1422 IF curr_old_amt > allocated_amt THEN
1423 curr_old_amt := allocated_amt;
1426 -- Can't attribute more than the amount of the current credit:
1428 IF curr_old_amt > source.converted_amt THEN
1429 curr_old_amt := source.converted_amt;
1432 curr_old_amt := trunc( curr_old_amt, 2 );
1434 old_remaining := old_remaining - curr_old_amt;
1436 -- Determine the amount to be deducted, if any,
1437 -- from the old allocation.
1439 IF old_remaining > 0 THEN
1441 -- In this case we're using the whole allocation, so use that
1442 -- amount directly instead of applying a currency translation
1443 -- and thereby inviting round-off errors.
1445 source_deduction := - orig_allocated_amt;
1447 source_deduction := trunc(
1448 ( - curr_old_amt ) *
1449 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1453 IF source_deduction <> 0 THEN
1455 -- Insert negative allocation for old fund in fund_allocation,
1456 -- converted into the currency of the funding source
1458 INSERT INTO acq.fund_allocation (
1465 source.funding_source,
1469 'Transfer to fund ' || new_fund
1473 IF new_fund IS NOT NULL THEN
1475 -- Determine how much to add to the new fund, in
1476 -- its currency, and how much remains to be added:
1478 IF same_currency THEN
1479 curr_new_amt := curr_old_amt;
1481 IF old_remaining = 0 THEN
1483 -- This is the last iteration, so nothing should be left
1485 curr_new_amt := new_remaining;
1488 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1489 new_remaining := new_remaining - curr_new_amt;
1493 -- Determine how much to add, if any,
1494 -- to the new fund's allocation.
1496 IF old_remaining > 0 THEN
1498 -- In this case we're using the whole allocation, so use that amount
1499 -- amount directly instead of applying a currency translation and
1500 -- thereby inviting round-off errors.
1502 source_addition := orig_allocated_amt;
1503 ELSIF source.currency_type = old_fund_currency THEN
1505 -- In this case we don't need a round trip currency translation,
1506 -- thereby inviting round-off errors:
1508 source_addition := curr_old_amt;
1510 source_addition := trunc(
1512 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1516 IF source_addition <> 0 THEN
1518 -- Insert positive allocation for new fund in fund_allocation,
1519 -- converted to the currency of the founding source
1521 INSERT INTO acq.fund_allocation (
1528 source.funding_source,
1532 'Transfer from fund ' || old_fund
1537 IF trunc( curr_old_amt, 2 ) <> 0
1538 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1540 -- Insert row in fund_transfer, using amounts in the currency of the funds
1542 INSERT INTO acq.fund_transfer (
1549 funding_source_credit
1552 trunc( curr_old_amt, 2 ),
1554 trunc( curr_new_amt, 2 ),
1561 if old_remaining <= 0 THEN
1562 EXIT; -- Nothing more to be transferred
1566 $$ LANGUAGE plpgsql;
1568 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1570 Function to attribute expenditures and encumbrances to funding source credits,
1571 and thereby to funding sources.
1573 Read the debits in chonological order, attributing each one to one or
1574 more funding source credits. Constraints:
1576 1. Don't attribute more to a credit than the amount of the credit.
1578 2. For a given fund, don't attribute more to a funding source than the
1579 source has allocated to that fund.
1581 3. Attribute debits to credits with deadlines before attributing them to
1582 credits without deadlines. Otherwise attribute to the earliest credits
1583 first, based on the deadline date when present, or on the effective date
1584 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1585 This ordering is defined by an ORDER BY clause on the view
1586 acq.ordered_funding_source_credit.
1588 Start by truncating the table acq.debit_attribution. Then insert a row
1589 into that table for each attribution. If a debit cannot be fully
1590 attributed, insert a row for the unattributable balance, with the
1591 funding_source_credit and credit_amount columns NULL.
1594 curr_fund_source_bal RECORD;
1595 seqno INT; -- sequence num for credits applicable to a fund
1596 fund_credit RECORD; -- current row in temp t_fund_credit table
1597 fc RECORD; -- used for loading t_fund_credit table
1598 sc RECORD; -- used for loading t_fund_credit table
1600 -- Used exclusively in the main loop:
1602 deb RECORD; -- current row from acq.fund_debit table
1603 curr_credit_bal RECORD; -- current row from temp t_credit table
1604 debit_balance NUMERIC; -- amount left to attribute for current debit
1605 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1606 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1607 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1608 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1609 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1610 attrib_count INT; -- populates id of acq.debit_attribution
1613 -- Load a temporary table. For each combination of fund and funding source,
1614 -- load an entry with the total amount allocated to that fund by that source.
1615 -- This sum may reflect transfers as well as original allocations. We will
1616 -- reduce this balance whenever we attribute debits to it.
1618 CREATE TEMP TABLE t_fund_source_bal
1622 funding_source AS source,
1623 sum( amount ) AS balance
1632 CREATE INDEX t_fund_source_bal_idx
1633 ON t_fund_source_bal( fund, source );
1634 -------------------------------------------------------------------------------
1636 -- Load another temporary table. For each fund, load zero or more
1637 -- funding source credits from which that fund can get money.
1639 CREATE TEMP TABLE t_fund_credit (
1646 SELECT DISTINCT fund
1647 FROM acq.fund_allocation
1649 LOOP -- Loop over the funds
1655 acq.ordered_funding_source_credit AS ofsc
1657 ofsc.funding_source IN
1659 SELECT funding_source
1660 FROM acq.fund_allocation
1661 WHERE fund = fc.fund
1667 LOOP -- Add each credit to the list
1668 INSERT INTO t_fund_credit (
1677 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1679 END LOOP; -- Loop over credits for a given fund
1680 END LOOP; -- Loop over funds
1682 CREATE INDEX t_fund_credit_idx
1683 ON t_fund_credit( fund, seq );
1684 -------------------------------------------------------------------------------
1686 -- Load yet another temporary table. This one is a list of funding source
1687 -- credits, with their balances. We shall reduce those balances as we
1688 -- attribute debits to them.
1690 CREATE TEMP TABLE t_credit
1694 fsc.funding_source AS source,
1695 fsc.amount AS balance,
1696 fs.currency_type AS currency_type
1698 acq.funding_source_credit AS fsc,
1699 acq.funding_source fs
1701 fsc.funding_source = fs.id
1704 CREATE INDEX t_credit_idx
1705 ON t_credit( credit );
1707 -------------------------------------------------------------------------------
1709 -- Now that we have loaded the lookup tables: loop through the debits,
1710 -- attributing each one to one or more funding source credits.
1712 truncate table acq.debit_attribution;
1730 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1732 debit_balance := deb.amount;
1734 -- Loop over the funding source credits that are eligible
1735 -- to pay for this debit
1747 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1749 -- Look up the balance for this credit. If it's zero, then
1750 -- it's not useful, so treat it as if you didn't find it.
1751 -- (Actually there shouldn't be any zero balances in the table,
1752 -- but we check just to make sure.)
1755 INTO curr_credit_bal
1758 credit = fund_credit.credit
1761 IF curr_credit_bal IS NULL THEN
1763 -- This credit is exhausted; try the next one.
1769 -- At this point we have an applicable credit with some money left.
1770 -- Now see if the relevant funding_source has any money left.
1772 -- Look up the balance of the allocation for this combination of
1773 -- fund and source. If you find such an entry, but it has a zero
1774 -- balance, then it's not useful, so treat it as unfound.
1775 -- (Actually there shouldn't be any zero balances in the table,
1776 -- but we check just to make sure.)
1779 INTO curr_fund_source_bal
1780 FROM t_fund_source_bal
1783 AND source = curr_credit_bal.source
1786 IF curr_fund_source_bal IS NULL THEN
1788 -- This fund/source doesn't exist or is already exhausted,
1789 -- so we can't use this credit. Go on to the next one.
1794 -- Convert the available balances to the currency of the fund
1796 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1797 curr_credit_bal.currency_type, deb.currency_type );
1798 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1799 curr_credit_bal.currency_type, deb.currency_type );
1801 -- Determine how much we can attribute to this credit: the minimum
1802 -- of the debit amount, the fund/source balance, and the
1805 --RAISE NOTICE ' deb bal %', debit_balance;
1806 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1807 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1809 conv_attr_amount := NULL;
1810 attr_amount := debit_balance;
1812 IF attr_amount > conv_alloc_balance THEN
1813 attr_amount := conv_alloc_balance;
1814 conv_attr_amount := curr_fund_source_bal.balance;
1816 IF attr_amount > conv_cred_balance THEN
1817 attr_amount := conv_cred_balance;
1818 conv_attr_amount := curr_credit_bal.balance;
1821 -- If we're attributing all of one of the balances, then that's how
1822 -- much we will deduct from the balances, and we already captured
1823 -- that amount above. Otherwise we must convert the amount of the
1824 -- attribution from the currency of the fund back to the currency of
1825 -- the funding source.
1827 IF conv_attr_amount IS NULL THEN
1828 conv_attr_amount := attr_amount * acq.exchange_ratio(
1829 deb.currency_type, curr_credit_bal.currency_type );
1832 -- Insert a row to record the attribution
1834 attrib_count := attrib_count + 1;
1835 INSERT INTO acq.debit_attribution (
1839 funding_source_credit,
1845 curr_credit_bal.credit,
1849 -- Subtract the attributed amount from the various balances
1851 debit_balance := debit_balance - attr_amount;
1852 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1854 IF curr_fund_source_bal.balance <= 0 THEN
1856 -- This allocation is exhausted. Delete it so
1857 -- that we don't waste time looking at it again.
1859 DELETE FROM t_fund_source_bal
1861 fund = curr_fund_source_bal.fund
1862 AND source = curr_fund_source_bal.source;
1864 UPDATE t_fund_source_bal
1865 SET balance = balance - conv_attr_amount
1867 fund = curr_fund_source_bal.fund
1868 AND source = curr_fund_source_bal.source;
1871 IF curr_credit_bal.balance <= 0 THEN
1873 -- This funding source credit is exhausted. Delete it
1874 -- so that we don't waste time looking at it again.
1876 --DELETE FROM t_credit
1878 -- credit = curr_credit_bal.credit;
1880 DELETE FROM t_fund_credit
1882 credit = curr_credit_bal.credit;
1885 SET balance = curr_credit_bal.balance
1887 credit = curr_credit_bal.credit;
1890 -- Are we done with this debit yet?
1892 IF debit_balance <= 0 THEN
1893 EXIT; -- We've fully attributed this debit; stop looking at credits.
1895 END LOOP; -- End loop over credits
1897 IF debit_balance <> 0 THEN
1899 -- We weren't able to attribute this debit, or at least not
1900 -- all of it. Insert a row for the unattributed balance.
1902 attrib_count := attrib_count + 1;
1903 INSERT INTO acq.debit_attribution (
1907 funding_source_credit,
1917 END LOOP; -- End of loop over debits
1919 $$ LANGUAGE 'plpgsql';
1921 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit(
1925 ) RETURNS VOID AS $$
1936 IF old_year IS NULL THEN
1937 RAISE EXCEPTION 'Input year argument is NULL';
1938 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1939 RAISE EXCEPTION 'Input year is out of range';
1942 IF user_id IS NULL THEN
1943 RAISE EXCEPTION 'Input user id argument is NULL';
1946 IF org_unit_id IS NULL THEN
1947 RAISE EXCEPTION 'Org unit id argument is NULL';
1949 SELECT TRUE INTO org_found
1951 WHERE id = org_unit_id;
1953 IF org_found IS NULL THEN
1954 RAISE EXCEPTION 'Org unit id is invalid';
1958 -- Loop over the applicable funds
1960 FOR old_fund in SELECT * FROM acq.fund
1964 AND org = org_unit_id
1967 INSERT INTO acq.fund (
1975 balance_warning_percent,
1976 balance_stop_percent
1981 old_fund.currency_type,
1985 old_fund.balance_warning_percent,
1986 old_fund.balance_stop_percent
1988 RETURNING id INTO new_id;
1990 WHEN unique_violation THEN
1991 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
1994 --RAISE NOTICE 'Propagating fund % to fund %',
1995 -- old_fund.code, new_id;
1998 $$ LANGUAGE plpgsql;
2000 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
2004 ) RETURNS VOID AS $$
2015 IF old_year IS NULL THEN
2016 RAISE EXCEPTION 'Input year argument is NULL';
2017 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2018 RAISE EXCEPTION 'Input year is out of range';
2021 IF user_id IS NULL THEN
2022 RAISE EXCEPTION 'Input user id argument is NULL';
2025 IF org_unit_id IS NULL THEN
2026 RAISE EXCEPTION 'Org unit id argument is NULL';
2028 SELECT TRUE INTO org_found
2030 WHERE id = org_unit_id;
2032 IF org_found IS NULL THEN
2033 RAISE EXCEPTION 'Org unit id is invalid';
2037 -- Loop over the applicable funds
2039 FOR old_fund in SELECT * FROM acq.fund
2044 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2048 INSERT INTO acq.fund (
2056 balance_warning_percent,
2057 balance_stop_percent
2062 old_fund.currency_type,
2066 old_fund.balance_warning_percent,
2067 old_fund.balance_stop_percent
2069 RETURNING id INTO new_id;
2071 WHEN unique_violation THEN
2072 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2075 --RAISE NOTICE 'Propagating fund % to fund %',
2076 -- old_fund.code, new_id;
2079 $$ LANGUAGE plpgsql;
2081 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit(
2085 ) RETURNS VOID AS $$
2089 new_year INT := old_year + 1;
2091 xfer_amount NUMERIC;
2100 IF old_year IS NULL THEN
2101 RAISE EXCEPTION 'Input year argument is NULL';
2102 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2103 RAISE EXCEPTION 'Input year is out of range';
2106 IF user_id IS NULL THEN
2107 RAISE EXCEPTION 'Input user id argument is NULL';
2110 IF org_unit_id IS NULL THEN
2111 RAISE EXCEPTION 'Org unit id argument is NULL';
2114 -- Validate the org unit
2119 WHERE id = org_unit_id;
2121 IF org_found IS NULL THEN
2122 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2126 -- Loop over the propagable funds to identify the details
2127 -- from the old fund plus the id of the new one, if it exists.
2131 oldf.id AS old_fund,
2137 newf.id AS new_fund_id
2140 LEFT JOIN acq.fund AS newf
2141 ON ( oldf.code = newf.code )
2143 oldf.org = org_unit_id
2144 and oldf.year = old_year
2146 and newf.year = new_year
2148 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2150 IF roll_fund.new_fund_id IS NULL THEN
2152 -- The old fund hasn't been propagated yet. Propagate it now.
2154 INSERT INTO acq.fund (
2162 balance_warning_percent,
2163 balance_stop_percent
2168 roll_fund.currency_type,
2172 roll_fund.balance_warning_percent,
2173 roll_fund.balance_stop_percent
2175 RETURNING id INTO new_fund;
2177 new_fund = roll_fund.new_fund_id;
2180 -- Determine the amount to transfer
2184 FROM acq.fund_spent_balance
2185 WHERE fund = roll_fund.old_fund;
2187 IF xfer_amount <> 0 THEN
2188 IF roll_fund.rollover THEN
2190 -- Transfer balance from old fund to new
2192 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2194 PERFORM acq.transfer_fund(
2204 -- Transfer balance from old fund to the void
2206 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2208 PERFORM acq.transfer_fund(
2219 IF roll_fund.rollover THEN
2221 -- Move any lineitems from the old fund to the new one
2222 -- where the associated debit is an encumbrance.
2224 -- Any other tables tying expenditure details to funds should
2225 -- receive similar treatment. At this writing there are none.
2227 UPDATE acq.lineitem_detail
2230 fund = roll_fund.old_fund -- this condition may be redundant
2236 fund = roll_fund.old_fund
2240 -- Move encumbrance debits from the old fund to the new fund
2242 UPDATE acq.fund_debit
2245 fund = roll_fund.old_fund
2249 -- Mark old fund as inactive, now that we've closed it
2253 WHERE id = roll_fund.old_fund;
2256 $$ LANGUAGE plpgsql;
2258 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2262 ) RETURNS VOID AS $$
2266 new_year INT := old_year + 1;
2268 xfer_amount NUMERIC;
2277 IF old_year IS NULL THEN
2278 RAISE EXCEPTION 'Input year argument is NULL';
2279 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2280 RAISE EXCEPTION 'Input year is out of range';
2283 IF user_id IS NULL THEN
2284 RAISE EXCEPTION 'Input user id argument is NULL';
2287 IF org_unit_id IS NULL THEN
2288 RAISE EXCEPTION 'Org unit id argument is NULL';
2291 -- Validate the org unit
2296 WHERE id = org_unit_id;
2298 IF org_found IS NULL THEN
2299 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2303 -- Loop over the propagable funds to identify the details
2304 -- from the old fund plus the id of the new one, if it exists.
2308 oldf.id AS old_fund,
2314 newf.id AS new_fund_id
2317 LEFT JOIN acq.fund AS newf
2318 ON ( oldf.code = newf.code )
2320 oldf.year = old_year
2322 AND newf.year = new_year
2324 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2327 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2329 IF roll_fund.new_fund_id IS NULL THEN
2331 -- The old fund hasn't been propagated yet. Propagate it now.
2333 INSERT INTO acq.fund (
2341 balance_warning_percent,
2342 balance_stop_percent
2347 roll_fund.currency_type,
2351 roll_fund.balance_warning_percent,
2352 roll_fund.balance_stop_percent
2354 RETURNING id INTO new_fund;
2356 new_fund = roll_fund.new_fund_id;
2359 -- Determine the amount to transfer
2363 FROM acq.fund_spent_balance
2364 WHERE fund = roll_fund.old_fund;
2366 IF xfer_amount <> 0 THEN
2367 IF roll_fund.rollover THEN
2369 -- Transfer balance from old fund to new
2371 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2373 PERFORM acq.transfer_fund(
2383 -- Transfer balance from old fund to the void
2385 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2387 PERFORM acq.transfer_fund(
2398 IF roll_fund.rollover THEN
2400 -- Move any lineitems from the old fund to the new one
2401 -- where the associated debit is an encumbrance.
2403 -- Any other tables tying expenditure details to funds should
2404 -- receive similar treatment. At this writing there are none.
2406 UPDATE acq.lineitem_detail
2409 fund = roll_fund.old_fund -- this condition may be redundant
2415 fund = roll_fund.old_fund
2419 -- Move encumbrance debits from the old fund to the new fund
2421 UPDATE acq.fund_debit
2424 fund = roll_fund.old_fund
2428 -- Mark old fund as inactive, now that we've closed it
2432 WHERE id = roll_fund.old_fund;
2435 $$ LANGUAGE plpgsql;
2437 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2438 SELECT funding_source,
2439 SUM(amount) AS amount
2440 FROM acq.funding_source_credit
2443 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2444 SELECT funding_source,
2445 SUM(a.amount)::NUMERIC(100,2) AS amount
2446 FROM acq.fund_allocation a
2449 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2450 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2451 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2452 FROM acq.funding_source_credit_total c
2453 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2456 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2458 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2459 FROM acq.fund_allocation a
2460 JOIN acq.fund f ON (a.fund = f.id)
2461 JOIN acq.funding_source s ON (a.funding_source = s.id)
2464 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2465 SELECT fund.id AS fund,
2466 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2468 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2471 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2474 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2476 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2477 WHERE fund_debit.encumbrance GROUP BY fund.id;
2479 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2480 SELECT fund.id AS fund,
2481 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2483 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2484 WHERE NOT fund_debit.encumbrance
2487 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2489 c.amount - COALESCE(d.amount, 0.0) AS amount
2490 FROM acq.fund_allocation_total c
2491 LEFT JOIN acq.fund_debit_total d USING (fund);
2493 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2495 c.amount - COALESCE(d.amount,0.0) AS amount
2496 FROM acq.fund_allocation_total c
2497 LEFT JOIN acq.fund_spent_total d USING (fund);
2499 -- For each fund: the total allocation from all sources, in the
2500 -- currency of the fund (or 0 if there are no allocations)
2502 CREATE VIEW acq.all_fund_allocation_total AS
2505 COALESCE( SUM( a.amount * acq.exchange_ratio(
2506 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2510 LEFT JOIN acq.fund_allocation a
2512 LEFT JOIN acq.funding_source s
2513 ON a.funding_source = s.id
2517 -- For every fund: the total encumbrances (or 0 if none),
2518 -- in the currency of the fund.
2520 CREATE VIEW acq.all_fund_encumbrance_total AS
2523 COALESCE( encumb.amount, 0 ) AS amount
2529 sum( amount ) AS amount
2536 ON f.id = encumb.fund;
2538 -- For every fund: the total spent (or 0 if none),
2539 -- in the currency of the fund.
2541 CREATE VIEW acq.all_fund_spent_total AS
2544 COALESCE( spent.amount, 0 ) AS amount
2550 sum( amount ) AS amount
2557 ON f.id = spent.fund;
2559 -- For each fund: the amount not yet spent, in the currency
2560 -- of the fund. May include encumbrances.
2562 CREATE VIEW acq.all_fund_spent_balance AS
2565 c.amount - d.amount AS amount
2566 FROM acq.all_fund_allocation_total c
2567 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2569 -- For each fund: the amount neither spent nor encumbered,
2570 -- in the currency of the fund
2572 CREATE VIEW acq.all_fund_combined_balance AS
2575 a.amount - COALESCE( c.amount, 0 ) AS amount
2577 acq.all_fund_allocation_total a
2581 SUM( amount ) AS amount
2586 ) AS c USING ( fund );
2588 CREATE TABLE acq.claim_type (
2589 id SERIAL PRIMARY KEY,
2590 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2591 DEFERRABLE INITIALLY DEFERRED,
2593 description TEXT NOT NULL,
2594 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2597 CREATE TABLE acq.claim (
2598 id SERIAL PRIMARY KEY,
2599 type INT NOT NULL REFERENCES acq.claim_type
2600 DEFERRABLE INITIALLY DEFERRED,
2601 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2602 DEFERRABLE INITIALLY DEFERRED
2605 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2607 CREATE TABLE acq.claim_event (
2608 id BIGSERIAL PRIMARY KEY,
2609 type INT NOT NULL REFERENCES acq.claim_event_type
2610 DEFERRABLE INITIALLY DEFERRED,
2611 claim SERIAL NOT NULL REFERENCES acq.claim
2612 DEFERRABLE INITIALLY DEFERRED,
2613 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2614 creator INT NOT NULL REFERENCES actor.usr
2615 DEFERRABLE INITIALLY DEFERRED,
2619 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2621 -- And the serials version of claiming
2622 CREATE TABLE acq.serial_claim (
2623 id SERIAL PRIMARY KEY,
2624 type INT NOT NULL REFERENCES acq.claim_type
2625 DEFERRABLE INITIALLY DEFERRED,
2626 item BIGINT NOT NULL REFERENCES serial.item
2627 DEFERRABLE INITIALLY DEFERRED
2630 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2632 CREATE TABLE acq.serial_claim_event (
2633 id BIGSERIAL PRIMARY KEY,
2634 type INT NOT NULL REFERENCES acq.claim_event_type
2635 DEFERRABLE INITIALLY DEFERRED,
2636 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2637 DEFERRABLE INITIALLY DEFERRED,
2638 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2639 creator INT NOT NULL REFERENCES actor.usr
2640 DEFERRABLE INITIALLY DEFERRED,
2644 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );