Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
74:cms_sharepoint_online [2019/10/11 11:05]
tssr
74:cms_sharepoint_online [2019/10/16 11:25] (current)
tssr [Sharepoint Online]
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 ===
- 
 <code xml> <code xml>
 <​cms-type name="​sharepointonlinegraph">​ <​cms-type name="​sharepointonlinegraph">​
Line 19: Line 18:
  
 === Host Properties === === Host Properties ===
 +These configuration properties affect the behavior of one SharePoint Online server.\\
  
-These configuration properties affect ​the behavior of one SharePoint Online server.+** * ** ''​Required''​\\ 
 +Properties marked with ** * ** are required for the adapter to work.
  
-**client.id**+** ** ''​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.
  
-   Default Value: N/A +** + ** ''​Required but with default''​\\ 
-  Description:​ The client id of the stages applicationwhich has to be registered at [[https://​portal.azure.com|Microsoft Azure Portal]].+Properties marked with ** + ** are requiredbut there is a default valueThis values can be overridden by configuring it in the config.xml.
  
-**client.secret**+client.id ** * **
  
-  ​* Default Value: N/A +  * Description:​ The client ​id of the stages application, which has to be registered ​at the Microsoft azure portal website. 
-  ​* Description:​ The client ​secret, which can be generated after registering ​the stages application at [[https://​portal.azure.com|Microsoft Azure Portal]].+  * Links: ​[[https://​portal.azure.com|Microsoft Azure Portal]]
  
-**tenant.id**+> client.secret ** * **
  
-  ​* Default Value: N/A +  * Description:​ The client secret, which can be generated after registering the stages application ​at the Microsoft azure portal website. 
-  ​* Description:​ The tenant id identifies your company when using Microsoft Services. You can get this id at [[https://​portal.azure.com|Microsoft Azure Portal]].+  * Links: ​[[https://​portal.azure.com|Microsoft Azure Portal]]
  
-**state.attribute.name**+> tenant.id ** * **
  
-  * Default ValueN/A +  * DescriptionThe tenant id identifies your company when using Microsoft Services. You can get this id at the Microsoft azure portal website. 
-  * DescriptionThis property specifies a column name, which will be used by stages to store the file status.+  * Links[[https://​portal.azure.com|Microsoft Azure Portal]]
  
-**use.system.account.for.download**+> loginserver ​** + ** 
 + 
 +  * 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]] 
 + 
 +> scope ** + ** 
 + 
 +  * Default Value: offline_access User.Read Sites.ReadWrite.All 
 +  * Links: [[https://​docs.microsoft.com/​en-us/​graph/​permissions-reference|More about Scopes and Permissions]] 
 + 
 +> state.attribute.name 
 + 
 +  * Description:​ This property specifies a column name, which will be used by stages to store the file status.  
 + 
 +> document.content.type.name ** + ** 
 + 
 +  * Default Value: Document 
 +  * Description:​ Name of the **document** content type. Sharepoint supports multiple content types but stages only supports the default type for documents. 
 + 
 +> link.content.type.name ** + ** 
 + 
 +  * Default Value: Link to a document 
 +  * Description:​ The second content type which is supported by stages. 
 + 
 +use.system.account.for.download ​** + **
  
   * Default Value: false   * Default Value: false
-  * Description:​ When set to true, files will be downloaded ​from stages ​using the system account.+  * Description:​ When set to true, files will be downloaded using the system account
 + 
 +==== Azure Portal ==== 
 +=== Authentication === 
 +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.
  
-=== Azure Redirect URI for Stages ===+{{cms:​azure_portal_redirect_urls.png}}
  
-''​[stages-server-url]/​stages/​app/​files/​oauth_callback''​+For the authentication process to work, you have to add the following redirect to the list: 
 +<​code>​ <​protocol>://<​stages-hostname>:<​port>​/​stages/​app/​files/​oauth_callback</​code>​
  
-=== Known Issues ===+  * 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
  
-- __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 Endpointwhich 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 [[https://​github.com/​microsoftgraph/​microsoft-graph-docs/​issues/​5754|Github]])+=== API Permissions === 
 +In addition to the Redirect URIs, the application needs permissions ​for file handling in behalf ​of the user. The picture below showshow this should look like:
  
-- __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.+{{cms:​azure_permissions.png}} 
 +==== Known Issues ====
  
-- __Initial commit__ \\ Creates two versions (one for the creation ​of a new file/ second ​for updating ​the properties)+== 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 ==
 +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 ==
 +Creates two versions (one for the creation of a new file/ second for updating the properties)