How to configure Nedap ONS

Quick reference:
Settings -> Integrations -> Nedap ONS connections

Table of Contents

 

About the Nedap ONS live tile

We have an integration with Nedap ONS. The Nedap ONS live tile is divided into two categories.

  • Clients: An overview of the clients in your Nedap ONS company. Use the search bar to search for more clients and choose ‘Load more’ to load more clients into the live tile overview.
  • My planning: A representation of appointments with clients. You can navigate through dates, using the arrows pointing left and right. You can hover your mouse over an appointment to view more information. Some appointments are presented in a different color, depending on the state (type of event/urgency). Click on an appointment from the live tile and you’ll be redirected to the Nedap ONS website.

Nedap_ONS_Week_View.gif

 

Configuration

Step 1. Request a certificate

To make use of the Nedap ONS integration, you must first request a certificate. Nedap ONS certificates are valid for 1 year. Please put a reminder in your calendar to request a new certificate 1 month before the expiration date of the certificate. It is your responsibility to make sure this happens on time. Workspace does not send reminders.
In order for Nedap ONS to work, make sure the UPN in Workspace matches exactly with the corresponding email address in Nedap ONS.


To request a certificate, submit a Change request (CR-04 - Nedap ONS Certificate request) and fill in the corresponding fields for:

  • Customer name
  • Customer code (from Nedap ONS, example MF**** or TE****)
  • Type (Production or Testing)
  • Nedap ONS web URL


Nedap ONS has two different environments:

Environment Use  URL
STAGING Test your connector on a customer’s test environment https://api-staging.ons.io
PRODUCTION Run your connector on a customer’s production environment https://api.ons.io

 

New feature, but missing data?

When you are in production, it could happen that the overview doesn't load or data is missing. It could be the case that these features are only accessible in the staging environment. This concerns the staging/production environment from Nedap ONS and not Workspace.

  • When new features become available, a certificate has to be requested for the staging environment first.
  • New features need to be approved, before we can move it into production.

Would you like to help us to make this data available a.s.a.p. in production environment? Request a staging certificate and provide us with the relevant information. In collaboration with Nedap ONS, we will discuss if we can integrate these features in the live tile.

 

Step 2. Create a Nedap ONS connection

When setting up the Nedap ONS connection, a client certificate configuration is used.

To set up the connection, go to:

  1. Workspace settings page.
  2. Select Integrations.
  3. Select Nedap ONS connections.
  4. Click New.
  5. Fill in the information from top to bottom.
    • Note: filling in the information from top to bottom is required due to security reasons. You cannot upload the certificate first, before filling in the name and API URL. If you do, the fields will be cleared after clicking on 'Add'.

      NedapONSSettingsScreen.png

  6. Click Add when the correct information has been filled in. Then click 'Save'.
If you get an error about an invalid connection when trying to add the connection, you may have entered an incorrect URL. If you are self-hosted, you will see the following error in the logs:
Message:Test connection to Nedap ONS failed
NDAW.WebApp.Common.Workspace.LiveInformation.NedapOns.NedapOnsService+<CanConnectAsync>d__9.MoveNext(:0) (null)
NDAW.NedapOns.Exceptions.NedapOnsException: Request failed. Status code: Unauthorized

 

Step 3. Add the Nedap ONS live tile to Workspace

After setting up the connection to Nedap ONS, you're ready to add the Nedap ONS live tile to you Workspace.

  1. Add the app from the App store (make sure 'Manage apps' is selected).
  2. Edit (right-click) the tile and use the arrows pointing up- or downwards to change position of the tabs ('clients' vs. 'planning') to determine what you see first from the live tile overview.
  3. Tip: Add the Nedap ONS tile twice to your Workspace, one for clients and the other one for the planning overview.

    mceclip4.png

Back to top

 

Deep links

In addition to the Nedap ONS Micro App, you can also configure shortcuts with deep links to specific sections of Nedap ONS. These deep links can be configured as shortcuts in the Workspace and provide a seamless user experience via Single Sign-On (SSO).

Based on customer feedback we provide the below three examples, but there are also other Nedap ONS components which could be made accessible via deep links and work in the same way.

A deep link contains two sections and both sections are customer domain specific:

  1. Customer environment URL
  2. Generic URL to Nedap ONS component

 

Validated example URLs

Please replace "klantomgeving" with your specific Nedap ONS customer domain.


Overdrachtsrapportages

https://klantomgeving.startmetons.nl/?jump=https://klantomgeving.ioservice.net/report/transferreport

 

Overdrachtsagenda

https://klantomgeving.startmetons.nl/?jump=https://klantomgeving.onsagenda.nl/transfer/

 

Kwaliteitsmonitor

https://klantomgeving.startmetons.nl/?jump=https://klantomgeving.ons-taken.nl/overview

 

Using SSO login

If you are using an external identity provider like Okta or HelloID, please use the format of the URL below. Replace "klantomgeving" with your specific Nedap ONS customer domain.

https://klantomgeving.startmetons.nl/auth/oidc/9e4ad0d3-6941-56ad-85f5-81184c5894f3?jump=https://klantomgeving.ioservice.net/report/transferreport

The first section refers to the link behind the blue SSO button in the ONS login window shown below:

nedap_ons.jpg

https://klantomgeving.startmetons.nl/auth/oidc/a77852f1-065f-5466-8e2a-ad3361106c32

The second section contains the generic URL to the desired Nedap ONS component.

Back to top