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 close_date TIMESTAMPTZ,
858 closed_by INTEGER REFERENCES actor.usr (id)
859 DEFERRABLE INITIALLY DEFERRED,
861 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
864 CREATE TABLE acq.invoice_entry (
865 id SERIAL PRIMARY KEY,
866 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
867 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
868 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
869 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
870 phys_item_count INT, -- and how many did staff count
872 billed_per_item BOOL,
873 cost_billed NUMERIC(8,2),
874 actual_cost NUMERIC(8,2),
875 amount_paid NUMERIC (8,2)
878 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
879 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
880 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
882 ALTER TABLE acq.fund_debit
883 ADD COLUMN invoice_entry INTEGER
884 REFERENCES acq.invoice_entry (id)
887 CREATE INDEX fund_debit_invoice_entry_idx ON acq.fund_debit (invoice_entry);
889 CREATE TABLE acq.invoice_item_type (
890 code TEXT PRIMARY KEY,
891 name TEXT NOT NULL, -- i18n-ize
892 prorate BOOL NOT NULL DEFAULT FALSE,
893 blanket BOOL NOT NULL DEFAULT FALSE,
894 CONSTRAINT aiit_not_blanket_and_prorate
895 CHECK (blanket IS FALSE OR prorate IS FALSE)
898 CREATE TABLE acq.po_item (
899 id SERIAL PRIMARY KEY,
900 purchase_order INT REFERENCES acq.purchase_order (id)
901 ON UPDATE CASCADE ON DELETE SET NULL
902 DEFERRABLE INITIALLY DEFERRED,
903 fund_debit INT REFERENCES acq.fund_debit (id)
904 DEFERRABLE INITIALLY DEFERRED,
905 inv_item_type TEXT NOT NULL
906 REFERENCES acq.invoice_item_type (code)
907 DEFERRABLE INITIALLY DEFERRED,
911 estimated_cost NUMERIC(8,2),
912 fund INT REFERENCES acq.fund (id)
913 DEFERRABLE INITIALLY DEFERRED,
917 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
919 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
920 id SERIAL PRIMARY KEY,
921 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
922 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
923 fund_debit INT REFERENCES acq.fund_debit (id),
924 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
928 cost_billed NUMERIC(8,2),
929 actual_cost NUMERIC(8,2),
930 fund INT REFERENCES acq.fund (id)
931 DEFERRABLE INITIALLY DEFERRED,
932 amount_paid NUMERIC (8,2),
933 po_item INT REFERENCES acq.po_item (id)
934 DEFERRABLE INITIALLY DEFERRED,
938 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
939 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
940 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
943 CREATE TABLE acq.user_request_type (
944 id SERIAL PRIMARY KEY,
945 label TEXT NOT NULL UNIQUE -- i18n-ize
948 CREATE TABLE acq.user_request_status_type (
949 id SERIAL PRIMARY KEY
953 INSERT INTO acq.user_request_status_type (id,label) VALUES
954 (0,oils_i18n_gettext(0,'Error','aurst','label'))
955 ,(1,oils_i18n_gettext(1,'New','aurst','label'))
956 ,(2,oils_i18n_gettext(2,'Pending','aurst','label'))
957 ,(3,oils_i18n_gettext(3,'Ordered, Hold Not Placed','aurst','label'))
958 ,(4,oils_i18n_gettext(4,'Ordered, Hold Placed','aurst','label'))
959 ,(5,oils_i18n_gettext(5,'Received','aurst','label'))
960 ,(6,oils_i18n_gettext(6,'Fulfilled','aurst','label'))
961 ,(7,oils_i18n_gettext(7,'Canceled','aurst','label'))
964 SELECT SETVAL('acq.user_request_status_type_id_seq'::TEXT, 100);
966 CREATE TABLE acq.user_request (
967 id SERIAL PRIMARY KEY,
968 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
969 hold BOOL NOT NULL DEFAULT TRUE,
971 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
972 holdable_formats TEXT, -- nullable, for use in hold creation
974 email_notify BOOL NOT NULL DEFAULT TRUE,
975 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
976 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
977 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
978 need_before TIMESTAMPTZ, -- don't create holds after this
981 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
994 cancel_reason INT REFERENCES acq.cancel_reason( id )
995 DEFERRABLE INITIALLY DEFERRED,
996 cancel_time TIMESTAMPTZ
999 ALTER TABLE action.hold_request ADD COLUMN acq_request INT REFERENCES acq.user_request (id);
1003 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
1004 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
1007 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
1010 SELECT COUNT(*) INTO counter
1011 FROM oils_xpath_table(
1015 '//*[@tag="' || tag || '"]',
1017 ) as t(i int,c text);
1019 FOR i IN 1 .. counter LOOP
1022 FROM ( SELECT id,i,t,v
1023 FROM oils_xpath_table(
1027 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
1028 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
1030 ) as t(id int,t text,v text)
1039 $$ LANGUAGE PLPGSQL;
1041 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
1042 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
1046 lida acq.flat_lineitem_detail%ROWTYPE;
1048 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
1049 IF NOT FOUND THEN RETURN; END IF;
1051 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
1052 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1059 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1060 JOIN acq.provider_holding_subfield_map a USING (subfield)
1061 WHERE a.provider = prov_i
1068 $$ LANGUAGE PLPGSQL;
1070 -- select * from acq.extract_provider_holding_data(699);
1072 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1073 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1076 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field_set ( BIGINT, TEXT, TEXT) RETURNS SETOF TEXT AS $$
1077 SELECT extract_marc_field_set('acq.lineitem', $1, $2, $3);
1082 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1083 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1086 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1087 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1091 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1094 Suggested vendor fields:
1102 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1111 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1113 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1115 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1116 IF (atype = 'lineitem_provider_attr_definition') THEN
1117 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1118 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1121 IF (atype = 'lineitem_provider_attr_definition') THEN
1122 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1123 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1124 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1125 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1126 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1129 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1131 IF (adef.code = 'title' OR adef.code = 'author') THEN
1132 -- title and author should not be split
1133 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1134 -- string-join in the xpath and remove this special case
1135 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1136 IF (value IS NOT NULL AND value <> '') THEN
1137 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1138 VALUES (NEW.id, adef.id, atype, adef.code, value);
1143 -- each application of the regex may produce multiple values
1145 SELECT * FROM extract_acq_marc_field_set(
1146 NEW.id, xpath_string || '[' || pos || ']', adef.remove)
1149 IF (value IS NOT NULL AND value <> '') THEN
1150 INSERT INTO acq.lineitem_attr
1151 (lineitem, definition, attr_type, attr_name, attr_value)
1152 VALUES (NEW.id, adef.id, atype, adef.code, value);
1170 $function$ LANGUAGE PLPGSQL;
1172 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1174 IF TG_OP = 'UPDATE' THEN
1175 DELETE FROM acq.lineitem_attr
1176 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1179 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1183 $$ LANGUAGE PLPGSQL;
1185 CREATE TRIGGER cleanup_lineitem_trigger
1186 BEFORE UPDATE OR DELETE ON acq.lineitem
1187 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1189 CREATE TRIGGER ingest_lineitem_trigger
1190 AFTER INSERT OR UPDATE ON acq.lineitem
1191 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1193 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1197 IF from_ex = to_ex THEN
1201 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1206 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1215 $$ LANGUAGE PLPGSQL;
1217 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1218 SELECT $3 * acq.exchange_ratio($1, $2);
1221 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1223 Examine the acq.fiscal_year table, comparing successive years.
1224 Report any inconsistencies, i.e. years that overlap, have gaps
1225 between them, or are out of sequence.
1227 RETURNS SETOF RECORD AS $$
1251 ELSIF curr_year.calendar = prev_year.calendar THEN
1252 IF curr_year.year_begin > prev_year.year_end THEN
1253 -- This ugly kludge works around the fact that older
1254 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1255 FOR return_rec IN SELECT
1258 'Gap between fiscal years'::TEXT
1260 RETURN NEXT return_rec;
1262 ELSIF curr_year.year_begin < prev_year.year_end THEN
1263 FOR return_rec IN SELECT
1266 'Overlapping fiscal years'::TEXT
1268 RETURN NEXT return_rec;
1270 ELSIF curr_year.year < prev_year.year THEN
1271 FOR return_rec IN SELECT
1274 'Fiscal years out of order'::TEXT
1276 RETURN NEXT return_rec;
1281 prev_year := curr_year;
1286 $$ LANGUAGE plpgsql;
1288 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1290 old_amount IN NUMERIC, -- in currency of old fund
1292 new_amount IN NUMERIC, -- in currency of new fund
1294 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1295 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1296 ) RETURNS VOID AS $$
1297 /* -------------------------------------------------------------------------------
1299 Function to transfer money from one fund to another.
1301 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1302 negative amount for the old (losing) fund and a positive amount for the new
1303 (gaining) fund. In some cases there may be more than one such pair of entries
1304 in order to pull the money from different funding sources, or more specifically
1305 from different funding source credits. For each such pair there is also an
1306 entry in acq.fund_transfer.
1308 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1309 choose a funding source for the transferred money to come from. This choice
1310 must meet two constraints, so far as possible:
1312 1. The amount transferred from a given funding source must not exceed the
1313 amount allocated to the old fund by the funding source. To that end we
1314 compare the amount being transferred to the amount allocated.
1316 2. We shouldn't transfer money that has already been spent or encumbered, as
1317 defined by the funding attribution process. We attribute expenses to the
1318 oldest funding source credits first. In order to avoid transferring that
1319 attributed money, we reverse the priority, transferring from the newest funding
1320 source credits first. There can be no guarantee that this approach will
1321 avoid overcommitting a fund, but no other approach can do any better.
1323 In this context the age of a funding source credit is defined by the
1324 deadline_date for credits with deadline_dates, and by the effective_date for
1325 credits without deadline_dates, with the proviso that credits with deadline_dates
1326 are all considered "older" than those without.
1330 In the signature for this function, there is one last parameter commented out,
1331 named "funding_source_in". Correspondingly, the WHERE clause for the query
1332 driving the main loop has an OR clause commented out, which references the
1333 funding_source_in parameter.
1335 If these lines are uncommented, this function will allow the user optionally to
1336 restrict a fund transfer to a specified funding source. If the source
1337 parameter is left NULL, then there will be no such restriction.
1339 ------------------------------------------------------------------------------- */
1341 same_currency BOOLEAN;
1342 currency_ratio NUMERIC;
1343 old_fund_currency TEXT;
1344 old_remaining NUMERIC; -- in currency of old fund
1345 new_fund_currency TEXT;
1346 new_fund_active BOOLEAN;
1347 new_remaining NUMERIC; -- in currency of new fund
1348 curr_old_amt NUMERIC; -- in currency of old fund
1349 curr_new_amt NUMERIC; -- in currency of new fund
1350 source_addition NUMERIC; -- in currency of funding source
1351 source_deduction NUMERIC; -- in currency of funding source
1352 orig_allocated_amt NUMERIC; -- in currency of funding source
1353 allocated_amt NUMERIC; -- in currency of fund
1359 IF old_fund IS NULL THEN
1360 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1363 IF old_amount IS NULL THEN
1364 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1367 -- The new fund and its amount must be both NULL or both not NULL.
1369 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1370 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1373 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1374 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1377 IF user_id IS NULL THEN
1378 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1381 -- Initialize the amounts to be transferred, each denominated
1382 -- in the currency of its respective fund. They will be
1383 -- reduced on each iteration of the loop.
1385 old_remaining := old_amount;
1386 new_remaining := new_amount;
1388 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1389 -- old_amount, old_fund, new_amount, new_fund;
1391 -- Get the currency types of the old and new funds.
1402 IF old_fund_currency IS NULL THEN
1403 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1406 IF new_fund IS NOT NULL THEN
1418 IF new_fund_currency IS NULL THEN
1419 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1420 ELSIF NOT new_fund_active THEN
1422 -- No point in putting money into a fund from whence you can't spend it
1424 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1427 IF new_amount = old_amount THEN
1428 same_currency := true;
1429 currency_ratio := 1;
1432 -- We'll have to translate currency between funds. We presume that
1433 -- the calling code has already applied an appropriate exchange rate,
1434 -- so we'll apply the same conversion to each sub-transfer.
1436 same_currency := false;
1437 currency_ratio := new_amount / old_amount;
1441 -- Identify the funding source(s) from which we want to transfer the money.
1442 -- The principle is that we want to transfer the newest money first, because
1443 -- we spend the oldest money first. The priority for spending is defined
1444 -- by a sort of the view acq.ordered_funding_source_credit.
1449 ofsc.funding_source,
1451 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1455 acq.ordered_funding_source_credit AS ofsc,
1456 acq.funding_source fs
1458 ofsc.funding_source = fs.id
1459 and ofsc.funding_source IN
1461 SELECT funding_source
1462 FROM acq.fund_allocation
1463 WHERE fund = old_fund
1467 -- ofsc.funding_source = funding_source_in
1468 -- OR funding_source_in IS NULL
1471 ofsc.sort_priority desc,
1472 ofsc.sort_date desc,
1476 -- Determine how much money the old fund got from this funding source,
1477 -- denominated in the currency types of the source and of the fund.
1478 -- This result may reflect transfers from previous iterations.
1481 COALESCE( sum( amount ), 0 ),
1482 COALESCE( sum( amount )
1483 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1485 orig_allocated_amt, -- in currency of the source
1486 allocated_amt -- in currency of the old fund
1491 and funding_source = source.funding_source;
1493 -- Determine how much to transfer from this credit, in the currency
1494 -- of the fund. Begin with the amount remaining to be attributed:
1496 curr_old_amt := old_remaining;
1498 -- Can't attribute more than was allocated from the fund:
1500 IF curr_old_amt > allocated_amt THEN
1501 curr_old_amt := allocated_amt;
1504 -- Can't attribute more than the amount of the current credit:
1506 IF curr_old_amt > source.converted_amt THEN
1507 curr_old_amt := source.converted_amt;
1510 curr_old_amt := trunc( curr_old_amt, 2 );
1512 old_remaining := old_remaining - curr_old_amt;
1514 -- Determine the amount to be deducted, if any,
1515 -- from the old allocation.
1517 IF old_remaining > 0 THEN
1519 -- In this case we're using the whole allocation, so use that
1520 -- amount directly instead of applying a currency translation
1521 -- and thereby inviting round-off errors.
1523 source_deduction := - curr_old_amt;
1525 source_deduction := trunc(
1526 ( - curr_old_amt ) *
1527 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1531 IF source_deduction <> 0 THEN
1533 -- Insert negative allocation for old fund in fund_allocation,
1534 -- converted into the currency of the funding source
1536 INSERT INTO acq.fund_allocation (
1543 source.funding_source,
1547 'Transfer to fund ' || new_fund
1551 IF new_fund IS NOT NULL THEN
1553 -- Determine how much to add to the new fund, in
1554 -- its currency, and how much remains to be added:
1556 IF same_currency THEN
1557 curr_new_amt := curr_old_amt;
1559 IF old_remaining = 0 THEN
1561 -- This is the last iteration, so nothing should be left
1563 curr_new_amt := new_remaining;
1566 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1567 new_remaining := new_remaining - curr_new_amt;
1571 -- Determine how much to add, if any,
1572 -- to the new fund's allocation.
1574 IF old_remaining > 0 THEN
1576 -- In this case we're using the whole allocation, so use that amount
1577 -- amount directly instead of applying a currency translation and
1578 -- thereby inviting round-off errors.
1580 source_addition := curr_new_amt;
1581 ELSIF source.currency_type = old_fund_currency THEN
1583 -- In this case we don't need a round trip currency translation,
1584 -- thereby inviting round-off errors:
1586 source_addition := curr_old_amt;
1588 source_addition := trunc(
1590 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1594 IF source_addition <> 0 THEN
1596 -- Insert positive allocation for new fund in fund_allocation,
1597 -- converted to the currency of the founding source
1599 INSERT INTO acq.fund_allocation (
1606 source.funding_source,
1610 'Transfer from fund ' || old_fund
1615 IF trunc( curr_old_amt, 2 ) <> 0
1616 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1618 -- Insert row in fund_transfer, using amounts in the currency of the funds
1620 INSERT INTO acq.fund_transfer (
1627 funding_source_credit
1630 trunc( curr_old_amt, 2 ),
1632 trunc( curr_new_amt, 2 ),
1639 if old_remaining <= 0 THEN
1640 EXIT; -- Nothing more to be transferred
1644 $$ LANGUAGE plpgsql;
1646 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1648 Function to attribute expenditures and encumbrances to funding source credits,
1649 and thereby to funding sources.
1651 Read the debits in chonological order, attributing each one to one or
1652 more funding source credits. Constraints:
1654 1. Don't attribute more to a credit than the amount of the credit.
1656 2. For a given fund, don't attribute more to a funding source than the
1657 source has allocated to that fund.
1659 3. Attribute debits to credits with deadlines before attributing them to
1660 credits without deadlines. Otherwise attribute to the earliest credits
1661 first, based on the deadline date when present, or on the effective date
1662 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1663 This ordering is defined by an ORDER BY clause on the view
1664 acq.ordered_funding_source_credit.
1666 Start by truncating the table acq.debit_attribution. Then insert a row
1667 into that table for each attribution. If a debit cannot be fully
1668 attributed, insert a row for the unattributable balance, with the
1669 funding_source_credit and credit_amount columns NULL.
1672 curr_fund_source_bal RECORD;
1673 seqno INT; -- sequence num for credits applicable to a fund
1674 fund_credit RECORD; -- current row in temp t_fund_credit table
1675 fc RECORD; -- used for loading t_fund_credit table
1676 sc RECORD; -- used for loading t_fund_credit table
1678 -- Used exclusively in the main loop:
1680 deb RECORD; -- current row from acq.fund_debit table
1681 curr_credit_bal RECORD; -- current row from temp t_credit table
1682 debit_balance NUMERIC; -- amount left to attribute for current debit
1683 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1684 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1685 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1686 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1687 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1688 attrib_count INT; -- populates id of acq.debit_attribution
1691 -- Load a temporary table. For each combination of fund and funding source,
1692 -- load an entry with the total amount allocated to that fund by that source.
1693 -- This sum may reflect transfers as well as original allocations. We will
1694 -- reduce this balance whenever we attribute debits to it.
1696 CREATE TEMP TABLE t_fund_source_bal
1700 funding_source AS source,
1701 sum( amount ) AS balance
1710 CREATE INDEX t_fund_source_bal_idx
1711 ON t_fund_source_bal( fund, source );
1712 -------------------------------------------------------------------------------
1714 -- Load another temporary table. For each fund, load zero or more
1715 -- funding source credits from which that fund can get money.
1717 CREATE TEMP TABLE t_fund_credit (
1724 SELECT DISTINCT fund
1725 FROM acq.fund_allocation
1727 LOOP -- Loop over the funds
1733 acq.ordered_funding_source_credit AS ofsc
1735 ofsc.funding_source IN
1737 SELECT funding_source
1738 FROM acq.fund_allocation
1739 WHERE fund = fc.fund
1745 LOOP -- Add each credit to the list
1746 INSERT INTO t_fund_credit (
1755 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1757 END LOOP; -- Loop over credits for a given fund
1758 END LOOP; -- Loop over funds
1760 CREATE INDEX t_fund_credit_idx
1761 ON t_fund_credit( fund, seq );
1762 -------------------------------------------------------------------------------
1764 -- Load yet another temporary table. This one is a list of funding source
1765 -- credits, with their balances. We shall reduce those balances as we
1766 -- attribute debits to them.
1768 CREATE TEMP TABLE t_credit
1772 fsc.funding_source AS source,
1773 fsc.amount AS balance,
1774 fs.currency_type AS currency_type
1776 acq.funding_source_credit AS fsc,
1777 acq.funding_source fs
1779 fsc.funding_source = fs.id
1782 CREATE INDEX t_credit_idx
1783 ON t_credit( credit );
1785 -------------------------------------------------------------------------------
1787 -- Now that we have loaded the lookup tables: loop through the debits,
1788 -- attributing each one to one or more funding source credits.
1790 truncate table acq.debit_attribution;
1808 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1810 debit_balance := deb.amount;
1812 -- Loop over the funding source credits that are eligible
1813 -- to pay for this debit
1825 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1827 -- Look up the balance for this credit. If it's zero, then
1828 -- it's not useful, so treat it as if you didn't find it.
1829 -- (Actually there shouldn't be any zero balances in the table,
1830 -- but we check just to make sure.)
1833 INTO curr_credit_bal
1836 credit = fund_credit.credit
1839 IF curr_credit_bal IS NULL THEN
1841 -- This credit is exhausted; try the next one.
1847 -- At this point we have an applicable credit with some money left.
1848 -- Now see if the relevant funding_source has any money left.
1850 -- Look up the balance of the allocation for this combination of
1851 -- fund and source. If you find such an entry, but it has a zero
1852 -- balance, then it's not useful, so treat it as unfound.
1853 -- (Actually there shouldn't be any zero balances in the table,
1854 -- but we check just to make sure.)
1857 INTO curr_fund_source_bal
1858 FROM t_fund_source_bal
1861 AND source = curr_credit_bal.source
1864 IF curr_fund_source_bal IS NULL THEN
1866 -- This fund/source doesn't exist or is already exhausted,
1867 -- so we can't use this credit. Go on to the next one.
1872 -- Convert the available balances to the currency of the fund
1874 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1875 curr_credit_bal.currency_type, deb.currency_type );
1876 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1877 curr_credit_bal.currency_type, deb.currency_type );
1879 -- Determine how much we can attribute to this credit: the minimum
1880 -- of the debit amount, the fund/source balance, and the
1883 --RAISE NOTICE ' deb bal %', debit_balance;
1884 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1885 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1887 conv_attr_amount := NULL;
1888 attr_amount := debit_balance;
1890 IF attr_amount > conv_alloc_balance THEN
1891 attr_amount := conv_alloc_balance;
1892 conv_attr_amount := curr_fund_source_bal.balance;
1894 IF attr_amount > conv_cred_balance THEN
1895 attr_amount := conv_cred_balance;
1896 conv_attr_amount := curr_credit_bal.balance;
1899 -- If we're attributing all of one of the balances, then that's how
1900 -- much we will deduct from the balances, and we already captured
1901 -- that amount above. Otherwise we must convert the amount of the
1902 -- attribution from the currency of the fund back to the currency of
1903 -- the funding source.
1905 IF conv_attr_amount IS NULL THEN
1906 conv_attr_amount := attr_amount * acq.exchange_ratio(
1907 deb.currency_type, curr_credit_bal.currency_type );
1910 -- Insert a row to record the attribution
1912 attrib_count := attrib_count + 1;
1913 INSERT INTO acq.debit_attribution (
1917 funding_source_credit,
1923 curr_credit_bal.credit,
1927 -- Subtract the attributed amount from the various balances
1929 debit_balance := debit_balance - attr_amount;
1930 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1932 IF curr_fund_source_bal.balance <= 0 THEN
1934 -- This allocation is exhausted. Delete it so
1935 -- that we don't waste time looking at it again.
1937 DELETE FROM t_fund_source_bal
1939 fund = curr_fund_source_bal.fund
1940 AND source = curr_fund_source_bal.source;
1942 UPDATE t_fund_source_bal
1943 SET balance = balance - conv_attr_amount
1945 fund = curr_fund_source_bal.fund
1946 AND source = curr_fund_source_bal.source;
1949 IF curr_credit_bal.balance <= 0 THEN
1951 -- This funding source credit is exhausted. Delete it
1952 -- so that we don't waste time looking at it again.
1954 --DELETE FROM t_credit
1956 -- credit = curr_credit_bal.credit;
1958 DELETE FROM t_fund_credit
1960 credit = curr_credit_bal.credit;
1963 SET balance = curr_credit_bal.balance
1965 credit = curr_credit_bal.credit;
1968 -- Are we done with this debit yet?
1970 IF debit_balance <= 0 THEN
1971 EXIT; -- We've fully attributed this debit; stop looking at credits.
1973 END LOOP; -- End loop over credits
1975 IF debit_balance <> 0 THEN
1977 -- We weren't able to attribute this debit, or at least not
1978 -- all of it. Insert a row for the unattributed balance.
1980 attrib_count := attrib_count + 1;
1981 INSERT INTO acq.debit_attribution (
1985 funding_source_credit,
1995 END LOOP; -- End of loop over debits
1997 $$ LANGUAGE 'plpgsql';
1999 CREATE OR REPLACE FUNCTION acq.copy_fund_tags(
2000 old_fund_id INTEGER,
2002 ) RETURNS VOID AS $$
2004 fund_tag_rec RECORD;
2007 FOR fund_tag_rec IN SELECT * FROM acq.fund_tag_map WHERE fund=old_fund_id LOOP
2009 INSERT INTO acq.fund_tag_map(fund, tag) VALUES(new_fund_id, fund_tag_rec.tag);
2011 WHEN unique_violation THEN
2012 -- RAISE NOTICE 'Fund tag already propagated', old_fund.id;
2018 $$ LANGUAGE plpgsql;
2020 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
2023 org_unit_id INTEGER,
2024 include_desc BOOL DEFAULT TRUE
2025 ) RETURNS VOID AS $$
2036 IF old_year IS NULL THEN
2037 RAISE EXCEPTION 'Input year argument is NULL';
2038 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2039 RAISE EXCEPTION 'Input year is out of range';
2042 IF user_id IS NULL THEN
2043 RAISE EXCEPTION 'Input user id argument is NULL';
2046 IF org_unit_id IS NULL THEN
2047 RAISE EXCEPTION 'Org unit id argument is NULL';
2049 SELECT TRUE INTO org_found
2051 WHERE id = org_unit_id;
2053 IF org_found IS NULL THEN
2054 RAISE EXCEPTION 'Org unit id is invalid';
2058 -- Loop over the applicable funds
2060 FOR old_fund in SELECT * FROM acq.fund
2064 AND ( ( include_desc AND org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2065 OR (NOT include_desc AND org = org_unit_id ) )
2069 INSERT INTO acq.fund (
2077 balance_warning_percent,
2078 balance_stop_percent
2083 old_fund.currency_type,
2087 old_fund.balance_warning_percent,
2088 old_fund.balance_stop_percent
2090 RETURNING id INTO new_id;
2092 WHEN unique_violation THEN
2093 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2097 PERFORM acq.copy_fund_tags(old_fund.id,new_id);
2099 --RAISE NOTICE 'Propagating fund % to fund %',
2100 -- old_fund.code, new_id;
2103 $$ LANGUAGE plpgsql;
2105 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER ) RETURNS VOID AS $$
2106 SELECT acq.propagate_funds_by_org_tree( $1, $2, $3, FALSE );
2109 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2112 org_unit_id INTEGER,
2113 encumb_only BOOL DEFAULT FALSE,
2114 include_desc BOOL DEFAULT TRUE
2115 ) RETURNS VOID AS $$
2119 new_year INT := old_year + 1;
2122 xfer_amount NUMERIC := 0;
2126 roll_distrib_forms BOOL;
2132 IF old_year IS NULL THEN
2133 RAISE EXCEPTION 'Input year argument is NULL';
2134 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2135 RAISE EXCEPTION 'Input year is out of range';
2138 IF user_id IS NULL THEN
2139 RAISE EXCEPTION 'Input user id argument is NULL';
2142 IF org_unit_id IS NULL THEN
2143 RAISE EXCEPTION 'Org unit id argument is NULL';
2146 -- Validate the org unit
2151 WHERE id = org_unit_id;
2153 IF org_found IS NULL THEN
2154 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2155 ELSIF encumb_only THEN
2156 SELECT INTO perm_ous value::BOOL FROM
2157 actor.org_unit_ancestor_setting(
2158 'acq.fund.allow_rollover_without_money', org_unit_id
2160 IF NOT FOUND OR NOT perm_ous THEN
2161 RAISE EXCEPTION 'Encumbrance-only rollover not permitted at org %', org_unit_id;
2166 -- Loop over the propagable funds to identify the details
2167 -- from the old fund plus the id of the new one, if it exists.
2171 oldf.id AS old_fund,
2177 newf.id AS new_fund_id
2180 LEFT JOIN acq.fund AS newf
2181 ON ( oldf.code = newf.code AND oldf.org = newf.org )
2183 oldf.year = old_year
2185 AND newf.year = new_year
2186 AND ( ( include_desc AND oldf.org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2187 OR (NOT include_desc AND oldf.org = org_unit_id ) )
2189 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2191 IF roll_fund.new_fund_id IS NULL THEN
2193 -- The old fund hasn't been propagated yet. Propagate it now.
2195 INSERT INTO acq.fund (
2203 balance_warning_percent,
2204 balance_stop_percent
2209 roll_fund.currency_type,
2213 roll_fund.balance_warning_percent,
2214 roll_fund.balance_stop_percent
2216 RETURNING id INTO new_fund;
2218 PERFORM acq.copy_fund_tags(roll_fund.id,new_fund);
2221 new_fund = roll_fund.new_fund_id;
2224 -- Determine the amount to transfer
2228 FROM acq.fund_spent_balance
2229 WHERE fund = roll_fund.old_fund;
2231 IF xfer_amount <> 0 THEN
2232 IF NOT encumb_only AND roll_fund.rollover THEN
2234 -- Transfer balance from old fund to new
2236 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2238 PERFORM acq.transfer_fund(
2248 -- Transfer balance from old fund to the void
2250 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2252 PERFORM acq.transfer_fund(
2258 'Rollover into the void'
2263 IF roll_fund.rollover THEN
2265 -- Move any lineitems from the old fund to the new one
2266 -- where the associated debit is an encumbrance.
2268 -- Any other tables tying expenditure details to funds should
2269 -- receive similar treatment. At this writing there are none.
2271 UPDATE acq.lineitem_detail
2274 fund = roll_fund.old_fund -- this condition may be redundant
2280 fund = roll_fund.old_fund
2284 -- Move encumbrance debits from the old fund to the new fund
2286 UPDATE acq.fund_debit
2289 fund = roll_fund.old_fund
2293 -- Rollover distribution formulae funds
2294 SELECT INTO roll_distrib_forms value::BOOL FROM
2295 actor.org_unit_ancestor_setting(
2296 'acq.fund.rollover_distrib_forms', org_unit_id
2299 IF roll_distrib_forms THEN
2300 UPDATE acq.distribution_formula_entry
2301 SET fund = roll_fund.new_fund_id
2302 WHERE fund = roll_fund.old_fund;
2306 -- Mark old fund as inactive, now that we've closed it
2310 WHERE id = roll_fund.old_fund;
2313 $$ LANGUAGE plpgsql;
2318 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 $$
2319 SELECT acq.rollover_funds_by_org_tree( $1, $2, $3, $4, FALSE );
2322 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2323 SELECT funding_source,
2324 SUM(amount) AS amount
2325 FROM acq.funding_source_credit
2328 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2329 SELECT funding_source,
2330 SUM(a.amount)::NUMERIC(100,2) AS amount
2331 FROM acq.fund_allocation a
2334 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2335 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2336 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2337 FROM acq.funding_source_credit_total c
2338 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2341 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2343 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2344 FROM acq.fund_allocation a
2345 JOIN acq.fund f ON (a.fund = f.id)
2346 JOIN acq.funding_source s ON (a.funding_source = s.id)
2349 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2350 SELECT fund.id AS fund,
2351 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2353 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2356 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2359 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2361 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2362 WHERE fund_debit.encumbrance GROUP BY fund.id;
2364 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2365 SELECT fund.id AS fund,
2366 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2368 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2369 WHERE NOT fund_debit.encumbrance
2372 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2374 c.amount - COALESCE(d.amount, 0.0) AS amount
2375 FROM acq.fund_allocation_total c
2376 LEFT JOIN acq.fund_debit_total d USING (fund);
2378 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2380 c.amount - COALESCE(d.amount,0.0) AS amount
2381 FROM acq.fund_allocation_total c
2382 LEFT JOIN acq.fund_spent_total d USING (fund);
2384 -- For each fund: the total allocation from all sources, in the
2385 -- currency of the fund (or 0 if there are no allocations)
2387 CREATE VIEW acq.all_fund_allocation_total AS
2390 COALESCE( SUM( a.amount * acq.exchange_ratio(
2391 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2395 LEFT JOIN acq.fund_allocation a
2397 LEFT JOIN acq.funding_source s
2398 ON a.funding_source = s.id
2402 -- For every fund: the total encumbrances (or 0 if none),
2403 -- in the currency of the fund.
2405 CREATE VIEW acq.all_fund_encumbrance_total AS
2408 COALESCE( encumb.amount, 0 ) AS amount
2414 sum( amount ) AS amount
2421 ON f.id = encumb.fund;
2423 -- For every fund: the total spent (or 0 if none),
2424 -- in the currency of the fund.
2426 CREATE VIEW acq.all_fund_spent_total AS
2429 COALESCE( spent.amount, 0 ) AS amount
2435 sum( amount ) AS amount
2442 ON f.id = spent.fund;
2444 -- For each fund: the amount not yet spent, in the currency
2445 -- of the fund. May include encumbrances.
2447 CREATE VIEW acq.all_fund_spent_balance AS
2450 c.amount - d.amount AS amount
2451 FROM acq.all_fund_allocation_total c
2452 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2454 -- For each fund: the amount neither spent nor encumbered,
2455 -- in the currency of the fund
2457 CREATE VIEW acq.all_fund_combined_balance AS
2460 a.amount - COALESCE( c.amount, 0 ) AS amount
2462 acq.all_fund_allocation_total a
2466 SUM( amount ) AS amount
2471 ) AS c USING ( fund );
2473 CREATE TABLE acq.claim_type (
2474 id SERIAL PRIMARY KEY,
2475 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2476 DEFERRABLE INITIALLY DEFERRED,
2478 description TEXT NOT NULL,
2479 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2482 CREATE TABLE acq.claim (
2483 id SERIAL PRIMARY KEY,
2484 type INT NOT NULL REFERENCES acq.claim_type
2485 DEFERRABLE INITIALLY DEFERRED,
2486 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2487 DEFERRABLE INITIALLY DEFERRED
2490 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2492 CREATE TABLE acq.claim_event (
2493 id BIGSERIAL PRIMARY KEY,
2494 type INT NOT NULL REFERENCES acq.claim_event_type
2495 DEFERRABLE INITIALLY DEFERRED,
2496 claim SERIAL NOT NULL REFERENCES acq.claim
2497 DEFERRABLE INITIALLY DEFERRED,
2498 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2499 creator INT NOT NULL REFERENCES actor.usr
2500 DEFERRABLE INITIALLY DEFERRED,
2504 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2506 -- And the serials version of claiming
2507 CREATE TABLE acq.serial_claim (
2508 id SERIAL PRIMARY KEY,
2509 type INT NOT NULL REFERENCES acq.claim_type
2510 DEFERRABLE INITIALLY DEFERRED,
2511 item BIGINT NOT NULL REFERENCES serial.item
2512 DEFERRABLE INITIALLY DEFERRED
2515 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2517 CREATE TABLE acq.serial_claim_event (
2518 id BIGSERIAL PRIMARY KEY,
2519 type INT NOT NULL REFERENCES acq.claim_event_type
2520 DEFERRABLE INITIALLY DEFERRED,
2521 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2522 DEFERRABLE INITIALLY DEFERRED,
2523 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2524 creator INT NOT NULL REFERENCES actor.usr
2525 DEFERRABLE INITIALLY DEFERRED,
2529 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );
2531 CREATE OR REPLACE VIEW acq.lineitem_summary AS
2535 SELECT COUNT(lid.id)
2536 FROM acq.lineitem_detail lid
2537 WHERE lineitem = li.id
2540 SELECT COUNT(lid.id)
2541 FROM acq.lineitem_detail lid
2542 WHERE recv_time IS NOT NULL AND lineitem = li.id
2545 SELECT COUNT(lid.id)
2546 FROM acq.lineitem_detail lid
2547 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2548 WHERE acqcr.keep_debits IS FALSE AND lineitem = li.id
2551 SELECT COUNT(lid.id)
2552 FROM acq.lineitem_detail lid
2553 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2554 WHERE acqcr.keep_debits IS TRUE AND lineitem = li.id
2557 SELECT COUNT(lid.id)
2558 FROM acq.lineitem_detail lid
2559 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2560 WHERE NOT debit.encumbrance AND lineitem = li.id
2563 SELECT COUNT(DISTINCT(lid.id))
2564 FROM acq.lineitem_detail lid
2565 JOIN acq.claim claim ON (claim.lineitem_detail = lid.id)
2566 WHERE lineitem = li.id
2569 SELECT (COUNT(lid.id) * li.estimated_unit_price)::NUMERIC(8,2)
2570 FROM acq.lineitem_detail lid
2571 WHERE lid.cancel_reason IS NULL AND lineitem = li.id
2572 ) AS estimated_amount,
2574 SELECT SUM(debit.amount)::NUMERIC(8,2)
2575 FROM acq.lineitem_detail lid
2576 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2577 WHERE debit.encumbrance AND lineitem = li.id
2578 ) AS encumbrance_amount,
2580 SELECT SUM(debit.amount)::NUMERIC(8,2)
2581 FROM acq.lineitem_detail lid
2582 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2583 WHERE NOT debit.encumbrance AND lineitem = li.id
2586 FROM acq.lineitem AS li;