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

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