[docs] update

This commit is contained in:
Rushabh Mehta
2017-07-28 12:45:19 +05:30
parent bd2578bc36
commit 67141f545f
564 changed files with 3545 additions and 550 deletions

View File

@@ -5,3 +5,4 @@ purchase-order
setup
articles
purchase-taxes
supplier-scorecard

View File

@@ -0,0 +1,77 @@
<!-- add-breadcrumbs -->
A Supplier Scorecard is an evaluation tool used to assess the performance of
suppliers. Supplier scorecards can be used to keep track of item quality,
delivery and responsiveness of suppliers across long periods of time. This data
is typically used to help in purchasing decisions.
A Supplier Scorecard is manually created for each supplier.
In ERPNext, you can create a supplier scorecard by going to:
> Buying > Documents > Supplier Scorecard > New Supplier Scorecard
### Create Supplier Scorecard
A supplier scorecard is created for each supplier individually. Only one supplier scorecard can be created for each
supplier.
<img class="screenshot" alt="Purchase Order" src="{{docs_base_url}}/assets/img/buying/supplier-scorecard.png">
#### Final Score and Standings
The supplier scorecard consists of a set evaluation periods, during which the performance of a supplier is
evaluated. This period can be daily, monthly or yearly. The current score is calculated from the score of each evaluation
period based on the weighting function. The default formula is linearly weight over the previous 12 scoring periods.
<img class="screenshot" alt="Purchase Order" src="{{docs_base_url}}/assets/img/buying/supplier-scorecard-weighing.png">
This formula is customizable.
The supplier standing is used to quickly sort suppliers based on their performance. These are customizable for each supplier.
The scorecard standing of a supplier can also be used to restrict suppliers from being included in Request for Quotations or
being issued Purchase Orders.
<img class="screenshot" alt="Purchase Order" src="{{docs_base_url}}/assets/img/buying/supplier-scorecard-standing.png">
#### Evaluation Criteria and Variables
A supplier can be evaluated on several individual evaluation criteria, including (but not limited to) quotation response time,
delivered item quality, and delivery timeliness. These criteria are weighed to determine the final period score.
<img class="screenshot" alt="Purchase Order" src="{{docs_base_url}}/assets/img/buying/supplier-scorecard-criteria.png">
The method for calculating each criteria is determined through the criteria formula field, which can use a number of pre-established variables.
The value of each of these variables is calculated over the scoring period for each supplier. Examples of such variables include:
- The total number of items received from the supplier
- The total number of accepted items from the supplier
- The total number of rejected items from the supplier
- The total number of deliveries from the supplier
- The total amount (in dollars) received from a supplier
Additional variables can be added through server-side customizations.
The criteria formula should be customized to evaluate the suppliers in each criteria in a way that best fits the Company requirements.
##### Evaluation Formulas
The evaluation formula uses the pre-established or custom variables to evaluate an aspect of supplier performance over the scoring period. Formulas can use the following mathematical functions:
* addition: +
* subtraction: -
* multiplication: *
* division: /
* min: min(x,y)
* max: max(x,y)
* if/else: (x) if (formula) else (y)
* less than: <
* greated than: >
* variables: {variable_name}
It is crucial that the formula be solvable for all variable values. This is most often an issue if the value resolves to 0. For example:
```
{total_accepted_items} / {total_received_items}
```
This example would resolve to 0 / 0 in periods where there are no received items, and therefore should have a check to protect in this case:
```
({total_accepted_items} / {total_received_items}) if {total_received_items} > 0 else 1.
```
### Evaluating the Supplier
An evaluation is generated for each Supplier Scorecard Period by clicking the "Generate Missing Scorecard Periods" button. The supplier
current score can be seen, as well as a visual graphic showing the performance of the supplier over time. Any actions against the supplier
are also noted here, including warnings when create RFQs and POs or locking out those features for this supplier altogether.
{next}

View File

@@ -1,6 +1,6 @@
<!-- add-breadcrumbs -->
This form allows you to enroll a student to a program. A student can be enrolled to multiple programs.
<img class="screenshot" alt="Student Applicant Enrollment" src="{{url_prefix}}/assets/img/schools/admission/program-enrollment.png">
<img class="screenshot" alt="Student Applicant Enrollment" src="{{docs_base_url}}/assets/img/schools/admission/program-enrollment.png">
{next}

View File

@@ -4,7 +4,7 @@
A Student Applicant record needs to be created when a student applies for a program at your institute.
You can Approve or Reject a student applicant. By accepting a student applicant you can add them to the student master.
<img class="screenshot" alt="Student Applicant" src="{{url_prefix}}/assets/img/schools/admission/student-applicant.png">
<img class="screenshot" alt="Student Applicant" src="{{docs_base_url}}/assets/img/schools/admission/student-applicant.png">
### Application Status
@@ -24,6 +24,6 @@ You can Approve or Reject a student applicant. By accepting a student applicant
Once you approve a Student Applicant you can enroll them to a program. When you click the 'Enroll' buttom,
the system shall create a student against that applicant and redirect you to the [Program Enrollment form]({{docs_base_url}}/user/manual/en/schools/student/program-enrollment.html).
<img class="screenshot" alt="Student Applicant Enrollment" src="{{url_prefix}}/assets/img/schools/admission/student-applicant-enroll.png">
<img class="screenshot" alt="Student Applicant Enrollment" src="{{docs_base_url}}/assets/img/schools/admission/student-applicant-enroll.png">
{next}

View File

@@ -3,6 +3,6 @@
List of all different type of fees collected.
<img class="screenshot" alt="Fees Category" src="{{url_prefix}}/assets/img/schools/fees/fee-category.png">
<img class="screenshot" alt="Fees Category" src="{{docs_base_url}}/assets/img/schools/fees/fee-category.png">
{next}

View File

@@ -3,6 +3,6 @@
A Fee Structure is a template that can be used while making fee records.
<img class="screenshot" alt="Fees Structure" src="{{url_prefix}}/assets/img/schools/fees/fee-structure.png">
<img class="screenshot" alt="Fees Structure" src="{{docs_base_url}}/assets/img/schools/fees/fee-structure.png">
{next}

View File

@@ -4,6 +4,6 @@
Maintain a record of fees collected from students.
The [Fee Structure]({{docs_base_url}}/user/manual/en/schools/fees/fee-structure.html) is fetched based on the selected Program and Academic Term.
<img class="screenshot" alt="Fees" src="{{url_prefix}}/assets/img/schools/fees/fees.png">
<img class="screenshot" alt="Fees" src="{{docs_base_url}}/assets/img/schools/fees/fees.png">
{next}

View File

@@ -3,7 +3,7 @@
This section contains 'Fee' related documents.
<img class="screenshot" alt="Fees Section" src="{{url_prefix}}/assets/img/schools/fees/fees-section.png">
<img class="screenshot" alt="Fees Section" src="{{docs_base_url}}/assets/img/schools/fees/fees-section.png">
### Topics

View File

@@ -2,6 +2,6 @@
The School Modules is designed to meet requirements of Schools, Colleges & Educational Institutes.
<img class="screenshot" alt="Fees Section" src="{{url_prefix}}/assets/img/schools/module.png">
<img class="screenshot" alt="Fees Section" src="{{docs_base_url}}/assets/img/schools/module.png">
{index}

View File

@@ -4,13 +4,13 @@
Course Schedule is the schedule of a session conducted by an Instructor for a particular Course.
You can see the overall course schedule in the Calendar view.
<img class="screenshot" alt="Course Schedule" src="{{url_prefix}}/assets/img/schools/schedule/course-schedule.png">
<img class="screenshot" alt="Course Schedule" src="{{docs_base_url}}/assets/img/schools/schedule/course-schedule.png">
### Marking Attendance
You can mark attendance for a Student Group against a Course Schedule.
<img class="screenshot" alt="Course Schedule Attendance" src="{{url_prefix}}/assets/img/schools/schedule/course-schedule-att.png">
<img class="screenshot" alt="Course Schedule Attendance" src="{{docs_base_url}}/assets/img/schools/schedule/course-schedule-att.png">
- To make attendance, expand the attendance section.
- Check the students who were present for that session.
@@ -21,6 +21,6 @@ You can mark attendance for a Student Group against a Course Schedule.
Once you have marked Attendance against a Course Schedule the Attendance section in the Course Schedule shall be hidden.
A View Attendance button shall appear. Click on that button to view all attendance records created against that Course Schedule.
<img class="screenshot" alt="Course Schedule Attendance" src="{{url_prefix}}/assets/img/schools/schedule/course-schedule-att-1.png">
<img class="screenshot" alt="Course Schedule Attendance" src="{{docs_base_url}}/assets/img/schools/schedule/course-schedule-att-1.png">
{next}

View File

@@ -3,7 +3,7 @@
The Examination record can be used to track the exam schedule and the results of that exam.
<img class="screenshot" alt="Examination" src="{{url_prefix}}/assets/img/schools/schedule/examination.png">
<img class="screenshot" alt="Examination" src="{{docs_base_url}}/assets/img/schools/schedule/examination.png">
{next}

View File

@@ -1,7 +1,7 @@
<!-- add-breadcrumbs -->
# Schedule
<img class="screenshot" alt="Schedule Section" src="{{url_prefix}}/assets/img/schools/schedule/schedule-section.png">
<img class="screenshot" alt="Schedule Section" src="{{docs_base_url}}/assets/img/schools/schedule/schedule-section.png">
### Topics

View File

@@ -3,7 +3,7 @@
This tool can be used to create 'Course Schedules'.
<img class="screenshot" alt="Scheduling Tool" src="{{url_prefix}}/assets/img/schools/schedule/scheduling-tool.png">
<img class="screenshot" alt="Scheduling Tool" src="{{docs_base_url}}/assets/img/schools/schedule/scheduling-tool.png">
### Creating Course Schedules

View File

@@ -3,6 +3,6 @@
Maintains attendance record of the student. Attendance Records can be created against Course Schedules.
<img class="screenshot" alt="Student Attendance" src="{{url_prefix}}/assets/img/schools/schedule/student-attendance.png">
<img class="screenshot" alt="Student Attendance" src="{{docs_base_url}}/assets/img/schools/schedule/student-attendance.png">
{next}

View File

@@ -1,7 +1,7 @@
<!-- add-breadcrumbs -->
# Academic Term
<img class="screenshot" alt="Academic Term" src="{{url_prefix}}/assets/img/schools/setup/academic-term.png">
<img class="screenshot" alt="Academic Term" src="{{docs_base_url}}/assets/img/schools/setup/academic-term.png">
{next}

View File

@@ -1,6 +1,6 @@
<!-- add-breadcrumbs -->
# Academic Year
<img class="screenshot" alt="Academic Year" src="{{url_prefix}}/assets/img/schools/setup/academic-year.png">
<img class="screenshot" alt="Academic Year" src="{{docs_base_url}}/assets/img/schools/setup/academic-year.png">
{next}

View File

@@ -1,6 +1,6 @@
<!-- add-breadcrumbs -->
# Course
<img class="screenshot" alt="Course" src="{{url_prefix}}/assets/img/schools/setup/course.png">
<img class="screenshot" alt="Course" src="{{docs_base_url}}/assets/img/schools/setup/course.png">
{next}

View File

@@ -1,7 +1,7 @@
<!-- add-breadcrumbs -->
# Setup
<img class="screenshot" alt="Setup Section" src="{{url_prefix}}/assets/img/schools/setup/setup-section.png">
<img class="screenshot" alt="Setup Section" src="{{docs_base_url}}/assets/img/schools/setup/setup-section.png">
### Topics

View File

@@ -1,6 +1,6 @@
<!-- add-breadcrumbs -->
# Instructor
<img class="screenshot" alt="Instructor" src="{{url_prefix}}/assets/img/schools/setup/instructor.png">
<img class="screenshot" alt="Instructor" src="{{docs_base_url}}/assets/img/schools/setup/instructor.png">
{next}

View File

@@ -1,6 +1,6 @@
<!-- add-breadcrumbs -->
# Program
<img class="screenshot" alt="Program" src="{{url_prefix}}/assets/img/schools/setup/program.png">
<img class="screenshot" alt="Program" src="{{docs_base_url}}/assets/img/schools/setup/program.png">
{next}

View File

@@ -2,6 +2,6 @@
# Room
<img class="screenshot" alt="Room" src="{{url_prefix}}/assets/img/schools/setup/room.png">
<img class="screenshot" alt="Room" src="{{docs_base_url}}/assets/img/schools/setup/room.png">
{next}

View File

@@ -3,6 +3,6 @@
Student batch is a collection of students from Student Groups.
<img class="screenshot" alt="Student" src="{{url_prefix}}/assets/img/schools/student/student-batch.png">
<img class="screenshot" alt="Student" src="{{docs_base_url}}/assets/img/schools/student/student-batch.png">
{next}

View File

@@ -2,6 +2,6 @@
This tool allows you to create student groups in bulk. You can specify multiple parameters to create them.
<img class="screenshot" alt="Student Group Creation Tool" src="{{url_prefix}}/assets/img/schools/student/student-group-creation-tool.png">
<img class="screenshot" alt="Student Group Creation Tool" src="{{docs_base_url}}/assets/img/schools/student/student-group-creation-tool.png">
{next}

View File

@@ -4,6 +4,6 @@
A student group is a collection of students taking a same course. You can create Course Schedules and Examinations against a Student Group.
A student group needs to be created for every course in a particular academic term and academic year.
<img class="screenshot" alt="Student Group" src="{{url_prefix}}/assets/img/schools/student/student-group.png">
<img class="screenshot" alt="Student Group" src="{{docs_base_url}}/assets/img/schools/student/student-group.png">
{next}

View File

@@ -4,6 +4,6 @@
You can make a note of student activities using student log.
Logs can be categorised as 'General', 'Academic', 'Medical' or 'Achievement'
<img class="screenshot" alt="Student" src="{{url_prefix}}/assets/img/schools/student/student-log.png">
<img class="screenshot" alt="Student" src="{{docs_base_url}}/assets/img/schools/student/student-log.png">
{next}

View File

@@ -6,6 +6,6 @@ The student doctype maintains personal details of the student.
You can view everything related to a particular student on this page. Eg : Fees, Student Group, etc
<img class="screenshot" alt="Student" src="{{url_prefix}}/assets/img/schools/student/student.png">
<img class="screenshot" alt="Student" src="{{docs_base_url}}/assets/img/schools/student/student.png">
{next}

View File

@@ -27,6 +27,12 @@ To setup an incoming Email Account, check on **Enable Incoming** and set your PO
<img class="screenshot" alt="Incoming EMail" src="{{docs_base_url}}/assets/img/setup/email/email-account-incoming.png">
### Setting Import Conditions for Email Import
Email Accounts allows you to set conditions according to the data of the incoming emails. The email will be imported to ERPNext only if the all conditions are true. For example if you want to import an email if the subject is "Some important email", you put doc.subject == "Some important email" in the conditions textbox. You can also set more complex conditions by combining them, as shown on the following screenshot.
<img class="screenshot" alt="Incoming EMail Conditions" src="{{docs_base_url}}/assets/img/setup/email/email-account-incoming-conditions.png">
### How ERPNext handles replies
In ERPNext when you send an email to a contact like a customer, the sender will be the user who sent the email. In the **Reply-To** property, the Email Address will be of the default incoming account (like `replies@yourcompany.com`). ERPNext will automatically extract these emails from the incoming account and tag it to the relevant communication