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 CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
42 CONSTRAINT code_once_per_owner UNIQUE (code, owner)
45 CREATE TABLE acq.provider_holding_subfield_map (
46 id SERIAL PRIMARY KEY,
47 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
48 name TEXT NOT NULL, -- barcode, price, etc
49 subfield TEXT NOT NULL,
50 CONSTRAINT name_once_per_provider UNIQUE (provider,name)
53 CREATE TABLE acq.provider_address (
54 id SERIAL PRIMARY KEY,
55 valid BOOL NOT NULL DEFAULT TRUE,
57 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
58 street1 TEXT NOT NULL,
63 country TEXT NOT NULL,
64 post_code TEXT NOT NULL
67 CREATE TABLE acq.provider_contact (
68 id SERIAL PRIMARY KEY,
69 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
71 role TEXT, -- free-form.. e.g. "our sales guy"
76 CREATE TABLE acq.provider_contact_address (
77 id SERIAL PRIMARY KEY,
78 valid BOOL NOT NULL DEFAULT TRUE,
80 contact INT NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
81 street1 TEXT NOT NULL,
86 country TEXT NOT NULL,
87 post_code TEXT NOT NULL
91 CREATE TABLE acq.funding_source (
92 id SERIAL PRIMARY KEY,
94 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
95 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
97 CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
100 CREATE TABLE acq.funding_source_credit (
101 id SERIAL PRIMARY KEY,
102 funding_source INT NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
103 amount NUMERIC NOT NULL,
105 deadline_date TIMESTAMPTZ,
106 effective_date TIMESTAMPTZ NOT NULL default now()
109 CREATE VIEW acq.ordered_funding_source_credit AS
111 CASE WHEN deadline_date IS NULL THEN
115 END AS sort_priority,
116 CASE WHEN deadline_date IS NULL THEN
126 acq.funding_source_credit;
128 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
130 * Copyright (C) 2009 Georgia Public Library Service
131 * Scott McKellar <scott@gmail.com>
133 * The acq.ordered_funding_source_credit view is a prioritized
134 * ordering of funding source credits. When ordered by the first
135 * three columns, this view defines the order in which the various
136 * credits are to be tapped for spending, subject to the allocations
137 * in the acq.fund_allocation table.
139 * The first column reflects the principle that we should spend
140 * money with deadlines before spending money without deadlines.
142 * The second column reflects the principle that we should spend the
143 * oldest money first. For money with deadlines, that means that we
144 * spend first from the credit with the earliest deadline. For
145 * money without deadlines, we spend first from the credit with the
146 * earliest effective date.
148 * The third column is a tie breaker to ensure a consistent
153 * This program is free software; you can redistribute it and/or
154 * modify it under the terms of the GNU General Public License
155 * as published by the Free Software Foundation; either version 2
156 * of the License, or (at your option) any later version.
158 * This program is distributed in the hope that it will be useful,
159 * but WITHOUT ANY WARRANTY; without even the implied warranty of
160 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
161 * GNU General Public License for more details.
165 CREATE TABLE acq.fund (
166 id SERIAL PRIMARY KEY,
167 org INT NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
169 year INT NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
170 currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
172 rollover BOOL NOT NULL DEFAULT FALSE,
173 propagate BOOL NOT NULL DEFAULT TRUE,
174 active BOOL NOT NULL DEFAULT TRUE,
175 CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
176 CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
177 CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
180 CREATE TABLE acq.fund_debit (
181 id SERIAL PRIMARY KEY,
182 fund INT NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
183 origin_amount NUMERIC NOT NULL, -- pre-exchange-rate amount
184 origin_currency_type TEXT NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
185 amount NUMERIC NOT NULL,
186 encumbrance BOOL NOT NULL DEFAULT TRUE,
187 debit_type TEXT NOT NULL,
188 xfer_destination INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
189 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
192 CREATE TABLE acq.fund_allocation (
193 id SERIAL PRIMARY KEY,
194 funding_source INT NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
195 fund INT NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
196 amount NUMERIC NOT NULL,
197 allocator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
199 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
201 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
203 CREATE TABLE acq.picklist (
204 id SERIAL PRIMARY KEY,
205 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
206 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
207 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
208 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
210 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
211 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
212 CONSTRAINT name_once_per_owner UNIQUE (name,owner)
214 CREATE INDEX acq_picklist_owner_idx ON acq.picklist ( owner );
215 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
216 CREATE INDEX acq_picklist_editor_idx ON acq.picklist ( editor );
218 CREATE TABLE acq.purchase_order (
219 id SERIAL PRIMARY KEY,
220 owner INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
221 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
222 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
223 ordering_agency INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
224 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
225 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
226 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
227 state TEXT NOT NULL DEFAULT 'new',
228 order_date TIMESTAMP WITH TIME ZONE,
231 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
232 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
233 CREATE INDEX po_state_idx ON acq.purchase_order (state);
234 CREATE INDEX po_creator_idx ON acq.purchase_order ( creator );
235 CREATE INDEX po_editor_idx ON acq.purchase_order ( editor );
236 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
238 -- The name should default to the id, as text. We can't reference a column
239 -- in a DEFAULT clause, so we use a trigger:
241 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
244 IF NEW.name IS NULL THEN
245 NEW.name := NEW.id::TEXT;
252 CREATE TRIGGER po_name_default_trg
253 BEFORE INSERT OR UPDATE ON acq.purchase_order
254 FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
256 -- The order name should be unique for a given ordering agency on a given order date
257 -- (truncated to midnight), but only where the order_date is not NULL. Conceptually
258 -- this rule requires a check constraint with a subquery. However you can't have a
259 -- subquery in a CHECK constraint, so we fake it with a trigger.
261 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
267 -- If order_date is not null, then make sure we don't have a collision
268 -- on order_date (truncated to day), org, and name
270 IF NEW.order_date IS NULL THEN
274 -- In the WHERE clause, we compare the order_dates without regard to time of day.
275 -- We use a pair of inequalities instead of comparing truncated dates so that the
276 -- query can do an indexed range scan.
278 SELECT 1 INTO collision
279 FROM acq.purchase_order
281 ordering_agency = NEW.ordering_agency
283 AND order_date >= date_trunc( 'day', NEW.order_date )
284 AND order_date < date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
287 IF collision IS NULL THEN
288 -- okay, no collision
291 -- collision; nip it in the bud
292 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
293 NEW.ordering_agency, NEW.order_date, NEW.name;
298 CREATE TRIGGER po_org_name_date_unique_trg
299 BEFORE INSERT OR UPDATE ON acq.purchase_order
300 FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
302 CREATE TABLE acq.po_note (
303 id SERIAL PRIMARY KEY,
304 purchase_order INT NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
305 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
306 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
307 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
308 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
311 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
312 CREATE INDEX acq_po_note_creator_idx ON acq.po_note ( creator );
313 CREATE INDEX acq_po_note_editor_idx ON acq.po_note ( editor );
315 CREATE TABLE acq.lineitem (
316 id BIGSERIAL PRIMARY KEY,
317 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
318 editor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
319 selector INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
320 provider INT REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
321 purchase_order INT REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
322 picklist INT REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
323 expected_recv_time TIMESTAMP WITH TIME ZONE,
324 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
325 edit_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
327 eg_bib_id INT REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
329 item_count INT NOT NULL DEFAULT 0,
330 state TEXT NOT NULL DEFAULT 'new',
331 CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
333 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
334 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
335 CREATE INDEX li_creator_idx ON acq.lineitem ( creator );
336 CREATE INDEX li_editor_idx ON acq.lineitem ( editor );
337 CREATE INDEX li_selector_idx ON acq.lineitem ( selector );
339 CREATE TABLE acq.lineitem_note (
340 id SERIAL PRIMARY KEY,
341 lineitem INT NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
342 creator INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
343 editor INT NOT NULL REFERENCES actor.usr (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(),
348 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
349 CREATE INDEX li_note_creator_idx ON acq.lineitem_note ( creator );
350 CREATE INDEX li_note_editor_idx ON acq.lineitem_note ( editor );
352 CREATE TABLE acq.lineitem_detail (
353 id BIGSERIAL PRIMARY KEY,
354 lineitem INT NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
355 fund INT REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
356 fund_debit INT REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
357 eg_copy_id BIGINT REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
361 collection_code TEXT,
362 circ_modifier TEXT REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
363 owning_lib INT REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
364 location INT REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
365 recv_time TIMESTAMP WITH TIME ZONE
368 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
370 CREATE TABLE acq.lineitem_attr_definition (
371 id BIGSERIAL PRIMARY KEY,
373 description TEXT NOT NULL,
374 remove TEXT NOT NULL DEFAULT '',
375 ident BOOL NOT NULL DEFAULT FALSE
378 CREATE TABLE acq.lineitem_marc_attr_definition (
379 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
381 ) INHERITS (acq.lineitem_attr_definition);
383 CREATE TABLE acq.lineitem_provider_attr_definition (
384 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
386 provider INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
387 ) INHERITS (acq.lineitem_attr_definition);
389 CREATE TABLE acq.lineitem_generated_attr_definition (
390 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
392 ) INHERITS (acq.lineitem_attr_definition);
394 CREATE TABLE acq.lineitem_usr_attr_definition (
395 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
396 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
397 ) INHERITS (acq.lineitem_attr_definition);
398 CREATE INDEX li_usr_attr_def_usr_idx ON acq.lineitem_usr_attr_definition ( usr );
400 CREATE TABLE acq.lineitem_local_attr_definition (
401 id BIGINT PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
402 ) INHERITS (acq.lineitem_attr_definition);
404 CREATE TABLE acq.lineitem_attr (
405 id BIGSERIAL PRIMARY KEY,
406 definition BIGINT NOT NULL,
407 lineitem BIGINT NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
408 attr_type TEXT NOT NULL,
409 attr_name TEXT NOT NULL,
410 attr_value TEXT NOT NULL
413 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
414 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
415 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
421 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
422 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)]');
423 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
424 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
425 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
426 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
427 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
428 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
429 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
430 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
431 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
433 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
436 CREATE TABLE acq.distribution_formula (
437 id SERIAL PRIMARY KEY,
439 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
441 skip_count INT NOT NULL DEFAULT 0,
442 CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
445 CREATE TABLE acq.distribution_formula_entry (
446 id SERIAL PRIMARY KEY,
447 formula INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
449 DEFERRABLE INITIALLY DEFERRED,
450 position INTEGER NOT NULL,
451 item_count INTEGER NOT NULL,
452 owning_lib INTEGER REFERENCES actor.org_unit(id)
453 DEFERRABLE INITIALLY DEFERRED,
454 location INTEGER REFERENCES asset.copy_location(id),
455 CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
456 CONSTRAINT acqdfe_must_be_somewhere
457 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
460 CREATE TABLE acq.fund_tag (
461 id SERIAL PRIMARY KEY,
463 REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
465 CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
468 CREATE TABLE acq.fund_tag_map (
469 id SERIAL PRIMARY KEY,
470 fund INTEGER NOT NULL REFERENCES acq.fund(id)
471 DEFERRABLE INITIALLY DEFERRED,
472 tag INTEGER REFERENCES acq.fund_tag(id)
474 DEFERRABLE INITIALLY DEFERRED,
475 CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
478 CREATE TABLE acq.fund_transfer (
479 id SERIAL PRIMARY KEY,
480 src_fund INT NOT NULL REFERENCES acq.fund( id )
481 DEFERRABLE INITIALLY DEFERRED,
482 src_amount NUMERIC NOT NULL,
483 dest_fund INT NOT NULL REFERENCES acq.fund( id )
484 DEFERRABLE INITIALLY DEFERRED,
485 dest_amount NUMERIC NOT NULL,
486 transfer_time TIMESTAMPTZ NOT NULL DEFAULT now(),
487 transfer_user INT NOT NULL REFERENCES actor.usr( id )
488 DEFERRABLE INITIALLY DEFERRED,
490 funding_source_credit INT NOT NULL REFERENCES acq.funding_source_credit( id )
491 DEFERRABLE INITIALLY DEFERRED
494 CREATE INDEX acqftr_usr_idx
495 ON acq.fund_transfer( transfer_user );
497 COMMENT ON TABLE acq.fund_transfer IS $$
499 * Copyright (C) 2009 Georgia Public Library Service
500 * Scott McKellar <scott@esilibrary.com>
504 * Each row represents the transfer of money from a source fund
505 * to a destination fund. There should be corresponding entries
506 * in acq.fund_allocation. The purpose of acq.fund_transfer is
507 * to record how much money moved from which fund to which other
510 * The presence of two amount fields, rather than one, reflects
511 * the possibility that the two funds are denominated in different
512 * currencies. If they use the same currency type, the two
513 * amounts should be the same.
517 * This program is free software; you can redistribute it and/or
518 * modify it under the terms of the GNU General Public License
519 * as published by the Free Software Foundation; either version 2
520 * of the License, or (at your option) any later version.
522 * This program is distributed in the hope that it will be useful,
523 * but WITHOUT ANY WARRANTY; without even the implied warranty of
524 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
525 * GNU General Public License for more details.
529 CREATE TABLE acq.fiscal_calendar (
530 id SERIAL PRIMARY KEY,
534 -- Create a default calendar (though we don't specify its contents).
535 -- Create a foreign key in actor.org_unit, initially pointing to
536 -- the default calendar.
538 INSERT INTO acq.fiscal_calendar (
545 ALTER TABLE actor.org_unit
546 ADD COLUMN fiscal_calendar INT NOT NULL
547 REFERENCES acq.fiscal_calendar( id )
548 DEFERRABLE INITIALLY DEFERRED
551 CREATE TABLE acq.fiscal_year (
552 id SERIAL PRIMARY KEY,
553 calendar INT NOT NULL
554 REFERENCES acq.fiscal_calendar
556 DEFERRABLE INITIALLY DEFERRED,
558 year_begin TIMESTAMPTZ NOT NULL,
559 year_end TIMESTAMPTZ NOT NULL,
560 CONSTRAINT acq_fy_logical_key UNIQUE ( calendar, year ),
561 CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
564 CREATE TABLE acq.edi_account ( -- similar tables can extend remote_account for other parts of EG
565 provider INT NOT NULL REFERENCES acq.provider (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
566 in_dir TEXT -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
567 ) INHERITS (config.remote_account);
569 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
570 ALTER TABLE acq.edi_account ADD CONSTRAINT acq_edi_account_id_unique UNIQUE (id);
572 -- Note below that the primary key is NOT a SERIAL type. We will periodically truncate and rebuild
573 -- the table, assigning ids programmatically instead of using a sequence.
574 CREATE TABLE acq.debit_attribution (
575 id INT NOT NULL PRIMARY KEY,
576 fund_debit INT NOT NULL
577 REFERENCES acq.fund_debit
578 DEFERRABLE INITIALLY DEFERRED,
579 debit_amount NUMERIC NOT NULL,
580 funding_source_credit INT REFERENCES acq.funding_source_credit
581 DEFERRABLE INITIALLY DEFERRED,
582 credit_amount NUMERIC
585 CREATE INDEX acq_attribution_debit_idx
586 ON acq.debit_attribution( fund_debit );
588 CREATE INDEX acq_attribution_credit_idx
589 ON acq.debit_attribution( funding_source_credit );
593 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
594 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
597 lida acq.flat_lineitem_holding_subfield%ROWTYPE;
600 SELECT COUNT(*) INTO counter
601 FROM oils_xpath_table(
605 '//*[@tag="' || tag || '"]',
607 ) as t(i int,c text);
609 FOR i IN 1 .. counter LOOP
612 FROM ( SELECT id,i,t,v
613 FROM oils_xpath_table(
617 '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
618 '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
620 ) as t(id int,t text,v text)
631 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
632 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
636 lida acq.flat_lineitem_detail%ROWTYPE;
638 SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
639 IF NOT FOUND THEN RETURN; END IF;
641 SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
642 IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
649 FROM acq.extract_holding_attr_table( lineitem_i, tag_t ) h
650 JOIN acq.provider_holding_subfield_map a USING (subfield)
651 WHERE a.provider = prov_i
660 -- select * from acq.extract_provider_holding_data(699);
662 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
663 SELECT public.extract_marc_field('acq.lineitem', $1, $2, $3);
667 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
668 SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
671 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
672 SELECT public.extract_marc_field('authority.record_entry', $1, $2);
676 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
679 Suggested vendor fields:
687 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $$
695 FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
697 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
699 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
700 IF (atype = 'lineitem_provider_attr_definition') THEN
701 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
702 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
705 IF (atype = 'lineitem_provider_attr_definition') THEN
706 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
707 ELSIF (atype = 'lineitem_marc_attr_definition') THEN
708 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
709 ELSIF (atype = 'lineitem_generated_attr_definition') THEN
710 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
713 SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
715 IF (value IS NOT NULL AND value <> '') THEN
716 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
717 VALUES (NEW.id, adef.id, atype, adef.code, value);
728 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
730 IF TG_OP = 'UPDATE' THEN
731 DELETE FROM acq.lineitem_attr
732 WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
735 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
741 CREATE TRIGGER cleanup_lineitem_trigger
742 BEFORE UPDATE OR DELETE ON acq.lineitem
743 FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
745 CREATE TRIGGER ingest_lineitem_trigger
746 AFTER INSERT OR UPDATE ON acq.lineitem
747 FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
749 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
753 IF from_ex = to_ex THEN
757 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
762 SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
773 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
774 SELECT $3 * acq.exchange_ratio($1, $2);
777 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
779 Examine the acq.fiscal_year table, comparing successive years.
780 Report any inconsistencies, i.e. years that overlap, have gaps
781 between them, or are out of sequence.
783 RETURNS SETOF RECORD AS $$
807 ELSIF curr_year.calendar = prev_year.calendar THEN
808 IF curr_year.year_begin > prev_year.year_end THEN
809 -- This ugly kludge works around the fact that older
810 -- versions of PostgreSQL don't support RETURN QUERY SELECT
811 FOR return_rec IN SELECT
814 'Gap between fiscal years'::TEXT
816 RETURN NEXT return_rec;
818 ELSIF curr_year.year_begin < prev_year.year_end THEN
819 FOR return_rec IN SELECT
822 'Overlapping fiscal years'::TEXT
824 RETURN NEXT return_rec;
826 ELSIF curr_year.year < prev_year.year THEN
827 FOR return_rec IN SELECT
830 'Fiscal years out of order'::TEXT
832 RETURN NEXT return_rec;
837 prev_year := curr_year;
844 -- The following three types are intended for internal use
845 -- by the acq.attribute_debits() function.
847 -- For a combination of fund and funding_source: How much that source
848 -- allocated to that fund, and how much is left.
849 CREATE TYPE acq.fund_source_balance AS
852 source INT, -- funding source id
853 amount NUMERIC, -- original total allocation
854 balance NUMERIC -- what's left
857 -- For a fund: a list of funding_source_credits to which
858 -- the fund's debits can be attributed.
859 CREATE TYPE acq.fund_credits AS
862 credit_count INT, -- number of entries in the following array
863 credit INT [] -- funding source credits from which a fund may draw
866 -- For a funding source credit: the funding source, the currency type
867 -- of the funding source, and the current balance.
868 CREATE TYPE acq.funding_source_credit_balance AS
870 credit_id INT, -- if for funding source credit
871 funding_source INT, -- id of funding source
872 currency_type TEXT, -- currency type of funding source
873 amount NUMERIC, -- original amount of credit
874 balance NUMERIC -- how much is left
877 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
879 Function to attribute expenditures and encumbrances to funding source credits,
880 and thereby to funding sources.
882 Read the debits in chonological order, attributing each one to one or
883 more funding source credits. Constraints:
885 1. Don't attribute more to a credit than the amount of the credit.
887 2. For a given fund, don't attribute more to a funding source than the
888 source has allocated to that fund.
890 3. Attribute debits to credits with deadlines before attributing them to
891 credits without deadlines. Otherwise attribute to the earliest credits
892 first, based on the deadline date when present, or on the effective date
893 when there is no deadline. Use funding_source_credit.id as a tie-breaker.
894 This ordering is defined by an ORDER BY clause on the view
895 acq.ordered_funding_source_credit.
897 Start by truncating the table acq.debit_attribution. Then insert a row
898 into that table for each attribution. If a debit cannot be fully
899 attributed, insert a row for the unattributable balance, with the
900 funding_source_credit and credit_amount columns NULL.
903 curr_fund_src_bal acq.fund_source_balance;
904 fund_source_balance acq.fund_source_balance [];
905 curr_fund_cr_list acq.fund_credits;
906 fund_credit_list acq.fund_credits [];
907 curr_cr_bal acq.funding_source_credit_balance;
908 cr_bal acq.funding_source_credit_balance[];
909 crl_max INT; -- Number of entries in fund_credits[]
910 fcr_max INT; -- Number of entries in a credit list
911 fsa_max INT; -- Number of entries in fund_source_balance[]
912 fscr_max INT; -- Number of entries in cr_bal[]
918 -- Used exclusively in the main loop:
921 debit_balance NUMERIC; -- amount left to attribute for current debit
922 conv_debit_balance NUMERIC; -- debit balance in currency of the fund
923 attr_amount NUMERIC; -- amount being attributed, in currency of debit
924 conv_attr_amount NUMERIC; -- amount being attributed, in currency of source
925 conv_cred_balance NUMERIC; -- credit_balance in the currency of the fund
926 conv_alloc_balance NUMERIC; -- allocated balance in the currency of the fund
930 curr_cred_x INT; -- index of current credit in cr_bal[]
931 curr_fund_src_x INT; -- index of current credit in fund_source_balance[]
932 attrib_count INT; -- populates id of acq.debit_attribution
935 -- Load an array. For each combination of fund and funding source, load an
936 -- entry with the total amount allocated to that fund by that source. This
937 -- sum may reflect transfers as well as original allocations. The balance
938 -- is initially equal to the original amount.
944 funding_source AS source,
945 sum( amount ) AS amount
957 IF fsa.amount > 0 THEN
959 -- Add this fund/source combination to the list
961 curr_fund_src_bal.fund := fsa.fund;
962 curr_fund_src_bal.source := fsa.source;
963 curr_fund_src_bal.amount := fsa.amount;
964 curr_fund_src_bal.balance := fsa.amount;
966 fsa_max := fsa_max + 1;
967 fund_source_balance[ fsa_max ] := curr_fund_src_bal;
971 -------------------------------------------------------------------------------
973 -- Load another array. For each fund, load a list of funding
974 -- source credits from which that fund can get money.
979 FROM acq.fund_allocation
981 LOOP -- Loop over the funds
983 -- Initialize the array entry
985 curr_fund_cr_list.fund := fc.fund;
987 curr_fund_cr_list.credit := NULL;
989 -- Make a list of the funding source credits
990 -- applicable to this fund
996 acq.ordered_funding_source_credit AS ofsc
998 ofsc.funding_source IN
1000 SELECT funding_source
1001 FROM acq.fund_allocation
1002 WHERE fund = fc.fund
1008 LOOP -- Add each credit to the list
1009 fcr_max := fcr_max + 1;
1010 curr_fund_cr_list.credit[ fcr_max ] := sc.id;
1014 -- If there are any credits applicable to this fund,
1015 -- add the credit list to the list of credit lists.
1018 curr_fund_cr_list.credit_count := fcr_max;
1019 crl_max := crl_max + 1;
1020 fund_credit_list[ crl_max ] := curr_fund_cr_list;
1024 -------------------------------------------------------------------------------
1026 -- Load yet another array. This one is a list of funding source credits, with
1033 ofsc.funding_source,
1037 acq.ordered_funding_source_credit AS ofsc,
1038 acq.funding_source fs
1040 ofsc.funding_source = fs.id
1047 curr_cr_bal.credit_id := cr.id;
1048 curr_cr_bal.funding_source := cr.funding_source;
1049 curr_cr_bal.amount := cr.amount;
1050 curr_cr_bal.balance := cr.amount;
1051 curr_cr_bal.currency_type := cr.currency_type;
1053 fscr_max := fscr_max + 1;
1054 cr_bal[ fscr_max ] := curr_cr_bal;
1057 -------------------------------------------------------------------------------
1059 -- Now that we have loaded the lookup tables: loop through the debits,
1060 -- attributing each one to one or more funding source credits.
1062 truncate table acq.debit_attribution;
1080 debit_balance := deb.amount;
1082 -- Find the list of credits applicable to this fund
1084 fund_found := false;
1085 FOR i in 1 .. crl_max LOOP
1086 IF fund_credit_list[ i ].fund = deb.fund THEN
1087 curr_fund_cr_list := fund_credit_list[ i ];
1093 -- If we didn't find an entry for this fund, then there are no applicable
1094 -- funding sources for this fund, and the debit is hence unattributable.
1096 -- If we did find an entry for this fund, then we have a list of funding source
1097 -- credits that we can apply to it. Go through that list and attribute the
1098 -- debit accordingly.
1102 -- For each applicable credit
1104 FOR i in 1 .. curr_fund_cr_list.credit_count LOOP
1106 -- Find the entry in the credit list for this credit. If you find it but
1107 -- it has a zero balance, it's not useful, so treat it as if you didn't
1110 credit_found := false;
1111 FOR j in 1 .. fscr_max LOOP
1112 IF cr_bal[ j ].credit_id = curr_fund_cr_list.credit[i] THEN
1113 curr_cr_bal := cr_bal[ j ];
1114 IF curr_cr_bal.balance <> 0 THEN
1116 credit_found := true;
1122 IF NOT credit_found THEN
1124 -- This credit is not usable; try the next one.
1129 -- At this point we have an applicable credit with some money left.
1130 -- Now see if the relevant funding_source has any money left.
1132 -- Search the fund/source list for an entry with this combination
1133 -- of fund and source. If you find such an entry, but it has a zero
1134 -- balance, then it's not useful, so treat it as unfound.
1136 alloc_found := false;
1137 FOR j in 1 .. fsa_max LOOP
1138 IF fund_source_balance[ j ].fund = deb.fund
1139 AND fund_source_balance[ j ].source = curr_cr_bal.funding_source THEN
1140 curr_fund_src_bal := fund_source_balance[ j ];
1141 IF curr_fund_src_bal.balance <> 0 THEN
1142 curr_fund_src_x := j;
1143 alloc_found := true;
1149 IF NOT alloc_found THEN
1151 -- This fund/source doesn't exist is already exhausted,
1152 -- so we can't use this credit. Go on to the next on.
1157 -- Convert the available balances to the currency of the fund
1159 conv_alloc_balance := curr_fund_src_bal.balance * acq.exchange_ratio(
1160 curr_cr_bal.currency_type, deb.currency_type );
1161 conv_cred_balance := curr_cr_bal.balance * acq.exchange_ratio(
1162 curr_cr_bal.currency_type, deb.currency_type );
1164 -- Determine how much we can attribute to this credit: the minimum
1165 -- of the debit amount, the fund/source balance, and the
1168 attr_amount := debit_balance;
1169 IF attr_amount > conv_alloc_balance THEN
1170 attr_amount := conv_alloc_balance;
1172 IF attr_amount > conv_cred_balance THEN
1173 attr_amount := conv_cred_balance;
1176 -- Convert the amount of the attribution to the
1177 -- currency of the funding source.
1179 conv_attr_amount := attr_amount * acq.exchange_ratio(
1180 deb.currency_type, curr_cr_bal.currency_type );
1182 -- Insert a row to record the attribution
1184 attrib_count := attrib_count + 1;
1185 INSERT INTO acq.debit_attribution (
1189 funding_source_credit,
1195 curr_cr_bal.credit_id,
1199 -- Subtract the attributed amount from the various balances
1201 debit_balance := debit_balance - attr_amount;
1203 curr_fund_src_bal.balance := curr_fund_src_bal.balance - conv_attr_amount;
1204 fund_source_balance[ curr_fund_src_x ] := curr_fund_src_bal;
1205 IF curr_fund_src_bal.balance <= 0 THEN
1207 -- This allocation is exhausted. Take it out of the list
1208 -- so that we don't waste time looking at it again.
1210 FOR i IN curr_fund_src_x .. fsa_max - 1 LOOP
1211 fund_source_balance[ i ] := fund_source_balance[ i + 1 ];
1213 fund_source_balance[ fsa_max ] := NULL;
1214 fsa_max := fsa_max - 1;
1217 curr_cr_bal.balance := curr_cr_bal.balance - conv_attr_amount;
1218 cr_bal[ curr_cred_x ] := curr_cr_bal;
1219 IF curr_cr_bal.balance <= 0 THEN
1221 -- This funding source credit is exhausted. Take it out of
1222 -- the list so that we don't waste time looking at it again.
1224 FOR i IN curr_cred_x .. fscr_max - 1 LOOP
1225 cr_bal[ i ] := cr_bal[ i + 1 ];
1227 cr_bal[ fscr_max ] := NULL;
1228 fscr_max := fscr_max - 1;
1231 -- Are we done with this debit yet?
1233 IF debit_balance <= 0 THEN
1234 EXIT; -- We've fully attributed this debit; stop looking at credits.
1236 END LOOP; -- End of loop over applicable credits
1239 IF debit_balance <> 0 THEN
1241 -- We weren't able to attribute this debit, or at least not
1242 -- all of it. Insert a row for the unattributed balance.
1244 attrib_count := attrib_count + 1;
1245 INSERT INTO acq.debit_attribution (
1249 funding_source_credit,
1259 END LOOP; -- End of loop over debits
1261 $$ LANGUAGE 'plpgsql';
1263 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
1264 SELECT funding_source,
1265 SUM(amount) AS amount
1266 FROM acq.funding_source_credit
1269 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
1270 SELECT funding_source,
1271 SUM(a.amount)::NUMERIC(100,2) AS amount
1272 FROM acq.fund_allocation a
1275 CREATE OR REPLACE VIEW acq.funding_source_balance AS
1276 SELECT COALESCE(c.funding_source, a.funding_source) AS funding_source,
1277 SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
1278 FROM acq.funding_source_credit_total c
1279 FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
1282 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
1284 SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
1285 FROM acq.fund_allocation a
1286 JOIN acq.fund f ON (a.fund = f.id)
1287 JOIN acq.funding_source s ON (a.funding_source = s.id)
1290 CREATE OR REPLACE VIEW acq.fund_debit_total AS
1291 SELECT fund.id AS fund,
1292 fund_debit.encumbrance AS encumbrance,
1293 SUM( COALESCE( fund_debit.amount, 0 ) ) AS amount
1294 FROM acq.fund AS fund
1295 LEFT JOIN acq.fund_debit AS fund_debit
1296 ON ( fund.id = fund_debit.fund )
1299 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
1301 SUM(amount) AS amount
1302 FROM acq.fund_debit_total
1303 WHERE encumbrance IS TRUE
1306 CREATE OR REPLACE VIEW acq.fund_spent_total AS
1308 SUM(amount) AS amount
1309 FROM acq.fund_debit_total
1310 WHERE encumbrance IS FALSE
1313 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
1315 c.amount - COALESCE(d.amount,0.0) AS amount
1316 FROM acq.fund_allocation_total c
1317 LEFT JOIN acq.fund_debit_total d USING (fund);
1319 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
1321 c.amount - COALESCE(d.amount,0.0) AS amount
1322 FROM acq.fund_allocation_total c
1323 LEFT JOIN acq.fund_spent_total d USING (fund);