{"_id":"5660b29e166da20d00d8c646","project":"56539c418b050e2100f006ca","category":{"_id":"56539c428b050e2100f006ce","__v":11,"pages":["56539c438b050e2100f006d0","5660b1b7166da20d00d8c643","5660b21eeef2ce1700a6c935","5660b257e163310d006b1989","5660b29e166da20d00d8c646","5660b2d3f5a87e0d00db313b","5660b33beef2ce1700a6c93a","5660b3a2f5a87e0d00db313e","5660b494eef2ce1700a6c93d","5660b5cff5a87e0d00db3145","5660b638f5a87e0d00db3149"],"project":"56539c418b050e2100f006ca","version":"56539c428b050e2100f006cd","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-23T23:07:46.897Z","from_sync":false,"order":0,"slug":"documentation","title":"Getting Started"},"parentDoc":null,"version":{"_id":"56539c428b050e2100f006cd","project":"56539c418b050e2100f006ca","__v":12,"createdAt":"2015-11-23T23:07:46.327Z","releaseDate":"2015-11-23T23:07:46.327Z","categories":["56539c428b050e2100f006ce","5789af34f55bf80e00d0c34f","5789af4e6a16260e006e7cd4","5789af53d7bf751900e3cbe1","5789af576a16260e006e7cd5","5789af5fc1c3de0e00169dc7","5789af64c1c3de0e00169dc8","5789b0067a572c0e00120269","579919b1b8d3432000fdffc3","590ba9d1030acd0f00f07046","5939cecbc78839000f4bff0e","59c4454a414f98001001f2a9"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":1,"user":"561b05bcc89cc30d00821542","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-03T21:22:38.831Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"User Roles\"\n}\n[/block]\nThere are three user roles in PlanRight. This is set in the Users tab on the Settings page.\n- **Standard**: Standard users have access to the dashboard and can view their capacity and tasks. When in Job Assign Mode they can allocate work to themselves and view the tasks of others who are also assigned to the Job. They can also log time against a task and view their timesheets.\n- **Standard (View All)**: Standard (View All) users have the same access as Standard users, but with the ability to choose to view (but not edit) all other staff members work load, not just those who are assigned to the same job as them.\n- **Manager**: Manager users have access to the dashboard and can view the capacity and tasks assigned to everyone in the organisation. They can view & allocate work to staff. They can also log time against a task and view timesheets.\n- **Admin**: Admin users have access to the entire PlanRight app. They can view & allocate work to staff, access organisation settings and log time against tasks.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sync Modes\"\n}\n[/block]\nThere are four sync modes. This is set in the XPM/WFM tab on the **Settings** page.\n- **Off**: No data is sync'ed from WFM/XPM to PlanRight.\n- **Manual**: Data is synced from WFM/XPM to PlanRight only when you click the sync buttons.\n- **Inbound only**: Data is imported from WFM/XPM to PlanRight, but no data is sent from PlanRight back to WFM/XPM.\n- **Full sync**: Data is synced automatically every four hours.\n\nIn Manual and Full sync modes, any changes you make in PlanRight are instantly synced back to WorkflowMax/Xero Practice Manager.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Task Types\"\n}\n[/block]\nThere are five possible values for **Task Type** and each affects how the task is treated by PlanRight.\n- **Fixed**: Tasks that have to be done at a particular time (such as GST returns). Fixed work is included in capacity calculations.\n- **Internal**: Tasks that have no fixed time but are regular (such as meetings). Internal tasks are included in capacity calculations.\n- **Not Set**: This will hide the task from being displayed or included in any calculations. The task will still be displayed in the **Jobs** page and time entered will still display on the **Timesheets** page. \n- **Variable**: Tasks which can be completed at anytime (such as client meetings). Variable work is included in capacity calculations.\n- ** Ongoing**: Tasks that have no fixed time but are worked on regularly (such as support). Ongoing work is included in capacity calculations.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Task Statuses\"\n}\n[/block]\nPlanright has a list of 10 statuses that a task can go through.\n\n- **Planned**\n- **Called In**\n- **Ready to Start**\n- **In Progress**\n- **Queries with Client**\n- **Ready for Review**\n- **Sent to Partner**\n- **Sent to Client**\n- **Waiting on other Docs**\n- **Completed**\n\nTask statuses (except for Completed) aren't synced with WFM/XPM but are an easy way to help you keep track of your tasks within PlanRight. You can use them to manage your workflow in any way that suits you.\n\nIf you mark a task as Completed, however, this does get synced and marks the task as Completed in WFM/XPM as well.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Task Colours\"\n}\n[/block]\nTasks will be displayed with the following colours:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ad9d0f8-Screen_Shot_2016-07-28_at_4.25.29_PM.png\",\n        \"Screen Shot 2016-07-28 at 4.25.29 PM.png\",\n        372,\n        64,\n        \"#e6e9e6\"\n      ],\n      \"caption\": \"Planned: Dark Blue\",\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/18530c0-Screen_Shot_2016-07-29_at_11.41.24_AM.png\",\n        \"Screen Shot 2016-07-29 at 11.41.24 AM.png\",\n        370,\n        65,\n        \"#e6e8e6\"\n      ],\n      \"caption\": \"Planned (Priority): Light Blue\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3167d2d-Screen_Shot_2016-07-29_at_11.46.35_AM.png\",\n        \"Screen Shot 2016-07-29 at 11.46.35 AM.png\",\n        371,\n        65,\n        \"#36597e\"\n      ],\n      \"caption\": \"In progress: Faded Blue\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f04979a-Screen_Shot_2016-07-29_at_11.55.57_AM.png\",\n        \"Screen Shot 2016-07-29 at 11.55.57 AM.png\",\n        371,\n        65,\n        \"#e4e6e3\"\n      ],\n      \"caption\": \"Overdue (due date is before today): Red\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e9fffa0-Screen_Shot_2016-07-29_at_12.04.12_PM.png\",\n        \"Screen Shot 2016-07-29 at 12.04.12 PM.png\",\n        371,\n        65,\n        \"#e3e7e6\"\n      ],\n      \"caption\": \"Sent to Partner/Sent to Client/Waiting on Docs: Green\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a090f69-Screen_Shot_2016-07-29_at_12.05.55_PM.png\",\n        \"Screen Shot 2016-07-29 at 12.05.55 PM.png\",\n        374,\n        67,\n        \"#345f90\"\n      ],\n      \"caption\": \"Completed: Light Grey\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Task Date Types\"\n}\n[/block]\n- **Start Date**: The set start date of a job or task in Workflow Max/Xero Practice Manager. It is used when [rolling over jobs](http://help.planrightapp.com/docs/rolling-over-jobs) in PlanRight.\n- **Planned Date**: The date that a task is due to start on in PlanRight. You can set a different planned date for each staff working on a single task. This date is not synced back to WFM/XPM. The planned date can also be set using Task Defaults.\n- **Due Date**: The date that a job or task is due to be completed by in WFM/XPM & PlanRight. This date is synced to PlanRight if the task in WFM/XPM is set as a scheduled task. The due date can also be set using **Task Defaults**.\n[block:api-header]\n{\n  \"title\": \"Task Hours\"\n}\n[/block]\n**In Weekly Planning Mode**\n\n- **Estimated Hours/Budgeted Hours**: This is the estimated amount of time a task takes to be completed. A task's estimated hours are synced in from WFM and are displayed in the 'Update task' modal. In 'Assign mode' on the dashboard, it is displayed as 'Hours budgeted' against each task. \n- **Allocated Hours**: This is the time allocated to each staff member for a task. Allocated hours are not synced to WFM. Allocated hours are displayed on the dashboard and in 'Assign mode.' \n- **Logged Hours**: This is the time logged against a task. Staff can log hours within PlanRight or WFM. Logged time is displayed in the Timesheets tab and is synced both to & from WFM. Logged hours are displayed on the dashboard (when hovering over a task), in the 'Update task' modal, and in 'Assign mode.'\n- **Remaining Hours**: This is the estimated time against a task minus any logged time. Remaining hours are displayed on the dashboard (when hovering over a task) and in the 'Update task' modal. \n\n**In Monthly Planning Mode**\n\n- **Estimated Hours**: A task's estimated hours are synced in from WFM and are displayed on the dashboard for each task and in the 'Update task' modal. It is also displayed as 'Days Planned' above the capacity bar on the dashboard. In the 'Planner' it shows as the total number hours of 'Fixed' & 'Variable' work for each month and in the column of unscheduled work. In the 'Jobs' tab it is displayed as 'Effort' for each task.\n- **Logged Hours**: It's displayed as 'Days Completed' above the capacity bar on the dashboard and in the 'Update Task' modal. The 'Timesheets' tab is also accessible in Monthly Planning Mode, so the logged hours are displayed there as well.\n- **Remaining Hours**: Remaining hours are only displayed in the 'Update Task' modal in Monthly Mode.\n\nAll hours are used when calculating staff capacity in both Weekly & Monthly planning modes.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Estimated Hours Remaining\",\n  \"body\": \"In the **Update Task** modal, you can manually enter estimated hours remaining on a task. This is not synced to WFM or used in capacity calculations.\"\n}\n[/block]","excerpt":"","slug":"task-types","type":"basic","title":"Understanding PlanRight Terms"}

Understanding PlanRight Terms


[block:api-header] { "type": "basic", "title": "User Roles" } [/block] There are three user roles in PlanRight. This is set in the Users tab on the Settings page. - **Standard**: Standard users have access to the dashboard and can view their capacity and tasks. When in Job Assign Mode they can allocate work to themselves and view the tasks of others who are also assigned to the Job. They can also log time against a task and view their timesheets. - **Standard (View All)**: Standard (View All) users have the same access as Standard users, but with the ability to choose to view (but not edit) all other staff members work load, not just those who are assigned to the same job as them. - **Manager**: Manager users have access to the dashboard and can view the capacity and tasks assigned to everyone in the organisation. They can view & allocate work to staff. They can also log time against a task and view timesheets. - **Admin**: Admin users have access to the entire PlanRight app. They can view & allocate work to staff, access organisation settings and log time against tasks. [block:api-header] { "type": "basic", "title": "Sync Modes" } [/block] There are four sync modes. This is set in the XPM/WFM tab on the **Settings** page. - **Off**: No data is sync'ed from WFM/XPM to PlanRight. - **Manual**: Data is synced from WFM/XPM to PlanRight only when you click the sync buttons. - **Inbound only**: Data is imported from WFM/XPM to PlanRight, but no data is sent from PlanRight back to WFM/XPM. - **Full sync**: Data is synced automatically every four hours. In Manual and Full sync modes, any changes you make in PlanRight are instantly synced back to WorkflowMax/Xero Practice Manager. [block:api-header] { "type": "basic", "title": "Task Types" } [/block] There are five possible values for **Task Type** and each affects how the task is treated by PlanRight. - **Fixed**: Tasks that have to be done at a particular time (such as GST returns). Fixed work is included in capacity calculations. - **Internal**: Tasks that have no fixed time but are regular (such as meetings). Internal tasks are included in capacity calculations. - **Not Set**: This will hide the task from being displayed or included in any calculations. The task will still be displayed in the **Jobs** page and time entered will still display on the **Timesheets** page. - **Variable**: Tasks which can be completed at anytime (such as client meetings). Variable work is included in capacity calculations. - ** Ongoing**: Tasks that have no fixed time but are worked on regularly (such as support). Ongoing work is included in capacity calculations. [block:api-header] { "type": "basic", "title": "Task Statuses" } [/block] Planright has a list of 10 statuses that a task can go through. - **Planned** - **Called In** - **Ready to Start** - **In Progress** - **Queries with Client** - **Ready for Review** - **Sent to Partner** - **Sent to Client** - **Waiting on other Docs** - **Completed** Task statuses (except for Completed) aren't synced with WFM/XPM but are an easy way to help you keep track of your tasks within PlanRight. You can use them to manage your workflow in any way that suits you. If you mark a task as Completed, however, this does get synced and marks the task as Completed in WFM/XPM as well. [block:api-header] { "type": "basic", "title": "Task Colours" } [/block] Tasks will be displayed with the following colours: [block:image] { "images": [ { "image": [ "https://files.readme.io/ad9d0f8-Screen_Shot_2016-07-28_at_4.25.29_PM.png", "Screen Shot 2016-07-28 at 4.25.29 PM.png", 372, 64, "#e6e9e6" ], "caption": "Planned: Dark Blue", "sizing": "smart" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/18530c0-Screen_Shot_2016-07-29_at_11.41.24_AM.png", "Screen Shot 2016-07-29 at 11.41.24 AM.png", 370, 65, "#e6e8e6" ], "caption": "Planned (Priority): Light Blue" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/3167d2d-Screen_Shot_2016-07-29_at_11.46.35_AM.png", "Screen Shot 2016-07-29 at 11.46.35 AM.png", 371, 65, "#36597e" ], "caption": "In progress: Faded Blue" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/f04979a-Screen_Shot_2016-07-29_at_11.55.57_AM.png", "Screen Shot 2016-07-29 at 11.55.57 AM.png", 371, 65, "#e4e6e3" ], "caption": "Overdue (due date is before today): Red" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/e9fffa0-Screen_Shot_2016-07-29_at_12.04.12_PM.png", "Screen Shot 2016-07-29 at 12.04.12 PM.png", 371, 65, "#e3e7e6" ], "caption": "Sent to Partner/Sent to Client/Waiting on Docs: Green" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/a090f69-Screen_Shot_2016-07-29_at_12.05.55_PM.png", "Screen Shot 2016-07-29 at 12.05.55 PM.png", 374, 67, "#345f90" ], "caption": "Completed: Light Grey" } ] } [/block] [block:api-header] { "type": "basic", "title": "Task Date Types" } [/block] - **Start Date**: The set start date of a job or task in Workflow Max/Xero Practice Manager. It is used when [rolling over jobs](http://help.planrightapp.com/docs/rolling-over-jobs) in PlanRight. - **Planned Date**: The date that a task is due to start on in PlanRight. You can set a different planned date for each staff working on a single task. This date is not synced back to WFM/XPM. The planned date can also be set using Task Defaults. - **Due Date**: The date that a job or task is due to be completed by in WFM/XPM & PlanRight. This date is synced to PlanRight if the task in WFM/XPM is set as a scheduled task. The due date can also be set using **Task Defaults**. [block:api-header] { "title": "Task Hours" } [/block] **In Weekly Planning Mode** - **Estimated Hours/Budgeted Hours**: This is the estimated amount of time a task takes to be completed. A task's estimated hours are synced in from WFM and are displayed in the 'Update task' modal. In 'Assign mode' on the dashboard, it is displayed as 'Hours budgeted' against each task. - **Allocated Hours**: This is the time allocated to each staff member for a task. Allocated hours are not synced to WFM. Allocated hours are displayed on the dashboard and in 'Assign mode.' - **Logged Hours**: This is the time logged against a task. Staff can log hours within PlanRight or WFM. Logged time is displayed in the Timesheets tab and is synced both to & from WFM. Logged hours are displayed on the dashboard (when hovering over a task), in the 'Update task' modal, and in 'Assign mode.' - **Remaining Hours**: This is the estimated time against a task minus any logged time. Remaining hours are displayed on the dashboard (when hovering over a task) and in the 'Update task' modal. **In Monthly Planning Mode** - **Estimated Hours**: A task's estimated hours are synced in from WFM and are displayed on the dashboard for each task and in the 'Update task' modal. It is also displayed as 'Days Planned' above the capacity bar on the dashboard. In the 'Planner' it shows as the total number hours of 'Fixed' & 'Variable' work for each month and in the column of unscheduled work. In the 'Jobs' tab it is displayed as 'Effort' for each task. - **Logged Hours**: It's displayed as 'Days Completed' above the capacity bar on the dashboard and in the 'Update Task' modal. The 'Timesheets' tab is also accessible in Monthly Planning Mode, so the logged hours are displayed there as well. - **Remaining Hours**: Remaining hours are only displayed in the 'Update Task' modal in Monthly Mode. All hours are used when calculating staff capacity in both Weekly & Monthly planning modes. [block:callout] { "type": "info", "title": "Estimated Hours Remaining", "body": "In the **Update Task** modal, you can manually enter estimated hours remaining on a task. This is not synced to WFM or used in capacity calculations." } [/block]