Open-ILS/src/sql/Pg/200.schema.acq.sql

   1 /*
   2  * Copyright (C) 2009  Georgia Public Library Service
   3  * Scott McKellar <scott@esilibrary.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  */
  15
  16 DROP SCHEMA IF EXISTS acq CASCADE;
  17
  18 BEGIN;
  19
  20 CREATE SCHEMA acq;
  21
  22
  23 -- Tables
  24
  25
  26 CREATE TABLE acq.currency_type (
  27         code    TEXT PRIMARY KEY,
  28         label   TEXT
  29 );
  30
  31 CREATE TABLE acq.exchange_rate (
  32     id              SERIAL  PRIMARY KEY,
  33     from_currency   TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  34     to_currency     TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  35     ratio           NUMERIC NOT NULL,
  36     CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
  37 );
  38
  39 CREATE TABLE acq.claim_policy (
  40         id              SERIAL       PRIMARY KEY,
  41         org_unit        INT          NOT NULL REFERENCES actor.org_unit
  42                                      DEFERRABLE INITIALLY DEFERRED,
  43         name            TEXT         NOT NULL,
  44         description     TEXT         NOT NULL,
  45         CONSTRAINT name_once_per_org UNIQUE (org_unit, name)
  46 );
  47
  48 CREATE TABLE acq.claim_event_type (
  49         id             SERIAL           PRIMARY KEY,
  50         org_unit       INT              NOT NULL REFERENCES actor.org_unit(id)
  51                                                  DEFERRABLE INITIALLY DEFERRED,
  52         code           TEXT             NOT NULL,
  53         description    TEXT             NOT NULL,
  54         library_initiated BOOL          NOT NULL DEFAULT FALSE,
  55         CONSTRAINT event_type_once_per_org UNIQUE ( org_unit, code )
  56 );
  57
  58 CREATE TABLE acq.claim_policy_action (
  59         id              SERIAL       PRIMARY KEY,
  60         claim_policy    INT          NOT NULL REFERENCES acq.claim_policy
  61                                  ON DELETE CASCADE
  62                                      DEFERRABLE INITIALLY DEFERRED,
  63         action_interval INTERVAL     NOT NULL,
  64         action          INT          NOT NULL REFERENCES acq.claim_event_type
  65                                      DEFERRABLE INITIALLY DEFERRED,
  66         CONSTRAINT action_sequence UNIQUE (claim_policy, action_interval)
  67 );
  68
  69 CREATE TABLE acq.provider (
  70     id                  SERIAL  PRIMARY KEY,
  71     name                TEXT    NOT NULL,
  72     owner               INT     NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
  73     currency_type       TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  74     code                TEXT    NOT NULL,
  75     holding_tag         TEXT,
  76     san                 TEXT,
  77     edi_default         INT,          -- REFERENCES acq.edi_account (id) DEFERRABLE INITIALLY DEFERRED
  78         active              BOOL    NOT NULL DEFAULT TRUE,
  79         prepayment_required BOOL    NOT NULL DEFAULT FALSE,
  80     url                 TEXT,
  81     email               TEXT,
  82     phone               TEXT,
  83     fax_phone           TEXT,
  84     default_copy_count  INT     NOT NULL DEFAULT 0,
  85         default_claim_policy INT    REFERENCES acq.claim_policy
  86                                     DEFERRABLE INITIALLY DEFERRED,
  87     CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
  88         CONSTRAINT code_once_per_owner UNIQUE (code, owner)
  89 );
  90
  91 CREATE TABLE acq.provider_holding_subfield_map (
  92     id          SERIAL  PRIMARY KEY,
  93     provider    INT     NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
  94     name        TEXT    NOT NULL, -- barcode, price, etc
  95     subfield    TEXT    NOT NULL,
  96     CONSTRAINT name_once_per_provider UNIQUE (provider,name)
  97 );
  98
  99 CREATE TABLE acq.provider_address (
 100         id              SERIAL  PRIMARY KEY,
 101         valid           BOOL    NOT NULL DEFAULT TRUE,
 102         address_type    TEXT,
 103     provider    INT     NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 104         street1         TEXT    NOT NULL,
 105         street2         TEXT,
 106         city            TEXT    NOT NULL,
 107         county          TEXT,
 108         state           TEXT    NOT NULL,
 109         country         TEXT    NOT NULL,
 110         post_code       TEXT    NOT NULL,
 111         fax_phone       TEXT
 112 );
 113
 114 CREATE TABLE acq.provider_contact (
 115         id              SERIAL  PRIMARY KEY,
 116     provider    INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 117     name    TEXT NOT NULL,
 118     role    TEXT, -- free-form.. e.g. "our sales guy"
 119     email   TEXT,
 120     phone   TEXT
 121 );
 122
 123 CREATE TABLE acq.provider_contact_address (
 124         id                      SERIAL  PRIMARY KEY,
 125         valid                   BOOL    NOT NULL DEFAULT TRUE,
 126         address_type    TEXT,
 127         contact                 INT         NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
 128         street1                 TEXT    NOT NULL,
 129         street2                 TEXT,
 130         city                    TEXT    NOT NULL,
 131         county                  TEXT,
 132         state                   TEXT    NOT NULL,
 133         country                 TEXT    NOT NULL,
 134         post_code               TEXT    NOT NULL,
 135         fax_phone               TEXT
 136 );
 137
 138 CREATE TABLE acq.provider_note (
 139         id              SERIAL                          PRIMARY KEY,
 140         provider    INT                         NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 141         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 142         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 143         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 144         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 145         value           TEXT                    NOT NULL
 146 );
 147 CREATE INDEX acq_pro_note_pro_idx      ON acq.provider_note ( provider );
 148 CREATE INDEX acq_pro_note_creator_idx  ON acq.provider_note ( creator );
 149 CREATE INDEX acq_pro_note_editor_idx   ON acq.provider_note ( editor );
 150
 151
 152 CREATE TABLE acq.funding_source (
 153         id              SERIAL  PRIMARY KEY,
 154         name            TEXT    NOT NULL,
 155         owner           INT     NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 156         currency_type   TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
 157         code            TEXT    UNIQUE,
 158         CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
 159 );
 160
 161 CREATE TABLE acq.funding_source_credit (
 162         id      SERIAL     PRIMARY KEY,
 163         funding_source INT      NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
 164         amount         NUMERIC  NOT NULL,
 165         note           TEXT,
 166         deadline_date  TIMESTAMPTZ,
 167         effective_date TIMESTAMPTZ NOT NULL default now()
 168 );
 169
 170 CREATE VIEW acq.ordered_funding_source_credit AS
 171     SELECT
 172         CASE WHEN deadline_date IS NULL THEN
 173             2
 174         ELSE
 175             1
 176         END AS sort_priority,
 177         CASE WHEN deadline_date IS NULL THEN
 178             effective_date
 179         ELSE
 180             deadline_date
 181         END AS sort_date,
 182         id,
 183         funding_source,
 184         amount,
 185         note
 186     FROM
 187         acq.funding_source_credit;
 188
 189 COMMENT ON VIEW acq.ordered_funding_source_credit IS $$
 190 The acq.ordered_funding_source_credit view is a prioritized
 191 ordering of funding source credits.  When ordered by the first
 192 three columns, this view defines the order in which the various
 193 credits are to be tapped for spending, subject to the allocations
 194 in the acq.fund_allocation table.
 195
 196 The first column reflects the principle that we should spend
 197 money with deadlines before spending money without deadlines.
 198
 199 The second column reflects the principle that we should spend the
 200 oldest money first.  For money with deadlines, that means that we
 201 spend first from the credit with the earliest deadline.  For
 202 money without deadlines, we spend first from the credit with the
 203 earliest effective date.
 204
 205 The third column is a tie breaker to ensure a consistent
 206 ordering.
 207 $$;
 208
 209 CREATE TABLE acq.fund (
 210     id              SERIAL  PRIMARY KEY,
 211     org             INT     NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 212     name            TEXT    NOT NULL,
 213     year            INT     NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
 214     currency_type   TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
 215     code            TEXT,
 216         rollover        BOOL    NOT NULL DEFAULT FALSE,
 217         propagate       BOOL    NOT NULL DEFAULT TRUE,
 218         active          BOOL    NOT NULL DEFAULT TRUE,
 219         balance_warning_percent INT,
 220         balance_stop_percent    INT,
 221     CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
 222     CONSTRAINT code_once_per_org_year UNIQUE (org, code, year),
 223         CONSTRAINT acq_fund_rollover_implies_propagate CHECK ( propagate OR NOT rollover )
 224 );
 225
 226 CREATE TABLE acq.fund_debit (
 227         id                      SERIAL  PRIMARY KEY,
 228         fund                    INT     NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
 229         origin_amount           NUMERIC NOT NULL,  -- pre-exchange-rate amount
 230         origin_currency_type    TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
 231         amount                  NUMERIC NOT NULL,
 232         encumbrance             BOOL    NOT NULL DEFAULT TRUE,
 233         debit_type              TEXT    NOT NULL,
 234         xfer_destination        INT     REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
 235         create_time     TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
 236 );
 237
 238 CREATE TABLE acq.fund_allocation (
 239     id          SERIAL  PRIMARY KEY,
 240     funding_source        INT     NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 241     fund        INT     NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 242     amount      NUMERIC NOT NULL,
 243     allocator   INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 244     note        TEXT,
 245         create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
 246 );
 247 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
 248
 249 CREATE TABLE acq.fund_allocation_percent
 250 (
 251     id                   SERIAL            PRIMARY KEY,
 252     funding_source       INT               NOT NULL REFERENCES acq.funding_source
 253                                                DEFERRABLE INITIALLY DEFERRED,
 254     org                  INT               NOT NULL REFERENCES actor.org_unit
 255                                                DEFERRABLE INITIALLY DEFERRED,
 256     fund_code            TEXT,
 257     percent              NUMERIC           NOT NULL,
 258     allocator            INTEGER           NOT NULL REFERENCES actor.usr
 259                                                DEFERRABLE INITIALLY DEFERRED,
 260     note                 TEXT,
 261     create_time          TIMESTAMPTZ       NOT NULL DEFAULT now(),
 262     CONSTRAINT logical_key UNIQUE( funding_source, org, fund_code ),
 263     CONSTRAINT percentage_range CHECK( percent >= 0 AND percent <= 100 )
 264 );
 265
 266 -- Trigger function to validate combination of org_unit and fund_code
 267
 268 CREATE OR REPLACE FUNCTION acq.fund_alloc_percent_val()
 269 RETURNS TRIGGER AS $$
 270 --
 271 DECLARE
 272 --
 273 dummy int := 0;
 274 --
 275 BEGIN
 276     SELECT
 277         1
 278     INTO
 279         dummy
 280     FROM
 281         acq.fund
 282     WHERE
 283         org = NEW.org
 284         AND code = NEW.fund_code
 285         LIMIT 1;
 286     --
 287     IF dummy = 1 then
 288         RETURN NEW;
 289     ELSE
 290         RAISE EXCEPTION 'No fund exists for org % and code %', NEW.org, NEW.fund_code;
 291     END IF;
 292 END;
 293 $$ LANGUAGE plpgsql;
 294
 295 CREATE TRIGGER acq_fund_alloc_percent_val_trig
 296     BEFORE INSERT OR UPDATE ON acq.fund_allocation_percent
 297     FOR EACH ROW EXECUTE PROCEDURE acq.fund_alloc_percent_val();
 298
 299 -- To do: trigger to verify that percentages don't add up to more than 100
 300
 301 CREATE OR REPLACE FUNCTION acq.fap_limit_100()
 302 RETURNS TRIGGER AS $$
 303 DECLARE
 304 --
 305 total_percent numeric;
 306 --
 307 BEGIN
 308     SELECT
 309         sum( percent )
 310     INTO
 311         total_percent
 312     FROM
 313         acq.fund_allocation_percent AS fap
 314     WHERE
 315         fap.funding_source = NEW.funding_source;
 316     --
 317     IF total_percent > 100 THEN
 318         RAISE EXCEPTION 'Total percentages exceed 100 for funding_source %',
 319             NEW.funding_source;
 320     ELSE
 321         RETURN NEW;
 322     END IF;
 323 END;
 324 $$ LANGUAGE plpgsql;
 325
 326 CREATE TRIGGER acqfap_limit_100_trig
 327     AFTER INSERT OR UPDATE ON acq.fund_allocation_percent
 328     FOR EACH ROW EXECUTE PROCEDURE acq.fap_limit_100();
 329
 330 CREATE TABLE acq.picklist (
 331         id              SERIAL                          PRIMARY KEY,
 332         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 333         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 334         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 335         org_unit        INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 336         name            TEXT                            NOT NULL,
 337         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 338         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 339         CONSTRAINT name_once_per_owner UNIQUE (name,owner)
 340 );
 341 CREATE INDEX acq_picklist_owner_idx   ON acq.picklist ( owner );
 342 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
 343 CREATE INDEX acq_picklist_editor_idx  ON acq.picklist ( editor );
 344
 345 CREATE TABLE acq.cancel_reason (
 346         id            SERIAL            PRIMARY KEY,
 347         org_unit      INTEGER           NOT NULL REFERENCES actor.org_unit( id )
 348                                         DEFERRABLE INITIALLY DEFERRED,
 349         label         TEXT              NOT NULL,
 350         description   TEXT              NOT NULL,
 351                 keep_debits   BOOL              NOT NULL DEFAULT FALSE,
 352         CONSTRAINT acq_cancel_reason_one_per_org_unit UNIQUE( org_unit, label )
 353 );
 354
 355 -- Reserve ids 1-999 for stock reasons
 356 -- Reserve ids 1000-1999 for EDI reasons
 357 -- 2000+ are available for staff to create
 358
 359 SELECT SETVAL('acq.cancel_reason_id_seq'::TEXT, 2000);
 360
 361 DROP TRIGGER IF EXISTS acq_no_deleted_reserved_cancel_reasons ON acq.cancel_reason;
 362
 363 CREATE TRIGGER acq_no_deleted_reserved_cancel_reasons BEFORE DELETE ON acq.cancel_reason
 364     FOR EACH ROW EXECUTE PROCEDURE evergreen.protect_reserved_rows_from_delete(2000);
 365
 366 CREATE TABLE acq.purchase_order (
 367         id              SERIAL                          PRIMARY KEY,
 368         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 369         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 370         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 371         ordering_agency INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 372         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 373         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 374         provider        INT                             NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 375         state                   TEXT                                    NOT NULL DEFAULT 'new',
 376         order_date              TIMESTAMP WITH TIME ZONE,
 377         name                    TEXT                                    NOT NULL,
 378         cancel_reason   INT                     REFERENCES acq.cancel_reason( id )
 379                                             DEFERRABLE INITIALLY DEFERRED,
 380         prepayment_required BOOLEAN NOT NULL DEFAULT FALSE,
 381     CONSTRAINT valid_po_state CHECK (state IN ('new','pending','on-order','received','cancelled'))
 382 );
 383 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
 384 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
 385 CREATE INDEX po_state_idx ON acq.purchase_order (state);
 386 CREATE INDEX po_creator_idx  ON acq.purchase_order ( creator );
 387 CREATE INDEX po_editor_idx   ON acq.purchase_order ( editor );
 388 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
 389
 390 -- The name should default to the id, as text.  We can't reference a column
 391 -- in a DEFAULT clause, so we use a trigger:
 392
 393 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
 394 AS $$
 395 BEGIN
 396         IF NEW.name IS NULL THEN
 397                 NEW.name := NEW.id::TEXT;
 398         END IF;
 399
 400         RETURN NEW;
 401 END;
 402 $$ LANGUAGE PLPGSQL;
 403
 404 CREATE TRIGGER po_name_default_trg
 405   BEFORE INSERT OR UPDATE ON acq.purchase_order
 406   FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
 407
 408 -- The order name should be unique for a given ordering agency on a given order date
 409 -- (truncated to midnight), but only where the order_date is not NULL.  Conceptually
 410 -- this rule requires a check constraint with a subquery.  However you can't have a
 411 -- subquery in a CHECK constraint, so we fake it with a trigger.
 412
 413 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
 414 AS $$
 415 DECLARE
 416         collision INT;
 417 BEGIN
 418         --
 419         -- If order_date is not null, then make sure we don't have a collision
 420         -- on order_date (truncated to day), org, and name
 421         --
 422         IF NEW.order_date IS NULL THEN
 423                 RETURN NEW;
 424         END IF;
 425         --
 426         -- In the WHERE clause, we compare the order_dates without regard to time of day.
 427         -- We use a pair of inequalities instead of comparing truncated dates so that the
 428         -- query can do an indexed range scan.
 429         --
 430         SELECT 1 INTO collision
 431         FROM acq.purchase_order
 432         WHERE
 433                 ordering_agency = NEW.ordering_agency
 434                 AND name = NEW.name
 435                 AND order_date >= date_trunc( 'day', NEW.order_date )
 436                 AND order_date <  date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
 437                 AND id <> NEW.id;
 438         --
 439         IF collision IS NULL THEN
 440                 -- okay, no collision
 441                 RETURN NEW;
 442         ELSE
 443                 -- collision; nip it in the bud
 444                 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
 445                         NEW.ordering_agency, NEW.order_date, NEW.name;
 446         END IF;
 447 END;
 448 $$ LANGUAGE PLPGSQL;
 449
 450 CREATE TRIGGER po_org_name_date_unique_trg
 451   BEFORE INSERT OR UPDATE ON acq.purchase_order
 452   FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
 453
 454 CREATE TABLE acq.po_note (
 455         id              SERIAL                          PRIMARY KEY,
 456         purchase_order  INT                             NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
 457         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 458         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 459         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 460         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 461         value           TEXT                    NOT NULL,
 462         vendor_public BOOLEAN       NOT NULL DEFAULT FALSE
 463 );
 464 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
 465 CREATE INDEX acq_po_note_creator_idx  ON acq.po_note ( creator );
 466 CREATE INDEX acq_po_note_editor_idx   ON acq.po_note ( editor );
 467
 468 CREATE TABLE acq.lineitem (
 469         id                  BIGSERIAL                   PRIMARY KEY,
 470         creator             INT                         NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 471         editor              INT                         NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 472         selector            INT                         NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 473         provider            INT                         REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 474         purchase_order      INT                         REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
 475         picklist            INT                         REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
 476         expected_recv_time  TIMESTAMP WITH TIME ZONE,
 477         create_time         TIMESTAMP WITH TIME ZONE    NOT NULL DEFAULT NOW(),
 478         edit_time           TIMESTAMP WITH TIME ZONE    NOT NULL DEFAULT NOW(),
 479         marc                TEXT                        NOT NULL,
 480         eg_bib_id           BIGINT                      REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
 481         source_label        TEXT,
 482         state               TEXT                        NOT NULL DEFAULT 'new',
 483         cancel_reason       INT                         REFERENCES acq.cancel_reason( id )
 484                                                     DEFERRABLE INITIALLY DEFERRED,
 485         estimated_unit_price NUMERIC,
 486         claim_policy        INT                         REFERENCES acq.claim_policy
 487                                                                 DEFERRABLE INITIALLY DEFERRED,
 488     queued_record       BIGINT                      REFERENCES vandelay.queued_bib_record (id)
 489                                                         ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 490     CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
 491 );
 492 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
 493 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
 494 CREATE INDEX li_creator_idx   ON acq.lineitem ( creator );
 495 CREATE INDEX li_editor_idx    ON acq.lineitem ( editor );
 496 CREATE INDEX li_selector_idx  ON acq.lineitem ( selector );
 497 CREATE INDEX li_queued_record_idx ON acq.lineitem ( queued_record );
 498
 499 CREATE TABLE acq.lineitem_alert_text (
 500     id               SERIAL         PRIMARY KEY,
 501     code             TEXT           NOT NULL,
 502     description      TEXT,
 503         owning_lib       INT            NOT NULL
 504                                         REFERENCES actor.org_unit(id)
 505                                         DEFERRABLE INITIALLY DEFERRED,
 506         CONSTRAINT alert_one_code_per_org UNIQUE (code, owning_lib)
 507 );
 508
 509 CREATE TABLE acq.lineitem_note (
 510         id              SERIAL                          PRIMARY KEY,
 511         lineitem        INT                             NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 512         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 513         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 514         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 515         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 516         value           TEXT                    NOT NULL,
 517         alert_text      INT                                              REFERENCES acq.lineitem_alert_text(id)
 518                                                                                  DEFERRABLE INITIALLY DEFERRED,
 519         vendor_public BOOLEAN       NOT NULL DEFAULT FALSE
 520 );
 521 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
 522 CREATE INDEX li_note_creator_idx  ON acq.lineitem_note ( creator );
 523 CREATE INDEX li_note_editor_idx   ON acq.lineitem_note ( editor );
 524
 525 CREATE TABLE acq.lineitem_detail (
 526     id          BIGSERIAL       PRIMARY KEY,
 527     lineitem    INT         NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 528     fund        INT         REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
 529     fund_debit  INT         REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
 530     eg_copy_id  BIGINT,     -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
 531     barcode     TEXT,
 532     cn_label    TEXT,
 533     note        TEXT,
 534     collection_code TEXT,
 535     circ_modifier   TEXT    REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 536     owning_lib  INT         REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 537     location    INT         REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 538     recv_time   TIMESTAMP WITH TIME ZONE,
 539         receiver                INT         REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 540         cancel_reason   INT     REFERENCES acq.cancel_reason( id ) DEFERRABLE INITIALLY DEFERRED
 541 );
 542
 543 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
 544
 545 CREATE TABLE acq.lineitem_attr_definition (
 546         id              BIGSERIAL       PRIMARY KEY,
 547         code            TEXT            NOT NULL,
 548         description     TEXT            NOT NULL,
 549         remove          TEXT            NOT NULL DEFAULT '',
 550         ident           BOOL            NOT NULL DEFAULT FALSE
 551 );
 552
 553 CREATE TABLE acq.lineitem_marc_attr_definition (
 554         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 555         xpath           TEXT            NOT NULL
 556 ) INHERITS (acq.lineitem_attr_definition);
 557
 558 CREATE TABLE acq.lineitem_provider_attr_definition (
 559         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 560         xpath           TEXT            NOT NULL,
 561         provider        INT     NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
 562 ) INHERITS (acq.lineitem_attr_definition);
 563
 564 CREATE TABLE acq.lineitem_generated_attr_definition (
 565         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 566         xpath           TEXT            NOT NULL
 567 ) INHERITS (acq.lineitem_attr_definition);
 568
 569 CREATE TABLE acq.lineitem_usr_attr_definition (
 570         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 571         usr             INT     NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
 572 ) INHERITS (acq.lineitem_attr_definition);
 573 CREATE INDEX li_usr_attr_def_usr_idx  ON acq.lineitem_usr_attr_definition ( usr );
 574
 575 CREATE TABLE acq.lineitem_local_attr_definition (
 576         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
 577 ) INHERITS (acq.lineitem_attr_definition);
 578
 579 CREATE TABLE acq.lineitem_attr (
 580         id              BIGSERIAL       PRIMARY KEY,
 581         definition      BIGINT          NOT NULL,
 582         lineitem        BIGINT          NOT NULL REFERENCES acq.lineitem (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 583         attr_type       TEXT            NOT NULL,
 584         attr_name       TEXT            NOT NULL,
 585         attr_value      TEXT            NOT NULL,
 586         order_ident     BOOLEAN         NOT NULL DEFAULT FALSE
 587 );
 588
 589 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
 590 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
 591 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
 592
 593
 594 -- Seed data
 595
 596
 597 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
 598 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('author','Author of work','//*[@tag="100" or @tag="110" or @tag="113"]/*[contains("ad",@code)]');
 599 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
 600 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
 601 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
 602 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
 603 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('upc', 'UPC', '//*[@tag="024" and @ind1="1"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
 604 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
 605 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
 606 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
 607 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
 608 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
 609
 610 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
 611
 612
 613 CREATE TABLE acq.distribution_formula (
 614         id              SERIAL PRIMARY KEY,
 615         owner   INT NOT NULL
 616                         REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
 617         name    TEXT NOT NULL,
 618         skip_count      INT NOT NULL DEFAULT 0,
 619         CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
 620 );
 621
 622 CREATE TABLE acq.distribution_formula_entry (
 623         id                      SERIAL PRIMARY KEY,
 624         formula         INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
 625                                 ON DELETE CASCADE
 626                                 DEFERRABLE INITIALLY DEFERRED,
 627         position        INTEGER NOT NULL,
 628         item_count      INTEGER NOT NULL,
 629         owning_lib      INTEGER REFERENCES actor.org_unit(id)
 630                                 DEFERRABLE INITIALLY DEFERRED,
 631         location        INTEGER REFERENCES asset.copy_location(id),
 632         fund            INTEGER REFERENCES acq.fund (id),
 633         circ_modifier   TEXT REFERENCES config.circ_modifier (code),
 634         collection_code TEXT,
 635         CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
 636         CONSTRAINT acqdfe_must_be_somewhere
 637                                 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
 638 );
 639
 640 CREATE TABLE acq.distribution_formula_application (
 641     id BIGSERIAL PRIMARY KEY,
 642     creator INT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
 643     create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
 644     formula INT NOT NULL
 645         REFERENCES acq.distribution_formula(id) DEFERRABLE INITIALLY DEFERRED,
 646     lineitem INT NOT NULL
 647         REFERENCES acq.lineitem(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
 648 );
 649
 650 CREATE INDEX acqdfa_df_idx
 651     ON acq.distribution_formula_application(formula);
 652 CREATE INDEX acqdfa_li_idx
 653     ON acq.distribution_formula_application(lineitem);
 654 CREATE INDEX acqdfa_creator_idx
 655     ON acq.distribution_formula_application(creator);
 656
 657 CREATE TABLE acq.fund_tag (
 658         id              SERIAL PRIMARY KEY,
 659         owner   INT NOT NULL
 660                         REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
 661         name    TEXT NOT NULL,
 662         CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
 663 );
 664
 665 CREATE TABLE acq.fund_tag_map (
 666         id                      SERIAL PRIMARY KEY,
 667         fund            INTEGER NOT NULL REFERENCES acq.fund(id)
 668                                 DEFERRABLE INITIALLY DEFERRED,
 669         tag         INTEGER REFERENCES acq.fund_tag(id)
 670                                 ON DELETE CASCADE
 671                                 DEFERRABLE INITIALLY DEFERRED,
 672         CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
 673 );
 674
 675 CREATE TABLE acq.fund_transfer (
 676     id               SERIAL         PRIMARY KEY,
 677     src_fund         INT            NOT NULL REFERENCES acq.fund( id )
 678                                     DEFERRABLE INITIALLY DEFERRED,
 679     src_amount       NUMERIC        NOT NULL,
 680     dest_fund        INT            REFERENCES acq.fund( id )
 681                                     DEFERRABLE INITIALLY DEFERRED,
 682     dest_amount      NUMERIC,
 683     transfer_time    TIMESTAMPTZ    NOT NULL DEFAULT now(),
 684     transfer_user    INT            NOT NULL REFERENCES actor.usr( id )
 685                                     DEFERRABLE INITIALLY DEFERRED,
 686     note             TEXT,
 687         funding_source_credit INT       NOT NULL REFERENCES acq.funding_source_credit( id )
 688                                     DEFERRABLE INITIALLY DEFERRED
 689 );
 690
 691 CREATE INDEX acqftr_usr_idx
 692 ON acq.fund_transfer( transfer_user );
 693
 694 COMMENT ON TABLE acq.fund_transfer IS $$
 695 Fund Transfer
 696 Each row represents the transfer of money from a source fund
 697 to a destination fund.  There should be corresponding entries
 698 in acq.fund_allocation.  The purpose of acq.fund_transfer is
 699 to record how much money moved from which fund to which other
 700 fund.
 701
 702 The presence of two amount fields, rather than one, reflects
 703 the possibility that the two funds are denominated in different
 704 currencies.  If they use the same currency type, the two
 705 amounts should be the same.
 706 $$;
 707
 708 CREATE TABLE acq.fiscal_calendar (
 709         id              SERIAL         PRIMARY KEY,
 710         name            TEXT           NOT NULL
 711 );
 712
 713 -- Create a default calendar (though we don't specify its contents).
 714 -- Create a foreign key in actor.org_unit, initially pointing to
 715 -- the default calendar.
 716
 717 INSERT INTO acq.fiscal_calendar (
 718     name
 719 ) VALUES (
 720
 721     'Default'
 722 );
 723
 724 ALTER TABLE actor.org_unit ADD FOREIGN KEY
 725         (fiscal_calendar) REFERENCES acq.fiscal_calendar( id )
 726         DEFERRABLE INITIALLY DEFERRED;
 727
 728 CREATE TABLE acq.fiscal_year (
 729         id              SERIAL         PRIMARY KEY,
 730         calendar        INT            NOT NULL
 731                                        REFERENCES acq.fiscal_calendar
 732                                        ON DELETE CASCADE
 733                                        DEFERRABLE INITIALLY DEFERRED,
 734         year            INT            NOT NULL,
 735         year_begin      TIMESTAMPTZ    NOT NULL,
 736         year_end        TIMESTAMPTZ    NOT NULL,
 737         CONSTRAINT acq_fy_logical_key  UNIQUE ( calendar, year ),
 738     CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
 739 );
 740
 741 CREATE TABLE acq.edi_account (      -- similar tables can extend remote_account for other parts of EG
 742     provider    INT     NOT NULL REFERENCES acq.provider          (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 743     in_dir      TEXT,   -- incoming messages dir (probably different than config.remote_account.path, the outgoing dir)
 744     vendcode    TEXT,
 745     vendacct    TEXT
 746 ) INHERITS (config.remote_account);
 747
 748 -- We need a UNIQUE constraint here also, to support the FK from acq.provider.edi_default
 749 ALTER TABLE acq.edi_account ADD PRIMARY KEY (id);
 750
 751 CREATE TABLE acq.edi_message (
 752     id               SERIAL          PRIMARY KEY,
 753     account          INTEGER         REFERENCES acq.edi_account(id)
 754                                      DEFERRABLE INITIALLY DEFERRED,
 755     remote_file      TEXT,
 756     create_time      TIMESTAMPTZ     NOT NULL DEFAULT now(),
 757     translate_time   TIMESTAMPTZ,
 758     process_time     TIMESTAMPTZ,
 759     error_time       TIMESTAMPTZ,
 760     status           TEXT            NOT NULL DEFAULT 'new'
 761                                      CONSTRAINT status_value CHECK
 762                                      ( status IN (
 763                                         'new',          -- needs to be translated
 764                                         'translated',   -- needs to be processed
 765                                         'trans_error',  -- error in translation step
 766                                         'processed',    -- needs to have remote_file deleted
 767                                         'proc_error',   -- error in processing step
 768                                         'delete_error', -- error in deletion
 769                                                                                 'retry',        -- need to retry
 770                                         'complete'      -- done
 771                                      )),
 772     edi              TEXT,
 773     jedi             TEXT,
 774     error            TEXT,
 775     purchase_order   INT             REFERENCES acq.purchase_order
 776                                      DEFERRABLE INITIALLY DEFERRED,
 777         message_type     TEXT            NOT NULL CONSTRAINT valid_message_type CHECK
 778                                          ( message_type IN (
 779                                                                              'ORDERS',
 780                                                                              'ORDRSP',
 781                                                                              'INVOIC',
 782                                                                              'OSTENQ',
 783                                                                              'OSTRPT'
 784                                                                          ))
 785 );
 786 CREATE INDEX edi_message_account_status_idx ON acq.edi_message (account,status);
 787 CREATE INDEX edi_message_po_idx ON acq.edi_message (purchase_order);
 788
 789 -- Note below that the primary key is NOT a SERIAL type.  We will periodically truncate and rebuild
 790 -- the table, assigning ids programmatically instead of using a sequence.
 791 CREATE TABLE acq.debit_attribution (
 792     id                     INT         NOT NULL PRIMARY KEY,
 793     fund_debit             INT         NOT NULL
 794                                        REFERENCES acq.fund_debit
 795                                        DEFERRABLE INITIALLY DEFERRED,
 796     debit_amount           NUMERIC     NOT NULL,
 797     funding_source_credit  INT         REFERENCES acq.funding_source_credit
 798                                        DEFERRABLE INITIALLY DEFERRED,
 799     credit_amount          NUMERIC
 800 );
 801
 802 CREATE INDEX acq_attribution_debit_idx
 803     ON acq.debit_attribution( fund_debit );
 804
 805 CREATE INDEX acq_attribution_credit_idx
 806     ON acq.debit_attribution( funding_source_credit );
 807
 808 -- Invoicing
 809
 810 CREATE TABLE acq.invoice_method (
 811     code    TEXT    PRIMARY KEY,
 812     name    TEXT    NOT NULL -- i18n-ize
 813 );
 814
 815 CREATE TABLE acq.invoice_payment_method (
 816     code    TEXT    PRIMARY KEY,
 817     name    TEXT    NOT NULL -- i18n-ize
 818 );
 819
 820 CREATE TABLE acq.invoice (
 821     id          SERIAL      PRIMARY KEY,
 822     receiver    INT         NOT NULL REFERENCES actor.org_unit (id),
 823     provider    INT         NOT NULL REFERENCES acq.provider (id),
 824     shipper     INT         NOT NULL REFERENCES acq.provider (id),
 825     recv_date   TIMESTAMPTZ NOT NULL DEFAULT NOW(),
 826     recv_method TEXT        NOT NULL REFERENCES acq.invoice_method (code) DEFAULT 'EDI',
 827     inv_type    TEXT,       -- A "type" field is desired, but no idea what goes here
 828     inv_ident   TEXT        NOT NULL, -- vendor-supplied invoice id/number
 829         payment_auth TEXT,
 830         payment_method TEXT     REFERENCES acq.invoice_payment_method (code)
 831                                 DEFERRABLE INITIALLY DEFERRED,
 832         note        TEXT,
 833     complete    BOOL        NOT NULL DEFAULT FALSE,
 834     CONSTRAINT  inv_ident_once_per_provider UNIQUE(provider, inv_ident)
 835 );
 836
 837 CREATE TABLE acq.invoice_entry (
 838     id              SERIAL      PRIMARY KEY,
 839     invoice         INT         NOT NULL REFERENCES acq.invoice (id) ON DELETE CASCADE,
 840     purchase_order  INT         REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
 841     lineitem        INT         REFERENCES acq.lineitem (id) ON UPDATE CASCADE ON DELETE SET NULL,
 842     inv_item_count  INT         NOT NULL, -- How many acqlids did they say they sent
 843     phys_item_count INT, -- and how many did staff count
 844     note            TEXT,
 845     billed_per_item BOOL,
 846     cost_billed     NUMERIC(8,2),
 847     actual_cost     NUMERIC(8,2),
 848         amount_paid     NUMERIC (8,2)
 849 );
 850
 851 CREATE INDEX ie_inv_idx on acq.invoice_entry (invoice);
 852 CREATE INDEX ie_po_idx on acq.invoice_entry (purchase_order);
 853 CREATE INDEX ie_li_idx on acq.invoice_entry (lineitem);
 854
 855 ALTER TABLE acq.fund_debit
 856     ADD COLUMN invoice_entry INTEGER
 857         REFERENCES acq.invoice_entry (id)
 858         ON DELETE SET NULL;
 859
 860 CREATE TABLE acq.invoice_item_type (
 861     code    TEXT    PRIMARY KEY,
 862     name    TEXT    NOT NULL,  -- i18n-ize
 863         prorate BOOL    NOT NULL DEFAULT FALSE,
 864     blanket BOOL    NOT NULL DEFAULT FALSE,
 865     CONSTRAINT aiit_not_blanket_and_prorate
 866         CHECK (blanket IS FALSE OR prorate IS FALSE)
 867 );
 868
 869 CREATE TABLE acq.po_item (
 870         id              SERIAL      PRIMARY KEY,
 871         purchase_order  INT         REFERENCES acq.purchase_order (id)
 872                                     ON UPDATE CASCADE ON DELETE SET NULL
 873                                     DEFERRABLE INITIALLY DEFERRED,
 874         fund_debit      INT         REFERENCES acq.fund_debit (id)
 875                                     DEFERRABLE INITIALLY DEFERRED,
 876         inv_item_type   TEXT        NOT NULL
 877                                     REFERENCES acq.invoice_item_type (code)
 878                                     DEFERRABLE INITIALLY DEFERRED,
 879         title           TEXT,
 880         author          TEXT,
 881         note            TEXT,
 882         estimated_cost  NUMERIC(8,2),
 883         fund            INT         REFERENCES acq.fund (id)
 884                                     DEFERRABLE INITIALLY DEFERRED,
 885     target          BIGINT
 886 );
 887
 888 CREATE INDEX poi_po_idx ON acq.po_item (purchase_order);
 889
 890 CREATE TABLE acq.invoice_item ( -- for invoice-only debits: taxes/fees/non-bib items/etc
 891     id              SERIAL      PRIMARY KEY,
 892     invoice         INT         NOT NULL REFERENCES acq.invoice (id) ON UPDATE CASCADE ON DELETE CASCADE,
 893     purchase_order  INT         REFERENCES acq.purchase_order (id) ON UPDATE CASCADE ON DELETE SET NULL,
 894     fund_debit      INT         REFERENCES acq.fund_debit (id),
 895     inv_item_type   TEXT        NOT NULL REFERENCES acq.invoice_item_type (code),
 896     title           TEXT,
 897     author          TEXT,
 898     note            TEXT,
 899     cost_billed     NUMERIC(8,2),
 900     actual_cost     NUMERIC(8,2),
 901         fund            INT         REFERENCES acq.fund (id)
 902                                     DEFERRABLE INITIALLY DEFERRED,
 903         amount_paid     NUMERIC (8,2),
 904         po_item         INT         REFERENCES acq.po_item (id)
 905                                     DEFERRABLE INITIALLY DEFERRED,
 906     target          BIGINT
 907 );
 908
 909 CREATE INDEX ii_inv_idx on acq.invoice_item (invoice);
 910 CREATE INDEX ii_po_idx on acq.invoice_item (purchase_order);
 911 CREATE INDEX ii_poi_idx on acq.invoice_item (po_item);
 912
 913 -- Patron requests
 914 CREATE TABLE acq.user_request_type (
 915     id      SERIAL  PRIMARY KEY,
 916     label   TEXT    NOT NULL UNIQUE -- i18n-ize
 917 );
 918
 919 CREATE TABLE acq.user_request (
 920     id                  SERIAL  PRIMARY KEY,
 921     usr                 INT     NOT NULL REFERENCES actor.usr (id), -- requesting user
 922     hold                BOOL    NOT NULL DEFAULT TRUE,
 923
 924     pickup_lib          INT     NOT NULL REFERENCES actor.org_unit (id), -- pickup lib
 925     holdable_formats    TEXT,           -- nullable, for use in hold creation
 926     phone_notify        TEXT,
 927     email_notify        BOOL    NOT NULL DEFAULT TRUE,
 928     lineitem            INT     REFERENCES acq.lineitem (id) ON DELETE CASCADE,
 929     eg_bib              BIGINT  REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
 930     request_date        TIMESTAMPTZ NOT NULL DEFAULT NOW(), -- when they requested it
 931     need_before         TIMESTAMPTZ,    -- don't create holds after this
 932     max_fee             TEXT,
 933
 934     request_type        INT     NOT NULL REFERENCES acq.user_request_type (id),
 935     isxn                TEXT,
 936     title               TEXT,
 937     volume              TEXT,
 938     author              TEXT,
 939     article_title       TEXT,
 940     article_pages       TEXT,
 941     publisher           TEXT,
 942     location            TEXT,
 943     pubdate             TEXT,
 944     mentioned           TEXT,
 945     other_info          TEXT,
 946         cancel_reason       INT    REFERENCES acq.cancel_reason( id )
 947                                    DEFERRABLE INITIALLY DEFERRED
 948 );
 949
 950
 951 -- Functions
 952
 953 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
 954 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
 955 DECLARE
 956     counter INT;
 957     lida    acq.flat_lineitem_holding_subfield%ROWTYPE;
 958 BEGIN
 959
 960     SELECT  COUNT(*) INTO counter
 961       FROM  oils_xpath_table(
 962                 'id',
 963                 'marc',
 964                 'acq.lineitem',
 965                 '//*[@tag="' || tag || '"]',
 966                 'id=' || lineitem
 967             ) as t(i int,c text);
 968
 969     FOR i IN 1 .. counter LOOP
 970         FOR lida IN
 971             SELECT  *
 972               FROM  (   SELECT  id,i,t,v
 973                           FROM  oils_xpath_table(
 974                                     'id',
 975                                     'marc',
 976                                     'acq.lineitem',
 977                                     '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
 978                                         '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
 979                                     'id=' || lineitem
 980                                 ) as t(id int,t text,v text)
 981                     )x
 982         LOOP
 983             RETURN NEXT lida;
 984         END LOOP;
 985     END LOOP;
 986
 987     RETURN;
 988 END;
 989 $$ LANGUAGE PLPGSQL;
 990
 991 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
 992 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
 993 DECLARE
 994     prov_i  INT;
 995     tag_t   TEXT;
 996     lida    acq.flat_lineitem_detail%ROWTYPE;
 997 BEGIN
 998     SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
 999     IF NOT FOUND THEN RETURN; END IF;
1000
1001     SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
1002     IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
1003
1004     FOR lida IN
1005         SELECT  lineitem_i,
1006                 h.holding,
1007                 a.name,
1008                 h.data
1009           FROM  acq.extract_holding_attr_table( lineitem_i, tag_t ) h
1010                 JOIN acq.provider_holding_subfield_map a USING (subfield)
1011           WHERE a.provider = prov_i
1012     LOOP
1013         RETURN NEXT lida;
1014     END LOOP;
1015
1016     RETURN;
1017 END;
1018 $$ LANGUAGE PLPGSQL;
1019
1020 -- select * from acq.extract_provider_holding_data(699);
1021
1022 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
1023         SELECT extract_marc_field('acq.lineitem', $1, $2, $3);
1024 $$ LANGUAGE SQL;
1025
1026 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field_set ( BIGINT, TEXT, TEXT) RETURNS SETOF TEXT AS $$
1027         SELECT extract_marc_field_set('acq.lineitem', $1, $2, $3);
1028 $$ LANGUAGE SQL;
1029
1030
1031 /*
1032 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1033         SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
1034 $$ LANGUAGE SQL;
1035
1036 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
1037         SELECT public.extract_marc_field('authority.record_entry', $1, $2);
1038 $$ LANGUAGE SQL;
1039 */
1040 -- For example:
1041 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
1042
1043 /*
1044 Suggested vendor fields:
1045         vendor_price
1046         vendor_currency
1047         vendor_avail
1048         vendor_po
1049         vendor_identifier
1050 */
1051
1052 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $function$
1053 DECLARE
1054         value           TEXT;
1055         atype           TEXT;
1056         prov            INT;
1057         pos             INT;
1058         adef            RECORD;
1059         xpath_string    TEXT;
1060 BEGIN
1061         FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
1062
1063                 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
1064
1065                 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
1066                         IF (atype = 'lineitem_provider_attr_definition') THEN
1067                                 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1068                                 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
1069                         END IF;
1070
1071                         IF (atype = 'lineitem_provider_attr_definition') THEN
1072                                 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
1073                         ELSIF (atype = 'lineitem_marc_attr_definition') THEN
1074                                 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
1075                         ELSIF (atype = 'lineitem_generated_attr_definition') THEN
1076                                 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
1077                         END IF;
1078
1079             xpath_string := REGEXP_REPLACE(xpath_string,$re$//?text\(\)$$re$,'');
1080
1081             IF (adef.code = 'title' OR adef.code = 'author') THEN
1082                 -- title and author should not be split
1083                 -- FIXME: once oils_xpath can grok XPATH 2.0 functions, we can use
1084                 -- string-join in the xpath and remove this special case
1085                         SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
1086                         IF (value IS NOT NULL AND value <> '') THEN
1087                                     INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
1088                                     VALUES (NEW.id, adef.id, atype, adef.code, value);
1089                 END IF;
1090             ELSE
1091                 pos := 1;
1092                 LOOP
1093                     -- each application of the regex may produce multiple values
1094                     FOR value IN
1095                         SELECT * FROM extract_acq_marc_field_set(
1096                             NEW.id, xpath_string || '[' || pos || ']', adef.remove)
1097                         LOOP
1098
1099                         IF (value IS NOT NULL AND value <> '') THEN
1100                             INSERT INTO acq.lineitem_attr
1101                                 (lineitem, definition, attr_type, attr_name, attr_value)
1102                                 VALUES (NEW.id, adef.id, atype, adef.code, value);
1103                         ELSE
1104                             EXIT;
1105                         END IF;
1106                     END LOOP;
1107                     IF NOT FOUND THEN
1108                         EXIT;
1109                     END IF;
1110                     pos := pos + 1;
1111                END LOOP;
1112             END IF;
1113
1114                 END IF;
1115
1116         END LOOP;
1117
1118         RETURN NULL;
1119 END;
1120 $function$ LANGUAGE PLPGSQL;
1121
1122 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
1123 BEGIN
1124         IF TG_OP = 'UPDATE' THEN
1125                 DELETE FROM acq.lineitem_attr
1126                         WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
1127                 RETURN NEW;
1128         ELSE
1129                 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
1130                 RETURN OLD;
1131         END IF;
1132 END;
1133 $$ LANGUAGE PLPGSQL;
1134
1135 CREATE TRIGGER cleanup_lineitem_trigger
1136         BEFORE UPDATE OR DELETE ON acq.lineitem
1137         FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
1138
1139 CREATE TRIGGER ingest_lineitem_trigger
1140         AFTER INSERT OR UPDATE ON acq.lineitem
1141         FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
1142
1143 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
1144 DECLARE
1145     rat NUMERIC;
1146 BEGIN
1147     IF from_ex = to_ex THEN
1148         RETURN 1.0;
1149     END IF;
1150
1151     SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
1152
1153     IF FOUND THEN
1154         RETURN rat;
1155     ELSE
1156         SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
1157         IF FOUND THEN
1158             RETURN 1.0/rat;
1159         END IF;
1160     END IF;
1161
1162     RETURN NULL;
1163
1164 END;
1165 $$ LANGUAGE PLPGSQL;
1166
1167 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
1168     SELECT $3 * acq.exchange_ratio($1, $2);
1169 $$ LANGUAGE SQL;
1170
1171 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
1172 /*
1173         Examine the acq.fiscal_year table, comparing successive years.
1174         Report any inconsistencies, i.e. years that overlap, have gaps
1175     between them, or are out of sequence.
1176 */
1177 RETURNS SETOF RECORD AS $$
1178 DECLARE
1179         first_row  BOOLEAN;
1180         curr_year  RECORD;
1181         prev_year  RECORD;
1182         return_rec RECORD;
1183 BEGIN
1184         first_row := true;
1185         FOR curr_year in
1186                 SELECT
1187                         id,
1188                         calendar,
1189                         year,
1190                         year_begin,
1191                         year_end
1192                 FROM
1193                         acq.fiscal_year
1194                 ORDER BY
1195                         calendar,
1196                         year_begin
1197         LOOP
1198                 --
1199                 IF first_row THEN
1200                         first_row := FALSE;
1201                 ELSIF curr_year.calendar    = prev_year.calendar THEN
1202                         IF curr_year.year_begin > prev_year.year_end THEN
1203                                 -- This ugly kludge works around the fact that older
1204                                 -- versions of PostgreSQL don't support RETURN QUERY SELECT
1205                                 FOR return_rec IN SELECT
1206                                         prev_year.id,
1207                                         prev_year.year,
1208                                         'Gap between fiscal years'::TEXT
1209                                 LOOP
1210                                         RETURN NEXT return_rec;
1211                                 END LOOP;
1212                         ELSIF curr_year.year_begin < prev_year.year_end THEN
1213                                 FOR return_rec IN SELECT
1214                                         prev_year.id,
1215                                         prev_year.year,
1216                                         'Overlapping fiscal years'::TEXT
1217                                 LOOP
1218                                         RETURN NEXT return_rec;
1219                                 END LOOP;
1220                         ELSIF curr_year.year < prev_year.year THEN
1221                                 FOR return_rec IN SELECT
1222                                         prev_year.id,
1223                                         prev_year.year,
1224                                         'Fiscal years out of order'::TEXT
1225                                 LOOP
1226                                         RETURN NEXT return_rec;
1227                                 END LOOP;
1228                         END IF;
1229                 END IF;
1230                 --
1231                 prev_year := curr_year;
1232         END LOOP;
1233         --
1234         RETURN;
1235 END;
1236 $$ LANGUAGE plpgsql;
1237
1238 CREATE OR REPLACE FUNCTION acq.transfer_fund(
1239         old_fund   IN INT,
1240         old_amount IN NUMERIC,     -- in currency of old fund
1241         new_fund   IN INT,
1242         new_amount IN NUMERIC,     -- in currency of new fund
1243         user_id    IN INT,
1244         xfer_note  IN TEXT         -- to be recorded in acq.fund_transfer
1245         -- ,funding_source_in IN INT  -- if user wants to specify a funding source (see notes)
1246 ) RETURNS VOID AS $$
1247 /* -------------------------------------------------------------------------------
1248
1249 Function to transfer money from one fund to another.
1250
1251 A transfer is represented as a pair of entries in acq.fund_allocation, with a
1252 negative amount for the old (losing) fund and a positive amount for the new
1253 (gaining) fund.  In some cases there may be more than one such pair of entries
1254 in order to pull the money from different funding sources, or more specifically
1255 from different funding source credits.  For each such pair there is also an
1256 entry in acq.fund_transfer.
1257
1258 Since funding_source is a non-nullable column in acq.fund_allocation, we must
1259 choose a funding source for the transferred money to come from.  This choice
1260 must meet two constraints, so far as possible:
1261
1262 1. The amount transferred from a given funding source must not exceed the
1263 amount allocated to the old fund by the funding source.  To that end we
1264 compare the amount being transferred to the amount allocated.
1265
1266 2. We shouldn't transfer money that has already been spent or encumbered, as
1267 defined by the funding attribution process.  We attribute expenses to the
1268 oldest funding source credits first.  In order to avoid transferring that
1269 attributed money, we reverse the priority, transferring from the newest funding
1270 source credits first.  There can be no guarantee that this approach will
1271 avoid overcommitting a fund, but no other approach can do any better.
1272
1273 In this context the age of a funding source credit is defined by the
1274 deadline_date for credits with deadline_dates, and by the effective_date for
1275 credits without deadline_dates, with the proviso that credits with deadline_dates
1276 are all considered "older" than those without.
1277
1278 ----------
1279
1280 In the signature for this function, there is one last parameter commented out,
1281 named "funding_source_in".  Correspondingly, the WHERE clause for the query
1282 driving the main loop has an OR clause commented out, which references the
1283 funding_source_in parameter.
1284
1285 If these lines are uncommented, this function will allow the user optionally to
1286 restrict a fund transfer to a specified funding source.  If the source
1287 parameter is left NULL, then there will be no such restriction.
1288
1289 ------------------------------------------------------------------------------- */
1290 DECLARE
1291         same_currency      BOOLEAN;
1292         currency_ratio     NUMERIC;
1293         old_fund_currency  TEXT;
1294         old_remaining      NUMERIC;  -- in currency of old fund
1295         new_fund_currency  TEXT;
1296         new_fund_active    BOOLEAN;
1297         new_remaining      NUMERIC;  -- in currency of new fund
1298         curr_old_amt       NUMERIC;  -- in currency of old fund
1299         curr_new_amt       NUMERIC;  -- in currency of new fund
1300         source_addition    NUMERIC;  -- in currency of funding source
1301         source_deduction   NUMERIC;  -- in currency of funding source
1302         orig_allocated_amt NUMERIC;  -- in currency of funding source
1303         allocated_amt      NUMERIC;  -- in currency of fund
1304         source             RECORD;
1305 BEGIN
1306         --
1307         -- Sanity checks
1308         --
1309         IF old_fund IS NULL THEN
1310                 RAISE EXCEPTION 'acq.transfer_fund: old fund id is NULL';
1311         END IF;
1312         --
1313         IF old_amount IS NULL THEN
1314                 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer is NULL';
1315         END IF;
1316         --
1317         -- The new fund and its amount must be both NULL or both not NULL.
1318         --
1319         IF new_fund IS NOT NULL AND new_amount IS NULL THEN
1320                 RAISE EXCEPTION 'acq.transfer_fund: amount to transfer to receiving fund is NULL';
1321         END IF;
1322         --
1323         IF new_fund IS NULL AND new_amount IS NOT NULL THEN
1324                 RAISE EXCEPTION 'acq.transfer_fund: receiving fund is NULL, its amount is not NULL';
1325         END IF;
1326         --
1327         IF user_id IS NULL THEN
1328                 RAISE EXCEPTION 'acq.transfer_fund: user id is NULL';
1329         END IF;
1330         --
1331         -- Initialize the amounts to be transferred, each denominated
1332         -- in the currency of its respective fund.  They will be
1333         -- reduced on each iteration of the loop.
1334         --
1335         old_remaining := old_amount;
1336         new_remaining := new_amount;
1337         --
1338         -- RAISE NOTICE 'Transferring % in fund % to % in fund %',
1339         --      old_amount, old_fund, new_amount, new_fund;
1340         --
1341         -- Get the currency types of the old and new funds.
1342         --
1343         SELECT
1344                 currency_type
1345         INTO
1346                 old_fund_currency
1347         FROM
1348                 acq.fund
1349         WHERE
1350                 id = old_fund;
1351         --
1352         IF old_fund_currency IS NULL THEN
1353                 RAISE EXCEPTION 'acq.transfer_fund: old fund id % is not defined', old_fund;
1354         END IF;
1355         --
1356         IF new_fund IS NOT NULL THEN
1357                 SELECT
1358                         currency_type,
1359                         active
1360                 INTO
1361                         new_fund_currency,
1362                         new_fund_active
1363                 FROM
1364                         acq.fund
1365                 WHERE
1366                         id = new_fund;
1367                 --
1368                 IF new_fund_currency IS NULL THEN
1369                         RAISE EXCEPTION 'acq.transfer_fund: new fund id % is not defined', new_fund;
1370                 ELSIF NOT new_fund_active THEN
1371                         --
1372                         -- No point in putting money into a fund from whence you can't spend it
1373                         --
1374                         RAISE EXCEPTION 'acq.transfer_fund: new fund id % is inactive', new_fund;
1375                 END IF;
1376                 --
1377                 IF new_amount = old_amount THEN
1378                         same_currency := true;
1379                         currency_ratio := 1;
1380                 ELSE
1381                         --
1382                         -- We'll have to translate currency between funds.  We presume that
1383                         -- the calling code has already applied an appropriate exchange rate,
1384                         -- so we'll apply the same conversion to each sub-transfer.
1385                         --
1386                         same_currency := false;
1387                         currency_ratio := new_amount / old_amount;
1388                 END IF;
1389         END IF;
1390         --
1391         -- Identify the funding source(s) from which we want to transfer the money.
1392         -- The principle is that we want to transfer the newest money first, because
1393         -- we spend the oldest money first.  The priority for spending is defined
1394         -- by a sort of the view acq.ordered_funding_source_credit.
1395         --
1396         FOR source in
1397                 SELECT
1398                         ofsc.id,
1399                         ofsc.funding_source,
1400                         ofsc.amount,
1401                         ofsc.amount * acq.exchange_ratio( fs.currency_type, old_fund_currency )
1402                                 AS converted_amt,
1403                         fs.currency_type
1404                 FROM
1405                         acq.ordered_funding_source_credit AS ofsc,
1406                         acq.funding_source fs
1407                 WHERE
1408                         ofsc.funding_source = fs.id
1409                         and ofsc.funding_source IN
1410                         (
1411                                 SELECT funding_source
1412                                 FROM acq.fund_allocation
1413                                 WHERE fund = old_fund
1414                         )
1415                         -- and
1416                         -- (
1417                         --      ofsc.funding_source = funding_source_in
1418                         --      OR funding_source_in IS NULL
1419                         -- )
1420                 ORDER BY
1421                         ofsc.sort_priority desc,
1422                         ofsc.sort_date desc,
1423                         ofsc.id desc
1424         LOOP
1425                 --
1426                 -- Determine how much money the old fund got from this funding source,
1427                 -- denominated in the currency types of the source and of the fund.
1428                 -- This result may reflect transfers from previous iterations.
1429                 --
1430                 SELECT
1431                         COALESCE( sum( amount ), 0 ),
1432                         COALESCE( sum( amount )
1433                                 * acq.exchange_ratio( source.currency_type, old_fund_currency ), 0 )
1434                 INTO
1435                         orig_allocated_amt,     -- in currency of the source
1436                         allocated_amt           -- in currency of the old fund
1437                 FROM
1438                         acq.fund_allocation
1439                 WHERE
1440                         fund = old_fund
1441                         and funding_source = source.funding_source;
1442                 --
1443                 -- Determine how much to transfer from this credit, in the currency
1444                 -- of the fund.   Begin with the amount remaining to be attributed:
1445                 --
1446                 curr_old_amt := old_remaining;
1447                 --
1448                 -- Can't attribute more than was allocated from the fund:
1449                 --
1450                 IF curr_old_amt > allocated_amt THEN
1451                         curr_old_amt := allocated_amt;
1452                 END IF;
1453                 --
1454                 -- Can't attribute more than the amount of the current credit:
1455                 --
1456                 IF curr_old_amt > source.converted_amt THEN
1457                         curr_old_amt := source.converted_amt;
1458                 END IF;
1459                 --
1460                 curr_old_amt := trunc( curr_old_amt, 2 );
1461                 --
1462                 old_remaining := old_remaining - curr_old_amt;
1463                 --
1464                 -- Determine the amount to be deducted, if any,
1465                 -- from the old allocation.
1466                 --
1467                 IF old_remaining > 0 THEN
1468                         --
1469                         -- In this case we're using the whole allocation, so use that
1470                         -- amount directly instead of applying a currency translation
1471                         -- and thereby inviting round-off errors.
1472                         --
1473                         source_deduction := - curr_old_amt;
1474                 ELSE
1475                         source_deduction := trunc(
1476                                 ( - curr_old_amt ) *
1477                                         acq.exchange_ratio( old_fund_currency, source.currency_type ),
1478                                 2 );
1479                 END IF;
1480                 --
1481                 IF source_deduction <> 0 THEN
1482                         --
1483                         -- Insert negative allocation for old fund in fund_allocation,
1484                         -- converted into the currency of the funding source
1485                         --
1486                         INSERT INTO acq.fund_allocation (
1487                                 funding_source,
1488                                 fund,
1489                                 amount,
1490                                 allocator,
1491                                 note
1492                         ) VALUES (
1493                                 source.funding_source,
1494                                 old_fund,
1495                                 source_deduction,
1496                                 user_id,
1497                                 'Transfer to fund ' || new_fund
1498                         );
1499                 END IF;
1500                 --
1501                 IF new_fund IS NOT NULL THEN
1502                         --
1503                         -- Determine how much to add to the new fund, in
1504                         -- its currency, and how much remains to be added:
1505                         --
1506                         IF same_currency THEN
1507                                 curr_new_amt := curr_old_amt;
1508                         ELSE
1509                                 IF old_remaining = 0 THEN
1510                                         --
1511                                         -- This is the last iteration, so nothing should be left
1512                                         --
1513                                         curr_new_amt := new_remaining;
1514                                         new_remaining := 0;
1515                                 ELSE
1516                                         curr_new_amt := trunc( curr_old_amt * currency_ratio, 2 );
1517                                         new_remaining := new_remaining - curr_new_amt;
1518                                 END IF;
1519                         END IF;
1520                         --
1521                         -- Determine how much to add, if any,
1522                         -- to the new fund's allocation.
1523                         --
1524                         IF old_remaining > 0 THEN
1525                                 --
1526                                 -- In this case we're using the whole allocation, so use that amount
1527                                 -- amount directly instead of applying a currency translation and
1528                                 -- thereby inviting round-off errors.
1529                                 --
1530                                 source_addition := curr_new_amt;
1531                         ELSIF source.currency_type = old_fund_currency THEN
1532                                 --
1533                                 -- In this case we don't need a round trip currency translation,
1534                                 -- thereby inviting round-off errors:
1535                                 --
1536                                 source_addition := curr_old_amt;
1537                         ELSE
1538                                 source_addition := trunc(
1539                                         curr_new_amt *
1540                                                 acq.exchange_ratio( new_fund_currency, source.currency_type ),
1541                                         2 );
1542                         END IF;
1543                         --
1544                         IF source_addition <> 0 THEN
1545                                 --
1546                                 -- Insert positive allocation for new fund in fund_allocation,
1547                                 -- converted to the currency of the founding source
1548                                 --
1549                                 INSERT INTO acq.fund_allocation (
1550                                         funding_source,
1551                                         fund,
1552                                         amount,
1553                                         allocator,
1554                                         note
1555                                 ) VALUES (
1556                                         source.funding_source,
1557                                         new_fund,
1558                                         source_addition,
1559                                         user_id,
1560                                         'Transfer from fund ' || old_fund
1561                                 );
1562                         END IF;
1563                 END IF;
1564                 --
1565                 IF trunc( curr_old_amt, 2 ) <> 0
1566                 OR trunc( curr_new_amt, 2 ) <> 0 THEN
1567                         --
1568                         -- Insert row in fund_transfer, using amounts in the currency of the funds
1569                         --
1570                         INSERT INTO acq.fund_transfer (
1571                                 src_fund,
1572                                 src_amount,
1573                                 dest_fund,
1574                                 dest_amount,
1575                                 transfer_user,
1576                                 note,
1577                                 funding_source_credit
1578                         ) VALUES (
1579                                 old_fund,
1580                                 trunc( curr_old_amt, 2 ),
1581                                 new_fund,
1582                                 trunc( curr_new_amt, 2 ),
1583                                 user_id,
1584                                 xfer_note,
1585                                 source.id
1586                         );
1587                 END IF;
1588                 --
1589                 if old_remaining <= 0 THEN
1590                         EXIT;                   -- Nothing more to be transferred
1591                 END IF;
1592         END LOOP;
1593 END;
1594 $$ LANGUAGE plpgsql;
1595
1596 CREATE OR REPLACE FUNCTION acq.attribute_debits() RETURNS VOID AS $$
1597 /*
1598 Function to attribute expenditures and encumbrances to funding source credits,
1599 and thereby to funding sources.
1600
1601 Read the debits in chonological order, attributing each one to one or
1602 more funding source credits.  Constraints:
1603
1604 1. Don't attribute more to a credit than the amount of the credit.
1605
1606 2. For a given fund, don't attribute more to a funding source than the
1607 source has allocated to that fund.
1608
1609 3. Attribute debits to credits with deadlines before attributing them to
1610 credits without deadlines.  Otherwise attribute to the earliest credits
1611 first, based on the deadline date when present, or on the effective date
1612 when there is no deadline.  Use funding_source_credit.id as a tie-breaker.
1613 This ordering is defined by an ORDER BY clause on the view
1614 acq.ordered_funding_source_credit.
1615
1616 Start by truncating the table acq.debit_attribution.  Then insert a row
1617 into that table for each attribution.  If a debit cannot be fully
1618 attributed, insert a row for the unattributable balance, with the
1619 funding_source_credit and credit_amount columns NULL.
1620 */
1621 DECLARE
1622         curr_fund_source_bal RECORD;
1623         seqno                INT;     -- sequence num for credits applicable to a fund
1624         fund_credit          RECORD;  -- current row in temp t_fund_credit table
1625         fc                   RECORD;  -- used for loading t_fund_credit table
1626         sc                   RECORD;  -- used for loading t_fund_credit table
1627         --
1628         -- Used exclusively in the main loop:
1629         --
1630         deb                 RECORD;   -- current row from acq.fund_debit table
1631         curr_credit_bal     RECORD;   -- current row from temp t_credit table
1632         debit_balance       NUMERIC;  -- amount left to attribute for current debit
1633         conv_debit_balance  NUMERIC;  -- debit balance in currency of the fund
1634         attr_amount         NUMERIC;  -- amount being attributed, in currency of debit
1635         conv_attr_amount    NUMERIC;  -- amount being attributed, in currency of source
1636         conv_cred_balance   NUMERIC;  -- credit_balance in the currency of the fund
1637         conv_alloc_balance  NUMERIC;  -- allocated balance in the currency of the fund
1638         attrib_count        INT;      -- populates id of acq.debit_attribution
1639 BEGIN
1640         --
1641         -- Load a temporary table.  For each combination of fund and funding source,
1642         -- load an entry with the total amount allocated to that fund by that source.
1643         -- This sum may reflect transfers as well as original allocations.  We will
1644         -- reduce this balance whenever we attribute debits to it.
1645         --
1646         CREATE TEMP TABLE t_fund_source_bal
1647         ON COMMIT DROP AS
1648                 SELECT
1649                         fund AS fund,
1650                         funding_source AS source,
1651                         sum( amount ) AS balance
1652                 FROM
1653                         acq.fund_allocation
1654                 GROUP BY
1655                         fund,
1656                         funding_source
1657                 HAVING
1658                         sum( amount ) > 0;
1659         --
1660         CREATE INDEX t_fund_source_bal_idx
1661                 ON t_fund_source_bal( fund, source );
1662         -------------------------------------------------------------------------------
1663         --
1664         -- Load another temporary table.  For each fund, load zero or more
1665         -- funding source credits from which that fund can get money.
1666         --
1667         CREATE TEMP TABLE t_fund_credit (
1668                 fund        INT,
1669                 seq         INT,
1670                 credit      INT
1671         ) ON COMMIT DROP;
1672         --
1673         FOR fc IN
1674                 SELECT DISTINCT fund
1675                 FROM acq.fund_allocation
1676                 ORDER BY fund
1677         LOOP                  -- Loop over the funds
1678                 seqno := 1;
1679                 FOR sc IN
1680                         SELECT
1681                                 ofsc.id
1682                         FROM
1683                                 acq.ordered_funding_source_credit AS ofsc
1684                         WHERE
1685                                 ofsc.funding_source IN
1686                                 (
1687                                         SELECT funding_source
1688                                         FROM acq.fund_allocation
1689                                         WHERE fund = fc.fund
1690                                 )
1691                 ORDER BY
1692                     ofsc.sort_priority,
1693                     ofsc.sort_date,
1694                     ofsc.id
1695                 LOOP                        -- Add each credit to the list
1696                         INSERT INTO t_fund_credit (
1697                                 fund,
1698                                 seq,
1699                                 credit
1700                         ) VALUES (
1701                                 fc.fund,
1702                                 seqno,
1703                                 sc.id
1704                         );
1705                         --RAISE NOTICE 'Fund % credit %', fc.fund, sc.id;
1706                         seqno := seqno + 1;
1707                 END LOOP;     -- Loop over credits for a given fund
1708         END LOOP;         -- Loop over funds
1709         --
1710         CREATE INDEX t_fund_credit_idx
1711                 ON t_fund_credit( fund, seq );
1712         -------------------------------------------------------------------------------
1713         --
1714         -- Load yet another temporary table.  This one is a list of funding source
1715         -- credits, with their balances.  We shall reduce those balances as we
1716         -- attribute debits to them.
1717         --
1718         CREATE TEMP TABLE t_credit
1719         ON COMMIT DROP AS
1720         SELECT
1721             fsc.id AS credit,
1722             fsc.funding_source AS source,
1723             fsc.amount AS balance,
1724             fs.currency_type AS currency_type
1725         FROM
1726             acq.funding_source_credit AS fsc,
1727             acq.funding_source fs
1728         WHERE
1729             fsc.funding_source = fs.id
1730                         AND fsc.amount > 0;
1731         --
1732         CREATE INDEX t_credit_idx
1733                 ON t_credit( credit );
1734         --
1735         -------------------------------------------------------------------------------
1736         --
1737         -- Now that we have loaded the lookup tables: loop through the debits,
1738         -- attributing each one to one or more funding source credits.
1739         --
1740         truncate table acq.debit_attribution;
1741         --
1742         attrib_count := 0;
1743         FOR deb in
1744                 SELECT
1745                         fd.id,
1746                         fd.fund,
1747                         fd.amount,
1748                         f.currency_type,
1749                         fd.encumbrance
1750                 FROM
1751                         acq.fund_debit fd,
1752                         acq.fund f
1753                 WHERE
1754                         fd.fund = f.id
1755                 ORDER BY
1756                         fd.id
1757         LOOP
1758                 --RAISE NOTICE 'Debit %, fund %', deb.id, deb.fund;
1759                 --
1760                 debit_balance := deb.amount;
1761                 --
1762                 -- Loop over the funding source credits that are eligible
1763                 -- to pay for this debit
1764                 --
1765                 FOR fund_credit IN
1766                         SELECT
1767                                 credit
1768                         FROM
1769                                 t_fund_credit
1770                         WHERE
1771                                 fund = deb.fund
1772                         ORDER BY
1773                                 seq
1774                 LOOP
1775                         --RAISE NOTICE '   Examining credit %', fund_credit.credit;
1776                         --
1777                         -- Look up the balance for this credit.  If it's zero, then
1778                         -- it's not useful, so treat it as if you didn't find it.
1779                         -- (Actually there shouldn't be any zero balances in the table,
1780                         -- but we check just to make sure.)
1781                         --
1782                         SELECT *
1783                         INTO curr_credit_bal
1784                         FROM t_credit
1785                         WHERE
1786                                 credit = fund_credit.credit
1787                                 AND balance > 0;
1788                         --
1789                         IF curr_credit_bal IS NULL THEN
1790                                 --
1791                                 -- This credit is exhausted; try the next one.
1792                                 --
1793                                 CONTINUE;
1794                         END IF;
1795                         --
1796                         --
1797                         -- At this point we have an applicable credit with some money left.
1798                         -- Now see if the relevant funding_source has any money left.
1799                         --
1800                         -- Look up the balance of the allocation for this combination of
1801                         -- fund and source.  If you find such an entry, but it has a zero
1802                         -- balance, then it's not useful, so treat it as unfound.
1803                         -- (Actually there shouldn't be any zero balances in the table,
1804                         -- but we check just to make sure.)
1805                         --
1806                         SELECT *
1807                         INTO curr_fund_source_bal
1808                         FROM t_fund_source_bal
1809                         WHERE
1810                                 fund = deb.fund
1811                                 AND source = curr_credit_bal.source
1812                                 AND balance > 0;
1813                         --
1814                         IF curr_fund_source_bal IS NULL THEN
1815                                 --
1816                                 -- This fund/source doesn't exist or is already exhausted,
1817                                 -- so we can't use this credit.  Go on to the next one.
1818                                 --
1819                                 CONTINUE;
1820                         END IF;
1821                         --
1822                         -- Convert the available balances to the currency of the fund
1823                         --
1824                         conv_alloc_balance := curr_fund_source_bal.balance * acq.exchange_ratio(
1825                                 curr_credit_bal.currency_type, deb.currency_type );
1826                         conv_cred_balance := curr_credit_bal.balance * acq.exchange_ratio(
1827                                 curr_credit_bal.currency_type, deb.currency_type );
1828                         --
1829                         -- Determine how much we can attribute to this credit: the minimum
1830                         -- of the debit amount, the fund/source balance, and the
1831                         -- credit balance
1832                         --
1833                         --RAISE NOTICE '   deb bal %', debit_balance;
1834                         --RAISE NOTICE '      source % balance %', curr_credit_bal.source, conv_alloc_balance;
1835                         --RAISE NOTICE '      credit % balance %', curr_credit_bal.credit, conv_cred_balance;
1836                         --
1837                         conv_attr_amount := NULL;
1838                         attr_amount := debit_balance;
1839                         --
1840                         IF attr_amount > conv_alloc_balance THEN
1841                                 attr_amount := conv_alloc_balance;
1842                                 conv_attr_amount := curr_fund_source_bal.balance;
1843                         END IF;
1844                         IF attr_amount > conv_cred_balance THEN
1845                                 attr_amount := conv_cred_balance;
1846                                 conv_attr_amount := curr_credit_bal.balance;
1847                         END IF;
1848                         --
1849                         -- If we're attributing all of one of the balances, then that's how
1850                         -- much we will deduct from the balances, and we already captured
1851                         -- that amount above.  Otherwise we must convert the amount of the
1852                         -- attribution from the currency of the fund back to the currency of
1853                         -- the funding source.
1854                         --
1855                         IF conv_attr_amount IS NULL THEN
1856                                 conv_attr_amount := attr_amount * acq.exchange_ratio(
1857                                         deb.currency_type, curr_credit_bal.currency_type );
1858                         END IF;
1859                         --
1860                         -- Insert a row to record the attribution
1861                         --
1862                         attrib_count := attrib_count + 1;
1863                         INSERT INTO acq.debit_attribution (
1864                                 id,
1865                                 fund_debit,
1866                                 debit_amount,
1867                                 funding_source_credit,
1868                                 credit_amount
1869                         ) VALUES (
1870                                 attrib_count,
1871                                 deb.id,
1872                                 attr_amount,
1873                                 curr_credit_bal.credit,
1874                                 conv_attr_amount
1875                         );
1876                         --
1877                         -- Subtract the attributed amount from the various balances
1878                         --
1879                         debit_balance := debit_balance - attr_amount;
1880                         curr_fund_source_bal.balance := curr_fund_source_bal.balance - conv_attr_amount;
1881                         --
1882                         IF curr_fund_source_bal.balance <= 0 THEN
1883                                 --
1884                                 -- This allocation is exhausted.  Delete it so
1885                                 -- that we don't waste time looking at it again.
1886                                 --
1887                                 DELETE FROM t_fund_source_bal
1888                                 WHERE
1889                                         fund = curr_fund_source_bal.fund
1890                                         AND source = curr_fund_source_bal.source;
1891                         ELSE
1892                                 UPDATE t_fund_source_bal
1893                                 SET balance = balance - conv_attr_amount
1894                                 WHERE
1895                                         fund = curr_fund_source_bal.fund
1896                                         AND source = curr_fund_source_bal.source;
1897                         END IF;
1898                         --
1899                         IF curr_credit_bal.balance <= 0 THEN
1900                                 --
1901                                 -- This funding source credit is exhausted.  Delete it
1902                                 -- so that we don't waste time looking at it again.
1903                                 --
1904                                 --DELETE FROM t_credit
1905                                 --WHERE
1906                                 --      credit = curr_credit_bal.credit;
1907                                 --
1908                                 DELETE FROM t_fund_credit
1909                                 WHERE
1910                                         credit = curr_credit_bal.credit;
1911                         ELSE
1912                                 UPDATE t_credit
1913                                 SET balance = curr_credit_bal.balance
1914                                 WHERE
1915                                         credit = curr_credit_bal.credit;
1916                         END IF;
1917                         --
1918                         -- Are we done with this debit yet?
1919                         --
1920                         IF debit_balance <= 0 THEN
1921                                 EXIT;       -- We've fully attributed this debit; stop looking at credits.
1922                         END IF;
1923                 END LOOP;       -- End loop over credits
1924                 --
1925                 IF debit_balance <> 0 THEN
1926                         --
1927                         -- We weren't able to attribute this debit, or at least not
1928                         -- all of it.  Insert a row for the unattributed balance.
1929                         --
1930                         attrib_count := attrib_count + 1;
1931                         INSERT INTO acq.debit_attribution (
1932                                 id,
1933                                 fund_debit,
1934                                 debit_amount,
1935                                 funding_source_credit,
1936                                 credit_amount
1937                         ) VALUES (
1938                                 attrib_count,
1939                                 deb.id,
1940                                 debit_balance,
1941                                 NULL,
1942                                 NULL
1943                         );
1944                 END IF;
1945         END LOOP;   -- End of loop over debits
1946 END;
1947 $$ LANGUAGE 'plpgsql';
1948
1949 CREATE OR REPLACE FUNCTION acq.copy_fund_tags(
1950         old_fund_id INTEGER,
1951         new_fund_id INTEGER
1952 ) RETURNS VOID AS $$
1953 DECLARE
1954 fund_tag_rec    RECORD;
1955 BEGIN
1956
1957         FOR fund_tag_rec IN SELECT * FROM acq.fund_tag_map WHERE fund=old_fund_id LOOP
1958                 BEGIN
1959                      INSERT INTO acq.fund_tag_map(fund, tag) VALUES(new_fund_id, fund_tag_rec.tag);
1960                 EXCEPTION
1961                         WHEN unique_violation THEN
1962                         --    RAISE NOTICE 'Fund tag already propagated', old_fund.id;
1963                         CONTINUE;
1964                 END;
1965         END LOOP;
1966         RETURN;
1967 END;
1968 $$ LANGUAGE plpgsql;
1969
1970 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_tree(
1971         old_year INTEGER,
1972         user_id INTEGER,
1973         org_unit_id INTEGER,
1974     include_desc BOOL DEFAULT TRUE
1975 ) RETURNS VOID AS $$
1976 DECLARE
1977 --
1978 new_id      INT;
1979 old_fund    RECORD;
1980 org_found   BOOLEAN;
1981 --
1982 BEGIN
1983         --
1984         -- Sanity checks
1985         --
1986         IF old_year IS NULL THEN
1987                 RAISE EXCEPTION 'Input year argument is NULL';
1988         ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
1989                 RAISE EXCEPTION 'Input year is out of range';
1990         END IF;
1991         --
1992         IF user_id IS NULL THEN
1993                 RAISE EXCEPTION 'Input user id argument is NULL';
1994         END IF;
1995         --
1996         IF org_unit_id IS NULL THEN
1997                 RAISE EXCEPTION 'Org unit id argument is NULL';
1998         ELSE
1999                 SELECT TRUE INTO org_found
2000                 FROM actor.org_unit
2001                 WHERE id = org_unit_id;
2002                 --
2003                 IF org_found IS NULL THEN
2004                         RAISE EXCEPTION 'Org unit id is invalid';
2005                 END IF;
2006         END IF;
2007         --
2008         -- Loop over the applicable funds
2009         --
2010         FOR old_fund in SELECT * FROM acq.fund
2011         WHERE
2012                 year = old_year
2013                 AND propagate
2014                 AND ( ( include_desc AND org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2015                 OR (NOT include_desc AND org = org_unit_id ) )
2016
2017         LOOP
2018                 BEGIN
2019                         INSERT INTO acq.fund (
2020                                 org,
2021                                 name,
2022                                 year,
2023                                 currency_type,
2024                                 code,
2025                                 rollover,
2026                                 propagate,
2027                                 balance_warning_percent,
2028                                 balance_stop_percent
2029                         ) VALUES (
2030                                 old_fund.org,
2031                                 old_fund.name,
2032                                 old_year + 1,
2033                                 old_fund.currency_type,
2034                                 old_fund.code,
2035                                 old_fund.rollover,
2036                                 true,
2037                                 old_fund.balance_warning_percent,
2038                                 old_fund.balance_stop_percent
2039                         )
2040                         RETURNING id INTO new_id;
2041                 EXCEPTION
2042                         WHEN unique_violation THEN
2043                                 --RAISE NOTICE 'Fund % already propagated', old_fund.id;
2044                                 CONTINUE;
2045                 END;
2046
2047                 PERFORM acq.copy_fund_tags(old_fund.id,new_id);
2048
2049                 --RAISE NOTICE 'Propagating fund % to fund %',
2050                 --      old_fund.code, new_id;
2051         END LOOP;
2052 END;
2053 $$ LANGUAGE plpgsql;
2054
2055 CREATE OR REPLACE FUNCTION acq.propagate_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER ) RETURNS VOID AS $$
2056     SELECT acq.propagate_funds_by_org_tree( $1, $2, $3, FALSE );
2057 $$ LANGUAGE SQL;
2058
2059 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_tree(
2060         old_year INTEGER,
2061         user_id INTEGER,
2062         org_unit_id INTEGER,
2063     encumb_only BOOL DEFAULT FALSE,
2064     include_desc BOOL DEFAULT TRUE
2065 ) RETURNS VOID AS $$
2066 DECLARE
2067 --
2068 new_fund    INT;
2069 new_year    INT := old_year + 1;
2070 org_found   BOOL;
2071 perm_ous    BOOL;
2072 xfer_amount NUMERIC := 0;
2073 roll_fund   RECORD;
2074 deb         RECORD;
2075 detail      RECORD;
2076 roll_distrib_forms BOOL;
2077 --
2078 BEGIN
2079         --
2080         -- Sanity checks
2081         --
2082         IF old_year IS NULL THEN
2083                 RAISE EXCEPTION 'Input year argument is NULL';
2084     ELSIF old_year NOT BETWEEN 2008 and 2200 THEN
2085         RAISE EXCEPTION 'Input year is out of range';
2086         END IF;
2087         --
2088         IF user_id IS NULL THEN
2089                 RAISE EXCEPTION 'Input user id argument is NULL';
2090         END IF;
2091         --
2092         IF org_unit_id IS NULL THEN
2093                 RAISE EXCEPTION 'Org unit id argument is NULL';
2094         ELSE
2095                 --
2096                 -- Validate the org unit
2097                 --
2098                 SELECT TRUE
2099                 INTO org_found
2100                 FROM actor.org_unit
2101                 WHERE id = org_unit_id;
2102                 --
2103                 IF org_found IS NULL THEN
2104                         RAISE EXCEPTION 'Org unit id % is invalid', org_unit_id;
2105                 ELSIF encumb_only THEN
2106                         SELECT INTO perm_ous value::BOOL FROM
2107                         actor.org_unit_ancestor_setting(
2108                                 'acq.fund.allow_rollover_without_money', org_unit_id
2109                         );
2110                         IF NOT FOUND OR NOT perm_ous THEN
2111                                 RAISE EXCEPTION 'Encumbrance-only rollover not permitted at org %', org_unit_id;
2112                         END IF;
2113                 END IF;
2114         END IF;
2115         --
2116         -- Loop over the propagable funds to identify the details
2117         -- from the old fund plus the id of the new one, if it exists.
2118         --
2119         FOR roll_fund in
2120         SELECT
2121             oldf.id AS old_fund,
2122             oldf.org,
2123             oldf.name,
2124             oldf.currency_type,
2125             oldf.code,
2126                 oldf.rollover,
2127             newf.id AS new_fund_id
2128         FROM
2129         acq.fund AS oldf
2130         LEFT JOIN acq.fund AS newf
2131                 ON ( oldf.code = newf.code )
2132         WHERE
2133                     oldf.year = old_year
2134                 AND oldf.propagate
2135         AND newf.year = new_year
2136                 AND ( ( include_desc AND oldf.org IN ( SELECT id FROM actor.org_unit_descendants( org_unit_id ) ) )
2137                 OR (NOT include_desc AND oldf.org = org_unit_id ) )
2138         LOOP
2139                 --RAISE NOTICE 'Processing fund %', roll_fund.old_fund;
2140                 --
2141                 IF roll_fund.new_fund_id IS NULL THEN
2142                         --
2143                         -- The old fund hasn't been propagated yet.  Propagate it now.
2144                         --
2145                         INSERT INTO acq.fund (
2146                                 org,
2147                                 name,
2148                                 year,
2149                                 currency_type,
2150                                 code,
2151                                 rollover,
2152                                 propagate,
2153                                 balance_warning_percent,
2154                                 balance_stop_percent
2155                         ) VALUES (
2156                                 roll_fund.org,
2157                                 roll_fund.name,
2158                                 new_year,
2159                                 roll_fund.currency_type,
2160                                 roll_fund.code,
2161                                 true,
2162                                 true,
2163                                 roll_fund.balance_warning_percent,
2164                                 roll_fund.balance_stop_percent
2165                         )
2166                         RETURNING id INTO new_fund;
2167
2168                         PERFORM acq.copy_fund_tags(roll_fund.id,new_fund);
2169
2170                 ELSE
2171                         new_fund = roll_fund.new_fund_id;
2172                 END IF;
2173                 --
2174                 -- Determine the amount to transfer
2175                 --
2176                 SELECT amount
2177                 INTO xfer_amount
2178                 FROM acq.fund_spent_balance
2179                 WHERE fund = roll_fund.old_fund;
2180                 --
2181                 IF xfer_amount <> 0 THEN
2182                         IF NOT encumb_only AND roll_fund.rollover THEN
2183                                 --
2184                                 -- Transfer balance from old fund to new
2185                                 --
2186                                 --RAISE NOTICE 'Transferring % from fund % to %', xfer_amount, roll_fund.old_fund, new_fund;
2187                                 --
2188                                 PERFORM acq.transfer_fund(
2189                                         roll_fund.old_fund,
2190                                         xfer_amount,
2191                                         new_fund,
2192                                         xfer_amount,
2193                                         user_id,
2194                                         'Rollover'
2195                                 );
2196                         ELSE
2197                                 --
2198                                 -- Transfer balance from old fund to the void
2199                                 --
2200                                 -- RAISE NOTICE 'Transferring % from fund % to the void', xfer_amount, roll_fund.old_fund;
2201                                 --
2202                                 PERFORM acq.transfer_fund(
2203                                         roll_fund.old_fund,
2204                                         xfer_amount,
2205                                         NULL,
2206                                         NULL,
2207                                         user_id,
2208                                         'Rollover into the void'
2209                                 );
2210                         END IF;
2211                 END IF;
2212                 --
2213                 IF roll_fund.rollover THEN
2214                         --
2215                         -- Move any lineitems from the old fund to the new one
2216                         -- where the associated debit is an encumbrance.
2217                         --
2218                         -- Any other tables tying expenditure details to funds should
2219                         -- receive similar treatment.  At this writing there are none.
2220                         --
2221                         UPDATE acq.lineitem_detail
2222                         SET fund = new_fund
2223                         WHERE
2224                         fund = roll_fund.old_fund -- this condition may be redundant
2225                         AND fund_debit in
2226                         (
2227                                 SELECT id
2228                                 FROM acq.fund_debit
2229                                 WHERE
2230                                 fund = roll_fund.old_fund
2231                                 AND encumbrance
2232                         );
2233                         --
2234                         -- Move encumbrance debits from the old fund to the new fund
2235                         --
2236                         UPDATE acq.fund_debit
2237                         SET fund = new_fund
2238                         wHERE
2239                                 fund = roll_fund.old_fund
2240                                 AND encumbrance;
2241                 END IF;
2242
2243                 -- Rollover distribution formulae funds
2244                 SELECT INTO roll_distrib_forms value::BOOL FROM
2245                         actor.org_unit_ancestor_setting(
2246                                 'acq.fund.rollover_distrib_forms', org_unit_id
2247                         );
2248
2249                 IF roll_distrib_forms THEN
2250                         UPDATE acq.distribution_formula_entry
2251                                 SET fund = roll_fund.new_fund_id
2252                                 WHERE fund = roll_fund.old_fund;
2253                 END IF;
2254
2255                 --
2256                 -- Mark old fund as inactive, now that we've closed it
2257                 --
2258                 UPDATE acq.fund
2259                 SET active = FALSE
2260                 WHERE id = roll_fund.old_fund;
2261         END LOOP;
2262 END;
2263 $$ LANGUAGE plpgsql;
2264
2265
2266
2267
2268 CREATE OR REPLACE FUNCTION acq.rollover_funds_by_org_unit( old_year INTEGER, user_id INTEGER, org_unit_id INTEGER, encumb_only BOOL DEFAULT FALSE ) RETURNS VOID AS $$
2269     SELECT acq.rollover_funds_by_org_tree( $1, $2, $3, $4, FALSE );
2270 $$ LANGUAGE SQL;
2271
2272 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
2273     SELECT  funding_source,
2274             SUM(amount) AS amount
2275       FROM  acq.funding_source_credit
2276       GROUP BY 1;
2277
2278 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
2279     SELECT  funding_source,
2280             SUM(a.amount)::NUMERIC(100,2) AS amount
2281     FROM  acq.fund_allocation a
2282     GROUP BY 1;
2283
2284 CREATE OR REPLACE VIEW acq.funding_source_balance AS
2285     SELECT  COALESCE(c.funding_source, a.funding_source) AS funding_source,
2286             SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
2287       FROM  acq.funding_source_credit_total c
2288             FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
2289       GROUP BY 1;
2290
2291 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
2292     SELECT  fund,
2293             SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
2294     FROM acq.fund_allocation a
2295          JOIN acq.fund f ON (a.fund = f.id)
2296          JOIN acq.funding_source s ON (a.funding_source = s.id)
2297     GROUP BY 1;
2298
2299 CREATE OR REPLACE VIEW acq.fund_debit_total AS
2300     SELECT  fund.id AS fund,
2301             sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2302     FROM acq.fund fund
2303         LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2304     GROUP BY fund.id;
2305
2306 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
2307     SELECT
2308         fund.id AS fund,
2309         sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2310     FROM acq.fund fund
2311         LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2312     WHERE fund_debit.encumbrance GROUP BY fund.id;
2313
2314 CREATE OR REPLACE VIEW acq.fund_spent_total AS
2315     SELECT  fund.id AS fund,
2316             sum(COALESCE(fund_debit.amount, 0::numeric)) AS amount
2317     FROM acq.fund fund
2318         LEFT JOIN acq.fund_debit fund_debit ON fund.id = fund_debit.fund
2319     WHERE NOT fund_debit.encumbrance
2320     GROUP BY fund.id;
2321
2322 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
2323     SELECT  c.fund,
2324             c.amount - COALESCE(d.amount, 0.0) AS amount
2325     FROM acq.fund_allocation_total c
2326     LEFT JOIN acq.fund_debit_total d USING (fund);
2327
2328 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
2329     SELECT  c.fund,
2330             c.amount - COALESCE(d.amount,0.0) AS amount
2331       FROM  acq.fund_allocation_total c
2332             LEFT JOIN acq.fund_spent_total d USING (fund);
2333
2334 -- For each fund: the total allocation from all sources, in the
2335 -- currency of the fund (or 0 if there are no allocations)
2336
2337 CREATE VIEW acq.all_fund_allocation_total AS
2338 SELECT
2339     f.id AS fund,
2340     COALESCE( SUM( a.amount * acq.exchange_ratio(
2341         s.currency_type, f.currency_type))::numeric(100,2), 0 )
2342     AS amount
2343 FROM
2344     acq.fund f
2345         LEFT JOIN acq.fund_allocation a
2346             ON a.fund = f.id
2347         LEFT JOIN acq.funding_source s
2348             ON a.funding_source = s.id
2349 GROUP BY
2350     f.id;
2351
2352 -- For every fund: the total encumbrances (or 0 if none),
2353 -- in the currency of the fund.
2354
2355 CREATE VIEW acq.all_fund_encumbrance_total AS
2356 SELECT
2357         f.id AS fund,
2358         COALESCE( encumb.amount, 0 ) AS amount
2359 FROM
2360         acq.fund AS f
2361                 LEFT JOIN (
2362                         SELECT
2363                                 fund,
2364                                 sum( amount ) AS amount
2365                         FROM
2366                                 acq.fund_debit
2367                         WHERE
2368                                 encumbrance
2369                         GROUP BY fund
2370                 ) AS encumb
2371                         ON f.id = encumb.fund;
2372
2373 -- For every fund: the total spent (or 0 if none),
2374 -- in the currency of the fund.
2375
2376 CREATE VIEW acq.all_fund_spent_total AS
2377 SELECT
2378     f.id AS fund,
2379     COALESCE( spent.amount, 0 ) AS amount
2380 FROM
2381     acq.fund AS f
2382         LEFT JOIN (
2383             SELECT
2384                 fund,
2385                 sum( amount ) AS amount
2386             FROM
2387                 acq.fund_debit
2388             WHERE
2389                 NOT encumbrance
2390             GROUP BY fund
2391         ) AS spent
2392             ON f.id = spent.fund;
2393
2394 -- For each fund: the amount not yet spent, in the currency
2395 -- of the fund.  May include encumbrances.
2396
2397 CREATE VIEW acq.all_fund_spent_balance AS
2398 SELECT
2399         c.fund,
2400         c.amount - d.amount AS amount
2401 FROM acq.all_fund_allocation_total c
2402     LEFT JOIN acq.all_fund_spent_total d USING (fund);
2403
2404 -- For each fund: the amount neither spent nor encumbered,
2405 -- in the currency of the fund
2406
2407 CREATE VIEW acq.all_fund_combined_balance AS
2408 SELECT
2409      a.fund,
2410      a.amount - COALESCE( c.amount, 0 ) AS amount
2411 FROM
2412      acq.all_fund_allocation_total a
2413         LEFT OUTER JOIN (
2414             SELECT
2415                 fund,
2416                 SUM( amount ) AS amount
2417             FROM
2418                 acq.fund_debit
2419             GROUP BY
2420                 fund
2421         ) AS c USING ( fund );
2422
2423 CREATE TABLE acq.claim_type (
2424         id             SERIAL           PRIMARY KEY,
2425         org_unit       INT              NOT NULL REFERENCES actor.org_unit(id)
2426                                                  DEFERRABLE INITIALLY DEFERRED,
2427         code           TEXT             NOT NULL,
2428         description    TEXT             NOT NULL,
2429         CONSTRAINT claim_type_once_per_org UNIQUE ( org_unit, code )
2430 );
2431
2432 CREATE TABLE acq.claim (
2433         id             SERIAL           PRIMARY KEY,
2434         type           INT              NOT NULL REFERENCES acq.claim_type
2435                                                  DEFERRABLE INITIALLY DEFERRED,
2436         lineitem_detail BIGINT          NOT NULL REFERENCES acq.lineitem_detail
2437                                                  DEFERRABLE INITIALLY DEFERRED
2438 );
2439
2440 CREATE INDEX claim_lid_idx ON acq.claim( lineitem_detail );
2441
2442 CREATE TABLE acq.claim_event (
2443         id             BIGSERIAL        PRIMARY KEY,
2444         type           INT              NOT NULL REFERENCES acq.claim_event_type
2445                                                  DEFERRABLE INITIALLY DEFERRED,
2446         claim          SERIAL           NOT NULL REFERENCES acq.claim
2447                                                  DEFERRABLE INITIALLY DEFERRED,
2448         event_date     TIMESTAMPTZ      NOT NULL DEFAULT now(),
2449         creator        INT              NOT NULL REFERENCES actor.usr
2450                                                  DEFERRABLE INITIALLY DEFERRED,
2451         note           TEXT
2452 );
2453
2454 CREATE INDEX claim_event_claim_date_idx ON acq.claim_event( claim, event_date );
2455
2456 -- And the serials version of claiming
2457 CREATE TABLE acq.serial_claim (
2458     id     SERIAL           PRIMARY KEY,
2459     type   INT              NOT NULL REFERENCES acq.claim_type
2460                                      DEFERRABLE INITIALLY DEFERRED,
2461     item    BIGINT          NOT NULL REFERENCES serial.item
2462                                      DEFERRABLE INITIALLY DEFERRED
2463 );
2464
2465 CREATE INDEX serial_claim_lid_idx ON acq.serial_claim( item );
2466
2467 CREATE TABLE acq.serial_claim_event (
2468     id             BIGSERIAL        PRIMARY KEY,
2469     type           INT              NOT NULL REFERENCES acq.claim_event_type
2470                                              DEFERRABLE INITIALLY DEFERRED,
2471     claim          SERIAL           NOT NULL REFERENCES acq.serial_claim
2472                                              DEFERRABLE INITIALLY DEFERRED,
2473     event_date     TIMESTAMPTZ      NOT NULL DEFAULT now(),
2474     creator        INT              NOT NULL REFERENCES actor.usr
2475                                              DEFERRABLE INITIALLY DEFERRED,
2476     note           TEXT
2477 );
2478
2479 CREATE INDEX serial_claim_event_claim_date_idx ON acq.serial_claim_event( claim, event_date );
2480
2481 CREATE OR REPLACE VIEW acq.lineitem_summary AS
2482     SELECT
2483         li.id AS lineitem,
2484         (
2485             SELECT COUNT(lid.id)
2486             FROM acq.lineitem_detail lid
2487             WHERE lineitem = li.id
2488         ) AS item_count,
2489         (
2490             SELECT COUNT(lid.id)
2491             FROM acq.lineitem_detail lid
2492             WHERE recv_time IS NOT NULL AND lineitem = li.id
2493         ) AS recv_count,
2494         (
2495             SELECT COUNT(lid.id)
2496             FROM acq.lineitem_detail lid
2497                 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2498             WHERE acqcr.keep_debits IS FALSE AND lineitem = li.id
2499         ) AS cancel_count,
2500         (
2501             SELECT COUNT(lid.id)
2502             FROM acq.lineitem_detail lid
2503                 JOIN acq.cancel_reason acqcr ON (acqcr.id = lid.cancel_reason)
2504             WHERE acqcr.keep_debits IS TRUE AND lineitem = li.id
2505         ) AS delay_count,
2506         (
2507             SELECT COUNT(lid.id)
2508             FROM acq.lineitem_detail lid
2509                 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2510             WHERE NOT debit.encumbrance AND lineitem = li.id
2511         ) AS invoice_count,
2512         (
2513             SELECT COUNT(DISTINCT(lid.id))
2514             FROM acq.lineitem_detail lid
2515                 JOIN acq.claim claim ON (claim.lineitem_detail = lid.id)
2516             WHERE lineitem = li.id
2517         ) AS claim_count,
2518         (
2519             SELECT (COUNT(lid.id) * li.estimated_unit_price)::NUMERIC(8,2)
2520             FROM acq.lineitem_detail lid
2521             WHERE lid.cancel_reason IS NULL AND lineitem = li.id
2522         ) AS estimated_amount,
2523         (
2524             SELECT SUM(debit.amount)::NUMERIC(8,2)
2525             FROM acq.lineitem_detail lid
2526                 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2527             WHERE debit.encumbrance AND lineitem = li.id
2528         ) AS encumbrance_amount,
2529         (
2530             SELECT SUM(debit.amount)::NUMERIC(8,2)
2531             FROM acq.lineitem_detail lid
2532                 JOIN acq.fund_debit debit ON (lid.fund_debit = debit.id)
2533             WHERE NOT debit.encumbrance AND lineitem = li.id
2534         ) AS paid_amount
2535
2536         FROM acq.lineitem AS li;
2537
2538 COMMIT;