This commit is contained in:
Rushabh Mehta
2017-07-28 11:44:35 +05:30
parent 076ea0d548
commit bd2578bc36
3744 changed files with 170656 additions and 53 deletions

View File

@@ -0,0 +1,22 @@
[
{
"route": "/docs",
"title": "Docs Home"
},
{
"route": "/docs/user",
"title": "User Guide"
},
{
"route": "/docs/current/api",
"title": "Server API"
},
{
"route": "/docs/current/models",
"title": "Models (Reference)"
},
{
"route": "https://github.com/frappe/erpnext/tree/develop/erpnext/docs",
"title": "Improve Docs"
}
]

View File

@@ -0,0 +1,17 @@
<!-- add-breadcrumbs -->
Global-search.md
Global search is a word-processing operation in which a complete computer file or set of files is searched for every occurrence of a particular word or other sequence of characters.
We have made the Awesome Bar of ERPNext lot more powerful by adding Global Search feature.
Global Search helps users find information quickly. It’s located in the upper right-hand corner in ERPNext.  Simply entering a few characters in the Search will show results from several different record types (Contact, Customer, Issues etc.) related to that keyword. You can also customise the fields based on which search will be shown.
### Using Awesome bar for Global Search.
<img alt="Global Search" class="screenshot" src="{{docs_base_url}}/assets/img/articles/Global Search .gif">
### Enable Global Search for fields in a Doctype.
<img alt="Global Search" class="screenshot" src="{{docs_base_url}}/assets/img/articles/Enable Global Search .gif">

View File

@@ -0,0 +1,22 @@
[
{
"route": "/docs",
"title": "Docs Home"
},
{
"route": "/docs/user",
"title": "User Guide"
},
{
"route": "/docs/current/api",
"title": "Server API"
},
{
"route": "/docs/current/models",
"title": "Models (Reference)"
},
{
"route": "https://github.com/frappe/erpnext/tree/develop/erpnext/docs",
"title": "Improve Docs"
}
]

View File

@@ -0,0 +1,10 @@
<!-- add-breadcrumbs -->
#Adding Attachments to Outgoing Messages
ERPNext has in-built file manager. Click [here]({{docs_base_url}}/user/videos/learn/file-manager.html) to learn more on how attachments are managed in ERPNext.
If you have file attached to the document (say Purchase Order), and same file needs to be emailed as attachment, following is how you can achieve it.
<img alt="Emailing Attachments" class="screenshot" src="{{docs_base_url}}/assets/img/articles/email-file-attachment.gif">
<!-- markdown -->

View File

@@ -0,0 +1,37 @@
<!-- add-breadcrumbs -->
#Adding File as a Attachment
ERPNext allows to attach files with documents. User with a read permission on particular document will also be able to access files attached with it.
###Attach New File
There are several ways to attach file to the document.
####From Browser
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/attach-file-1.gif">
####By drag and drop
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/attach-file-2.gif">
Click on Attach to browse and select the file.
####Link
If you use separate server for files, or use online service like Dropbox, you can attach file by providing link of a particular file.
<img alt="Sales Order Select File" class="screenshot" src="{{docs_base_url}}/assets/img/articles/attach-file-3.gif">
`For hosted users, limit of 5 MB is applied on file size.`
To ensure there are not many files attached to a document, which can affect your accounts performance, you can set limit as how many files can be attached to a particular document. Click [here]({{docs_base_url}}/user/manual/en/customize-erpnext/articles/increase-max-attachments.html) to learn more about it.
####File Manager
Check following link to learn how files are managed in ERPNext.
<iframe width="660" height="371" src="https://www.youtube.com/embed/4-osLW3E_Rk" frameborder="0" allowfullscreen></iframe>
<!-- markdown -->

View File

@@ -0,0 +1,28 @@
<!-- add-breadcrumbs -->
#Bulk Rename
Using renaming tool, you can to rectify/change multiple document ids at once. This tool is only accessible to the User who has System Manager role assigned.
###Rename Tool
You can rename ids of upto 500 records at a time. Following are step to bulk rename bulk records. Let's assume we are renaming Item Codes for the existing items.
#### Step 1: Open Excel File
In a spreadsheet file, enter old Item IDs in the first column, and new Item Ids in the second column. Save spreadsheet file in a CSV format.
<img alt="Data File" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-docs-1.png">
#### Step 2: Upload Data File
To upload data file go to,
`Setup > Data > Rename Tool`
Select DocType which you want to rename. Here DocType will be Item. Then Browse and Upload data file.
![Upload Data]({{docs_base_url}}/assets/img/articles/Selection_0173436a8.png)
{next}
<!-- markdown -->

View File

@@ -0,0 +1,24 @@
<!-- add-breadcrumbs -->
#Checking Link Between Documents
Links option shows one document is linked to which other documents. Check Menu for the Links options.
<img alt="Cancel Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/links-1.gif">
####Scenario
If you need that against Sales Order, which Delivery Note and Sales Invoice has been created, you should open Sales Order document, and check Links. Same way, you can also check Purchase Order, and find which Purchase Receipt and Purchase Ivoice is linked with it.
####How It Works?
When you check Links for a Sales Order, it lists all the record where this Sales Order ID is linked. When Delivery Note is created against Sales Order, then Sales Order link is updated in the Delivery Note Item table.
####Backward Links
If I check Links in the Purchase Receipt, will it list Purchase Order from which this Purchase Receipt was created?
Links only shows forward linkages. For the backward links, you should check current document itself. In the Purchase Receipt Item table table, you can check which Purchase Order it is linked to.
<img alt="Cancel Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/links-2.gif">
<!-- markdown -->

View File

@@ -0,0 +1,30 @@
<!-- add-breadcrumbs -->
#Delete Submitted Document
To be able to delete Submitted document, you should first Cancel. Once canceled, you can delete that document from Menu or from the List View of that Document Type.
If document which needs to be deleted is also linked to other documents, then you should first Cancel document those document as well. For example if you need to delete Sales Order, but Delivery Note and Sales Invoice has already been created against it. Then you should first cancel and delete documents in reverse order, i.e. Sales Invoice, Delivery Note and then Sales Order.
Delete option is only visible to user having related permission. From Role Permission Manager, you can control and define Delete permission and Role for each Document Type.
Following are step to delete submitted documents.
####Step 1: Cancel Document
You will find option to Cancel in the submitted document. If document is at draft stage, it can delete directly. Also if document is not submittable, but only save, it can be deleted directly.
<img alt="Cancel Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/delete-submitted-doc-1.png">
####Step 2: Delete Document
After cancellation, go to Menu and click on Delete.
<img alt="Delete Doc" class="screenshot" src="{{docs_base_url}}/assets/img/articles/delete-submitted-doc-2.png">
####Step 3: Deleting from List
For bulk deletion, you can select multiple Cancelled records and delete at once from the List View.
<img alt="Delete Doc from List" class="screenshot" src="{{docs_base_url}}/assets/img/articles/delete-submitted-doc-3.gif">
<!-- markdown -->

View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
#Duplicate a Record
Duplicate feature helps you to copy values of existing document into new document.
####Scenario
An electronic supplier receives a repeat order from an existing customer. Since new order will have details just like previous order, you should open previous order, and Duplciate it to create new order faster. On Duplicating, values of the previous transaction will be updated in a new document. You can make changes where needed and submit the document.
You will find Copy option under:
`Menu > Copy`
<img alt="Duplicate" class="screenshot" src="{{docs_base_url}}/assets/img/articles/duplicate.gif">
<!-- markdown -->

View File

@@ -0,0 +1,2 @@
<!-- add-breadcrumbs -->
{index}

View File

@@ -0,0 +1,11 @@
adding-attachment-to-outgoing-messages
check-link-between-documents
delete-submitted-document
duplicate-record
adding-file-as-a-attachment
merging-documents
bulk-rename
renaming-documents
search-filter
tree-master-renaming
pos-view

View File

@@ -0,0 +1,32 @@
<!-- add-breadcrumbs -->
#Merging Documents
For a document, if you have two records which are identical, and meant for common purpose, you can merge them into one record.
Following are step to merge documents. Let's assume we are merging two Accounts.
#### Step 1: Go to Chart of Account
`Accounts > Documents > Chart of Accounts`
#### Step 2: Go to Account
For an Account to be merged, click on the "Rename" option.
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/merge-docs-1.png">
#### Step 3: Merge Account
In the New Name field, enter another account name with which this account will be merged. Check "Merge with existing" option. Then press 'Rename' button to merge.
Following is how the merged account will appear in the Chart of Accounts master.
<img alt="Sales Order File Attachment" class="screenshot" src="{{docs_base_url}}/assets/img/articles/merge-docs-2.gif">
###Effect of Merging
After Account is merged, new name is updated in the existing transactions where old account was selected.
<div class="well"> Note: Group Account cannot be merged into Child Account and vice versa.</div>
<!-- markdown -->

View File

@@ -0,0 +1,12 @@
<!-- add-breadcrumbs -->
#POS View
POS (point of sale) view renders form in a different layout, optimized for the quick selection of items. This view has primarily been designed for the retail business.
Using POS View, you can only create Sales Invoice, without switching to standard form view. For other transactions, like Sales Order, Delivery Note, Purchase Order, Purchase Receipt etc., POS View is only used for Item selection. For entering other values in the transaction, you should switch to form view.
<img alt="POS View" class="screenshot" src="{{docs_base_url}}/assets/img/articles/pos-view.gif">
For creating POS Invoice, check following help video.
<iframe width="660" height="371" src="https://www.youtube.com/embed/4WkelWkbP_c" frameborder="0" allowfullscreen></iframe>

View File

@@ -0,0 +1,60 @@
<!-- add-breadcrumbs -->
#Renaming a Document
Using Renaming feature, you can change ID of a master documents like Item, Warehouse, Accounts etc. Following are the steps to rename Item Code. Following same steps, you can rename other masters as well.
#### 1. Go to Item
`Stock > Documents > Item List > (Open Item to be renamed)`
#### 2. Rename
<img alt="Renamed Item" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-a-doc.gif">
###Effect of Renaming
Renaming document affects existing transaction where this record is selected. Consider given example, Item Code for a given item will be updated in the existing transaction as well.
###See Also
1. [Bulk Renaming]({{docs_base_url}}/user/manual/en/using-erpnext/articles/bulk-rename.html)
2. [Document Merging]({{docs_base_url}}/user/manual/en/using-erpnext/articles/merging-documents.html)
**List of Renamable Documents**
1. Contact
2. Address
3. Warehouse
4. Supplier
5. Customer
6. User
7. Sales Partner
8. Project
9. Cost Center
10. Item Group
11. Item
12. Company
13. Role
14. Earning Type
15. Note
16. Serial No
17. Account
18. Territory
19. Terms and Conditions
20. Supplier Type
21. Workstation
22. Employee
23. Sales Taxes and Charges Master
24. Purchase Taxes and Charges Master
25. Price List
26. Party Type
27. Mode of Payment
28. Designation
29. Department
30. Deduction Type
31. Customer Group
32. Brand
33. Branch
34. Sales Person
<!-- markdown -->

View File

@@ -0,0 +1,36 @@
<!-- add-breadcrumbs -->
#Search Filter
Search Filter option allow user to filter records based on value in the specific field of that document. Search Filters are available on the List View of Document Type and in the Report Builder.
Each filter option has three fields.
#### Field
Select field of the document based on which you wish to filter records.
<img alt="Search Filter Field" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-field.gif">
#### Based On
With Field, you will provide a value. In the based on field, you can define a criterion that when filter should be applied in record. It will be when value define for the field if filter is:
<img alt="Search Filter Based On" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-based-on.gif">
#### Value
A value should be entered in this field based on while records will be filtered. After filter is applied, records will be filtered based on it. And filter will shrunk under one field/button.
<img alt="Search Filter Based On" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-result.png">
You can apply multiple filters at a time. To remove specific filter, just click on cancelled (X) sign ahead of it.
#### Ready Filters
From the list views, you can also apply filters by clicking on the Status field.
<img alt="Renamed Item" class="screenshot" src="{{docs_base_url}}/assets/img/articles/search-filter-auto.gif">
<!-- markdown -->

View File

@@ -0,0 +1,24 @@
<!-- add-breadcrumbs -->
#Tree Master Renaming
There are various master which are maintained in tree structure. Click [here]({{docs_base_url}}/user/manual/en/setting-up/articles/managing-tree-structure-masters.html) to learn more about tree structured masters in ERPNext.
Following are the steps to be followed for renaming ID of a master which is maintained in tree structure. Let's rename an Account for the instance.
#### Step 1: Go to Chart of Account
`Accounts > Setup > Chart of Accounts`
#### Step 2: Go to Account
When click on the Account, you will find Rename option.
<img alt="Account" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-account.png">
#### Step 2: Rename Account
On clicking Rename, you will get field to enter New Name. After entering new name for the Account, click on the "Rename" button.
<img alt="Renamed Account" class="screenshot" src="{{docs_base_url}}/assets/img/articles/rename-account-2.gif">
<!-- markdown -->

View File

@@ -0,0 +1,38 @@
<!-- add-breadcrumbs -->
Assign To feature in ERPNext allows you to allocate particular document to specific user, whom needs to further work on that document.
For example, if Sales Order needs to be approved/submitted by Sales Manager, first draft user can allocate that Sales Order to Sales Manager. On allocating document to Sales Manager, it will be added to that user's ToDo list. Same way, allocation can also be done to Material User and Account user who needs to create Delivery Note and Sales Invoice respectively against this Sales Note.
<div class=well>Permissions restriction cannot be done based on Assigned To.</div>
Following are the steps to assign document to another user.
#### Step 1: Click on the Assign To Button
Assign to option is located at the footer of document. Clicking on Assignment Icon on the tool bar will fast-forward you to footer of same document.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-1.png">
#### Step 2: Assign to User
In the Assign To section, you will find option to select User to whom this document will be assigned to. You can assign one document to multiple people at a time.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-2.png">
With assignment, you can also leave a comment for the review of assignee.
####ToDo List of Assignee
This transaction will appear in the To-do list of the user in “Todo” section.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-3.png">
####Removing Assignment
User will be able to remove assignment by clicking on "Assignment Completed" button in the document.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-4.png">
Once assignment is set as completed, the Status of its ToDo record will be set as Closed.
{next}

View File

@@ -0,0 +1,57 @@
<!-- add-breadcrumbs -->
The Calendar is a tool where you can create and share Events and also see auto-generated events from the system.
You can switch calendar view based on Month, Week and Day.
<img class="screenshot" alt="Calendar" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-1.png">
### Creating Events in Calendar
#### Creating Event Manually
To create event manually, you should first determine Calendar View. If Event's start and end time will be within one day, then you should first switch to Day view.
This view will 24 hours of a day broken in various slots. You should click on slot for Event Start Time, and drag it down till you reach event end time.
<img class="screenshot" alt="Calendar" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-2.gif">
Based on the selection of time slot, Start Time and End Time will be updated in the Event master. Then you can set subject for an event, and save it.
#### Event Based on Lead
In the Lead form, you will find a field called Next Contact By and Next Contact Date. Event will be auto created for date and person specified in this field.
<img class="screenshot" alt="Lead Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-3.png">
#### Birthday Event
Birthday Event is created based on Date of Birth specified in the Employee master.
### Recurring Events
You can set events as recurring in specific interval by Checking the "Repeat This
Event".
<img class="screenshot" alt="Calendar Recurring Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-4.png">
### Event Reminders
There are two ways you can receive email reminder for an event.
#### Enable Reminder in Event
In the Event master, checking "Send an email reminder in the morning" will trigger notification email to all the participants for this event.
<img class="screenshot" alt="Calendar Recurring Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calendar-6.png">
#### Create Email Digest
To get email reminders for event, you should set Email Digest for Calendar Events.
Email Digest can be set from:
`Setup > Email > Email Digest`
<img class="screenshot" alt="Calendar Recurring Event" src="{{docs_base_url}}/assets/img/collaboration-tools/calender-email-digest.png">
{next}

View File

@@ -0,0 +1,15 @@
<!-- add-breadcrumbs -->
You can send and receive messages from the system by using the Messages tool.
`Explore > Tools > Chat`
If you send a message to a user, and the user is logged in, it will appear as a popup message and the unread messages counter in the top toolbar will be
updated.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/chat-1.png">
You can choose to send message to all the users, or to specific user.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/chat-2.png">
{next}

View File

@@ -0,0 +1,25 @@
<!-- add-breadcrumbs -->
Following are the tools in each document using which you can collaborate with other Users in your ERPNext account.
### Assigned to
If some document requires an action from User, you can Assign that document to that User. On assignment, User to whom document is assigned is intimated via email. To learn about Assign To feature, [click here.]({{docs_base_url}}/user/manual/en/using-erpnext/assignment.html)
### Comments
Comments are a great way to add information about a transaction that is not a
part of the transactions. Like some background information etc.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/comments-1.png">
###Share
You can share document with the specific User. If Document is shared with the specific User, he/she will be able to access it, even if that User doesn't have permission to access that document or Document Type.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/share-1.gif">
### Tags
[Read more about Tags]({{docs_base_url}}/user/manual/en/using-erpnext/tags.html)
{next}

View File

@@ -0,0 +1,22 @@
<!-- add-breadcrumbs -->
#Document Versioning
The document versioning feature allows you to track all the changes made in the form over the period. It will be very helpful in audit trial to check which user edited what value, and when exactly.
####Enable Document Versioning
Document Versioning can be enabled for one Document Type as a time. Let's assume that we need to enable it from Purchase Order. Then, we will check Customize Form tool for Purchase Order and check field `Track Changes`. With this, document versioning will be enabled for all the Purchase Orders create and edited hence forth.
<img class="screenshot" alt="Enable Versioning" src="{{docs_base_url}}/assets/img/collaboration-tools/enable-versioning.png">
####Version Log
Following is link of version in a Purchase Order form. Each time a document is edited, a version's link will be added in that document. To check more details on specific version, click on it's link.
<img class="screenshot" alt="Version Links" src="{{docs_base_url}}/assets/img/collaboration-tools/version-links.png">
####Version Details
In the Version document, you will find log of all the fields and values changes in it.
<img class="screenshot" alt="Version Details" src="{{docs_base_url}}/assets/img/collaboration-tools/version-details.png">

View File

@@ -0,0 +1,16 @@
<!-- add-breadcrumbs -->
We live in an era when people are very comfortable communicating, discussing,
asking, assigning work and getting feedback electronically. The Internet acts
as a great medium to collaborate on work too. Taking this concept into ERP
system, we have designed a bunch of tools whereby you can Assign transactions,
manage your To Dos, share and maintain a Calendar, maintain a company wise
Knowledge Base, Tag and Comment on transactions and send your Orders, Invoices
etc via Email. You can also send instant messages to other users using the
Messaging tool.
These tools are integrated into all aspects of the product so that you can
effectively manage your data and collaborate with your co-workers.
### Topics
{index}

View File

@@ -0,0 +1,11 @@
to-do
restore-deleted-docs
document-versioning
collaborating-around-forms
chat
notes
calendar
assignment
tags
articles
pos-view

View File

@@ -0,0 +1,18 @@
<!-- add-breadcrumbs -->
You can store your long notes under this section. It can contain your partner lists, frequently used passwords, terms and conditions, or any other document which needs to be shared. Following are the steps to create new Note.
`Explore > Note > New`
####Notes Details
Enter Title and Context.
<img class="screenshot" alt="Note New" src="{{docs_base_url}}/assets/img/collaboration-tools/note-1.png">
####Set Permissions to select Users
To make Note accessible for all, check "Public" under links section. Else you can share it with the specific User by using Share feature.
<img class="screenshot" alt="Note New" src="{{docs_base_url}}/assets/img/collaboration-tools/share-1.gif">
{next}

View File

@@ -0,0 +1,32 @@
<!-- add-breadcrumbs -->
#Restore Deleted Documents
In ERPNext, you can delete a records if not needed. They can be masters like Items, Customer or transactions like Sales Order, Payment Entries etc.
<img class="screenshot" alt="Delete a Docuemnt" src="{{docs_base_url}}/assets/img/collaboration-tools/delete-a-doc.png">
If you have deleted an entry by mistake and wish to restore it back into your ERPNext account.
> Only User having System Manager role assigned can restore deleted documents.
Steps below to restore a deleted document.
####Step 1: Go to Deleted Documents
For the list of deleted document, just type Deleted Document in the Search Bar and go to list.
<img class="screenshot" alt="Deleted Docs List" src="{{docs_base_url}}/assets/img/collaboration-tools/deleted-docs-list.gif">
####Step 2: Open Doc and Restore
Open the document to be restored from the list. Click on Restore button.
<img class="screenshot" alt="Restored Doc" src="{{docs_base_url}}/assets/img/collaboration-tools/restore-a-doc.png">
####Step 3: Restored
Once a document is restored, you will be able to use it for creating entries in your ERPNext account.
<img class="screenshot" alt="Restored Doc" src="{{docs_base_url}}/assets/img/collaboration-tools/restored-doc.png">
> If canceled document is deleted, then it will not be restored.

View File

@@ -0,0 +1,10 @@
<!-- add-breadcrumbs -->
Like Assignments and Comments, you can also add your own tags to each type of transactions. These tags can help you search a document and also classify it.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/tags-1.png">
ERPNext will also show you all the important tags in the document list.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/tags-2.png">
{next}

View File

@@ -0,0 +1,10 @@
<!-- add-breadcrumbs -->
To Do is a simple tool where all the activities [assigned]({{docs_base_url}}/user/manual/en/using-erpnext/assignments.html) to you and assigned by you are listed. You can also add your own to-do items in the list.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-3.png">
When task is completed, you should simply remove assignment from the assigned document. With this, task will be removed from your Todo list as well. For Todo which are not assigned via document, you can set their status as Closed from the Todo master itself.
<img class="screenshot" alt="Assign" src="{{docs_base_url}}/assets/img/collaboration-tools/assign-4.png">
{next}