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_copy_count INT NOT NULL DEFAULT 0,
93 default_claim_policy INT REFERENCES acq.claim_policy
94 DEFERRABLE INITIALLY DEFERRED,
95 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
96 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
99 CREATE TABLE acq.provider_holding_subfield_map (
100 id SERIAL PRIMARY KEY,
101 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
102 name TEXT NOT NULL, -- barcode, price, etc
103 subfield TEXT NOT NULL,
104 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
107 CREATE TABLE acq.provider_address (
108 id SERIAL PRIMARY KEY,
109 valid BOOL NOT NULL DEFAULT TRUE,
111 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
112 street1 TEXT NOT NULL,
117 country TEXT NOT NULL,
118 post_code TEXT NOT NULL,
122 CREATE TABLE acq.provider_contact (
123 id SERIAL PRIMARY KEY,
124 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
126 role TEXT, -- free-form.. e.g. "our sales guy"
131 CREATE TABLE acq.provider_contact_address (
132 id SERIAL PRIMARY KEY,
133 valid BOOL NOT NULL DEFAULT TRUE,
135 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
136 street1 TEXT NOT NULL,
141 country TEXT NOT NULL,
142 post_code TEXT NOT NULL,
146 CREATE TABLE acq.provider_note (
147 id SERIAL PRIMARY KEY,
148 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
149 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
150 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
151 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
152 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
155 CREATE INDEX acq_pro_note_pro_idx ON acq.provider_note ( provider );
156 CREATE INDEX acq_pro_note_creator_idx ON acq.provider_note ( creator );
157 CREATE INDEX acq_pro_note_editor_idx ON acq.provider_note ( editor );
160 CREATE TABLE acq.funding_source (
161 id SERIAL PRIMARY KEY,
163 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
164 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
166 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
169 CREATE TABLE acq.funding_source_credit (
170 id SERIAL PRIMARY KEY,
171 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
172 amount NUMERIC NOT NULL,
174 deadline_date TIMESTAMPTZ,
175 effective_date TIMESTAMPTZ NOT NULL default now()
178 CREATE VIEW acq.ordered_funding_source_credit AS
180 CASE WHEN deadline_date IS NULL THEN
184 END AS sort_priority,
185 CASE WHEN deadline_date IS NULL THEN
195 acq.funding_source_credit;
197 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
198 The acq.ordered_funding_source_credit view is a prioritized
199 ordering of funding source credits. When ordered by the first
200 three columns, this view defines the order in which the various
201 credits are to be tapped for spending, subject to the allocations
202 in the acq.fund_allocation table.
204 The first column reflects the principle that we should spend
205 money with deadlines before spending money without deadlines.
207 The second column reflects the principle that we should spend the
208 oldest money first. For money with deadlines, that means that we
209 spend first from the credit with the earliest deadline. For
210 money without deadlines, we spend first from the credit with the
211 earliest effective date.
213 The third column is a tie breaker to ensure a consistent
217 CREATE TABLE acq.fund (
218 id SERIAL PRIMARY KEY,
219 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
221 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
222 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
224 rollover BOOL NOT NULL DEFAULT FALSE,
225 propagate BOOL NOT NULL DEFAULT TRUE,
226 active BOOL NOT NULL DEFAULT TRUE,
227 balance_warning_percent INT,
228 balance_stop_percent INT,
229 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
230 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
231 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
234 CREATE TABLE acq.fund_debit (
235 id SERIAL PRIMARY KEY,
236 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
237 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
238 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
239 amount NUMERIC NOT NULL,
240 encumbrance BOOL NOT NULL DEFAULT TRUE,
241 debit_type TEXT NOT NULL,
242 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
243 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
246 CREATE TABLE acq.fund_allocation (
247 id SERIAL PRIMARY KEY,
248 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
249 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
250 amount NUMERIC NOT NULL,
251 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
253 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
255 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
257 CREATE TABLE acq.fund_allocation_percent
259 id SERIAL PRIMARY KEY,
260 funding_source INT NOT NULL REFERENCES acq.funding_source
261 DEFERRABLE INITIALLY DEFERRED,
262 org INT NOT NULL REFERENCES actor.org_unit
263 DEFERRABLE INITIALLY DEFERRED,
265 percent NUMERIC NOT NULL,
266 allocator INTEGER NOT NULL REFERENCES actor.usr
267 DEFERRABLE INITIALLY DEFERRED,
269 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
270 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
271 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
274 -- Trigger function to validate combination of org_unit and fund_code
276 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
277 RETURNS TRIGGER AS $$
292 AND code = NEW.fund_code
298 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
303 CREATE TRIGGER acq_fund_alloc_percent_val_trig
304 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
305 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
307 -- To do: trigger to verify that percentages don't add up to more than 100
309 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
310 RETURNS TRIGGER AS $$
313 total_percent numeric;
321 acq.fund_allocation_percent AS fap
323 fap.funding_source = NEW.funding_source;
325 IF total_percent > 100 THEN
326 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
334 CREATE TRIGGER acqfap_limit_100_trig
335 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
336 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
338 CREATE TABLE acq.picklist (
339 id SERIAL PRIMARY KEY,
340 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
341 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
342 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
343 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
345 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
346 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
347 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
349 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
350 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
351 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
353 CREATE TABLE acq.cancel_reason (
354 id SERIAL PRIMARY KEY,
355 org_unit INTEGER NOT NULL REFERENCES actor.org_unit( id )
356 DEFERRABLE INITIALLY DEFERRED,
358 description TEXT NOT NULL,
359 keep_debits BOOL NOT NULL DEFAULT FALSE,
360 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
363 -- Reserve ids 1-999 for stock reasons
364 -- Reserve ids 1000-1999 for EDI reasons
365 -- 2000+ are available for staff to create
367 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
369 CREATE TABLE acq.purchase_order (
370 id SERIAL PRIMARY KEY,
371 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
372 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
373 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
374 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
375 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
376 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
377 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
378 state TEXT NOT NULL DEFAULT 'new',
379 order_date TIMESTAMP WITH TIME ZONE,
381 cancel_reason INT REFERENCES acq.cancel_reason( id )
382 DEFERRABLE INITIALLY DEFERRED,
383 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE,
384 CONSTRAINT valid_po_state CHECK (state IN ('new','pending','on-order','received','cancelled'))
386 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
387 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
388 CREATE INDEX po_state_idx ON acq.purchase_order (state);
389 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
390 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
391 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
393 -- The name should default to the id, as text. We can't reference a column
394 -- in a DEFAULT clause, so we use a trigger:
396 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
399 IF NEW.name IS NULL THEN
400 NEW.name := NEW.id::TEXT;
407 CREATE TRIGGER po_name_default_trg
408 BEFORE INSERT OR UPDATE ON acq.purchase_order
409 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
411 -- The order name should be unique for a given ordering agency on a given order date
412 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
413 -- this rule requires a check constraint with a subquery. However you can't have a
414 -- subquery in a CHECK constraint, so we fake it with a trigger.
416 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
422 -- If order_date is not null, then make sure we don't have a collision
423 -- on order_date (truncated to day), org, and name
425 IF NEW.order_date IS NULL THEN
429 -- In the WHERE clause, we compare the order_dates without regard to time of day.
430 -- We use a pair of inequalities instead of comparing truncated dates so that the
431 -- query can do an indexed range scan.
433 SELECT 1 INTO collision
434 FROM acq.purchase_order
436 ordering_agency = NEW.ordering_agency
438 AND order_date >= date_trunc( 'day', NEW.order_date )
439 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
442 IF collision IS NULL THEN
443 -- okay, no collision
446 -- collision; nip it in the bud
447 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
448 NEW.ordering_agency, NEW.order_date, NEW.name;
453 CREATE TRIGGER po_org_name_date_unique_trg
454 BEFORE INSERT OR UPDATE ON acq.purchase_order
455 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
457 CREATE TABLE acq.po_note (
458 id SERIAL PRIMARY KEY,
459 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
460 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
461 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
462 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
463 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
465 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
467 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
468 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
469 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
471 CREATE TABLE acq.lineitem (
472 id BIGSERIAL PRIMARY KEY,
473 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
474 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
475 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
476 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
477 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
478 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
479 expected_recv_time TIMESTAMP WITH TIME ZONE,
480 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
481 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
483 eg_bib_id BIGINT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
485 state TEXT NOT NULL DEFAULT 'new',
486 cancel_reason INT REFERENCES acq.cancel_reason( id )
487 DEFERRABLE INITIALLY DEFERRED,
488 estimated_unit_price NUMERIC,
489 claim_policy INT REFERENCES acq.claim_policy
490 DEFERRABLE INITIALLY DEFERRED,
491 queued_record BIGINT REFERENCES vandelay.queued_bib_record (id)
492 ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
493 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
495 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
496 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
497 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
498 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
499 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
501 CREATE TABLE acq.lineitem_alert_text (
502 id SERIAL PRIMARY KEY,
505 owning_lib INT NOT NULL
506 REFERENCES actor.org_unit(id)
507 DEFERRABLE INITIALLY DEFERRED,
508 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
511 CREATE TABLE acq.lineitem_note (
512 id SERIAL PRIMARY KEY,
513 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
514 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
515 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
516 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
517 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
519 alert_text INT REFERENCES acq.lineitem_alert_text(id)
520 DEFERRABLE INITIALLY DEFERRED,
521 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
523 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
524 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
525 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
527 CREATE TABLE acq.lineitem_detail (
528 id BIGSERIAL PRIMARY KEY,
529 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
530 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
531 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
532 eg_copy_id BIGINT, -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
536 collection_code TEXT,
537 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
538 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
539 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
540 recv_time TIMESTAMP WITH TIME ZONE,
541 receiver INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
542 cancel_reason INT REFERENCES acq.cancel_reason( id ) DEFERRABLE INITIALLY DEFERRED
545 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
547 CREATE TABLE acq.lineitem_attr_definition (
548 id BIGSERIAL PRIMARY KEY,
550 description TEXT NOT NULL,
551 remove TEXT NOT NULL DEFAULT '',
552 ident BOOL NOT NULL DEFAULT FALSE
555 CREATE TABLE acq.lineitem_marc_attr_definition (
556 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
558 ) INHERITS (acq.lineitem_attr_definition);
560 CREATE TABLE acq.lineitem_provider_attr_definition (
561 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
563 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
564 ) INHERITS (acq.lineitem_attr_definition);
566 CREATE TABLE acq.lineitem_generated_attr_definition (
567 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
569 ) INHERITS (acq.lineitem_attr_definition);
571 CREATE TABLE acq.lineitem_usr_attr_definition (
572 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
573 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
574 ) INHERITS (acq.lineitem_attr_definition);
575 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
577 CREATE TABLE acq.lineitem_local_attr_definition (
578 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
579 ) INHERITS (acq.lineitem_attr_definition);
581 CREATE TABLE acq.lineitem_attr (
582 id BIGSERIAL PRIMARY KEY,
583 definition BIGINT NOT NULL,
584 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
585 attr_type TEXT NOT NULL,
586 attr_name TEXT NOT NULL,
587 attr_value TEXT NOT NULL,
588 order_ident BOOLEAN NOT NULL DEFAULT FALSE
591 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
592 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
593 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
599 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
600 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)]');
601 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
602 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
604 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
605 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('upc', 'UPC', '//*[@tag="024" and @ind1="1"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
606 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
607 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
608 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
609 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
610 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
612 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
615 CREATE TABLE acq.distribution_formula (
616 id SERIAL PRIMARY KEY,
618 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
620 skip_count INT NOT NULL DEFAULT 0,
621 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
624 CREATE TABLE acq.distribution_formula_entry (
625 id SERIAL PRIMARY KEY,
626 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
628 DEFERRABLE INITIALLY DEFERRED,
629 position INTEGER NOT NULL,
630 item_count INTEGER NOT NULL,
631 owning_lib INTEGER REFERENCES actor.org_unit(id)
632 DEFERRABLE INITIALLY DEFERRED,
633 location INTEGER REFERENCES asset.copy_location(id),
634 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
635 CONSTRAINT acqdfe_must_be_somewhere
636 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
639 CREATE TABLE acq.distribution_formula_application (
640 id BIGSERIAL PRIMARY KEY,
641 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
642 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
644 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
645 lineitem INT NOT NULL
646 REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
649 CREATE INDEX acqdfa_df_idx
650 ON acq.distribution_formula_application(formula);
651 CREATE INDEX acqdfa_li_idx
652 ON acq.distribution_formula_application(lineitem);
653 CREATE INDEX acqdfa_creator_idx
654 ON acq.distribution_formula_application(creator);
656 CREATE TABLE acq.fund_tag (
657 id SERIAL PRIMARY KEY,
659 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
661 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
664 CREATE TABLE acq.fund_tag_map (
665 id SERIAL PRIMARY KEY,
666 fund INTEGER NOT NULL REFERENCES acq.fund(id)
667 DEFERRABLE INITIALLY DEFERRED,
668 tag INTEGER REFERENCES acq.fund_tag(id)
670 DEFERRABLE INITIALLY DEFERRED,
671 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
674 CREATE TABLE acq.fund_transfer (
675 id SERIAL PRIMARY KEY,
676 src_fund INT NOT NULL REFERENCES acq.fund( id )
677 DEFERRABLE INITIALLY DEFERRED,
678 src_amount NUMERIC NOT NULL,
679 dest_fund INT REFERENCES acq.fund( id )
680 DEFERRABLE INITIALLY DEFERRED,
682 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
683 transfer_user INT NOT NULL REFERENCES actor.usr( id )
684 DEFERRABLE INITIALLY DEFERRED,
686 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
687 DEFERRABLE INITIALLY DEFERRED
690 CREATE INDEX acqftr_usr_idx
691 ON acq.fund_transfer( transfer_user );
693 COMMENT ON TABLE acq.fund_transfer IS $$
695 Each row represents the transfer of money from a source fund
696 to a destination fund. There should be corresponding entries
697 in acq.fund_allocation. The purpose of acq.fund_transfer is
698 to record how much money moved from which fund to which other
701 The presence of two amount fields, rather than one, reflects
702 the possibility that the two funds are denominated in different
703 currencies. If they use the same currency type, the two
704 amounts should be the same.
707 CREATE TABLE acq.fiscal_calendar (
708 id SERIAL PRIMARY KEY,
712 -- Create a default calendar (though we don't specify its contents).
713 -- Create a foreign key in actor.org_unit, initially pointing to
714 -- the default calendar.
716 INSERT INTO acq.fiscal_calendar (
723 ALTER TABLE actor.org_unit ADD FOREIGN KEY
724 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
725 DEFERRABLE INITIALLY DEFERRED;
727 CREATE TABLE acq.fiscal_year (
728 id SERIAL PRIMARY KEY,
729 calendar INT NOT NULL
730 REFERENCES acq.fiscal_calendar
732 DEFERRABLE INITIALLY DEFERRED,
734 year_begin TIMESTAMPTZ NOT NULL,
735 year_end TIMESTAMPTZ NOT NULL,
736 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
737 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
740 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
741 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
742 in_dir TEXT, -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
745 ) INHERITS (config.remote_account);
747 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
748 ALTER TABLE acq.edi_account ADD PRIMARY KEY (id);
750 CREATE TABLE acq.edi_message (
751 id SERIAL PRIMARY KEY,
752 account INTEGER REFERENCES acq.edi_account(id)
753 DEFERRABLE INITIALLY DEFERRED,
755 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
756 translate_time TIMESTAMPTZ,
757 process_time TIMESTAMPTZ,
758 error_time TIMESTAMPTZ,
759 status TEXT NOT NULL DEFAULT 'new'
760 CONSTRAINT status_value CHECK
762 'new', -- needs to be translated
763 'translated', -- needs to be processed
764 'trans_error', -- error in translation step
765 'processed', -- needs to have remote_file deleted
766 'proc_error', -- error in processing step
767 'delete_error', -- error in deletion
768 'retry', -- need to retry
774 purchase_order INT REFERENCES acq.purchase_order
775 DEFERRABLE INITIALLY DEFERRED,
776 message_type TEXT NOT NULL CONSTRAINT valid_message_type CHECK
786 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
787 -- the table, assigning ids programmatically instead of using a sequence.
788 CREATE TABLE acq.debit_attribution (
789 id INT NOT NULL PRIMARY KEY,
790 fund_debit INT NOT NULL
791 REFERENCES acq.fund_debit
792 DEFERRABLE INITIALLY DEFERRED,
793 debit_amount NUMERIC NOT NULL,
794 funding_source_credit INT REFERENCES acq.funding_source_credit
795 DEFERRABLE INITIALLY DEFERRED,
796 credit_amount NUMERIC
799 CREATE INDEX acq_attribution_debit_idx
800 ON acq.debit_attribution( fund_debit );
802 CREATE INDEX acq_attribution_credit_idx
803 ON acq.debit_attribution( funding_source_credit );
807 CREATE TABLE acq.invoice_method (
808 code TEXT PRIMARY KEY,
809 name TEXT NOT NULL -- i18n-ize
812 CREATE TABLE acq.invoice_payment_method (
813 code TEXT PRIMARY KEY,
814 name TEXT NOT NULL -- i18n-ize
817 CREATE TABLE acq.invoice (
818 id SERIAL PRIMARY KEY,
819 receiver INT NOT NULL REFERENCES actor.org_unit (id),
820 provider INT NOT NULL REFERENCES acq.provider (id),
821 shipper INT NOT NULL REFERENCES acq.provider (id),
822 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
823 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
824 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
825 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
827 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
828 DEFERRABLE INITIALLY DEFERRED,
830 complete BOOL NOT NULL DEFAULT FALSE,
831 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
834 CREATE TABLE acq.invoice_entry (
835 id SERIAL PRIMARY KEY,
836 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
837 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
838 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
839 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
840 phys_item_count INT, -- and how many did staff count
842 billed_per_item BOOL,
843 cost_billed NUMERIC(8,2),
844 actual_cost NUMERIC(8,2),
845 amount_paid NUMERIC (8,2)
848 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
849 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
850 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
852 CREATE TABLE acq.invoice_item_type (
853 code TEXT PRIMARY KEY,
854 name TEXT NOT NULL, -- i18n-ize
855 prorate BOOL NOT NULL DEFAULT FALSE
858 CREATE TABLE acq.po_item (
859 id SERIAL PRIMARY KEY,
860 purchase_order INT REFERENCES acq.purchase_order (id)
861 ON UPDATE CASCADE ON DELETE SET NULL
862 DEFERRABLE INITIALLY DEFERRED,
863 fund_debit INT REFERENCES acq.fund_debit (id)
864 DEFERRABLE INITIALLY DEFERRED,
865 inv_item_type TEXT NOT NULL
866 REFERENCES acq.invoice_item_type (code)
867 DEFERRABLE INITIALLY DEFERRED,
871 estimated_cost NUMERIC(8,2),
872 fund INT REFERENCES acq.fund (id)
873 DEFERRABLE INITIALLY DEFERRED,
877 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
879 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
880 id SERIAL PRIMARY KEY,
881 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
882 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
883 fund_debit INT REFERENCES acq.fund_debit (id),
884 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
888 cost_billed NUMERIC(8,2),
889 actual_cost NUMERIC(8,2),
890 fund INT REFERENCES acq.fund (id)
891 DEFERRABLE INITIALLY DEFERRED,
892 amount_paid NUMERIC (8,2),
893 po_item INT REFERENCES acq.po_item (id)
894 DEFERRABLE INITIALLY DEFERRED,
898 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
899 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
900 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
903 CREATE TABLE acq.user_request_type (
904 id SERIAL PRIMARY KEY,
905 label TEXT NOT NULL UNIQUE -- i18n-ize
908 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
909 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
910 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
911 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
912 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
914 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
916 CREATE TABLE acq.user_request (
917 id SERIAL PRIMARY KEY,
918 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
919 hold BOOL NOT NULL DEFAULT TRUE,
921 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
922 holdable_formats TEXT, -- nullable, for use in hold creation
924 email_notify BOOL NOT NULL DEFAULT TRUE,
925 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
926 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
927 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
928 need_before TIMESTAMPTZ, -- don't create holds after this
931 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
943 cancel_reason INT REFERENCES acq.cancel_reason( id )
944 DEFERRABLE INITIALLY DEFERRED
950 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
951 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
954 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
957 SELECT COUNT(*) INTO counter
958 FROM oils_xpath_table(
962 '//*[@tag="' || tag || '"]',
964 ) as t(i int,c text);
966 FOR i IN 1 .. counter LOOP
969 FROM ( SELECT id,i,t,v
970 FROM oils_xpath_table(
974 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
975 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
977 ) as t(id int,t text,v text)
988 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
989 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
993 lida acq.flat_lineitem_detail%ROWTYPE;
995 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
996 IF NOT FOUND THEN RETURN; END IF;
998 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
999 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1006 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1007 JOIN acq.provider_holding_subfield_map a USING (subfield)
1008 WHERE a.provider = prov_i
1015 $$ LANGUAGE PLPGSQL;
1017 -- select * from acq.extract_provider_holding_data(699);
1019 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1020 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1023 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field_set ( BIGINT, TEXT, TEXT) RETURNS SETOF TEXT AS $$
1024 SELECT extract_marc_field_set('acq.lineitem', $1, $2, $3);
1029 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1030 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1033 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1034 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1038 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1041 Suggested vendor fields:
1049 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1058 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1060 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1062 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1063 IF (atype = 'lineitem_provider_attr_definition') THEN
1064 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1065 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1068 IF (atype = 'lineitem_provider_attr_definition') THEN
1069 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1070 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1071 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1072 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1073 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1076 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1078 IF (adef.code = 'title' OR adef.code = 'author') THEN
1079 -- title and author should not be split
1080 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1081 -- string-join in the xpath and remove this special case
1082 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1083 IF (value IS NOT NULL AND value <> '') THEN
1084 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1085 VALUES (NEW.id, adef.id, atype, adef.code, value);
1090 -- each application of the regex may produce multiple values
1092 SELECT * FROM extract_acq_marc_field_set(
1093 NEW.id, xpath_string || '[' || pos || ']', adef.remove)
1096 IF (value IS NOT NULL AND value <> '') THEN
1097 INSERT INTO acq.lineitem_attr
1098 (lineitem, definition, attr_type, attr_name, attr_value)
1099 VALUES (NEW.id, adef.id, atype, adef.code, value);
1117 $function$ LANGUAGE PLPGSQL;
1119 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1121 IF TG_OP = 'UPDATE' THEN
1122 DELETE FROM acq.lineitem_attr
1123 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1126 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1130 $$ LANGUAGE PLPGSQL;
1132 CREATE TRIGGER cleanup_lineitem_trigger
1133 BEFORE UPDATE OR DELETE ON acq.lineitem
1134 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1136 CREATE TRIGGER ingest_lineitem_trigger
1137 AFTER INSERT OR UPDATE ON acq.lineitem
1138 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1140 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1144 IF from_ex = to_ex THEN
1148 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1153 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1162 $$ LANGUAGE PLPGSQL;
1164 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1165 SELECT $3 * acq.exchange_ratio($1, $2);
1168 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1170 Examine the acq.fiscal_year table, comparing successive years.
1171 Report any inconsistencies, i.e. years that overlap, have gaps
1172 between them, or are out of sequence.
1174 RETURNS SETOF RECORD AS $$
1198 ELSIF curr_year.calendar = prev_year.calendar THEN
1199 IF curr_year.year_begin > prev_year.year_end THEN
1200 -- This ugly kludge works around the fact that older
1201 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1202 FOR return_rec IN SELECT
1205 'Gap between fiscal years'::TEXT
1207 RETURN NEXT return_rec;
1209 ELSIF curr_year.year_begin < prev_year.year_end THEN
1210 FOR return_rec IN SELECT
1213 'Overlapping fiscal years'::TEXT
1215 RETURN NEXT return_rec;
1217 ELSIF curr_year.year < prev_year.year THEN
1218 FOR return_rec IN SELECT
1221 'Fiscal years out of order'::TEXT
1223 RETURN NEXT return_rec;
1228 prev_year := curr_year;
1233 $$ LANGUAGE plpgsql;
1235 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1237 old_amount IN NUMERIC, -- in currency of old fund
1239 new_amount IN NUMERIC, -- in currency of new fund
1241 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1242 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1243 ) RETURNS VOID AS $$
1244 /* -------------------------------------------------------------------------------
1246 Function to transfer money from one fund to another.
1248 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1249 negative amount for the old (losing) fund and a positive amount for the new
1250 (gaining) fund. In some cases there may be more than one such pair of entries
1251 in order to pull the money from different funding sources, or more specifically
1252 from different funding source credits. For each such pair there is also an
1253 entry in acq.fund_transfer.
1255 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1256 choose a funding source for the transferred money to come from. This choice
1257 must meet two constraints, so far as possible:
1259 1. The amount transferred from a given funding source must not exceed the
1260 amount allocated to the old fund by the funding source. To that end we
1261 compare the amount being transferred to the amount allocated.
1263 2. We shouldn't transfer money that has already been spent or encumbered, as
1264 defined by the funding attribution process. We attribute expenses to the
1265 oldest funding source credits first. In order to avoid transferring that
1266 attributed money, we reverse the priority, transferring from the newest funding
1267 source credits first. There can be no guarantee that this approach will
1268 avoid overcommitting a fund, but no other approach can do any better.
1270 In this context the age of a funding source credit is defined by the
1271 deadline_date for credits with deadline_dates, and by the effective_date for
1272 credits without deadline_dates, with the proviso that credits with deadline_dates
1273 are all considered "older" than those without.
1277 In the signature for this function, there is one last parameter commented out,
1278 named "funding_source_in". Correspondingly, the WHERE clause for the query
1279 driving the main loop has an OR clause commented out, which references the
1280 funding_source_in parameter.
1282 If these lines are uncommented, this function will allow the user optionally to
1283 restrict a fund transfer to a specified funding source. If the source
1284 parameter is left NULL, then there will be no such restriction.
1286 ------------------------------------------------------------------------------- */
1288 same_currency BOOLEAN;
1289 currency_ratio NUMERIC;
1290 old_fund_currency TEXT;
1291 old_remaining NUMERIC; -- in currency of old fund
1292 new_fund_currency TEXT;
1293 new_fund_active BOOLEAN;
1294 new_remaining NUMERIC; -- in currency of new fund
1295 curr_old_amt NUMERIC; -- in currency of old fund
1296 curr_new_amt NUMERIC; -- in currency of new fund
1297 source_addition NUMERIC; -- in currency of funding source
1298 source_deduction NUMERIC; -- in currency of funding source
1299 orig_allocated_amt NUMERIC; -- in currency of funding source
1300 allocated_amt NUMERIC; -- in currency of fund
1306 IF old_fund IS NULL THEN
1307 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1310 IF old_amount IS NULL THEN
1311 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1314 -- The new fund and its amount must be both NULL or both not NULL.
1316 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1317 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1320 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1321 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1324 IF user_id IS NULL THEN
1325 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1328 -- Initialize the amounts to be transferred, each denominated
1329 -- in the currency of its respective fund. They will be
1330 -- reduced on each iteration of the loop.
1332 old_remaining := old_amount;
1333 new_remaining := new_amount;
1335 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1336 -- old_amount, old_fund, new_amount, new_fund;
1338 -- Get the currency types of the old and new funds.
1349 IF old_fund_currency IS NULL THEN
1350 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1353 IF new_fund IS NOT NULL THEN
1365 IF new_fund_currency IS NULL THEN
1366 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1367 ELSIF NOT new_fund_active THEN
1369 -- No point in putting money into a fund from whence you can't spend it
1371 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1374 IF new_amount = old_amount THEN
1375 same_currency := true;
1376 currency_ratio := 1;
1379 -- We'll have to translate currency between funds. We presume that
1380 -- the calling code has already applied an appropriate exchange rate,
1381 -- so we'll apply the same conversion to each sub-transfer.
1383 same_currency := false;
1384 currency_ratio := new_amount / old_amount;
1388 -- Identify the funding source(s) from which we want to transfer the money.
1389 -- The principle is that we want to transfer the newest money first, because
1390 -- we spend the oldest money first. The priority for spending is defined
1391 -- by a sort of the view acq.ordered_funding_source_credit.
1396 ofsc.funding_source,
1398 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1402 acq.ordered_funding_source_credit AS ofsc,
1403 acq.funding_source fs
1405 ofsc.funding_source = fs.id
1406 and ofsc.funding_source IN
1408 SELECT funding_source
1409 FROM acq.fund_allocation
1410 WHERE fund = old_fund
1414 -- ofsc.funding_source = funding_source_in
1415 -- OR funding_source_in IS NULL
1418 ofsc.sort_priority desc,
1419 ofsc.sort_date desc,
1423 -- Determine how much money the old fund got from this funding source,
1424 -- denominated in the currency types of the source and of the fund.
1425 -- This result may reflect transfers from previous iterations.
1428 COALESCE( sum( amount ), 0 ),
1429 COALESCE( sum( amount )
1430 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1432 orig_allocated_amt, -- in currency of the source
1433 allocated_amt -- in currency of the old fund
1438 and funding_source = source.funding_source;
1440 -- Determine how much to transfer from this credit, in the currency
1441 -- of the fund. Begin with the amount remaining to be attributed:
1443 curr_old_amt := old_remaining;
1445 -- Can't attribute more than was allocated from the fund:
1447 IF curr_old_amt > allocated_amt THEN
1448 curr_old_amt := allocated_amt;
1451 -- Can't attribute more than the amount of the current credit:
1453 IF curr_old_amt > source.converted_amt THEN
1454 curr_old_amt := source.converted_amt;
1457 curr_old_amt := trunc( curr_old_amt, 2 );
1459 old_remaining := old_remaining - curr_old_amt;
1461 -- Determine the amount to be deducted, if any,
1462 -- from the old allocation.
1464 IF old_remaining > 0 THEN
1466 -- In this case we're using the whole allocation, so use that
1467 -- amount directly instead of applying a currency translation
1468 -- and thereby inviting round-off errors.
1470 source_deduction := - orig_allocated_amt;
1472 source_deduction := trunc(
1473 ( - curr_old_amt ) *
1474 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1478 IF source_deduction <> 0 THEN
1480 -- Insert negative allocation for old fund in fund_allocation,
1481 -- converted into the currency of the funding source
1483 INSERT INTO acq.fund_allocation (
1490 source.funding_source,
1494 'Transfer to fund ' || new_fund
1498 IF new_fund IS NOT NULL THEN
1500 -- Determine how much to add to the new fund, in
1501 -- its currency, and how much remains to be added:
1503 IF same_currency THEN
1504 curr_new_amt := curr_old_amt;
1506 IF old_remaining = 0 THEN
1508 -- This is the last iteration, so nothing should be left
1510 curr_new_amt := new_remaining;
1513 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1514 new_remaining := new_remaining - curr_new_amt;
1518 -- Determine how much to add, if any,
1519 -- to the new fund's allocation.
1521 IF old_remaining > 0 THEN
1523 -- In this case we're using the whole allocation, so use that amount
1524 -- amount directly instead of applying a currency translation and
1525 -- thereby inviting round-off errors.
1527 source_addition := orig_allocated_amt;
1528 ELSIF source.currency_type = old_fund_currency THEN
1530 -- In this case we don't need a round trip currency translation,
1531 -- thereby inviting round-off errors:
1533 source_addition := curr_old_amt;
1535 source_addition := trunc(
1537 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1541 IF source_addition <> 0 THEN
1543 -- Insert positive allocation for new fund in fund_allocation,
1544 -- converted to the currency of the founding source
1546 INSERT INTO acq.fund_allocation (
1553 source.funding_source,
1557 'Transfer from fund ' || old_fund
1562 IF trunc( curr_old_amt, 2 ) <> 0
1563 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1565 -- Insert row in fund_transfer, using amounts in the currency of the funds
1567 INSERT INTO acq.fund_transfer (
1574 funding_source_credit
1577 trunc( curr_old_amt, 2 ),
1579 trunc( curr_new_amt, 2 ),
1586 if old_remaining <= 0 THEN
1587 EXIT; -- Nothing more to be transferred
1591 $$ LANGUAGE plpgsql;
1593 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1595 Function to attribute expenditures and encumbrances to funding source credits,
1596 and thereby to funding sources.
1598 Read the debits in chonological order, attributing each one to one or
1599 more funding source credits. Constraints:
1601 1. Don't attribute more to a credit than the amount of the credit.
1603 2. For a given fund, don't attribute more to a funding source than the
1604 source has allocated to that fund.
1606 3. Attribute debits to credits with deadlines before attributing them to
1607 credits without deadlines. Otherwise attribute to the earliest credits
1608 first, based on the deadline date when present, or on the effective date
1609 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1610 This ordering is defined by an ORDER BY clause on the view
1611 acq.ordered_funding_source_credit.
1613 Start by truncating the table acq.debit_attribution. Then insert a row
1614 into that table for each attribution. If a debit cannot be fully
1615 attributed, insert a row for the unattributable balance, with the
1616 funding_source_credit and credit_amount columns NULL.
1619 curr_fund_source_bal RECORD;
1620 seqno INT; -- sequence num for credits applicable to a fund
1621 fund_credit RECORD; -- current row in temp t_fund_credit table
1622 fc RECORD; -- used for loading t_fund_credit table
1623 sc RECORD; -- used for loading t_fund_credit table
1625 -- Used exclusively in the main loop:
1627 deb RECORD; -- current row from acq.fund_debit table
1628 curr_credit_bal RECORD; -- current row from temp t_credit table
1629 debit_balance NUMERIC; -- amount left to attribute for current debit
1630 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1631 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1632 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1633 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1634 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1635 attrib_count INT; -- populates id of acq.debit_attribution
1638 -- Load a temporary table. For each combination of fund and funding source,
1639 -- load an entry with the total amount allocated to that fund by that source.
1640 -- This sum may reflect transfers as well as original allocations. We will
1641 -- reduce this balance whenever we attribute debits to it.
1643 CREATE TEMP TABLE t_fund_source_bal
1647 funding_source AS source,
1648 sum( amount ) AS balance
1657 CREATE INDEX t_fund_source_bal_idx
1658 ON t_fund_source_bal( fund, source );
1659 -------------------------------------------------------------------------------
1661 -- Load another temporary table. For each fund, load zero or more
1662 -- funding source credits from which that fund can get money.
1664 CREATE TEMP TABLE t_fund_credit (
1671 SELECT DISTINCT fund
1672 FROM acq.fund_allocation
1674 LOOP -- Loop over the funds
1680 acq.ordered_funding_source_credit AS ofsc
1682 ofsc.funding_source IN
1684 SELECT funding_source
1685 FROM acq.fund_allocation
1686 WHERE fund = fc.fund
1692 LOOP -- Add each credit to the list
1693 INSERT INTO t_fund_credit (
1702 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1704 END LOOP; -- Loop over credits for a given fund
1705 END LOOP; -- Loop over funds
1707 CREATE INDEX t_fund_credit_idx
1708 ON t_fund_credit( fund, seq );
1709 -------------------------------------------------------------------------------
1711 -- Load yet another temporary table. This one is a list of funding source
1712 -- credits, with their balances. We shall reduce those balances as we
1713 -- attribute debits to them.
1715 CREATE TEMP TABLE t_credit
1719 fsc.funding_source AS source,
1720 fsc.amount AS balance,
1721 fs.currency_type AS currency_type
1723 acq.funding_source_credit AS fsc,
1724 acq.funding_source fs
1726 fsc.funding_source = fs.id
1729 CREATE INDEX t_credit_idx
1730 ON t_credit( credit );
1732 -------------------------------------------------------------------------------
1734 -- Now that we have loaded the lookup tables: loop through the debits,
1735 -- attributing each one to one or more funding source credits.
1737 truncate table acq.debit_attribution;
1755 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1757 debit_balance := deb.amount;
1759 -- Loop over the funding source credits that are eligible
1760 -- to pay for this debit
1772 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1774 -- Look up the balance for this credit. If it's zero, then
1775 -- it's not useful, so treat it as if you didn't find it.
1776 -- (Actually there shouldn't be any zero balances in the table,
1777 -- but we check just to make sure.)
1780 INTO curr_credit_bal
1783 credit = fund_credit.credit
1786 IF curr_credit_bal IS NULL THEN
1788 -- This credit is exhausted; try the next one.
1794 -- At this point we have an applicable credit with some money left.
1795 -- Now see if the relevant funding_source has any money left.
1797 -- Look up the balance of the allocation for this combination of
1798 -- fund and source. If you find such an entry, but it has a zero
1799 -- balance, then it's not useful, so treat it as unfound.
1800 -- (Actually there shouldn't be any zero balances in the table,
1801 -- but we check just to make sure.)
1804 INTO curr_fund_source_bal
1805 FROM t_fund_source_bal
1808 AND source = curr_credit_bal.source
1811 IF curr_fund_source_bal IS NULL THEN
1813 -- This fund/source doesn't exist or is already exhausted,
1814 -- so we can't use this credit. Go on to the next one.
1819 -- Convert the available balances to the currency of the fund
1821 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1822 curr_credit_bal.currency_type, deb.currency_type );
1823 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1824 curr_credit_bal.currency_type, deb.currency_type );
1826 -- Determine how much we can attribute to this credit: the minimum
1827 -- of the debit amount, the fund/source balance, and the
1830 --RAISE NOTICE ' deb bal %', debit_balance;
1831 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1832 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1834 conv_attr_amount := NULL;
1835 attr_amount := debit_balance;
1837 IF attr_amount > conv_alloc_balance THEN
1838 attr_amount := conv_alloc_balance;
1839 conv_attr_amount := curr_fund_source_bal.balance;
1841 IF attr_amount > conv_cred_balance THEN
1842 attr_amount := conv_cred_balance;
1843 conv_attr_amount := curr_credit_bal.balance;
1846 -- If we're attributing all of one of the balances, then that's how
1847 -- much we will deduct from the balances, and we already captured
1848 -- that amount above. Otherwise we must convert the amount of the
1849 -- attribution from the currency of the fund back to the currency of
1850 -- the funding source.
1852 IF conv_attr_amount IS NULL THEN
1853 conv_attr_amount := attr_amount * acq.exchange_ratio(
1854 deb.currency_type, curr_credit_bal.currency_type );
1857 -- Insert a row to record the attribution
1859 attrib_count := attrib_count + 1;
1860 INSERT INTO acq.debit_attribution (
1864 funding_source_credit,
1870 curr_credit_bal.credit,
1874 -- Subtract the attributed amount from the various balances
1876 debit_balance := debit_balance - attr_amount;
1877 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1879 IF curr_fund_source_bal.balance <= 0 THEN
1881 -- This allocation is exhausted. Delete it so
1882 -- that we don't waste time looking at it again.
1884 DELETE FROM t_fund_source_bal
1886 fund = curr_fund_source_bal.fund
1887 AND source = curr_fund_source_bal.source;
1889 UPDATE t_fund_source_bal
1890 SET balance = balance - conv_attr_amount
1892 fund = curr_fund_source_bal.fund
1893 AND source = curr_fund_source_bal.source;
1896 IF curr_credit_bal.balance <= 0 THEN
1898 -- This funding source credit is exhausted. Delete it
1899 -- so that we don't waste time looking at it again.
1901 --DELETE FROM t_credit
1903 -- credit = curr_credit_bal.credit;
1905 DELETE FROM t_fund_credit
1907 credit = curr_credit_bal.credit;
1910 SET balance = curr_credit_bal.balance
1912 credit = curr_credit_bal.credit;
1915 -- Are we done with this debit yet?
1917 IF debit_balance <= 0 THEN
1918 EXIT; -- We've fully attributed this debit; stop looking at credits.
1920 END LOOP; -- End loop over credits
1922 IF debit_balance <> 0 THEN
1924 -- We weren't able to attribute this debit, or at least not
1925 -- all of it. Insert a row for the unattributed balance.
1927 attrib_count := attrib_count + 1;
1928 INSERT INTO acq.debit_attribution (
1932 funding_source_credit,
1942 END LOOP; -- End of loop over debits
1944 $$ LANGUAGE 'plpgsql';
1946 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1949 org_unit_id INTEGER,
1950 include_desc BOOL DEFAULT TRUE
1951 ) RETURNS VOID AS $$
1962 IF old_year IS NULL THEN
1963 RAISE EXCEPTION 'Input year argument is NULL';
1964 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1965 RAISE EXCEPTION 'Input year is out of range';
1968 IF user_id IS NULL THEN
1969 RAISE EXCEPTION 'Input user id argument is NULL';
1972 IF org_unit_id IS NULL THEN
1973 RAISE EXCEPTION 'Org unit id argument is NULL';
1975 SELECT TRUE INTO org_found
1977 WHERE id = org_unit_id;
1979 IF org_found IS NULL THEN
1980 RAISE EXCEPTION 'Org unit id is invalid';
1984 -- Loop over the applicable funds
1986 FOR old_fund in SELECT * FROM acq.fund
1990 AND ( ( include_desc AND org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
1991 OR (NOT include_desc AND org = org_unit_id ) )
1995 INSERT INTO acq.fund (
2003 balance_warning_percent,
2004 balance_stop_percent
2009 old_fund.currency_type,
2013 old_fund.balance_warning_percent,
2014 old_fund.balance_stop_percent
2016 RETURNING id INTO new_id;
2018 WHEN unique_violation THEN
2019 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2022 --RAISE NOTICE 'Propagating fund % to fund %',
2023 -- old_fund.code, new_id;
2026 $$ LANGUAGE plpgsql;
2028 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER ) RETURNS VOID AS $$
2029 SELECT acq.propagate_funds_by_org_tree( $1, $2, $3, FALSE );
2033 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2036 org_unit_id INTEGER,
2037 encumb_only BOOL DEFAULT FALSE,
2038 include_desc BOOL DEFAULT TRUE
2039 ) RETURNS VOID AS $$
2043 new_year INT := old_year + 1;
2046 xfer_amount NUMERIC := 0;
2055 IF old_year IS NULL THEN
2056 RAISE EXCEPTION 'Input year argument is NULL';
2057 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2058 RAISE EXCEPTION 'Input year is out of range';
2061 IF user_id IS NULL THEN
2062 RAISE EXCEPTION 'Input user id argument is NULL';
2065 IF org_unit_id IS NULL THEN
2066 RAISE EXCEPTION 'Org unit id argument is NULL';
2069 -- Validate the org unit
2074 WHERE id = org_unit_id;
2076 IF org_found IS NULL THEN
2077 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2078 ELSIF encumb_only THEN
2079 SELECT INTO perm_ous value::BOOL FROM
2080 actor.org_unit_ancestor_setting(
2081 'acq.fund.allow_rollover_without_money', org_unit_id
2083 IF NOT FOUND OR NOT perm_ous THEN
2084 RAISE EXCEPTION 'Encumbrance-only rollover not permitted at org %', org_unit_id;
2089 -- Loop over the propagable funds to identify the details
2090 -- from the old fund plus the id of the new one, if it exists.
2094 oldf.id AS old_fund,
2100 newf.id AS new_fund_id
2103 LEFT JOIN acq.fund AS newf
2104 ON ( oldf.code = newf.code )
2106 oldf.year = old_year
2108 AND newf.year = new_year
2109 AND ( ( include_desc AND oldf.org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2110 OR (NOT include_desc AND oldf.org = org_unit_id ) )
2112 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2114 IF roll_fund.new_fund_id IS NULL THEN
2116 -- The old fund hasn't been propagated yet. Propagate it now.
2118 INSERT INTO acq.fund (
2126 balance_warning_percent,
2127 balance_stop_percent
2132 roll_fund.currency_type,
2136 roll_fund.balance_warning_percent,
2137 roll_fund.balance_stop_percent
2139 RETURNING id INTO new_fund;
2141 new_fund = roll_fund.new_fund_id;
2144 -- Determine the amount to transfer
2148 FROM acq.fund_spent_balance
2149 WHERE fund = roll_fund.old_fund;
2151 IF xfer_amount <> 0 THEN
2152 IF NOT encumb_only AND roll_fund.rollover THEN
2154 -- Transfer balance from old fund to new
2156 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2158 PERFORM acq.transfer_fund(
2168 -- Transfer balance from old fund to the void
2170 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2172 PERFORM acq.transfer_fund(
2178 'Rollover into the void'
2183 IF roll_fund.rollover THEN
2185 -- Move any lineitems from the old fund to the new one
2186 -- where the associated debit is an encumbrance.
2188 -- Any other tables tying expenditure details to funds should
2189 -- receive similar treatment. At this writing there are none.
2191 UPDATE acq.lineitem_detail
2194 fund = roll_fund.old_fund -- this condition may be redundant
2200 fund = roll_fund.old_fund
2204 -- Move encumbrance debits from the old fund to the new fund
2206 UPDATE acq.fund_debit
2209 fund = roll_fund.old_fund
2213 -- Mark old fund as inactive, now that we've closed it
2217 WHERE id = roll_fund.old_fund;
2220 $$ LANGUAGE plpgsql;
2222 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER, encumb_only BOOL DEFAULT FALSE ) RETURNS VOID AS $$
2223 SELECT acq.rollover_funds_by_org_tree( $1, $2, $3, $4, FALSE );
2226 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2227 SELECT funding_source,
2228 SUM(amount) AS amount
2229 FROM acq.funding_source_credit
2232 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2233 SELECT funding_source,
2234 SUM(a.amount)::NUMERIC(100,2) AS amount
2235 FROM acq.fund_allocation a
2238 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2239 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2240 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2241 FROM acq.funding_source_credit_total c
2242 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2245 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2247 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2248 FROM acq.fund_allocation a
2249 JOIN acq.fund f ON (a.fund = f.id)
2250 JOIN acq.funding_source s ON (a.funding_source = s.id)
2253 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2254 SELECT fund.id AS fund,
2255 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2257 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2260 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2263 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2265 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2266 WHERE fund_debit.encumbrance GROUP BY fund.id;
2268 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2269 SELECT fund.id AS fund,
2270 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2272 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2273 WHERE NOT fund_debit.encumbrance
2276 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2278 c.amount - COALESCE(d.amount, 0.0) AS amount
2279 FROM acq.fund_allocation_total c
2280 LEFT JOIN acq.fund_debit_total d USING (fund);
2282 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2284 c.amount - COALESCE(d.amount,0.0) AS amount
2285 FROM acq.fund_allocation_total c
2286 LEFT JOIN acq.fund_spent_total d USING (fund);
2288 -- For each fund: the total allocation from all sources, in the
2289 -- currency of the fund (or 0 if there are no allocations)
2291 CREATE VIEW acq.all_fund_allocation_total AS
2294 COALESCE( SUM( a.amount * acq.exchange_ratio(
2295 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2299 LEFT JOIN acq.fund_allocation a
2301 LEFT JOIN acq.funding_source s
2302 ON a.funding_source = s.id
2306 -- For every fund: the total encumbrances (or 0 if none),
2307 -- in the currency of the fund.
2309 CREATE VIEW acq.all_fund_encumbrance_total AS
2312 COALESCE( encumb.amount, 0 ) AS amount
2318 sum( amount ) AS amount
2325 ON f.id = encumb.fund;
2327 -- For every fund: the total spent (or 0 if none),
2328 -- in the currency of the fund.
2330 CREATE VIEW acq.all_fund_spent_total AS
2333 COALESCE( spent.amount, 0 ) AS amount
2339 sum( amount ) AS amount
2346 ON f.id = spent.fund;
2348 -- For each fund: the amount not yet spent, in the currency
2349 -- of the fund. May include encumbrances.
2351 CREATE VIEW acq.all_fund_spent_balance AS
2354 c.amount - d.amount AS amount
2355 FROM acq.all_fund_allocation_total c
2356 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2358 -- For each fund: the amount neither spent nor encumbered,
2359 -- in the currency of the fund
2361 CREATE VIEW acq.all_fund_combined_balance AS
2364 a.amount - COALESCE( c.amount, 0 ) AS amount
2366 acq.all_fund_allocation_total a
2370 SUM( amount ) AS amount
2375 ) AS c USING ( fund );
2377 CREATE TABLE acq.claim_type (
2378 id SERIAL PRIMARY KEY,
2379 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2380 DEFERRABLE INITIALLY DEFERRED,
2382 description TEXT NOT NULL,
2383 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2386 CREATE TABLE acq.claim (
2387 id SERIAL PRIMARY KEY,
2388 type INT NOT NULL REFERENCES acq.claim_type
2389 DEFERRABLE INITIALLY DEFERRED,
2390 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2391 DEFERRABLE INITIALLY DEFERRED
2394 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2396 CREATE TABLE acq.claim_event (
2397 id BIGSERIAL PRIMARY KEY,
2398 type INT NOT NULL REFERENCES acq.claim_event_type
2399 DEFERRABLE INITIALLY DEFERRED,
2400 claim SERIAL NOT NULL REFERENCES acq.claim
2401 DEFERRABLE INITIALLY DEFERRED,
2402 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2403 creator INT NOT NULL REFERENCES actor.usr
2404 DEFERRABLE INITIALLY DEFERRED,
2408 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2410 -- And the serials version of claiming
2411 CREATE TABLE acq.serial_claim (
2412 id SERIAL PRIMARY KEY,
2413 type INT NOT NULL REFERENCES acq.claim_type
2414 DEFERRABLE INITIALLY DEFERRED,
2415 item BIGINT NOT NULL REFERENCES serial.item
2416 DEFERRABLE INITIALLY DEFERRED
2419 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2421 CREATE TABLE acq.serial_claim_event (
2422 id BIGSERIAL PRIMARY KEY,
2423 type INT NOT NULL REFERENCES acq.claim_event_type
2424 DEFERRABLE INITIALLY DEFERRED,
2425 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2426 DEFERRABLE INITIALLY DEFERRED,
2427 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2428 creator INT NOT NULL REFERENCES actor.usr
2429 DEFERRABLE INITIALLY DEFERRED,
2433 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );
2435 CREATE OR REPLACE VIEW acq.lineitem_summary AS
2439 SELECT COUNT(lid.id)
2440 FROM acq.lineitem_detail lid
2441 WHERE lineitem = li.id
2444 SELECT COUNT(lid.id)
2445 FROM acq.lineitem_detail lid
2446 WHERE recv_time IS NOT NULL AND lineitem = li.id
2449 SELECT COUNT(lid.id)
2450 FROM acq.lineitem_detail lid
2451 WHERE cancel_reason IS NOT NULL AND lineitem = li.id
2454 SELECT COUNT(lid.id)
2455 FROM acq.lineitem_detail lid
2456 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2457 WHERE NOT debit.encumbrance AND lineitem = li.id
2460 SELECT COUNT(DISTINCT(lid.id))
2461 FROM acq.lineitem_detail lid
2462 JOIN acq.claim claim ON (claim.lineitem_detail = lid.id)
2463 WHERE lineitem = li.id
2466 SELECT (COUNT(lid.id) * li.estimated_unit_price)::NUMERIC(8,2)
2467 FROM acq.lineitem_detail lid
2468 WHERE lid.cancel_reason IS NULL AND lineitem = li.id
2469 ) AS estimated_amount,
2471 SELECT SUM(debit.amount)::NUMERIC(8,2)
2472 FROM acq.lineitem_detail lid
2473 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2474 WHERE debit.encumbrance AND lineitem = li.id
2475 ) AS encumbrance_amount,
2477 SELECT SUM(debit.amount)::NUMERIC(8,2)
2478 FROM acq.lineitem_detail lid
2479 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2480 WHERE NOT debit.encumbrance AND lineitem = li.id
2483 FROM acq.lineitem AS li;