Skip to main content

Role matrix

This page lists every role defined for Insurance Broker Core, the rights each role holds on each DocType, and the role that each Tender command requires. It is generated from the DocType JSON permissions, the roles baseline contract and the Tender contracts, so it changes only when those sources change. For how to assign roles in practice, see Roles and access.

Roles and their purpose​

Roles marked Plan role are the baseline roles of the role design. Roles marked Legacy role were present before that design and are kept under their original names. System Manager is a standard role of the platform and is not part of the roles baseline contract.

CodeRoleOriginPurpose
ACAInsurance Broker Accounting ApproverLegacy roleIndependent accounting approval checker.
ADCInsurance Broker Accounting Draft CreatorPlan roleCreates accounting draft records.
ADMInsurance Broker AdministratorLegacy roleSetup, activation and technical administration.
ADVInsurance Broker AdvisorPlan roleAdvisory and recommendation workflows.
APPInsurance Broker ApproverLegacy roleApproval checker.
AUDInsurance Broker AuditorPlan roleRead-only audit access including ledger records.
CLMInsurance Broker ClaimsPlan roleClaim and complaint case handling.
COAInsurance Broker Commission ApproverPlan roleIndependent commission approval checker.
CORInsurance Broker Commission ReconcilerPlan roleCommission reconciliation maker.
CMPInsurance Broker ComplianceLegacy roleDisclosure, privacy and compliance evidence.
IMPInsurance Broker Import OperatorPlan roleImport batch, import line and quarantine processing.
MGRInsurance Broker ManagerPlan roleOverall operational management of broker business records.
OPSInsurance Broker OperationsPlan roleMandates, policies and operational cases.
PRVInsurance Broker Privacy OfficerPlan rolePrivacy rights, data subject requests and legal hold processing.
RDOInsurance Broker Read OnlyPlan roleRead-only viewer for all non-restricted records.
RECInsurance Broker ReconcilerLegacy roleCommission reconciliation maker.
SCLInsurance Broker Sensitive ClaimsPlan roleExplicit access to sensitive/restricted claim records.
SETInsurance Broker Setup ManagerPlan roleSetup, activation and technical configuration of the broker site.
REGRegulatory ReviewerPlan roleReviews and submits regulatory rule contracts; W0 keeps the engine inert.
SYSSystem ManagerPlatform roleStandard platform role that also holds rights on some DocTypes.

Reading the DocType table​

The next section has one row per DocType. Each cell lists the roles that hold at least one right on that DocType, written as the role code followed by right letters.

LetterRight
rread
wwrite
ccreate
ddelete
ssubmit
xcancel
treport
eemail
oexport
pprint
hshare

The table covers 168 DocTypes. A DocType with no role listed has no permission rows in its JSON. Rights in this table are the Frappe permission rows only; company scope and the other server-side checks described in Security and privacy apply on top of them.

Rights by DocType​

DocTypeRoles and rights
Insurance Broker AI Capability AdmissionADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker AML Applicability DecisionADM rwcsx, AUD r, CMP rwcs, OPS r, RDO r
Insurance Broker Accounting Party MappingACA rwc, ADC rwc, ADM rwc, AUD r, RDO r, REC r
Insurance Broker Accounting Strategy AdmissionACA rwc, ADC rwc, ADM rwc, AUD r, RDO r, REC r
Insurance Broker Advice CaseADM rwc, ADV rwc, AUD r, CMP r, MGR rwc, RDO r
Insurance Broker Advice ProtocolADM rwc, ADV rwc, AUD r, CMP rw, RDO r
Insurance Broker Advice Regime VersionADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Advisor Eligibility SnapshotADM rct, AUD r, CMP rct, RDO r
Insurance Broker Advisor ProfileADM rwc, AUD r, CMP rw, RDO r
Insurance Broker Advisor Qualification EvidenceADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Advisor RegistrationADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Applicability DecisionADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Application Placement CaseADM rwc, ADV rwc, AUD r, CMP r, MGR rwc, RDO r
Insurance Broker Approval ConsumptionADM rc, APP rc, AUD r, CMP r, RDO r
Insurance Broker Capability AdmissionADM rwcsx, APP r, AUD r, CMP rwcs, RDO r
Insurance Broker Carrier Authorization ProfileADM rwc, AUD r, CMP rw, RDO r
Insurance Broker Carrier ParticipationAUD r, RDO r
Insurance Broker Carrier Product OfferingADM rwcd, AUD r, OPS rwc, RDO r
Insurance Broker Census SnapshotADM rc, OPS rc, SCL r
Insurance Broker ChargebackACA rw, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Claim Assistance CaseADM rwc, CLM rwc, SCL rwc
Insurance Broker ClauseADM rwcd, APP rw, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Client Remuneration AgreementADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Collection ModelADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Commission AgreementACA r, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Commission ExpectationACA rt, ADC rwc, ADM rwct, AUD r, CMP rt, COA rw, COR rwc, RDO r, REC rwct
Insurance Broker Commission LiabilityACA rwt, ADC rwc, ADM rwct, AUD r, CMP rt, COA rw, COR rwc, RDO r, REC rwct
Insurance Broker Commission ReconciliationACA rw, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Commission Rule VersionACA r, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Commission SplitACA rw, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Commission StatementACA rw, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Commission Statement LineAUD r, COA rw, COR rwc, RDO r
Insurance Broker Communication LinkADM rwc, OPS rwc, SCL rw
Insurance Broker Company Party ScopeADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Company SettingsADM rwcdteoph, AUD r, CMP r, RDO r, SET rw
Insurance Broker Complaint CaseADM rwc, CMP rwc, SCL rwc
Insurance Broker Configuration SnapshotADM rc, AUD r, CMP r, RDO r
Insurance Broker Conflict of Interest AssessmentADM rwc, ADV rwc, AUD r, CMP rwc, RDO r
Insurance Broker Consumer CursorADM rc, AUD r, CMP r, RDO r
Insurance Broker Country ProfileADM rwcsx, AUD r, CMP r, RDO r
Insurance Broker CoverageAUD r, RDO r
Insurance Broker Coverage Template VersionADM rwc, AUD r, OPS rwc, RDO r
Insurance Broker Customer DecisionADM rwc, ADV rwc, AUD r, CMP r, RDO r
Insurance Broker Data Quality IssueADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Data Subject Identity LinkADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker Data Subject Request CaseADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker DeadlineADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Delivery EvidenceADM rc, AUD r, CMP rc, OPS rc, RDO r
Insurance Broker Delivery ReceiptADM rc, AUD r, CMP r, RDO r
Insurance Broker Demo InstallationADM r, AUD r, RDO r, SYS r
Insurance Broker Demo RecordAUD r, RDO r
Insurance Broker Disclosure Template FamilyADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Disclosure Template VersionADM rwcs, AUD r, CMP rwcs, RDO r
Insurance Broker Disposition LedgerADM rc, AUD r, CMP rc, RDO r
Insurance Broker Document Ingestion QueueADM rwc, OPS rwc, SCL rw
Insurance Broker Document ReferenceADM rwc, CMP r, OPS rwc, SCL r
Insurance Broker Document VersionADM rwc, CMP r, OPS rwc, SCL r
Insurance Broker Earnings BasisADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Evaluation Approval Referencenone
Insurance Broker Evaluation Evidence Referencenone
Insurance Broker Evaluation Exception Referencenone
Insurance Broker Evaluation Rule Resultnone
Insurance Broker Evidence BundleADM rwc, CMP rwc, SCL r
Insurance Broker Evidence RequirementADM rwcsx, AUD r, CMP rwcs, OPS r, RDO r
Insurance Broker Exception WaiverADM rwcsx, AUD r, CMP rwcs, RDO r
Insurance Broker ExclusionADM rwcd, APP rw, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker External Source ReferenceADM rwc, AUD r, CMP r, OPS r, RDO r
Insurance Broker Extraction ProposalADM rwc, OPS rwc, SCL rw
Insurance Broker Field ProvenanceADM rwc, AUD r, CMP r, OPS r, RDO r
Insurance Broker Import BatchADM rwc, AUD r, CMP r, IMP rwc, OPS rwc, RDO r
Insurance Broker Import Batch LineAUD r, IMP rwc, RDO r
Insurance Broker Import QuarantineADM rwc, AUD r, CMP rwc, IMP rwc, RDO r
Insurance Broker Initial DisclosureADM rwc, AUD r, CMP rwc, OPS r, RDO r
Insurance Broker Insured PopulationADM rwc, OPS rwc, SCL r
Insurance Broker JurisdictionADM rwc, AUD r, CMP rwc, RDO r, SET rwc
Insurance Broker Jurisdiction Source StateADM rwcs, AUD r, CMP rwcs, RDO r, SET rwcs
Insurance Broker Large Risk ClassificationADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Legacy Regulatory ValueADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Legal Basis ProfileADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker Legal HoldADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker Legal Review SnapshotADM rwcs, AUD r, CMP rwcs, RDO r
Insurance Broker Legal Review Source Statenone
Insurance Broker Line of BusinessADM rwcd, AUD r, OPS r, RDO r
Insurance Broker MandateADM rwc, AUD r, CMP rw, MGR rwc, OPS rwc, RDO r
Insurance Broker Mapping ProfileADM rwc, AUD r, CMP r, RDO r
Insurance Broker Membership VersionADM rwc, OPS rwc, SCL r
Insurance Broker Needs AssessmentADM rwc, ADV rwc, AUD r, RDO r
Insurance Broker Outbox DeliveryADM rc, AUD r, CMP r, RDO r
Insurance Broker Outbox EventADM rc, AUD r, CMP r, RDO r
Insurance Broker Outbox SubscriptionADM rwc, AUD r, CMP r, RDO r
Insurance Broker Party AliasADM rwc, AUD r, CMP r, RDO r
Insurance Broker Party IdentityADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Party Identity ReviewADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Party RoleADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Placement CaseADM rwc, ADV rwc, AUD r, CMP r, MGR rwc, RDO r
Insurance Broker PolicyADM rwct, AUD r, CMP rt, MGR rwc, OPS rwct, RDO r, REC r
Insurance Broker Policy Adjustment CaseADM rwc, APP rw, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Policy Carrier ParticipationADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Policy CheckADM rwc, ADV rwc, AUD r, CMP rw, RDO r
Insurance Broker Policy MutationADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Policy Replacement CaseADM rwc, APP rw, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Policy Risk ParticipationADM rwc, AUD r, OPS rwc, RDO r
Insurance Broker Policy TermADM rwcst, APP rws, AUD r, CMP rt, MGR rwc, OPS rwct, RDO r, REC r
Insurance Broker Population Import BatchADM rwc, AUD r, CMP r, IMP rwc, OPS rwc, RDO r
Insurance Broker Population MemberADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Population ReconciliationADM rwc, AUD r, OPS rwc, RDO r, REC rwc
Insurance Broker Population VersionADM rwcsx, AUD r, OPS rwc, RDO r, REC r
Insurance Broker Portfolio Transfer CaseADM rwc, AUD r, CMP r, MGR rwc, OPS rwc, RDO r
Insurance Broker Posting PlanACA rw, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Premium AdjustmentADM rwc, APP rw, AUD r, OPS rwc, RDO r, REC r
Insurance Broker Premium External Transaction ReferenceADM rwcd, AUD r, OPS rwc, RDO r, REC rwc
Insurance Broker Premium NoticeADM rwcd, AUD r, OPS rwc, RDO r, REC r
Insurance Broker Premium ObligationADM rwc, AUD r, OPS rwc, RDO r, REC r
Insurance Broker Premium Payment StatusADM rwcd, AUD r, OPS rwc, RDO r, REC rwc
Insurance Broker Premium ScheduleADM rwcd, AUD r, OPS rwc, RDO r, REC r
Insurance Broker Privacy Incident CaseADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker Processing Purpose ProfileADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker Processing RestrictionADM rwc, AUD r, CMP rwc, PRV rwc, RDO r
Insurance Broker Product Applicability AssessmentADM rwc, ADV rwc, AUD r, CMP rw, RDO r
Insurance Broker Product CapabilityADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Product ClassADM rwcd, AUD r, OPS r, RDO r
Insurance Broker Product Class LOBAUD r, RDO r
Insurance Broker Product Information ReceiptADM rwc, AUD r, CMP rwc, OPS rwc, RDO r
Insurance Broker Product LOBnone
Insurance Broker Product VersionADM rwcsx, AUD r, OPS rwcs, RDO r
Insurance Broker Provider ReceiptADM rwc, CMP r, OPS rwc, SCL r
Insurance Broker QuoteADM rwc, ADV rwc, AUD r, MGR rwc, RDO r
Insurance Broker Quote ComparisonADM rwc, ADV rwc, AUD r, RDO r
Insurance Broker Quote CoverageADM rwc, ADV rwc, AUD r, MGR rwc, RDO r
Insurance Broker Receipt ConsumptionADM rc, AUD r, CMP rc, RDO r
Insurance Broker RecommendationADM rwc, ADV rwc, AUD r, CMP r, RDO r
Insurance Broker Recommendation RecordADM rwc, ADV rwc, AUD r, CMP r, RDO r
Insurance Broker Regulatory ContextADM rwcsx, AUD r, CMP rwcs, OPS r, RDO r
Insurance Broker Regulatory Contractual DeadlineADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Regulatory Evaluation ReceiptADM rc, AUD r, CMP rc, RDO r
Insurance Broker Regulatory ExceptionADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Regulatory Exception BasisADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Regulatory Exception EventADM rc, AUD r, CMP rc, RDO r
Insurance Broker Regulatory Obligation ProfileADM rwcsx, AUD r, CMP rwcs, RDO r
Insurance Broker Regulatory Rule ContractADM r, AUD r, CMP r, RDO r, REG rwcs, SYS rwc
Insurance Broker Regulatory SettingsADM rw, AUD r, CMP r, RDO r, SET rw, SYS r
Insurance Broker Reinstatement CaseADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Remuneration DisclosureADM rwc, AUD r, CMP rw, OPS rwc, RDO r
Insurance Broker Renewal CaseADM rwc, AUD r, MGR rwc, OPS rwc, RDO r
Insurance Broker Representation AuthorityADM rwc, AUD r, CMP rwc, OPS rwc
Insurance Broker Reserve Release ProposalACA rw, ADC rwc, ADM rwc, AUD r, COA rw, COR rwc, RDO r, REC rwc
Insurance Broker Restore Disposition LedgerADM rc, AUD r, CMP rc, RDO r
Insurance Broker Retention Disposition CaseADM rwc, AUD r, CMP rwc, PRV r, RDO r
Insurance Broker Retention RuleADM rwc, AUD r, CMP rwc, PRV r, RDO r
Insurance Broker Risk Needs AssessmentADM rwc, ADV rwc, AUD r, CMP r, MGR rwc, RDO r
Insurance Broker Risk ObjectADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Risk Object AttributeADM rwc, AUD r, CMP r, OPS rwc, RDO r
Insurance Broker Risk Object VersionADM rwc, OPS rwc, SCL r
Insurance Broker Risk Schema VersionADM rwcs, AUD r, CMP rwcs, OPS r, RDO r
Insurance Broker Rule Applicability Dimensionnone
Insurance Broker Rule Evidence Requirementnone
Insurance Broker Rule Lifecycle EventADM rc, AUD r, CMP rc, RDO r
Insurance Broker Rule Precedence DecisionADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Rule SeriesADM rwc, AUD r, CMP rwc, RDO r
Insurance Broker Rule Source Statenone
Insurance Broker SettingsADM rw, AUD r, RDO r, SET rwc, SYS r
Insurance Broker State Machine InstanceADM rc, AUD r, CMP r, OPS r, RDO r
Insurance Broker State Transition ReceiptADM rc, AUD r, CMP r, OPS r, RDO r
Insurance Broker SubmissionADM rwc, ADV rwc, AUD r, RDO r
Insurance Broker TenderADM rwc, ADV rwc, AUD r, CMP r, OPS r, RDO r
Insurance Broker Tender InvitationADM rwc, ADV rwc, AUD r, OPS rwc, RDO r
Insurance Broker Tender Risk ObjectAUD r, RDO r
Insurance Broker Unresolved Party ReferenceADM rwc, AUD r, CLM rwc, CMP rwc

Tender command roles​

Two contracts describe the role of a Tender command. The state machine contract lists the role per transition. The Tender command API contract lists the role that the endpoint insurance_broker_core.api.tender.execute_tender_command checks for the command, together with the states from which it accepts the command and whether it needs a capability admission. Both are shown so that differences stay visible. For the commands in practice, see Tender states and commands.

CommandRole in state machine contractRole in API contractStates accepted by the APICapability admission checked by the API
prepareInsurance Broker AdvisorInsurance Broker Advisordraftyes
send_invitationsInsurance Broker AdvisorInsurance Broker Advisorpreparingyes
open_responsesInsurance Broker AdvisorInsurance Broker Advisorinvitations_sentyes
start_comparisonInsurance Broker AdvisorInsurance Broker Advisorresponses_openyes
recommendInsurance Broker AdvisorInsurance Broker Advisorcomparisonyes
decideInsurance Broker AdvisorInsurance Broker Advisorrecommendedyes
closeInsurance Broker OperationsInsurance Broker Operationsdecidedno
cancelInsurance Broker AdvisorInsurance Broker Advisordraft, preparing, invitations_sent, responses_open, comparison, recommendedno
mark_no_resultInsurance Broker AdvisorInsurance Broker Advisorinvitations_sent, responses_open, comparisonno
require_legal_reviewInsurance Broker ComplianceInsurance Broker Compliancedraft, preparing, invitations_sent, responses_open, comparison, recommendedno

The API checks that the signed-in user holds the role from its own contract and that the user may read the Tender within its company scope. Only the endpoint changes the state; Operations and Compliance can read the Tender in the Desk but cannot edit it directly. The caller never supplies roles or approval claims.