Differences

This shows you the differences between two versions of the page.

--- 74:cms_sharepoint_online [2019/10/14 08:49] – [Sharepoint Online] tssr
+++ 74:cms_sharepoint_online [2020/05/20 07:05] – tssr
@@ Line 1: / Line 1: @@
-[[:74:cms_configuration|Back to Common CMS Configuration]]
+[[:74:cms_configuration|Back to CMS Configuration]]
-# Sharepoint Online
+===== Sharepoint Online =====
-Example Configuration
+=== Example Configuration ===
-``` xml
+<code xml>
+<cms-type name="sharepointonlinegraph">
+    <!-- Global Properties -->
+    <cms-host ident="sharepoint.online.ident" name="https://your-company.sharepoint.com" displayName="SharePoint Online Example">
+        <!-- Host Properties -->
+        <cms-property name="client.id" value="xxxx-xxxx-xxxx-xxxx-xxxx" />
+        <cms-property name="client.secret" value="xxxxxx" />
+        <cms-property name="tenant.id" value="xxxx-xxxx-xxxx-xxxx-xxxx" />
+        <cms-property name="state.attribute.name" value="_Status" />
+        <cms-property name="link.content.type.name" value="Link to a Document" />
+    </cms-host>
+</cms-type>
-< cms-type name="sharepointonlinegraph">
+</code>
-< !-- Global Properties -->
+=== Host Properties ===
-< cms-host ident="sharepoint.online.ident" name="https://your-company.sharepoint.com" displayName="SharePoint Online Example">
+These configuration properties affect the behavior of one SharePoint Online server.
-< !-- Host Properties -->
+*** ** ''Required'' \\
+Properties marked with ** * ** are required for the adapter to work.
-< cms-property name="client.id" value="xxxx-xxxx-xxxx-xxxx-xxxx" />
+**# ** ''Required but can also be set in web-application'' \\
+Properties marked with ** # ** are required but can also be set in the //File Management// section in the Stages web-application as well. The value entered in the web-application overrides the one from the config.xml.
-< cms-property name="client.secret" value="xxxxxx" />
+**+ ** ''Required but with default'' \\
+Properties marked with ** + ** are required, but there is a default value. This values can be overridden by configuring it in the config.xml.
-< cms-property name="tenant.id" value="xxxx-xxxx-xxxx-xxxx-xxxx" />
+> client.id ** * **
-< cms-property name="state.attribute.name" value="_Status" />
+   * Description: The client id of the stages application, which has to be registered at the Microsoft azure portal website.
+  * Links: [[https://portal.azure.com|Microsoft Azure Portal]]
-< /cms-host>
+> client.secret ** * **
-< /cms-type>
+  * Description: The client secret, which can be generated after registering the stages application at the Microsoft azure portal website.
+  * Links: [[https://portal.azure.com|Microsoft Azure Portal]]
-```
+> tenant.id ** * **
-## Host Properties
+  * Description: The tenant id identifies your company when using Microsoft Services. You can get this id at the Microsoft azure portal website.
+  * Links: [[https://portal.azure.com|Microsoft Azure Portal]]
-These configuration properties affect the behavior of one SharePoint Online server. Properties marked with * are required for the adapter to work. Properties marked with + are required, but there is a default value. This values can be overridden by configuring it in the config.xml.
+> loginserver ** + **
-**\* Required** \
+  * Default Value: <nowiki>https://login.microsoftonline.com/</nowiki>
+  * Description: The URL to the login server used for OAuth2 authentication. Stages appends /oauth2/v2.0/authorize , to authorize the access. For receiving tokens, /oauth2/v2.0/token will be appended to the login server address.
+  * Links: [[https://oauth.net/|More about OAuth]]
-**\+ Required with default value**
+> scope ** + **
-`* client.id`
+  * Default Value: offline_access User.Read Sites.ReadWrite.All
+  * Links: [[https://docs.microsoft.com/en-us/graph/permissions-reference|More about Scopes and Permissions]]
-* Description: The client id of the stages application, which has to be registered at Microsoft Azure Portal.
+> state.attribute.name
-`* client.secret`
+  * Description: This property specifies a column name, which will be used by stages to store the file status.
-* Description: The client secret, which can be generated after registering the stages application at Microsoft Azure Portal.
+> document.content.type.name ** + **
-`* tenant.id`
+  * Default Value: Document
+  * Description: Name of the **document**  content type. Sharepoint supports multiple content types but stages only supports the default type for documents.
-* Description: The tenant id identifies your company when using Microsoft Services. You can get this id at Microsoft Azure Portal.
+> link.content.type.name ** + **
-`+ loginserver`
+  * Default Value: Link to a document
+  * Description: The second content type which is supported by stages.
-* Default Value:
+  * Known Issue: Typo in Default Value. Has to be Link to a **D**ocument
-* Description: The URL to the login server used for OAuth2 authentication. Stages appends */oauth2/v2.0/authorize* , to authorize the access. For receiving tokens, */oauth2/v2.0/token* will be appended to the login server address.
+> use.system.account.for.download ** + **
-`+ scope`
+  * Default Value: false
+  * Description: When set to true, files will be downloaded using the system account.
-* Default Value: *offline_access User.Read Sites.ReadWrite.All*
+==== Azure Portal ====
-`state.attribute.name`
+=== Authentication ===
-* Description: This property specifies a column name, which will be used by stages to store the file status.
+Every application registered at the Microsoft azure portal can register **Redirect URIs**  in the //Authentication//  section of the applications registration page shown in the picture below.
-`document.content.type.name`
+[[https://doc.stagesasaservice.com/lib/exe/detail.php?id=74:cms_sharepoint_online&media=cms:azure_portal_redirect_urls.png|{{:cms:azure_portal_redirect_urls.png}}]]
-* Default Value: Dokument
+For the authentication process to work, you have to add the following redirect to the list:<code>
-`link.content.type.name`
+ <protocol>://<stages-hostname>:<port>/stages/app/files/oauth_callback
-* Default Value: Link to a document
+</code>
-`use.system.account.for.download`
+  * Protocol: Microsoft only accepts __https__  expect for testing scenarios on localhost (then __http__  is valid as well)
+  * Stages-hostname: Hostname of the server, users can access the Stages application
+  * Port: Port Stages is running on (80 for http, 443 for https) or any other custom port
-* Default Value: false
+=== API Permissions ===
-* Description: When set to true, files will be downloaded from stages using the system account.
+In addition to the Redirect URIs, the application needs permissions for file handling in behalf of the user. The picture below shows, how this should look like:
-## Azure Redirect URI for Stages
+[[https://doc.stagesasaservice.com/lib/exe/detail.php?id=74:cms_sharepoint_online&media=cms:azure_permissions.png|{{:cms:azure_permissions.png}}]]
-`[stages-server-url]/stages/app/files/oauth_callback`
+=== Repository Configuration ===
+Access to SharePoint Online projects can be configured in Stages processes via “Management > File Management > Repositories”.
+{{ :cms:spo-repository.png? |}}
-## Known Issues
+> Name:
+The name of this SharePoint Online configuration. This name will be used by Stages to refer to this repository configuration (e.g. in repository plan)
-#### Commit comments for file versions
+> Host:
+This selection field contains an entry for each cms-host section in the Stages configuration file (config.xml). You can select the host for this repository configuration.
+> Site:
+Define a site parameter for this repository configuration. The site is the path to the location, where your document libraries are located on the SharePoint server. The site is one piece for the complete connection string to the SharePoint server. The connection string is build like that: // | host.url | : | port | | **/site/** | | documentLibrary | //.
+This overwrites the **path** from the URL entered in the configuration file (config.xml).
+Example:
+  * **config.xml**: //<nowiki><cms-host name="http://mySharePoint.de:123/myPath/to/mySite" /></nowiki>//
+  * Value in **Site**: //myPath/to/another/Repository//
+  * Resulting **URL**: //<nowiki>http://mySharePoint.de:123/myPath/to/another/Repository</nowiki>//
+  * The path from the config.xml gets overwritten by the value from Repository Path.
+> Document Library:
+Defines the name of the document library. The document library is one piece for the complete connection string to the SharePoint server. The connection string is build like that: // | host.url | : | port | | /site/ | | **documentLibrary** | //.
+> Root Folder:
+Defines a root folder **inside** the given document library. Every file linked or uploaded to a repository, which defines a root folder in the configuration, will be **inside** this root folder.
+> Default Lifecycle
+Select a lifecycle from the process metamodel as default for files from this repository.
+==== Known Limitations ====
+== Commit comments for file versions ==
 For each checkin of a file, the user can attach a comment for the version which gets created. The Microsoft Endpoint, which is used to read that information, delivers the same checkin comment for each version. This comment is simply the latest checkin comment. (Opened issue at Github)
-#### Behavior of Lock/Unlock
+== Behavior of Lock/Unlock ==
 Currently, the graph API only supports checkin/checkout and no Undo-Checkout. So for every lock/unlock a new version of that file is created in sharepoint online.
-#### Initial commit
+== Initial commit ==
 Creates two versions (one for the creation of a new file/ second for updating the properties)
+== Set State ==
+After setting the state of a Sharepoint Online document, the assignment to the Stages user gets lost. The modifier will be the Sharepoint Online user instead of the Stages user.
+== Major / Minor Version ==
+The Graph API, wich is used by the SharePoint Online Adapter, does currently not support setting major/minor versions when uploading a file.