SharePoint Online DMS extension

SharePoint Online DMS Extension

Product line

Standard

|

Expert

Operating mode

CLOUD ABO

|

ON-PREMISES

Modules

Services & CRM

Budget & Phases

Purchases

Resource Planning

Business Intelligence

Created: 17.01.2019
Machine translated
Updated: 03.11.2024 | Article rewritten and renewed.

The SharePoint Online DMS extension allows integration with SharePoint Online.

  • Vertec-generated Legacy Office Reports and Office Reports can save their output directly to SharePoint. The result is shown in Microsoft 365 Online and can be processed directly.
  • Documents and emails can be saved to SharePoint using the Vertec Explorer Add-In via Vertec, taking into account the document paths in Vertec, as explained below.
  • Documents can be opened and edited from within Vertec in Microsoft 365 Online.
  • You can also write metadata. For more information, see Writing Writing sharepoint metadata in SharePoint.

The following operations are not possible:

  • Save Office-generated legacy reports to SharePoint
  • Using report templates from SharePoint

For the operation of the extension, a SharePoint Online is required. There must be at least one main user / administrator with login.

The following steps are required to start up the extension:

Installing the extension in Vertec

To install the interface, open the SharePoint Online DMS Extension in the Settings > Extensions folder and click Installieren.

The extension creates the following CRM/activities system settings:

DMS SharePoint Application ID

Application ID of the Vertec application in Microsoft 365, see Register vertec application in microsoft 365 .

PropertyName: DmsSharePointApplicationId. Stringproperty .

DMS SharePoint Application Secret

Registration key of the Vertec application in Microsoft 365, see Register Vertec application in Microsoft 365.

PropertyName: DmsSharePointApplicationSecret. Stringproperty .

DMS SharePoint Library URL

Path to the SharePoint document library where Vertec documents should be stored. See Mapping in the vertec document paths .

The value entered here is entered in the Vertec document paths with SharePoint:\ represented.

PropertyName: DmsSharePointLibraryUrl. Stringproperty .

Use DMS SharePoint OAuth individual login

Activates individual authentication, see Define and accept user rights

Starting with version 6.5.0.1. If you had already installed the SharePoint Online DMS extension before this version, it must be uninstalled and reinstalled for this system setting to be visible.

PropertyName: DmsSharePointUseIndividualLogin. Booleanproperty . Default: No.

If changes are made to the SharePoint system settings, the interface must be reloaded: Under Settings > Interfaces > Extensions, open the SharePoint Online DMS Extension and click on the button Reload.

Register Vertec application in Microsoft 365

In order for the Vertec application to access SharePoint, it must be registered in Microsoft 365:

  • Open https://portal.azure.com/ and click on Microsoft Entra ID verwalten
  • Click on App-Registrierungen on the left
  • Click on + Neue Registrierung
  • Enter a name, e.g. Vertec
  • Click on the button Registrieren
  • After that, Home > Customer AG | App registration > Vertec should be open, with Vertec = name of app just created
  • Enter the Application ID (Client) (not the Object ID) in the Vertec system settings under Dms sharepoint application id .

Create a key

  1. Links to Zertifikate und Geheimnisse click
  2. Under Secret Client Keys, click Neuer geheimer Clientschlüssel
  3. In the Description field, enter a name for the key, e.g. VertecSharePointKey
  4. Select the key validity period (maximum 24 months) and remember the corresponding expiration date to create a new key before it expires.
  5. Click on Hinzufügen
  6. The key in the column Wert appears, must be entered in the Vertec system settings under Dms sharepoint application secret . The key can no longer be retrieved later.

Define and accept user rights

Mode “As Vertec app”

This mode is used when the system setting     deaktiviert is (default).

In this case, Vertec stores the documents for all users under the same user account, with the name configured in the app registration as “Vertec app”. Permissions cannot be used to distinguish who has uploaded the document.

  • This configuration requires administrator privileges. This step must be successful, otherwise the connection will not work later.
  • Click on API-Berechtigungen > Berechtigung hinzufügen
  • In the list, select Microsoft Graph
  • Add the following user rights, select Anwendung as type:
    API/Permission Name description
    Files.ReadWrite.All
    Read and write files in all site collections
    Sites.FullControl.All
    Have full control of all site collections
    Sites.Manage.All
    Create, edit, and delete items and lists in all site collections
    Sites.ReadWrite.All
    Read and write items in all site collections
“Individual registration” mode

This mode is used when the system setting Use dms sharepoint oauth individual login     aktiviert is.

In this case, Vertec also logs in to SharePoint as “Vertec app,” but the files are stored with the individual user’s SharePoint account.

  • This configuration requires administrator privileges. This step must be successful, otherwise the connection will not work later.
  • Click on API-Berechtigungen > Berechtigung hinzufügen
  • In the list, select Microsoft Graph
  • Add the following rights as a type Delegiert select:

    API/Permission Name

    description
    Sites.FullControl.All
    Has full access to all site collections
    Sites.Manage.All
    Create, edit, and delete items and lists in all site collections
    Sites.ReadWrite.All
    Edit or delete items in all site collections
    User.Read
    Log in and read user profile

In addition, a redirection URI must be set up for this mode:

  1. Links to Authentifizierung click
  2. + Plattform hinzufügen click and select Web
  3. Enter the URL where the Vertec instance can be reached as the redirect URI, followed by callback. Example: https://mycompany.vertec-cloud.com/callback.
  4. Click on Konfigurieren.

For this to work, each user must first log in to SharePoint via the Vertec cloud app or the Vertec web app. The credentials are then sent back to Vertec. After that, all Vertec apps are ready to work.

After registering in Microsoft 365, the interface must be reloaded in Vertec: Under Settings > Interfaces > Extensions open the SharePoint Online DMS Extension and click on the button Reload.

Structure of the SharePoint document repository

In order for the documents that are stored in SharePoint from Vertec to arrive at the right location, the page structure of SharePoint must be known and mapped accordingly in the Vertec document paths.

In SharePoint, there are sites (websites), within sites there are libraries (document libraries), and within libraries there are folders (folders). Documents from Vertec are always stored in a library (document library) or one of its subfolders.

The structure of the structure depends on the file storage requirements and the access permissions. Permissions can be assigned at the site and library levels. Permissions cannot be assigned at the folder or subfolder levels.

The following scenarios arise:

  Site Library folder User rights
1 One site A library Folder structure from Vertec, e.g. by customer, by project, etc. Permissions equal for all users
2 One site Several libraries, e.g. by project type, by industry etc. Suitable folder structure, e.g. according to projects, customers etc. User rights can be assigned per library
3 Multiple sites, e.g. by project type One or more libraries each Suitable folder structure Permissions can be assigned per site and per library

Note: In Vertec versions prior to 6.4.0.21, the maximum quantity of libraries is 200.

Mapping in the Vertec document paths

For the connection to Sharepoint, the DMS SharePoint Library URL is specified in the CRM/Activities system settings. Here the SharePoint base path is entered. This is selected so that it represents the highest common level in SharePoint, depending on the Structure of the sharepoint document repository (it may also be that no “Library” is entered there, but e.g. a site).

In the Vertec document paths, this DMS SharePoint Library URL with the prefix SharePoint:\ Otherwise, the paths are constructed in the same way as described in the article Document management with vertec .

For the above scenarios, this means:

  DMS SharePoint Library URL System settings Document path Class Settings
1 Path to the library, e.g. https://mycompany.sharepoint.com/sites/Vertec/Freigegebene Dokumente SharePoint:\ Suitable for the selected folder structure, e.g. Projekte\%code% in the Class Settings project.
2 Path to the site, e.g. https://mycompany.sharepoint.com/sites/Vertec SharePoint:\

In the class settings of the class according to which the libraries are divided, e.g. %bezeichnung% in the Class Settings Project type.

The folder structure in it must refer to it, e.g. %typ.dokpfad%\%code% on project etc.

3 SharePoint base path, e.g. https://mycompany.sharepoint.com/sites Standard path, e.g.
SharePoint:\Projekttyp1\Freigegebene Dokumente
Used for all objects that have not defined a different path.

For all classes whose documents are to be stored in a directory other than the default path, the Class Settings will return to SharePoint:\ and the residue is adapted accordingly, e.g. SharePoint:\%bezeichnung%\Freigegebene Dokumente on project type.

The directory or folder structure in it must refer to it, see above.

The folders or subfolders are automatically created by Vertec if they are part of the document path and do not already exist. Sites and libraries must be created in SharePoint beforehand.

The system is designed in such a way that the SharePoint: Prefix can also be used only for individual Classes . So it is also possible to save only certain documents in SharePoint without changing the general document path to SharePoint.