Rule Repositories

SharePoint Integration

Business teams can maintain Excel rule files directly in SharePoint while deployed OpenRules services securely load the latest authorized version.

Why SharePoint

Use the document platform your teams already share.

SharePoint gives distributed teams secure document access, Microsoft Office collaboration, and version control that preserves earlier revisions. These capabilities make it a practical home for enterprise OpenRules repositories.

OpenRules supports SharePoint repositories beginning with Release 10.5.0. Your IT department must first register an application and configure the runtime credentials used to access Microsoft Graph.

Microsoft SharePoint repositoryOpen full size ↗

1. Application registration

Register OpenRules in Microsoft Entra.

Register an application such as openrules-builder in the Microsoft Entra admin center. Add Microsoft Graph API application permissions for the target SharePoint site.

The source example grants Sites.Read.All. Organizations can instead configure the more restricted Sites.Selected permission.

Microsoft Entra application registration for openrules-builder — Register the OpenRules builder applicationOpen full size ↗

Microsoft Entra registered application overview — Registered application overviewOpen full size ↗

Adding Microsoft Graph API permissions — Add API permissionsOpen full size ↗

Selecting Microsoft Graph application permissions — Select application permissionsOpen full size ↗

Microsoft Graph Sites.Read.All permission — Grant a SharePoint sites permissionOpen full size ↗

2. Client credentials

Create the secret used by the runtime.

Open the application’s Client credentials section, add a certificate or secret, create a new client secret, and securely retain its value for the runtime configuration.

Client credentials section in Microsoft Entra — Open client credentialsOpen full size ↗

New client secret action in Microsoft Entra — Create a new client secretOpen full size ↗

Add a client secret form — Add the client secretOpen full size ↗

Generated client secret value in Microsoft Entra — Copy and protect the secret valueOpen full size ↗

3. Runtime configuration

Supply the tenant, client, and secret.

The builder first looks for Java system properties sp.tenantId, sp.clientId, and sp.secret. It then checks SP_TENANT_ID, SP_CLIENT_ID, and SP_SECRET. If neither is present, it reads ~/.sp/credentials.

TENANT_ID=your-tenant-id
CLIENT_ID=your-client-id
SECRET=your-client-secret

4. Repository links

Copy the SharePoint document path.

Select a document in its SharePoint library, open the details panel, find the Path property, and copy the link. Use that URL for the model or test file in your OpenRules project.

SharePoint document details showing the Path property — Copy the SharePoint document pathOpen full size ↗

5. OpenRules project

Point project.properties to SharePoint.

Replace the local model.file and optional test.file values with your SharePoint document URLs. The installed VacationDaysSharePoint sample provides a working project structure that you can adapt.

model.file=https://openrules.sharepoint.com/sites/openrules.samples/Shared%20Documents/VacationDays/rules/DecisionModel.xlsx
test.file=https://openrules.sharepoint.com/sites/openrules.samples/Shared%20Documents/VacationDays/rules/Test.xlsx

Deployment options