2 * Copyright (C) 2009 Georgia Public Library Service
3 * Scott McKellar <scott@esilibrary.com>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 DROP SCHEMA IF EXISTS acq CASCADE;
26 CREATE TABLE acq.currency_type (
27 code TEXT PRIMARY KEY,
31 -- Use the ISO 4217 abbreviations for currency codes
32 INSERT INTO acq.currency_type (code, label) VALUES ('USD','US Dollars');
33 INSERT INTO acq.currency_type (code, label) VALUES ('CAN','Canadian Dollars');
34 INSERT INTO acq.currency_type (code, label) VALUES ('EUR','Euros');
36 CREATE TABLE acq.exchange_rate (
37 id SERIAL PRIMARY KEY,
38 from_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
39 to_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
40 ratio NUMERIC NOT NULL,
41 CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
44 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','CAN',1.2);
45 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','EUR',0.5);
47 CREATE TABLE acq.claim_policy (
48 id SERIAL PRIMARY KEY,
49 org_unit INT NOT NULL REFERENCES actor.org_unit
50 DEFERRABLE INITIALLY DEFERRED,
52 description TEXT NOT NULL,
53 CONSTRAINT name_once_per_org UNIQUE (org_unit, name)
56 CREATE TABLE acq.claim_event_type (
57 id SERIAL PRIMARY KEY,
58 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
59 DEFERRABLE INITIALLY DEFERRED,
61 description TEXT NOT NULL,
62 library_initiated BOOL NOT NULL DEFAULT FALSE,
63 CONSTRAINT event_type_once_per_org UNIQUE ( org_unit, code )
66 CREATE TABLE acq.claim_policy_action (
67 id SERIAL PRIMARY KEY,
68 claim_policy INT NOT NULL REFERENCES acq.claim_policy
70 DEFERRABLE INITIALLY DEFERRED,
71 action_interval INTERVAL NOT NULL,
72 action INT NOT NULL REFERENCES acq.claim_event_type
73 DEFERRABLE INITIALLY DEFERRED,
74 CONSTRAINT action_sequence UNIQUE (claim_policy, action_interval)
77 CREATE TABLE acq.provider (
78 id SERIAL PRIMARY KEY,
80 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
81 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
85 edi_default INT, -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
86 active BOOL NOT NULL DEFAULT TRUE,
87 prepayment_required BOOL NOT NULL DEFAULT FALSE,
92 default_claim_policy INT REFERENCES acq.claim_policy
93 DEFERRABLE INITIALLY DEFERRED,
94 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
95 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
98 CREATE TABLE acq.provider_holding_subfield_map (
99 id SERIAL PRIMARY KEY,
100 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
101 name TEXT NOT NULL, -- barcode, price, etc
102 subfield TEXT NOT NULL,
103 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
106 CREATE TABLE acq.provider_address (
107 id SERIAL PRIMARY KEY,
108 valid BOOL NOT NULL DEFAULT TRUE,
110 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
111 street1 TEXT NOT NULL,
116 country TEXT NOT NULL,
117 post_code TEXT NOT NULL,
121 CREATE TABLE acq.provider_contact (
122 id SERIAL PRIMARY KEY,
123 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
125 role TEXT, -- free-form.. e.g. "our sales guy"
130 CREATE TABLE acq.provider_contact_address (
131 id SERIAL PRIMARY KEY,
132 valid BOOL NOT NULL DEFAULT TRUE,
134 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
135 street1 TEXT NOT NULL,
140 country TEXT NOT NULL,
141 post_code TEXT NOT NULL,
145 CREATE TABLE acq.provider_note (
146 id SERIAL PRIMARY KEY,
147 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
148 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
149 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
150 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
151 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
154 CREATE INDEX acq_pro_note_pro_idx ON acq.provider_note ( provider );
155 CREATE INDEX acq_pro_note_creator_idx ON acq.provider_note ( creator );
156 CREATE INDEX acq_pro_note_editor_idx ON acq.provider_note ( editor );
159 CREATE TABLE acq.funding_source (
160 id SERIAL PRIMARY KEY,
162 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
163 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
165 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
168 CREATE TABLE acq.funding_source_credit (
169 id SERIAL PRIMARY KEY,
170 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
171 amount NUMERIC NOT NULL,
173 deadline_date TIMESTAMPTZ,
174 effective_date TIMESTAMPTZ NOT NULL default now()
177 CREATE VIEW acq.ordered_funding_source_credit AS
179 CASE WHEN deadline_date IS NULL THEN
183 END AS sort_priority,
184 CASE WHEN deadline_date IS NULL THEN
194 acq.funding_source_credit;
196 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
197 The acq.ordered_funding_source_credit view is a prioritized
198 ordering of funding source credits. When ordered by the first
199 three columns, this view defines the order in which the various
200 credits are to be tapped for spending, subject to the allocations
201 in the acq.fund_allocation table.
203 The first column reflects the principle that we should spend
204 money with deadlines before spending money without deadlines.
206 The second column reflects the principle that we should spend the
207 oldest money first. For money with deadlines, that means that we
208 spend first from the credit with the earliest deadline. For
209 money without deadlines, we spend first from the credit with the
210 earliest effective date.
212 The third column is a tie breaker to ensure a consistent
216 CREATE TABLE acq.fund (
217 id SERIAL PRIMARY KEY,
218 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
220 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
221 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
223 rollover BOOL NOT NULL DEFAULT FALSE,
224 propagate BOOL NOT NULL DEFAULT TRUE,
225 active BOOL NOT NULL DEFAULT TRUE,
226 balance_warning_percent INT,
227 balance_stop_percent INT,
228 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
229 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
230 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
233 CREATE TABLE acq.fund_debit (
234 id SERIAL PRIMARY KEY,
235 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
236 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
237 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
238 amount NUMERIC NOT NULL,
239 encumbrance BOOL NOT NULL DEFAULT TRUE,
240 debit_type TEXT NOT NULL,
241 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
242 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
245 CREATE TABLE acq.fund_allocation (
246 id SERIAL PRIMARY KEY,
247 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
248 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
249 amount NUMERIC NOT NULL,
250 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
252 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
254 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
256 CREATE TABLE acq.fund_allocation_percent
258 id SERIAL PRIMARY KEY,
259 funding_source INT NOT NULL REFERENCES acq.funding_source
260 DEFERRABLE INITIALLY DEFERRED,
261 org INT NOT NULL REFERENCES actor.org_unit
262 DEFERRABLE INITIALLY DEFERRED,
264 percent NUMERIC NOT NULL,
265 allocator INTEGER NOT NULL REFERENCES actor.usr
266 DEFERRABLE INITIALLY DEFERRED,
268 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
269 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
270 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
273 -- Trigger function to validate combination of org_unit and fund_code
275 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
276 RETURNS TRIGGER AS $$
291 AND code = NEW.fund_code
297 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
302 CREATE TRIGGER acq_fund_alloc_percent_val_trig
303 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
304 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
306 -- To do: trigger to verify that percentages don't add up to more than 100
308 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
309 RETURNS TRIGGER AS $$
312 total_percent numeric;
320 acq.fund_allocation_percent AS fap
322 fap.funding_source = NEW.funding_source;
324 IF total_percent > 100 THEN
325 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
333 CREATE TRIGGER acqfap_limit_100_trig
334 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
335 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
337 CREATE TABLE acq.picklist (
338 id SERIAL PRIMARY KEY,
339 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
340 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
341 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
342 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
344 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
345 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
346 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
348 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
349 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
350 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
352 CREATE TABLE acq.cancel_reason (
353 id SERIAL PRIMARY KEY,
354 org_unit INTEGER NOT NULL REFERENCES actor.org_unit( id )
355 DEFERRABLE INITIALLY DEFERRED,
357 description TEXT NOT NULL,
358 keep_debits BOOL NOT NULL DEFAULT FALSE,
359 CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
362 -- Reserve ids 1-999 for stock reasons
363 -- Reserve ids 1000-1999 for EDI reasons
364 -- 2000+ are available for staff to create
366 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
368 CREATE TABLE acq.purchase_order (
369 id SERIAL PRIMARY KEY,
370 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
371 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
372 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
373 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
374 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
375 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
376 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
377 state TEXT NOT NULL DEFAULT 'new',
378 order_date TIMESTAMP WITH TIME ZONE,
380 cancel_reason INT REFERENCES acq.cancel_reason( id )
381 DEFERRABLE INITIALLY DEFERRED,
382 prepayment_required BOOLEAN NOT NULL DEFAULT FALSE,
383 CONSTRAINT valid_po_state CHECK (state IN ('new','pending','on-order','received','cancelled'))
385 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
386 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
387 CREATE INDEX po_state_idx ON acq.purchase_order (state);
388 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
389 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
390 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
392 -- The name should default to the id, as text. We can't reference a column
393 -- in a DEFAULT clause, so we use a trigger:
395 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
398 IF NEW.name IS NULL THEN
399 NEW.name := NEW.id::TEXT;
406 CREATE TRIGGER po_name_default_trg
407 BEFORE INSERT OR UPDATE ON acq.purchase_order
408 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
410 -- The order name should be unique for a given ordering agency on a given order date
411 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
412 -- this rule requires a check constraint with a subquery. However you can't have a
413 -- subquery in a CHECK constraint, so we fake it with a trigger.
415 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
421 -- If order_date is not null, then make sure we don't have a collision
422 -- on order_date (truncated to day), org, and name
424 IF NEW.order_date IS NULL THEN
428 -- In the WHERE clause, we compare the order_dates without regard to time of day.
429 -- We use a pair of inequalities instead of comparing truncated dates so that the
430 -- query can do an indexed range scan.
432 SELECT 1 INTO collision
433 FROM acq.purchase_order
435 ordering_agency = NEW.ordering_agency
437 AND order_date >= date_trunc( 'day', NEW.order_date )
438 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
441 IF collision IS NULL THEN
442 -- okay, no collision
445 -- collision; nip it in the bud
446 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
447 NEW.ordering_agency, NEW.order_date, NEW.name;
452 CREATE TRIGGER po_org_name_date_unique_trg
453 BEFORE INSERT OR UPDATE ON acq.purchase_order
454 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
456 CREATE TABLE acq.po_note (
457 id SERIAL PRIMARY KEY,
458 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
459 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
460 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
461 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
462 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
464 vendor_public BOOLEAN NOT NULL DEFAULT FALSE
466 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
467 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
468 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
470 CREATE TABLE acq.lineitem (
471 id BIGSERIAL PRIMARY KEY,
472 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
473 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
474 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
475 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
476 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
477 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
478 expected_recv_time TIMESTAMP WITH TIME ZONE,
479 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
480 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
482 eg_bib_id BIGINT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
484 state TEXT NOT NULL DEFAULT 'new',
485 cancel_reason INT REFERENCES acq.cancel_reason( id )
486 DEFERRABLE INITIALLY DEFERRED,
487 estimated_unit_price NUMERIC,
488 claim_policy INT REFERENCES acq.claim_policy
489 DEFERRABLE INITIALLY DEFERRED,
490 queued_record BIGINT REFERENCES vandelay.queued_bib_record (id)
491 ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
492 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
494 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
495 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
496 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
497 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
498 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
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);
546 CREATE TABLE acq.lineitem_attr_definition (
547 id BIGSERIAL PRIMARY KEY,
549 description TEXT NOT NULL,
550 remove TEXT NOT NULL DEFAULT '',
551 ident BOOL NOT NULL DEFAULT FALSE
554 CREATE TABLE acq.lineitem_marc_attr_definition (
555 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
557 ) INHERITS (acq.lineitem_attr_definition);
559 CREATE TABLE acq.lineitem_provider_attr_definition (
560 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
562 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
563 ) INHERITS (acq.lineitem_attr_definition);
565 CREATE TABLE acq.lineitem_generated_attr_definition (
566 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
568 ) INHERITS (acq.lineitem_attr_definition);
570 CREATE TABLE acq.lineitem_usr_attr_definition (
571 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
572 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
573 ) INHERITS (acq.lineitem_attr_definition);
574 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
576 CREATE TABLE acq.lineitem_local_attr_definition (
577 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
578 ) INHERITS (acq.lineitem_attr_definition);
580 CREATE TABLE acq.lineitem_attr (
581 id BIGSERIAL PRIMARY KEY,
582 definition BIGINT NOT NULL,
583 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
584 attr_type TEXT NOT NULL,
585 attr_name TEXT NOT NULL,
586 attr_value TEXT NOT NULL
589 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
590 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
591 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
597 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
598 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)]');
599 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
600 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
601 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
602 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('upc', 'UPC', '//*[@tag="024" and @ind1="1"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
604 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
605 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
606 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
607 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
608 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
610 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
613 CREATE TABLE acq.distribution_formula (
614 id SERIAL PRIMARY KEY,
616 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
618 skip_count INT NOT NULL DEFAULT 0,
619 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
622 CREATE TABLE acq.distribution_formula_entry (
623 id SERIAL PRIMARY KEY,
624 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
626 DEFERRABLE INITIALLY DEFERRED,
627 position INTEGER NOT NULL,
628 item_count INTEGER NOT NULL,
629 owning_lib INTEGER REFERENCES actor.org_unit(id)
630 DEFERRABLE INITIALLY DEFERRED,
631 location INTEGER REFERENCES asset.copy_location(id),
632 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
633 CONSTRAINT acqdfe_must_be_somewhere
634 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
637 CREATE TABLE acq.distribution_formula_application (
638 id BIGSERIAL PRIMARY KEY,
639 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
640 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
642 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
643 lineitem INT NOT NULL
644 REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
647 CREATE INDEX acqdfa_df_idx
648 ON acq.distribution_formula_application(formula);
649 CREATE INDEX acqdfa_li_idx
650 ON acq.distribution_formula_application(lineitem);
651 CREATE INDEX acqdfa_creator_idx
652 ON acq.distribution_formula_application(creator);
654 CREATE TABLE acq.fund_tag (
655 id SERIAL PRIMARY KEY,
657 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
659 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
662 CREATE TABLE acq.fund_tag_map (
663 id SERIAL PRIMARY KEY,
664 fund INTEGER NOT NULL REFERENCES acq.fund(id)
665 DEFERRABLE INITIALLY DEFERRED,
666 tag INTEGER REFERENCES acq.fund_tag(id)
668 DEFERRABLE INITIALLY DEFERRED,
669 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
672 CREATE TABLE acq.fund_transfer (
673 id SERIAL PRIMARY KEY,
674 src_fund INT NOT NULL REFERENCES acq.fund( id )
675 DEFERRABLE INITIALLY DEFERRED,
676 src_amount NUMERIC NOT NULL,
677 dest_fund INT REFERENCES acq.fund( id )
678 DEFERRABLE INITIALLY DEFERRED,
680 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
681 transfer_user INT NOT NULL REFERENCES actor.usr( id )
682 DEFERRABLE INITIALLY DEFERRED,
684 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
685 DEFERRABLE INITIALLY DEFERRED
688 CREATE INDEX acqftr_usr_idx
689 ON acq.fund_transfer( transfer_user );
691 COMMENT ON TABLE acq.fund_transfer IS $$
693 Each row represents the transfer of money from a source fund
694 to a destination fund. There should be corresponding entries
695 in acq.fund_allocation. The purpose of acq.fund_transfer is
696 to record how much money moved from which fund to which other
699 The presence of two amount fields, rather than one, reflects
700 the possibility that the two funds are denominated in different
701 currencies. If they use the same currency type, the two
702 amounts should be the same.
705 CREATE TABLE acq.fiscal_calendar (
706 id SERIAL PRIMARY KEY,
710 -- Create a default calendar (though we don't specify its contents).
711 -- Create a foreign key in actor.org_unit, initially pointing to
712 -- the default calendar.
714 INSERT INTO acq.fiscal_calendar (
721 ALTER TABLE actor.org_unit ADD FOREIGN KEY
722 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
723 DEFERRABLE INITIALLY DEFERRED;
725 CREATE TABLE acq.fiscal_year (
726 id SERIAL PRIMARY KEY,
727 calendar INT NOT NULL
728 REFERENCES acq.fiscal_calendar
730 DEFERRABLE INITIALLY DEFERRED,
732 year_begin TIMESTAMPTZ NOT NULL,
733 year_end TIMESTAMPTZ NOT NULL,
734 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
735 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
738 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
739 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
740 in_dir TEXT, -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
743 ) INHERITS (config.remote_account);
745 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
746 ALTER TABLE acq.edi_account ADD PRIMARY KEY (id);
748 CREATE TABLE acq.edi_message (
749 id SERIAL PRIMARY KEY,
750 account INTEGER REFERENCES acq.edi_account(id)
751 DEFERRABLE INITIALLY DEFERRED,
753 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
754 translate_time TIMESTAMPTZ,
755 process_time TIMESTAMPTZ,
756 error_time TIMESTAMPTZ,
757 status TEXT NOT NULL DEFAULT 'new'
758 CONSTRAINT status_value CHECK
760 'new', -- needs to be translated
761 'translated', -- needs to be processed
762 'trans_error', -- error in translation step
763 'processed', -- needs to have remote_file deleted
764 'proc_error', -- error in processing step
765 'delete_error', -- error in deletion
766 'retry', -- need to retry
772 purchase_order INT REFERENCES acq.purchase_order
773 DEFERRABLE INITIALLY DEFERRED,
774 message_type TEXT NOT NULL CONSTRAINT valid_message_type CHECK
784 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
785 -- the table, assigning ids programmatically instead of using a sequence.
786 CREATE TABLE acq.debit_attribution (
787 id INT NOT NULL PRIMARY KEY,
788 fund_debit INT NOT NULL
789 REFERENCES acq.fund_debit
790 DEFERRABLE INITIALLY DEFERRED,
791 debit_amount NUMERIC NOT NULL,
792 funding_source_credit INT REFERENCES acq.funding_source_credit
793 DEFERRABLE INITIALLY DEFERRED,
794 credit_amount NUMERIC
797 CREATE INDEX acq_attribution_debit_idx
798 ON acq.debit_attribution( fund_debit );
800 CREATE INDEX acq_attribution_credit_idx
801 ON acq.debit_attribution( funding_source_credit );
805 CREATE TABLE acq.invoice_method (
806 code TEXT PRIMARY KEY,
807 name TEXT NOT NULL -- i18n-ize
810 CREATE TABLE acq.invoice_payment_method (
811 code TEXT PRIMARY KEY,
812 name TEXT NOT NULL -- i18n-ize
815 CREATE TABLE acq.invoice (
816 id SERIAL PRIMARY KEY,
817 receiver INT NOT NULL REFERENCES actor.org_unit (id),
818 provider INT NOT NULL REFERENCES acq.provider (id),
819 shipper INT NOT NULL REFERENCES acq.provider (id),
820 recv_date TIMESTAMPTZ NOT NULL DEFAULT NOW(),
821 recv_method TEXT NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
822 inv_type TEXT, -- A "type" field is desired, but no idea what goes here
823 inv_ident TEXT NOT NULL, -- vendor-supplied invoice id/number
825 payment_method TEXT REFERENCES acq.invoice_payment_method (code)
826 DEFERRABLE INITIALLY DEFERRED,
828 complete BOOL NOT NULL DEFAULT FALSE,
829 CONSTRAINT inv_ident_once_per_provider UNIQUE(provider, inv_ident)
832 CREATE TABLE acq.invoice_entry (
833 id SERIAL PRIMARY KEY,
834 invoice INT NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
835 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
836 lineitem INT REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
837 inv_item_count INT NOT NULL, -- How many acqlids did they say they sent
838 phys_item_count INT, -- and how many did staff count
840 billed_per_item BOOL,
841 cost_billed NUMERIC(8,2),
842 actual_cost NUMERIC(8,2),
843 amount_paid NUMERIC (8,2)
846 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
847 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
848 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
850 CREATE TABLE acq.invoice_item_type (
851 code TEXT PRIMARY KEY,
852 name TEXT NOT NULL, -- i18n-ize
853 prorate BOOL NOT NULL DEFAULT FALSE
856 CREATE TABLE acq.po_item (
857 id SERIAL PRIMARY KEY,
858 purchase_order INT REFERENCES acq.purchase_order (id)
859 ON UPDATE CASCADE ON DELETE SET NULL
860 DEFERRABLE INITIALLY DEFERRED,
861 fund_debit INT REFERENCES acq.fund_debit (id)
862 DEFERRABLE INITIALLY DEFERRED,
863 inv_item_type TEXT NOT NULL
864 REFERENCES acq.invoice_item_type (code)
865 DEFERRABLE INITIALLY DEFERRED,
869 estimated_cost NUMERIC(8,2),
870 fund INT REFERENCES acq.fund (id)
871 DEFERRABLE INITIALLY DEFERRED,
875 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
877 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
878 id SERIAL PRIMARY KEY,
879 invoice INT NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
880 purchase_order INT REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
881 fund_debit INT REFERENCES acq.fund_debit (id),
882 inv_item_type TEXT NOT NULL REFERENCES acq.invoice_item_type (code),
886 cost_billed NUMERIC(8,2),
887 actual_cost NUMERIC(8,2),
888 fund INT REFERENCES acq.fund (id)
889 DEFERRABLE INITIALLY DEFERRED,
890 amount_paid NUMERIC (8,2),
891 po_item INT REFERENCES acq.po_item (id)
892 DEFERRABLE INITIALLY DEFERRED,
896 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
897 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
898 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
901 CREATE TABLE acq.user_request_type (
902 id SERIAL PRIMARY KEY,
903 label TEXT NOT NULL UNIQUE -- i18n-ize
906 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
907 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
908 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
909 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
910 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
912 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
914 CREATE TABLE acq.user_request (
915 id SERIAL PRIMARY KEY,
916 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
917 hold BOOL NOT NULL DEFAULT TRUE,
919 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
920 holdable_formats TEXT, -- nullable, for use in hold creation
922 email_notify BOOL NOT NULL DEFAULT TRUE,
923 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
924 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
925 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
926 need_before TIMESTAMPTZ, -- don't create holds after this
929 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
941 cancel_reason INT REFERENCES acq.cancel_reason( id )
942 DEFERRABLE INITIALLY DEFERRED
948 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
949 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
952 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
955 SELECT COUNT(*) INTO counter
956 FROM oils_xpath_table(
960 '//*[@tag="' || tag || '"]',
962 ) as t(i int,c text);
964 FOR i IN 1 .. counter LOOP
967 FROM ( SELECT id,i,t,v
968 FROM oils_xpath_table(
972 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
973 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
975 ) as t(id int,t text,v text)
986 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
987 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
991 lida acq.flat_lineitem_detail%ROWTYPE;
993 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
994 IF NOT FOUND THEN RETURN; END IF;
996 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
997 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1004 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1005 JOIN acq.provider_holding_subfield_map a USING (subfield)
1006 WHERE a.provider = prov_i
1013 $$ LANGUAGE PLPGSQL;
1015 -- select * from acq.extract_provider_holding_data(699);
1017 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1018 SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1022 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1023 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1026 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1027 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1031 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1034 Suggested vendor fields:
1042 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1051 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1053 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1055 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1056 IF (atype = 'lineitem_provider_attr_definition') THEN
1057 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1058 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1061 IF (atype = 'lineitem_provider_attr_definition') THEN
1062 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1063 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1064 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1065 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1066 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1069 xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1071 IF (adef.code = 'title' OR adef.code = 'author') THEN
1072 -- title and author should not be split
1073 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1074 -- string-join in the xpath and remove this special case
1075 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1076 IF (value IS NOT NULL AND value <> '') THEN
1077 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1078 VALUES (NEW.id, adef.id, atype, adef.code, value);
1084 SELECT extract_acq_marc_field(id, xpath_string || '[' || pos || ']', adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1086 IF (value IS NOT NULL AND value <> '') THEN
1087 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1088 VALUES (NEW.id, adef.id, atype, adef.code, value);
1103 $function$ LANGUAGE PLPGSQL;
1105 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1107 IF TG_OP = 'UPDATE' THEN
1108 DELETE FROM acq.lineitem_attr
1109 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1112 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1116 $$ LANGUAGE PLPGSQL;
1118 CREATE TRIGGER cleanup_lineitem_trigger
1119 BEFORE UPDATE OR DELETE ON acq.lineitem
1120 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1122 CREATE TRIGGER ingest_lineitem_trigger
1123 AFTER INSERT OR UPDATE ON acq.lineitem
1124 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1126 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1130 IF from_ex = to_ex THEN
1134 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1139 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1148 $$ LANGUAGE PLPGSQL;
1150 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1151 SELECT $3 * acq.exchange_ratio($1, $2);
1154 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1156 Examine the acq.fiscal_year table, comparing successive years.
1157 Report any inconsistencies, i.e. years that overlap, have gaps
1158 between them, or are out of sequence.
1160 RETURNS SETOF RECORD AS $$
1184 ELSIF curr_year.calendar = prev_year.calendar THEN
1185 IF curr_year.year_begin > prev_year.year_end THEN
1186 -- This ugly kludge works around the fact that older
1187 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1188 FOR return_rec IN SELECT
1191 'Gap between fiscal years'::TEXT
1193 RETURN NEXT return_rec;
1195 ELSIF curr_year.year_begin < prev_year.year_end THEN
1196 FOR return_rec IN SELECT
1199 'Overlapping fiscal years'::TEXT
1201 RETURN NEXT return_rec;
1203 ELSIF curr_year.year < prev_year.year THEN
1204 FOR return_rec IN SELECT
1207 'Fiscal years out of order'::TEXT
1209 RETURN NEXT return_rec;
1214 prev_year := curr_year;
1219 $$ LANGUAGE plpgsql;
1221 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1223 old_amount IN NUMERIC, -- in currency of old fund
1225 new_amount IN NUMERIC, -- in currency of new fund
1227 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1228 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1229 ) RETURNS VOID AS $$
1230 /* -------------------------------------------------------------------------------
1232 Function to transfer money from one fund to another.
1234 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1235 negative amount for the old (losing) fund and a positive amount for the new
1236 (gaining) fund. In some cases there may be more than one such pair of entries
1237 in order to pull the money from different funding sources, or more specifically
1238 from different funding source credits. For each such pair there is also an
1239 entry in acq.fund_transfer.
1241 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1242 choose a funding source for the transferred money to come from. This choice
1243 must meet two constraints, so far as possible:
1245 1. The amount transferred from a given funding source must not exceed the
1246 amount allocated to the old fund by the funding source. To that end we
1247 compare the amount being transferred to the amount allocated.
1249 2. We shouldn't transfer money that has already been spent or encumbered, as
1250 defined by the funding attribution process. We attribute expenses to the
1251 oldest funding source credits first. In order to avoid transferring that
1252 attributed money, we reverse the priority, transferring from the newest funding
1253 source credits first. There can be no guarantee that this approach will
1254 avoid overcommitting a fund, but no other approach can do any better.
1256 In this context the age of a funding source credit is defined by the
1257 deadline_date for credits with deadline_dates, and by the effective_date for
1258 credits without deadline_dates, with the proviso that credits with deadline_dates
1259 are all considered "older" than those without.
1263 In the signature for this function, there is one last parameter commented out,
1264 named "funding_source_in". Correspondingly, the WHERE clause for the query
1265 driving the main loop has an OR clause commented out, which references the
1266 funding_source_in parameter.
1268 If these lines are uncommented, this function will allow the user optionally to
1269 restrict a fund transfer to a specified funding source. If the source
1270 parameter is left NULL, then there will be no such restriction.
1272 ------------------------------------------------------------------------------- */
1274 same_currency BOOLEAN;
1275 currency_ratio NUMERIC;
1276 old_fund_currency TEXT;
1277 old_remaining NUMERIC; -- in currency of old fund
1278 new_fund_currency TEXT;
1279 new_fund_active BOOLEAN;
1280 new_remaining NUMERIC; -- in currency of new fund
1281 curr_old_amt NUMERIC; -- in currency of old fund
1282 curr_new_amt NUMERIC; -- in currency of new fund
1283 source_addition NUMERIC; -- in currency of funding source
1284 source_deduction NUMERIC; -- in currency of funding source
1285 orig_allocated_amt NUMERIC; -- in currency of funding source
1286 allocated_amt NUMERIC; -- in currency of fund
1292 IF old_fund IS NULL THEN
1293 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1296 IF old_amount IS NULL THEN
1297 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1300 -- The new fund and its amount must be both NULL or both not NULL.
1302 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1303 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1306 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1307 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1310 IF user_id IS NULL THEN
1311 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1314 -- Initialize the amounts to be transferred, each denominated
1315 -- in the currency of its respective fund. They will be
1316 -- reduced on each iteration of the loop.
1318 old_remaining := old_amount;
1319 new_remaining := new_amount;
1321 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1322 -- old_amount, old_fund, new_amount, new_fund;
1324 -- Get the currency types of the old and new funds.
1335 IF old_fund_currency IS NULL THEN
1336 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1339 IF new_fund IS NOT NULL THEN
1351 IF new_fund_currency IS NULL THEN
1352 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1353 ELSIF NOT new_fund_active THEN
1355 -- No point in putting money into a fund from whence you can't spend it
1357 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1360 IF new_amount = old_amount THEN
1361 same_currency := true;
1362 currency_ratio := 1;
1365 -- We'll have to translate currency between funds. We presume that
1366 -- the calling code has already applied an appropriate exchange rate,
1367 -- so we'll apply the same conversion to each sub-transfer.
1369 same_currency := false;
1370 currency_ratio := new_amount / old_amount;
1374 -- Identify the funding source(s) from which we want to transfer the money.
1375 -- The principle is that we want to transfer the newest money first, because
1376 -- we spend the oldest money first. The priority for spending is defined
1377 -- by a sort of the view acq.ordered_funding_source_credit.
1382 ofsc.funding_source,
1384 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1388 acq.ordered_funding_source_credit AS ofsc,
1389 acq.funding_source fs
1391 ofsc.funding_source = fs.id
1392 and ofsc.funding_source IN
1394 SELECT funding_source
1395 FROM acq.fund_allocation
1396 WHERE fund = old_fund
1400 -- ofsc.funding_source = funding_source_in
1401 -- OR funding_source_in IS NULL
1404 ofsc.sort_priority desc,
1405 ofsc.sort_date desc,
1409 -- Determine how much money the old fund got from this funding source,
1410 -- denominated in the currency types of the source and of the fund.
1411 -- This result may reflect transfers from previous iterations.
1414 COALESCE( sum( amount ), 0 ),
1415 COALESCE( sum( amount )
1416 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1418 orig_allocated_amt, -- in currency of the source
1419 allocated_amt -- in currency of the old fund
1424 and funding_source = source.funding_source;
1426 -- Determine how much to transfer from this credit, in the currency
1427 -- of the fund. Begin with the amount remaining to be attributed:
1429 curr_old_amt := old_remaining;
1431 -- Can't attribute more than was allocated from the fund:
1433 IF curr_old_amt > allocated_amt THEN
1434 curr_old_amt := allocated_amt;
1437 -- Can't attribute more than the amount of the current credit:
1439 IF curr_old_amt > source.converted_amt THEN
1440 curr_old_amt := source.converted_amt;
1443 curr_old_amt := trunc( curr_old_amt, 2 );
1445 old_remaining := old_remaining - curr_old_amt;
1447 -- Determine the amount to be deducted, if any,
1448 -- from the old allocation.
1450 IF old_remaining > 0 THEN
1452 -- In this case we're using the whole allocation, so use that
1453 -- amount directly instead of applying a currency translation
1454 -- and thereby inviting round-off errors.
1456 source_deduction := - orig_allocated_amt;
1458 source_deduction := trunc(
1459 ( - curr_old_amt ) *
1460 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1464 IF source_deduction <> 0 THEN
1466 -- Insert negative allocation for old fund in fund_allocation,
1467 -- converted into the currency of the funding source
1469 INSERT INTO acq.fund_allocation (
1476 source.funding_source,
1480 'Transfer to fund ' || new_fund
1484 IF new_fund IS NOT NULL THEN
1486 -- Determine how much to add to the new fund, in
1487 -- its currency, and how much remains to be added:
1489 IF same_currency THEN
1490 curr_new_amt := curr_old_amt;
1492 IF old_remaining = 0 THEN
1494 -- This is the last iteration, so nothing should be left
1496 curr_new_amt := new_remaining;
1499 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1500 new_remaining := new_remaining - curr_new_amt;
1504 -- Determine how much to add, if any,
1505 -- to the new fund's allocation.
1507 IF old_remaining > 0 THEN
1509 -- In this case we're using the whole allocation, so use that amount
1510 -- amount directly instead of applying a currency translation and
1511 -- thereby inviting round-off errors.
1513 source_addition := orig_allocated_amt;
1514 ELSIF source.currency_type = old_fund_currency THEN
1516 -- In this case we don't need a round trip currency translation,
1517 -- thereby inviting round-off errors:
1519 source_addition := curr_old_amt;
1521 source_addition := trunc(
1523 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1527 IF source_addition <> 0 THEN
1529 -- Insert positive allocation for new fund in fund_allocation,
1530 -- converted to the currency of the founding source
1532 INSERT INTO acq.fund_allocation (
1539 source.funding_source,
1543 'Transfer from fund ' || old_fund
1548 IF trunc( curr_old_amt, 2 ) <> 0
1549 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1551 -- Insert row in fund_transfer, using amounts in the currency of the funds
1553 INSERT INTO acq.fund_transfer (
1560 funding_source_credit
1563 trunc( curr_old_amt, 2 ),
1565 trunc( curr_new_amt, 2 ),
1572 if old_remaining <= 0 THEN
1573 EXIT; -- Nothing more to be transferred
1577 $$ LANGUAGE plpgsql;
1579 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1581 Function to attribute expenditures and encumbrances to funding source credits,
1582 and thereby to funding sources.
1584 Read the debits in chonological order, attributing each one to one or
1585 more funding source credits. Constraints:
1587 1. Don't attribute more to a credit than the amount of the credit.
1589 2. For a given fund, don't attribute more to a funding source than the
1590 source has allocated to that fund.
1592 3. Attribute debits to credits with deadlines before attributing them to
1593 credits without deadlines. Otherwise attribute to the earliest credits
1594 first, based on the deadline date when present, or on the effective date
1595 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1596 This ordering is defined by an ORDER BY clause on the view
1597 acq.ordered_funding_source_credit.
1599 Start by truncating the table acq.debit_attribution. Then insert a row
1600 into that table for each attribution. If a debit cannot be fully
1601 attributed, insert a row for the unattributable balance, with the
1602 funding_source_credit and credit_amount columns NULL.
1605 curr_fund_source_bal RECORD;
1606 seqno INT; -- sequence num for credits applicable to a fund
1607 fund_credit RECORD; -- current row in temp t_fund_credit table
1608 fc RECORD; -- used for loading t_fund_credit table
1609 sc RECORD; -- used for loading t_fund_credit table
1611 -- Used exclusively in the main loop:
1613 deb RECORD; -- current row from acq.fund_debit table
1614 curr_credit_bal RECORD; -- current row from temp t_credit table
1615 debit_balance NUMERIC; -- amount left to attribute for current debit
1616 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1617 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1618 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1619 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1620 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1621 attrib_count INT; -- populates id of acq.debit_attribution
1624 -- Load a temporary table. For each combination of fund and funding source,
1625 -- load an entry with the total amount allocated to that fund by that source.
1626 -- This sum may reflect transfers as well as original allocations. We will
1627 -- reduce this balance whenever we attribute debits to it.
1629 CREATE TEMP TABLE t_fund_source_bal
1633 funding_source AS source,
1634 sum( amount ) AS balance
1643 CREATE INDEX t_fund_source_bal_idx
1644 ON t_fund_source_bal( fund, source );
1645 -------------------------------------------------------------------------------
1647 -- Load another temporary table. For each fund, load zero or more
1648 -- funding source credits from which that fund can get money.
1650 CREATE TEMP TABLE t_fund_credit (
1657 SELECT DISTINCT fund
1658 FROM acq.fund_allocation
1660 LOOP -- Loop over the funds
1666 acq.ordered_funding_source_credit AS ofsc
1668 ofsc.funding_source IN
1670 SELECT funding_source
1671 FROM acq.fund_allocation
1672 WHERE fund = fc.fund
1678 LOOP -- Add each credit to the list
1679 INSERT INTO t_fund_credit (
1688 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1690 END LOOP; -- Loop over credits for a given fund
1691 END LOOP; -- Loop over funds
1693 CREATE INDEX t_fund_credit_idx
1694 ON t_fund_credit( fund, seq );
1695 -------------------------------------------------------------------------------
1697 -- Load yet another temporary table. This one is a list of funding source
1698 -- credits, with their balances. We shall reduce those balances as we
1699 -- attribute debits to them.
1701 CREATE TEMP TABLE t_credit
1705 fsc.funding_source AS source,
1706 fsc.amount AS balance,
1707 fs.currency_type AS currency_type
1709 acq.funding_source_credit AS fsc,
1710 acq.funding_source fs
1712 fsc.funding_source = fs.id
1715 CREATE INDEX t_credit_idx
1716 ON t_credit( credit );
1718 -------------------------------------------------------------------------------
1720 -- Now that we have loaded the lookup tables: loop through the debits,
1721 -- attributing each one to one or more funding source credits.
1723 truncate table acq.debit_attribution;
1741 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1743 debit_balance := deb.amount;
1745 -- Loop over the funding source credits that are eligible
1746 -- to pay for this debit
1758 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1760 -- Look up the balance for this credit. If it's zero, then
1761 -- it's not useful, so treat it as if you didn't find it.
1762 -- (Actually there shouldn't be any zero balances in the table,
1763 -- but we check just to make sure.)
1766 INTO curr_credit_bal
1769 credit = fund_credit.credit
1772 IF curr_credit_bal IS NULL THEN
1774 -- This credit is exhausted; try the next one.
1780 -- At this point we have an applicable credit with some money left.
1781 -- Now see if the relevant funding_source has any money left.
1783 -- Look up the balance of the allocation for this combination of
1784 -- fund and source. If you find such an entry, but it has a zero
1785 -- balance, then it's not useful, so treat it as unfound.
1786 -- (Actually there shouldn't be any zero balances in the table,
1787 -- but we check just to make sure.)
1790 INTO curr_fund_source_bal
1791 FROM t_fund_source_bal
1794 AND source = curr_credit_bal.source
1797 IF curr_fund_source_bal IS NULL THEN
1799 -- This fund/source doesn't exist or is already exhausted,
1800 -- so we can't use this credit. Go on to the next one.
1805 -- Convert the available balances to the currency of the fund
1807 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1808 curr_credit_bal.currency_type, deb.currency_type );
1809 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1810 curr_credit_bal.currency_type, deb.currency_type );
1812 -- Determine how much we can attribute to this credit: the minimum
1813 -- of the debit amount, the fund/source balance, and the
1816 --RAISE NOTICE ' deb bal %', debit_balance;
1817 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1818 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1820 conv_attr_amount := NULL;
1821 attr_amount := debit_balance;
1823 IF attr_amount > conv_alloc_balance THEN
1824 attr_amount := conv_alloc_balance;
1825 conv_attr_amount := curr_fund_source_bal.balance;
1827 IF attr_amount > conv_cred_balance THEN
1828 attr_amount := conv_cred_balance;
1829 conv_attr_amount := curr_credit_bal.balance;
1832 -- If we're attributing all of one of the balances, then that's how
1833 -- much we will deduct from the balances, and we already captured
1834 -- that amount above. Otherwise we must convert the amount of the
1835 -- attribution from the currency of the fund back to the currency of
1836 -- the funding source.
1838 IF conv_attr_amount IS NULL THEN
1839 conv_attr_amount := attr_amount * acq.exchange_ratio(
1840 deb.currency_type, curr_credit_bal.currency_type );
1843 -- Insert a row to record the attribution
1845 attrib_count := attrib_count + 1;
1846 INSERT INTO acq.debit_attribution (
1850 funding_source_credit,
1856 curr_credit_bal.credit,
1860 -- Subtract the attributed amount from the various balances
1862 debit_balance := debit_balance - attr_amount;
1863 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1865 IF curr_fund_source_bal.balance <= 0 THEN
1867 -- This allocation is exhausted. Delete it so
1868 -- that we don't waste time looking at it again.
1870 DELETE FROM t_fund_source_bal
1872 fund = curr_fund_source_bal.fund
1873 AND source = curr_fund_source_bal.source;
1875 UPDATE t_fund_source_bal
1876 SET balance = balance - conv_attr_amount
1878 fund = curr_fund_source_bal.fund
1879 AND source = curr_fund_source_bal.source;
1882 IF curr_credit_bal.balance <= 0 THEN
1884 -- This funding source credit is exhausted. Delete it
1885 -- so that we don't waste time looking at it again.
1887 --DELETE FROM t_credit
1889 -- credit = curr_credit_bal.credit;
1891 DELETE FROM t_fund_credit
1893 credit = curr_credit_bal.credit;
1896 SET balance = curr_credit_bal.balance
1898 credit = curr_credit_bal.credit;
1901 -- Are we done with this debit yet?
1903 IF debit_balance <= 0 THEN
1904 EXIT; -- We've fully attributed this debit; stop looking at credits.
1906 END LOOP; -- End loop over credits
1908 IF debit_balance <> 0 THEN
1910 -- We weren't able to attribute this debit, or at least not
1911 -- all of it. Insert a row for the unattributed balance.
1913 attrib_count := attrib_count + 1;
1914 INSERT INTO acq.debit_attribution (
1918 funding_source_credit,
1928 END LOOP; -- End of loop over debits
1930 $$ LANGUAGE 'plpgsql';
1932 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1935 org_unit_id INTEGER,
1936 include_desc BOOL DEFAULT TRUE
1937 ) RETURNS VOID AS $$
1948 IF old_year IS NULL THEN
1949 RAISE EXCEPTION 'Input year argument is NULL';
1950 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1951 RAISE EXCEPTION 'Input year is out of range';
1954 IF user_id IS NULL THEN
1955 RAISE EXCEPTION 'Input user id argument is NULL';
1958 IF org_unit_id IS NULL THEN
1959 RAISE EXCEPTION 'Org unit id argument is NULL';
1961 SELECT TRUE INTO org_found
1963 WHERE id = org_unit_id;
1965 IF org_found IS NULL THEN
1966 RAISE EXCEPTION 'Org unit id is invalid';
1970 -- Loop over the applicable funds
1972 FOR old_fund in SELECT * FROM acq.fund
1976 AND ( ( include_desc AND org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
1977 OR (NOT include_desc AND org = org_unit_id ) )
1981 INSERT INTO acq.fund (
1989 balance_warning_percent,
1990 balance_stop_percent
1995 old_fund.currency_type,
1999 old_fund.balance_warning_percent,
2000 old_fund.balance_stop_percent
2002 RETURNING id INTO new_id;
2004 WHEN unique_violation THEN
2005 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2008 --RAISE NOTICE 'Propagating fund % to fund %',
2009 -- old_fund.code, new_id;
2012 $$ LANGUAGE plpgsql;
2014 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER ) RETURNS VOID AS $$
2015 SELECT acq.propagate_funds_by_org_tree( $1, $2, $3, FALSE );
2019 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2022 org_unit_id INTEGER,
2023 encumb_only BOOL DEFAULT FALSE,
2024 include_desc BOOL DEFAULT TRUE
2025 ) RETURNS VOID AS $$
2029 new_year INT := old_year + 1;
2032 xfer_amount NUMERIC := 0;
2041 IF old_year IS NULL THEN
2042 RAISE EXCEPTION 'Input year argument is NULL';
2043 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2044 RAISE EXCEPTION 'Input year is out of range';
2047 IF user_id IS NULL THEN
2048 RAISE EXCEPTION 'Input user id argument is NULL';
2051 IF org_unit_id IS NULL THEN
2052 RAISE EXCEPTION 'Org unit id argument is NULL';
2055 -- Validate the org unit
2060 WHERE id = org_unit_id;
2062 IF org_found IS NULL THEN
2063 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2064 ELSIF encumb_only THEN
2065 SELECT INTO perm_ous value::BOOL FROM
2066 actor.org_unit_ancestor_setting(
2067 'acq.fund.allow_rollover_without_money', org_unit_id
2069 IF NOT FOUND OR NOT perm_ous THEN
2070 RAISE EXCEPTION 'Encumbrance-only rollover not permitted at org %', org_unit_id;
2075 -- Loop over the propagable funds to identify the details
2076 -- from the old fund plus the id of the new one, if it exists.
2080 oldf.id AS old_fund,
2086 newf.id AS new_fund_id
2089 LEFT JOIN acq.fund AS newf
2090 ON ( oldf.code = newf.code )
2092 oldf.year = old_year
2094 AND newf.year = new_year
2095 AND ( ( include_desc AND oldf.org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2096 OR (NOT include_desc AND oldf.org = org_unit_id ) )
2098 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2100 IF roll_fund.new_fund_id IS NULL THEN
2102 -- The old fund hasn't been propagated yet. Propagate it now.
2104 INSERT INTO acq.fund (
2112 balance_warning_percent,
2113 balance_stop_percent
2118 roll_fund.currency_type,
2122 roll_fund.balance_warning_percent,
2123 roll_fund.balance_stop_percent
2125 RETURNING id INTO new_fund;
2127 new_fund = roll_fund.new_fund_id;
2130 -- Determine the amount to transfer
2134 FROM acq.fund_spent_balance
2135 WHERE fund = roll_fund.old_fund;
2137 IF xfer_amount <> 0 THEN
2138 IF NOT encumb_only AND roll_fund.rollover THEN
2140 -- Transfer balance from old fund to new
2142 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2144 PERFORM acq.transfer_fund(
2154 -- Transfer balance from old fund to the void
2156 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2158 PERFORM acq.transfer_fund(
2164 'Rollover into the void'
2169 IF roll_fund.rollover THEN
2171 -- Move any lineitems from the old fund to the new one
2172 -- where the associated debit is an encumbrance.
2174 -- Any other tables tying expenditure details to funds should
2175 -- receive similar treatment. At this writing there are none.
2177 UPDATE acq.lineitem_detail
2180 fund = roll_fund.old_fund -- this condition may be redundant
2186 fund = roll_fund.old_fund
2190 -- Move encumbrance debits from the old fund to the new fund
2192 UPDATE acq.fund_debit
2195 fund = roll_fund.old_fund
2199 -- Mark old fund as inactive, now that we've closed it
2203 WHERE id = roll_fund.old_fund;
2206 $$ LANGUAGE plpgsql;
2208 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 $$
2209 SELECT acq.rollover_funds_by_org_tree( $1, $2, $3, $4, FALSE );
2212 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2213 SELECT funding_source,
2214 SUM(amount) AS amount
2215 FROM acq.funding_source_credit
2218 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2219 SELECT funding_source,
2220 SUM(a.amount)::NUMERIC(100,2) AS amount
2221 FROM acq.fund_allocation a
2224 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2225 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
2226 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2227 FROM acq.funding_source_credit_total c
2228 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2231 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2233 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2234 FROM acq.fund_allocation a
2235 JOIN acq.fund f ON (a.fund = f.id)
2236 JOIN acq.funding_source s ON (a.funding_source = s.id)
2239 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2240 SELECT fund.id AS fund,
2241 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2243 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2246 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2249 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2251 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2252 WHERE fund_debit.encumbrance GROUP BY fund.id;
2254 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2255 SELECT fund.id AS fund,
2256 sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2258 LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2259 WHERE NOT fund_debit.encumbrance
2262 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2264 c.amount - COALESCE(d.amount, 0.0) AS amount
2265 FROM acq.fund_allocation_total c
2266 LEFT JOIN acq.fund_debit_total d USING (fund);
2268 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2270 c.amount - COALESCE(d.amount,0.0) AS amount
2271 FROM acq.fund_allocation_total c
2272 LEFT JOIN acq.fund_spent_total d USING (fund);
2274 -- For each fund: the total allocation from all sources, in the
2275 -- currency of the fund (or 0 if there are no allocations)
2277 CREATE VIEW acq.all_fund_allocation_total AS
2280 COALESCE( SUM( a.amount * acq.exchange_ratio(
2281 s.currency_type, f.currency_type))::numeric(100,2), 0 )
2285 LEFT JOIN acq.fund_allocation a
2287 LEFT JOIN acq.funding_source s
2288 ON a.funding_source = s.id
2292 -- For every fund: the total encumbrances (or 0 if none),
2293 -- in the currency of the fund.
2295 CREATE VIEW acq.all_fund_encumbrance_total AS
2298 COALESCE( encumb.amount, 0 ) AS amount
2304 sum( amount ) AS amount
2311 ON f.id = encumb.fund;
2313 -- For every fund: the total spent (or 0 if none),
2314 -- in the currency of the fund.
2316 CREATE VIEW acq.all_fund_spent_total AS
2319 COALESCE( spent.amount, 0 ) AS amount
2325 sum( amount ) AS amount
2332 ON f.id = spent.fund;
2334 -- For each fund: the amount not yet spent, in the currency
2335 -- of the fund. May include encumbrances.
2337 CREATE VIEW acq.all_fund_spent_balance AS
2340 c.amount - d.amount AS amount
2341 FROM acq.all_fund_allocation_total c
2342 LEFT JOIN acq.all_fund_spent_total d USING (fund);
2344 -- For each fund: the amount neither spent nor encumbered,
2345 -- in the currency of the fund
2347 CREATE VIEW acq.all_fund_combined_balance AS
2350 a.amount - COALESCE( c.amount, 0 ) AS amount
2352 acq.all_fund_allocation_total a
2356 SUM( amount ) AS amount
2361 ) AS c USING ( fund );
2363 CREATE TABLE acq.claim_type (
2364 id SERIAL PRIMARY KEY,
2365 org_unit INT NOT NULL REFERENCES actor.org_unit(id)
2366 DEFERRABLE INITIALLY DEFERRED,
2368 description TEXT NOT NULL,
2369 CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2372 CREATE TABLE acq.claim (
2373 id SERIAL PRIMARY KEY,
2374 type INT NOT NULL REFERENCES acq.claim_type
2375 DEFERRABLE INITIALLY DEFERRED,
2376 lineitem_detail BIGINT NOT NULL REFERENCES acq.lineitem_detail
2377 DEFERRABLE INITIALLY DEFERRED
2380 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2382 CREATE TABLE acq.claim_event (
2383 id BIGSERIAL PRIMARY KEY,
2384 type INT NOT NULL REFERENCES acq.claim_event_type
2385 DEFERRABLE INITIALLY DEFERRED,
2386 claim SERIAL NOT NULL REFERENCES acq.claim
2387 DEFERRABLE INITIALLY DEFERRED,
2388 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2389 creator INT NOT NULL REFERENCES actor.usr
2390 DEFERRABLE INITIALLY DEFERRED,
2394 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2396 -- And the serials version of claiming
2397 CREATE TABLE acq.serial_claim (
2398 id SERIAL PRIMARY KEY,
2399 type INT NOT NULL REFERENCES acq.claim_type
2400 DEFERRABLE INITIALLY DEFERRED,
2401 item BIGINT NOT NULL REFERENCES serial.item
2402 DEFERRABLE INITIALLY DEFERRED
2405 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2407 CREATE TABLE acq.serial_claim_event (
2408 id BIGSERIAL PRIMARY KEY,
2409 type INT NOT NULL REFERENCES acq.claim_event_type
2410 DEFERRABLE INITIALLY DEFERRED,
2411 claim SERIAL NOT NULL REFERENCES acq.serial_claim
2412 DEFERRABLE INITIALLY DEFERRED,
2413 event_date TIMESTAMPTZ NOT NULL DEFAULT now(),
2414 creator INT NOT NULL REFERENCES actor.usr
2415 DEFERRABLE INITIALLY DEFERRED,
2419 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );
2421 CREATE OR REPLACE VIEW acq.lineitem_summary AS
2425 SELECT COUNT(lid.id)
2426 FROM acq.lineitem_detail lid
2427 WHERE lineitem = li.id
2430 SELECT COUNT(lid.id)
2431 FROM acq.lineitem_detail lid
2432 WHERE recv_time IS NOT NULL AND lineitem = li.id
2435 SELECT COUNT(lid.id)
2436 FROM acq.lineitem_detail lid
2437 WHERE cancel_reason IS NOT NULL AND lineitem = li.id
2440 SELECT COUNT(lid.id)
2441 FROM acq.lineitem_detail lid
2442 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2443 WHERE NOT debit.encumbrance AND lineitem = li.id
2446 SELECT COUNT(DISTINCT(lid.id))
2447 FROM acq.lineitem_detail lid
2448 JOIN acq.claim claim ON (claim.lineitem_detail = lid.id)
2449 WHERE lineitem = li.id
2452 SELECT (COUNT(lid.id) * li.estimated_unit_price)::NUMERIC(8,2)
2453 FROM acq.lineitem_detail lid
2454 WHERE lid.cancel_reason IS NULL AND lineitem = li.id
2455 ) AS estimated_amount,
2457 SELECT SUM(debit.amount)::NUMERIC(8,2)
2458 FROM acq.lineitem_detail lid
2459 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2460 WHERE debit.encumbrance AND lineitem = li.id
2461 ) AS encumbrance_amount,
2463 SELECT SUM(debit.amount)::NUMERIC(8,2)
2464 FROM acq.lineitem_detail lid
2465 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2466 WHERE NOT debit.encumbrance AND lineitem = li.id
2469 FROM acq.lineitem AS li;