{"_id":"5a8b9378e4eb600012e90deb","project":"56539c418b050e2100f006ca","version":{"_id":"56539c428b050e2100f006cd","project":"56539c418b050e2100f006ca","__v":15,"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","5a8b9193e4eb600012e90dea","5b511e0bfe048400034364d8","5c06db5b3712bb000d056e1a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5a8b9193e4eb600012e90dea","project":"56539c418b050e2100f006ca","version":"56539c428b050e2100f006cd","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-02-20T03:10:11.603Z","from_sync":false,"order":2,"slug":"getting-started-guide","title":"Getting Started Guide"},"user":"5a84d1bf6b17d200124fa3ea","githubsync":"","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-20T03:18:16.949Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"In order to use PlanRight, you’ll need to connect to either WorkflowMax or Xero Practice Manager. The steps are the same, whether you are connecting to WorkflowMax or Xero Practice Manager: \n[block:api-header]\n{\n  \"title\": \"How to connect to WorkflowMax/Xero Practice Manager\"\n}\n[/block]\nWhen you first sign up to PlanRight, you will be walked through the process to connect your PlanRight account to your WorkflowMax/Xero Practice Manager account.\n\nYou can also connect using the following steps:\n  1. Click \"Settings” at the top-right\n  2. Click “XPM/WFM”\n  3. Click “Connect”\n\nFollow the instructions on screen, enter your WFM/XPM login details. When PlanRight is successfully connected to WFM/XPM, you will be asked to select the sync option based on\nhow you would like to start using PlanRight.\n\nThe available Sync Options are -\n1. Plan in PlanRight\n2. Plan in WorkflowMax\n\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/da8cb28-Screen_Shot_2019-08-08_at_1.29.16_PM.png\",\n        \"Screen Shot 2019-08-08 at 1.29.16 PM.png\",\n        1448,\n        1662,\n        \"#f0f0f0\"\n      ]\n    }\n  ]\n}\n[/block]\nSelect the sync mode and click on the “Continue” button. \n\nMore information about PlanRight sync settings can be found here http://help.planrightapp.com/docs/xpm-settings\n\n[block:api-header]\n{\n  \"title\": \"Plan in PlanRight\"\n}\n[/block]\nChoose this option if you haven’t done any detailed planning in WorkflowMax and would like to start planning in PlanRight. With this option your clients, jobs, tasks, staff assignments, estimated efforts and timesheets will be imported into PlanRight.\n\n**Planning in PlanRight works as follow**\n\n* Create Clients, Jobs, Tasks and Estimate efforts in WorkflowMax. After the initial sync, all of this information will be available in PlanRight.\n\n* Tasks Start and End Dates. (We recommend you use PlanRight to add dates):\n   - After the initial sync, PlanRight will create a new task assignment for each assigned staff member \n     beginning on the same date as the task created in WorkflowMax.\n   - Task assignments will not appear on schedule until you assign them from the schedule or the \n     Jobs tab.\n   - If a task is not given it’s own start and end dates in WorkflowMax, PlanRight will copy the start \n     date of the task’s respective job.\n   - Dates changed in PlanRight will not sync back to WorkflowMax\n\n\n* Assign tasks to staff members and allocate hours. (We recommend you use PlanRight to assign tasks):\n  - Once a task has been synchronised with PlanRight, any changes made in WorkflowMax will not \n    appear in PlanRight.\n  - During the planning you can assign/reassign tasks and allocate hours to staff members from the \n    Jobs tab, Plan Job or from the schedule.\n  - Staff members can be assigned to the same task multiple times.\n  - Staff members assigned to tasks via PlanRight will sync back to WorkflowMax only if the Task \n    Staff Assignments checkbox is enabled in the Settings > XPM/WFM tab.\n  - Allocated hours will never sync back to WorkflowMax.\n \n\n* Timesheets:\n   - Timesheets will sync back to WorkflowMax only if the Timesheets and checkbox is enabled in the Settings > XPM/WFM tab.\n  \n[block:api-header]\n{\n  \"title\": \"Planning in WorkflowMax\"\n}\n[/block]\nChoose this option if you have been using WorkflowMax to do your detailed planning. With this option you will be able to import all your data from WorkflowMax including your clients, jobs, tasks, staff assignments, estimated efforts, job/task dates, allocated hours and timesheets. Your PlanRight schedule will reflect these values on the schedule.\n\n**Planning in WorkflowMax works as follows:**\n  * All task assignments will appear on the schedule. \n\n  * Changing task dates and staff assignments in WorkflowMax will cause the same changes to appear in PlanRight.\n \n  * Changing task dates for a single staff member will update the dates for all other staff members assigned to that task as well. \n  \n  * Staff members can only be assigned to a task once. In this mode we do not support allocating multiple instances of a task to a staff member.\n  \n  * You can optionally enable or disable the synchronisation of Task Start & End Dates, Task Staff Assignments, Allocated Hours and Timesheets to and from WorkflowMax from the Settings > XPM/WFM tab.\n  \n  * Deallocating all staff from a task will cause the task to appear in the Unassigned row on the schedule.\n\n\n\n **\n Coming soon -**   You will soon be able to switch between the sync modes from the PlanRight settings. \n\n\n\nMore information about PlanRight sync settings can be found here http://help.planrightapp.com/docs/xpm-settings\n\n\n\n[block:api-header]\n{\n  \"title\": \"The First Sync\"\n}\n[/block]\nThe time it takes for the sync to finish depends on the amount of data in your WFM/XPM account - it can be anywhere from 2 minutes to 2 hours (if you have thousands of open jobs). \n\nWhen your sync is complete, you'll see your tasks, jobs, clients & timesheets in PlanRight.\n\nYou can manage your connection to WFM/XPM by accessing the [**XPM Settings**](http://help.planrightapp.com/docs/xpm-settings) in PlanRight.\n[block:api-header]\n{\n  \"title\": \"Sync Modes\"\n}\n[/block]\nPlanRight supports three sync modes:\n\n1. **Automatic** - the daily and quick syncs will run as described below and changes made in PlanRight will sync to WFM/XPM\n2. **Manual** - daily and quick syncs will not run, but changes made in PlanRight will sync to WFM/XPM \n3. **Off** - daily and quick syncs will not run, changes made in PlanRight will not sync to WFM/XPM\n[block:api-header]\n{\n  \"title\": \"Daily Sync\"\n}\n[/block]\nEvery day, at approximately 7am, 11am, 3pm and 7pm (in your timezone), PlanRight will do a complete sync of your data from WFM/XPM to PlanRight.  This includes:\n\n- Updating all staff\n- Updating all open jobs and tasks\n- Updating any jobs that have been closed or cancelled since the last sync\n- Updating all clients\n- Updating any timesheets added in the last 30 days and allocating these to tasks in PlanRight\n[block:api-header]\n{\n  \"title\": \"Quick Sync\"\n}\n[/block]\nEvery 20 minutes, between 7am and 7pm (in your timezone), PlanRight will attempt to perform a quick sync of your data from WFM/XPM.  This includes:\n\n- Update any new staff added since the last full sync\n- Update any new jobs added since the last full sync\n- Update any new clients added since the last full sync\n- Update any timesheets dated within the last day\n[block:api-header]\n{\n  \"title\": \"Changes made in PlanRight\"\n}\n[/block]\nThe following changes, made in PlanRight, will be updated immediately in WorkflowMax:\n\n- When a task is allocated to a staff member, that staff member will be assigned to the task in WFM\n- When a task is marked as completed in PlanRight, the task will updated in WFM if all tasks of that type for that job are marked as completed\n- When time is record in PlanRight, a timesheet will be created in WFM\n- When a note is added in PlanRight, a note will be added to the job in WFM \n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Sync Limitations\",\n  \"body\": \"1. If you edit a timesheet in WFM in order to move it to a different staff person or task, then that change will not be visible in PlanRight. This means that your total **Logged Hours** for the task will be incorrect in PlanRight.\\n\\n2. If you delete a timesheet in WFM it'll still be visible in PlanRight and won't update the **Logged Hours.**\\n\\n3. If you delete a job in WFM, it'll still be visible in PlanRight. We recommend closing jobs that you no longer want.\\n\\nThe above limitations exist because the WFM API doesn't give us information on whether a timesheet or job was deleted or edited.\\n\\n4. Only timesheets from the last 30 days are imported from WFM to PlanRight.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Syncing Jobs for a Client\"\n}\n[/block]\nIf you have added a job in WorkflowMax and don't want to wait for the sync to happen, you can select the client from the Jobs screen and click the \"Update all Jobs\" button, which will update all jobs for just that client immediately.","excerpt":"","slug":"connecting-to-workflowmaxxero-practice-manager","type":"basic","title":"Connecting to WorkflowMax/Xero Practice Manager"}

Connecting to WorkflowMax/Xero Practice Manager


In order to use PlanRight, you’ll need to connect to either WorkflowMax or Xero Practice Manager. The steps are the same, whether you are connecting to WorkflowMax or Xero Practice Manager: [block:api-header] { "title": "How to connect to WorkflowMax/Xero Practice Manager" } [/block] When you first sign up to PlanRight, you will be walked through the process to connect your PlanRight account to your WorkflowMax/Xero Practice Manager account. You can also connect using the following steps: 1. Click "Settings” at the top-right 2. Click “XPM/WFM” 3. Click “Connect” Follow the instructions on screen, enter your WFM/XPM login details. When PlanRight is successfully connected to WFM/XPM, you will be asked to select the sync option based on how you would like to start using PlanRight. The available Sync Options are - 1. Plan in PlanRight 2. Plan in WorkflowMax [block:image] { "images": [ { "image": [ "https://files.readme.io/da8cb28-Screen_Shot_2019-08-08_at_1.29.16_PM.png", "Screen Shot 2019-08-08 at 1.29.16 PM.png", 1448, 1662, "#f0f0f0" ] } ] } [/block] Select the sync mode and click on the “Continue” button. More information about PlanRight sync settings can be found here http://help.planrightapp.com/docs/xpm-settings [block:api-header] { "title": "Plan in PlanRight" } [/block] Choose this option if you haven’t done any detailed planning in WorkflowMax and would like to start planning in PlanRight. With this option your clients, jobs, tasks, staff assignments, estimated efforts and timesheets will be imported into PlanRight. **Planning in PlanRight works as follow** * Create Clients, Jobs, Tasks and Estimate efforts in WorkflowMax. After the initial sync, all of this information will be available in PlanRight. * Tasks Start and End Dates. (We recommend you use PlanRight to add dates): - After the initial sync, PlanRight will create a new task assignment for each assigned staff member beginning on the same date as the task created in WorkflowMax. - Task assignments will not appear on schedule until you assign them from the schedule or the Jobs tab. - If a task is not given it’s own start and end dates in WorkflowMax, PlanRight will copy the start date of the task’s respective job. - Dates changed in PlanRight will not sync back to WorkflowMax * Assign tasks to staff members and allocate hours. (We recommend you use PlanRight to assign tasks): - Once a task has been synchronised with PlanRight, any changes made in WorkflowMax will not appear in PlanRight. - During the planning you can assign/reassign tasks and allocate hours to staff members from the Jobs tab, Plan Job or from the schedule. - Staff members can be assigned to the same task multiple times. - Staff members assigned to tasks via PlanRight will sync back to WorkflowMax only if the Task Staff Assignments checkbox is enabled in the Settings > XPM/WFM tab. - Allocated hours will never sync back to WorkflowMax. * Timesheets: - Timesheets will sync back to WorkflowMax only if the Timesheets and checkbox is enabled in the Settings > XPM/WFM tab. [block:api-header] { "title": "Planning in WorkflowMax" } [/block] Choose this option if you have been using WorkflowMax to do your detailed planning. With this option you will be able to import all your data from WorkflowMax including your clients, jobs, tasks, staff assignments, estimated efforts, job/task dates, allocated hours and timesheets. Your PlanRight schedule will reflect these values on the schedule. **Planning in WorkflowMax works as follows:** * All task assignments will appear on the schedule. * Changing task dates and staff assignments in WorkflowMax will cause the same changes to appear in PlanRight. * Changing task dates for a single staff member will update the dates for all other staff members assigned to that task as well. * Staff members can only be assigned to a task once. In this mode we do not support allocating multiple instances of a task to a staff member. * You can optionally enable or disable the synchronisation of Task Start & End Dates, Task Staff Assignments, Allocated Hours and Timesheets to and from WorkflowMax from the Settings > XPM/WFM tab. * Deallocating all staff from a task will cause the task to appear in the Unassigned row on the schedule. ** Coming soon -** You will soon be able to switch between the sync modes from the PlanRight settings. More information about PlanRight sync settings can be found here http://help.planrightapp.com/docs/xpm-settings [block:api-header] { "title": "The First Sync" } [/block] The time it takes for the sync to finish depends on the amount of data in your WFM/XPM account - it can be anywhere from 2 minutes to 2 hours (if you have thousands of open jobs). When your sync is complete, you'll see your tasks, jobs, clients & timesheets in PlanRight. You can manage your connection to WFM/XPM by accessing the [**XPM Settings**](http://help.planrightapp.com/docs/xpm-settings) in PlanRight. [block:api-header] { "title": "Sync Modes" } [/block] PlanRight supports three sync modes: 1. **Automatic** - the daily and quick syncs will run as described below and changes made in PlanRight will sync to WFM/XPM 2. **Manual** - daily and quick syncs will not run, but changes made in PlanRight will sync to WFM/XPM 3. **Off** - daily and quick syncs will not run, changes made in PlanRight will not sync to WFM/XPM [block:api-header] { "title": "Daily Sync" } [/block] Every day, at approximately 7am, 11am, 3pm and 7pm (in your timezone), PlanRight will do a complete sync of your data from WFM/XPM to PlanRight. This includes: - Updating all staff - Updating all open jobs and tasks - Updating any jobs that have been closed or cancelled since the last sync - Updating all clients - Updating any timesheets added in the last 30 days and allocating these to tasks in PlanRight [block:api-header] { "title": "Quick Sync" } [/block] Every 20 minutes, between 7am and 7pm (in your timezone), PlanRight will attempt to perform a quick sync of your data from WFM/XPM. This includes: - Update any new staff added since the last full sync - Update any new jobs added since the last full sync - Update any new clients added since the last full sync - Update any timesheets dated within the last day [block:api-header] { "title": "Changes made in PlanRight" } [/block] The following changes, made in PlanRight, will be updated immediately in WorkflowMax: - When a task is allocated to a staff member, that staff member will be assigned to the task in WFM - When a task is marked as completed in PlanRight, the task will updated in WFM if all tasks of that type for that job are marked as completed - When time is record in PlanRight, a timesheet will be created in WFM - When a note is added in PlanRight, a note will be added to the job in WFM [block:callout] { "type": "danger", "title": "Sync Limitations", "body": "1. If you edit a timesheet in WFM in order to move it to a different staff person or task, then that change will not be visible in PlanRight. This means that your total **Logged Hours** for the task will be incorrect in PlanRight.\n\n2. If you delete a timesheet in WFM it'll still be visible in PlanRight and won't update the **Logged Hours.**\n\n3. If you delete a job in WFM, it'll still be visible in PlanRight. We recommend closing jobs that you no longer want.\n\nThe above limitations exist because the WFM API doesn't give us information on whether a timesheet or job was deleted or edited.\n\n4. Only timesheets from the last 30 days are imported from WFM to PlanRight." } [/block] [block:api-header] { "title": "Syncing Jobs for a Client" } [/block] If you have added a job in WorkflowMax and don't want to wait for the sync to happen, you can select the client from the Jobs screen and click the "Update all Jobs" button, which will update all jobs for just that client immediately.