loc
stringlengths
30
153
lastmod
stringdate
2025-04-10 00:00:00
2025-09-08 00:00:00
lang
stringclasses
1 value
title
stringlengths
3
86
breadcrumbs
listlengths
1
9
html_content
stringlengths
138k
1.18M
clean_text
stringlengths
1
44.7k
rich_text
stringlengths
80
44.7k
https://docs.frappe.io/log-settings
2025-04-10
en
Log Settings
[ "log-settings" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Log Settings"><meta property="og:image...
Log Settings allows you to set the number of days after which you want the logs to be deleted. Some common doctypes used are Error Log, Activity Log, and Email Queue. When you set the number of days in the Log Settings, the system calculates the number of days based on the creation or modification time of the log file...
--- title: Log Settings breadcrumbs: - log-settings --- Log Settings allows you to set the number of days after which you want the logs to be deleted. Some common doctypes used are Error Log, Activity Log, and Email Queue. When you set the number of days in the Log Settings, the system calculates the number of days b...
https://docs.frappe.io/calculation-in-case-of-tax-inclusive-item-price-and-additional-discount-on-grand-total
2025-04-10
en
Calculation in case of Tax Inclusive Item Price and Additional Discount on Grand Total
[ "calculation-in-case-of-tax-inclusive-item-price-and-additional-discount-on-grand-total" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Calculation in case of Tax Inclusive I...
In this article, we will explain how ERPNext calculates net item price and net tax amount, if tax is included in the item price and there is an additional discount on grand total. Example: Let's say, an item costs $100 with a tax rate of 10%, the customer still pays a flat $100, of which $9.09 is collected as tax. And...
--- title: Calculation in case of Tax Inclusive Item Price and Additional Discount on Grand Total breadcrumbs: - calculation-in-case-of-tax-inclusive-item-price-and-additional-discount-on-grand-total --- In this article, we will explain how ERPNext calculates net item price and net tax amount, if tax is included in ...
https://docs.frappe.io/sales-person-target-allocation
2025-04-10
en
Sales Person Target Allocation
[ "sales-person-target-allocation" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Sales Person Target Allocation"><meta ...
**It is the assignment of Sales Persons to an item or a territory.** Along with the management of Sales Persons, ERPNext also allows you to assign target Sales Persons based on Item Group and Territory. Based on target allocated and actual sales booked by Sales Person, you will get the Target Variance Report for the S...
--- title: Sales Person Target Allocation breadcrumbs: - sales-person-target-allocation --- **It is the assignment of Sales Persons to an item or a territory.** Along with the management of Sales Persons, ERPNext also allows you to assign target Sales Persons based on Item Group and Territory. Based on target allocat...
https://docs.frappe.io/erpnext-shipping
2025-04-10
en
ERPNext Shipping
[ "erpnext-shipping" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="ERPNext Shipping"><meta property="og:i...
> Introduced in version 13 **The ERPNext Shipping app helps you compare shipping rates being offered by multiple service providers, generate labels, and track your shipments' status.** Integration with the following service providers is available: 1. Packlink 2. LetMeShip 3. SendCloud > To avail these features, the...
--- title: ERPNext Shipping breadcrumbs: - erpnext-shipping --- > Introduced in version 13 **The ERPNext Shipping app helps you compare shipping rates being offered by multiple service providers, generate labels, and track your shipments' status.** Integration with the following service providers is available: 1. P...
https://docs.frappe.io/helpdesk/assignment-rule
2025-09-01
en
Assignment Rule
[ "helpdesk", "assignment-rule" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Assignment Rule"><meta property="og:im...
Assignment Rules automate the process of assigning tickets to specific agents based on predefined conditions. This streamlines your workflow and ensures tickets are directed to the most qualified agents for faster resolution and improved customer experience. ## **Creating an Assignment Rule** 1. **Open settings modal...
--- title: Assignment Rule breadcrumbs: - helpdesk - assignment-rule --- Assignment Rules automate the process of assigning tickets to specific agents based on predefined conditions. This streamlines your workflow and ensures tickets are directed to the most qualified agents for faster resolution and improved customer...
https://docs.frappe.io/helpdesk/exotel
2025-09-05
en
Exotel
[ "helpdesk", "exotel" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Exotel"><meta property="og:image:width...
Exotel is a cloud telephony platform that enables businesses to manage voice calls, SMS, and communication workflows without traditional phone hardware. The integration with Frappe Helpdesk combines these communication capabilities with customer relationship management to provide a unified system for handling customer ...
--- title: Exotel breadcrumbs: - helpdesk - exotel --- Exotel is a cloud telephony platform that enables businesses to manage voice calls, SMS, and communication workflows without traditional phone hardware. The integration with Frappe Helpdesk combines these communication capabilities with customer relationship manag...
https://docs.frappe.io/helpdesk/twilio
2025-09-05
en
Twilio
[ "helpdesk", "twilio" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Twilio"><meta property="og:image:width...
Twilio is a cloud communications platform that allows businesses to integrate voice, video, messaging, and authentication functionalities into their applications. This integration enables you to make calls directly from various pages within the Helpdesk. ## Twilio setup To configure Twilio for use within the Helpdesk...
--- title: Twilio breadcrumbs: - helpdesk - twilio --- Twilio is a cloud communications platform that allows businesses to integrate voice, video, messaging, and authentication functionalities into their applications. This integration enables you to make calls directly from various pages within the Helpdesk. ## Twili...
https://docs.frappe.io/helpdesk/email-notifications
2025-08-29
en
Email Notifications
[ "helpdesk", "email-notifications" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Email Notifications"><meta property="o...
Some emails are sent by Helpdesk based on the activities carried out by the users. Currently, there are 4 kinds of emails: * Share Feedback * Acknowledgement * Reply From Contact * Reply From Agent To customize the content and the related options associated with each kind of email, you can use the 'Email Notification...
--- title: Email Notifications breadcrumbs: - helpdesk - email-notifications --- Some emails are sent by Helpdesk based on the activities carried out by the users. Currently, there are 4 kinds of emails: * Share Feedback * Acknowledgement * Reply From Contact * Reply From Agent To customize the content and the relat...
https://docs.frappe.io/helpdesk/ticket-status
2025-08-25
en
Ticket Status
[ "helpdesk", "ticket-status" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Ticket Status"><meta property="og:imag...
## Overview The `HD Ticket Status` DocType defines the lifecycle states of helpdesk tickets in the system. It lets administrators control how statuses appear to agents and end-users, how SLAs behave depending on the status, and how statuses are visually represented (e.g., with colors). This DocType helps keep ticket h...
--- title: Ticket Status breadcrumbs: - helpdesk - ticket-status --- ## Overview The `HD Ticket Status` DocType defines the lifecycle states of helpdesk tickets in the system. It lets administrators control how statuses appear to agents and end-users, how SLAs behave depending on the status, and how statuses are visu...
https://docs.frappe.io/helpdesk/settings
2025-08-25
en
Settings
[ "helpdesk", "settings" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Settings"><meta property="og:image:wid...
To go to the settings tab click on the dropdown present in the sidebar, then click on settings to open the settings modal. Settings tab will only be shown to the users who are either "System Manager" or "Administrator". Inside the modal, 2 settings are present, let's go through them one by one, 1. Email Accounts. In...
--- title: Settings breadcrumbs: - helpdesk - settings --- To go to the settings tab click on the dropdown present in the sidebar, then click on settings to open the settings modal. Settings tab will only be shown to the users who are either "System Manager" or "Administrator". Inside the modal, 2 settings are presen...
https://docs.frappe.io/helpdesk/field-dependency
2025-08-23
en
Field Dependency
[ "helpdesk", "field-dependency" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Field Dependency"><meta property="og:i...
Dependency fields are those that have a parent-child relationship, such as the Category and Sub-category field values. The relevant Sub-categories will only be listed when the Category is also selected. Similarly, you may only need to list the specific issues when the main category is selected, or list the products bas...
--- title: Field Dependency breadcrumbs: - helpdesk - field-dependency --- Dependency fields are those that have a parent-child relationship, such as the Category and Sub-category field values. The relevant Sub-categories will only be listed when the Category is also selected. Similarly, you may only need to list the ...
https://docs.frappe.io/helpdesk/customer-portal
2025-08-20
en
Customer Portal
[ "helpdesk", "customer-portal" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Customer Portal"><meta property="og:im...
The **Customer Portal** allows your users to sign in to the Helpdesk and manage their support interactions. When a contact logs in, they are automatically redirected to the Customer Portal. Once you’ve invited a contact, they can access the portal to: * Submit new tickets * Track the status of existing tickets * Acc...
--- title: Customer Portal breadcrumbs: - helpdesk - customer-portal --- The **Customer Portal** allows your users to sign in to the Helpdesk and manage their support interactions. When a contact logs in, they are automatically redirected to the Customer Portal. Once you’ve invited a contact, they can access the por...
https://docs.frappe.io/helpdesk/inviting-agents
2025-08-20
en
Inviting agents
[ "helpdesk", "inviting-agents" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Inviting agents"><meta property="og:im...
> Note: This feature is available only on the `develop` branch The Invite Agents tab in the settings modal can be used to invite new or existing (haven't been invited yet) users to Helpdesk. ## Steps to invite 1. List out the emails you wish to invite in a comma-separated format. 2. Select a suitable role. > If ...
--- title: Inviting agents breadcrumbs: - helpdesk - inviting-agents --- > Note: This feature is available only on the `develop` branch The Invite Agents tab in the settings modal can be used to invite new or existing (haven't been invited yet) users to Helpdesk. ## Steps to invite 1. List out the emails you wish t...
https://docs.frappe.io/helpdesk/ticket-routing
2025-08-19
en
Ticket Routing
[ "helpdesk", "ticket-routing" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Ticket Routing"><meta property="og:ima...
In Frappe Helpdesk, you can automate ticket routing using the Server Script feature. The `Server Script` DocType allows you to write server-side Python code without creating a custom app or deploying anything. Read more about server scripts from here. ## 1.Route tickets based on the type of ticket `agent_group` is th...
--- title: Ticket Routing breadcrumbs: - helpdesk - ticket-routing --- In Frappe Helpdesk, you can automate ticket routing using the Server Script feature. The `Server Script` DocType allows you to write server-side Python code without creating a custom app or deploying anything. Read more about server scripts from he...
https://docs.frappe.io/helpdesk/lesson-3-agents-teams
2025-07-31
en
Agents & Teams
[ "helpdesk", "lesson-3-agents-teams" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Agents &amp; Teams"><meta property="og...
In Helpdesk, the way tickets are handled depends on three key concepts: Roles, Agents, and Teams. ### 1. Roles Roles define what a user can do in the system. There are three main roles: * **Admin** Has full access across the system — including all tickets, settings, teams, and configurations. * **Agent Manager**...
--- title: Agents & Teams breadcrumbs: - helpdesk - lesson-3-agents-teams --- In Helpdesk, the way tickets are handled depends on three key concepts: Roles, Agents, and Teams. ### 1. Roles Roles define what a user can do in the system. There are three main roles: * **Admin** Has full access across the system — ...
https://docs.frappe.io/helpdesk/service-level-agreement
2025-07-03
en
Service Level Agreement
[ "helpdesk", "service-level-agreement" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Service Level Agreement"><meta propert...
A **Service Level Agreement (SLA)** is a formal agreement between a service provider and a customer that defines the level of service expected. It sets clear expectations by outlining key metrics such as response times, resolution times, service availability, and responsibilities. SLAs help ensure accountability by est...
--- title: Service Level Agreement breadcrumbs: - helpdesk - service-level-agreement --- A **Service Level Agreement (SLA)** is a formal agreement between a service provider and a customer that defines the level of service expected. It sets clear expectations by outlining key metrics such as response times, resolution...
https://docs.frappe.io/helpdesk/your-first-steps-with-frappe-helpdesk
2025-06-02
en
Your First Steps with Frappe Helpdesk
[ "helpdesk", "your-first-steps-with-frappe-helpdesk" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Your First Steps with Frappe Helpdesk"...
Welcome to Frappe Helpdesk! We’re so glad you’re here. We built Frappe Helpdesk because we were tired of tools that were too complicated or too expensive. This one's different—simple, open-source, and easy for both agents and customers. In this guide, we’ll help you set up your inbox, invite your team, manage ticket...
--- title: Your First Steps with Frappe Helpdesk breadcrumbs: - helpdesk - your-first-steps-with-frappe-helpdesk --- Welcome to Frappe Helpdesk! We’re so glad you’re here. We built Frappe Helpdesk because we were tired of tools that were too complicated or too expensive. This one's different—simple, open-source, and...
https://docs.frappe.io/helpdesk/lesson-1-your-first-ticket
2025-05-15
en
Creating a ticket
[ "helpdesk", "lesson-1-your-first-ticket" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Creating a ticket"><meta property="og:...
Once you have set up your Email account, you are ready to get started with helpdesk. When you land on Helpdesk for the first time your URL should be "/helpdesk/tickets". This view shows you the list of all the tickets, in the begining you will see only one ticket: ## Channels to create tickets In Frappe Helpdesk yo...
--- title: Creating a ticket breadcrumbs: - helpdesk - lesson-1-your-first-ticket --- Once you have set up your Email account, you are ready to get started with helpdesk. When you land on Helpdesk for the first time your URL should be "/helpdesk/tickets". This view shows you the list of all the tickets, in the begin...
https://docs.frappe.io/helpdesk/faq
2025-04-29
en
Email Accounts Configuration
[ "helpdesk", "faq" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Email Accounts Configuration"><meta pr...
How to support 2 email accounts in Frappe Helpdesk, based on accounts assign different Agents. You can do so via Server Script, we at Frappe has also done the similar thing, Steps: 1. Create 2 agent groups by going to HD Team DocType. 2. Add agent 1&2 in Group 1, agent 3&4 in Group 2. ( when you do so , an assignmen...
--- title: Email Accounts Configuration breadcrumbs: - helpdesk - faq --- How to support 2 email accounts in Frappe Helpdesk, based on accounts assign different Agents. You can do so via Server Script, we at Frappe has also done the similar thing, Steps: 1. Create 2 agent groups by going to HD Team DocType. 2. Add ...
https://docs.frappe.io/helpdesk/setting-up
2025-04-28
en
Setting Up
[ "helpdesk", "setting-up" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Setting Up"><meta property="og:image:w...
If you have installed Helpdesk on a brand new site, you will need to set up your account. Visit your site that has Helpdesk installed, and you should see a setup wizard. *Setup Wizard* To complete the setup you will need to enter basic information like your country, name, email, and password. Make sure to remember yo...
--- title: Setting Up breadcrumbs: - helpdesk - setting-up --- If you have installed Helpdesk on a brand new site, you will need to set up your account. Visit your site that has Helpdesk installed, and you should see a setup wizard. *Setup Wizard* To complete the setup you will need to enter basic information like y...
https://docs.frappe.io/helpdesk/installation
2025-04-28
en
Installation
[ "helpdesk", "installation" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Installation"><meta property="og:image...
Frappe Helpdesk can be installed in several ways depending on your requirements. You can choose to install it on Frappe Cloud, the cloud version of Frappe Helpdesk, or on your own server. The following sections describe the installation methods in detail. ## Managed Hosting Install Frappe Helpdesk with one click on F...
--- title: Installation breadcrumbs: - helpdesk - installation --- Frappe Helpdesk can be installed in several ways depending on your requirements. You can choose to install it on Frappe Cloud, the cloud version of Frappe Helpdesk, or on your own server. The following sections describe the installation methods in deta...
https://docs.frappe.io/helpdesk/customers-contacts
2025-04-25
en
Customers & Contacts
[ "helpdesk", "customers-contacts" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Customers &amp; Contacts"><meta proper...
### Customer A **Customer** refers to an organization or a company. It is used to group contacts under a common entity. #### Adding New Customer 1. Navigate to Customer Page using the sidebar, 2. Click on **"Add New Customer"**, present on the top right corner. 3. Fill in the following details: * **Customer Name*...
--- title: Customers & Contacts breadcrumbs: - helpdesk - customers-contacts --- ### Customer A **Customer** refers to an organization or a company. It is used to group contacts under a common entity. #### Adding New Customer 1. Navigate to Customer Page using the sidebar, 2. Click on **"Add New Customer"**, presen...
https://docs.frappe.io/helpdesk/lesson-2understanding-ticket-view
2025-04-25
en
Understanding ticket view
[ "helpdesk", "lesson-2understanding-ticket-view" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Understanding ticket view"><meta prope...
* SLA information: Here you can see the SLA information, like when is the first response due or when is the resolution due, we will cover how to create & manage SLA's in the upcoming lessons. * Description: Whatever we added as description (in above img) shows up as the first communication. * Ticket Additional Info: So...
--- title: Understanding ticket view breadcrumbs: - helpdesk - lesson-2understanding-ticket-view --- * SLA information: Here you can see the SLA information, like when is the first response due or when is the resolution due, we will cover how to create & manage SLA's in the upcoming lessons. * Description: Whatever we...
https://docs.frappe.io/helpdesk/ticket-priority
2025-04-23
en
Ticket Priority
[ "helpdesk", "ticket-priority" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Ticket Priority"><meta property="og:im...
Ticket Priority helps categorize tickets based on their urgency or importance. It’s used to identify which tickets need faster attention, such as "Urgent" or "High" priority ones. Helpdesk creates for 4 default ticket priorities for you out of the box. * High * Low * Medium * Urgent ### Adding a ticket type 1. Navi...
--- title: Ticket Priority breadcrumbs: - helpdesk - ticket-priority --- Ticket Priority helps categorize tickets based on their urgency or importance. It’s used to identify which tickets need faster attention, such as "Urgent" or "High" priority ones. Helpdesk creates for 4 default ticket priorities for you out of t...
https://docs.frappe.io/helpdesk/ticket-type
2025-04-23
en
Ticket Type
[ "helpdesk", "ticket-type" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Ticket Type"><meta property="og:image:...
Ticket Types help you categorize incoming tickets based on the nature of the issue — such as "Bug", "Feature Request", or "Billing". Adding meaningful ticket types can help teams streamline operations and reporting. Helpdesk creates for 4 default ticket types for you out of the box. * Bug * Incident * Question * Unsp...
--- title: Ticket Type breadcrumbs: - helpdesk - ticket-type --- Ticket Types help you categorize incoming tickets based on the nature of the issue — such as "Bug", "Feature Request", or "Billing". Adding meaningful ticket types can help teams streamline operations and reporting. Helpdesk creates for 4 default ticket...
https://docs.frappe.io/helpdesk/custom-views
2025-04-23
en
Managing Tickets with ease
[ "helpdesk", "custom-views" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Managing Tickets with ease"><meta prop...
### Custom Views It becomes difficult for agents and customers to create different filters and constantly change them depending on their requirements. Custom views makes it easier for both types of users to segregate and maintain combinations of sort, filters, and columns. #### Creating a view There are 4 types of v...
--- title: Managing Tickets with ease breadcrumbs: - helpdesk - custom-views --- ### Custom Views It becomes difficult for agents and customers to create different filters and constantly change them depending on their requirements. Custom views makes it easier for both types of users to segregate and maintain combina...
https://docs.frappe.io/helpdesk/lesson-4-knowledge-base
2025-04-23
en
Knowledge Base
[ "helpdesk", "lesson-4-knowledge-base" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Knowledge Base"><meta property="og:ima...
The Knowledge Base is a powerful tool for agents to create, organize, and reuse helpful articles when responding to tickets. It helps ensure accurate and consistent replies while reducing time spent typing the same responses. In addition, these articles are shown on the Customer Portal, allowing customers to find answ...
--- title: Knowledge Base breadcrumbs: - helpdesk - lesson-4-knowledge-base --- The Knowledge Base is a powerful tool for agents to create, organize, and reuse helpful articles when responding to tickets. It helps ensure accurate and consistent replies while reducing time spent typing the same responses. In addition,...
https://docs.frappe.io/helpdesk/agent
2025-04-21
en
Agent
[ "helpdesk", "agent" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Agent"><meta property="og:image:width"...
In Frappe Helpdesk, an agent is a user who is responsible for handling customer support tickets. Agents are the frontline personnel who interact directly with customers, diagnose issues, provide solutions, and ensure customer satisfaction. They play a vital role in the helpdesk system, contributing to the overall effic...
--- title: Agent breadcrumbs: - helpdesk - agent --- In Frappe Helpdesk, an agent is a user who is responsible for handling customer support tickets. Agents are the frontline personnel who interact directly with customers, diagnose issues, provide solutions, and ensure customer satisfaction. They play a vital role in ...
https://docs.frappe.io/helpdesk/quick-first-steps
2025-04-21
en
Quick First Steps
[ "helpdesk", "quick-first-steps" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Quick First Steps"><meta property="og:...
(WIP)
--- title: Quick First Steps breadcrumbs: - helpdesk - quick-first-steps --- (WIP)
https://docs.frappe.io/helpdesk/ticket
2025-04-10
en
Ticket
[ "helpdesk", "ticket" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Ticket"><meta property="og:image:width...
In Frappe Helpdesk, a Ticket represents a digital record used to manage and track customer support and service requests. These tickets can be created by customers using Portal or by sending an email to the email address specified by admin. Every Ticket has an SLA attached to it which gets updated based on interaction ...
--- title: Ticket breadcrumbs: - helpdesk - ticket --- In Frappe Helpdesk, a Ticket represents a digital record used to manage and track customer support and service requests. These tickets can be created by customers using Portal or by sending an email to the email address specified by admin. Every Ticket has an SLA...
https://docs.frappe.io/helpdesk/notification
2025-04-10
en
Notification
[ "helpdesk", "notification" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Notification"><meta property="og:image...
Stay informed about important activities within your Helpdesk system using the Notifications feature. This page serves as a central hub for all your Helpdesk-related alerts and updates. ## **Accessing Notifications** 1. Locate the **Notifications** option in the sidebar. 2. Click to open the **Notifications Panel**. ...
--- title: Notification breadcrumbs: - helpdesk - notification --- Stay informed about important activities within your Helpdesk system using the Notifications feature. This page serves as a central hub for all your Helpdesk-related alerts and updates. ## **Accessing Notifications** 1. Locate the **Notifications** o...
https://docs.frappe.io/helpdesk/comment
2025-04-10
en
Comment
[ "helpdesk", "comment" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Comment"><meta property="og:image:widt...
The comment feature allows internal communication and information sharing related to tickets. It facilitates collaboration among agents by providing a dedicated space to discuss, track progress, and share details. ## **Key Features** * **Internal Communication:** Engage in discussions with other agents regarding tick...
--- title: Comment breadcrumbs: - helpdesk - comment --- The comment feature allows internal communication and information sharing related to tickets. It facilitates collaboration among agents by providing a dedicated space to discuss, track progress, and share details. ## **Key Features** * **Internal Communication...
https://docs.frappe.io/helpdesk/pwa-installation
2025-04-10
en
PWA Installation
[ "helpdesk", "pwa-installation" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="PWA Installation"><meta property="og:i...
### Safari Browser 1. Click on the share button (middle one in the bottom navbar) 2. Click on Add to Home screen button 3. Click on Add 4. Login Once, and you are done ✅ ### Chrome Browser 1. Click on Share Icon (position might differ for android phones) 2. Click on Add to Home Screen 3. Click on Add 4. Login Once, ...
--- title: PWA Installation breadcrumbs: - helpdesk - pwa-installation --- ### Safari Browser 1. Click on the share button (middle one in the bottom navbar) 2. Click on Add to Home screen button 3. Click on Add 4. Login Once, and you are done ✅ ### Chrome Browser 1. Click on Share Icon (position might differ for an...
https://docs.frappe.io/helpdesk/canned-response
2025-04-10
en
Canned Response
[ "helpdesk", "canned-response" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Canned Response"><meta property="og:im...
Canned responses in Frappe Helpdesk are pre-written replies that support agents can use to respond to common customer inquiries quickly and consistently. These templates help streamline communication, ensuring that customers receive prompt and accurate information. ## Key Features of Canned Responses 1. **Pre-Written...
--- title: Canned Response breadcrumbs: - helpdesk - canned-response --- Canned responses in Frappe Helpdesk are pre-written replies that support agents can use to respond to common customer inquiries quickly and consistently. These templates help streamline communication, ensuring that customers receive prompt and ac...
https://docs.frappe.io/helpdesk/email-communication
2025-04-10
en
Email Communication
[ "helpdesk", "email-communication" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Email Communication"><meta property="o...
This feature allows you to seamlessly exchange emails with your customers directly from the Ticket page within the system. All email interactions are conveniently stored and accessible, promoting efficient communication and record-keeping. ## **Sending Emails** 1. **Locate the Reply Button:** On the Ticket page, find...
--- title: Email Communication breadcrumbs: - helpdesk - email-communication --- This feature allows you to seamlessly exchange emails with your customers directly from the Ticket page within the system. All email interactions are conveniently stored and accessible, promoting efficient communication and record-keeping...
https://docs.frappe.io/helpdesk/knowledge-base
2025-04-10
en
Knowledge Base
[ "helpdesk", "knowledge-base" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Knowledge Base"><meta property="og:ima...
The Knowledge Base in Frappe Helpdesk is a centralized repository of information designed to assist both support agents and customers in finding solutions to common issues. It serves as a self-service tool that helps reduce the number of support tickets by enabling users to resolve problems on their own. ## Key Featur...
--- title: Knowledge Base breadcrumbs: - helpdesk - knowledge-base --- The Knowledge Base in Frappe Helpdesk is a centralized repository of information designed to assist both support agents and customers in finding solutions to common issues. It serves as a self-service tool that helps reduce the number of support ti...
https://docs.frappe.io/helpdesk/customer
2025-04-10
en
Customer
[ "helpdesk", "customer" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Customer"><meta property="og:image:wid...
In Frappe Helpdesk, a customer represents an organization or individual who receives support services. Managing customer information efficiently is crucial for delivering high-quality support and maintaining strong relationships. The customer record encompasses all relevant data, including contact details, support hist...
--- title: Customer breadcrumbs: - helpdesk - customer --- In Frappe Helpdesk, a customer represents an organization or individual who receives support services. Managing customer information efficiently is crucial for delivering high-quality support and maintaining strong relationships. The customer record encompasse...
https://docs.frappe.io/helpdesk/contact
2025-04-10
en
Contact
[ "helpdesk", "contact" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Contact"><meta property="og:image:widt...
In Frappe Helpdesk, a contact represents an individual who interacts with the support team, typically a customer or user seeking assistance. Contacts are crucial for managing customer relationships and ensuring efficient communication between the helpdesk and its users. ## Key Features of Contacts * **Personal Inform...
--- title: Contact breadcrumbs: - helpdesk - contact --- In Frappe Helpdesk, a contact represents an individual who interacts with the support team, typically a customer or user seeking assistance. Contacts are crucial for managing customer relationships and ensuring efficient communication between the helpdesk and it...
https://docs.frappe.io/helpdesk/team
2025-04-10
en
Team
[ "helpdesk", "team" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Team"><meta property="og:image:width" ...
In Frappe Helpdesk, a team is a group of support agents or users who collaborate to manage and resolve customer support tickets. Teams are crucial for organizing and distributing workloads, ensuring that customer inquiries are handled efficiently and effectively. ## Key Features of Teams in Frappe Helpdesk * **Role A...
--- title: Team breadcrumbs: - helpdesk - team --- In Frappe Helpdesk, a team is a group of support agents or users who collaborate to manage and resolve customer support tickets. Teams are crucial for organizing and distributing workloads, ensuring that customer inquiries are handled efficiently and effectively. ## ...
https://docs.frappe.io/helpdesk/custom-actions
2025-04-10
en
Custom Actions
[ "helpdesk", "custom-actions" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Actions"><meta property="og:ima...
Custom actions allow you to perform specific tasks directly from the Ticket page. These actions can be anything from integrating with external apps to updating ticket data or creating related documents... ## Creating Custom Actions Custom actions are implemented using Form Scripts in Desk: 1. **Navigate to Desk:** S...
--- title: Custom Actions breadcrumbs: - helpdesk - custom-actions --- Custom actions allow you to perform specific tasks directly from the Ticket page. These actions can be anything from integrating with external apps to updating ticket data or creating related documents... ## Creating Custom Actions Custom actions...
https://docs.frappe.io/crm/assignment-rule
2025-09-01
en
Assignment Rule
[ "crm", "assignment-rule" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Assignment Rule"><meta property="og:im...
Assignment Rules automate the process of assigning leads and deals to specific agents based on predefined conditions. This streamlines your workflow and ensures leads and deals are directed to the most qualified agents for faster resolution and improved customer experience. ## **Creating an Assignment Rule** 1. **Ope...
--- title: Assignment Rule breadcrumbs: - crm - assignment-rule --- Assignment Rules automate the process of assigning leads and deals to specific agents based on predefined conditions. This streamlines your workflow and ensures leads and deals are directed to the most qualified agents for faster resolution and improv...
https://docs.frappe.io/crm/invite-users
2025-06-23
en
Invite Users
[ "crm", "invite-users" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Invite Users"><meta property="og:image...
The Invite Members feature allows you to invite agents via email and assign them either Manager Access or Regular Access based on their role. ## Access Levels * **Manager Access:** Full access to all features, including editing layouts, integration settings, and other manager-level controls. * **Regular Access:** Res...
--- title: Invite Users breadcrumbs: - crm - invite-users --- The Invite Members feature allows you to invite agents via email and assign them either Manager Access or Regular Access based on their role. ## Access Levels * **Manager Access:** Full access to all features, including editing layouts, integration settin...
https://docs.frappe.io/crm/introduction
2025-05-29
en
Introduction
[ "crm", "introduction" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Introduction"><meta property="og:image...
## What is Frappe CRM? Frappe CRM is a simple, affordable, open-source CRM tool designed for modern sales teams with unlimited users. Frappe CRM is crafted for providing a great user experience, packed with features for core CRM activities helping you build strong customer relationships while keeping things clean and ...
--- title: Introduction breadcrumbs: - crm - introduction --- ## What is Frappe CRM? Frappe CRM is a simple, affordable, open-source CRM tool designed for modern sales teams with unlimited users. Frappe CRM is crafted for providing a great user experience, packed with features for core CRM activities helping you buil...
https://docs.frappe.io/crm/custom-script
2025-05-14
en
Custom Script
[ "crm", "custom-script" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Script"><meta property="og:imag...
In Frappe CRM, you can automate lead creation using the **Server Script** feature. The `Server Script` DocType allows you to write server-side Python code without creating a custom app or deploying anything. There are four types of Server Scripts, but for this guide we'll focus on: 1. **DocType Event** 2. **API** 3. ...
--- title: Custom Script breadcrumbs: - crm - custom-script --- In Frappe CRM, you can automate lead creation using the **Server Script** feature. The `Server Script` DocType allows you to write server-side Python code without creating a custom app or deploying anything. There are four types of Server Scripts, but fo...
https://docs.frappe.io/crm/email-communication
2025-04-15
en
Email Communication
[ "crm", "email-communication" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Email Communication"><meta property="o...
This feature allows you to seamlessly exchange emails with your customers directly from the Lead/Deal page within the system. All email interactions are conveniently stored and accessible, promoting efficient communication and record-keeping. ## Sending Emails 1. **Locate the Reply Button:** On the Lead or Deal page,...
--- title: Email Communication breadcrumbs: - crm - email-communication --- This feature allows you to seamlessly exchange emails with your customers directly from the Lead/Deal page within the system. All email interactions are conveniently stored and accessible, promoting efficient communication and record-keeping. ...
https://docs.frappe.io/crm/notification
2025-04-10
en
Notification
[ "crm", "notification" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Notification"><meta property="og:image...
Stay informed about important activities within your CRM system using the Notifications feature. This page serves as a central hub for all your CRM-related alerts and updates. ## Accessing Notifications 1. Locate the **Notifications** option in the sidebar. 2. Click to open the **Notifications Panel**. ## Understand...
--- title: Notification breadcrumbs: - crm - notification --- Stay informed about important activities within your CRM system using the Notifications feature. This page serves as a central hub for all your CRM-related alerts and updates. ## Accessing Notifications 1. Locate the **Notifications** option in the sideba...
https://docs.frappe.io/crm/quick-entry-layout
2025-04-10
en
Quick Entry Layout
[ "crm", "quick-entry-layout" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Quick Entry Layout"><meta property="og...
The Quick Entry Layout Builder allows you to customize the layout of quick entry forms in Frappe CRM, similar to how you can add custom sections and fields to Lead and Deal pages. This gives you more control over the data capture process for different document types. ## Steps 1. **Navigate to Lead/Deal ListView:** Go...
--- title: Quick Entry Layout breadcrumbs: - crm - quick-entry-layout --- The Quick Entry Layout Builder allows you to customize the layout of quick entry forms in Frappe CRM, similar to how you can add custom sections and fields to Lead and Deal pages. This gives you more control over the data capture process for dif...
https://docs.frappe.io/crm/custom-statuses
2025-04-10
en
Custom Statuses
[ "crm", "custom-statuses" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Statuses"><meta property="og:im...
Custom Statuses allow you to tailor the status options available for Leads and Deals to your specific business requirements. By defining custom status lists, you can create more accurate and meaningful workflows that reflect your organization's unique processes. ## Adding Custom Statuses Custom statuses are implement...
--- title: Custom Statuses breadcrumbs: - crm - custom-statuses --- Custom Statuses allow you to tailor the status options available for Leads and Deals to your specific business requirements. By defining custom status lists, you can create more accurate and meaningful workflows that reflect your organization's unique...
https://docs.frappe.io/crm/custom-actions
2025-04-10
en
Custom Actions
[ "crm", "custom-actions" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Actions"><meta property="og:ima...
Custom actions allow you to perform specific tasks directly from the Lead or Deal page, aligning with your sales process stages. These actions can be anything from integrating with external apps to updating deal statuses or creating related documents. ## Creating Custom Actions Custom actions are implemented using Fo...
--- title: Custom Actions breadcrumbs: - crm - custom-actions --- Custom actions allow you to perform specific tasks directly from the Lead or Deal page, aligning with your sales process stages. These actions can be anything from integrating with external apps to updating deal statuses or creating related documents. ...
https://docs.frappe.io/crm/call-log
2025-04-10
en
Call Log
[ "crm", "call-log" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Call Log"><meta property="og:image:wid...
The call log page in Frappe CRM is for recording, tracking, and managing all your customer calls. It helps you to maintain a clear history of interactions, improve communication effectiveness, and gain valuable insights for better customer relationships. ## Make a call * You need to go to a Deal/Lead page * You can m...
--- title: Call Log breadcrumbs: - crm - call-log --- The call log page in Frappe CRM is for recording, tracking, and managing all your customer calls. It helps you to maintain a clear history of interactions, improve communication effectiveness, and gain valuable insights for better customer relationships. ## Make a...
https://docs.frappe.io/crm/service-level-agreement
2025-04-10
en
Service Level Agreement
[ "crm", "service-level-agreement" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Service Level Agreement"><meta propert...
An SLA (Service Level Agreement) is a formal agreement outlining the level of service a provider commits to deliver and the expectations a customer has for that service. In Frappe CRM, SLAs establish response time benchmarks for communication-related to Leads and Deals. ## Creating an SLA 1. **Switch to Desk:** Switc...
--- title: Service Level Agreement breadcrumbs: - crm - service-level-agreement --- An SLA (Service Level Agreement) is a formal agreement outlining the level of service a provider commits to deliver and the expectations a customer has for that service. In Frappe CRM, SLAs establish response time benchmarks for commun...
https://docs.frappe.io/crm/contact
2025-04-10
en
Contact
[ "crm", "contact" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Contact"><meta property="og:image:widt...
Contact store essential details like phone numbers and addresses, facilitating further communication and engagement with leads and deals. You can have multiple contacts for the same Deal. ## Create a Contact * Go to the Contact tab and click on "Create" * Fill in all the relevant information like Name, Email, Mobile ...
--- title: Contact breadcrumbs: - crm - contact --- Contact store essential details like phone numbers and addresses, facilitating further communication and engagement with leads and deals. You can have multiple contacts for the same Deal. ## Create a Contact * Go to the Contact tab and click on "Create" * Fill in a...
https://docs.frappe.io/crm/custom-list-actions
2025-04-10
en
Custom List Actions
[ "crm", "custom-list-actions" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom List Actions"><meta property="o...
Similar to Custom Actions, Custom List Actions allows you to add custom actions that you can perform directly from the list view of various Frappe CRM masters (e.g., Leads, Deals, Organizations). These actions enhance your workflow by allowing quick execution of specific tasks without needing to open individual records...
--- title: Custom List Actions breadcrumbs: - crm - custom-list-actions --- Similar to Custom Actions, Custom List Actions allows you to add custom actions that you can perform directly from the list view of various Frappe CRM masters (e.g., Leads, Deals, Organizations). These actions enhance your workflow by allowing...
https://docs.frappe.io/crm/comment
2025-04-10
en
Comment
[ "crm", "comment" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Comment"><meta property="og:image:widt...
The comment feature allows internal communication and information sharing related to leads and deals. It facilitates collaboration among agents by providing a dedicated space to discuss, track progress, and share details. ### **Key Features** * **Internal Communication:** Engage in discussions with other agents regar...
--- title: Comment breadcrumbs: - crm - comment --- The comment feature allows internal communication and information sharing related to leads and deals. It facilitates collaboration among agents by providing a dedicated space to discuss, track progress, and share details. ### **Key Features** * **Internal Communica...
https://docs.frappe.io/crm/lead
2025-04-10
en
Lead
[ "crm", "lead" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Lead"><meta property="og:image:width" ...
In Frappe CRM, a Lead represents a potential customer who has shown some level of interest in your products or services. These leads can be generated through various channels, including: * Website inquiries (contact forms, live chat) * Referrals from existing customers * Networking events and conferences * Paid market...
--- title: Lead breadcrumbs: - crm - lead --- In Frappe CRM, a Lead represents a potential customer who has shown some level of interest in your products or services. These leads can be generated through various channels, including: * Website inquiries (contact forms, live chat) * Referrals from existing customers * ...
https://docs.frappe.io/crm/mobile-app-installation
2025-04-10
en
Mobile App Installation
[ "crm", "mobile-app-installation" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Mobile App Installation"><meta propert...
Frappe CRM offers a mobile-friendly interface through a Progressive Web App (PWA). This means you can access all the CRM functionalities directly on your phone. ## Supported Devices and Browsers The Frappe CRM PWA works on most modern smartphones and tablets. Here's a quick note about browser compatibility: * **Andr...
--- title: Mobile App Installation breadcrumbs: - crm - mobile-app-installation --- Frappe CRM offers a mobile-friendly interface through a Progressive Web App (PWA). This means you can access all the CRM functionalities directly on your phone. ## Supported Devices and Browsers The Frappe CRM PWA works on most moder...
https://docs.frappe.io/crm/email-template
2025-04-10
en
Email Template
[ "crm", "email-template" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Email Template"><meta property="og:ima...
Email templates serve as a time-saving tool for composing emails efficiently. With the ability to utilize Jinja templates, you can personalize emails to cater to specific recipients or contexts. ## Create a new Email Template To create a new Email Template: * Go to the Email Template list and click on the "Create" b...
--- title: Email Template breadcrumbs: - crm - email-template --- Email templates serve as a time-saving tool for composing emails efficiently. With the ability to utilize Jinja templates, you can personalize emails to cater to specific recipients or contexts. ## Create a new Email Template To create a new Email Tem...
https://docs.frappe.io/crm/pinned-view
2025-04-10
en
Pinned View
[ "crm", "pinned-view" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Pinned View"><meta property="og:image:...
Pinned View is a handy feature that allows you to save frequently used views and access them quickly from the sidebar. [ ](https://docs.frappe.io/files/PinnedView.mov) ## What are Pinned Views? Pinned Views are essentially saved views that you've designated for easy access. This means you can create custom filters ...
--- title: Pinned View breadcrumbs: - crm - pinned-view --- Pinned View is a handy feature that allows you to save frequently used views and access them quickly from the sidebar. [ ](https://docs.frappe.io/files/PinnedView.mov) ## What are Pinned Views? Pinned Views are essentially saved views that you've designat...
https://docs.frappe.io/crm/deal
2025-04-10
en
Deal
[ "crm", "deal" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Deal"><meta property="og:image:width" ...
The Deal page is your central hub for managing potential business opportunities (deals) with your customers and prospects. Here, you can track progress, collaborate with colleagues, and close deals efficiently. ## What is a Deal? A deal represents a potential sales transaction your company is pursuing with a customer...
--- title: Deal breadcrumbs: - crm - deal --- The Deal page is your central hub for managing potential business opportunities (deals) with your customers and prospects. Here, you can track progress, collaborate with colleagues, and close deals efficiently. ## What is a Deal? A deal represents a potential sales trans...
https://docs.frappe.io/crm/public-view
2025-04-10
en
Public View
[ "crm", "public-view" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Public View"><meta property="og:image:...
Public Views are a powerful way to share commonly used filters and layouts with all users in your CRM system. This section will explain what Public Views are, how to create them, and who can create them. [ ](https://docs.frappe.io/files/PublicView.mov) ## What are Public Views? Public Views are saved views that are...
--- title: Public View breadcrumbs: - crm - public-view --- Public Views are a powerful way to share commonly used filters and layouts with all users in your CRM system. This section will explain what Public Views are, how to create them, and who can create them. [ ](https://docs.frappe.io/files/PublicView.mov) ## ...
https://docs.frappe.io/crm/erpnext
2025-04-10
en
ERPNext
[ "crm", "erpnext" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="ERPNext"><meta property="og:image:widt...
Frappe CRM, while a standalone application, offers seamless integration with ERPNext to streamline your business processes. This integration allows you to create quotations and customers directly from deals within Frappe CRM, enhancing efficiency and reducing manual data entry. ## Creating Quotation from Deals The in...
--- title: ERPNext breadcrumbs: - crm - erpnext --- Frappe CRM, while a standalone application, offers seamless integration with ERPNext to streamline your business processes. This integration allows you to create quotations and customers directly from deals within Frappe CRM, enhancing efficiency and reducing manual ...
https://docs.frappe.io/crm/organization
2025-04-10
en
Organization
[ "crm", "organization" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Organization"><meta property="og:image...
The Organization master is used to store relevant information like website details, annual revenue, territory, and no. of employees of your Lead / Deal. To create a new Organization, * Go to Organization tab, and click on the "Create" button * Fill in the relevant information * Click on Create ## Linking an Organiza...
--- title: Organization breadcrumbs: - crm - organization --- The Organization master is used to store relevant information like website details, annual revenue, territory, and no. of employees of your Lead / Deal. To create a new Organization, * Go to Organization tab, and click on the "Create" button * Fill in the...
https://docs.frappe.io/crm/note
2025-04-10
en
Note
[ "crm", "note" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Note"><meta property="og:image:width" ...
Notes are a way to capture and store important details about your leads and deals within Frappe CRM. This information can be referenced later to gain valuable context and insights throughout the sales process. ## Creating Notes There are three ways to create notes in Frappe CRM: 1. **Notes List View:** The Notes lis...
--- title: Note breadcrumbs: - crm - note --- Notes are a way to capture and store important details about your leads and deals within Frappe CRM. This information can be referenced later to gain valuable context and insights throughout the sales process. ## Creating Notes There are three ways to create notes in Fra...
https://docs.frappe.io/crm/task
2025-04-10
en
Task
[ "crm", "task" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Task"><meta property="og:image:width" ...
The task page in Frappe CRM is your central hub for managing everything on your to-do list. Here, you can view and manage tasks efficiently. ## **With the help of Task, you can** * **View All Tasks:** Get a clear overview of your entire workload, including upcoming tasks and those you've completed in the past. * **...
--- title: Task breadcrumbs: - crm - task --- The task page in Frappe CRM is your central hub for managing everything on your to-do list. Here, you can view and manage tasks efficiently. ## **With the help of Task, you can** * **View All Tasks:** Get a clear overview of your entire workload, including upcoming tas...
https://docs.frappe.io/crm/view
2025-04-10
en
Saved View
[ "crm", "view" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Saved View"><meta property="og:image:w...
Saved Views allow you to personalize your list views by applying filters, sorting, and selecting specific columns. This lets you quickly access frequently used data configurations without having to re-apply them every time. ## What are Views? A View is a combination of: * **Filters:** Specify which data records to d...
--- title: Saved View breadcrumbs: - crm - view --- Saved Views allow you to personalize your list views by applying filters, sorting, and selecting specific columns. This lets you quickly access frequently used data configurations without having to re-apply them every time. ## What are Views? A View is a combinatio...
https://docs.frappe.io/crm/setting-up
2025-04-10
en
Setting Up
[ "crm", "setting-up" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Setting Up"><meta property="og:image:w...
This guide will walk you through the setup process for your Frappe CRM after installation. You'll learn how to configure essential elements, import data, and access your CRM portal. ## Choosing your deployment option Frappe CRM offers two deployment options: 1. **Frappe Cloud:** Experience a hassle-free setup with F...
--- title: Setting Up breadcrumbs: - crm - setting-up --- This guide will walk you through the setup process for your Frappe CRM after installation. You'll learn how to configure essential elements, import data, and access your CRM portal. ## Choosing your deployment option Frappe CRM offers two deployment options: ...
https://docs.frappe.io/crm/twilio
2025-04-10
en
Twilio
[ "crm", "twilio" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Twilio"><meta property="og:image:width...
Twilio is a cloud communications platform that allows businesses to integrate voice, video, messaging, and authentication functionalities into their applications. This integration enables you to make calls directly from various pages within the CRM. ## Make call * **Lead page:** A call button is available in the righ...
--- title: Twilio breadcrumbs: - crm - twilio --- Twilio is a cloud communications platform that allows businesses to integrate voice, video, messaging, and authentication functionalities into their applications. This integration enables you to make calls directly from various pages within the CRM. ## Make call * **...
https://docs.frappe.io/crm/exotel
2025-04-10
en
Exotel
[ "crm", "exotel" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Exotel"><meta property="og:image:width...
Exotel is a cloud telephony platform that enables businesses to manage voice calls, SMS, and communication workflows without traditional phone hardware. The integration with Frappe CRM combines these communication capabilities with customer relationship management to provide a unified system for handling customer inter...
--- title: Exotel breadcrumbs: - crm - exotel --- Exotel is a cloud telephony platform that enables businesses to manage voice calls, SMS, and communication workflows without traditional phone hardware. The integration with Frappe CRM combines these communication capabilities with customer relationship management to p...
https://docs.frappe.io/crm/custom-fields
2025-04-10
en
Custom Fields
[ "crm", "custom-fields" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Fields"><meta property="og:imag...
Frappe CRM understands that every business has unique needs. That's why it offers customization options to tailor the system to your specific workflows. This guide focuses on adding Custom Fields, a powerful tool for capturing additional data relevant to your business. ## What are Custom Fields? The default Lead/Deal...
--- title: Custom Fields breadcrumbs: - crm - custom-fields --- Frappe CRM understands that every business has unique needs. That's why it offers customization options to tailor the system to your specific workflows. This guide focuses on adding Custom Fields, a powerful tool for capturing additional data relevant to ...
https://docs.frappe.io/crm/data
2025-04-10
en
Data
[ "crm", "data" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Data"><meta property="og:image:width" ...
The side panel allowed quick access to frequently used fields but had limitations like excessive scrolling and no support for child tables. The new Data Tab addresses these issues, offering a cleaner, more organized way to view and manage data efficiently. You can customize the data fields using Tabs, Sections, and Co...
--- title: Data breadcrumbs: - crm - data --- The side panel allowed quick access to frequently used fields but had limitations like excessive scrolling and no support for child tables. The new Data Tab addresses these issues, offering a cleaner, more organized way to view and manage data efficiently. You can customi...
https://docs.frappe.io/crm/profile
2025-04-10
en
Profile
[ "crm", "profile" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Profile"><meta property="og:image:widt...
You can update your name, profile image, and password from the Profile Settings page. ## How to Update Your Profile 1. Navigate to Settings → Profile. 2. Update your **First** or **Last name** if needed. 3. Click on **Edit profile photo** to update the avatar image. 4. Add new password to change your password. 5. Cli...
--- title: Profile breadcrumbs: - crm - profile --- You can update your name, profile image, and password from the Profile Settings page. ## How to Update Your Profile 1. Navigate to Settings → Profile. 2. Update your **First** or **Last name** if needed. 3. Click on **Edit profile photo** to update the avatar image...
https://docs.frappe.io/crm/custom-branding
2025-04-10
en
Custom Branding
[ "crm", "custom-branding" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Branding"><meta property="og:im...
You can now customize your Frappe CRM with a custom **Logo**, **Name**, and **Favicon** based on your business requirements. This feature is accessible under Settings → General.
--- title: Custom Branding breadcrumbs: - crm - custom-branding --- You can now customize your Frappe CRM with a custom **Logo**, **Name**, and **Favicon** based on your business requirements. This feature is accessible under Settings → General.
https://docs.frappe.io/crm/home-actions
2025-04-10
en
Home Actions
[ "crm", "home-actions" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Home Actions"><meta property="og:image...
You can now add, edit, or hide custom links with icons in the dropdown menu. This feature is accessible under Settings → General. For custom icons, you can use Feather Icons or add an SVG in the icon field.
--- title: Home Actions breadcrumbs: - crm - home-actions --- You can now add, edit, or hide custom links with icons in the dropdown menu. This feature is accessible under Settings → General. For custom icons, you can use Feather Icons or add an SVG in the icon field.
https://docs.frappe.io/crm/web-form
2025-04-10
en
Web Form
[ "crm", "web-form" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Web Form"><meta property="og:image:wid...
Web Forms in Frappe CRM let you collect leads directly from your website without writing a single line of code. Follow these simple steps to create one: 1. **Switch to Desk:** First, switch to the desk view by clicking the profile button in the top left corner and selecting Apps > Desk. 2. **Create Web form:** * Sear...
--- title: Web Form breadcrumbs: - crm - web-form --- Web Forms in Frappe CRM let you collect leads directly from your website without writing a single line of code. Follow these simple steps to create one: 1. **Switch to Desk:** First, switch to the desk view by clicking the profile button in the top left corner and...
https://docs.frappe.io/crm/whatsapp
2025-04-10
en
WhatsApp
[ "crm", "whatsapp" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="WhatsApp"><meta property="og:image:wid...
WhatsApp integration allows you to send and receive WhatsApp messages from within the lead and deal pages in Frappe CRM. This streamlines communication and keeps all interaction history centralised for better customer relationship management. A dedicated WhatsApp tab is available on both Lead and Deal pages, providing...
--- title: WhatsApp breadcrumbs: - crm - whatsapp --- WhatsApp integration allows you to send and receive WhatsApp messages from within the lead and deal pages in Frappe CRM. This streamlines communication and keeps all interaction history centralised for better customer relationship management. A dedicated WhatsApp ...
https://docs.frappe.io/cloud/bench-analytics
2025-09-04
en
Bench Analytics
[ "cloud", "bench-analytics" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Bench Analytics"><meta property="og:im...
We have now added a feature to expose bench level metrics. Available under the `Bench Analytics` tab on the server page Smiliar to how users are exposed to site level analytics, it is now possible to see how benches in a selected release group are performing and early detect problems using this as well. We currently...
--- title: Bench Analytics breadcrumbs: - cloud - bench-analytics --- We have now added a feature to expose bench level metrics. Available under the `Bench Analytics` tab on the server page Smiliar to how users are exposed to site level analytics, it is now possible to see how benches in a selected release group are...
https://docs.frappe.io/cloud/server-snapshot
2025-09-04
en
Server Snapshot
[ "cloud", "server-snapshot" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Server Snapshot"><meta property="og:im...
A **Server Snapshot** is a time-based copy of server's disks. It can be used to create a new server or recover your data in the future. Snapshots are useful for **disaster recovery** and can be kept for as long as you want, even after the server is archived. ### Charges Snapshots are charged at **6.5 INR / GB / Mont...
--- title: Server Snapshot breadcrumbs: - cloud - server-snapshot --- A **Server Snapshot** is a time-based copy of server's disks. It can be used to create a new server or recover your data in the future. Snapshots are useful for **disaster recovery** and can be kept for as long as you want, even after the server is...
https://docs.frappe.io/cloud/database-server-actions
2025-08-28
en
Database Server Actions
[ "cloud", "database-server-actions" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Database Server Actions"><meta propert...
On **Server Actions** page, you will find several options for database configuration. #### What is Binlog & Why It's required ? The **Binary Log (Binlog)** in MariaDB is a crucial logging mechanism that records all changes to the database - such as SQL statements that modify data (INSERT, UPDATE, DELETE). It does **n...
--- title: Database Server Actions breadcrumbs: - cloud - database-server-actions --- On **Server Actions** page, you will find several options for database configuration. #### What is Binlog & Why It's required ? The **Binary Log (Binlog)** in MariaDB is a crucial logging mechanism that records all changes to the d...
https://docs.frappe.io/cloud/app-plan
2025-08-27
en
App Pricing Plans
[ "cloud", "app-plan" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="App Pricing Plans"><meta property="og:...
You can create different pricing plans for your marketplace apps, offering different services according to your needs. e.g. Customization, Priority Support, etc: ### How do customers subscribe to your app plan? During app installation on a Frappe Cloud site, the user gets an option to select a plan. They can also ch...
--- title: App Pricing Plans breadcrumbs: - cloud - app-plan --- You can create different pricing plans for your marketplace apps, offering different services according to your needs. e.g. Customization, Priority Support, etc: ### How do customers subscribe to your app plan? During app installation on a Frappe Clou...
https://docs.frappe.io/cloud/change-team-of-bench-group
2025-08-20
en
Change Team of Bench Group
[ "cloud", "change-team-of-bench-group" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Change Team of Bench Group"><meta prop...
You can change the team of the site by using the **Transfer Bench Group** feature. 1. Select Transfer Bench Group option from the Actions tab in your Bench Group's dashboard. 2. Fill in the fields and click on **Transfer** 3. The team that is supposed to receive the ownership will now receive a mail to accept the ow...
--- title: Change Team of Bench Group breadcrumbs: - cloud - change-team-of-bench-group --- You can change the team of the site by using the **Transfer Bench Group** feature. 1. Select Transfer Bench Group option from the Actions tab in your Bench Group's dashboard. 2. Fill in the fields and click on **Transfer** 3...
https://docs.frappe.io/cloud/dropping-a-bench-group
2025-08-20
en
Dropping a Bench Group
[ "cloud", "dropping-a-bench-group" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Dropping a Bench Group"><meta property...
> You cannot drop a Bench Group which active sites under it 1. From your Bench Group dashboard go to Actions > Dangerous Actions. 2. Click on the Drop button. 3. You will be asked to confirm the name of the Bench Group you want to drop. 4. Once you have typed in the name click on the `Drop` button
--- title: Dropping a Bench Group breadcrumbs: - cloud - dropping-a-bench-group --- > You cannot drop a Bench Group which active sites under it 1. From your Bench Group dashboard go to Actions > Dangerous Actions. 2. Click on the Drop button. 3. You will be asked to confirm the name of the Bench Group you want to dro...
https://docs.frappe.io/cloud/what-are-benches-and-bench-groups
2025-08-14
en
What are Benches and Bench Groups?
[ "cloud", "what-are-benches-and-bench-groups" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="What are Benches and Bench Groups?"><m...
* **Bench** is a collection of apps and sites. * **Bench Group** is a collection of **Benches**. ## **Bench** A **Bench** is a collection of apps and sites. All sites on a **Bench** share the same configuration, such as the version of apps, or version of dependencies. Frappe Cloud creates **Benches** from informatio...
--- title: What are Benches and Bench Groups? breadcrumbs: - cloud - what-are-benches-and-bench-groups --- * **Bench** is a collection of apps and sites. * **Bench Group** is a collection of **Benches**. ## **Bench** A **Bench** is a collection of apps and sites. All sites on a **Bench** share the same configuration...
https://docs.frappe.io/cloud/benches
2025-08-10
en
Private Bench Groups
[ "cloud", "benches" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Private Bench Groups"><meta property="...
With private bench groups you can unlock the pull power of Frappe Cloud. To understand what are private bench groups, first you have to understand what are Benches and Bench Groups ## Public Bench Groups Any site you create using the `+ New` button from Frappe Cloud dashboard home page, is created under a bench group...
--- title: Private Bench Groups breadcrumbs: - cloud - benches --- With private bench groups you can unlock the pull power of Frappe Cloud. To understand what are private bench groups, first you have to understand what are Benches and Bench Groups ## Public Bench Groups Any site you create using the `+ New` button f...
https://docs.frappe.io/cloud/server-storage-breakdown
2025-08-01
en
Server Storage Breakdown
[ "cloud", "server-storage-breakdown" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Server Storage Breakdown"><meta proper...
# Database Server If you want to know, what is consuming storage on your dedicated database server, you can use this option. 1. Click on the `pie` icon in your server overview page. 2. You will get storage breakdown in this way. 3. You can click on the `Site Name` to view tablewise usage in the database. #### Some T...
--- title: Server Storage Breakdown breadcrumbs: - cloud - server-storage-breakdown --- # Database Server If you want to know, what is consuming storage on your dedicated database server, you can use this option. 1. Click on the `pie` icon in your server overview page. 2. You will get storage breakdown in this way. ...
https://docs.frappe.io/cloud/tiny-plan
2025-08-01
en
Tiny Plan ($5 / month)
[ "cloud", "tiny-plan" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Tiny Plan ($5 / month)"><meta property...
### Why is it so cheap ? This plan has a couple of constraints on resource usage, deployment location, and the ability to install only selected apps. Custom apps are also not permitted. This plan provides * 0.5 compute hour / day * 250 MB of database storage * 2.5 GB of disk storage It has several limitations * Cu...
--- title: Tiny Plan ($5 / month) breadcrumbs: - cloud - tiny-plan --- ### Why is it so cheap ? This plan has a couple of constraints on resource usage, deployment location, and the ability to install only selected apps. Custom apps are also not permitted. This plan provides * 0.5 compute hour / day * 250 MB of dat...
https://docs.frappe.io/cloud/storage-addons
2025-07-29
en
Storage Addons
[ "cloud", "storage-addons" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Storage Addons"><meta property="og:ima...
## Introduction In case the base storage included in the Server's plan is not enough, you can always add more storage to your server as required at an additional cost of $0.2/GB per month. Note that AWS does not allow us to revert the storage added to a volume. So, if it turns out that you don't need the additional st...
--- title: Storage Addons breadcrumbs: - cloud - storage-addons --- ## Introduction In case the base storage included in the Server's plan is not enough, you can always add more storage to your server as required at an additional cost of $0.2/GB per month. Note that AWS does not allow us to revert the storage added t...
https://docs.frappe.io/cloud/recent-issues
2025-07-22
en
Recent Issues
[ "cloud", "recent-issues" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Recent Issues"><meta property="og:imag...
## Frankfurt sites down issue (2025-07-22) Sites were reported being down and agent jobs failing on the sites with a 404 error. The issue had happened due to an nginx config limit being reached. We've updated the same on all proxies to prevent same issues going forward. ## *.frappe.cloud redirect issue (2025-07-15) ...
--- title: Recent Issues breadcrumbs: - cloud - recent-issues --- ## Frankfurt sites down issue (2025-07-22) Sites were reported being down and agent jobs failing on the sites with a 404 error. The issue had happened due to an nginx config limit being reached. We've updated the same on all proxies to prevent same iss...
https://docs.frappe.io/cloud/introduction
2025-07-10
en
Introduction
[ "cloud", "introduction" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Introduction"><meta property="og:image...
## What is Frappe Cloud? Frappe Cloud is a 100% open-source cloud hosting for the Frappe stack. ## Why Frappe Cloud? Frappe Cloud takes the hassle out of hosting and managing Frappe apps so you can focus on what truly matters: building and growing your business. 1. Effortless Hosting – Deploy your Frappe apps in mi...
--- title: Introduction breadcrumbs: - cloud - introduction --- ## What is Frappe Cloud? Frappe Cloud is a 100% open-source cloud hosting for the Frappe stack. ## Why Frappe Cloud? Frappe Cloud takes the hassle out of hosting and managing Frappe apps so you can focus on what truly matters: building and growing your...
https://docs.frappe.io/cloud/role-permissions
2025-07-09
en
Role Permissions
[ "cloud", "role-permissions" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Role Permissions"><meta property="og:i...
Frappe Cloud provides permission access for team members based on roles. They allow you to restrict access to site, bench group and server individually. ## Configuring Permission > Configuring of permission is only allowed for Team owners and admins * Go to Settings > Permissions * Click on New Role, input the Role...
--- title: Role Permissions breadcrumbs: - cloud - role-permissions --- Frappe Cloud provides permission access for team members based on roles. They allow you to restrict access to site, bench group and server individually. ## Configuring Permission > Configuring of permission is only allowed for Team owners and ad...
https://docs.frappe.io/cloud/public-bench-update-schedule
2025-07-09
en
Public Bench Update Schedule
[ "cloud", "public-bench-update-schedule" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Public Bench Update Schedule"><meta pr...
Public/Shared benches update every Wednesday. Sites get auto updated soon after. Your site on public bench should get auto updated by the end of thursday.
--- title: Public Bench Update Schedule breadcrumbs: - cloud - public-bench-update-schedule --- Public/Shared benches update every Wednesday. Sites get auto updated soon after. Your site on public bench should get auto updated by the end of thursday.
https://docs.frappe.io/cloud/how-to-get-static-ip
2025-07-09
en
Obtain a Static IP
[ "cloud", "how-to-get-static-ip" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Obtain a Static IP"><meta property="og...
To obtain a static IP, you will need to migrate your site to a dedicated server and request a static IP to be assigned to your site in advance. (You can request us via support portal) **Note**:- The IP that you will get by default will not be static
--- title: Obtain a Static IP breadcrumbs: - cloud - how-to-get-static-ip --- To obtain a static IP, you will need to migrate your site to a dedicated server and request a static IP to be assigned to your site in advance. (You can request us via support portal) **Note**:- The IP that you will get by default will not ...
https://docs.frappe.io/cloud/control-resources-allocated-for-site
2025-07-09
en
Control resources allocated for site
[ "cloud", "control-resources-allocated-for-site" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Control resources allocated for site">...
You may notice that the sites you create within your dedicated server are all assigned an **Unlimited** plan by default or **Unlimited - Supported,** depending on whether you choose to avail support on it. At some point you may add other smaller (based on usage) sites to the same server as it's free (technically). In ...
--- title: Control resources allocated for site breadcrumbs: - cloud - control-resources-allocated-for-site --- You may notice that the sites you create within your dedicated server are all assigned an **Unlimited** plan by default or **Unlimited - Supported,** depending on whether you choose to avail support on it. A...
https://docs.frappe.io/cloud/site-process-list
2025-07-09
en
Site Process List
[ "cloud", "site-process-list" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Site Process List"><meta property="og:...
You can view running mariadb queries in your site by opening **Insights** tab, and then **Reports ->** **Process List Report** You'll see running queries in the above page when using your site
--- title: Site Process List breadcrumbs: - cloud - site-process-list --- You can view running mariadb queries in your site by opening **Insights** tab, and then **Reports ->** **Process List Report** You'll see running queries in the above page when using your site
https://docs.frappe.io/cloud/custom-frappe-framework-fork
2025-07-09
en
Custom Frappe Framework Fork
[ "cloud", "custom-frappe-framework-fork" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Custom Frappe Framework Fork"><meta pr...
You can use your custom version/fork of the vanilla Frappe Framework. > Note: We do not support modified versions of the framework. You can do so by simply following the add app flow inside your Bench Groups. This will replace the Vanilla Frappe Framework with your custom fork / version.
--- title: Custom Frappe Framework Fork breadcrumbs: - cloud - custom-frappe-framework-fork --- You can use your custom version/fork of the vanilla Frappe Framework. > Note: We do not support modified versions of the framework. You can do so by simply following the add app flow inside your Bench Groups. This will r...
https://docs.frappe.io/cloud/connect-metabase
2025-07-09
en
Connect Metabase
[ "cloud", "connect-metabase" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Connect Metabase"><meta property="og:i...
> Metabase is an open-source business intelligence (BI) tool that allows users to explore data, create dashboards, and visualize data 1. You need to first generate a database user for your site. Follow this documentation to create a read-only user. Typically, it takes a few seconds to configure the database user. Onc...
--- title: Connect Metabase breadcrumbs: - cloud - connect-metabase --- > Metabase is an open-source business intelligence (BI) tool that allows users to explore data, create dashboards, and visualize data 1. You need to first generate a database user for your site. Follow this documentation to create a read-only use...
https://docs.frappe.io/cloud/cant-connect-to-mysql-server
2025-07-09
en
Can't connect to MySQL server
[ "cloud", "cant-connect-to-mysql-server" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Can&#39;t connect to MySQL server"><me...
```None ERROR 2002 (HY000): Can't connect to MySQL server on '10.1.1.1' (115) ``` You may see this error when restoring a site or during a migrate job. This likely happened as the mysql server restarted as it didn't have sufficient memory for the operation. Changing the **database server** plan for more memory should ...
--- title: Can't connect to MySQL server breadcrumbs: - cloud - cant-connect-to-mysql-server --- ```None ERROR 2002 (HY000): Can't connect to MySQL server on '10.1.1.1' (115) ``` You may see this error when restoring a site or during a migrate job. This likely happened as the mysql server restarted as it didn't have ...
https://docs.frappe.io/cloud/local-fc-setup
2025-07-09
en
Local Development Environment Setup
[ "cloud", "local-fc-setup" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Local Development Environment Setup"><...
This guide shows you how to setup your development machine for Frappe Cloud development. By the end of this guide, you will have a replica of the FC production environment. > “Patience is bitter, but its fruit is sweet.” – Aristotle ## Introduction `f` servers: These host your bench (`f` is for Frappe Apps) `m` ser...
--- title: Local Development Environment Setup breadcrumbs: - cloud - local-fc-setup --- This guide shows you how to setup your development machine for Frappe Cloud development. By the end of this guide, you will have a replica of the FC production environment. > “Patience is bitter, but its fruit is sweet.” – Aristo...
https://docs.frappe.io/cloud/connect-power-bi-desktop
2025-07-09
en
Connect Power BI Desktop
[ "cloud", "connect-power-bi-desktop" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Connect Power BI Desktop"><meta proper...
> Microsoft Power BI is an interactive data visualization software product developed by Microsoft with a primary focus on business intelligence (BI). ## Step 1: Create Site Database User 1. You need to first generate a database user for your site. Follow this documentation to create a read-only user. 2. Typically, it...
--- title: Connect Power BI Desktop breadcrumbs: - cloud - connect-power-bi-desktop --- > Microsoft Power BI is an interactive data visualization software product developed by Microsoft with a primary focus on business intelligence (BI). ## Step 1: Create Site Database User 1. You need to first generate a database u...
https://docs.frappe.io/cloud/database-users-and-permission-manager
2025-07-09
en
Database Users And Permission Manager
[ "cloud", "database-users-and-permission-manager" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Database Users And Permission Manager"...
> Database Access is available for sites on USD 50 and above plans ## Available Permissions There are three types of permissions that can be assigned to database users: 1. **Read Only**: The user can view data but cannot modify it. They have access to all tables and columns in the database for reading purposes only....
--- title: Database Users And Permission Manager breadcrumbs: - cloud - database-users-and-permission-manager --- > Database Access is available for sites on USD 50 and above plans ## Available Permissions There are three types of permissions that can be assigned to database users: 1. **Read Only**: The user can vi...
https://docs.frappe.io/cloud/instructions-to-upgrade-the-email-delivery-service-plan
2025-07-09
en
Upgrade the Email Delivery Service plan for more emails
[ "cloud", "instructions-to-upgrade-the-email-delivery-service-plan" ]
<!DOCTYPE html> <!-- Built on Frappe. https://frappeframework.com/ --> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <meta name="generator" content="frappe"> <meta name="title" content="Upgrade the Email Delivery Service pla...
From your Frappe Cloud site dashboard navigate to the Apps tab and click on three dots from the Email Delivery Service app. Choose the plan you would like as per your requirements and click on select plan to confirm the change. > Once logged into your site, you can monitor the emails sent by searching for "**Email De...
--- title: Upgrade the Email Delivery Service plan for more emails breadcrumbs: - cloud - instructions-to-upgrade-the-email-delivery-service-plan --- From your Frappe Cloud site dashboard navigate to the Apps tab and click on three dots from the Email Delivery Service app. Choose the plan you would like as per your r...