Setup, navigation and lifecycle

Enable or disable the broker portal setting

Control whether the dedicated broker portal is shown/used.

Audience: CRM staffPermission: AdministratorModule v1.0.0
Exact navigationAdmin Area → Settings → General Settings → Show Broker Portal
Before you begin
  • Use an account with Administrator and confirm the intended record or setting before making a change.
  • Follow the exact route above. If the screen or action is absent, check module activation, ownership and permissions rather than using another person’s account.
  • Use controlled test data for configuration, integration, email, AI, payment, portal or automation changes before production-wide use.

What this guide covers

Control whether the dedicated broker portal is shown/used. The instructions reflect the supplied module’s registered menus, controller actions, views, settings and code-backed validation flow.

Exact step-by-step process

  1. Open Admin Area → Settings → General Settings → Show Broker Portal.
  2. Open the exact setting, option or record named in this guide.
  3. Enter or select the required value; leave unrelated options unchanged.
  4. Save the form and wait for the success response.
  5. Reload the page or open a controlled record to confirm the stored value is being used.

Fields, choices and supported possibilities

Exact actionEnable or disable the broker portal setting
Exact navigationAdmin Area → Settings → General Settings → Show Broker Portal
Module version1.0.0
Access ruleAdministrator
VerificationReopen the source record and confirm the expected status, linked record, file, notification, portal visibility or financial effect.
Organisation/personName, code, email, phone, website, tax/VAT, address, status and profile image where exposed.
Access and structurePlan, role, administrator flag, departments, staff type/company link, approval-manager and public flags where applicable.

Code-backed validations and workflow rules

  • The option real_show_broker_portal controls the broker-portal feature.
  • Broker accounts still require active credentials and company/staff records.
  • Company, owner, broker and staff records use different capability groups and ownership checks.
  • Email-exists checks prevent duplicate staff/company identities in supported forms.

Expected result and verification

  • The supported enable or disable the broker portal setting flow completes without bypassing permission or validation checks.
  • The resulting record, setting, status, file, delivery event or external response is visible from the relevant workspace.
  • Unexpected validation, provider or linked-record errors are investigated before retrying.

Security, privacy and operational checks

  • Apply least privilege to purchasing, vendor, invoice, payment, return, contract and report permissions.
  • Verify vendor identity, bank/payment details, tax, currency, totals and approvals before creating financial commitments.
  • Treat public links, signatures, portal files, attachments and exported reports as controlled business records.
  • Test settings and automated jobs with controlled records before production-wide use.