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
Last revisionBoth sides next revision
74:cms_sharepoint [2019/10/16 13:19] – tssr74:cms_sharepoint [2020/05/20 07:05] – [Sharepoint] tssr
Line 8: Line 8:
 <cms-type name="sharepoint"> <cms-type name="sharepoint">
     <!-- Global Properties -->     <!-- Global Properties -->
-    <cms-property name="stages.server.url" value="https://stages.mycompany:8080" /> 
-    <cms-property name="http.authentication.hostname" value="nonempty" /> 
-    <cms-property name="http.max.connections" value="100" /> 
-    <cms-property name="http.connection.timeout" value="10000" /> 
-    <cms-property name="http.socket.timeout" value="90000" /> 
-    <cms-property name="http.connection.pool.max.idle" value="60000" /> 
-    <cms-property name="http.ssl.allow.all" value="true" /> 
     <cms-host ident="sharepoint.example.ident" name="https://sharepoint.example.net:1234" displayName="Sharepoint Example Server">     <cms-host ident="sharepoint.example.ident" name="https://sharepoint.example.net:1234" displayName="Sharepoint Example Server">
         <!-- Host Properties -->         <!-- Host Properties -->
-        <cms-property name="state.attribute.name" value="_Status" /> 
         <cms-property name="version.date.format" value="dd.MM.yyyy HH:mm" />         <cms-property name="version.date.format" value="dd.MM.yyyy HH:mm" />
-        <cms-property name="document.content.type.name" value="Document" /> 
-        <cms-property name="link.content.type.name" value="Link to a document" /> 
         <cms-property name="user" value="sharepoint_username" />         <cms-property name="user" value="sharepoint_username" />
-        <cms-property name="password" value="sharepoint_username" />+        <cms-property name="password" value="sharepoint_password" />
     </cms-host>     </cms-host>
 </cms-type> </cms-type>
 +
 </code> </code>
  
Line 31: Line 22:
 These configuration properties affect the behavior of every integrated SharePoint server. These configuration properties affect the behavior of every integrated SharePoint server.
  
-** * ** ''Required''\\+*** ** ''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.
- 
-> http.authentication.hostname (required for ntlm authentication) 
- 
-  * __Description__: The host name of the server that runs Stages and is allowed to authenticate via ntlm against the SharePoint server. 
  
 > http.connection.context.timeout ** + ** > http.connection.context.timeout ** + **
  
-  * __Default Value__: 60000+   * __Default Value__: 60000
   * __Description__: The maximum period of inactivity (in milliseconds) before an authentication context is considered obsolete and will be removed by the resource monitor.   * __Description__: The maximum period of inactivity (in milliseconds) before an authentication context is considered obsolete and will be removed by the resource monitor.
  
Line 78: Line 65:
   * __Default Value__: 100   * __Default Value__: 100
   * __Description__: The maximum number of simultaneous HTTP connections between Stages and SharePoint.   * __Description__: The maximum number of simultaneous HTTP connections between Stages and SharePoint.
 +
 +> http.authentication.hostname
 +
 +  * __Description__: The host name of the server that runs Stages and is allowed to authenticate via ntlm against the SharePoint server.
  
 > cms.browser.activated ** + ** > cms.browser.activated ** + **
  
   * __Default Value__: true   * __Default Value__: true
-  * __Description__: If set to false, it is  not possible to browse through the files in the Stages web-application.+  * __Description__: If set to false, it is not possible to browse through the files in the Stages web-application.
  
-> upload.service+> upload.service ** + **
  
   * __Default Value__: CopyService   * __Default Value__: CopyService
   * __Description__: Either CopyService or RPC. Defines the interface that is used for uploads to SharePoint. CopyService is the default setting, the only drawback is that it might create an additional version for the initial checkin depending of the SharePoint setting Checkout required   * __Description__: Either CopyService or RPC. Defines the interface that is used for uploads to SharePoint. CopyService is the default setting, the only drawback is that it might create an additional version for the initial checkin depending of the SharePoint setting Checkout required
 +=== 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''\\ +*** **  ''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.+
  
 > user ** # ** > user ** # **
Line 105: Line 93:
   * __Description__: You may enter the SharePoint username for the Stages system account here instead of the corresponding field Username in the cms profile. If both values exist, the username from the cms profile is preferred.   * __Description__: You may enter the SharePoint username for the Stages system account here instead of the corresponding field Username in the cms profile. If both values exist, the username from the cms profile is preferred.
  
-> password+> password ** # **
  
   * __Description__: You may enter the SharePoint password for the Stages system account here instead of the corresponding field Password in the cms profile. If both values exist, the password from the cms profile is preferred.   * __Description__: You may enter the SharePoint password for the Stages system account here instead of the corresponding field Password in the cms profile. If both values exist, the password from the cms profile is preferred.
Line 120: Line 108:
 > link.content.type.name ** + ** > link.content.type.name ** + **
  
-  * __Default Value__: Link to a document +  * __Default Value__: Link to a Document 
-  * __Description__: The configurable name of the content type ''Link to a document''. The default value corresponds with the default name in english versions of SharePoint.+  * __Description__: The configurable name of the content type ''Link to a Document''. The default value corresponds with the default name in english versions of SharePoint.
  
 > state.attribute.name > state.attribute.name
Line 164: Line 152:
   * __Description__: When set to true, files will be downloaded from stages using the system account.   * __Description__: When set to true, files will be downloaded from stages using the system account.
  
 +=== Repository Configuration ===
 +Access to SharePoint projects can be configured in Stages processes via “Management > File Management > Repositories”.
 +{{ :cms:sp-repository.png? |}}
 +
 +> Name:
 +The name of this SharePoint configuration. This name will be used by Stages to refer to this repository configuration (e.g. in repository plan)
 +
 +> 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.
 +
 +> Default Domain:
 +Define a domain for this repository configuration, which will be used when Stages is logging in to the SharePoint server. This overwrites the property **domain** from the configuration file (config.xml).
 +
 +> 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.
 +
 +> Username:
 +Define a username for this repository configuration. This overwrites the property **username** from the configuration file (config.xml).
 +
 +> Password
 +Define a username for this repository configuration. This overwrites the property **password** from the configuration file (config.xml).
 +
 +> Default Lifecycle
 +Select a lifecycle from the process metamodel as default for files from this repository.
 +
 +
 +
 +=== Host-Properties which are not in use since Stages v7.+ ===
  
-=== Currently not used === 
 > stages.server.url > stages.server.url
  
Line 181: Line 211:
 > validateFilename > validateFilename
  
-  * <nowiki>^[^~\"#%&*:<>?/\\\\{|}]+$</nowiki>+  * <nowiki>^[^~"#%&*:<>?/{|}]+$</nowiki>
  
 > validatePath > validatePath
  
-  * <nowiki>^([^~\"#%&*:<>?/\\\\{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.])?([\\\\/]([^~\"#%&*:<>?/\\\\{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.]))*[\\\\/]?$</nowiki>+  * <nowiki>^([^~"#%&*:<>?/{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.])?([\\\\/]([^~\"#%&*:<>?/\\\\{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.]))*[\\\\/]?$</nowiki> 
 +