Global Controls: Global (GB) — Part 1

System-wide configuration settings

Global (GB)

ModuleNameCommentDefault Value
gb2factorauthenabled_flagIf 'yes', the 2 Factor Authentication process is visible and enabled. If 'no' it is hidden and not used. We recommend leaving this on even if you choose not to use it, as Catch-e's staff do use 2FA in your Live and Staging environments.yes
gb2factorauthapptokennameIf populated, this will set the text in 2factor token name (Account Label) in the Authenticator App. If this is blank the default token name will be used e.g. [client name]: Operating Lease & Fleet ManagementBlank
gb2factorauthrevalidation_daysAllows to bypass 2FA verification if opted for set number of days0
gbabaidentificationnumber_creditUser Identification Number which is assigned by APCA and User Financial Institutions for transacting credit ABA files. This is used in the Accounts / Export to BECS / Reimbursements (ABA) and Fleet / Payments / Periodic → Payments (ABA)) files.0
gbabaidentificationnumber_debitUser Identification Number which is assigned by APCA and User Financial Institutions for transacting debit ABA files. This is used in the Fleet / Receivables → Allocate → Receipts (ABA)) file.0
gbaccessportalandroidappfingerprintsUsed to store tags for Android app authorisation on Google Play Store. Refer task CAT-138340
gbassetstorageproviderThis flag controls where attachments are stored. The default supplier for storing attachments is 's3', this is provided by Amazon. "symlink" is another option. Visit the Attach page for more details.s3
gbatobenchmarkinterestWhen the 'Operating cost method' is used to calculate the taxable value of a car fringe benefit, this value used to calculate the deemed interest component of the car's total operating costs.0.0862
gbatodepreciationdiminishingDepreciation rate for Luxury Car Charge0.25
gbatodepreciationprime_rateThis control is used if the control luxurychargedepreciation_method is set to "prime". Go to the Luxury Car Charge page for a worked example of the LCC calculation..12500
gbatoresidualratesThe appropriate ATO residual rate defaults into the Quotes / Finance "Residual Rate" field when a new novated lease quote is being created. If the lease term falls between two rates, a pro-rated percentage is calculated and applied.
120.6563
240.5625
360.4688
480.375
600.2813
gbattachmaxfile_sizeStores the maximum allowable size of a file to be stored in the table using the Attach button in the system. The default allowable size is 5 MB (stored in bytes) which can be increased or decreased using this control.5242880
gbawss3assetstoragedetailsThis record stored the access keys for the amazon. This is required if your assetstorageprovider is set to s3.
gbazureadoauth2_loginContains 3 fields. Tenant Id, Client Id & Client Secret. Please refer to Users:Login with Microsoft Account for more details.Blank.
gbbank_accountsBank account details - e.g. payables used for BECS system (refer Note below). Receivables required for a Receipts(ABA)) file to be created. Note also BSB number should be punctuated with a hyphen as NNN-NNN
gbbecs_detailsBECS details - used for BECS system (refer Note below)
gbbillingautosearch_flagIf this flag is set to "yes", the Billing screens will execute a billing search based on today's date. If set to "no", the search will not be executed until the user has specified the search criteria and clicked on "Go". Go to Billing Set-up for details of the billing process.yes
gbbugsnagenabledflagWhen this control is set to 'yes', system errors will be monitored by Catch-e via the https://www.bugsnag.com/ tool. This control is display-only for user information and is managed by Catch-e staff.yes
gbcatchehelploginStores user login and password used to open the Help wiki. The stored value is encrypted. The flag is not available in the Setup/Reference Data → Global Controls screen
gbcatche_loginStores user login and password used by scheduler to run the scheduler jobs. The stored value is encrypted. The flag is not available in the Setup/Reference Data → Global Controls screen
gbcompanytaxrateCompany tax rate used for Luxury Car Charge calculations unless the Client Company Tax Rate field is populated (non-zero). It will be used in the Luxury Car Charge calculation (both methods). If Company Tax Rate is zero the the calculations will use this Company Tax Rate.d:0.3
gbcountry_codeAvailable options are 'AUS' or 'NZ'. If 'AUS', all Australian states are shown. If 'NZ', 'NZ' is the only choice when selecting "State" in the Quotes / Contract and Contracts / Contract tabs. Visit the New Zealand page for more details about set-up and settings for New Zealand.AUS
gbcsd_ratesCSD rates
gbcsrfcheckflagIf set to 'no' cross sessions will not be checked and the cross session error will not be triggered. The default is 'yes'. The flag is not available in the Setup/Reference Data → Global Controls screen and Catch-e staff will only update this flag to 'no' in special circumstances.yes
gbcurrency_codeCurrency codeAUD
gbdatasourcedefaultName of data source. I.e. Redbook or Glass.redbook
gbdmz_pathPath used by web application to interact with the client's DMZ area. The DMZ area is dedicated Virtual Private Server on a different IP address. Client's are granted access via a chroot jail to download / upload files for use in various interfaces./var/interface/CLIENT_NAME
gbdriverportalandroidappfingerprintsThis control is using for Android app authorisation on Google Play store,Visit Driver Portal App for full detailsBlank.
gbdriverportal2factorauthenabled_flagIf 'yes', the 2 Factor Authorisation button is displayed on the Driver Portal Home screen. If 'no', it is hidden.yes
gbdriverportalattachreceipttextIf populated, the stored text will be displayed in the Driver Portal Attach Receipt screen.Blank.
gbdriverportalclaimshistoryshowattachmentsfrom_dateEnter a date here to limit which attachments can be downloaded from the Claims History screen in the Driver Portal. Claims with a header "Date" on or after the dated entered here will be available. Attachments are not limited by default. The recommended format is 'YYYY-MM-DD', but 'DD/MM/YYYYY' will also work.Blank
gbdriverportalattachmentmaxsizeinbytesThis control sets the size limit of a particular file attached to a claim in the Driver Portal. If the user attaches files that are larger than this (e.g. over 20MB), the user will be warned and cannot proceed with the upload. The default value is 20971520 (20 MB).20971520
gbdriverportaldisplaybankdetails_flagSet this flag to 'yes' to display full bank details on the Driver Portal Banking Details screen.no
gbdriverportalenquiryenabledflagIf 'yes', the 'Send an Enquiry' button is available on the Driver Portal Home screen.no
gbdriverportalhidefundssummaryThis control is set to 'no' by default. Set to 'yes' to hide the View my vehicle balance Funds Summary section.no
gbdriverportalnoclaimstextIf the Drivers / Contact "Driver Claims" checkbox is un-checked, the driver cannot create new claims in the Contracts / Claim tab or the Driver Portal and the message stored in this record is shown if they try. This text can be modifiedThis feature has been disabled. Contact your provider for assistance.
gbdriverportalreceipt_textIf populated, the stored text will be displayed in the Driver Portal Receipt screen after raising a claim.Blank.
gbdriverportalsidebarenabledtextIf set to 'yes', drivers can see a sidebar menu icon. When clicked, drivers can access the Contact Details and Employment Details screens in the Driver Portal.no
gbdriverportalpasswordautorecovery_flagThe Forgot Username? Forgot Password? feature is turned off in the Driver Portal and Employee Portal by default. Change the value here to 'yes' to enable this feature.no
gbdriverportalpasswordforgottenmessageStores the message to be displayed to the user confirming the password reset process has started. If you have Channel Portals and want channel specific messages, this control should be blank.Thank you. An e-mail will be sent to your registered e-mail address shortly with further instructions for resetting your password. If you do not receive an e-mail within 10 minutes please call your system administrator.
gbdriverportalpasswordforgottenuseridmessageStores a message to be displayed when you click on Forgot Username. If you have Channel Portals and want channel specific messages, this control should be blank.Please contact your System Administrator to reset your password
gbdriverportaltermsofuse_textIf populated, the stored text will be displayed in the Driver Portal Terms of Use pop-up.Blank.
gbdriverportaltotalattachmentmaxsizein_bytesThis control sets the total size limit of all files attached to a claim in the Driver Portal. If the user attaches files that total more than this (e.g. over 100MB), the user will be warned and cannot proceed with the upload. The default value is 104857600 Bytes (100MB).104857600MB
gbdriverportaluseglpostingmapreportingIf 'yes' the Driver Portal will display values as reported in the Funds Check pop-up screen.yes
gbdriverportalviewmybalance_modeIf this is set to 'hide', the View my vehicle balance button is hidden on the Driver Portal Home Screen. For all other values, it is shown. If this is set to 'show', the 'Funds available to claim' amount is shown in the 'Vehicle Balance' screen. This amount is aligned to the Funds Check 'Current Funds Balance (incl GST)' amount. If this set to ‘hidefundsavailable_balance’, the 'Funds available to claim' amount is hidden in the 'Vehicle Balance' screen.‘hidefundsavailable_balance’
gbdriverportalviewmybalance_textAllows you to customise the text to be displayed on the new style View my balance report.Notes: Funds received are those processed at report date Pending and requested claims are not included
gbdriverportalviewmypackagebalancefrom_dateUse this control to restrict the transactions displayed on the ‘Transactions’ screen in the Employee Portal. The default setting is for no restrictions, so all stored transactions will be displayed. Enter a date in the '"Value" field to show only transactions dated on or after the entered "Value" date. Acceptable date formats are 'dd/mm/yyyy' and 'yyyy-mm-dd'. No other date format will work. Use the "Effective From" date to specify when the control should be invoked. E.g.
Effective FromValueComment
01/04/2022Until 01/04/2024, all transactions on or after 01/04/2022 will be displayed.
01/04/202401/04/2023From 01/04/2024, all transactions on or after 01/04/2023 will be displayed.
0000-00-00
gbdriverportalview_ mysalarypackageitemsstatusUpdate these settings to restrict which items are displayed on the View my salary package screen. Items are shown if the status setting here is 'yes'. Set the control to 'no' to hide them. When items are hidden on this screen, their transactions will still be shown in the View my salary package balance screen. Visit the Driver Portal Setup page to review all the required settings.'yes' for each Status.
gbemailattachmentsdownloadlinktextWhen email attachments are converted into URLs, this text is inserted at the end of the email body. The default text is shown here.Due to mail size restrictions, your attachments have been automatically converted to download links for your convenience. Links will expire in 2 days.
gbemailattachmentsmaxsizein_bytesThis control sets the maximum allowable size of email attachments. The default value is 7864320 (7.5MB) which is the maximum size that the Amazon SES email method will support. If emails are sent with attachments that are larger thank this, the email will convert the email attachments into URLs.7864320
gbemailurlsenttimeoutin_secondsThis control governs how long email attachments converted into URLs can remain valid for. Once the expiry time is reached, the URL will not work anymore. The default value is 172800 (2 days).172800
gbexcesskmfactorStore the factor you want to use to calculate the Quotes / Lease "Excess KM Charge" amount. Visit the Excess KM Charge page for all of the feature details.2.0
gbfbtrebaterates
gbfbtrebatethreshold
gbfbtstatutoryratesfbt statutory rates
gbfbttaxratefbt tax rate0.470
gbfbttype1grossupfactorfbt type1 gross up factor2.0802
gbfbttype2grossupfactorfbt type2 gross up factor1.8868
gbfranchise_typesa:2:{s:8:"fmsufv";s:7:"Vehicle";s:8:"fmsufp";s:3:"POS";}

| gb | fslrates | Fire Service Levy Rates per State. fslrates are used in calculating quote insurance rates and are also stored as a component of the contract insurance payment record. This control value is still 'called' for the calculations, so all the supporting fields and settings currently remain in place for all states. NSW is the only state currently charging this levy.
| gb | glassvehicledataimporttimeout | The scheduler job methods qt / glass / importVehicleData will timeout if they take longer than the time stored here (seconds). Increase the timeout if required. | 600 |
| gb | gstrate | GST rate | d:0.1 || gb | gsttolerance | Sets GST tolerance range that is applied in a range of screens where GST is calculated or transacted. Go to GST Checks for feature details. | a:2:{s:5:"under";s:2:"99";s:4:"over";s:2:"99";} |
| gb | gsttoleranceerrormessage | To give error when GST value is incorrect in Contracts/Approvals. Go to GST Checks for feature details. | Invalid GST amount. GST amount is out of tolerance! || gb | html2pdfmethod | | |
| gb | html2pdfphantomjspath | Used to control which version of PhantomJS is used for rendering a quote pdf. When set to '/usr/local/phantomjs/bin/phantomjs-webfonts' version 1.9.7 is used. When set to /usr/local/phantomjs-2.1.1-linux-x8664/bin/phantomjs version 2.1.1. Version 2.1.1 will provide for active hyperlinks which can be embedded in the quote html. | /usr/local/phantomjs/bin/phantomjs-webfonts /usr/local/phantomjs-2.1.1-linux-x8664/bin/phantomjs |
| gb | html2pdfservicelogin | Add a user login and password here to use the API Render Quote PDF. This user should have a 'webservices' role. Catch-e recommends this user be used only for this function. | || Login | encrypted | | || Password | encrypted | | || gb | importtabledatatimeout | Time allowed for validation and importing files recorded in seconds | 200 |
| gb | incometaxrates | Income Tax Rates | (complex value) |
| gb | insuranceatfaultrate | Insurance at fault rate | d:1.5 || gb | insurancecalculationmethod | used to change from the standard insurance calculation to a client specific internal calculation. | s:8:"external"; || gb | interfacebatchno | Interface batch no | 100021 || gb | isdrates | Insurance Stamp Duty rates per State | a:8{ "act" = ".04"; "nsw"= ".05"; "vic" = ".10"; "qld" = ".09"; "sa" = ".11"; "wa" ".10"; "nt"= ".10"; "tas" = ".10" |
| gb | loginaccessgeneratepasswordflag | | no |
| gb | loginbackgroundimagepaths | This control can be utilized for customizing the background images of the login screen and reset password screen(s) by updating the array of image paths in the control. Clients can have their own backgrounds which can be added to version control during the initial client setup process – or uploaded using the gbfiles file import process | /images/backgrounds/login-background-1.webp |
| gb | luxurycarfuelefficientcombinedlitresper100km | Fuel Efficient L/100km vehicle definition for Luxury Cars. Visit the LCT Limits page for details. | 3.5 |
| gb | luxurycarfuelefficientlimit | The limit above which fuel efficient luxury cars are subject to luxury car tax. Visit the LCT Limits page for details. | |
| gb | luxurycarfuelefficientlimitnet | Used to calculate luxury car tax where the combined fuel consumption is less than or equal to luxurycarfuelefficientcombinedlitresper100km. Visit the LCT Limits page for details. | || gb | luxurycarlimit | Used to calculate GST claimable on the quote/finance screen. Also used for calculating maximum allowable depreciation for luxury cars. Visit the LCT Limits page for details. | || gb | luxurycarlimitnet | Visit the LCT Limits page for details. | |
| gb | luxurycartaxrate | Visit the LCT Limits page for details. (33% from 01/07/2008, previously set to 25%) | 0.33 || gb | luxurycarthreshold | Used to calculate luxury car tax for non fuel-efficient vehicles. Visit the LCT Limits page for details. | || gb | luxurychargedeemedprofitflag | Apply deemed profit on sale or not. This is used in the Luxury Car Charge diminishing method calculation. Visit the LCT Limits page for details. | no || gb | macleasepartnerlogin | Use to validate Maclease Partner Interface file credentials to allow a finance application to be submitted. | || gb | mailbatch_no | Mail batch no | 100944 |