Differences

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

--- 74:cms_sharepoint [2019/10/11 11:03] – tssr
+++ 74:cms_sharepoint [2019/11/11 10:17] – tssr
@@ Line 8: / Line 8: @@
 <cms-type name="sharepoint">
     <!-- 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-property name="use.system.account.for.download" value="true|false" />
     <cms-host ident="sharepoint.example.ident" name="https://sharepoint.example.net:1234" displayName="Sharepoint Example Server">
         <!-- 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="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="password" value="sharepoint_username" />
+        <cms-property name="password" value="sharepoint_password" />
     </cms-host>
 </cms-type>
@@ Line 32: / Line 21: @@
 === Global Properties ===
-These configuration properties affect the behavior of every integrated SharePoint server. The configuration of them needs to be done in the **<cms-type>** section of config.xml.
+These configuration properties affect the behavior of every integrated SharePoint server.
-**stages.server.url ** (required)
+*** ** ''Required'' \\
+Properties marked with ** * ** are required for the adapter to work.
-   * Default Value: N/A
+**# ** ''Required but can also be set in web-application'' \\
-  * Description: The URL under which Stages is accessible.
+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.
-**http.authentication.hostname **  (required for NTLM authentication)
+**+ ** ''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.
-  * Default Value: N/A
+> http.connection.context.timeout ** + **
-  * Description: The host name of the server that runs Stages and is allowed to authenticate via NTLM against the SharePoint server.
-**upload.service**
+   * __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.
+> http.connection.pool.max.idle ** + **
-  * Default Value: Copy service
+  * __Default Value__: 60000
-  * 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__: The maximum period of inactivity (in milliseconds) until a server connection will be closed automatically. For technical reasons the sum of http.connection.pool.max.idle and http.connection.resource.check.interval has to be lower than the keep-alive timeout of SharePoint's IIS site (default: 120s).
+> http.connection.timeout ** + **
-**initial.checkin.fix**
+  * __Default Value__: 10000
+  * __Description__: The timeout in milliseconds until a connection to the server has to be established.
+> http.connection.resource.check.interval ** + **
-  * Default Value: true
+  * __Default Value__: 10000
-  * Description: If CopyService is used for uploads, causes Stages to repeat the initial checkin in case the comment or version are not created correctly in SharePoint.
+  * __Description__: The interval (in milliseconds) between two consecutive resource monitor runs which check for idle or expired connections and obsolete authentication contexts.
+> http.socket.timeout ** + **
-**http.ssl.allow.all**
+  * __Default Value__: 90000
+  * __Description__: The maximum time of inactivity (in milliseconds) until a server connection is considered dead and will be closed forcefully. This value should be higher than http.connection.pool.max.idle.
+> http.ssl.allow.all ** + **
-  * Default Value: false
+  * __Default Value__: false
-  * Description: When set to true, disables any verification checks for certificates in case of SSL-secured HTTPS connections. It is recommended to only use this in test environments where no valid certificates exist (e.g. self-signed certificates).
+  * __Description__: When set to true, disables any verification checks for certificates in case of SSL-secured HTTPS connections. It is recommended to only use this in test environments where no valid certificates exist (e.g. self-signed certificates).
+> http.max.connections ** + **
-**http.max.connections**
+  * __Default Value__: 100
+  * __Description__: The maximum number of simultaneous HTTP connections between Stages and SharePoint.
+> http.authentication.hostname
-  * Default Value: 100
+  * __Description__: The host name of the server that runs Stages and is allowed to authenticate via ntlm against the SharePoint server.
-  * Description: The maximum number of simultaneous HTTP connections between Stages and SharePoint.
+> cms.browser.activated ** + **
-**http.connection.timeout**
+  * __Default Value__: true
+  * __Description__: If set to false, it is not possible to browse through the files in the Stages web-application.
+> upload.service ** + **
-  * Default Value: 10000
+  * __Default Value__: CopyService
-  * Description: The timeout in milliseconds until a connection to the server has to be established.
+  * __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 ===
-**http.socket.timeout**
+These configuration properties affect the behavior of one SharePoint Online server.
-  * Default Value: 90000
+*** **  ''Required''  Properties marked with ** * **  are required for the adapter to work.
-  * Description: The maximum time of inactivity (in milliseconds) until a server connection is considered dead and will be closed forcefully. This value should be higher than http.connection.pool.max.idle.
-**http.connection.pool.max.idle**
+**# **  ''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: 60000
+**+ **  ''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.
-  * Description: The maximum period of inactivity (in milliseconds) until a server connection will be closed automatically. For technical reasons the sum of http.connection.pool.max.idle and http.connection.resource.check.interval has to be lower than the keep-alive timeout of SharePoint's IIS site (default: 120s).
-**http.connection.context.timeout**
+> user ** # **
-  * Default Value: 60000
+  * __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: The maximum period of inactivity (in milliseconds) before an authentication context is considered obsolete and will be removed by the resource monitor.
+> password ** # **
-**http.connection.resource.check.interval**
+  * __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.
+> domain ** # **
-  * Default Value: 10000
+  * __Description__: You may enter the SharePoint domain for the Stages system account here instead of the corresponding field Default domain in the cms profile. If both values exist, the domain from the cms profile is preferred.
-  * Description: The interval (in milliseconds) between two consecutive resource monitor runs which check for idle or expired connections and obsolete authentication contexts.
+> document.content.type.name ** + **
-=== Host Properties ===
+  * __Default Value__: Document
+  * __Description__: The configurable name of the content type ''Document''. The default value corresponds with the default name in english versions of SharePoint.
+> link.content.type.name ** + **
-**version.date.format **
+  * __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.
+> state.attribute.name
-  * Default Value: N/A
+  * Description: The optional SharePoint column to write the Stages state to.
-  * Description: The localized date format that SharePoint is using.
-**raw.version.date.format **  (required)
+> label.attribute.name
-  * Default Value: yyyy-MM-dd'T'HH:mm:ss'Z'
+  * Description: The optional SharePoint column to read Stages labels from.
-  * Description: The date format that SharePoint is using internally.
-**document.content.type.name **  (required if Sharepoint Content Types are enabled)
+> label.attribute.delimiter ** + **
-  * Default Value: Document
+  * __Default Value__: '',''
-  * Description: The configurable name of the content type "Document". The default value corresponds with the default name in english versions of SharePoint.
+  * __Description__: A delimiting character or string that separates single labels.
+> raw.version.date.format ** + **
-**link.content.type.name **  (required if Sharepoint Content Types enabled)
+  * __Default Value__: ''yyyy-MM-dd'T'HH:mm:ss'Z' ''
+  * __Description__: The date format that SharePoint is using internally.
+> version.date.format
-  * Default Value: Link to a document
+  * __Description__: The localized date format that SharePoint is using.
-  * 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.
+> major.versions ** + **
-**user**
+  * __Default Value__: true
+  * __Description__: This optional property can be used to specify whether major versions (e.g 2.0) or minor versions (e.g. 0.2) are to be created on checkin. By default major versions are created (major.versions=true). Set major.versions=false if minor versions shall be created instead. A more fine-grained configuration which version type is created on which state change can be defined for document lifecycles in the metamodel.
+> page.size ** + **
-  * Default Value: N/A
+  * __Default Value__: 1000
-  * 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__: Item count of one page received from the Sharepoint server.
+> page.url.override
-**password**
+  * __Description__: N/A
+> use.system.account.for.download ** + **
-  * Default Value: N/A
-  * 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.
-**domain**
-  * Default Value: N/A
-  * Description: You may enter the SharePoint default domain for the Stages system account here instead of the corresponding field Default domain in the CMS profile. If both values exist, the default domain from the CMS profile is preferred.
-**state.attribute.name**  (required)
-  * Default Value: N/A
-  * Description: The optional SharePoint column to write the Stages state to.
-**label.attribute.name**
-  * Default Value: N/A
-  * Description: The optional SharePoint column to read Stages labels from.
-**label.attribute.delimiter**
+  * __Default Value__: false
+  * __Description__: When set to true, files will be downloaded from stages using the system account.
+=== Currently not used ===
-  * Default Value: N/A
+> stages.server.url
-  * Description: A delimiting character or string that separates single labels.
-**element.url.attribute.name**
+  * __Description__: The url to this Stages server.
+> initial.checkin.fix ** + **
-  * Default Value: N/A
+  * __Default Value__: true
-  * Description: The optional SharePoint column where external links to Stages may be stored as a back-reference
+  * __Description__: If CopyService is used for uploads, causes Stages to repeat the initial checkin in case the comment or version are not created correctly in SharePoint.
+> element.url.attribute.name
-**major.versions**
+  * __Description__: The optional SharePoint column where external links to Stages may be stored as a back-reference
+> validateFilename
-  * Default Value: true
+  * <nowiki>^[^~"#%&*:<>?/\\{|}]+$</nowiki>
-  * Description: This optional property can be used to specify whether major versions (e.g 2.0) or minor versions (e.g. 0.2) are to be created on checkin. By default major versions are created (major.versions=true). Set major.versions=false if minor versions shall be created instead. A more fine-grained configuration which version type is created on which state change can be defined for document lifecycles in the metamodel.
-**use.system.account.for.download**
+> validatePath
-  * Default Value: false
+  * <nowiki>^([^~"#%&*:<>?/\\{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.])?([\\\\/]([^~\"#%&*:<>?/\\\\{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.]))*[\\\\/]?$</nowiki>
-  * Description: When set to true, files will be downloaded from stages using the system account.