Global Controls: Global (GB) — Part 2

| gb | mailfooter | Mail footer | Notice: The information contained in this e-mail message and any attached files may be confidential information. If you are not the intended recipient, any use, disclosure or copying of this e-mail is unauthorised. If you have received this e-mail in error, please notify the sender immediately by reply e-mail and delete all copies of this transmission together with any attachments.; || gb | mailfooterhtml | Used to add a footer to HTML markup in mail messages | Inserting HTML markup here will corrupt the structure in the Wiki so a working example isn't possible || gb | mailsendblockflag | This flag turns system emailing on or off. If the flag is 'no', emailing is active. Visit the Mail Send Block Flag page for full details. | no |
| gb | mailsenderaddress | If you have an email configured without an sender's address, the email will use this address. If both and this control are blank, the email's status in will be set to 'failed'. i.e. * * = 'failed'. This value is blank when a new system is created and needs to be updated during configuration. | |
| gb | mailsenderdomainsenforcingflag | Used to control the status of Domain enrolling of SPF Records | no |
| gb | mailsmtpparameters | This control can be used to set alternate settings to SMTP. Alternative settings will not as an example allow Catch-e to manage and report bounce backs. | |
| gb | mailtoaddress | Record the email address that should be used if the user launches the ** icon that is displayed on the system login page. This value is blank when a new system is created and needs to be updated during configuration. | |
| gb | mailtosystemnotification | Store the email address to receive system notifications | || gb | maximumgstclaimable | Maximum GST credit that is claimable. Also visit the LCT Limits page for more details. | 6191.00 (Effective From 2023-07-01) || gb | medicarelevy | Medicare levy | d:0.02 |
| gb | medicarelevyadjustmentscale2 | | |
| gb | medicarelevyadjustmentscale6 | | |
| gb | medicarelevyadjustmentscale7 | | |
| gb | moduleaccess | These are used to set access to the Quote and Packaging modules. Module access is defined in your Hosting Agreement with Catch-e. The most common and popular set-up is shown. If the module is set to 'yes', the modules screens are available to your users if their roles are also configured to allow this. Visit the System Menus page to see how access is configured for each role. If these settings are updated, the changes will not take effect until Catch-e is re-launched in a new browser screen. | || Quotes | yes | | || Packaging | no | | || gb | pageresponsenotificationthreshold | Send notification email to system@catch-e.com.au if the server response time crosses the set threshold. The server response on every page can be checked by looking at footer part that says "server response time is x seconds". Default setting is 30 seconds. | 30 |
| gb | pageresponsenotificationfrequency | Minimum number of seconds between email notifications to Catch-e for slow server response time. Default setting is 60 seconds. | 60 || gb | pageresponsenotificationlastsent | Stores the timestamp when gbcontrols.pageresponsenotificationthreshold has sent the last notification email to Catch-e | b:0; || gb | passwordautorecoveryflag | If set to 'yes', users can reset their own passwords. Visit Resetting Passwords for full details. | no |
| gb | passwordexcludedictionarywordsflag | If set to 'yes', a dictionary word more than certain number of characters cannot be saved. The number of character is defined by [gb]passwordmaximumdictionarywordsize.Visit Password Setup for full details. | no |
| gb | passwordforgottenmessage | On screen message when a password reset requested. Visit Resetting Passwords for full details. | s:219:"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 | passwordforgottenuseridmessage | On screen message when a user has forgotten their User ID or has requested a password reset and they are already 'suspended'. Visit Resetting Passwords for full details. | s:79:"Please contact client by phone on 1300 XXX XXX or by email client@client.com.au"; |
| gb | passwordhistorysize | Describes how many times a password needs to be changed before it can be re-used. Visit Password Setup for full details. | 12 |
| gb | passwordmaximumdictionarywordsize | Defined the number of characters that a dictionary word can be embedded in password. This global control becomes irrelevant if passwordexcludedictionarywordsflag is set to 'no'.Visit Password Setup for full details. | 4 |
| gb | passwordminimumlength | Minimum length requires to set a password. Note ~ a minimum length of four is required, regardless of the value set here. I.e. if this is set to '3', '4' will be applied as the rule.Visit Password Setup for full details. | 8 |
| gb | passwordrequiresnumberflag | If set to 'yes', password cannot be save without having a number.Visit Password Setup for full details. | yes || gb | passwordrequiresletterflag | If set to 'yes', password cannot be save without having a letter.Visit Password Setup for full details. | yes |
| gb | passwordrequiresuppercaseletterflag | If set to 'yes', password cannot be save without having a upper case letter.Visit Password Setup for full details. | yes || gb | passwordrequireslowercaseletterflag | If set to 'yes', password cannot be save without having a lower case letter.Visit Password Setup for full details. | yes |
| gb | passwordrequiresspecialcharacterflag | If set to 'yes', password cannot be save without having a special characters like !,@,#,$ etc.Visit Password Setup for full details. | yes |
| gb | passwordresetaccessdeniedmessage | Password Reset URL expired message. Visit Resetting Passwords for full details. | s:143:"The Password Reset hyperlink has expired. To generate another link, please click on Reset Password on the Login page."; |
| gb | passwordresetactivesessionexistsmessage | Password Reset URL already exists. Visit Resetting Passwords for full details. | s:212:"An email containing password reset instructions has already been sent to your registered email address. Please follow the instruction in that email. Only one password reset email can be active at a time."; || gb | passwordresetsuccessmessage | Password Reset success message. Visit Resetting Passwords for full details. | "Your password has been reset. Re-Login is required. Please close this window and re-login to the system using your normal login process. Thank You." |
| gb | paygcoefficientsscale1 | | || gb | paygcoefficientsscale2 | | |
| gb | paygcoefficientsscale3 | | || gb | paygcoefficientsscale4 | | |
| gb | paygcoefficientsscale5 | | || gb | paygcoefficientsscale6 | | |
| gb | paygcoefficientsscale7 | | || gb | paygftboffsetrates | | |
| gb | paycyclebillingroundingmethod | This control is used to specify the rounding calculation that is to be applied to the calculation of when a rounding method is required. Values may be 'floor','ceil','round' or 'none'. We do not recommend setting this to 'none' as this creates rounding issues in budget calculations. Use either 'floor', 'round' or 'ceil'. This can be updated at a particular effectivedate if needed. This control is also when recalculating Contracts / Billings "Total Billings" if "Periodic Interval" is changed away from a 'Monthly' setting. Visit Pay Cycle Billing for more details. 'floor':ROUNDDOWN (billingperiods/12* paycyclesperyear) = paycyclebillingperiods e.g. 19-2 = 17 (months) 17/1226= 36.83333 =36 (rounded fortnights). 'ceil':ROUNDUP (billingperiods/12 paycyclesperyear) = paycyclebillingperiods 'round':ROUND (billingperiods/12* paycyclesperyear, 0) = paycyclebillingperiods 'none': billingperiods/12* paycyclesperyear = paycyclebillingperiods to 5 decimal places | ceil || gb | psdratesnswevdutiablevaluethreshold | Purchase Stamp Duty Rates are stored here. See Purchase Stamp Duty-exemptions:) for further details | 0.00 || gb | psdratesqld | Purchase Stamp Duty Rates are stored here. See Purchase Stamp Duty for further details | || gb | psdratesvic | Purchase Stamp Duty Rates are stored here. See Purchase Stamp Duty for further details | || gb | regctpupliftrate | reg ctp uplift rate. Go to Registration for full details of registration calculations and set-up. | d:0.1 |
| gb | reportbudgetfeesasactualflag | This flag changes what is calculated and shown in the Actual column of Driver Report for the row "Fees". The posting classes MFEE,IFEE,NFEE,FEE and MCLB are totalled in this row. If this flag is set to "yes", the values of both the amounts billed (Budget) and maintenance + payments records (Actuals) for those posting classes are shown as Actual. If this flag is set to "no", only actual costs from the maintenance records will be shown. | yes || gb | reportsnotavailable | Enter reports here to exclude them from the Fleet / Administration / Reports "Report Title" drop list. Contact Catch-e Support for assistance with this update. | a:0:{} a:1:{i:0;s:10:""assetlist"";} a:4:{i:0;s:10:"driverfbt";i:1;s:20:"driverfbtoperating";i:2;s:12:"clientlogin";i:3;s:10:"assetlist";} || gb | reportqueuetimeouttobackground | Allocates an allowable time to run a system generated report from either Fleet/Administration/Reports or Reporting/Standard Reports menus where the 'Report Queue' flag is checked OFF. When this time is exceeded, the completed report will be sent to the Report Queue screen. If the user has the Report Queue Notifications flag checked ON, an email will be sent alerting the user to the report being available from the Report Queue screen. | 600 (10 minutes) || gb | restratelimit | This control restricts the number of combined rest call requests that can be made to APIs in a given interval. If the limit is reached, the legacy APIs will return the following error: 'CATCHEERRORTOOMANYREQUESTS'. The current token-based APIs will return a HTTP 429 response: "Too many requests". "Minutes" stores the size of the window for the limit calculation. In most cases, this will be set to 1. "Requests" stores the maximum number of requests that can occur within the specified "Minutes" window. The restratelimit is calculated dynamically using the sliding scale calculation. This control is only visible to Catch-e staff. Do not try to edit this control by other means. Contact Catch-e Support to request confirmation of your entries or changes to this setting. | "Minutes" (5) "Requests" (200) |
| gb | restratelimitipwhitelist | This control contains a list of the IP addresses that the "restratelimit" stored above will not apply to. This control is only visible to Catch-e staff. Do not try to edit this control by other means. Contact Catch-e Support to request confirmation of your entries or changes to this setting. | 127.0.0.1, 192.168.70.1 |
| gb | revsfees | This field no longer exists in gbcontrols. Visit the REVS page for an overview of the current functionality. | |
| gb | rolefbtdeclarationsessiontimeoutmaximum | See FBT Declaration Email for full details of this feature. The value is expressed in seconds. I.e. 60 seconds * 60 minutes * 24 hours * 62 days = 5,356,800 | s:7:"5356800"; || gb | salesforceapexinterfaceenabledflag | If you have a Salesforce CRM interface with Catch-e and you are using the Rest Set-up, this will be set to 'yes'. If you are using the SOAP Set-up, this should be set to 'no'. | no || gb | salesforceinterfaceemailonerror | If you have a Salesforce CRM interface with Catch-e and you are using the SOAP Set-up, enter an email address here if you want to receive an email if there has been a Salesforce update error. | || gb | salesforceinterfaceenabledflag | If you have a Salesforce CRM interface with Catch-e and you are using the SOAP Set-up, this control is set to 'yes'. If you have a Salesforce CRM interface with Catch-e and you are using the Rest Set-up, this should be set to 'no'. In the Support environment, this is updated to 'no' on refresh to prevent the function from being triggered. | no |
| gb | salesforceinterfaceserviceworkerenabledflag | If you have a Salesforce CRM interface with Catch-e and you are using the SOAP Set-up and use AWS SQS, this control will be set to 'yes' to queue jobs using a first in first our basis. If you have a Salesforce CRM interface with Catch-e and you are using the Rest Set-up, this should be set to 'no'. | no || gb | smsglobalproviderdetails | Enter the login details provided by your provider which must be SMS Global. These fields are encrypted. | |
| API Key | Enter this | | |
| API Secret | Enter this | | |
| gb | smsprovider | To use the 'sms' method for 2FA the provider must be SMS Global. The control value to use is 'smsglobal'. | || gb | temporarypasswordflag | Turns on temporary passwords feature for the clients. | no || gb | urlchartimagegenerator | URL hosting Chart Image Server. Usually on VPS Container 102 on current host | e.g.http://highcharts-export.catch-e.com.au:3003 |
| gb | urlhtml2pdfrasterizer | | |
| gb | webservicesaccessflag | Legacy Web Services are being progressively deprecated and the planned end date is 31/12/2024. When this control set to 'no' 1. Legacy web services cannot be run. 2. Driver Portal View my balance (Legacy) cannot be run. If you are using HTML Quote template please see additional changes here. This control is only visible to Catch-e staff. Do not try to edit this control by other means. Contact Catch-e Support to request changes to this setting | no || gb | webservicesupsertaccessflag | Legacy Web Services are being progressively deprecated and the planned end date is 31/12/2024. When this control set to 'no', the web service upsert cannot be run. upsert can only run if webservicesaccessflag = 'yes' and webservicesupsertaccessflag = 'yes'. This control is only visible to Catch-e staff. Do not try to edit this control by other means. Contact Catch-e Support to request changes to this setting. | no |
| gb | wholetableexporttimeout | This control can be record the time that is allowed for a Whole Table Export. The default value is 30, (30 seconds). If the export exceeds this time, the export will be cancelled, the exportsamplerowsonlyflag will be set to ‘yes’ for that table, and the user will see the following message; "Whole Table export has exceeded max execution time. Contact Support for assistance."[OK]. | 30 || gb | xlscontrolsFormat) | Enables changes to be made to the default settings of system reports. For example, logo size can be amended to fit on the report. These controls can also be included in the report query to ensure the output has specific results. More information can be found hereFormat#customised-spreadsheet-formats). | |