windowsMS Excel

This doc is about how to enable MS Excel integration in your self hosted instance.

This guide walks you through app registration in Microsoft Entra (Azure AD) and configuring your on-premise Nected deployment so users can connect Microsoft Excel (OneDrive/SharePoint) as an integration from the Nected UI. The Excel connector is used in Workflows for reading and writing workbooks.

Prerequisites

  • Access to your on-premise Nected deployment (Helm values and cluster)

  • A Microsoft account with permissions to register applications in Microsoft Entraarrow-up-right (Azure AD)

  • Your Nected UI base URL (e.g. https://nected.yourcompany.com)

  • Requires Garuda. Enable the Garuda service before adding MS Excel. See How to enable integrations in the Overview.

App Registration (Microsoft Entra)

Complete the following steps in the Microsoft Entra admin center so Nected can use OAuth to connect to Excel/OneDrive/SharePoint.

Step 1: Open Entra and Create the App

  1. In the left sidebar, expand Entra ID and select App registrations.

  2. Click + New registration.

  3. On the Register an application form, fill in:

    • Name: A user-facing display name (e.g. Nected Excel). This can be changed later.

    • Supported account types: Choose one:

      • Accounts in any organizational directory (Any Microsoft Entra ID tenant – Multitenant) if users from any Azure AD / Microsoft 365 tenant should sign in.

      • Single tenant only (Default Directory) if only your organization’s directory should be allowed. Use Help me choose if unsure.

    • Redirect URI (optional): Under Web, add your Nected OAuth redirect URI: https://<nected-ui-domain>/oauth/redirect (e.g. https://nected.yourcompany.com/oauth/redirect). You can also add this later under Authentication.

  4. Click Register. You’ll land on the app’s Overview page.

Step 2: Add API Permissions

  1. In the left menu, go to ManageAPI permissions.

  2. Click + Add a permission.

  3. In Request API permissions, leave Microsoft APIs selected. Under Commonly used Microsoft APIs, select Microsoft Graph (it includes access to Excel, OneDrive, SharePoint, and related services).

  4. When asked “What type of permissions does your application require?”, choose Delegated permissions (your app will access the API as the signed-in user, which is required for Excel/OneDrive in Nected).

  5. Search for and add the following delegated permissions.

    Microsoft Graph (add these first via Add a permissionMicrosoft APIsMicrosoft GraphDelegated):

    • Files.Read — Read user files

    • Files.ReadWrite — Have full access to user files

    • offline_access — Maintain access to data you have given it access to

    • openid — Sign users in

    • profile — View users’ basic profile

    • User.Read — Sign in and read user profile

    SharePoint (add via Add a permissionAPIs my organization uses or search for SharePointDelegated):

    • MyFiles.Read — Read user files

    • MyFiles.Write — Read and write user files

    Your Configured permissions should show both Microsoft Graph (6) and SharePoint (2). Optionally check Grant admin consent for Default Directory if your organization requires it.

  6. Click Add permissions after each API. Your list should look like the following (Microsoft Graph only) or include SharePoint as above.

Step 3: Create a Client Secret

  1. In the left menu, go to ManageCertificates & secrets.

  2. Open the Client secrets tab and click + New client secret.

  3. Enter a Description (e.g. Nected Excel) and choose an Expires value (e.g. 365 days (12 months)), then click Add.

  4. In the Client secrets table, copy the Value of the new secret using Copy to clipboard. Store it securely; the value is shown only once.

You will use this value as the Microsoft Excel client secret in nected-values.yaml.

Step 4: Confirm Redirect URI (If Not Set in Step 1)

If you didn’t set the redirect URI during registration:

  1. Go to ManageAuthentication (Preview).

  2. Under Platform configurationsWeb, add a Redirect URI: https://<nected-ui-domain>/oauth/redirect.

  3. Replace <nected-ui-domain> with your actual Nected UI host (no trailing slash) and save.

Step 5: Update Logo (Optional)

For a consistent experience in the Nected Integrations UI, you can upload a logo under ManageBranding & properties. This step is optional.

Step 6: Note Application (Client) ID, Tenant ID, and Endpoints

  1. Go to Overview. In the Essentials section, copy:

    • Application (client) ID

    • Directory (tenant) ID

    Use organizations in your Nected config for multitenant; for single tenant, use this Directory (tenant) ID.

  2. For authUrl and tokenUrl in nected-values.yaml, use the OAuth 2.0 endpoints from Endpoints (or build them from your tenant ID):

    • OAuth 2.0 authorization endpoint (v2): https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize

    • OAuth 2.0 token endpoint (v2): https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token Replace <tenant-id> with your Directory (tenant) ID or use organizations for multitenant.

circle-info

You will use the Client ID, client secret (from Step 3), tenant ID, and these URLs in the next section.

Update `nected-values.yaml` — CREDENTIAL_CONFIG_MAP

In nected-values.yaml, CREDENTIAL_CONFIG_MAP and SYNC_PLUGINS are set under the nalanda section, under the envVars section. They are not present in the file by default—copy the default values from the Overview and append your integration entries. Both must be single-line (no newlines); do not remove existing values.

  1. Open your nected-values.yaml file.

  2. Under the nalanda section, under envVars, locate or add CREDENTIAL_CONFIG_MAP.

  3. CREDENTIAL_CONFIG_MAP must be a single-line JSON string (no newlines or pretty-printing). Add the msexcel entry to the existing JSON object; do not remove other integrations.

MS Excel supports two config types. Choose one:

Organizations (multiple organizations / multi-tenant):

Tenant (single tenant; explicit auth and token URLs):

  • Replace <<YOUR-CLIENT-ID>> with the Application (client) ID from Step 6.

  • Replace <<YOUR-CLIENT-SECRET>> with the client secret value from Step 3.

  • If you need custom scopes or a redirectUri, add them to the same msexcel object.

  • For a single tenant, replace organizations in authUrl and tokenUrl with your Directory (tenant) ID (from Step 6 / Endpoints).

Update nected-values.yaml — SYNC_PLUGINS

  1. In the same nected-values.yaml, under the nalanda section, under envVars, locate or add SYNC_PLUGINS.

  2. SYNC_PLUGINS is a single-line comma-separated list. Append msexcel to the existing list; do not remove existing plugins. For example:

Use your current plugin list and add msexcel at the end (or after the last plugin you use).

Apply Changes and Run Plugin Migrations

Helm upgrade

Restart Nalanda (if needed)

If the Nalanda deployment does not pick up the new plugin:

Run plugin migrations

To ensure the MS Excel integration is registered and appears under the Integrations tab:

  1. Get the Nalanda pod name:

  2. Run plugin migrations from inside the pod:

Replace <<nalanda-pod-name>> with the actual pod name.

After this, refresh the Nected UI and open Integrations. You should see the option to connect to Microsoft Excel (Sign in with Microsoft). Users can then use the Excel connector in Workflows as described in the Microsoft Excel integration guide.

Summary Checklist

  1. Open entra.microsoft.comarrow-up-rightEntra IDApp registrationsNew registration.

  2. Fill in Name, Supported account types, and Redirect URI (Web: https://<nected-ui-domain>/oauth/redirect).

  3. Add API permissions: Microsoft Graph (Delegated) — Files.Read, Files.ReadWrite, offline_access, openid, profile, User.Read; SharePoint (Delegated) — MyFiles.Read, MyFiles.Write. If needed, add custom scopes as described in the CREDENTIAL_CONFIG_MAP section above.

  4. Create a client secret under Certificates & secrets and copy the Value.

  5. Copy Application (client) ID and Directory (tenant) ID from Overview (and OAuth endpoints from Endpoints if needed).

  6. (Optional) Update logo under Branding & properties.

  7. Under nalandaenvVars in nected-values.yaml: add msexcel to CREDENTIAL_CONFIG_MAP (Organizations or Tenant config) and msexcel to SYNC_PLUGINS.

  8. Run Helm upgrade, restart the deployment if needed, then run plugin sync (./nalanda sync plugin).

Troubleshooting

  • Excel not in Integrations list: Ensure msexcel is in SYNC_PLUGINS and run ./nalanda sync plugin inside the Nalanda pod.

  • OAuth or redirect errors: Confirm the redirect URI in Entra exactly matches the value in CREDENTIAL_CONFIG_MAP (including https and no trailing slash).

  • Consent or permission errors: Verify delegated permissions in Entra (Microsoft Graph and, if used, SharePoint) and grant admin consent if required. If issues persist, try the alternative scopes (including email and https://<tenant>-my.sharepoint.com/AllSites.Read).

  • Using Excel in Nected: The Excel integration is available only in Workflows, not in Rules. See Microsoft Excel for workflow usage.

Last updated