OnePlan

Set Up the OnePlan Connector in Power Automate/Flow

Updated

This article explains how to set up Power Automate (formerly called Flow) to be used with OnePlan.  Follow the instructions to download the JSON file, and then upload into your account.  

This article doesn't include instructions how to create flows in Power Automate.  Refer to the documentation from Microsoft, etc. for how to create flows.  This article instructions how to upload OnePlan so it's available to be used in your flows.

Download JSON File

  1. Open the attached JSON file in your web browser by clicking the link below.
  2. Copy all of the content, and paste into a text editor.
  3. Save as a .json file locally to your machine.
    NOTE: You can name the file anything you like. The connector will work as long as it is saved as a .json file.

Upload JSON File to Power Automate

1. Log in to Power Automate on Office365.

Microsoft Office Home - Google Chrome

2. Select Data > Custom Connectors.

Microsoft Power Automate | Microsoft Power Platform - Google Chrome

3. Open the New custom connector menu.  Select Import an OpenAPI file. The Create a custom connector form will open.

4. Complete the Create a custom connector form:

  • Connector Name: Enter OnePlan
  • Import and OpenAPI file: Click Import. Go to where you saved the JSON file on your computer.

 

Manage your custom connectors | Power Automate - Google Chrome
Manage your custom connectors | Power Automate - Google Chrome

5.  Click Continue.

Manage your custom connectors | Power Automate - Google Chrome

Set Up the Connector In Power Automate

After the JSON file is imported into Power Automate, you must finish setting up the OnePlan connector. Once you click Continue in Create a custom connector, you will be taken to the connector settings.

1. In the General tab, do not input or update any content. Click Security.

2. In the Security tab, do not input or update any content. Click Definition.

NOTE: Editing the fields in Security will break your connector. Do not edit.

3. In the Definition tab, do not input or update any content. Click Code (Preview).

4. In the Code (Preview) tab, do not input or update any content. Click Test.

5. In the Test tab, click Create connector. Once the connector is created, the Test Operation and Operations panels will open. Leave this window open for the next steps.

Connect OnePlan to Power Automate

For this procedure, have OnePlan Admin pages and Power Automate open in separate tabs in your browser.  

1. Get an authentication key from the OnePlan Admin pages.

  1. Go to Integration.
  2. Click the Add Key icon to create a new authentication key. The Add Key form will open.
  3. Enter a name for the key and click ADD.
  4. Copy the new key and save it for later use.
    NOTE: The authentication key will be hidden once you navigate away from the page. Once hidden, you cannot retrieve the key again.
  5. Copy the App Name for the new key and save it for later use.

6. In Power Automate, click New Connection. You will be prompted for a username and password.

1. Enter the username and password.  

  • Username: The App Name you saved from OnePlan.
  • Password: The authentication key you saved from OnePlan.

2. Click Create connection.

7. Click the Refresh icon in the Connections panel. The Selected connection field should populate.

Test the Connection

For this procedure, have OnePlan and Power Automate open in separate tabs in your browser.
NOTE: Keep the OnePlan plan open for later procedures.

1. In OnePlan, go to a project or plan of your choice.

2. Copy the plan i.d.

1. Click on the user profile. Click Share With.

2. Locate the plan i.d. in the Shareable Url. The i.d. is at the end of the url following PlanId=. Copy the i.d.

3. Paste the plan i.d. into the i.d. field in Power Automate.

4. In this tutorial, we will use the GetPlan operation to test our connection. Select GetPlan from the Operations list.

5. Click Test operation. The test is successful if you receive a response and a Status (200).

Create a Flow in Power Automate

1. In Power Automate, go to My Flows.

2. Select New Flow > Instant cloud flow. The Build an instant cloud flow window will open. Click Skip.

3. In the next window, select Triggers and search for "OnePlan" in the search bar. Select When a Plan Gets Updated from the search results.

4. Click New Step. The Add a step form will open.

5. Search for "Get Plan" in the search bar. Select Get Plan from the results.

6. Click into the i.d. field. A pop up will open. The select Id from the pop up.

7. Enter a name for the new flow in the field in the top left of the window. Copy the flow name.

8. Click Save.

9. Go to OnePlan. Go to the Admin pages > Integration. There should now be a new item in Events.

NOTE: If there is not a new item in Events, try refreshing the page.

10. Click the Edit icon next to the new event item. The Edit Event form will open.

11. Update the Edit Event form.

1. In the Strategy field, paste the flow name from step 7.

2. Select the Update from the Triggers drop down.

12. Click SAVE.

Test the Flow

1. Go to Power Automate to confirm that the flow is on. The Turn Off option will be available when the flow is on.  

2. Test the flow.

1. Select Edit > Test Flow. The Test Flow pop up will open.

2. Select Manually to manually test the flow.

3. Click Test.

3. Go to OnePlan. Go to the plan you selected in Test the Connection. Make a change to any field in the plan.

4. Confirm that the event functions.

1. Go to OnePlan Admin > Integration > Events. Click the View Log icon next to the appropriate event. There should be a new Success entry in the log.  

2. Go to your flow in Power Automate. There should be a message stating "Your flow ran successfully."

Available Uses

There are two triggers and five actions available with the OnePlan connector:

  1. Trigger: Step Change.  Fires when a process step is changed inside OnePlan.
  2. Trigger: Plan Update.  Fires when a plan is created or updated.
  3. Action: Step Update.  Used to move between steps of a process.
  4. Action: Approve.  Used to approve/reject a step in a process.
  5. Action: Update Plan.  Used to update plan level information.
  6. Action: Get Plan.  Used to get plan level information.
  7. Action: Get Fields.
Previous Article How do I manage system notifications?
Next Article What are the Tools options?