System Records API: Gb controls quotes vehicle report

Gb_* API endpoints for system record operations

Gb controls quotes vehicle report

qtquotesvehiclereportformatdefaultChoose the default output you want to show on in the Quotes / Vehicle tab. This can be set to 'Office(xlsx)', 'ExcelXml', 'Email-send' or 'Text(CSV)'Office(xlsx)
qtquotesvehiclereportattachmentformatChoose the default file extension to use when attaching this file to 'Dealer Quote Request' emails. A 'dealerquoterequest' form must be set-up in your system with the same format as chosen here. Set the format to one of the following: 'ExcelXml', 'Office(xlsx)' or 'PDF'.
Global ControlRequired TemplateOutput Format
ExcelXmldealerquoterequest.xmlxls
Office(xlsx)dealerquoterequest.xlsxxlsx
PDFdealerquoterequest.xlsxPDF
Office(xlsx)

Gb controls sp

sploginaccessroleUsed in Salary Packaging.package_employee
spspclientpackagingdefaultsbankaccountenabledflagdefaultClients / Packaging Defaults "Client Bank Account" - set a default entry for this field.no
spspclientpackagingdefaultstaxablesalesdefaultClients / Packaging Defaults "Taxable Sales" tab. - set a default entry for this field. Choose from ' only-fees' or 'all-items.only-fees
spspemployeepackageitemsedit_flagSP employee package items edit flag1
spsuperannuationguaranteerateThis rate is used to calculate the default Employees / Contact "Employer Super" amount. Go to the Tax Rates page for the history of this control.0.115

Gb controls web services access flag

gbwebservicesaccess_flagLegacy 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 settingno

Gb dmz upload file destinations

FieldDatatype
dmzuploadfiledestinationidint(10) unsigned
namevarchar(50) NOT NULL
typeENUM (sftp) NOT NULL
configurationBLOB [encrypted]
Password
Hostsftp.supplier.com
Port22
UsernameName
PasswordPassword
Key
Hostsftp.supplier.com
Port22
UsernameName
KeyPassword
Key with Encryption
Hostsftp.supplier.com
Port22
UsernameName
KeyPassword
Encryption
Used by DmzUploadFile scheduler method to encrypt the uploaded file
key_namekeyprovider@encrypt.com.au
keyencryption key. The key is coded into base64 when deployed.
status_flagenum('active','inactive')

Gb mail

Warning: This feature has been deprecated. Please contact your Account Manager if you wish to use this feature.

You can import email messages into the Catch-e mail queue from a spreadsheet template. These emails can then be sent out from the Mail Queue.

The benefits of this feature are that you have a stored record of the email and it allows you the flexibility to design and send a bulk email without needed help from Catch-e staff.

Mail Import Features

  • Multiple To, Cc and Bcc recipients.
  • Read receipt flag for To address.
  • User definable sender and reply to addresses.
  • Email can be associated with a table and record id, e.g. Contracts, Drivers or Clients for linking to Events.
  • Date and Time to send. A scheduled service then sends the emails. If left blank the emails are sent immediately.

Workflow

  • Go to Fleet / Export Data / Whole Table and download a sample file of the table gbmailimport

    Do this by ticking ON the checkboxes for "Include Field Headers" and "5 Sample Rows Only?"
    This will give you a file in the correct layout and format to use as a template for your email file.

  • Populate the spreadsheet with the email you wish to send (remember to delete the 5 sample rows)

  • Save the import file as .csv

  • Go to Fleet / Import Data / Whole Table and import the file into the table gbmailimport

  • Go to System / Mail Queue to view the mail in the queue!

Field Descriptions

FieldTypeDescription
mailimportidIDSystem generated. Upload "0"
mailbatchnoIDSystem generated. Upload "0"
mailitemnoIDSystem generated. Upload "0"
table_nametextE.g. fm_drivers or leave blank if no association
record_idIDRecord ID for the table, e.g. 101949 or leave blank if no association
to_addressestextUse semi colon for multiple addresses, e.g. Ian Rawlingsian.rawlings@catch-e.com.au;Gray Quinngray.quinn@catch-e.com.au
cc_addressestextE.g. demo@catch-e.com.au
bcc_addressestextE.g. demo@catch-e.com.au
sender_addresstextE.g. services@catch-e.com.au. If left blank a global control default address is used.
replytoaddresstextE.g. services@catch-e.com.au.
subjecttextEmail subject.
bodytextEmail body. Can be HTML. See Note below
body_formattextFormat of body content, either 'text' if plain text or 'html' for HTML
readreceiptflagyes or noApplies to "To" addressee only.
datetosendDateUpload in format YYYY-MM-DD or leave blank.
timetosendTime 24 hour formatUpload in format HH:MM:SS or leave blank.
status_flagtext'pending' for mail to send or 'deleted' to remove existing

Special characters can be inserted in the construction of excel formulas, e.g:
&CHAR(13)&CHAR(10) represents a carriage return and line break.

Gb tables

The tables that can be imported or exported can be restricted by updating entries in gb_tables.

This table also controls the sort order that the tables list displays in, if you have tables you use often, you can adjust gb_tables to put these at the top.

If an export is long running, it will be stopped if it exceeds the timeout stored in )

File size limits to the export file process apply.

gb_tables restriction flags and behaviour

import_flagexport_flagexportsamplerowsonlyflagOutcomeComments
yesyesnoCan import, can export, can sampleThis is the default setting for most tables.
yesyesyesCan import, can't export, can sampleCan't export because exportsamplerowsonlyflag = 'yes', a yes here means you can only sample, not export
yesnonoCan import, can't export, can't sampleCan't sample because export flag = 'no', this prevents access to the table, so sampling cannot happen
noyesyesCan't import, can't export , can sampleCan't export because exportsamplerowsonlyflag = 'yes', a yes here means you can only sample, not export
noyesnoCan't import, can export , can sampleSome tables have this setting becaus
nonoyesCan't import, , can't export, can't sampleCan't sample because export flag = 'no', this prevents access to the table, so sampling cannot happen
nononoCan't import, can't export, can't sample

Restricted tables

Some tables are hard-coded, so modifying the settings and uploading them here will not update the table for the records or change their behaviour here. In addition tables can be restricted to the Super role only.

import_flagexport_flagexportsamplerowsonlyflagOutcomeRestricted tables
yesnoyesCan import, can't export, can sampleqt_variants
nononoCan't import, can't export, can't sample13 records: dbsequencebatchno dbsequenceinterfacebatchno dbsequenceinvoiceno dbsequencemailbatchno dbsequencepaymentno gbapiconsumptionlog gbapipermissions gbcontrols gbroleapipermissions gbroleapirestrictions gbsessions gbuserapirestrictions gbuser_passwords
noyesnoCan't import, can export , can't sample39 records: fmcontractbudgets fmcontractcostcentreallocations fmcontractdivisionallocations fmcontractdriverallocations fmcontracteventsimports fmserviceprofilesimport fmsupplierclientcreditrating gbauditimport gbauditimportarchive201810 gbenum gbeventlog gbmail gbmailattachments gbmailrecipients gbmailrecipientstatuses gbqueries gbreferer gbrolekpis gbrolerestrictions gbroleuserrestrictions gbschedulerjobrecipients gbscreenresolutions gbuserroles gbuserrolekpis gbwebservicelog pqmodeloptions pqquotelaptop pqquotesuper pqquotevehicle pqquotevehicleoptions pqratelookup qtinsuranceloadingrates qtinsurerlocationsbypostcode qtoptionalequipmentpacks qtquoteinsurancedisclosures qtquoteinsuranceloadingtypes qtvariantpaints slreceiptimports spunicardtransactions
noyesyesCan't import, can export , can sample5 records: gbaudit gbauditfields gblocks gbuniqueids gl_controls