crm — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module id	crm
Name	CRM
Version	1.0.0
Ships from	@endora-commerce/mod-crm
Licence	MIT

Activation

An operator switches this module on and off on /platform/modules. The choice is the setting crm.enabled, and it defaults to on.

Dependencies

Module	Binding	What it means
admin_users	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
assets_library	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
audit_logs	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
auth	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
catalog	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
custom_fields	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
customer_accounts	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
orders	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
organizations	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
sales_channels	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
settings	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
transactional_emails	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
admin_notifications	no	degrades-without adminNotificationRecordPort — CRM stops notifying people about assignments and messages; everything else in CRM keeps working
admin_search	no	contributes-to adminSearchProviderRegistry
quote_requests	no	degrades-without quoteRequestCustomFieldCarryPort — Values of Sales Opportunities are not carried into Quote Requests created from them
quote_requests	no	degrades-without quoteRequestReadPort — Quote Requests linked to Opportunities show as unavailable, stop counting toward computed values, and can no longer be linked or created from one. Opportunities and their Orders keep working
webhooks	no	contributes-to webhookEventRegistry

Permissions

Code	Label	Also needs
crm:analytics	View CRM analytics	crm:read
crm:configure	Configure the CRM workflow and tags	crm:read
crm:read	View sales opportunities	orders:read, custom_fields:read
crm:write	Create and work sales opportunities	crm:read

Command palette

Action	Opens	Permission
new-opportunity	/crm/opportunities/new	crm:write
open-crm-analytics	/crm/analytics	crm:analytics
open-crm-calendar	/crm/calendar	crm:read
open-opportunities	/crm/opportunities	crm:read
open-opportunity-board	/crm/board	crm:read

Settings

Code	Name	Type
crm.auto_create_from_orders	Create an opportunity for every new order	boolean
crm.auto_create_from_quote_requests	Create an opportunity for every new quote request	boolean
crm.board_card_fields	Fields shown on a board card	json
crm.enabled	CRM enabled	boolean

Translations

Bundles at i18n inside the module, one file per shipped language.

Operator commands

None.