Stages Documentation

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
74:cms_sharepoint_online [2019/10/16 11:25] – [Sharepoint Online] tssr74:cms_sharepoint_online [2019/10/30 08:53] – tssr
Line 4: Line 4:
  
 === Example Configuration === === Example Configuration ===
 +
 <code xml> <code xml>
 <cms-type name="sharepointonlinegraph"> <cms-type name="sharepointonlinegraph">
Line 13: Line 14:
         <cms-property name="tenant.id" value="xxxx-xxxx-xxxx-xxxx-xxxx" />         <cms-property name="tenant.id" value="xxxx-xxxx-xxxx-xxxx-xxxx" />
         <cms-property name="state.attribute.name" value="_Status" />         <cms-property name="state.attribute.name" value="_Status" />
 +        <cms-property name="link.content.type.name" value="Link to a Document" />
     </cms-host>     </cms-host>
 </cms-type> </cms-type>
Line 18: Line 20:
  
 === Host Properties === === Host Properties ===
-These configuration properties affect the behavior of one SharePoint Online server.\\ 
  
-** * ** ''Required''\\+These configuration properties affect the behavior of one SharePoint Online server. 
 + 
 +*** ** ''Required'' \\
 Properties marked with ** * ** are required for the adapter to work. Properties marked with ** * ** are required for the adapter to work.
  
-** # ** ''Required but can also be set in web-application''\\+**# ** ''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. 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.
  
-** + ** ''Required but with default''\\+**+ ** ''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. Properties marked with ** + ** are required, but there is a default value. This values can be overridden by configuring it in the config.xml.
  
 > client.id ** * ** > client.id ** * **
  
-  * Description: The client id of the stages application, which has to be registered at the Microsoft azure portal website.+   * 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]]   * Links: [[https://portal.azure.com|Microsoft Azure Portal]]
  
Line 48: Line 51:
   * Default Value: <nowiki>https://login.microsoftonline.com/</nowiki>   * 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.   * 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]]+  * Links: [[https://oauth.net/|More about OAuth]]
  
 > scope ** + ** > scope ** + **
Line 57: Line 60:
 > state.attribute.name > state.attribute.name
  
-  * Description: This property specifies a column name, which will be used by stages to store the file status. +  * Description: This property specifies a column name, which will be used by stages to store the file status.
  
 > document.content.type.name ** + ** > document.content.type.name ** + **
  
   * Default Value: Document   * 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: Name of the **document**  content type. Sharepoint supports multiple content types but stages only supports the default type for documents.
  
 > link.content.type.name ** + ** > link.content.type.name ** + **
Line 68: Line 71:
   * Default Value: Link to a document   * Default Value: Link to a document
   * Description: The second content type which is supported by stages.   * Description: The second content type which is supported by stages.
 +
 +  * Known Issue: Typo in Default Value. Has to be Link to a **D**ocument
  
 > use.system.account.for.download ** + ** > use.system.account.for.download ** + **
Line 75: Line 80:
  
 ==== Azure Portal ==== ==== Azure Portal ====
 +
 === Authentication === === 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. 
  
-{{cms:azure_portal_redirect_urls.png}}+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. 
 + 
 +{{:cms:azure_portal_redirect_urls.png}}
  
 For the authentication process to work, you have to add the following redirect to the list: 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> 
  
-  * Protocol: Microsoft only accepts __https__ expect for testing scenarios on localhost (then __http__ is valid as well)+<code> 
 + <protocol>://<stages-hostname>:<port>/stages/app/files/oauth_callback 
 +</code> 
 + 
 +  * 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   * 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   * Port: Port Stages is running on (80 for http, 443 for https) or any other custom port
  
 === API Permissions === === API Permissions ===
 +
 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: 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:
  
-{{cms:azure_permissions.png}}+{{:cms:azure_permissions.png}} 
 ==== Known Issues ==== ==== Known Issues ====
  
 == Commit comments for file versions == == 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) 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. 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) Creates two versions (one for the creation of a new file/ second for updating the properties)
 +
 +