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 gb_role_restrictions. 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

Name	Comments
System Menus	type = page_map, restriction_type = bit_array. Changes to menu access requires extensive testing

Fleet Administration: Approvals

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Recharge Flag (R)	fm	approvals	approval	field	fm_mail_recharge_flag	display_only / hidden	If restriction_type = 'display-only', the field name and field will be read only. If restriction_type = 'hidden', the column will be hidden

Fleet Administration: Suppliers

Account

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Disclose Transactions	fm	suppliers	account	field	fm_sup_external_role_disclose_transactions_flag	display-only
Allow Duplicate Reference	fm	suppliers		field	fm_sup_allow_duplicate_reference_flag
Payee	fm	suppliers	account	field	fm_sup_payee_id	display-only
Pay Method	fm	suppliers	account	field	fm_sup_payment_method_id	display-only

Events

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
User	fm	suppliers		field	fm_sup_e_user_id_edit	display-only	The field is display-only and cannot be edited by the listed roles

Franchise Details

Name	Module	Page	Sub Page	Type	Field
Road Worthy	fm	suppliers	franchise_details	field	fm_sufv_road_worthy_flag
Road Worthy (State Transfer)	fm	suppliers	franchise_details	field	fm_sufv_road_worthy_state_transfer_flag
Pickup & Delivery	fm	suppliers	franchise_details	field	fm_sufv_pickup_delivery_flag
LPG Servicing	fm	suppliers	franchise_details	field	fm_sufv_lpg_servicing_flag

Fleet Card Services

Cards

Name	Module	Page	Sub Page	Type	Field
Account Number	fm	cards		field	fm_car_account_number

Fleet Controls

Maintenance / VMRS Codes

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Odometer (Scheduled Service km)				field	odometer		Scheduled Service km
Capped Price Service				field	capped_price_service_flag

Accounts / Contract Types: Details

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Quote Payload Maximum				field	gl_maps_quote_maximum_payload

Accounts / Posting Classes: Details

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Disclose Transactions	gl	classes	details	field	gl_posc_external_role_disclose_transactions_flag	display-only	If restriction_type = 'display-only', the field name and field will be read only

Fleet Payments

Periodic

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Un-Post	fm	payments		business_rule	unpost	hidden	If set, the user cannot Un-Post a payment batch that has been exported. 'admin' role has access as the default setting

Salary Packaging: Employees

Item

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Payee	sp	employees	item	field	sp_empi_payee_payment_method_id	display-only	If restriction_type = 'display-only', the field name and field will be read only
Payment Method	sp	employees	item	field	sp_empi_payee_payment_method_id	display-only	If restriction_type = 'display-only', the field name and field will be read only

Contact

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Cost Centre	sp	employees	contact	field	fm_dri_client_cost_centre_id	display-only	If restriction_type = 'display-only', the field name and field will be read only
Allowances	sp	employees	contact	field	fm_dri_allowances	display-only	If restriction_type = 'display-only', the field name and field will be read only
Employer Super	sp	employees	contact	field	fm_dri_employer_super	display-only	If restriction_type = 'display-only', the field name and field will be read only
Employee Super	sp	employees	contact	field	fm_dri_employee_super	display-only	If restriction_type = 'display-only', the field name and field will be read only
HELP Debt	sp	employees	contact	field	fm_dri_ato_loan_flag	display-only	If restriction_type = 'display-only', the field name and field will be read only
2FA	sp	employees	contact	field	2fa_enrollment_flag	display-only	If restriction_type = 'display-only', the field name and field will be read only

Users: Details

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Password Expiry Days		details	field	gb_user_password_expiry_days	display-only	If restriction_type = 'display-only', the field name and field will be read only. By default the Users / Details tab is only visible to 'admin' role users

System: Roles

Roles / Details

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Salary Packaged Contracts	gb	roles	details	field	gb_rol_salary_packaged_contracts_flag	display_only	If 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 t1 INNER JOIN gb_roles t2 ON t2.role_id = t1.role_id WHERE t1.module IN ('qt','fm','gb','gl','bk','rp','sp') AND t1.page LIKE '%%' -- module description AND t1.sub_page LIKE '%%' -- tab name AND t1.type LIKE '%%' -- type of restriction AND t1.name LIKE '%%' -- field name AND t1.restriction_type LIKE '%%' -- display_only, hidden etc AND t1.bit_array LIKE '%%' -- for Menu configuration AND t1.conditions LIKE '%%' -- for restriction conditions AND t2.name LIKE '%%' -- Role Name ORDER BY t2.name, t1.page, t1.name;

Clients

Client Tabs

Setting	Type	Restriction Type	Comments
Client tabs	sub_page_map	bit_array	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

View Client Tab Configuration SQL

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

Clients: Contact

Field Name	Table.Field	Comments
Client Code	fm_cli.client_code
Client Name	fm_cli.name
Address 1	fm_cli.address1
Address 2	fm_cli.address2
State	fm_cli.state
Post Code	fm_cli.pcode
Phone	fm_cli.phone
ABN	fm_cli.abn
ACN	fm_cli.acn
Account Manager	fm_cli.user_id
Sales	fm_cli.user_id_sales
Client ID External	fm_cli.client_id_external	Field can be set as display only or hidden
Group/Comment	fm_cli.gb_client_group_code
Group/Comment Note	fm_cli.client_group_note
Contact 1 / Name	fm_cli.contact1_name
Contact 1 / Job Title	fm_cli.contact1_job_title
Contact 1 / Phone	fm_cli.contact1_phone
Contact 1 / Email	fm_cli.contact1_email
Contact 1 / Interests/Comments	fm_cli.contact1_note
Contact 2 / Name	fm_cli.contact2_name
Contact 2 / Job Title	fm_cli.contact2_job_title
Contact 2 / Phone	fm_cli.contact2_phone
Contact 2 / Email	fm_cli.contact2_email
Contact 2 / Interests/Comments	fm_cli.contact2_note
A/C Payable / Name	fm_cli.contact3_name
A/C Payable / Job Title	fm_cli.contact3_job_title
A/C Payable / Phone	fm_cli.contact3_phone
A/C Payable / Email	fm_cli.contact3_email
A/C Payable / Interests/Comments	fm_cli.contact3_note
CC / Name	fm_cli.contact4_name
CC / Job Title	fm_cli.contact4_job_title
CC / Phone	fm_cli.contact4_phone
CC / Email	fm_cli.contact4_email
CC / Interests/Comments	fm_cli.contact4_note
Payroll / Name	fm_cli.contact5_name
Payroll / Job Title	fm_cli.contact5_job_title
Payroll / Phone	fm_cli.contact5_phone
Payroll / Email	fm_cli.contact5_email
Payroll / Interests/Comments	fm_cli.contact5_note

Clients: MLA (Master Lease Agreement)

Column One

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Facility Type	fm	clients	mla	field	fm_cli_facility_type_id	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Credit Rating	fm	clients	mla	field	fm_cli_client_credit_ratings_id	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Limit	fm	clients	mla	field	fm_cli_finance_limit	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Review Date	fm	clients	mla	field	fm_cli_finance_review_date	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable

Clients: Quote Defaults

Field Name	Table.Field	Restriction Type	Comments
Luxury Charge Event	fm_cli.luxury_charge_event_flag	display-only / hidden	If restriction_type = 'display-only', the field will be displayed but is not editable. If restriction_type = 'hidden', the field will be hidden
Novated Management Fee	fm_cli.novated_management_fee
Payroll Date	fm_cli.payroll_date	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Allow Operating FBT Type	fm_cli.allow_operating_fbt_type_flag	display-only / hidden	If restriction_type = 'display-only', the field will be displayed but is not editable. If restriction_type = 'hidden', the field will be hidden
Financier	qt_clid.supplier_id_financier
Agreed Lessee Rate	fm_cli.agreed_lessee_rate	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Management Fee	qt_clid.management_fee
Novated Commission Rate	qt_clid.novated_commission_rate
Pay Cycle	fm_cli.pay_cycle_id	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Payroll Date	fm_cli.payroll_date	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Pay Cycle 2	fm_cli.pay_cycle_id_2	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Payroll Date 2	fm_cli.payroll_date_2	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Pay Cycle 3	fm_cli.pay_cycle_id_3	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Payroll Date 3	fm_cli.payroll_date_3	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable
Payroll Cut Off Days	fm_cli.payroll_cut_off_days	display-only	If restriction_type = 'display-only', the field will be displayed but is not editable

Clients: Contract Defaults

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Finance Budget Term Deferred	fm	clients	contract_defaults	field	fm_cli_finance_budget_term_deferred_flag	display-only
Recall Notice Note	fm	clients	contract_defaults	field	fm_cli_recall_notice_note	display-only	This field cannot be hidden

Clients: Financiers

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Facility Type	fm	clients	financiers	field	fm_cli_f_facility_type_id	display-only	This field cannot be hidden

Clients: Events

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
User	fm	clients	events	field	fm_cli_e_user_id_edit	display-only

Clients: Contact List

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Screen Function Buttons	fm	clients	contact_list	bottom_controls_map		bit_array	If set, the function buttons at the bottom right of the screen are hidden

Clients: Contact Details

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Client Allocations	fm	clients	contact_detail		client_allocation	display_only
Contact Type Allocations	fm	clients	contact_detail		contact_type_allocation	display_only

Clients: Cost Centre

Name	Module	Page	Sub Page	Type	Field	Restriction Type	Comments
Cost Centre	fm	clients	cost_centre	field	fm_cl_cc_description	display-only