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

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