Permissions & Restrictions: Role Restrictions

Role restriction matrices by module

Role Restrictions

Role restrictions allow control over which menu items and fields a particular role can see or use.

Menu items can be set to be visible and accessible, or are hidden. Go to the System Menus page for details of what can be configured for menus.

Selected fields can be restricted to be 'Read Only' or 'Hidden' if required and details are listed below. The list is not a definitive list of all fields governed by gbrolerestrictions. Your Account Manager can assist you if you want to modify access to system fields.

A number of fields in the Quotes, Contracts and Clients modules are set to 'Read Only' for the Channel Manager role to restrict their ability to change settings.

Bespoke fields use a different configuration for setting up role restrictions. Visit Bespoke Role Restrictions for details.

Field Settings

NameComments
System Menustype = pagemap, restrictiontype = bit_arrayChanges to menu access requires extensive testing.

Fleet / Administration / Approvals

Namemodulepagesub_pagetypenamerestriction_typeComments
Approval
R (Recharge flag)fmapprovalsapprovalfieldfmmairecharge_flag'display_only' or 'hidden'If restrictiontype = 'display-only', the field name and field will be read only. If restrictiontype = 'hidden', the column will be hidden.

Fleet / Administration / Suppliers

Namemodulepagesub_pagetypenamerestriction_typeComments
Account
Disclose Transactionsfmsuppliersaccountfieldfmsupexternalroledisclosetransactionsflagdisplay-only
Allow Duplicate Referencefmsuppliersfieldfmsupallowduplicatereference_flag
Payeefmsuppliersaccountfieldfmsuppayee_iddisplay-only
Pay Methodfmsuppliersaccountfieldfmsuppaymentmethodiddisplay-only
Events
Userfmsuppliersfieldfmsupeuserideditdisplay-onlyThe field is display-only and cannot be edited by the listed roles.
Franchise Details
Road Worthyfmsuppliersfranchise_detailsfieldfmsufvroadworthyflag
Road Worthy (State Transfer)fmsuppliersfranchise_detailsfieldfmsufvroadworthystatetransferflag
Pickup & Deliveryfmsuppliersfranchise_detailsfieldfmsufvpickupdeliveryflag
LPG Servicingfmsuppliersfranchise_detailsfieldfmsufvlpgservicingflag

Fleet / Card Services

Namemodulepagesub_pagetypenamerestriction_typeComments
Cards
Account Numberfmcaraccount_number

Fleet / Controls

Namemodulepagesub_pagetypenamerestriction_typeComments
Maintenance / VMRS Codes
Odometer(Scheduled Service km)odometerScheduled Service km
Capped Price Servicecappedpriceservice_flag
Accounts / Contract Types → Details
Quote Payload Maximumglmapsquotemaximumpayload
Accounts / Posting Classes → Details
Disclose Transactionsglclassesdetailsfieldglposcexternalroledisclosetransactionsflag'display-onlyIf restriction_type = 'display-only', the field name and field will be read only

Fleet / Payments

Namemodulepagesub_pagetypenamerestriction_typeComments
Periodic
Un-Postfmpaymentsbusiness_ruleunposthiddenIf set, the user cannot Un-Post a payment batch that has been exported. 'admin' role has access as the default setting.

Packaging / Employees

Namemodulepagesub_pagetypenamerestriction_typeComments
Item
Payeespemployeesitemfieldspempipayeepaymentmethod_iddisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
Payment Methodspemployeesitemfieldspempipayeepaymentmethod_iddisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
Contact
Cost Centrespemployeescontactfieldfmdriclientcostcentre_iddisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
Allowancesspemployeescontactfieldfmdriallowancesdisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
Employer Superspemployeescontactfieldfmdriemployer_superdisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
Employee Superspemployeescontactfieldfmdriemployee_superdisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
HELP Debtspemployeescontactfieldfmdriatoloanflagdisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.
2FAspemployeescontactfield2faenrollmentflagdisplay-onlyIf restriction_type = 'display-only', the field name and field will be read only.

Users / Details

  • Password Expiry Days (field) — If restrictiontype = 'display-only', the field name and field will be read only. By default the Users / Details tab is only visible to 'admin' role users. gb users details gbusepasswordexpirydays displayonly

System / Roles

Namemodulepagesub_pagetypenamerestriction_typeComments
Roles / Details
Salary Packaged Contractsgbrolesdetailsfieldgbrolsalarypackagedcontracts_flagdisplay_onlyIf restriction_type = 'display-only', the field name and field will be read only.

Useful SQL

Run this SQL to show all Role Restriction records in your database.

SELECT t2.name, t1.*FROM gb_role_restrictions t1INNER JOIN gb_roles t2 ON t2.role_id = t1.role_idWHERE t1.module IN ('qt','fm','gb','gl','bk','rp','sp')AND t1.page LIKE '%%' -- module descriptionAND t1.sub_page LIKE '%%' -- tab nameAND t1.type LIKE '%%' -- type of restrictionAND t1.name LIKE '%%' -- field nameAND t1.restriction_type LIKE '%%' -- display_only, hidden etcAND t1.bit_array LIKE '%%' -- for Menu configurationAND t1.conditions LIKE '%%' -- for restriction conditionsAND t2.name LIKE '%%' -- Role NameORDER BY t2.name, t1.page, t1.name;

Clients

Clients

NameComments

| Client tabs | type = subpagemap, restrictiontype = bitarray | The client tabs that are accessed by roles can be configured by updating the bit array. By default, the Cost Centre and Other tabs are hidden. Note: The Clients / Other tab will not be available to external users, regardless of the bit_array setting entered here.

SELECT * FROM gb_role_restrictions WHERE page = 'clients' AND type = 'sub_page_map' ORDER BY role_id;

|

Contact

NameComments
Client Codefmcliclient_code
Client Namefmcliname
Address 1fmcliaddress1
Address 2fmcliaddress2
Statefmclistate
Post Codefmclipcode
Phonefmcliphone
ABNfmcliabn
ACNfmcliacn
A/C Managerfmcliuser_id
Salesfmcliuseridsales
Client ID ExternalfmcliclientidexternalField can be set as display only or hidden.
Group/Commentfmcligclientgroupcode
Group/Commentfmcliclientgroupnote
Contact 1 / Namefmclicontact1_name
Contact 1 / Job Titlefmclicontact1jobtitle
Contact 1 / Phonefmclicontact1_phone
Contact 1 / Emailfmclicontact1_email
Contact 1 / Interests/Commentsfmclicontact1_note
Contact 2 / Namefmclicontact2_name
Contact 2 / Job Titlefmclicontact2jobtitle
Contact 2 / Phonefmclicontact2_phone
Contact 2 / Emailfmclicontact2_email
Contact 2 / Interests/Commentsfmclicontact2_note
A/C Payable / Namefmclicontact3_name
A/C Payable / Job Titlefmclicontact3jobtitle
A/C Payable / Phonefmclicontact3_phone
A/C Payable / Emailfmclicontact3_email
A/C Payable / Interests/Commentsfmclicontact3_note
CC / Namefmclicontact4_name
CC / Job Titlefmclicontact4jobtitle
CC / Phonefmclicontact4_phone
CC / Emailfmclicontact4_email
CC / Interests/Commentsfmclicontact4_note
Payroll / Namefmclicontact5_name
Payroll / Job Titlefmclicontact5jobtitle
Payroll / Phonefmclicontact5_phone
Payroll / Emailfmclicontact5_email
Payroll / Interests/Commentsfmclicontact5_note

MLA

Namemodulepagesub_pagetypenamerestriction_typeComments
Column One
Facility Typefmclifacilitytypeiddisplay-onlyIf restriction_type = 'display-only', the field will be displayed but is not editable.
Credit Ratingfmcliclientcreditratings_iddisplay-onlyIf restriction_type = 'display-only', the field will be displayed but is not editable.
Limitfmclifinance_limitdisplay-onlyIf restriction_type = 'display-only', the field will be displayed but is not editable.
Review Datefmclifinancereviewdatedisplay-onlyIf restriction_type = 'display-only', the field will be displayed but is not editable.

Quote Defaults

  • Luxury Charge Event — If restrictiontype = 'display-only', the field will be displayed, but is not editable. fmcliluxurychargeeventflag
  • Novated Management Fee fmclinovatedmanagementfee
  • Payroll Date — If restrictiontype = 'display-only', the field will be displayed, but is not editable. fmclipayrolldate
  • Allow Operating FBT Type — If restrictiontype = 'display-only', the field will be displayed, but is not editable. If restrictiontype = 'hidden', the field name and field will be hidden. fmcliallowoperatingfbttypeflag
  • Financier qtclidsupplieridfinancier
  • Agreed Lessee Rate — If restrictiontype = 'display-only', the field will be displayed, but is not editable. fmcliagreedlessee_rate
  • Management Fee qtclidmanagement_fee
  • Novated Commission Rate qtclidnovatedcommissionrate
  • Pay Cycle — If restrictiontype = 'display-only', the field will be displayed, but is not editable fmclipaycycle_id
  • Payroll Date — If restrictiontype = 'display-only', the field will be displayed, but is not editable. fmclipayrolldate
  • Pay Cycle 2 — If restrictiontype = 'display-only', the field will be displayed, but is not editable fmclipaycycle_id2
  • Payroll Date 2 — If restrictiontype = 'display-only', the field will be displayed, but is not editable. fmclipayrolldate2
  • Pay Cycle 3 — If restrictiontype = 'display-only', the field will be displayed, but is not editable fmclipaycycle_id3
  • Payroll Date 3 — If restrictiontype = 'display-only', the field will be displayed, but is not editable. fmclipayrolldate3
  • Payroll Cut Off Days — If restrictiontype = 'display-only', the field will be displayed, but is not editable fmclipayrollcutoffdays

Contract Defaults

Namemodulepagesub_pagetypenamerestriction_typeComments
Finance Budget Term Deferredfmclientscontract_defaultsfieldfmclifinancebudgettermdeferredflagdisplay-only
Recall Notice Notefmclientscontract_defaultsfieldfmclirecallnoticenotedisplay-onlyThis field cannot be hidden.

Financiers

Namemodulepagesub_pagetypenamerestriction_typeComments
Facility Typefmclientsfinanciersfieldfmcliffacilitytypeiddisplay-onlyThis field cannot be hidden.

Events

Namemodulepagesub_pagetypenamerestriction_typeComments
Userfmclientseventsfieldfmclieuserideditdisplay-only

Contact List

Namemodulepagesub_pagetypenamerestriction_typeComments
Screen Function Buttonsfmclientscontact_listbottomcontrolsmapbit_arrayIf set, the function buttons at the bottom right of the screen are hidden

Contact details

Namemodulepagesub_pagetypenamerestriction_typeComments
Client Allocationsfmclientscontact_detailclient_allocationdisplay_only
Contact Type Allocationsfmclientscontact_detailcontacttypeallocationdisplay_only

Cost Centre

Namemodulepagesub_pagetypenamerestriction_typeComments
Cost Centrefmclientscost_centrefieldfmclccdescriptiondisplay-only