JBAS-2019 Invoice export support

DB function for finding and stamping invoices for export.
Script for calling DB func, creating CSV from the exported invoices, and
SCP'ing the invoices to prod-depot.

Signed-off-by: Bill Erickson <berickxx@gmail.com>

diff --git a/KCLS/sql/schema/deploy/invoice-exports.sql b/KCLS/sql/schema/deploy/invoice-exports.sql
new file mode 100644 (file)
index 0000000..6e62acb
--- /dev/null
+++ b/KCLS/sql/schema/deploy/invoice-exports.sql
@@ -0,0 +1,146 @@
+-- Deploy kcls-evergreen:invoice-exports to pg
+-- requires: refundable-xact-summary-view-speed
+
+BEGIN;
+
+SET STATEMENT_TIMEOUT = 0;
+
+SELECT CLOCK_TIMESTAMP(), 
+    'Adding export date to legacy invoices closed 2018-05-22';
+
+-- Mark all invoices closed before today as exported so they 
+-- are not re-exported.  
+UPDATE acq.invoice SET erp_export_date = '2018-05-22' 
+WHERE erp_export_date IS NULL AND DATE(close_date) < '2019-03-15';
+
+SELECT CLOCK_TIMESTAMP(), 'Done with legacy invoices';
+
+/**
+External script does this:
+SELECT acq.export_invoices();
+SELECT * FROM acq.last_invoice_export;
+
+In dry_run mode, the table of exported data is rebuilt as usual
+but the erp_export_date values on the acq.invoice rows are not set.
+*/
+
+CREATE OR REPLACE FUNCTION acq.export_invoices(dry_run BOOLEAN DEFAULT FALSE)
+    RETURNS INTEGER AS -- RETURNS number of invoices exported
+$FUNK$
+DECLARE
+    num_invoices INTEGER;
+BEGIN
+    -- DROP instead of TRUNCATE so it's easier to modify 
+    -- columns later if needed by simply modifying this function.
+    DROP TABLE IF EXISTS acq.last_invoice_export;
+
+    CREATE TABLE acq.last_invoice_export AS 
+        SELECT 
+            * 
+        FROM
+            (
+            SELECT
+                acq.invoice.ID AS internal_id,
+                acq.invoice.inv_ident AS vendor_inv_id,
+                acq.provider.ID AS provider_id,
+                to_char( acq.invoice.recv_date, 'MM/DD/YYYY' ) AS recv_date,
+                SUM ( acq.fund_debit.amount ) :: money AS amount_paid,
+                acq.fund_debit.fund AS fund_id,
+                'inv_detail' AS entry_type,
+                acq.fund.code AS fund_code,
+                acq.fund.NAME AS fund_name,
+                acq.provider.code AS provider_code,
+                acq.provider.NAME AS provider_name,
+                acq.fund.YEAR AS fund_year,
+                acq.fund_tag.NAME AS fund_tag,
+                acq.invoice_entry.ID,
+                acq.invoice.close_date,
+                acq.invoice.closed_by 
+            FROM
+                acq.invoice
+                INNER JOIN acq.provider ON acq.invoice.provider = acq.provider.ID 
+                INNER JOIN acq.invoice_entry ON acq.invoice_entry.invoice = acq.invoice.ID 
+                FULL OUTER JOIN acq.fund_debit ON acq.fund_debit.invoice_entry = acq.invoice_entry.ID 
+                INNER JOIN acq.fund ON acq.fund_debit.fund = acq.fund.ID 
+                LEFT JOIN acq.fund_tag_map ON acq.fund_tag_map.fund = acq.fund.ID 
+                LEFT JOIN acq.fund_tag ON acq.fund_tag_map.tag = acq.fund_tag.ID 
+            WHERE
+                    acq.invoice.close_date IS NOT NULL
+                AND acq.provider.prepayment_required = 'f' 
+                AND acq.invoice.erp_export_date IS NULL
+            GROUP BY
+                acq.invoice.ID,
+                acq.invoice.inv_ident,
+                acq.provider.ID,
+                acq.fund_debit.fund,
+                acq.fund.code,
+                acq.fund.NAME,
+                acq.fund.YEAR,
+                acq.fund_tag.NAME,
+                acq.invoice_entry.ID UNION ALL
+            SELECT
+                acq.invoice.ID AS internal_id,
+                acq.invoice.inv_ident AS vendor_inv_id,
+                acq.provider.ID AS provider_id,
+                to_char( acq.invoice.recv_date, 'MM/DD/YYYY' ) AS recv_date,
+                SUM ( acq.fund_debit.amount ) :: money AS amount_paid,
+                acq.fund_debit.fund AS fund_id,
+                acq.invoice_item_type.NAME AS entry_type,
+                acq.fund.code AS fund_code,
+                acq.fund.NAME AS fund_name,
+                acq.provider.code AS provider_code,
+                acq.provider.NAME AS provider_name,
+                acq.fund.YEAR AS fund_year,
+                acq.fund_tag.NAME AS fund_tag,
+                acq.invoice_item.ID,
+                acq.invoice.close_date,
+                acq.invoice.closed_by 
+            FROM
+                acq.invoice
+                INNER JOIN acq.provider ON acq.invoice.provider = acq.provider.ID 
+                INNER JOIN acq.invoice_item ON acq.invoice_item.invoice = acq.invoice.ID 
+                INNER JOIN acq.invoice_item_type ON acq.invoice_item.inv_item_type = acq.invoice_item_type.code
+                FULL OUTER JOIN acq.fund_debit ON acq.invoice_item.fund_debit = acq.fund_debit.ID 
+                INNER JOIN acq.fund ON acq.fund_debit.fund = acq.fund.ID 
+                LEFT JOIN acq.fund_tag_map ON acq.fund_tag_map.fund = acq.fund.ID 
+                LEFT JOIN acq.fund_tag ON acq.fund_tag_map.tag = acq.fund_tag.ID 
+            WHERE
+                    acq.invoice.close_date IS NOT NULL
+                AND acq.provider.prepayment_required = 'f' 
+                AND acq.invoice.erp_export_date IS NULL
+            GROUP BY
+                acq.invoice.ID,
+                acq.invoice.inv_ident,
+                acq.provider.ID,
+                acq.fund_debit.fund,
+                acq.invoice_item_type.NAME,
+                acq.fund.code,
+                acq.fund.NAME,
+                acq.provider.code,
+                acq.provider.NAME,
+                acq.fund.YEAR,
+                acq.fund_tag.NAME,
+                acq.invoice_item.ID 
+            ) AS inv 
+        ORDER BY 
+            1
+    ;
+
+    -- Stamp the selected invoices as exported.
+    IF NOT dry_run THEN
+        UPDATE acq.invoice 
+        SET erp_export_date = NOW() 
+        WHERE id IN (
+            SELECT DISTINCT(internal_id) FROM acq.last_invoice_export
+        );
+    END IF;
+
+    SELECT INTO num_invoices COUNT(*) FROM acq.last_invoice_export;
+    RAISE NOTICE '% Invoices stamped as exported', num_invoices;
+
+    RETURN num_invoices;
+END;
+$FUNK$ LANGUAGE PLPGSQL;
+
+COMMIT;
+

diff --git a/KCLS/sql/schema/revert/invoice-exports.sql b/KCLS/sql/schema/revert/invoice-exports.sql
new file mode 100644 (file)
index 0000000..5055085
--- /dev/null
+++ b/KCLS/sql/schema/revert/invoice-exports.sql
@@ -0,0 +1,7 @@
+-- Revert kcls-evergreen:invoice-exports from pg
+
+BEGIN;
+
+-- XXX Add DDLs here.
+
+COMMIT;

diff --git a/KCLS/sql/schema/sqitch.plan b/KCLS/sql/schema/sqitch.plan
index 9980582..a980e03 100644 (file)
--- a/KCLS/sql/schema/sqitch.plan
+++ b/KCLS/sql/schema/sqitch.plan
@@ -78,6 +78,7 @@ lost-paid-receipts [all-circs-slim-backport] 2017-07-03T20:10:59Z Bill Erickson,
 lost-paid-receipts-data [lost-paid-receipts] 2017-08-02T15:28:08Z Bill Erickson,,, <berick@kcls-dev-local> # Lost/Paid permissions and receipts
 aged-money-purge [lost-paid-receipts-data] 2018-10-16T19:33:11Z Bill Erickson,,, <berick@kcls-dev> # aged billing/payment migration
 refundable-xact-summary-view-speed [aged-money-purge] 2018-11-14T16:49:15Z Bill Erickson,,, <berick@kcls-dev> # Speed up refundable xact summary
+invoice-exports [refundable-xact-summary-view-speed] 2019-01-17T20:58:17Z berick <berick@kcls-dev> # Exporting invoices
 stock-browse-schema [ecard-notice-validator] 2018-08-31T15:22:58Z Bill Erickson,,, <berick@kcls-dev-local> # Recover stock browse data tables, etc.
 stock-browse-headings-report [stock-browse-schema] 2018-10-04T15:56:18Z Bill Erickson,,, <berick@kcls-dev> # New heading report updates for stock browse
 stock-browse-cleanup [stock-browse-schema] 2018-10-03T18:05:49Z Bill Erickson,,, <berick@kcls-dev> # Delete old browse data

diff --git a/KCLS/utility-scripts/export_invoices/export_invoices.sh b/KCLS/utility-scripts/export_invoices/export_invoices.sh
new file mode 100755 (executable)
index 0000000..7ae0343
--- /dev/null
+++ b/KCLS/utility-scripts/export_invoices/export_invoices.sh
@@ -0,0 +1,21 @@
+#!/bin/bash
+# Kick off the holds purge function.
+# Set PGHOST, PGPASSWORD, PGUSER environment variables!
+set -eu
+PSQL="psql"
+YMD=$(date +'%F');
+CSV_FILE="/tmp/invoice-export.$YMD.csv"
+CSV_COMMAND="\\copy (SELECT * FROM acq.last_invoice_export ORDER BY internal_id) TO '$CSV_FILE' WITH (FORMAT CSV, HEADER)"
+
+echo -n "Exporting completed invoices at "
+date +"%F %T" 
+
+echo "SET STATEMENT_TIMEOUT = 0; SELECT acq.export_invoices();" | $PSQL;
+echo "$CSV_COMMAND" | $PSQL;
+
+echo "CSV export file created: $CSV_FILE"
+
+scp "$CSV_FILE" prod-depot.eg.kcls.org:/home/sftpinv/pending/
+
+echo -n "Invoice exports complete "
+date +"%F %T"