1 DROP SCHEMA acq CASCADE;
11 CREATE TABLE acq.currency_type (
12 code TEXT PRIMARY KEY,
16 -- Use the ISO 4217 abbreviations for currency codes
17 INSERT INTO acq.currency_type (code, label) VALUES ('USD','US Dollars');
18 INSERT INTO acq.currency_type (code, label) VALUES ('CAN','Canadian Dollars');
19 INSERT INTO acq.currency_type (code, label) VALUES ('EUR','Euros');
21 CREATE TABLE acq.exchange_rate (
22 id SERIAL PRIMARY KEY,
23 from_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
24 to_currency TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
25 ratio NUMERIC NOT NULL,
26 CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
29 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','CAN',1.2);
30 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','EUR',0.5);
32 CREATE TABLE acq.provider (
33 id SERIAL PRIMARY KEY,
35 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
36 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
40 edi_default INT, -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
41 active BOOL NOT NULL DEFAULT TRUE,
42 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
43 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
46 CREATE TABLE acq.provider_holding_subfield_map (
47 id SERIAL PRIMARY KEY,
48 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
49 name TEXT NOT NULL, -- barcode, price, etc
50 subfield TEXT NOT NULL,
51 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
54 CREATE TABLE acq.provider_address (
55 id SERIAL PRIMARY KEY,
56 valid BOOL NOT NULL DEFAULT TRUE,
58 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
59 street1 TEXT NOT NULL,
64 country TEXT NOT NULL,
65 post_code TEXT NOT NULL
68 CREATE TABLE acq.provider_contact (
69 id SERIAL PRIMARY KEY,
70 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
72 role TEXT, -- free-form.. e.g. "our sales guy"
77 CREATE TABLE acq.provider_contact_address (
78 id SERIAL PRIMARY KEY,
79 valid BOOL NOT NULL DEFAULT TRUE,
81 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
82 street1 TEXT NOT NULL,
87 country TEXT NOT NULL,
88 post_code TEXT NOT NULL
92 CREATE TABLE acq.funding_source (
93 id SERIAL PRIMARY KEY,
95 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
96 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
98 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
101 CREATE TABLE acq.funding_source_credit (
102 id SERIAL PRIMARY KEY,
103 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
104 amount NUMERIC NOT NULL,
106 deadline_date TIMESTAMPTZ,
107 effective_date TIMESTAMPTZ NOT NULL default now()
110 CREATE VIEW acq.ordered_funding_source_credit AS
112 CASE WHEN deadline_date IS NULL THEN
116 END AS sort_priority,
117 CASE WHEN deadline_date IS NULL THEN
127 acq.funding_source_credit;
129 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
131 * Copyright (C) 2009 Georgia Public Library Service
132 * Scott McKellar <scott@gmail.com>
134 * The acq.ordered_funding_source_credit view is a prioritized
135 * ordering of funding source credits. When ordered by the first
136 * three columns, this view defines the order in which the various
137 * credits are to be tapped for spending, subject to the allocations
138 * in the acq.fund_allocation table.
140 * The first column reflects the principle that we should spend
141 * money with deadlines before spending money without deadlines.
143 * The second column reflects the principle that we should spend the
144 * oldest money first. For money with deadlines, that means that we
145 * spend first from the credit with the earliest deadline. For
146 * money without deadlines, we spend first from the credit with the
147 * earliest effective date.
149 * The third column is a tie breaker to ensure a consistent
154 * This program is free software; you can redistribute it and/or
155 * modify it under the terms of the GNU General Public License
156 * as published by the Free Software Foundation; either version 2
157 * of the License, or (at your option) any later version.
159 * This program is distributed in the hope that it will be useful,
160 * but WITHOUT ANY WARRANTY; without even the implied warranty of
161 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
162 * GNU General Public License for more details.
166 CREATE TABLE acq.fund (
167 id SERIAL PRIMARY KEY,
168 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
170 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
171 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
173 rollover BOOL NOT NULL DEFAULT FALSE,
174 propagate BOOL NOT NULL DEFAULT TRUE,
175 active BOOL NOT NULL DEFAULT TRUE,
176 balance_warning_percent INT CONSTRAINT balance_warning_percent_limit
177 CHECK( balance_warning_percent <= 100 ),
178 balance_stop_percent INT CONSTRAINT balance_stop_percent_limit
179 CHECK( balance_stop_percent <= 100 ),
180 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
181 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
182 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
185 CREATE TABLE acq.fund_debit (
186 id SERIAL PRIMARY KEY,
187 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
188 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
189 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
190 amount NUMERIC NOT NULL,
191 encumbrance BOOL NOT NULL DEFAULT TRUE,
192 debit_type TEXT NOT NULL,
193 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
194 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
197 CREATE TABLE acq.fund_allocation (
198 id SERIAL PRIMARY KEY,
199 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
200 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
201 amount NUMERIC NOT NULL,
202 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
204 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
206 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
208 CREATE TABLE acq.fund_allocation_percent
210 id SERIAL PRIMARY KEY,
211 funding_source INT NOT NULL REFERENCES acq.funding_source
212 DEFERRABLE INITIALLY DEFERRED,
213 org INT NOT NULL REFERENCES actor.org_unit
214 DEFERRABLE INITIALLY DEFERRED,
216 percent NUMERIC NOT NULL,
217 allocator INTEGER NOT NULL REFERENCES actor.usr
218 DEFERRABLE INITIALLY DEFERRED,
220 create_time TIMESTAMPTZ NOT NULL DEFAULT now(),
221 CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
222 CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
225 -- Trigger function to validate combination of org_unit and fund_code
227 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
228 RETURNS TRIGGER AS $$
243 AND code = NEW.fund_code
249 RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
254 CREATE TRIGGER acq_fund_alloc_percent_val_trig
255 BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
256 FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
258 -- To do: trigger to verify that percentages don't add up to more than 100
260 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
261 RETURNS TRIGGER AS $$
264 total_percent numeric;
272 acq.fund_allocation_percent AS fap
274 fap.funding_source = NEW.funding_source;
276 IF total_percent > 100 THEN
277 RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
285 CREATE TRIGGER acqfap_limit_100_trig
286 AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
287 FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
289 CREATE TABLE acq.picklist (
290 id SERIAL PRIMARY KEY,
291 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
292 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
293 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
294 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
296 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
297 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
298 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
300 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
301 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
302 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
304 CREATE TABLE acq.purchase_order (
305 id SERIAL PRIMARY KEY,
306 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
307 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
308 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
309 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
310 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
311 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
312 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
313 state TEXT NOT NULL DEFAULT 'new',
314 order_date TIMESTAMP WITH TIME ZONE,
317 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
318 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
319 CREATE INDEX po_state_idx ON acq.purchase_order (state);
320 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
321 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
322 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
324 -- The name should default to the id, as text. We can't reference a column
325 -- in a DEFAULT clause, so we use a trigger:
327 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
330 IF NEW.name IS NULL THEN
331 NEW.name := NEW.id::TEXT;
338 CREATE TRIGGER po_name_default_trg
339 BEFORE INSERT OR UPDATE ON acq.purchase_order
340 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
342 -- The order name should be unique for a given ordering agency on a given order date
343 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
344 -- this rule requires a check constraint with a subquery. However you can't have a
345 -- subquery in a CHECK constraint, so we fake it with a trigger.
347 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
353 -- If order_date is not null, then make sure we don't have a collision
354 -- on order_date (truncated to day), org, and name
356 IF NEW.order_date IS NULL THEN
360 -- In the WHERE clause, we compare the order_dates without regard to time of day.
361 -- We use a pair of inequalities instead of comparing truncated dates so that the
362 -- query can do an indexed range scan.
364 SELECT 1 INTO collision
365 FROM acq.purchase_order
367 ordering_agency = NEW.ordering_agency
369 AND order_date >= date_trunc( 'day', NEW.order_date )
370 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
373 IF collision IS NULL THEN
374 -- okay, no collision
377 -- collision; nip it in the bud
378 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
379 NEW.ordering_agency, NEW.order_date, NEW.name;
384 CREATE TRIGGER po_org_name_date_unique_trg
385 BEFORE INSERT OR UPDATE ON acq.purchase_order
386 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
388 CREATE TABLE acq.po_note (
389 id SERIAL PRIMARY KEY,
390 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
391 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
392 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
393 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
394 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
397 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
398 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
399 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
401 CREATE TABLE acq.lineitem (
402 id BIGSERIAL PRIMARY KEY,
403 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
404 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
405 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
406 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
407 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
408 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
409 expected_recv_time TIMESTAMP WITH TIME ZONE,
410 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
411 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
413 eg_bib_id INT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
415 state TEXT NOT NULL DEFAULT 'new',
416 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
418 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
419 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
420 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
421 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
422 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
424 CREATE TABLE acq.lineitem_alert_text (
425 id SERIAL PRIMARY KEY,
428 owning lib INT NOT NULL
429 REFERENCES actor.org_unit(id)
430 DEFERRABLE INITIALLY DEFERRED,
431 CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
434 CREATE TABLE acq.lineitem_note (
435 id SERIAL PRIMARY KEY,
436 lineitem INT NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
437 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
438 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
439 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
440 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
442 alert_text INT REFERENCES acq.lineitem_alert_text(id)
443 DEFERRABLE INITIALLY DEFERRED
445 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
446 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
447 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
449 CREATE TABLE acq.lineitem_detail (
450 id BIGSERIAL PRIMARY KEY,
451 lineitem INT NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
452 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
453 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
454 eg_copy_id BIGINT REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
458 collection_code TEXT,
459 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
460 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
461 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
462 recv_time TIMESTAMP WITH TIME ZONE
465 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
467 CREATE TABLE acq.lineitem_attr_definition (
468 id BIGSERIAL PRIMARY KEY,
470 description TEXT NOT NULL,
471 remove TEXT NOT NULL DEFAULT '',
472 ident BOOL NOT NULL DEFAULT FALSE
475 CREATE TABLE acq.lineitem_marc_attr_definition (
476 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
478 ) INHERITS (acq.lineitem_attr_definition);
480 CREATE TABLE acq.lineitem_provider_attr_definition (
481 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
483 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
484 ) INHERITS (acq.lineitem_attr_definition);
486 CREATE TABLE acq.lineitem_generated_attr_definition (
487 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
489 ) INHERITS (acq.lineitem_attr_definition);
491 CREATE TABLE acq.lineitem_usr_attr_definition (
492 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
493 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
494 ) INHERITS (acq.lineitem_attr_definition);
495 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
497 CREATE TABLE acq.lineitem_local_attr_definition (
498 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
499 ) INHERITS (acq.lineitem_attr_definition);
501 CREATE TABLE acq.lineitem_attr (
502 id BIGSERIAL PRIMARY KEY,
503 definition BIGINT NOT NULL,
504 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
505 attr_type TEXT NOT NULL,
506 attr_name TEXT NOT NULL,
507 attr_value TEXT NOT NULL
510 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
511 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
512 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
518 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
519 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)]');
520 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
521 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
522 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
523 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
524 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
525 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
526 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
527 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
528 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
530 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
533 CREATE TABLE acq.distribution_formula (
534 id SERIAL PRIMARY KEY,
536 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
538 skip_count INT NOT NULL DEFAULT 0,
539 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
542 CREATE TABLE acq.distribution_formula_entry (
543 id SERIAL PRIMARY KEY,
544 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
546 DEFERRABLE INITIALLY DEFERRED,
547 position INTEGER NOT NULL,
548 item_count INTEGER NOT NULL,
549 owning_lib INTEGER REFERENCES actor.org_unit(id)
550 DEFERRABLE INITIALLY DEFERRED,
551 location INTEGER REFERENCES asset.copy_location(id),
552 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
553 CONSTRAINT acqdfe_must_be_somewhere
554 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
557 CREATE TABLE acq.distribution_formula_application (
558 id BIGSERIAL PRIMARY KEY,
559 creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
560 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
562 REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
563 lineitem INT NOT NULL
564 REFERENCES acq.lineitem(id) DEFERRABLE INITIALLY DEFERRED
567 CREATE INDEX acqdfa_df_idx
568 ON acq.distribution_formula_application(formula);
569 CREATE INDEX acqdfa_li_idx
570 ON acq.distribution_formula_application(lineitem);
571 CREATE INDEX acqdfa_creator_idx
572 ON acq.distribution_formula_application(creator);
574 CREATE TABLE acq.fund_tag (
575 id SERIAL PRIMARY KEY,
577 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
579 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
582 CREATE TABLE acq.fund_tag_map (
583 id SERIAL PRIMARY KEY,
584 fund INTEGER NOT NULL REFERENCES acq.fund(id)
585 DEFERRABLE INITIALLY DEFERRED,
586 tag INTEGER REFERENCES acq.fund_tag(id)
588 DEFERRABLE INITIALLY DEFERRED,
589 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
592 CREATE TABLE acq.fund_transfer (
593 id SERIAL PRIMARY KEY,
594 src_fund INT NOT NULL REFERENCES acq.fund( id )
595 DEFERRABLE INITIALLY DEFERRED,
596 src_amount NUMERIC NOT NULL,
597 dest_fund INT NOT NULL REFERENCES acq.fund( id )
598 DEFERRABLE INITIALLY DEFERRED,
599 dest_amount NUMERIC NOT NULL,
600 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
601 transfer_user INT NOT NULL REFERENCES actor.usr( id )
602 DEFERRABLE INITIALLY DEFERRED,
604 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
605 DEFERRABLE INITIALLY DEFERRED
608 CREATE INDEX acqftr_usr_idx
609 ON acq.fund_transfer( transfer_user );
611 COMMENT ON TABLE acq.fund_transfer IS $$
613 * Copyright (C) 2009 Georgia Public Library Service
614 * Scott McKellar <scott@esilibrary.com>
618 * Each row represents the transfer of money from a source fund
619 * to a destination fund. There should be corresponding entries
620 * in acq.fund_allocation. The purpose of acq.fund_transfer is
621 * to record how much money moved from which fund to which other
624 * The presence of two amount fields, rather than one, reflects
625 * the possibility that the two funds are denominated in different
626 * currencies. If they use the same currency type, the two
627 * amounts should be the same.
631 * This program is free software; you can redistribute it and/or
632 * modify it under the terms of the GNU General Public License
633 * as published by the Free Software Foundation; either version 2
634 * of the License, or (at your option) any later version.
636 * This program is distributed in the hope that it will be useful,
637 * but WITHOUT ANY WARRANTY; without even the implied warranty of
638 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
639 * GNU General Public License for more details.
643 CREATE TABLE acq.fiscal_calendar (
644 id SERIAL PRIMARY KEY,
648 -- Create a default calendar (though we don't specify its contents).
649 -- Create a foreign key in actor.org_unit, initially pointing to
650 -- the default calendar.
652 INSERT INTO acq.fiscal_calendar (
659 ALTER TABLE actor.org_unit ADD FOREIGN KEY
660 (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
661 DEFERRABLE INITIALLY DEFERRED;
663 CREATE TABLE acq.fiscal_year (
664 id SERIAL PRIMARY KEY,
665 calendar INT NOT NULL
666 REFERENCES acq.fiscal_calendar
668 DEFERRABLE INITIALLY DEFERRED,
670 year_begin TIMESTAMPTZ NOT NULL,
671 year_end TIMESTAMPTZ NOT NULL,
672 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
673 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
676 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
677 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
678 in_dir TEXT -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
679 ) INHERITS (config.remote_account);
681 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
682 ALTER TABLE acq.edi_account ADD CONSTRAINT acq_edi_account_id_unique UNIQUE (id);
684 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
685 -- the table, assigning ids programmatically instead of using a sequence.
686 CREATE TABLE acq.debit_attribution (
687 id INT NOT NULL PRIMARY KEY,
688 fund_debit INT NOT NULL
689 REFERENCES acq.fund_debit
690 DEFERRABLE INITIALLY DEFERRED,
691 debit_amount NUMERIC NOT NULL,
692 funding_source_credit INT REFERENCES acq.funding_source_credit
693 DEFERRABLE INITIALLY DEFERRED,
694 credit_amount NUMERIC
697 CREATE INDEX acq_attribution_debit_idx
698 ON acq.debit_attribution( fund_debit );
700 CREATE INDEX acq_attribution_credit_idx
701 ON acq.debit_attribution( funding_source_credit );
705 CREATE TABLE acq.user_request_type (
706 id SERIAL PRIMARY KEY,
707 label TEXT NOT NULL UNIQUE -- i18n-ize
710 INSERT INTO acq.user_request_type (id,label) VALUES (1, oils_i18n_gettext('1', 'Books', 'aurt', 'label'));
711 INSERT INTO acq.user_request_type (id,label) VALUES (2, oils_i18n_gettext('2', 'Journal/Magazine & Newspaper Articles', 'aurt', 'label'));
712 INSERT INTO acq.user_request_type (id,label) VALUES (3, oils_i18n_gettext('3', 'Audiobooks', 'aurt', 'label'));
713 INSERT INTO acq.user_request_type (id,label) VALUES (4, oils_i18n_gettext('4', 'Music', 'aurt', 'label'));
714 INSERT INTO acq.user_request_type (id,label) VALUES (5, oils_i18n_gettext('5', 'DVDs', 'aurt', 'label'));
716 SELECT SETVAL('acq.user_request_type_id_seq'::TEXT, 6);
718 CREATE TABLE acq.user_request (
719 id SERIAL PRIMARY KEY,
720 usr INT NOT NULL REFERENCES actor.usr (id), -- requesting user
721 hold BOOL NOT NULL DEFAULT TRUE,
723 pickup_lib INT NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
724 holdable_formats TEXT, -- nullable, for use in hold creation
726 email_notify BOOL NOT NULL DEFAULT TRUE,
727 lineitem INT REFERENCES acq.lineitem (id) ON DELETE CASCADE,
728 eg_bib BIGINT REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
729 request_date TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
730 need_before TIMESTAMPTZ, -- don't create holds after this
733 request_type INT NOT NULL REFERENCES acq.user_request_type (id),
750 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
751 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
754 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
757 SELECT COUNT(*) INTO counter
758 FROM oils_xpath_table(
762 '//*[@tag="' || tag || '"]',
764 ) as t(i int,c text);
766 FOR i IN 1 .. counter LOOP
769 FROM ( SELECT id,i,t,v
770 FROM oils_xpath_table(
774 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
775 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
777 ) as t(id int,t text,v text)
788 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
789 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
793 lida acq.flat_lineitem_detail%ROWTYPE;
795 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
796 IF NOT FOUND THEN RETURN; END IF;
798 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
799 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
806 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
807 JOIN acq.provider_holding_subfield_map a USING (subfield)
808 WHERE a.provider = prov_i
817 -- select * from acq.extract_provider_holding_data(699);
819 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
820 SELECT public.extract_marc_field('acq.lineitem', $1, $2, $3);
824 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
825 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
828 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
829 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
833 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
836 Suggested vendor fields:
844 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $$
852 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
854 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
856 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
857 IF (atype = 'lineitem_provider_attr_definition') THEN
858 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
859 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
862 IF (atype = 'lineitem_provider_attr_definition') THEN
863 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
864 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
865 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
866 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
867 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
870 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
872 IF (value IS NOT NULL AND value <> '') THEN
873 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
874 VALUES (NEW.id, adef.id, atype, adef.code, value);
885 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
887 IF TG_OP = 'UPDATE' THEN
888 DELETE FROM acq.lineitem_attr
889 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
892 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
898 CREATE TRIGGER cleanup_lineitem_trigger
899 BEFORE UPDATE OR DELETE ON acq.lineitem
900 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
902 CREATE TRIGGER ingest_lineitem_trigger
903 AFTER INSERT OR UPDATE ON acq.lineitem
904 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
906 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
910 IF from_ex = to_ex THEN
914 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
919 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
930 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
931 SELECT $3 * acq.exchange_ratio($1, $2);
934 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
936 Examine the acq.fiscal_year table, comparing successive years.
937 Report any inconsistencies, i.e. years that overlap, have gaps
938 between them, or are out of sequence.
940 RETURNS SETOF RECORD AS $$
964 ELSIF curr_year.calendar = prev_year.calendar THEN
965 IF curr_year.year_begin > prev_year.year_end THEN
966 -- This ugly kludge works around the fact that older
967 -- versions of PostgreSQL don't support RETURN QUERY SELECT
968 FOR return_rec IN SELECT
971 'Gap between fiscal years'::TEXT
973 RETURN NEXT return_rec;
975 ELSIF curr_year.year_begin < prev_year.year_end THEN
976 FOR return_rec IN SELECT
979 'Overlapping fiscal years'::TEXT
981 RETURN NEXT return_rec;
983 ELSIF curr_year.year < prev_year.year THEN
984 FOR return_rec IN SELECT
987 'Fiscal years out of order'::TEXT
989 RETURN NEXT return_rec;
994 prev_year := curr_year;
1001 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1003 old_amount IN NUMERIC, -- in currency of old fund
1005 new_amount IN NUMERIC, -- in currency of new fund
1007 xfer_note IN TEXT -- to be recorded in acq.fund_transfer
1008 -- ,funding_source_in IN INT -- if user wants to specify a funding source (see notes)
1009 ) RETURNS VOID AS $$
1010 /* -------------------------------------------------------------------------------
1012 Function to transfer money from one fund to another.
1014 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1015 negative amount for the old (losing) fund and a positive amount for the new
1016 (gaining) fund. In some cases there may be more than one such pair of entries
1017 in order to pull the money from different funding sources, or more specifically
1018 from different funding source credits. For each such pair there is also an
1019 entry in acq.fund_transfer.
1021 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1022 choose a funding source for the transferred money to come from. This choice
1023 must meet two constraints, so far as possible:
1025 1. The amount transferred from a given funding source must not exceed the
1026 amount allocated to the old fund by the funding source. To that end we
1027 compare the amount being transferred to the amount allocated.
1029 2. We shouldn't transfer money that has already been spent or encumbered, as
1030 defined by the funding attribution process. We attribute expenses to the
1031 oldest funding source credits first. In order to avoid transferring that
1032 attributed money, we reverse the priority, transferring from the newest funding
1033 source credits first. There can be no guarantee that this approach will
1034 avoid overcommitting a fund, but no other approach can do any better.
1036 In this context the age of a funding source credit is defined by the
1037 deadline_date for credits with deadline_dates, and by the effective_date for
1038 credits without deadline_dates, with the proviso that credits with deadline_dates
1039 are all considered "older" than those without.
1043 In the signature for this function, there is one last parameter commented out,
1044 named "funding_source_in". Correspondingly, the WHERE clause for the query
1045 driving the main loop has an OR clause commented out, which references the
1046 funding_source_in parameter.
1048 If these lines are uncommented, this function will allow the user optionally to
1049 restrict a fund transfer to a specified funding source. If the source
1050 parameter is left NULL, then there will be no such restriction.
1052 ------------------------------------------------------------------------------- */
1054 same_currency BOOLEAN;
1055 currency_ratio NUMERIC;
1056 old_fund_currency TEXT;
1057 old_remaining NUMERIC; -- in currency of old fund
1058 new_fund_currency TEXT;
1059 new_fund_active BOOLEAN;
1060 new_remaining NUMERIC; -- in currency of new fund
1061 curr_old_amt NUMERIC; -- in currency of old fund
1062 curr_new_amt NUMERIC; -- in currency of new fund
1063 source_addition NUMERIC; -- in currency of funding source
1064 source_deduction NUMERIC; -- in currency of funding source
1065 orig_allocated_amt NUMERIC; -- in currency of funding source
1066 allocated_amt NUMERIC; -- in currency of fund
1072 IF old_fund IS NULL THEN
1073 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1076 IF old_amount IS NULL THEN
1077 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1080 -- The new fund and its amount must be both NULL or both not NULL.
1082 IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1083 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1086 IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1087 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1090 IF user_id IS NULL THEN
1091 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1094 -- Initialize the amounts to be transferred, each denominated
1095 -- in the currency of its respective fund. They will be
1096 -- reduced on each iteration of the loop.
1098 old_remaining := old_amount;
1099 new_remaining := new_amount;
1101 -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1102 -- old_amount, old_fund, new_amount, new_fund;
1104 -- Get the currency types of the old and new funds.
1115 IF old_fund_currency IS NULL THEN
1116 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1119 IF new_fund IS NOT NULL THEN
1131 IF new_fund_currency IS NULL THEN
1132 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1133 ELSIF NOT new_fund_active THEN
1135 -- No point in putting money into a fund from whence you can't spend it
1137 RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1140 IF new_amount = old_amount THEN
1141 same_currency := true;
1142 currency_ratio := 1;
1145 -- We'll have to translate currency between funds. We presume that
1146 -- the calling code has already applied an appropriate exchange rate,
1147 -- so we'll apply the same conversion to each sub-transfer.
1149 same_currency := false;
1150 currency_ratio := new_amount / old_amount;
1154 -- Identify the funding source(s) from which we want to transfer the money.
1155 -- The principle is that we want to transfer the newest money first, because
1156 -- we spend the oldest money first. The priority for spending is defined
1157 -- by a sort of the view acq.ordered_funding_source_credit.
1162 ofsc.funding_source,
1164 ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1168 acq.ordered_funding_source_credit AS ofsc,
1169 acq.funding_source fs
1171 ofsc.funding_source = fs.id
1172 and ofsc.funding_source IN
1174 SELECT funding_source
1175 FROM acq.fund_allocation
1176 WHERE fund = old_fund
1180 -- ofsc.funding_source = funding_source_in
1181 -- OR funding_source_in IS NULL
1184 ofsc.sort_priority desc,
1185 ofsc.sort_date desc,
1189 -- Determine how much money the old fund got from this funding source,
1190 -- denominated in the currency types of the source and of the fund.
1191 -- This result may reflect transfers from previous iterations.
1194 COALESCE( sum( amount ), 0 ),
1195 COALESCE( sum( amount )
1196 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1198 orig_allocated_amt, -- in currency of the source
1199 allocated_amt -- in currency of the old fund
1204 and funding_source = source.funding_source;
1206 -- Determine how much to transfer from this credit, in the currency
1207 -- of the fund. Begin with the amount remaining to be attributed:
1209 curr_old_amt := old_remaining;
1211 -- Can't attribute more than was allocated from the fund:
1213 IF curr_old_amt > allocated_amt THEN
1214 curr_old_amt := allocated_amt;
1217 -- Can't attribute more than the amount of the current credit:
1219 IF curr_old_amt > source.converted_amt THEN
1220 curr_old_amt := source.converted_amt;
1223 curr_old_amt := trunc( curr_old_amt, 2 );
1225 old_remaining := old_remaining - curr_old_amt;
1227 -- Determine the amount to be deducted, if any,
1228 -- from the old allocation.
1230 IF old_remaining > 0 THEN
1232 -- In this case we're using the whole allocation, so use that
1233 -- amount directly instead of applying a currency translation
1234 -- and thereby inviting round-off errors.
1236 source_deduction := - orig_allocated_amt;
1238 source_deduction := trunc(
1239 ( - curr_old_amt ) *
1240 acq.exchange_ratio( old_fund_currency, source.currency_type ),
1244 IF source_deduction <> 0 THEN
1246 -- Insert negative allocation for old fund in fund_allocation,
1247 -- converted into the currency of the funding source
1249 INSERT INTO acq.fund_allocation (
1256 source.funding_source,
1260 'Transfer to fund ' || new_fund
1264 IF new_fund IS NOT NULL THEN
1266 -- Determine how much to add to the new fund, in
1267 -- its currency, and how much remains to be added:
1269 IF same_currency THEN
1270 curr_new_amt := curr_old_amt;
1272 IF old_remaining = 0 THEN
1274 -- This is the last iteration, so nothing should be left
1276 curr_new_amt := new_remaining;
1279 curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1280 new_remaining := new_remaining - curr_new_amt;
1284 -- Determine how much to add, if any,
1285 -- to the new fund's allocation.
1287 IF old_remaining > 0 THEN
1289 -- In this case we're using the whole allocation, so use that amount
1290 -- amount directly instead of applying a currency translation and
1291 -- thereby inviting round-off errors.
1293 source_addition := orig_allocated_amt;
1294 ELSIF source.currency_type = old_fund_currency THEN
1296 -- In this case we don't need a round trip currency translation,
1297 -- thereby inviting round-off errors:
1299 source_addition := curr_old_amt;
1301 source_addition := trunc(
1303 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1307 IF source_addition <> 0 THEN
1309 -- Insert positive allocation for new fund in fund_allocation,
1310 -- converted to the currency of the founding source
1312 INSERT INTO acq.fund_allocation (
1319 source.funding_source,
1323 'Transfer from fund ' || old_fund
1328 IF trunc( curr_old_amt, 2 ) <> 0
1329 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1331 -- Insert row in fund_transfer, using amounts in the currency of the funds
1333 INSERT INTO acq.fund_transfer (
1340 funding_source_credit
1343 trunc( curr_old_amt, 2 ),
1345 trunc( curr_new_amt, 2 ),
1352 if old_remaining <= 0 THEN
1353 EXIT; -- Nothing more to be transferred
1357 $$ LANGUAGE plpgsql;
1359 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1361 Function to attribute expenditures and encumbrances to funding source credits,
1362 and thereby to funding sources.
1364 Read the debits in chonological order, attributing each one to one or
1365 more funding source credits. Constraints:
1367 1. Don't attribute more to a credit than the amount of the credit.
1369 2. For a given fund, don't attribute more to a funding source than the
1370 source has allocated to that fund.
1372 3. Attribute debits to credits with deadlines before attributing them to
1373 credits without deadlines. Otherwise attribute to the earliest credits
1374 first, based on the deadline date when present, or on the effective date
1375 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
1376 This ordering is defined by an ORDER BY clause on the view
1377 acq.ordered_funding_source_credit.
1379 Start by truncating the table acq.debit_attribution. Then insert a row
1380 into that table for each attribution. If a debit cannot be fully
1381 attributed, insert a row for the unattributable balance, with the
1382 funding_source_credit and credit_amount columns NULL.
1385 curr_fund_source_bal RECORD;
1386 seqno INT; -- sequence num for credits applicable to a fund
1387 fund_credit RECORD; -- current row in temp t_fund_credit table
1388 fc RECORD; -- used for loading t_fund_credit table
1389 sc RECORD; -- used for loading t_fund_credit table
1391 -- Used exclusively in the main loop:
1393 deb RECORD; -- current row from acq.fund_debit table
1394 curr_credit_bal RECORD; -- current row from temp t_credit table
1395 debit_balance NUMERIC; -- amount left to attribute for current debit
1396 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
1397 attr_amount NUMERIC; -- amount being attributed, in currency of debit
1398 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
1399 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
1400 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
1401 attrib_count INT; -- populates id of acq.debit_attribution
1404 -- Load a temporary table. For each combination of fund and funding source,
1405 -- load an entry with the total amount allocated to that fund by that source.
1406 -- This sum may reflect transfers as well as original allocations. We will
1407 -- reduce this balance whenever we attribute debits to it.
1409 CREATE TEMP TABLE t_fund_source_bal
1413 funding_source AS source,
1414 sum( amount ) AS balance
1423 CREATE INDEX t_fund_source_bal_idx
1424 ON t_fund_source_bal( fund, source );
1425 -------------------------------------------------------------------------------
1427 -- Load another temporary table. For each fund, load zero or more
1428 -- funding source credits from which that fund can get money.
1430 CREATE TEMP TABLE t_fund_credit (
1437 SELECT DISTINCT fund
1438 FROM acq.fund_allocation
1440 LOOP -- Loop over the funds
1446 acq.ordered_funding_source_credit AS ofsc
1448 ofsc.funding_source IN
1450 SELECT funding_source
1451 FROM acq.fund_allocation
1452 WHERE fund = fc.fund
1458 LOOP -- Add each credit to the list
1459 INSERT INTO t_fund_credit (
1468 --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1470 END LOOP; -- Loop over credits for a given fund
1471 END LOOP; -- Loop over funds
1473 CREATE INDEX t_fund_credit_idx
1474 ON t_fund_credit( fund, seq );
1475 -------------------------------------------------------------------------------
1477 -- Load yet another temporary table. This one is a list of funding source
1478 -- credits, with their balances. We shall reduce those balances as we
1479 -- attribute debits to them.
1481 CREATE TEMP TABLE t_credit
1485 fsc.funding_source AS source,
1486 fsc.amount AS balance,
1487 fs.currency_type AS currency_type
1489 acq.funding_source_credit AS fsc,
1490 acq.funding_source fs
1492 fsc.funding_source = fs.id
1495 CREATE INDEX t_credit_idx
1496 ON t_credit( credit );
1498 -------------------------------------------------------------------------------
1500 -- Now that we have loaded the lookup tables: loop through the debits,
1501 -- attributing each one to one or more funding source credits.
1503 truncate table acq.debit_attribution;
1521 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1523 debit_balance := deb.amount;
1525 -- Loop over the funding source credits that are eligible
1526 -- to pay for this debit
1538 --RAISE NOTICE ' Examining credit %', fund_credit.credit;
1540 -- Look up the balance for this credit. If it's zero, then
1541 -- it's not useful, so treat it as if you didn't find it.
1542 -- (Actually there shouldn't be any zero balances in the table,
1543 -- but we check just to make sure.)
1546 INTO curr_credit_bal
1549 credit = fund_credit.credit
1552 IF curr_credit_bal IS NULL THEN
1554 -- This credit is exhausted; try the next one.
1560 -- At this point we have an applicable credit with some money left.
1561 -- Now see if the relevant funding_source has any money left.
1563 -- Look up the balance of the allocation for this combination of
1564 -- fund and source. If you find such an entry, but it has a zero
1565 -- balance, then it's not useful, so treat it as unfound.
1566 -- (Actually there shouldn't be any zero balances in the table,
1567 -- but we check just to make sure.)
1570 INTO curr_fund_source_bal
1571 FROM t_fund_source_bal
1574 AND source = curr_credit_bal.source
1577 IF curr_fund_source_bal IS NULL THEN
1579 -- This fund/source doesn't exist or is already exhausted,
1580 -- so we can't use this credit. Go on to the next one.
1585 -- Convert the available balances to the currency of the fund
1587 conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1588 curr_credit_bal.currency_type, deb.currency_type );
1589 conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1590 curr_credit_bal.currency_type, deb.currency_type );
1592 -- Determine how much we can attribute to this credit: the minimum
1593 -- of the debit amount, the fund/source balance, and the
1596 --RAISE NOTICE ' deb bal %', debit_balance;
1597 --RAISE NOTICE ' source % balance %', curr_credit_bal.source, conv_alloc_balance;
1598 --RAISE NOTICE ' credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1600 conv_attr_amount := NULL;
1601 attr_amount := debit_balance;
1603 IF attr_amount > conv_alloc_balance THEN
1604 attr_amount := conv_alloc_balance;
1605 conv_attr_amount := curr_fund_source_bal.balance;
1607 IF attr_amount > conv_cred_balance THEN
1608 attr_amount := conv_cred_balance;
1609 conv_attr_amount := curr_credit_bal.balance;
1612 -- If we're attributing all of one of the balances, then that's how
1613 -- much we will deduct from the balances, and we already captured
1614 -- that amount above. Otherwise we must convert the amount of the
1615 -- attribution from the currency of the fund back to the currency of
1616 -- the funding source.
1618 IF conv_attr_amount IS NULL THEN
1619 conv_attr_amount := attr_amount * acq.exchange_ratio(
1620 deb.currency_type, curr_credit_bal.currency_type );
1623 -- Insert a row to record the attribution
1625 attrib_count := attrib_count + 1;
1626 INSERT INTO acq.debit_attribution (
1630 funding_source_credit,
1636 curr_credit_bal.credit,
1640 -- Subtract the attributed amount from the various balances
1642 debit_balance := debit_balance - attr_amount;
1643 curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1645 IF curr_fund_source_bal.balance <= 0 THEN
1647 -- This allocation is exhausted. Delete it so
1648 -- that we don't waste time looking at it again.
1650 DELETE FROM t_fund_source_bal
1652 fund = curr_fund_source_bal.fund
1653 AND source = curr_fund_source_bal.source;
1655 UPDATE t_fund_source_bal
1656 SET balance = balance - conv_attr_amount
1658 fund = curr_fund_source_bal.fund
1659 AND source = curr_fund_source_bal.source;
1662 IF curr_credit_bal.balance <= 0 THEN
1664 -- This funding source credit is exhausted. Delete it
1665 -- so that we don't waste time looking at it again.
1667 --DELETE FROM t_credit
1669 -- credit = curr_credit_bal.credit;
1671 DELETE FROM t_fund_credit
1673 credit = curr_credit_bal.credit;
1676 SET balance = curr_credit_bal.balance
1678 credit = curr_credit_bal.credit;
1681 -- Are we done with this debit yet?
1683 IF debit_balance <= 0 THEN
1684 EXIT; -- We've fully attributed this debit; stop looking at credits.
1686 END LOOP; -- End loop over credits
1688 IF debit_balance <> 0 THEN
1690 -- We weren't able to attribute this debit, or at least not
1691 -- all of it. Insert a row for the unattributed balance.
1693 attrib_count := attrib_count + 1;
1694 INSERT INTO acq.debit_attribution (
1698 funding_source_credit,
1708 END LOOP; -- End of loop over debits
1710 $$ LANGUAGE 'plpgsql';
1712 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit(
1716 ) RETURNS VOID AS $$
1727 IF old_year IS NULL THEN
1728 RAISE EXCEPTION 'Input year argument is NULL';
1729 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1730 RAISE EXCEPTION 'Input year is out of range';
1733 IF user_id IS NULL THEN
1734 RAISE EXCEPTION 'Input user id argument is NULL';
1737 IF org_unit_id IS NULL THEN
1738 RAISE EXCEPTION 'Org unit id argument is NULL';
1740 SELECT TRUE INTO org_found
1742 WHERE id = org_unit_id;
1744 IF org_found IS NULL THEN
1745 RAISE EXCEPTION 'Org unit id is invalid';
1749 -- Loop over the applicable funds
1751 FOR old_fund in SELECT * FROM acq.fund
1755 AND org = org_unit_id
1758 INSERT INTO acq.fund (
1770 old_fund.currency_type,
1775 RETURNING id INTO new_id;
1777 WHEN unique_violation THEN
1778 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
1781 --RAISE NOTICE 'Propagating fund % to fund %',
1782 -- old_fund.code, new_id;
1785 $$ LANGUAGE plpgsql;
1787 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1791 ) RETURNS VOID AS $$
1802 IF old_year IS NULL THEN
1803 RAISE EXCEPTION 'Input year argument is NULL';
1804 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1805 RAISE EXCEPTION 'Input year is out of range';
1808 IF user_id IS NULL THEN
1809 RAISE EXCEPTION 'Input user id argument is NULL';
1812 IF org_unit_id IS NULL THEN
1813 RAISE EXCEPTION 'Org unit id argument is NULL';
1815 SELECT TRUE INTO org_found
1817 WHERE id = org_unit_id;
1819 IF org_found IS NULL THEN
1820 RAISE EXCEPTION 'Org unit id is invalid';
1824 -- Loop over the applicable funds
1826 FOR old_fund in SELECT * FROM acq.fund
1831 SELECT id FROM actor.org_unit_descendants( org_unit_id )
1835 INSERT INTO acq.fund (
1847 old_fund.currency_type,
1852 RETURNING id INTO new_id;
1854 WHEN unique_violation THEN
1855 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
1858 --RAISE NOTICE 'Propagating fund % to fund %',
1859 -- old_fund.code, new_id;
1862 $$ LANGUAGE plpgsql;
1864 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit(
1868 ) RETURNS VOID AS $$
1872 new_year INT := old_year + 1;
1874 xfer_amount NUMERIC;
1883 IF old_year IS NULL THEN
1884 RAISE EXCEPTION 'Input year argument is NULL';
1885 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1886 RAISE EXCEPTION 'Input year is out of range';
1889 IF user_id IS NULL THEN
1890 RAISE EXCEPTION 'Input user id argument is NULL';
1893 IF org_unit_id IS NULL THEN
1894 RAISE EXCEPTION 'Org unit id argument is NULL';
1897 -- Validate the org unit
1902 WHERE id = org_unit_id;
1904 IF org_found IS NULL THEN
1905 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
1909 -- Loop over the propagable funds to identify the details
1910 -- from the old fund plus the id of the new one, if it exists.
1914 oldf.id AS old_fund,
1920 newf.id AS new_fund_id
1923 LEFT JOIN acq.fund AS newf
1924 ON ( oldf.code = newf.code )
1926 oldf.org = org_unit_id
1927 and oldf.year = old_year
1929 and newf.year = new_year
1931 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
1933 IF roll_fund.new_fund_id IS NULL THEN
1935 -- The old fund hasn't been propagated yet. Propagate it now.
1937 INSERT INTO acq.fund (
1949 roll_fund.currency_type,
1954 RETURNING id INTO new_fund;
1956 new_fund = roll_fund.new_fund_id;
1959 -- Determine the amount to transfer
1963 FROM acq.fund_spent_balance
1964 WHERE fund = roll_fund.old_fund;
1966 IF xfer_amount <> 0 THEN
1967 IF roll_fund.rollover THEN
1969 -- Transfer balance from old fund to new
1971 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
1973 PERFORM acq.transfer_fund(
1983 -- Transfer balance from old fund to the void
1985 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
1987 PERFORM acq.transfer_fund(
1998 IF roll_fund.rollover THEN
2000 -- Move any lineitems from the old fund to the new one
2001 -- where the associated debit is an encumbrance.
2003 -- Any other tables tying expenditure details to funds should
2004 -- receive similar treatment. At this writing there are none.
2006 UPDATE acq.lineitem_detail
2009 fund = roll_fund.old_fund -- this condition may be redundant
2015 fund = roll_fund.old_fund
2019 -- Move encumbrance debits from the old fund to the new fund
2021 UPDATE acq.fund_debit
2024 fund = roll_fund.old_fund
2028 -- Mark old fund as inactive, now that we've closed it
2032 WHERE id = roll_fund.old_fund;
2035 $$ LANGUAGE plpgsql;
2037 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2041 ) RETURNS VOID AS $$
2045 new_year INT := old_year + 1;
2047 xfer_amount NUMERIC;
2056 IF old_year IS NULL THEN
2057 RAISE EXCEPTION 'Input year argument is NULL';
2058 ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2059 RAISE EXCEPTION 'Input year is out of range';
2062 IF user_id IS NULL THEN
2063 RAISE EXCEPTION 'Input user id argument is NULL';
2066 IF org_unit_id IS NULL THEN
2067 RAISE EXCEPTION 'Org unit id argument is NULL';
2070 -- Validate the org unit
2075 WHERE id = org_unit_id;
2077 IF org_found IS NULL THEN
2078 RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2082 -- Loop over the propagable funds to identify the details
2083 -- from the old fund plus the id of the new one, if it exists.
2087 oldf.id AS old_fund,
2093 newf.id AS new_fund_id
2096 LEFT JOIN acq.fund AS newf
2097 ON ( oldf.code = newf.code )
2099 oldf.year = old_year
2101 AND newf.year = new_year
2103 SELECT id FROM actor.org_unit_descendants( org_unit_id )
2106 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2108 IF roll_fund.new_fund_id IS NULL THEN
2110 -- The old fund hasn't been propagated yet. Propagate it now.
2112 INSERT INTO acq.fund (
2124 roll_fund.currency_type,
2129 RETURNING id INTO new_fund;
2131 new_fund = roll_fund.new_fund_id;
2134 -- Determine the amount to transfer
2138 FROM acq.fund_spent_balance
2139 WHERE fund = roll_fund.old_fund;
2141 IF xfer_amount <> 0 THEN
2142 IF roll_fund.rollover THEN
2144 -- Transfer balance from old fund to new
2146 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2148 PERFORM acq.transfer_fund(
2158 -- Transfer balance from old fund to the void
2160 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2162 PERFORM acq.transfer_fund(
2173 IF roll_fund.rollover THEN
2175 -- Move any lineitems from the old fund to the new one
2176 -- where the associated debit is an encumbrance.
2178 -- Any other tables tying expenditure details to funds should
2179 -- receive similar treatment. At this writing there are none.
2181 UPDATE acq.lineitem_detail
2184 fund = roll_fund.old_fund -- this condition may be redundant
2190 fund = roll_fund.old_fund
2194 -- Move encumbrance debits from the old fund to the new fund
2196 UPDATE acq.fund_debit
2199 fund = roll_fund.old_fund
2203 -- Mark old fund as inactive, now that we've closed it
2207 WHERE id = roll_fund.old_fund;
2210 $$ LANGUAGE plpgsql;
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 fund_debit.encumbrance AS encumbrance,
2242 SUM( COALESCE( fund_debit.amount, 0 ) ) AS amount
2243 FROM acq.fund AS fund
2244 LEFT JOIN acq.fund_debit AS fund_debit
2245 ON ( fund.id = fund_debit.fund )
2248 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2250 SUM(amount) AS amount
2251 FROM acq.fund_debit_total
2252 WHERE encumbrance IS TRUE
2255 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2257 SUM(amount) AS amount
2258 FROM acq.fund_debit_total
2259 WHERE encumbrance IS FALSE
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);