Global (GB) — Part 1

Global (GB)

The following global controls are available for the Global (GB) Module.

Setup / Reference Data > gb_controls

Module

Name

Comment

Default Value

gb

2factor_auth_enabled_flag

If 'yes', the 2 Factor Authentication process is visible and enabled. If 'no' it is hidden and not used. Catch-e recommends leaving this on even if you choose not to use it, as Catch-e staff use 2FA in Live and Staging environments

yes

gb

2factor_auth_app_token_name

If 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 (for example: [client name]: Operating Lease and Fleet Management)

Blank

gb

2factor_auth_revalidation_days

Allows to bypass 2FA verification if opted for set number of days

0

gb

aba_identification_number_credit

User 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

gb

aba_identification_number_debit

User 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

gb

access_portal_android_app_fingerprints

Used to store tags for Android app authorisation on Google Play Store. Refer task CAT-13834

0

gb

asset_storage_provider

This 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

gb

ato_benchmark_interest

When the 'Operating cost method' is used to calculate the taxable value of a car fringe benefit, this value is used to calculate the deemed interest component of the car's total operating costs

0.0862

gb

ato_depreciation_diminishing

Depreciation rate for Luxury Car Charge

0.25

gb

ato_depreciation_prime_rate

This control is used if the control luxury_charge_depreciation_method is set to "prime". Go to the Luxury Car Charge page for a worked example of the LCC calculation

0.12500

gb

ato_residual_rates

The 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. 12: 0.6563, 24: 0.5625, 36: 0.4688, 48: 0.375, 60: 0.2813

gb

attach_max_file_size

Stores 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

gb

aws_s3_asset_storage_details

This record stores the access keys for Amazon. This is required if your asset_storage_provider is set to s3

gb

azure_ad_oauth2_login

Contains 3 fields: Tenant Id, Client Id and Client Secret. Please refer to Users: Login with Microsoft Account for more details

Blank

gb

bank_accounts

Bank account details (for example: payables used for BECS system). Receivables required for a Receipts (ABA) file to be created. Note: BSB number should be punctuated with a hyphen as NNN-NNN

gb

becs_details

BECS details used for BECS system

gb

billing_auto_search_flag

If 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

gb

bugsnag_enabled_flag

When 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

gb

catche_help_login

Stores 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

gb

catche_login

Stores credentials 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

gb

company_tax_rate

Company 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 calculations will use this Company Tax Rate

d:0.3

gb

country_code

Available 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

gb

csd_rates

CSD rates

gb

csrf_check_flag

If 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

gb

currency_code

Currency code

AUD

gb

data_source_default

Name of data source (for example: Redbook or Glass)

redbook

gb

dmz_path

Path used by web application to interact with the client's DMZ area. The DMZ area is a dedicated Virtual Private Server on a different IP address. Clients are granted access via a chroot jail to download/upload files for use in various interfaces

/var/interface/CLIENT_NAME

gb

driver_portal_android_app_fingerprints

This control is used for Android app authorisation on Google Play store. Visit Driver Portal App for full details

Blank

gb

driver_portal_2factor_auth_enabled_flag

If 'yes', the 2 Factor Authorisation button is displayed on the Driver Portal Home screen. If 'no', it is hidden

yes

gb

driver_portal_attach_receipt_text

If populated, the stored text will be displayed in the Driver Portal Attach Receipt screen

Blank

gb

driver_portal_claims_history_show_attachments_from_date

Enter 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/YYYY' will also work

Blank

gb

driver_portal_attachment_max_size_in_bytes

This 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 (for example: over 20MB), the user will be warned and cannot proceed with the upload. The default value is 20971520 (20 MB)

20971520

gb

driver_portal_display_bank_details_flag

Set this flag to 'yes' to display full bank details on the Driver Portal Banking Details screen

no

gb

driver_portal_enquiry_enabled_flag

If 'yes', the 'Send an Enquiry' button is available on the Driver Portal Home screen

no

gb

driver_portal_hide_funds_summary

This control is set to 'no' by default. Set to 'yes' to hide the View my vehicle balance Funds Summary section

no

gb

driver_portal_no_claims_text

If the Drivers / Contact "Driver Claims" checkbox is unchecked, 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 modified

This feature has been disabled. Contact your provider for assistance

gb

driver_portal_receipt_text

If populated, the stored text will be displayed in the Driver Portal Receipt screen after raising a claim

Blank

gb

driver_portal_sidebar_enabled_text

If 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

gb

driver_portal_password_auto_recovery_flag

The 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

gb

driver_portal_password_forgotten_message

Stores 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

gb

driver_portal_password_forgotten_user_id_message

Stores 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

gb

driver_portal_terms_of_use_text

If populated, the stored text will be displayed in the Driver Portal Terms of Use pop up

Blank

gb

driver_portal_total_attachment_max_size_in_bytes

This 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 (for example: over 100MB), the user will be warned and cannot proceed with the upload. The default value is 104857600 Bytes (100MB)

104857600MB

gb

driver_portal_use_gl_posting_map_reporting

If 'yes' the Driver Portal will display values as reported in the Funds Check pop up screen

yes

gb

driver_portal_view_my_balance_mode

If 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 'hide_funds_available_balance', the 'Funds available to claim' amount is hidden in the 'Vehicle Balance' screen

'hide_funds_available_balance'

gb

driver_portal_view_my_balance_text

Allows 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

gb

driver_portal_view_my_package_balance_from_date

Use 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

See control documentation for example table with Effective From and Value columns

gb

driver_portal_view_my_salary_package_items_status

Update 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

gb

email_attachments_download_link_text

When 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

gb

email_attachments_max_size_in_bytes

This 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 than this, the email will convert the email attachments into URLs

7864320

gb

email_urls_sent_timeout_in_seconds

This 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

gb

excess_km_factor

Store 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

gb

fbt_rebate_rates

FBT rebate rates

gb

fbt_rebate_threshold

FBT rebate threshold

gb

fbt_statutory_rates

FBT statutory rates

gb

fbt_tax_rate

FBT tax rate

0.470

gb

fbt_type1_gross_up_factor

FBT type 1 gross up factor

2.0802

gb

fbt_type2_gross_up_factor

FBT type 2 gross up factor

1.8868

gb

franchise_types

Franchise types

a:2:{s:8:"fmsufv";s:7:"Vehicle";s:8:"fmsufp";s:3:"POS";}

gb

fsl_rates

Fire Service Levy Rates per State. FSL rates 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

glass_vehicle_data_import_timeout

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

gst_rate

GST rate

d:0.1

gb

gst_tolerance

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

gst_tolerance_error_message

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

html2pdf_method

HTML to PDF conversion method

gb

html2pdf_phantomjs_path

Used to control which version of PhantomJS is used for rendering a quote pdf. When set to '/usr/local/phantomjs/bin/phantomjs' version 1.9.7 is used. When set to /usr/local/phantomjs/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 (version 1.9.7) or /usr/local/phantomjs/bin/phantomjs (version 2.1.1)

gb

html2pdf_service_login

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

import_table_data_timeout

Time allowed for validation and importing files (recorded in seconds)

200

gb

income_tax_rates

Income Tax Rates

(complex value)

gb

insurance_at_fault_rate

Insurance at fault rate

d:1.5

gb

insurance_calculation_method

Used to change from the standard insurance calculation to a client specific internal calculation

s:8:"external";

gb

interface_batch_no

Interface batch number

100021

gb

isd_rates

Insurance Stamp Duty rates per State. NSW: 0.05, VIC: 0.10, QLD: 0.09, SA: 0.11, WA: 0.10, NT: 0.10, TAS: 0.10, ACT: 0.04

gb

login_access_generate_password_flag

Generate password on login access

no

gb

login_background_image_paths

This control can be utilised for customising 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 gb_files file import process

/images/backgrounds/login-background-1.webp

gb

luxury_car_fuel_efficient_combined_litres_per_100km

Fuel Efficient L/100km vehicle definition for Luxury Cars. Visit the LCT Limits page for details

3.5

gb

luxury_car_fuel_efficient_limit

The limit above which fuel efficient luxury cars are subject to luxury car tax. Visit the LCT Limits page for details

gb

luxury_car_fuel_efficient_limit_net

Used to calculate luxury car tax where the combined fuel consumption is less than or equal to luxury_car_fuel_efficient_combined_litres_per_100km. Visit the LCT Limits page for details

gb

luxury_car_limit

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

luxury_car_limit_net

Visit the LCT Limits page for details

gb

luxury_car_tax_rate

Visit the LCT Limits page for details. (33% from 01/07/2008, previously set to 25%)

0.33

gb

luxury_car_threshold

Used to calculate luxury car tax for non fuel efficient vehicles. Visit the LCT Limits page for details

gb

luxury_charge_deemed_profit_flag

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

maclease_partner_login

Use to validate Maclease Partner Interface file credentials to allow a finance application to be submitted

gb

mail_batch_no

Mail batch number

100944