cu_flagconst.i

<?php
/**
 *  ***
 *  *** NEW GLOBAL FUNCTIONS ADDED AT END OF SCRIPT -- keep both until all references removed
 *  ***
 *  ***  GetFlagsetValue
 *  ***  GetUserFlagsValue
 *  ***  GetAdminUserFlagsValue
 *  ***  GetMsgTxValue
 *  ***
 */
# Defines used for ACH operations; used for ACH, external accounts, transfers
define( "ACCOUNT_TYPE_CHECKING", 10 );
define( "ACCOUNT_TYPE_SAVINGS", 20 );

# stored in cuadmin.flagset
#                        Show Available balance
$CU_SHOWAVAILABLE=1;
#                        Check image retrieval on
$CU_SHOWIMAGES=2;
#                        Special processing for check images returned as link
# value recycled as new flag 5/25/12
#                        Use cuadmin.depositlimit for 3rd party remote deposit
$CU_3RDPARTYRDC=4;
#                        Mail copy of transactions to CU
$CU_MAILTXNS=8;
#                        Save copy of transaction in database
$CU_SAVETXNS=16;
#                        Require email addresses on transfers
$CU_COLLECTEMAIL=32;
#                        Calculate running balance from account balance
$CU_CALCRUNBAL=64;
#                        Show Dividend message on deposit accounts
$CU_SHOWDEPDIVIDEND=128;
#                        Show YTD Interest message on loans
$CU_SHOWLNINTEREST=256;
#                        Include description when reporting loan transactions
$CU_SHOWLNTXNDESC=512;
#                        Show split principle and interest for loan transactions
$CU_SHOWLNTXNSPLIT=1024;
#                        If loan balance is NA print zero
$CU_HIDENA=2048;
#                        Sort account history transactions by ....
#                        accounttype, certnumber, tracenumber desc
$CU_SORTORDER1=4096;
#                        accounttype, certnumber, date desc, sortkey desc
$CU_SORTORDER2=8192;
#                        accounttype, certnumber, date desc, tracenumber desc
$CU_SORTORDER3=16384;
#       btrim(ab.accounttype,'DIS'),ab.certnumber,ah.date desc, tracenumber desc
$CU_SORTORDER4=32768;
#                        accounttype, certnumber, date desc, oid desc
$CU_SORTORDER5=2097152;
#                        loanhistory balance missing -- hide the field
$CU_LNBALUNUSABLE=65536;
#                        Sort loan history transactions by ....
#                        lb.loannumber, lh.date desc, lh.tracenumber desc
$CU_LNSORT1=131072;
#                   btrim(lb.loannumber,'LC'), lh.date desc, lh.tracenumber desc
$CU_LNSORT2=262144;
#                        Allow QIF download format
$CU_QIFDOWN=524288;
#                        Hide Loan Next Payment Date
$CU_HIDELOANDATE=1048576;
#                        Allow MNY download format Microsoft Money
$CU_MNYDOWN=4194304;
#                        Allow QKN download format Quicken WebConnect
$CU_QKNDOWN=8388608;
#                        Show NCUA logo on Transfer screen
$CU_SHOWNCUA=16777216;
#                        Show Current Interest Rates on Loans
$CU_SHOWLNRATE=33554432;
#                        Show link for older check images
$CU_SHOWARCLINK=67108864;
#                        Allow members to reset their own password
$CU_MEMRESET=134217728;
#                        Allow members to switch to other accounts w/o login
$CU_ALLOWSWITCH=268435456;
#                        Switch Account records included in LIVE XAC packet
$CU_PKT_SWITCH=536870912;
#                        Hide Prior Year Interest and Dividends
$CU_HIDE_PYR=1073741824;
#
# Now use flagset2  because PHP runs out of bits

# stored in cuadmin.flagset2
#                        Hide Payoff
$CU2_HIDE_PAYOFF=1;
#                        Show 'Call' for Payoff
$CU2_CALL_PAYOFF=2;
#                        Special Handling for loan type 18 Credit Cards
$CU2_SPEC18=4;
#                        Show interest rate on credit cards
$CU2_SHOWCCRATE=8;
#                        Show Credit Card last paid date
$CU2_SHOWCCLPAY=16;
#                        Process Repeating Transactions for this CU, they will NOT be processed until this is set
$CU2_PROCRECUR=32;
#                        Credit Union uses member messaging feature
$CU2_ALLOWMESSAGE=64;
#                        Sort accounts by ....
#                        deposittype, accounttype, certnumber
$CU2_SORTORDER6=128;
#                        Show Destination Account Number for LIVE Cross-Accts
$CU2_SHOWTXDEST=256;
#                        Show holds; Expect Hold Transactions in live packet
$CU2_SHOWHOLD=512;
#                        Show Credit Card (type 18) stmnt bal
$CU2_SHOWCCSB=1024;
#                        Credit Union uses OnLineDeposits
$CU2_USEONLDEP=2048;
#                        Type 18 No balance info available
$CU2_CC18NOINFO=4096;
#                        Type 18 Show as From/To even if zero available
$CU2_CC18SHOWZERO=8192;
#                        Hide Loan Past Due marker
$CU2_HIDE_PASTDUE=16384;
#                        OFX Include Member in ACCTID
$CU2_OFX_MEMACCTID=32768;
#                        OFX Include LOAN INFO
$CU2_OFX_PASSLOAN=65536;
#                        Show 10-day payoff
$CU2_10DAYPAY=131072;
#                        Credit Card Hide Available
$CU2_HIDE_CCAVAIL=262144;
#                        Credit Card Show 'Call' for Available
$CU2_CALL_CCAVAIL=524288;
#                        Show banner add in page top
$CU2_SHOWBANNER=1048576;
#                        Use expanded schema for LoanBalance & LoanHistory
#                        available for use on UPD8 / AWS only
$CU2_ESCHEMA=2097152;
#                        Loan History show escrow amount (requires CU2_ESCHEMA)
$CU2_SHOW_LN_ESCROW=4194304;
#                        Loan History show fee amount (requires CU2_ESCHEMA)
$CU2_SHOW_LN_FEE=8388608;
#                        Present Members with FRAME-FREE home banking scripts -- Menu is loaded from fmenu.html
$CU2_FRAMEFREE=16777216;
#                        Allow Member Alerts Processing -- Use this to turn on Alert processing for a credit union
$CU2_ALLOW_MBR_ALERTS=33554432;
#                        CU requires user_alias as username
$CU2_ALIAS_REQ=67108864;
#                        Show pending; Expect pending Txns in live packet
$CU2_SHOWPEND=134217728;
#                   lb.oid, lh.date desc, lh.tracenumber desc
$CU2_LNSORT3=268435456;
#                        Show only 1 randomized challenge question at a time
$CU2_RANDOM_CHAL=536870912;
#                        CU allows user_alias as username
$CU2_ALIAS_OK=1073741824;



#                        NEXT AVAILABLE FLAG
# alter cuadmin to include flagset3 before using this set. Defined on barney
# and debtest and forward to amazon.
# If a client needs a cu3 flag, make sure they move to amazon

# stored in cuadmin.flagset3

#                       Flag used to see if member should be able to sign up for E-Statements at first login
$CU3_ESTMNT_SIGNUP=1;
#                       Flag for receiving eStatements directly from core
$CU3_ESTMNT_CORE=2;
#                       Flag for allowing members to enroll in home banking by showing button on login page
$CU3_SHOW_ENROLL=4;
#                       Flag for having auto activate use the MIR packet
$CU3_ENROLL_MIR=8;
#                       CU uses MFA Authcode instead of Challenge Questions
$CU3_MFA_AUTHCODE=16;
#                       Prepends members to descriptions without custom message
$CU3_PREPEND_MBR_DESC=32;
#                       Masks the member number for descriptions without custom message and previous flag set
$CU3_MASK_MBR_DESC=64;
//                     Use Plus API features (Balance Only, History on demand, M2M)
$CU3_API_PLUS = 128;
//                    Make a XAC packet request from the core for the member
$CU3_API_XAC = 256;
//                      By default Odyssey will use Amazon SMS services for sending MFA Codes.  If this is set then it will use the LONG CODE associated with CU
$CU3_LONGCODE_MFA = 512;
//                      Allow contents of sortkey from core to override check micr info at HomeCU
$CU3_SORTKEY_MICR = 1024;
//                      Allow QB download format QuickBooks
$CU3_QBDOWN = 2048;
//                      Flag for having auto activate use the core PIN
$CU3_ENROLL_PIN = 4096;
//                      Flag for disallowing multiple accounts
$CU3_DISALLOW_MULTIPLE_ACCOUNTS = 8192;
//                      Flag for preventing transfers to different accounts
$CU3_DISALLOW_MULT_ACCOUNTS_TRANSFER = 16384;
//    Flag to determine if we create Access_Control Records from XAC entries instead of the overloaded 000#1234123
$CU3_CREATE_ACCESS_CONTROL_FROM_XAC = 32768;
//                      Flag for allowing CU to have leading zeros on member account numbers
$CU3_ALLOW_LEAD_ZEROS = 65536;
//                      Flag for allowing CU to migrate older (device) cookies to the new format
$CU3_ALLOW_COOKIE_MIGRATION = 131072;
//                      Flag for when the MIR packet is not supported
$CU3_MIR_PACKET_NOT_SUPPORTED = 262144;
//                      Flag for deciding whether or not to display
//                      cross accounts in the profile descriptions
//                      screen
$CU3_EXCLUDE_XAC_FROM_PROFILE_DESCRIPTIONS = 524288;


# CUDP default flags
$CU_CUDP_DEFAULT=$CU_SORTORDER1 + $CU_SHOWDEPDIVIDEND + $CU_SHOWLNINTEREST
                 + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT + $CU_LNSORT1
                 + $CU_SAVETXNS + $CU_COLLECTEMAIL;

# CUSA default flags
$CU_CUSA_DEFAULT=$CU_SORTORDER2 + $CU_SHOWDEPDIVIDEND + $CU_SHOWLNINTEREST
                 + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT + $CU_LNSORT1
                 + $CU_SAVETXNS + $CU_COLLECTEMAIL;

# AMI default flags
$CU_AMI_DEFAULT=$CU_SORTORDER3 + $CU_CALCRUNBAL + $CU_SHOWLNTXNSPLIT
                 + $CU_LNSORT1 + $CU_SAVETXNS + $CU_COLLECTEMAIL
         + $CU_SHOWAVAILABLE + $CU_SHOWLNTXNDESC;

# SOSystems default flags
$CU_SOS_DEFAULT=$CU_SORTORDER3 + $CU_CALCRUNBAL + $CU_LNBALUNUSABLE
                 + $CU_LNSORT1 + $CU_SAVETXNS + $CU_COLLECTEMAIL
                 + $CU_SHOWLNTXNDESC;

# Peerless default flags
$CU_PEER_DEFAULT=$CU_SORTORDER3 + $CU_SHOWDEPDIVIDEND + $CU_SHOWLNINTEREST
                 + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT + $CU_CALCRUNBAL
                 + $CU_LNSORT1 + $CU_SAVETXNS + $CU_COLLECTEMAIL;

# Galaxy default flags
$CU_GALAXY_DEFAULT=$CU_SORTORDER4 + $CU_SHOWDEPDIVIDEND + $CU_SHOWLNINTEREST
                 + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT + $CU_CALCRUNBAL
                 + $CU_LNSORT2 + $CU_HIDENA + $CU_SAVETXNS + $CU_COLLECTEMAIL;

# Compusource default flags
$CU_CSOURCE_DEFAULT=$CU_SORTORDER5 + $CU_SHOWDEPDIVIDEND + $CU_SHOWLNINTEREST
                 + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT + $CU_LNSORT1
                 + $CU_SAVETXNS + $CU_COLLECTEMAIL;

# CUC default flags
$CU_CUC_DEFAULT=$CU_SHOWAVAILABLE + $CU_SORTORDER1 + $CU_SHOWDEPDIVIDEND
                 + $CU_SHOWLNINTEREST + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT
                 + $CU_LNSORT1 + $CU_SAVETXNS + $CU_COLLECTEMAIL + $CU_HIDE_PYR;

# generic default flags
$CU_GENL_DEFAULT=$CU_SORTORDER3 + $CU_SHOWDEPDIVIDEND + $CU_SHOWLNINTEREST
                 + $CU_SHOWLNTXNDESC + $CU_SHOWLNTXNSPLIT + $CU_LNSORT1
                 + $CU_SAVETXNS + $CU_COLLECTEMAIL;


// *** MEMBER FLAG CONSTANTS
// stored in cuusers.userflags
// ** Bit Number --- Maximum of a 32 bit integer
// 0                    -               Flag Unused
$MEM_UNUSED = 0;
// 1                    -               Force Reset by Admin
$MEM_FORCE_RESET    = 2;
// 2                    -                   Login Failed -- Email Incorrect
$MEM_LOGIN_FAILED_EMAIL = 4;
// 3                    -                   Login Failed -- Challenge Questions Incorrect
$MEM_LOGIN_FAILED_QST = 8;
// 4                    -                   Login Failed -- Password Incorrect
$MEM_LOGIN_FAILED_PWD = 16;
// 5                    -                   Flag Member for Bill Pay email
$MEM_ASKBPAY = 32;
// 6          -         Login Failed -- Cannot use account # when alias is set
$MEM_LOGIN_FAILED_ALIAS = 64;
// 7          -         Login Failed -- Secure Access Code Incorrect
$MEM_LOGIN_FAILED_SAC = 128;
// 8                    Login Failed -- MFA Bundle missing or invalid
$MEM_LOGIN_FAILED_BNDL = 256;
// 9                    Login Failed -- App login process took too long
$MEM_LOGIN_FAILED_BNDL_TIMEOUT = 512;

// ** NEXT MEMBER FLAG VALUE = 1024
// ** MAX MEMBER FLAG VALUE = 1073741824  2^30

// *** ADMIN FLAG CONSTANTS
// stored in cuadminusers.userflags
// ** Bit Number --- Maximum of a 32 bit integer
// 0                    - Flag Unused
$ADM_UNUSED = 0;
// 1                    - Force Reset by Admin
$ADM_FORCE_RESET    = 2;
// 2                    -Admin Privileges
$ADM_MASTER_PRIV    = 4;
// 3                    -Login Failed -- Email Incorrect
$ADM_LOGIN_FAILED_EMAIL = 8;
// 4                    -Login Failed -- Challenge Questions Incorrect
$ADM_LOGIN_FAILED_QST = 16;
// 5                    -Login Failed -- Password Incorrect
$ADM_LOGIN_FAILED_PWD = 32;
// 6
$ADM_REMOTE_ACCESS_ALLOWED = 64;

// ** NEXT ADMIN FLAG VALUE = 128
// ** MAX ADMIN FLAG VALUE = 1073741824  2^30


// *** LIVE APPLIANCE FLAG CONSTANTS
# stored in cuadmin.livesetup
#                   -               Allow appliance auto-down
$LA_AUTO_DOWN   = 1;
#                     -                 Allow appliance auto-up
$LA_AUTO_UP = 2;

// ** NEXT LIVE APPLIANCE FLAG VALUE = 4
// ** MAX LIVE APPLIANCE FLAG VALUE = 1073741824  2^30

#
# flag bits stored in cuusers.msg_tx
# 1=Transfer
# 2=Estatement
# 4=WebConnect
#
# 8  temporary (session-long) flag for SurveyPopup SURVEY
# 16 temporary (session-long) flag to indicate when an XAC packet has been requested
# 32 temporary (session-long) flag to indicate when an XAC packet has been successfully loaded
#
# 64=IntuitUpdate message
# 128=TxnDownload
#
# 256 temporary (session-long) flag for SurveyPopup MESSAGE
#
# 512 'Force Email Change': when set the member will be prompted for email at login.
# 1024=Passchange
#
# 2048 Online Deposits disclosure acceptance - used in OnLineDeposits,
# 4096 - Promo don't show me again
# 8192 - "Sticky" Promo -- member can't suppress
#
# 16384 is next

# HCUTEMP_FLAGS value below should reflect the sum of
# temporary (session-long) flags.  This value is used when updating
# the database to avoid storing any temporary flags.
#

define ("HCUTEMP_FLAGS",49464);

/**
 *  Return the integer value of a predefined constant
 *    FOR ** flagset ** constants
 *
 *  These values are typically used in bitwise operations
 *
 *  @param string $pConstantName -- Name of the predefined constant
 *
 *  @return integer
 *                    -- returns 0 on error
 *
 */
function GetFlagsetValue($pConstantName) {
  $retVal = 0;

/*  stored in cuadmin.flagset */

  $flagConstants = Array(
                        'CU_SHOWAVAILABLE'  => 1, //                        Show Available balance
                        'CU_SHOWIMAGES'     => 2, //                        Check image retrieval on
                        'CU_3RDPARTYRDC'    => 4, //                        Use cuadmin.depositlimit for 3rd party remote deposit

                        'CU_MAILTXNS'       => 8, //                        Mail copy of transactions to CU
                        'CU_SAVETXNS'       => 16, //                        Save copy of transaction in database
                        'CU_COLLECTEMAIL'   => 32, //                        Require email addresses on transfers
                        'CU_CALCRUNBAL'     => 64, //                        Calculate running balance from account balance
                        'CU_SHOWDEPDIVIDEND' => 128, //                        Show Dividend message on deposit accounts
                        'CU_SHOWLNINTEREST' => 256, //                        Show YTD Interest message on loans
                        'CU_SHOWLNTXNDESC'  => 512, //                        Include description when reporting loan transactions
                        'CU_SHOWLNTXNSPLIT' => 1024, //                        Show split principle and interest for loan transactions
                        'CU_HIDENA'         => 2048, //                        If loan balance is NA print zero
                        'CU_SORTORDER1'     => 4096, //                        Sort account history transactions by ....accounttype, certnumber, tracenumber desc
                        'CU_SORTORDER2'     => 8192, //                        accounttype, certnumber, date desc, sortkey desc
                        'CU_SORTORDER3'     => 16384, //                        accounttype, certnumber, date desc, tracenumber desc
                        'CU_SORTORDER4'     => 32768, //       btrim(ab.accounttype,'DIS'),ab.certnumber,ah.date desc, tracenumber desc
                        'CU_SORTORDER5'     => 2097152, //                        accounttype, certnumber, date desc, oid desc
                        'CU_LNBALUNUSABLE'  => 65536, //                        loanhistory balance missing -- hide the field
                        'CU_LNSORT1'        => 131072, //                        Sort loan history transactions by .... lb.loannumber, lh.date desc, lh.tracenumber desc
                        'CU_LNSORT2'        => 262144, //                   btrim(lb.loannumber,'LC'), lh.date desc, lh.tracenumber desc
                        'CU_QIFDOWN'        => 524288, //                        Allow QIF download format
                        'CU_HIDELOANDATE'   => 1048576, //                        Hide Loan Next Payment Date
                        'CU_MNYDOWN'        => 4194304, //                        Allow MNY download format Microsoft Money
                        'CU_QKNDOWN'        => 8388608, //                        Allow QKN download format Quicken WebConnect
                        'CU_SHOWNCUA'       => 16777216, //                        Show NCUA logo on Transfer screen
                        'CU_SHOWLNRATE'     => 33554432, //                        Show Current Interest Rates on Loans
                        'CU_SHOWARCLINK'    => 67108864, //                        Show link for older check images
                        'CU_MEMRESET'       => 134217728, //                        Allow members to reset their own password
                        'CU_ALLOWSWITCH'    => 268435456, //                        Allow members to switch to other accounts w/o login
                        'CU_PKT_SWITCH'     => 536870912, //                        Switch Account records included in LIVE XAC packet
                        'CU_HIDE_PYR'       => 1073741824, //                        Hide Prior Year Interest and Dividends

                        /* stored in cuadmin.flagset2 */
                        'CU2_HIDE_PAYOFF'  => 1, //                        Hide Payoff
                        'CU2_CALL_PAYOFF'  => 2, //                        Show 'Call' for Payoff
                        'CU2_SPEC18'       => 4, //                        Special Handling for loan type 18 Credit Cards
                        'CU2_SHOWCCRATE'   => 8, //                        Show interest rate on credit cards
                        'CU2_SHOWCCLPAY'   => 16, //                        Show Credit Card last paid date
                        'CU2_PROCRECUR'    => 32, //                        Process Repeating Transactions for this CU, they will NOT be processed until this is set
                        'CU2_ALLOWMESSAGE' => 64, //                        Credit Union uses member messaging feature
                        'CU2_SORTORDER6'   => 128, //                        Sort accounts by .... deposittype, accounttype, certnumber
                        'CU2_SHOWTXDEST'   => 256, //                        Show Destination Account Number for LIVE Cross-Accts
                        'CU2_SHOWHOLD'     => 512, //                        Show holds; Expect Hold Transactions in live packet
                        'CU2_SHOWCCSB'     => 1024, //                        Show Credit Card (type 18) stmnt bal
                        'CU2_USEONLDEP'    => 2048, //                        Credit Union uses OnLineDeposits
                        'CU2_CC18NOINFO'   => 4096, //                        Type 18 No balance info available
                        'CU2_CC18SHOWZERO' => 8192, //                        Type 18 Show as From/To even if zero available
                        'CU2_HIDE_PASTDUE' => 16384, //                        Hide Loan Past Due marker
                        'CU2_OFX_MEMACCTID'=> 32768, //                        OFX Include Member in ACCTID
                        'CU2_OFX_PASSLOAN' => 65536, //                        OFX Include LOAN INFO
                        'CU2_10DAYPAY'     => 131072, //                        Show 10-day payoff
                        'CU2_HIDE_CCAVAIL' => 262144, //                        Credit Card Hide Available
                        'CU2_CALL_CCAVAIL' => 524288, //                        Credit Card Show 'Call' for Available
                        'CU2_SHOWBANNER'   => 1048576, //                        Show banner add in page top
                        'CU2_ESCHEMA'      => 2097152, //                        Use expanded schema for LoanBalance & LoanHistory
                        'CU2_SHOW_LN_ESCROW' => 4194304, //                        Loan History show escrow amount (requires CU2_ESCHEMA)
                        'CU2_SHOW_LN_FEE'  => 8388608, //                        Loan History show fee amount (requires CU2_ESCHEMA)
                        'CU2_FRAMEFREE'    => 16777216, //                        Present Members with FRAME-FREE home banking scripts -- Menu is loaded from fmenu.html
                        'CU2_ALLOW_MBR_ALERTS' => 33554432, //                        Allow Member Alerts Processing -- Use this to turn on Alert processing for a credit union
                        'CU2_ALIAS_REQ'    => 67108864, //                        CU requires user_alias as username
                        'CU2_SHOWPEND'     => 134217728, //                        Show pending; Expect pending Txns in live packet
                        'CU2_LNSORT3'      => 268435456, //                   lb.oid, lh.date desc, lh.tracenumber desc
                        'CU2_RANDOM_CHAL'  => 536870912, //                        Show only 1 randomized challenge question at a time
                        'CU2_ALIAS_OK'     => 1073741824, //                        CU allows user_alias as username

                        /* stored in cuadmin.flagset3 */
                        'CU3_ESTMNT_SIGNUP'=> 1, //                       Flag used to see if member should be able to sign up for E-Statements at first login
                        'CU3_ESTMNT_CORE'  => 2, //                       Flag for receiving eStatements directly from core
                        'CU3_SHOW_ENROLL'  => 4, //                       Flag for allowing members to enroll in home banking by showing button on login page
                        'CU3_ENROLL_MIR'   => 8, //                       Flag for having auto activate use the MIR packet
                        'CU3_MFA_AUTHCODE' => 16, //                       CU uses MFA Authcode instead of Challenge Questions
                        'CU3_PREPEND_MBR_DESC' => 32, //                  Prepends members to descriptions without custom message
                        'CU3_MASK_MBR_DESC' => 64, //                      Masks the member number for descriptions without custom message and previous flag set
                        'CU3_API_PLUS'     => 128, //                     Use Plus API features (Balance Only, History on demand, M2M)
                        'CU3_API_XAC'      => 256, //                      Make a XAC packet request from the core for the member
                        'CU3_LONGCODE_MFA' => 512,  //                      By default Odyssey will use Amazon SMS services for sending MFA Codes.  If this is set then it will use the LONG CODE associated with CU
                        'CU3_SORTKEY_MICR' => 1024,  //                      Allow contents of sortkey from core to override check micr info at HomeCU
                        'CU3_QBDOWN'       => 2048, //                        Allow QB download format QuickBooks
                        "CU3_ENROLL_PIN"   => 4096, //                      Flag for having auto activate use the core PIN
                        "CU3_DISALLOW_MULTIPLE_ACCOUNTS" => 8192, //         Flag for disallowing multiple accounts
                        "CU3_DISALLOW_MULT_ACCOUNTS_TRANSFER" => 16384,  //    Flag for disallowing transfers between different accounts
                        "CU3_CREATE_ACCESS_CONTROL_FROM_XAC" => 32768,  //    Flag to determine if we create Access_Control Records from XAC entries instead of the overloaded 000#1234123
                        "CU3_ALLOW_LEAD_ZEROS" => 65536, // Allow CU to have leading zeros on member account numbers
                        "CU3_ALLOW_COOKIE_MIGRATION" => 131072, //Allow CU to migrate older (device) cookies to the new format
                        "CU3_MIR_PACKET_NOT_SUPPORTED" => 262144,    // Do not call MIR packet when not supported by core
                        "CU3_EXCLUDE_XAC_FROM_PROFILE_DESCRIPTIONS" => 524288, // Exclude XAC from profile descriptions
                      );

  /* **  CUDP default flags ** */
  $flagConstants['CU_CUDP_DEFAULT'] = $flagConstants['CU_SORTORDER1'] + $flagConstants['CU_SHOWDEPDIVIDEND'] + $flagConstants['CU_SHOWLNINTEREST']
                 + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT'] + $flagConstants['CU_LNSORT1']
                 + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'];

  /* CUSA default flags */
  $flagConstants['CU_CUSA_DEFAULT'] = $flagConstants['CU_SORTORDER2'] + $flagConstants['CU_SHOWDEPDIVIDEND'] + $flagConstants['CU_SHOWLNINTEREST']
                   + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT'] + $flagConstants['CU_LNSORT1']
                   + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'];

  /* AMI default flags */
  $flagConstants['CU_AMI_DEFAULT'] = $flagConstants['CU_SORTORDER3'] + $flagConstants['CU_CALCRUNBAL'] + $flagConstants['CU_SHOWLNTXNSPLIT']
                   + $flagConstants['CU_LNSORT1'] + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL']
       + $flagConstants['CU_SHOWAVAILABLE'] + $flagConstants['CU_SHOWLNTXNDESC'];

  /* SOSystems default flags */
  $flagConstants['CU_SOS_DEFAULT'] = $flagConstants['CU_SORTORDER3'] + $flagConstants['CU_CALCRUNBAL'] + $flagConstants['CU_LNBALUNUSABLE']
                   + $flagConstants['CU_LNSORT1'] + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL']
                   + $flagConstants['CU_SHOWLNTXNDESC'];

  /* Peerless default flags */
  $flagConstants['CU_PEER_DEFAULT'] = $flagConstants['CU_SORTORDER3'] + $flagConstants['CU_SHOWDEPDIVIDEND'] + $flagConstants['CU_SHOWLNINTEREST']
                   + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT'] + $flagConstants['CU_CALCRUNBAL']
                   + $flagConstants['CU_LNSORT1'] + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'];

  /* Galaxy default flags */
  $flagConstants['CU_GALAXY_DEFAULT'] = $flagConstants['CU_SORTORDER4'] + $flagConstants['CU_SHOWDEPDIVIDEND'] + $flagConstants['CU_SHOWLNINTEREST']
                   + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT'] + $flagConstants['CU_CALCRUNBAL']
                   + $flagConstants['CU_LNSORT2'] + $flagConstants['CU_HIDENA'] + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'];

  /* Compusource default flags */
  $flagConstants['CU_CSOURCE_DEFAULT'] = $flagConstants['CU_SORTORDER5'] + $flagConstants['CU_SHOWDEPDIVIDEND']+ $flagConstants['CU_SHOWLNINTEREST']
                   + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT'] + $flagConstants['CU_LNSORT1']
                   + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'];

  /* CUC default flags */
  $flagConstants['CU_CUC_DEFAULT'] = $flagConstants['CU_SHOWAVAILABLE'] + $flagConstants['CU_SORTORDER1'] + $flagConstants['CU_SHOWDEPDIVIDEND']
                   + $flagConstants['CU_SHOWLNINTEREST'] + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT']
                   + $flagConstants['CU_LNSORT1'] + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'] + $flagConstants['CU_HIDE_PYR'];

  /* generic default flags */
  $flagConstants['CU_GENL_DEFAULT'] = $flagConstants['CU_SORTORDER3'] + $flagConstants['CU_SHOWDEPDIVIDEND'] + $flagConstants['CU_SHOWLNINTEREST']
                   + $flagConstants['CU_SHOWLNTXNDESC'] + $flagConstants['CU_SHOWLNTXNSPLIT'] + $flagConstants['CU_LNSORT1']
                   + $flagConstants['CU_SAVETXNS'] + $flagConstants['CU_COLLECTEMAIL'];

  if (array_key_exists($pConstantName, $flagConstants)) {
    $retVal = $flagConstants[$pConstantName];
  }

  return $retVal;
}
/**
 *  Return the integer value of a predefined constant
 *    FOR ** <client>user.userflags ** constants
 *
 *  These values are typically used in bitwise operations
 *
 *  @param string $pConstantName -- Name of the predefined constant
 *
 *  @return integer
 *                    -- returns 0 on error
 *
 */

function GetUserFlagsValue($pConstantName) {
  $retVal = 0;

  // *** MEMBER FLAG CONSTANTS
  // stored in cuusers.userflags
  // ** Bit Number --- Maximum of a 32 bit integer
  $flagConstants = Array(
                        'MEM_UNUSED'             => 0,    // 0  -   Flag Unused
                        'MEM_FORCE_RESET'          => 2,  // 1  -   Force Reset by Admin
                        'MEM_LOGIN_FAILED_EMAIL' => 4,    // 2  -   Login Failed -- Email Incorrect
                        'MEM_LOGIN_FAILED_QST' => 8, // 8  -   Login Failed -- Challenge Questions
                        'MEM_LOGIN_FAILED_PWD'   => 16,   // 4  -   Login Failed -- Password Incorrect
                        'MEM_ASKBPAY'            => 32,   // 5  -   Flag Member for Bill Pay email
                        'MEM_LOGIN_FAILED_ALIAS' => 64,   // 6  -   Login Failed -- Cannot use account # when alias is set
                        'MEM_LOGIN_FAILED_SAC' => 128,    // 7  -   Login Failed -- Secure Access Code incorrect
                        'MEM_LOGIN_FAILED_BNDL' => 256,    // 8  -   APP Login Failed -- MFABUNDLE missing or invalid
                        'MEM_LOGIN_FAILED_BNDL_TIMEOUT' => 512    // 9  -   APP Login Failed -- APP login process took too long
                      );
  // ** NEXT MEMBER FLAG VALUE = 512
  // ** MAX MEMBER FLAG VALUE = 1073741824  2^30

  if (array_key_exists($pConstantName, $flagConstants)) {
    $retVal = $flagConstants[$pConstantName];
  }
  return $retVal;
}

/**
 *  Return the integer value of a predefined constant
 *    FOR ** cuadminusers.userflags ** constants
 *
 *  These values are typically used in bitwise operations
 *
 *  @param string $pConstantName -- Name of the predefined constant
 *
 *  @return integer
 *                    -- returns 0 on error
 *
 */

function GetAdminUserFlagsValue($pConstantName) {
  $retVal = 0;

  // *** ADMIN FLAG CONSTANTS
  // stored in cuadminusers.userflags
  // ** Bit Number --- Maximum of a 32 bit integer
  $flagConstants = Array(
                      'ADM_UNUSED'                => 0, // 0                    - Flag Unused
                      'ADM_FORCE_RESET'           => 2, // 1                    - Force Reset by Admin
                      'ADM_MASTER_PRIV'           => 4, // 2                    -Admin Privileges
                      'ADM_LOGIN_FAILED_EMAIL'    => 8, // 3                    -Login Failed -- Email Incorrect
                      'ADM_LOGIN_FAILED_QST'      => 16, // 4                   -Login Failed -- Challenge Questions Incorrect
                      'ADM_LOGIN_FAILED_PWD'      => 32, // 5                   -Login Failed -- Password Incorrect
                      'ADM_REMOTE_ACCESS_ALLOWED' => 64  // 6
                    );

  // ** NEXT ADMIN FLAG VALUE = 128
  // ** MAX ADMIN FLAG VALUE = 1073741824  2^30


  if (array_key_exists($pConstantName, $flagConstants)) {
    $retVal = $flagConstants[$pConstantName];
  }
  return $retVal;
}
/**
 *  Return the integer value of a predefined constant
 *    FOR ** msg_tx ** constants
 *
 *  These values are typically used in bitwise operations
 *
 *  @param string $pConstantName -- Name of the predefined constant
 *
 *  @return integer
 *                    -- returns 0 on error
 *
 */
function GetMsgTxValue($pConstantName) {
  $retVal = 0;

  // *** USER msg_tx
  // flag bits stored in cuusers.msg_tx
  // ** Bit Number --- Maximum of a 32 bit integer
  $flagConstants = Array(
                      'MSGTX_TRANSFER'   => 1,    // Transfer
                      'MSGTX_ES'         => 2,    // Estatement
                      'MSGTX_WEBCONNECT' => 4,    // WebConnect
                      'MSGTX_TMP_SURVEY' => 8,    // temporary (session-long) flag for SurveyPopup SURVEY
                      'MSGTX_TMP_XAC_RQ' => 16,   // temporary (session-long) flag to indicate when an XAC packet has been requested
                      'MSGTX_TMP_XAX_LD' => 32,   // temporary (session-long) flag to indicate when an XAC packet has been successfully loaded
                      'MSGTX_INTUITUPD'  => 64,   // IntuitUpdate message
                      'MSGTX_TXNDOWN'    => 128,  // TxnDownload
                      'MSGTX_TMP_MKT'    => 256,  // temporary (session-long) flag for SurveyPopup MESSAGE
                      'MSGTX_FORCE_EM'   => 512,  // 'Force Email Change': when set the member will be prompted for email at login.
                      'MSGTX_PASSCHG'    => 1024, // Passchange
                      'MSGTX_ONLINEDISC' => 2048, // Online Deposits disclosure acceptance - used in OnLineDeposits,
                      'MSGTX_PROMOHIDE'  => 4096, // Promo don't show me again
                      'MSGTX_STICKY'     => 8192, // "Sticky" Promo -- member can't suppress
                      'HCUTEMP_FLAGS'    => 49464 // The sum of all session long flags
                  );
# HCUTEMP_FLAGS value below should reflect the sum of
# temporary (session-long) flags.  This value is used when updating
# the database to avoid storing any temporary flags.
#



  /* ** 16384 is next ** */
  if (array_key_exists($pConstantName, $flagConstants)) {
    $retVal = $flagConstants[$pConstantName];
  }
  return $retVal;
}

/**
 *  Function to return the value to save for msg_tx
 *  This function will auto remove any of the session only values
 */