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