brotherton-erpnext/erpnext/docs/current/models/projects/task.html

777 lines
18 KiB
HTML

<!-- title: Task -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/projects/doctype/task"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p><b>Table Name:</b> <code>tabTask</code></p>
<h3>Fields</h3>
<table class="table table-bordered">
<thead>
<tr>
<th style="width: 5%">Sr</th>
<th style="width: 25%">Fieldname</th>
<th style="width: 20%">Type</th>
<th style="width: 25%">Label</th>
<th style="width: 25%">Options</th>
</tr>
</thead>
<tbody>
<tr >
<td>1</td>
<td class="danger" title="Mandatory"><code>subject</code></td>
<td >
Data</td>
<td >
Subject
</td>
<td></td>
</tr>
<tr >
<td>2</td>
<td ><code>project</code></td>
<td >
Link</td>
<td >
Project
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/project">Project</a>
</td>
</tr>
<tr >
<td>3</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td ><code>status</code></td>
<td >
Select</td>
<td >
Status
</td>
<td>
<pre>Open
Working
Pending Review
Overdue
Closed
Cancelled</pre>
</td>
</tr>
<tr >
<td>5</td>
<td ><code>priority</code></td>
<td >
Select</td>
<td >
Priority
</td>
<td>
<pre>Low
Medium
High
Urgent</pre>
</td>
</tr>
<tr class="info">
<td>6</td>
<td ><code>section_break_10</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>exp_start_date</code></td>
<td >
Date</td>
<td >
Expected Start Date
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td ><code>expected_time</code></td>
<td >
Float</td>
<td >
Expected Time (in hours)
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td ><code>column_break_11</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>exp_end_date</code></td>
<td >
Date</td>
<td >
Expected End Date
</td>
<td></td>
</tr>
<tr class="info">
<td>11</td>
<td ><code>section_break0</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>Simple</pre>
</td>
</tr>
<tr >
<td>12</td>
<td ><code>description</code></td>
<td >
Text Editor</td>
<td >
Details
</td>
<td></td>
</tr>
<tr class="info">
<td>13</td>
<td ><code>section_break</code></td>
<td >
Section Break</td>
<td >
Depends On
</td>
<td></td>
</tr>
<tr >
<td>14</td>
<td ><code>depends_on</code></td>
<td >
Table</td>
<td >
depends_on
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/task_depends_on">Task Depends On</a>
</td>
</tr>
<tr class="info">
<td>15</td>
<td ><code>actual</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>16</td>
<td ><code>act_start_date</code></td>
<td >
Date</td>
<td >
Actual Start Date (via Time Logs)
</td>
<td></td>
</tr>
<tr >
<td>17</td>
<td ><code>actual_time</code></td>
<td >
Float</td>
<td >
Actual Time (in hours)
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>column_break_15</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>19</td>
<td ><code>act_end_date</code></td>
<td >
Date</td>
<td >
Actual End Date (via Time Logs)
</td>
<td></td>
</tr>
<tr class="info">
<td>20</td>
<td ><code>section_break_17</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>total_costing_amount</code></td>
<td >
Currency</td>
<td >
Total Costing Amount (via Time Logs)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>22</td>
<td ><code>total_expense_claim</code></td>
<td >
Currency</td>
<td >
Total Expense Claim (via Expense Claim)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>23</td>
<td ><code>column_break_20</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>24</td>
<td ><code>total_billing_amount</code></td>
<td >
Currency</td>
<td >
Total Billing Amount (via Time Logs)
</td>
<td></td>
</tr>
<tr class="info">
<td>25</td>
<td ><code>more_details</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>26</td>
<td ><code>review_date</code></td>
<td >
Date</td>
<td >
Review Date
</td>
<td></td>
</tr>
<tr >
<td>27</td>
<td ><code>closing_date</code></td>
<td >
Date</td>
<td >
Closing Date
</td>
<td></td>
</tr>
<tr >
<td>28</td>
<td ><code>column_break_22</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>29</td>
<td ><code>company</code></td>
<td >
Link</td>
<td >
Company
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/company">Company</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.projects.doctype.task.task</h4>
<h3 style="font-weight: normal;">Class <b>CircularReferenceError</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
</div>
<hr>
<h3 style="font-weight: normal;">Class <b>Task</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="check_recursion" href="#check_recursion" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_recursion</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_customer_details" href="#get_customer_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_customer_details</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_feed" href="#get_feed" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_feed</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_project_details" href="#get_project_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_project_details</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="on_update" href="#on_update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_update</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="reschedule_dependent_tasks" href="#reschedule_dependent_tasks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>reschedule_dependent_tasks</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_project" href="#update_project" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_project</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_time_and_costing" href="#update_time_and_costing" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_time_and_costing</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_total_expense_claim" href="#update_total_expense_claim" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_total_expense_claim</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate" href="#validate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_dates" href="#validate_dates" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_dates</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_status" href="#validate_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_status</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
</div>
<hr>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.projects.doctype.task.task.get_events</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.projects.doctype.task.task.get_events" href="#erpnext.projects.doctype.task.task.get_events" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.projects.doctype.task.task.<b>get_events</b>
<i class="text-muted">(start, end, filters=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns events for Gantt / Calendar view rendering.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>start</code></strong> - Start date-time.</li>
<li><strong><code>end</code></strong> - End date-time.</li>
<li><strong><code>filters</code></strong> - Filters (JSON).</li>
</ul>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.projects.doctype.task.task.get_project" href="#erpnext.projects.doctype.task.task.get_project" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.projects.doctype.task.task.<b>get_project</b>
<i class="text-muted">(doctype, txt, searchfield, start, page_len, filters)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.projects.doctype.task.task.set_multiple_status</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.projects.doctype.task.task.set_multiple_status" href="#erpnext.projects.doctype.task.task.set_multiple_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.projects.doctype.task.task.<b>set_multiple_status</b>
<i class="text-muted">(names, status)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.projects.doctype.task.task.set_tasks_as_overdue" href="#erpnext.projects.doctype.task.task.set_tasks_as_overdue" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.projects.doctype.task.task.<b>set_tasks_as_overdue</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<h4>Linked In:</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/projects/dependent_task">Dependent Task</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/hr/expense_claim">Expense Claim</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/projects/project_task">Project Task</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/projects/task_depends_on">Task Depends On</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/projects/time_log">Time Log</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->