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