SharePoint

Inleiding

De Microsoft connector maakt het mogelijk om vanuit een proces met Microsoft services te integreren. Momenteel beperkt de connector zich tot het uploaden van bestanden naar SharePoint. De connector is beschikbaar vanaf platform versie v28.0.0.

Protocol

Voor de communicatie met Microsoft services gebruikt de connector de Microsoft Graph REST API. Met de nodige credentials kan je via de Graph API een token opvragen waarmee je vervolgens verder met SharePoint kan communiceren.

Om deze connector te kunnen gebruiken moet je eerst de volgende stappen uitvoeren.

Voeg de Microsoft maven dependency toe aan de juiste pom.xml files.

CODE

<dependency>
    <groupId>com.skryv.connectors</groupId>
    <artifactId>microsoft</artifactId>
    <version>${skryv.version}</version>
</dependency>

Stel de volgende applicatie eigenschappen (application properties) in:

Eigenschap	Default	Beschrijving
MicrosoftGraphConfiguration
`skryv.connectors.microsoft.enabled`	-	`True`: de connector is geactiveerd binnen de applicatie. `False` of niet opgegeven: de connector staat niet actief binnen de applicatie.
MicrosoftAppRegistrationProperties
`skryv.connectors.microsoft.client-id`	-	Azure app client ID.
`skryv.connectors.microsoft.tenant-id`	-	Azure tenant ID.
`skryv.connectors.microsoft.client-secret`	-	Azure app client secret.
MicrosoftSharepointProperties
`skryv.connectors.microsoft.sharepoint.drive-id`	-	De unieke identifier van de SharePoint-documentbibliotheek (drive) in Microsoft Graph. Je kan deze opvragen via de Graph API Explorer: GET https://graph.microsoft.com/v1.0/sites/{site-id}/drives.

De MicrosoftAppRegistration properties worden gebruikt als authenticatie voor de Graph API. De MicrosoftSharepoint property bepaalt dan de drive/folder in SharePoint waar de bestanden terecht moeten komen.

Services en functies

De Microsoft connector bestaat voorlopig uit één service met één beschikbare functie.

Upload bijlage naar SharePoint

Service om een door Skryv gegenereerde bijlage te uploaden naar SharePoint.

Workflow expressie

CODE

${microsoft.uploadAttachmentToSharepoint(attachmentId,path,fileName)}

Opmerking

De namen van de procesvariabelen in de workflow-expressie zijn vrij te kiezen. De volgorde van de argumenten is bepalend.

Java business method

CODE

// Bean injecteren:
private final MicrosoftBusinessConnector microsoftBusinessConnector;

// Aanroepen:
microsoftBusinessConnector.uploadAttachmentToSharepoint(attachmentId,path,fileName);

Uitleg

Deze expressie zal de bijlage attachmentId uploaden naar het pad path binnen de ingestelde SharePoint drive ID (zie applicatie eigenschappen). De bijlage wordt geüpload met naam fileName.

Input

Inputparameters	Data type	Verplicht	Voorbeeld	Uitleg
`attachmentId`	String	Ja	00bbf608-9ea6-4fd9-a8dd-392ad069d553	Id van de bijlage in Skryv.
`path`	String	Ja	schadedossiers/2024	Pad naar de bijlage binnen de ingestelde SharePoint drive ID.
`fileName`	String	Ja	bijlage.pdf	Naam van de bijlage zoals die in SharePoint te zien moet zijn.

Output

Geen output.

Foutafhandeling

Als de opgegeven attachmentId niet bestaat in Skryv, zal de connector een fout gooien (IllegalArgumentException). Zorg er voor dat het id correct is en dat de bijlage reeds aangemaakt is voordat deze stap in het proces wordt bereikt.
Als de connector uitgeschakeld is (zie enabled=false of niet ingesteld bij applicatie eigenschappen) en er toch een workflow-expressie naar microsoft.* verwijst, zal het proces een fout gooien op dat punt.