Stages Documentation

Differences

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

Link to this comparison view

Next revision		Previous revision
711:cms_sharepoint_online [2024/08/29 14:19] – created - external edit 127.0.0.1711:cms_sharepoint_online [2025/12/15 15:25] (current) – Policnik, Florian
Line 38: Line 38:
   * Links: [[https://portal.azure.com|Microsoft Azure Portal]]   * Links: [[https://portal.azure.com|Microsoft Azure Portal]]
  
-> client.secret ** * **+> client.secret ** * ** //(required if no keystore file is provided)//
  
   * Description: The client secret, which can be generated after registering the stages application at the Microsoft azure portal website.   * 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]]   * Links: [[https://portal.azure.com|Microsoft Azure Portal]]
 +
 +> client.certificate.keystore.file //(since Stages 7.11.10.0, required if no client secret is provided)//
 +
 +  * Description: Path to the keystore file with private key and certificate to authenticate with Azure. Path can be absolute or relative to Stages installation directory.
 +
 +> client.certificate.keystore.password //(since Stages 7.11.10.0, required if no client secret is provided)//
 +
 +  * Description: Password for the specified keystore file.
 +
 +> client.certificate.key.alias //(since Stages 7.11.10.0, required if no client secret is provided)//
 +
 +  * Description: Alias of the private key / certificate entry in keystore file.
 +
 +> client.certificate.key.password //(since Stages 7.11.10.0, required if no client secret is provided)//
 +
 +  * Description: Password of the private key / certificate entry in keystore file.
  
 > tenant.id ** * ** > tenant.id ** * **
Line 56: Line 72:
 > 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. 
 +  * You can choose any column. 
 +  * There is an integrated standard column with name "Status". Typically you have to add it via library settings. The identifier for this column is "''_Status''": 
 + 
 +<code xml> 
 +<cms-property name="state.attribute.name" value="_Status" /> 
 +</code>
  
 > document.content.type.name > document.content.type.name
Line 88: Line 110:
   * Default Value: false   * Default Value: false
   * Description: When set to true, Stages uses application permission Sites.Selected for system user and Sites.Selected delegated permission for Stages user. Please refer chapter "Application and delegated permission Sites.Selected" for detailed explanation.   * Description: When set to true, Stages uses application permission Sites.Selected for system user and Sites.Selected delegated permission for Stages user. Please refer chapter "Application and delegated permission Sites.Selected" for detailed explanation.
 +
 +
 +==== Proxy configuration (since Stages 7.10.10.0) ====
 +
 +Stages can communicate with SharePoint Online through a proxy. Fill in the ''proxy.scheme'', ''proxy.hostname'' and ''proxy.port'' host properties to use a proxy. Otherwise no proxy is used.
 +
 +> proxy.scheme
 +
 +  * Default value empty (no proxy)
 +  * Possible values: http, https
 +  * Description: The type of proxy to use.
 +
 +> proxy.hostname
 +
 +  * Default value empty (no proxy)
 +  * Example values: proxy.example.com or 10.1.2.3
 +  * Description: Which proxy host to use.
 +
 +> proxy.port
 +
 +  * Default value empty (no proxy)
 +  * Example values: 3128
 +  * Description: Which proxy port to use.
 +
 +> proxy.username
 +
 +  * Default value is empty (proxy doesn't require authentication).
 +  * Example values: username
 +  * Description: The username to use for authentication on the proxy.
 +
 +> proxy.password
 +
 +  * Default value is empty (proxy doesn't require authentication)
 +  * Example values: secretPassword
 +  * Description: The password to use for authentication on the proxy.
 +
  
 ===== Azure Portal ===== ===== Azure Portal =====
Line 216: Line 274:
 ==== Certificates & secrets ==== ==== Certificates & secrets ====
  
-It is required to generate a client secret for Stages. It's recommended to choose expire never or a long duration. If the secret expires it must be changed in Stages and all users have to re-authenticate.+It is required to generate a client secret or certificate for Stages.  
 + 
 +=== Client Secret === 
 + 
 +It's recommended to choose expire never or a long duration. If the secret expires it must be changed in Stages.
  
 [[https://doc.stagesasaservice.com/lib/exe/detail.php?id=74:cms_sharepoint_online&media=cms:azure_certificates_secrets.png|{{:cms:azure_certificates_secrets.png}}]] [[https://doc.stagesasaservice.com/lib/exe/detail.php?id=74:cms_sharepoint_online&media=cms:azure_certificates_secrets.png|{{:cms:azure_certificates_secrets.png}}]]
 +
 +Client secret can be specified like this:
 +
 +<code xml>
 +<cms-property name="client.secret" value="xxxxxx" />
 +</code>
 +
 +
 +=== Certificates (Since 7.11.10.0) === 
 +
 +It is possible to use certificates instead of client secret. A [[https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-self-signed-certificate|certificate has to be generated]] and added to Azure configuration. A keystore file with private key and certificate has to be configured in Stages:
 +
 +<code xml>
 +<cms-property name="client.certificate.keystore.file" value="conf/sharepointonline.pfx" />
 +<cms-property name="client.certificate.keystore.password" value="keystorepassword" />
 +<cms-property name="client.certificate.key.alias" value="myalias" />
 +<cms-property name="client.certificate.key.password" value="keypassword" />
 +</code>
  
 ===== Repository Configuration ===== ===== Repository Configuration =====