guides
Project and task statuses
What each project and task status means, which changes the API accepts, and how they map to the statuses of other platforms.
Project statuses
You change a project's status with Change Project Status. A change outside this table is refused with Unsupported transition.
| From | To |
|---|---|
DRAFT | PENDING, CANCELLED, DELETED, CONTINUOUS |
PENDING | DRAFT, APPROVED, CANCELLED, DELETED |
APPROVED | DRAFT, PENDING, DELIVERED, CANCELLED, DELETED |
DELIVERED | DRAFT, INVOICED, PARTIALLY_INVOICED, NOT_INVOICED |
PARTIALLY_INVOICED | INVOICED |
NOT_INVOICED | DELIVERED |
CONTINUOUS | DRAFT, CANCELLED, DELETED |
CANCELLED | DRAFT |
INVOICED, DELETED | none |
Some changes have extra conditions:
- To
APPROVED: the costs must be calculated and without errors (a project in manual cost mode can also be approved before calculating them), no file ingestion or automation may be running, and, when the org unit requires a purchase order, the project'sinvoiceInfomust hold one of at least 6 characters. - To
PENDING: no ingestion, automation or cost calculation may be running. - Back to
DRAFT(fromPENDING,APPROVED,CONTINUOUSorCANCELLED) and toCANCELLEDfrom any status butDRAFT: only users with an admin, project manager or client role. CONTINUOUSback toDRAFT: only while the project has received no import batch.CANCELLEDback toDRAFT: not for a project created by a connector (cancelling removed its connector entries), nor while another live project of the org unit uses itsciTag, nor for a continuous project that has received an import batch.
Reverting a cancelled project
Cancelling closes the project's open tasks: a task with an assignee and confirmed segments is delivered as it stands, every other one is cancelled, and their work units are closed. Reverting the project to DRAFT does not reopen them, and no payable changes. When the project is approved again, tasks are created only for the work units that have none, such as files or steps added while it was back in DRAFT. A file whose tasks were cancelled gets no new task.
Replacing a source file
An approved project that needs a new source file goes back to DRAFT, gets the file through Preview Source Update and Apply Source Update, and is approved again. Translations of unchanged segments are kept, and so are the assignees unless you send keepAssignees: false.
An approved project that needs one more workflow step does not have to leave APPROVED: Add Workflow Steps with allowApproved=true adds steps after the last existing step. The project keeps its status, no status webhook is sent, the first step is not translated again, and the new steps' tasks are created once their work units are ingested. A step that would go between existing steps is refused, and so is a DELIVERED project. The project's costs do not change: when the new step is billed, add the line with Add Costs Manually.
Task statuses
A task is one workflow step of one work unit.
| Status | Meaning |
|---|---|
PENDING | Nobody is assigned. |
PENDING_ACCEPTANCE | Offered to a vendor, who must accept or decline it. |
ASSIGNED | Assigned and open for work. |
PENDING_CONFIRMATION | Delivered with the hours worked, waiting for the project manager to confirm the delivery. |
DELIVERED | Delivered. |
INVOICED, PAID, NOT_INVOICED | Delivered, and settled by invoicing and payables. |
SKIPPED | The step was skipped; it has no assignee. |
CANCELLED | The step was cancelled. |
SCHEDULED, EXPIRED | Older statuses that wxrks no longer sets on its own. Treat them as open. |
DELIVERED, INVOICED, PAID and NOT_INVOICED count as completed: the bulk actions on translations (Clear Translations, Confirm All) skip these steps unless the org unit lets delivered tasks be edited.
Changing a task's status
Task Status moves a task to another status. It is refused for an INVOICED or PAID task and when the task is already in that status. Besides the status, some targets do more:
| Target | What else happens |
|---|---|
ASSIGNED | A delivered work unit is reopened for work. |
PENDING | The work unit goes back in progress. The assignee is kept: use Revoke Task Assignment to remove it. |
DELIVERED | The task is delivered as from the editor, and its payable calculated. From NOT_INVOICED it only goes back to DELIVERED. |
SKIPPED | The step is skipped, and its assignee and rates are removed. |
CANCELLED | The step is cancelled in the editor and its work unit closed. Not for split tasks. |
| Any other | Only the status changes. |
Assignment
- Assign Task to User assigns the task. A vendor who must accept first gets it as
PENDING_ACCEPTANCE, everyone else asASSIGNED. The assignee is emailed when the org unit has vendor email notifications on. - With
includeRelatedTasks=true, Assign Task to User and Bulk Assign Tasks to User also assign the user to the related tasks: the otherPENDINGtasks of the project with the same language pair and workflow and no assignee, as "Assign to Related Tasks" does in the app. If any of them cannot take the user, the call fails and nothing is assigned. - The assignee answers with Accept Task Assignment (
ASSIGNED) or Decline Task Assignment: the assignment is revoked, the task goes back toPENDING, and the project manager is emailed the reason. - Notify Task Assignee emails the assignee again, without changing the assignment. It sends even when the org unit has vendor email notifications off.
- Revoke Task Assignment removes the assignee.
Choosing the email template per send
An account has one template per email type, and can keep named variants of the assignment emails, for example an auditor email.
The assignment email's type depends on the task:
| Type | Sent when |
|---|---|
TASK_PENDING_ACCEPTANCE | The task waits for the vendor to accept it. |
TASK_ASSIGNED_READY | The task has no previous step, or the previous step is closed. |
TASK_ASSIGNED_NOT_READY | The previous step is still in progress. |
TASK_READY | The previous step is delivered. |
TASK_SKIPPED | The previous step is a skipped review. |
- Save a variant with Save Notification Template, giving its
variantname (1 to 64 letters, digits,-or_). Save it for each type it may be sent as: an auditor step usually starts after the previous step is delivered, soTASK_READYat least. List Notification Templates withincludeVariants=trueshows them, and Reset Notification Template withvariantremoves one. - Send it with
template=<name>: - on Assign Task to User: the assignment sends the variant instead of the default email, so the assignee gets one email;
- on Notify Task Assignee, to send the assignment email again.
To send only the emails you choose, turn vendor email notifications off in the org unit: they cover the emails wxrks sends on its own, such as the ready email once the previous step is delivered, while template on an assignment and Notify Task Assignee still send.
A name the account has no variant of for the type the task sends answers 400: the assignment does not happen and nothing is sent. Without template, the account's default template is sent, as before. Bulk Assign Tasks to User and includeRelatedTasks always send the default template.
Coming from Phrase
| Phrase job status | wxrks |
|---|---|
NEW | PENDING |
EMAILED | PENDING_ACCEPTANCE |
ACCEPTED | ASSIGNED, after Accept Task Assignment |
DECLINED | No status of its own: Decline Task Assignment revokes the assignment and the task is PENDING again |
DELIVERED | PENDING_CONFIRMATION while the delivery waits for confirmation, then DELIVERED |
COMPLETED | DELIVERED, INVOICED, PAID or NOT_INVOICED |
CANCELLED | CANCELLED, or SKIPPED for a step that was skipped |