Skip to main content

Use OnePlan

OnePlan Integration settings

This article explains the Integration settings in the Admin pages of OnePlan.

Go to the Admin pages, select Integration in the navigation. These settings are available when the Advanced Settings are enabled.

Authentication Keys

Any authentication keys that have been added, such as for reporting or integration will show on this page. You can't see the actual keys themselves, just the name.

Click Delete Screenshot_2022-01-28_135729.png to remove a key if needed.

Integration_AuthenticationKeyList.png

To create a new authentication key:

  1. Click Add KeyScreenshot_2021-12-06_134934.png. The Add Key form will open.

  2. Enter a name for the new key. Then click ADD to create.

    Integration_AddKey.png
  3. The new authentication key will be visible in the Authentication Keys list. Copy and save the key in a secure location. The key will become encrypted when you reload the Admin pages.

    Integration_AuthenticationKey_NewKey.png
Events

Any events that have been added will show. If an integration has already been built/configured, you may add an additional event.

Integration_Events.png

To create a new event:

  1. Click Add EventScreenshot_2021-12-06_134934.png. The Add Event form will open.

  2. Complete the Add Event form. Click ADD to create the new event.

    • Target: The target is where the event going to be installed at. Options include WorkPlan, Process Flow, Resources, and Status Reports.

    • Type: Type is when the event will run. Options include Before Save and After Save.

    • Triggers: Triggers determine when the event will kick it off. Options include Add, Update, Delete, Submit, and Approve/Reject

    • Url: URL is the URL the event will to go to when it runs. Enter the URL.

    • Strategy: If the event is for an integration and runs a OneConnect strategy or another item name, enter the strategy name.

    • IntegrationId: If the event is for an integration using OneConnect, enter the ID of the integration.

    Integration_AddEvent.png
Integrations

All integrations set up in your environment are listed in the Integrations section.

Click Delete Screenshot_2022-01-28_135729.png to remove an integration if needed.

Integration_IntegrationsList.png

To add a new integration into your environment, click Add Integration Screenshot_2021-12-06_134934.png. You will be redirected to our integration platform, OneConnect.

Reporting

Add the url to your odata feed to enable powerful reporting in OnePlan.

Integration_Reporting.png