2 * Copyright (C) 2009 Georgia Public Library Service
3 * Scott McKellar <scott@esilibrary.com>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 DROP SCHEMA IF EXISTS acq CASCADE;
26 CREATE TABLE acq.currency_type (
27 code TEXT PRIMARY KEY,
31 CREATE TABLE acq.exchange_rate (
32 id SERIAL PRIMARY KEY,
33 from_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
34 to_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
35 ratio NUMERIC NOT NULL,
36 CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
39 CREATE TABLE acq.claim_policy (
40 id SERIAL PRIMARY KEY,
41 org_unit INT NOT NULL REFERENCES actor.org_unit
42 DEFERRABLE INITIALLY DEFERRED,
44 description TEXT NOT NULL,
45 CONSTRAINT name_once_per_org UNIQUE (org_unit, name)
48 CREATE TABLE acq.claim_event_type (
49 id SERIAL PRIMARY KEY,
50 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
51 DEFERRABLE INITIALLY DEFERRED,
53 description TEXT NOT NULL,
54 library_initiated BOOL NOT NULL DEFAULT FALSE,
55 CONSTRAINT event_type_once_per_org UNIQUE ( org_unit, code )
58 CREATE TABLE acq.claim_policy_action (
59 id SERIAL PRIMARY KEY,
60 claim_policy INT NOT NULL REFERENCES acq.claim_policy
62 DEFERRABLE INITIALLY DEFERRED,
63 action_interval INTERVAL NOT NULL,
64 action INT NOT NULL REFERENCES acq.claim_event_type
65 DEFERRABLE INITIALLY DEFERRED,
66 CONSTRAINT action_sequence UNIQUE (claim_policy, action_interval)
69 CREATE TABLE acq.provider (
70 id SERIAL PRIMARY KEY,
72 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
73 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
77 edi_default INT, -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
78 active BOOL NOT NULL DEFAULT TRUE,
79 prepayment_required BOOL NOT NULL DEFAULT FALSE,
84 default_copy_count INT NOT NULL DEFAULT 0,
85 default_claim_policy INT REFERENCES acq.claim_policy
86 DEFERRABLE INITIALLY DEFERRED,
87 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
88 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
91 CREATE TABLE acq.provider_holding_subfield_map (
92 id SERIAL PRIMARY KEY,
93 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
94 name TEXT NOT NULL, -- barcode, price, etc
95 subfield TEXT NOT NULL,
96 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
99 CREATE TABLE acq.provider_address (
100 id SERIAL PRIMARY KEY,
101 valid BOOL NOT NULL DEFAULT TRUE,
103 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
104 street1 TEXT NOT NULL,
109 country TEXT NOT NULL,
110 post_code TEXT NOT NULL,
114 CREATE TABLE acq.provider_contact (
115 id SERIAL PRIMARY KEY,
116 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
118 role TEXT, -- free-form.. e.g. "our sales guy"
123 CREATE TABLE acq.provider_contact_address (
124 id SERIAL PRIMARY KEY,
125 valid BOOL NOT NULL DEFAULT TRUE,
127 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
128 street1 TEXT NOT NULL,
133 country TEXT NOT NULL,
134 post_code TEXT NOT NULL,
138 CREATE TABLE acq.provider_note (
139 id SERIAL PRIMARY KEY,
140 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
141 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
142 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
143 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
144 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
147 CREATE INDEX acq_pro_note_pro_idx ON acq.provider_note ( provider );
148 CREATE INDEX acq_pro_note_creator_idx ON acq.provider_note ( creator );
149 CREATE INDEX acq_pro_note_editor_idx ON acq.provider_note ( editor );
152 CREATE TABLE acq.funding_source (
153 id SERIAL PRIMARY KEY,
155 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
156 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
158 CONSTRAINT funding_source_code_once_per_owner UNIQUE (code,owner),
159 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
162 CREATE TABLE acq.funding_source_credit (
163 id SERIAL PRIMARY KEY,
164 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
165 amount NUMERIC NOT NULL,
167 deadline_date TIMESTAMPTZ,
168 effective_date TIMESTAMPTZ NOT NULL default now()
171 CREATE VIEW acq.ordered_funding_source_credit AS
173 CASE WHEN deadline_date IS NULL THEN
177 END AS sort_priority,
178 CASE WHEN deadline_date IS NULL THEN
188 acq.funding_source_credit;
190 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
191 The acq.ordered_funding_source_credit view is a prioritized
192 ordering of funding source credits. When ordered by the first
193 three columns, this view defines the order in which the various
194 credits are to be tapped for spending, subject to the allocations
195 in the acq.fund_allocation table.
197 The first column reflects the principle that we should spend
198 money with deadlines before spending money without deadlines.
200 The second column reflects the principle that we should spend the
201 oldest money first. For money with deadlines, that means that we
202 spend first from the credit with the earliest deadline. For
203 money without deadlines, we spend first from the credit with the
204 earliest effective date.
206 The third column is a tie breaker to ensure a consistent
210 CREATE TABLE acq.fund (
211 id SERIAL PRIMARY KEY,
212 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
214 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
215 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
217 rollover BOOL NOT NULL DEFAULT FALSE,
218 propagate BOOL NOT NULL DEFAULT TRUE,
219 active BOOL NOT NULL DEFAULT TRUE,
220 balance_warning_percent INT,
221 balance_stop_percent INT,
222 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
223 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
224 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
227 CREATE TABLE acq.fund_debit (
228 id SERIAL PRIMARY KEY,
229 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
230 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
231 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
232 amount NUMERIC NOT NULL,
233 encumbrance BOOL NOT NULL DEFAULT TRUE,
234 debit_type TEXT NOT NULL,
235 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
236 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
239 CREATE TABLE acq.fund_allocation (
240 id SERIAL PRIMARY KEY,
241 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
242 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
243 amount NUMERIC NOT NULL,
244 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
246 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
248 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
250 CREATE TABLE acq.fund_allocation_percent
252 id SERIAL PRIMARY KEY,
253 funding_source INT NOT NULL REFERENCES acq.funding_source
254 DEFERRABLE INITIALLY DEFERRED,
255 org INT NOT NULL REFERENCES actor.org_unit
256 DEFERRABLE INITIALLY DEFERRED,
258 percent NUMERIC NOT NULL,
259 allocator INTEGER NOT NULL REFERENCES actor.usr
260 DEFERRABLE INITIALLY DEFERRED,
262 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
263 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
264 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
267 -- Trigger function to validate combination of org_unit and fund_code
269 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
270 RETURNS TRIGGER AS $$
285 AND code = NEW.fund_code
291 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
296 CREATE TRIGGER acq_fund_alloc_percent_val_trig
297 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
298 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
300 -- To do: trigger to verify that percentages don't add up to more than 100
302 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
303 RETURNS TRIGGER AS $$
306 total_percent numeric;
314 acq.fund_allocation_percent AS fap
316 fap.funding_source = NEW.funding_source;
318 IF total_percent > 100 THEN
319 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
327 CREATE TRIGGER acqfap_limit_100_trig
328 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
329 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
331 CREATE TABLE acq.picklist (
332 id SERIAL PRIMARY KEY,
333 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
334 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
335 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
336 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
338 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
339 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
340 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
342 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
343 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
344 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
346 CREATE TABLE acq.cancel_reason (
347 id SERIAL PRIMARY KEY,
348 org_unit INTEGER NOT NULL REFERENCES actor.org_unit( id )
349 DEFERRABLE INITIALLY DEFERRED,
351 description TEXT NOT NULL,
352 keep_debits BOOL NOT NULL DEFAULT FALSE,
353 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
356 -- Reserve ids 1-999 for stock reasons
357 -- Reserve ids 1000-1999 for EDI reasons
358 -- 2000+ are available for staff to create
360 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
362 DROP TRIGGER IF EXISTS acq_no_deleted_reserved_cancel_reasons ON acq.cancel_reason;
364 CREATE TRIGGER acq_no_deleted_reserved_cancel_reasons BEFORE DELETE ON acq.cancel_reason
365 FOR EACH ROW EXECUTE PROCEDURE evergreen.protect_reserved_rows_from_delete(2000);
367 CREATE TABLE acq.purchase_order (
368 id SERIAL PRIMARY KEY,
369 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
370 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
371 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
372 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
373 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
374 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
375 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
376 state TEXT NOT NULL DEFAULT 'new',
377 order_date TIMESTAMP WITH TIME ZONE,
379 cancel_reason INT REFERENCES acq.cancel_reason( id )
380 DEFERRABLE INITIALLY DEFERRED,
381 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE,
382 CONSTRAINT valid_po_state CHECK (state IN ('new','pending','on-order','received','cancelled'))
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 );
498 CREATE INDEX li_queued_record_idx ON acq.lineitem ( queued_record );
500 CREATE TABLE acq.lineitem_alert_text (
501 id SERIAL PRIMARY KEY,
504 owning_lib INT NOT NULL
505 REFERENCES actor.org_unit(id)
506 DEFERRABLE INITIALLY DEFERRED,
507 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
510 CREATE TABLE acq.lineitem_note (
511 id SERIAL PRIMARY KEY,
512 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
513 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
514 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
515 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
516 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
518 alert_text INT REFERENCES acq.lineitem_alert_text(id)
519 DEFERRABLE INITIALLY DEFERRED,
520 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
522 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
523 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
524 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
526 CREATE TABLE acq.lineitem_detail (
527 id BIGSERIAL PRIMARY KEY,
528 lineitem INT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
529 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
530 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
531 eg_copy_id BIGINT, -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
535 collection_code TEXT,
536 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
537 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
538 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
539 recv_time TIMESTAMP WITH TIME ZONE,
540 receiver INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
541 cancel_reason INT REFERENCES acq.cancel_reason( id ) DEFERRABLE INITIALLY DEFERRED
544 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
545 CREATE INDEX lineitem_detail_fund_debit_idx ON acq.lineitem_detail (fund_debit);
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 fund INTEGER REFERENCES acq.fund (id),
635 circ_modifier TEXT REFERENCES config.circ_modifier (code),
636 collection_code TEXT,
637 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
638 CONSTRAINT acqdfe_must_be_somewhere
639 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
642 CREATE TABLE acq.distribution_formula_application (
643 id BIGSERIAL PRIMARY KEY,
644 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
645 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
647 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
648 lineitem INT NOT NULL
649 REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
652 CREATE INDEX acqdfa_df_idx
653 ON acq.distribution_formula_application(formula);
654 CREATE INDEX acqdfa_li_idx
655 ON acq.distribution_formula_application(lineitem);
656 CREATE INDEX acqdfa_creator_idx
657 ON acq.distribution_formula_application(creator);
659 CREATE TABLE acq.fund_tag (
660 id SERIAL PRIMARY KEY,
662 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
664 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
667 CREATE TABLE acq.fund_tag_map (
668 id SERIAL PRIMARY KEY,
669 fund INTEGER NOT NULL REFERENCES acq.fund(id)
670 DEFERRABLE INITIALLY DEFERRED,
671 tag INTEGER REFERENCES acq.fund_tag(id)
673 DEFERRABLE INITIALLY DEFERRED,
674 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
677 CREATE TABLE acq.fund_transfer (
678 id SERIAL PRIMARY KEY,
679 src_fund INT NOT NULL REFERENCES acq.fund( id )
680 DEFERRABLE INITIALLY DEFERRED,
681 src_amount NUMERIC NOT NULL,
682 dest_fund INT REFERENCES acq.fund( id )
683 DEFERRABLE INITIALLY DEFERRED,
685 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
686 transfer_user INT NOT NULL REFERENCES actor.usr( id )
687 DEFERRABLE INITIALLY DEFERRED,
689 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
690 DEFERRABLE INITIALLY DEFERRED
693 CREATE INDEX acqftr_usr_idx
694 ON acq.fund_transfer( transfer_user );
696 COMMENT ON TABLE acq.fund_transfer IS $$
698 Each row represents the transfer of money from a source fund
699 to a destination fund. There should be corresponding entries
700 in acq.fund_allocation. The purpose of acq.fund_transfer is
701 to record how much money moved from which fund to which other
704 The presence of two amount fields, rather than one, reflects
705 the possibility that the two funds are denominated in different
706 currencies. If they use the same currency type, the two
707 amounts should be the same.
710 CREATE TABLE acq.fiscal_calendar (
711 id SERIAL PRIMARY KEY,
715 -- Create a default calendar (though we don't specify its contents).
716 -- Create a foreign key in actor.org_unit, initially pointing to
717 -- the default calendar.
719 INSERT INTO acq.fiscal_calendar (
726 ALTER TABLE actor.org_unit ADD FOREIGN KEY
727 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
728 DEFERRABLE INITIALLY DEFERRED;
730 CREATE TABLE acq.fiscal_year (
731 id SERIAL PRIMARY KEY,
732 calendar INT NOT NULL
733 REFERENCES acq.fiscal_calendar
735 DEFERRABLE INITIALLY DEFERRED,
737 year_begin TIMESTAMPTZ NOT NULL,
738 year_end TIMESTAMPTZ NOT NULL,
739 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
740 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
743 CREATE TABLE acq.edi_attr (
744 key TEXT PRIMARY KEY,
745 label TEXT NOT NULL UNIQUE
748 CREATE TABLE acq.edi_attr_set (
749 id SERIAL PRIMARY KEY,
750 label TEXT NOT NULL UNIQUE
753 CREATE TABLE acq.edi_attr_set_map (
754 id SERIAL PRIMARY KEY,
755 attr_set INTEGER NOT NULL REFERENCES acq.edi_attr_set(id)
756 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
757 attr TEXT NOT NULL REFERENCES acq.edi_attr(key)
758 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
759 CONSTRAINT edi_attr_set_map_attr_once UNIQUE (attr_set, attr)
762 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
763 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
764 in_dir TEXT, -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
767 attr_set INTEGER REFERENCES acq.edi_attr_set(id), -- NULL OK
768 use_attrs BOOLEAN NOT NULL DEFAULT FALSE
769 ) INHERITS (config.remote_account);
771 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
772 ALTER TABLE acq.edi_account ADD PRIMARY KEY (id);
774 CREATE TABLE acq.edi_message (
775 id SERIAL PRIMARY KEY,
776 account INTEGER REFERENCES acq.edi_account(id)
777 DEFERRABLE INITIALLY DEFERRED,
779 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
780 translate_time TIMESTAMPTZ,
781 process_time TIMESTAMPTZ,
782 error_time TIMESTAMPTZ,
783 status TEXT NOT NULL DEFAULT 'new'
784 CONSTRAINT status_value CHECK
786 'new', -- needs to be translated
787 'translated', -- needs to be processed
788 'trans_error', -- error in translation step
789 'processed', -- needs to have remote_file deleted
790 'proc_error', -- error in processing step
791 'delete_error', -- error in deletion
792 'retry', -- need to retry
798 purchase_order INT REFERENCES acq.purchase_order
799 DEFERRABLE INITIALLY DEFERRED,
800 message_type TEXT NOT NULL CONSTRAINT valid_message_type CHECK
809 CREATE INDEX edi_message_account_status_idx ON acq.edi_message (account,status);
810 CREATE INDEX edi_message_po_idx ON acq.edi_message (purchase_order);
811 CREATE INDEX edi_message_remote_file_idx ON acq.edi_message (evergreen.lowercase(remote_file));
813 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
814 -- the table, assigning ids programmatically instead of using a sequence.
815 CREATE TABLE acq.debit_attribution (
816 id INT NOT NULL PRIMARY KEY,
817 fund_debit INT NOT NULL
818 REFERENCES acq.fund_debit
819 DEFERRABLE INITIALLY DEFERRED,
820 debit_amount NUMERIC NOT NULL,
821 funding_source_credit INT REFERENCES acq.funding_source_credit
822 DEFERRABLE INITIALLY DEFERRED,
823 credit_amount NUMERIC
826 CREATE INDEX acq_attribution_debit_idx
827 ON acq.debit_attribution( fund_debit );
829 CREATE INDEX acq_attribution_credit_idx
830 ON acq.debit_attribution( funding_source_credit );
834 CREATE TABLE acq.invoice_method (
835 code TEXT PRIMARY KEY,
836 name TEXT NOT NULL -- i18n-ize
839 CREATE TABLE acq.invoice_payment_method (
840 code TEXT PRIMARY KEY,
841 name TEXT NOT NULL -- i18n-ize
844 CREATE TABLE acq.invoice (
845 id SERIAL PRIMARY KEY,
846 receiver INT NOT NULL REFERENCES actor.org_unit (id),
847 provider INT NOT NULL REFERENCES acq.provider (id),
848 shipper INT NOT NULL REFERENCES acq.provider (id),
849 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
850 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
851 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
852 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
854 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
855 DEFERRABLE INITIALLY DEFERRED,
857 complete BOOL NOT NULL DEFAULT FALSE,
858 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
861 CREATE TABLE acq.invoice_entry (
862 id SERIAL PRIMARY KEY,
863 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
864 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
865 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
866 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
867 phys_item_count INT, -- and how many did staff count
869 billed_per_item BOOL,
870 cost_billed NUMERIC(8,2),
871 actual_cost NUMERIC(8,2),
872 amount_paid NUMERIC (8,2)
875 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
876 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
877 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
879 ALTER TABLE acq.fund_debit
880 ADD COLUMN invoice_entry INTEGER
881 REFERENCES acq.invoice_entry (id)
884 CREATE INDEX fund_debit_invoice_entry_idx ON acq.fund_debit (invoice_entry);
886 CREATE TABLE acq.invoice_item_type (
887 code TEXT PRIMARY KEY,
888 name TEXT NOT NULL, -- i18n-ize
889 prorate BOOL NOT NULL DEFAULT FALSE,
890 blanket BOOL NOT NULL DEFAULT FALSE,
891 CONSTRAINT aiit_not_blanket_and_prorate
892 CHECK (blanket IS FALSE OR prorate IS FALSE)
895 CREATE TABLE acq.po_item (
896 id SERIAL PRIMARY KEY,
897 purchase_order INT REFERENCES acq.purchase_order (id)
898 ON UPDATE CASCADE ON DELETE SET NULL
899 DEFERRABLE INITIALLY DEFERRED,
900 fund_debit INT REFERENCES acq.fund_debit (id)
901 DEFERRABLE INITIALLY DEFERRED,
902 inv_item_type TEXT NOT NULL
903 REFERENCES acq.invoice_item_type (code)
904 DEFERRABLE INITIALLY DEFERRED,
908 estimated_cost NUMERIC(8,2),
909 fund INT REFERENCES acq.fund (id)
910 DEFERRABLE INITIALLY DEFERRED,
914 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
916 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
917 id SERIAL PRIMARY KEY,
918 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
919 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
920 fund_debit INT REFERENCES acq.fund_debit (id),
921 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
925 cost_billed NUMERIC(8,2),
926 actual_cost NUMERIC(8,2),
927 fund INT REFERENCES acq.fund (id)
928 DEFERRABLE INITIALLY DEFERRED,
929 amount_paid NUMERIC (8,2),
930 po_item INT REFERENCES acq.po_item (id)
931 DEFERRABLE INITIALLY DEFERRED,
935 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
936 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
937 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
940 CREATE TABLE acq.user_request_type (
941 id SERIAL PRIMARY KEY,
942 label TEXT NOT NULL UNIQUE -- i18n-ize
945 CREATE TABLE acq.user_request (
946 id SERIAL PRIMARY KEY,
947 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
948 hold BOOL NOT NULL DEFAULT TRUE,
950 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
951 holdable_formats TEXT, -- nullable, for use in hold creation
953 email_notify BOOL NOT NULL DEFAULT TRUE,
954 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
955 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
956 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
957 need_before TIMESTAMPTZ, -- don't create holds after this
960 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
972 cancel_reason INT REFERENCES acq.cancel_reason( id )
973 DEFERRABLE INITIALLY DEFERRED
979 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
980 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
983 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
986 SELECT COUNT(*) INTO counter
987 FROM oils_xpath_table(
991 '//*[@tag="' || tag || '"]',
993 ) as t(i int,c text);
995 FOR i IN 1 .. counter LOOP
998 FROM ( SELECT id,i,t,v
999 FROM oils_xpath_table(
1003 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
1004 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
1006 ) as t(id int,t text,v text)
1015 $$ LANGUAGE PLPGSQL;
1017 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
1018 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
1022 lida acq.flat_lineitem_detail%ROWTYPE;
1024 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
1025 IF NOT FOUND THEN RETURN; END IF;
1027 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
1028 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1035 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1036 JOIN acq.provider_holding_subfield_map a USING (subfield)
1037 WHERE a.provider = prov_i
1044 $$ LANGUAGE PLPGSQL;
1046 -- select * from acq.extract_provider_holding_data(699);
1048 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1049 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1052 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field_set ( BIGINT, TEXT, TEXT) RETURNS SETOF TEXT AS $$
1053 SELECT extract_marc_field_set('acq.lineitem', $1, $2, $3);
1058 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1059 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1062 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1063 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1067 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1070 Suggested vendor fields:
1078 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1087 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1089 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1091 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1092 IF (atype = 'lineitem_provider_attr_definition') THEN
1093 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1094 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1097 IF (atype = 'lineitem_provider_attr_definition') THEN
1098 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1099 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1100 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1101 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1102 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1105 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1107 IF (adef.code = 'title' OR adef.code = 'author') THEN
1108 -- title and author should not be split
1109 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1110 -- string-join in the xpath and remove this special case
1111 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1112 IF (value IS NOT NULL AND value <> '') THEN
1113 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1114 VALUES (NEW.id, adef.id, atype, adef.code, value);
1119 -- each application of the regex may produce multiple values
1121 SELECT * FROM extract_acq_marc_field_set(
1122 NEW.id, xpath_string || '[' || pos || ']', adef.remove)
1125 IF (value IS NOT NULL AND value <> '') THEN
1126 INSERT INTO acq.lineitem_attr
1127 (lineitem, definition, attr_type, attr_name, attr_value)
1128 VALUES (NEW.id, adef.id, atype, adef.code, value);
1146 $function$ LANGUAGE PLPGSQL;
1148 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1150 IF TG_OP = 'UPDATE' THEN
1151 DELETE FROM acq.lineitem_attr
1152 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1155 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1159 $$ LANGUAGE PLPGSQL;
1161 CREATE TRIGGER cleanup_lineitem_trigger
1162 BEFORE UPDATE OR DELETE ON acq.lineitem
1163 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1165 CREATE TRIGGER ingest_lineitem_trigger
1166 AFTER INSERT OR UPDATE ON acq.lineitem
1167 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1169 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1173 IF from_ex = to_ex THEN
1177 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1182 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1191 $$ LANGUAGE PLPGSQL;
1193 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1194 SELECT $3 * acq.exchange_ratio($1, $2);
1197 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1199 Examine the acq.fiscal_year table, comparing successive years.
1200 Report any inconsistencies, i.e. years that overlap, have gaps
1201 between them, or are out of sequence.
1203 RETURNS SETOF RECORD AS $$
1227 ELSIF curr_year.calendar = prev_year.calendar THEN
1228 IF curr_year.year_begin > prev_year.year_end THEN
1229 -- This ugly kludge works around the fact that older
1230 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1231 FOR return_rec IN SELECT
1234 'Gap between fiscal years'::TEXT
1236 RETURN NEXT return_rec;
1238 ELSIF curr_year.year_begin < prev_year.year_end THEN
1239 FOR return_rec IN SELECT
1242 'Overlapping fiscal years'::TEXT
1244 RETURN NEXT return_rec;
1246 ELSIF curr_year.year < prev_year.year THEN
1247 FOR return_rec IN SELECT
1250 'Fiscal years out of order'::TEXT
1252 RETURN NEXT return_rec;
1257 prev_year := curr_year;
1262 $$ LANGUAGE plpgsql;
1264 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1266 old_amount IN NUMERIC, -- in currency of old fund
1268 new_amount IN NUMERIC, -- in currency of new fund
1270 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1271 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1272 ) RETURNS VOID AS $$
1273 /* -------------------------------------------------------------------------------
1275 Function to transfer money from one fund to another.
1277 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1278 negative amount for the old (losing) fund and a positive amount for the new
1279 (gaining) fund. In some cases there may be more than one such pair of entries
1280 in order to pull the money from different funding sources, or more specifically
1281 from different funding source credits. For each such pair there is also an
1282 entry in acq.fund_transfer.
1284 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1285 choose a funding source for the transferred money to come from. This choice
1286 must meet two constraints, so far as possible:
1288 1. The amount transferred from a given funding source must not exceed the
1289 amount allocated to the old fund by the funding source. To that end we
1290 compare the amount being transferred to the amount allocated.
1292 2. We shouldn't transfer money that has already been spent or encumbered, as
1293 defined by the funding attribution process. We attribute expenses to the
1294 oldest funding source credits first. In order to avoid transferring that
1295 attributed money, we reverse the priority, transferring from the newest funding
1296 source credits first. There can be no guarantee that this approach will
1297 avoid overcommitting a fund, but no other approach can do any better.
1299 In this context the age of a funding source credit is defined by the
1300 deadline_date for credits with deadline_dates, and by the effective_date for
1301 credits without deadline_dates, with the proviso that credits with deadline_dates
1302 are all considered "older" than those without.
1306 In the signature for this function, there is one last parameter commented out,
1307 named "funding_source_in". Correspondingly, the WHERE clause for the query
1308 driving the main loop has an OR clause commented out, which references the
1309 funding_source_in parameter.
1311 If these lines are uncommented, this function will allow the user optionally to
1312 restrict a fund transfer to a specified funding source. If the source
1313 parameter is left NULL, then there will be no such restriction.
1315 ------------------------------------------------------------------------------- */
1317 same_currency BOOLEAN;
1318 currency_ratio NUMERIC;
1319 old_fund_currency TEXT;
1320 old_remaining NUMERIC; -- in currency of old fund
1321 new_fund_currency TEXT;
1322 new_fund_active BOOLEAN;
1323 new_remaining NUMERIC; -- in currency of new fund
1324 curr_old_amt NUMERIC; -- in currency of old fund
1325 curr_new_amt NUMERIC; -- in currency of new fund
1326 source_addition NUMERIC; -- in currency of funding source
1327 source_deduction NUMERIC; -- in currency of funding source
1328 orig_allocated_amt NUMERIC; -- in currency of funding source
1329 allocated_amt NUMERIC; -- in currency of fund
1335 IF old_fund IS NULL THEN
1336 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1339 IF old_amount IS NULL THEN
1340 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1343 -- The new fund and its amount must be both NULL or both not NULL.
1345 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1346 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1349 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1350 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1353 IF user_id IS NULL THEN
1354 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1357 -- Initialize the amounts to be transferred, each denominated
1358 -- in the currency of its respective fund. They will be
1359 -- reduced on each iteration of the loop.
1361 old_remaining := old_amount;
1362 new_remaining := new_amount;
1364 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1365 -- old_amount, old_fund, new_amount, new_fund;
1367 -- Get the currency types of the old and new funds.
1378 IF old_fund_currency IS NULL THEN
1379 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1382 IF new_fund IS NOT NULL THEN
1394 IF new_fund_currency IS NULL THEN
1395 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1396 ELSIF NOT new_fund_active THEN
1398 -- No point in putting money into a fund from whence you can't spend it
1400 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1403 IF new_amount = old_amount THEN
1404 same_currency := true;
1405 currency_ratio := 1;
1408 -- We'll have to translate currency between funds. We presume that
1409 -- the calling code has already applied an appropriate exchange rate,
1410 -- so we'll apply the same conversion to each sub-transfer.
1412 same_currency := false;
1413 currency_ratio := new_amount / old_amount;
1417 -- Identify the funding source(s) from which we want to transfer the money.
1418 -- The principle is that we want to transfer the newest money first, because
1419 -- we spend the oldest money first. The priority for spending is defined
1420 -- by a sort of the view acq.ordered_funding_source_credit.
1425 ofsc.funding_source,
1427 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1431 acq.ordered_funding_source_credit AS ofsc,
1432 acq.funding_source fs
1434 ofsc.funding_source = fs.id
1435 and ofsc.funding_source IN
1437 SELECT funding_source
1438 FROM acq.fund_allocation
1439 WHERE fund = old_fund
1443 -- ofsc.funding_source = funding_source_in
1444 -- OR funding_source_in IS NULL
1447 ofsc.sort_priority desc,
1448 ofsc.sort_date desc,
1452 -- Determine how much money the old fund got from this funding source,
1453 -- denominated in the currency types of the source and of the fund.
1454 -- This result may reflect transfers from previous iterations.
1457 COALESCE( sum( amount ), 0 ),
1458 COALESCE( sum( amount )
1459 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1461 orig_allocated_amt, -- in currency of the source
1462 allocated_amt -- in currency of the old fund
1467 and funding_source = source.funding_source;
1469 -- Determine how much to transfer from this credit, in the currency
1470 -- of the fund. Begin with the amount remaining to be attributed:
1472 curr_old_amt := old_remaining;
1474 -- Can't attribute more than was allocated from the fund:
1476 IF curr_old_amt > allocated_amt THEN
1477 curr_old_amt := allocated_amt;
1480 -- Can't attribute more than the amount of the current credit:
1482 IF curr_old_amt > source.converted_amt THEN
1483 curr_old_amt := source.converted_amt;
1486 curr_old_amt := trunc( curr_old_amt, 2 );
1488 old_remaining := old_remaining - curr_old_amt;
1490 -- Determine the amount to be deducted, if any,
1491 -- from the old allocation.
1493 IF old_remaining > 0 THEN
1495 -- In this case we're using the whole allocation, so use that
1496 -- amount directly instead of applying a currency translation
1497 -- and thereby inviting round-off errors.
1499 source_deduction := - curr_old_amt;
1501 source_deduction := trunc(
1502 ( - curr_old_amt ) *
1503 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1507 IF source_deduction <> 0 THEN
1509 -- Insert negative allocation for old fund in fund_allocation,
1510 -- converted into the currency of the funding source
1512 INSERT INTO acq.fund_allocation (
1519 source.funding_source,
1523 'Transfer to fund ' || new_fund
1527 IF new_fund IS NOT NULL THEN
1529 -- Determine how much to add to the new fund, in
1530 -- its currency, and how much remains to be added:
1532 IF same_currency THEN
1533 curr_new_amt := curr_old_amt;
1535 IF old_remaining = 0 THEN
1537 -- This is the last iteration, so nothing should be left
1539 curr_new_amt := new_remaining;
1542 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1543 new_remaining := new_remaining - curr_new_amt;
1547 -- Determine how much to add, if any,
1548 -- to the new fund's allocation.
1550 IF old_remaining > 0 THEN
1552 -- In this case we're using the whole allocation, so use that amount
1553 -- amount directly instead of applying a currency translation and
1554 -- thereby inviting round-off errors.
1556 source_addition := curr_new_amt;
1557 ELSIF source.currency_type = old_fund_currency THEN
1559 -- In this case we don't need a round trip currency translation,
1560 -- thereby inviting round-off errors:
1562 source_addition := curr_old_amt;
1564 source_addition := trunc(
1566 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1570 IF source_addition <> 0 THEN
1572 -- Insert positive allocation for new fund in fund_allocation,
1573 -- converted to the currency of the founding source
1575 INSERT INTO acq.fund_allocation (
1582 source.funding_source,
1586 'Transfer from fund ' || old_fund
1591 IF trunc( curr_old_amt, 2 ) <> 0
1592 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1594 -- Insert row in fund_transfer, using amounts in the currency of the funds
1596 INSERT INTO acq.fund_transfer (
1603 funding_source_credit
1606 trunc( curr_old_amt, 2 ),
1608 trunc( curr_new_amt, 2 ),
1615 if old_remaining <= 0 THEN
1616 EXIT; -- Nothing more to be transferred
1620 $$ LANGUAGE plpgsql;
1622 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1624 Function to attribute expenditures and encumbrances to funding source credits,
1625 and thereby to funding sources.
1627 Read the debits in chonological order, attributing each one to one or
1628 more funding source credits. Constraints:
1630 1. Don't attribute more to a credit than the amount of the credit.
1632 2. For a given fund, don't attribute more to a funding source than the
1633 source has allocated to that fund.
1635 3. Attribute debits to credits with deadlines before attributing them to
1636 credits without deadlines. Otherwise attribute to the earliest credits
1637 first, based on the deadline date when present, or on the effective date
1638 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1639 This ordering is defined by an ORDER BY clause on the view
1640 acq.ordered_funding_source_credit.
1642 Start by truncating the table acq.debit_attribution. Then insert a row
1643 into that table for each attribution. If a debit cannot be fully
1644 attributed, insert a row for the unattributable balance, with the
1645 funding_source_credit and credit_amount columns NULL.
1648 curr_fund_source_bal RECORD;
1649 seqno INT; -- sequence num for credits applicable to a fund
1650 fund_credit RECORD; -- current row in temp t_fund_credit table
1651 fc RECORD; -- used for loading t_fund_credit table
1652 sc RECORD; -- used for loading t_fund_credit table
1654 -- Used exclusively in the main loop:
1656 deb RECORD; -- current row from acq.fund_debit table
1657 curr_credit_bal RECORD; -- current row from temp t_credit table
1658 debit_balance NUMERIC; -- amount left to attribute for current debit
1659 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1660 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1661 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1662 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1663 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1664 attrib_count INT; -- populates id of acq.debit_attribution
1667 -- Load a temporary table. For each combination of fund and funding source,
1668 -- load an entry with the total amount allocated to that fund by that source.
1669 -- This sum may reflect transfers as well as original allocations. We will
1670 -- reduce this balance whenever we attribute debits to it.
1672 CREATE TEMP TABLE t_fund_source_bal
1676 funding_source AS source,
1677 sum( amount ) AS balance
1686 CREATE INDEX t_fund_source_bal_idx
1687 ON t_fund_source_bal( fund, source );
1688 -------------------------------------------------------------------------------
1690 -- Load another temporary table. For each fund, load zero or more
1691 -- funding source credits from which that fund can get money.
1693 CREATE TEMP TABLE t_fund_credit (
1700 SELECT DISTINCT fund
1701 FROM acq.fund_allocation
1703 LOOP -- Loop over the funds
1709 acq.ordered_funding_source_credit AS ofsc
1711 ofsc.funding_source IN
1713 SELECT funding_source
1714 FROM acq.fund_allocation
1715 WHERE fund = fc.fund
1721 LOOP -- Add each credit to the list
1722 INSERT INTO t_fund_credit (
1731 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1733 END LOOP; -- Loop over credits for a given fund
1734 END LOOP; -- Loop over funds
1736 CREATE INDEX t_fund_credit_idx
1737 ON t_fund_credit( fund, seq );
1738 -------------------------------------------------------------------------------
1740 -- Load yet another temporary table. This one is a list of funding source
1741 -- credits, with their balances. We shall reduce those balances as we
1742 -- attribute debits to them.
1744 CREATE TEMP TABLE t_credit
1748 fsc.funding_source AS source,
1749 fsc.amount AS balance,
1750 fs.currency_type AS currency_type
1752 acq.funding_source_credit AS fsc,
1753 acq.funding_source fs
1755 fsc.funding_source = fs.id
1758 CREATE INDEX t_credit_idx
1759 ON t_credit( credit );
1761 -------------------------------------------------------------------------------
1763 -- Now that we have loaded the lookup tables: loop through the debits,
1764 -- attributing each one to one or more funding source credits.
1766 truncate table acq.debit_attribution;
1784 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1786 debit_balance := deb.amount;
1788 -- Loop over the funding source credits that are eligible
1789 -- to pay for this debit
1801 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1803 -- Look up the balance for this credit. If it's zero, then
1804 -- it's not useful, so treat it as if you didn't find it.
1805 -- (Actually there shouldn't be any zero balances in the table,
1806 -- but we check just to make sure.)
1809 INTO curr_credit_bal
1812 credit = fund_credit.credit
1815 IF curr_credit_bal IS NULL THEN
1817 -- This credit is exhausted; try the next one.
1823 -- At this point we have an applicable credit with some money left.
1824 -- Now see if the relevant funding_source has any money left.
1826 -- Look up the balance of the allocation for this combination of
1827 -- fund and source. If you find such an entry, but it has a zero
1828 -- balance, then it's not useful, so treat it as unfound.
1829 -- (Actually there shouldn't be any zero balances in the table,
1830 -- but we check just to make sure.)
1833 INTO curr_fund_source_bal
1834 FROM t_fund_source_bal
1837 AND source = curr_credit_bal.source
1840 IF curr_fund_source_bal IS NULL THEN
1842 -- This fund/source doesn't exist or is already exhausted,
1843 -- so we can't use this credit. Go on to the next one.
1848 -- Convert the available balances to the currency of the fund
1850 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1851 curr_credit_bal.currency_type, deb.currency_type );
1852 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1853 curr_credit_bal.currency_type, deb.currency_type );
1855 -- Determine how much we can attribute to this credit: the minimum
1856 -- of the debit amount, the fund/source balance, and the
1859 --RAISE NOTICE ' deb bal %', debit_balance;
1860 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1861 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1863 conv_attr_amount := NULL;
1864 attr_amount := debit_balance;
1866 IF attr_amount > conv_alloc_balance THEN
1867 attr_amount := conv_alloc_balance;
1868 conv_attr_amount := curr_fund_source_bal.balance;
1870 IF attr_amount > conv_cred_balance THEN
1871 attr_amount := conv_cred_balance;
1872 conv_attr_amount := curr_credit_bal.balance;
1875 -- If we're attributing all of one of the balances, then that's how
1876 -- much we will deduct from the balances, and we already captured
1877 -- that amount above. Otherwise we must convert the amount of the
1878 -- attribution from the currency of the fund back to the currency of
1879 -- the funding source.
1881 IF conv_attr_amount IS NULL THEN
1882 conv_attr_amount := attr_amount * acq.exchange_ratio(
1883 deb.currency_type, curr_credit_bal.currency_type );
1886 -- Insert a row to record the attribution
1888 attrib_count := attrib_count + 1;
1889 INSERT INTO acq.debit_attribution (
1893 funding_source_credit,
1899 curr_credit_bal.credit,
1903 -- Subtract the attributed amount from the various balances
1905 debit_balance := debit_balance - attr_amount;
1906 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1908 IF curr_fund_source_bal.balance <= 0 THEN
1910 -- This allocation is exhausted. Delete it so
1911 -- that we don't waste time looking at it again.
1913 DELETE FROM t_fund_source_bal
1915 fund = curr_fund_source_bal.fund
1916 AND source = curr_fund_source_bal.source;
1918 UPDATE t_fund_source_bal
1919 SET balance = balance - conv_attr_amount
1921 fund = curr_fund_source_bal.fund
1922 AND source = curr_fund_source_bal.source;
1925 IF curr_credit_bal.balance <= 0 THEN
1927 -- This funding source credit is exhausted. Delete it
1928 -- so that we don't waste time looking at it again.
1930 --DELETE FROM t_credit
1932 -- credit = curr_credit_bal.credit;
1934 DELETE FROM t_fund_credit
1936 credit = curr_credit_bal.credit;
1939 SET balance = curr_credit_bal.balance
1941 credit = curr_credit_bal.credit;
1944 -- Are we done with this debit yet?
1946 IF debit_balance <= 0 THEN
1947 EXIT; -- We've fully attributed this debit; stop looking at credits.
1949 END LOOP; -- End loop over credits
1951 IF debit_balance <> 0 THEN
1953 -- We weren't able to attribute this debit, or at least not
1954 -- all of it. Insert a row for the unattributed balance.
1956 attrib_count := attrib_count + 1;
1957 INSERT INTO acq.debit_attribution (
1961 funding_source_credit,
1971 END LOOP; -- End of loop over debits
1973 $$ LANGUAGE 'plpgsql';
1975 CREATE OR REPLACE FUNCTION acq.copy_fund_tags(
1976 old_fund_id INTEGER,
1978 ) RETURNS VOID AS $$
1980 fund_tag_rec RECORD;
1983 FOR fund_tag_rec IN SELECT * FROM acq.fund_tag_map WHERE fund=old_fund_id LOOP
1985 INSERT INTO acq.fund_tag_map(fund, tag) VALUES(new_fund_id, fund_tag_rec.tag);
1987 WHEN unique_violation THEN
1988 -- RAISE NOTICE 'Fund tag already propagated', old_fund.id;
1994 $$ LANGUAGE plpgsql;
1996 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1999 org_unit_id INTEGER,
2000 include_desc BOOL DEFAULT TRUE
2001 ) RETURNS VOID AS $$
2012 IF old_year IS NULL THEN
2013 RAISE EXCEPTION 'Input year argument is NULL';
2014 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2015 RAISE EXCEPTION 'Input year is out of range';
2018 IF user_id IS NULL THEN
2019 RAISE EXCEPTION 'Input user id argument is NULL';
2022 IF org_unit_id IS NULL THEN
2023 RAISE EXCEPTION 'Org unit id argument is NULL';
2025 SELECT TRUE INTO org_found
2027 WHERE id = org_unit_id;
2029 IF org_found IS NULL THEN
2030 RAISE EXCEPTION 'Org unit id is invalid';
2034 -- Loop over the applicable funds
2036 FOR old_fund in SELECT * FROM acq.fund
2040 AND ( ( include_desc AND org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2041 OR (NOT include_desc AND org = org_unit_id ) )
2045 INSERT INTO acq.fund (
2053 balance_warning_percent,
2054 balance_stop_percent
2059 old_fund.currency_type,
2063 old_fund.balance_warning_percent,
2064 old_fund.balance_stop_percent
2066 RETURNING id INTO new_id;
2068 WHEN unique_violation THEN
2069 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2073 PERFORM acq.copy_fund_tags(old_fund.id,new_id);
2075 --RAISE NOTICE 'Propagating fund % to fund %',
2076 -- old_fund.code, new_id;
2079 $$ LANGUAGE plpgsql;
2081 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER ) RETURNS VOID AS $$
2082 SELECT acq.propagate_funds_by_org_tree( $1, $2, $3, FALSE );
2085 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2088 org_unit_id INTEGER,
2089 encumb_only BOOL DEFAULT FALSE,
2090 include_desc BOOL DEFAULT TRUE
2091 ) RETURNS VOID AS $$
2095 new_year INT := old_year + 1;
2098 xfer_amount NUMERIC := 0;
2102 roll_distrib_forms BOOL;
2108 IF old_year IS NULL THEN
2109 RAISE EXCEPTION 'Input year argument is NULL';
2110 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2111 RAISE EXCEPTION 'Input year is out of range';
2114 IF user_id IS NULL THEN
2115 RAISE EXCEPTION 'Input user id argument is NULL';
2118 IF org_unit_id IS NULL THEN
2119 RAISE EXCEPTION 'Org unit id argument is NULL';
2122 -- Validate the org unit
2127 WHERE id = org_unit_id;
2129 IF org_found IS NULL THEN
2130 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2131 ELSIF encumb_only THEN
2132 SELECT INTO perm_ous value::BOOL FROM
2133 actor.org_unit_ancestor_setting(
2134 'acq.fund.allow_rollover_without_money', org_unit_id
2136 IF NOT FOUND OR NOT perm_ous THEN
2137 RAISE EXCEPTION 'Encumbrance-only rollover not permitted at org %', org_unit_id;
2142 -- Loop over the propagable funds to identify the details
2143 -- from the old fund plus the id of the new one, if it exists.
2147 oldf.id AS old_fund,
2153 newf.id AS new_fund_id
2156 LEFT JOIN acq.fund AS newf
2157 ON ( oldf.code = newf.code )
2159 oldf.year = old_year
2161 AND newf.year = new_year
2162 AND ( ( include_desc AND oldf.org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2163 OR (NOT include_desc AND oldf.org = org_unit_id ) )
2165 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2167 IF roll_fund.new_fund_id IS NULL THEN
2169 -- The old fund hasn't been propagated yet. Propagate it now.
2171 INSERT INTO acq.fund (
2179 balance_warning_percent,
2180 balance_stop_percent
2185 roll_fund.currency_type,
2189 roll_fund.balance_warning_percent,
2190 roll_fund.balance_stop_percent
2192 RETURNING id INTO new_fund;
2194 PERFORM acq.copy_fund_tags(roll_fund.id,new_fund);
2197 new_fund = roll_fund.new_fund_id;
2200 -- Determine the amount to transfer
2204 FROM acq.fund_spent_balance
2205 WHERE fund = roll_fund.old_fund;
2207 IF xfer_amount <> 0 THEN
2208 IF NOT encumb_only AND roll_fund.rollover THEN
2210 -- Transfer balance from old fund to new
2212 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2214 PERFORM acq.transfer_fund(
2224 -- Transfer balance from old fund to the void
2226 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2228 PERFORM acq.transfer_fund(
2234 'Rollover into the void'
2239 IF roll_fund.rollover THEN
2241 -- Move any lineitems from the old fund to the new one
2242 -- where the associated debit is an encumbrance.
2244 -- Any other tables tying expenditure details to funds should
2245 -- receive similar treatment. At this writing there are none.
2247 UPDATE acq.lineitem_detail
2250 fund = roll_fund.old_fund -- this condition may be redundant
2256 fund = roll_fund.old_fund
2260 -- Move encumbrance debits from the old fund to the new fund
2262 UPDATE acq.fund_debit
2265 fund = roll_fund.old_fund
2269 -- Rollover distribution formulae funds
2270 SELECT INTO roll_distrib_forms value::BOOL FROM
2271 actor.org_unit_ancestor_setting(
2272 'acq.fund.rollover_distrib_forms', org_unit_id
2275 IF roll_distrib_forms THEN
2276 UPDATE acq.distribution_formula_entry
2277 SET fund = roll_fund.new_fund_id
2278 WHERE fund = roll_fund.old_fund;
2282 -- Mark old fund as inactive, now that we've closed it
2286 WHERE id = roll_fund.old_fund;
2289 $$ LANGUAGE plpgsql;
2294 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 $$
2295 SELECT acq.rollover_funds_by_org_tree( $1, $2, $3, $4, FALSE );
2298 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2299 SELECT funding_source,
2300 SUM(amount) AS amount
2301 FROM acq.funding_source_credit
2304 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2305 SELECT funding_source,
2306 SUM(a.amount)::NUMERIC(100,2) AS amount
2307 FROM acq.fund_allocation a
2310 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2311 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2312 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2313 FROM acq.funding_source_credit_total c
2314 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2317 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2319 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2320 FROM acq.fund_allocation a
2321 JOIN acq.fund f ON (a.fund = f.id)
2322 JOIN acq.funding_source s ON (a.funding_source = s.id)
2325 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2326 SELECT fund.id AS fund,
2327 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2329 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2332 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2335 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2337 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2338 WHERE fund_debit.encumbrance GROUP BY fund.id;
2340 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2341 SELECT fund.id AS fund,
2342 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2344 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2345 WHERE NOT fund_debit.encumbrance
2348 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2350 c.amount - COALESCE(d.amount, 0.0) AS amount
2351 FROM acq.fund_allocation_total c
2352 LEFT JOIN acq.fund_debit_total d USING (fund);
2354 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2356 c.amount - COALESCE(d.amount,0.0) AS amount
2357 FROM acq.fund_allocation_total c
2358 LEFT JOIN acq.fund_spent_total d USING (fund);
2360 -- For each fund: the total allocation from all sources, in the
2361 -- currency of the fund (or 0 if there are no allocations)
2363 CREATE VIEW acq.all_fund_allocation_total AS
2366 COALESCE( SUM( a.amount * acq.exchange_ratio(
2367 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2371 LEFT JOIN acq.fund_allocation a
2373 LEFT JOIN acq.funding_source s
2374 ON a.funding_source = s.id
2378 -- For every fund: the total encumbrances (or 0 if none),
2379 -- in the currency of the fund.
2381 CREATE VIEW acq.all_fund_encumbrance_total AS
2384 COALESCE( encumb.amount, 0 ) AS amount
2390 sum( amount ) AS amount
2397 ON f.id = encumb.fund;
2399 -- For every fund: the total spent (or 0 if none),
2400 -- in the currency of the fund.
2402 CREATE VIEW acq.all_fund_spent_total AS
2405 COALESCE( spent.amount, 0 ) AS amount
2411 sum( amount ) AS amount
2418 ON f.id = spent.fund;
2420 -- For each fund: the amount not yet spent, in the currency
2421 -- of the fund. May include encumbrances.
2423 CREATE VIEW acq.all_fund_spent_balance AS
2426 c.amount - d.amount AS amount
2427 FROM acq.all_fund_allocation_total c
2428 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2430 -- For each fund: the amount neither spent nor encumbered,
2431 -- in the currency of the fund
2433 CREATE VIEW acq.all_fund_combined_balance AS
2436 a.amount - COALESCE( c.amount, 0 ) AS amount
2438 acq.all_fund_allocation_total a
2442 SUM( amount ) AS amount
2447 ) AS c USING ( fund );
2449 CREATE TABLE acq.claim_type (
2450 id SERIAL PRIMARY KEY,
2451 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2452 DEFERRABLE INITIALLY DEFERRED,
2454 description TEXT NOT NULL,
2455 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2458 CREATE TABLE acq.claim (
2459 id SERIAL PRIMARY KEY,
2460 type INT NOT NULL REFERENCES acq.claim_type
2461 DEFERRABLE INITIALLY DEFERRED,
2462 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2463 DEFERRABLE INITIALLY DEFERRED
2466 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2468 CREATE TABLE acq.claim_event (
2469 id BIGSERIAL PRIMARY KEY,
2470 type INT NOT NULL REFERENCES acq.claim_event_type
2471 DEFERRABLE INITIALLY DEFERRED,
2472 claim SERIAL NOT NULL REFERENCES acq.claim
2473 DEFERRABLE INITIALLY DEFERRED,
2474 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2475 creator INT NOT NULL REFERENCES actor.usr
2476 DEFERRABLE INITIALLY DEFERRED,
2480 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2482 -- And the serials version of claiming
2483 CREATE TABLE acq.serial_claim (
2484 id SERIAL PRIMARY KEY,
2485 type INT NOT NULL REFERENCES acq.claim_type
2486 DEFERRABLE INITIALLY DEFERRED,
2487 item BIGINT NOT NULL REFERENCES serial.item
2488 DEFERRABLE INITIALLY DEFERRED
2491 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2493 CREATE TABLE acq.serial_claim_event (
2494 id BIGSERIAL PRIMARY KEY,
2495 type INT NOT NULL REFERENCES acq.claim_event_type
2496 DEFERRABLE INITIALLY DEFERRED,
2497 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2498 DEFERRABLE INITIALLY DEFERRED,
2499 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2500 creator INT NOT NULL REFERENCES actor.usr
2501 DEFERRABLE INITIALLY DEFERRED,
2505 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );
2507 CREATE OR REPLACE VIEW acq.lineitem_summary AS
2511 SELECT COUNT(lid.id)
2512 FROM acq.lineitem_detail lid
2513 WHERE lineitem = li.id
2516 SELECT COUNT(lid.id)
2517 FROM acq.lineitem_detail lid
2518 WHERE recv_time IS NOT NULL AND lineitem = li.id
2521 SELECT COUNT(lid.id)
2522 FROM acq.lineitem_detail lid
2523 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2524 WHERE acqcr.keep_debits IS FALSE AND lineitem = li.id
2527 SELECT COUNT(lid.id)
2528 FROM acq.lineitem_detail lid
2529 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2530 WHERE acqcr.keep_debits IS TRUE AND lineitem = li.id
2533 SELECT COUNT(lid.id)
2534 FROM acq.lineitem_detail lid
2535 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2536 WHERE NOT debit.encumbrance AND lineitem = li.id
2539 SELECT COUNT(DISTINCT(lid.id))
2540 FROM acq.lineitem_detail lid
2541 JOIN acq.claim claim ON (claim.lineitem_detail = lid.id)
2542 WHERE lineitem = li.id
2545 SELECT (COUNT(lid.id) * li.estimated_unit_price)::NUMERIC(8,2)
2546 FROM acq.lineitem_detail lid
2547 WHERE lid.cancel_reason IS NULL AND lineitem = li.id
2548 ) AS estimated_amount,
2550 SELECT SUM(debit.amount)::NUMERIC(8,2)
2551 FROM acq.lineitem_detail lid
2552 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2553 WHERE debit.encumbrance AND lineitem = li.id
2554 ) AS encumbrance_amount,
2556 SELECT SUM(debit.amount)::NUMERIC(8,2)
2557 FROM acq.lineitem_detail lid
2558 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2559 WHERE NOT debit.encumbrance AND lineitem = li.id
2562 FROM acq.lineitem AS li;