| Next revision | Previous revision |
| 74:cms_sharepoint [2019/09/25 13:43] – created tssr | 74:cms_sharepoint [2024/02/15 00:00] (current) – external edit 127.0.0.1 |
|---|
| <h3>Sharepoint</h3> | [[:74:cms_configuration|Back to Common CMS Configuration]] |
| |
| <div class="level3"> </div> | ==== Sharepoint ==== |
| |
| <h4>Example Configuration</h4> | === Example Configuration === |
| |
| <div class="level4">\\ | <code xml> |
| <pre class="code xml">\\ | <cms-type name="sharepoint"> |
| < cms-type name="sharepoint">\\ | <!-- Global Properties --> |
| < !-- Global Properties -->\\ | <cms-host ident="sharepoint.example.ident" name="https://sharepoint.example.net:1234" displayName="Sharepoint Example Server"> |
| < cms-property name="stages.server.url" value="https://stages.mycompany:8080" />\\ | <!-- Host Properties --> |
| < cms-property name="http.authentication.hostname" value="nonempty" />\\ | <cms-property name="version.date.format" value="dd.MM.yyyy HH:mm" /> |
| < cms-property name="http.max.connections" value="100" />\\ | <cms-property name="user" value="sharepoint_username" /> |
| < cms-property name="http.connection.timeout" value="10000" />\\ | <cms-property name="password" value="sharepoint_password" /> |
| < cms-property name="http.socket.timeout" value="90000" />\\ | </cms-host> |
| < cms-property name="http.connection.pool.max.idle" value="60000" />\\ | </cms-type> |
| < 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">\\ | |
| < !-- 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-host>\\ | |
| < /cms-type> | |
| |
| </pre> | </code> |
| |
| <p> </p>\\ | === Global Properties === |
| </div> | |
| |
| <h4>Global Properties</h4> | These configuration properties affect the behavior of every integrated SharePoint server. |
| |
| <div class="level4">\\ | *** ** ''Required'' \\ |
| <p>These configuration properties affect the behavior of every integrated SharePoint server. The configuration of them needs to be done in the <b><cms-type></b> section of config.xml.</p> | Properties marked with ** * ** are required for the adapter to work. |
| |
| <p><b>stages.server.url </b> (required)</p> | **# ** ''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. |
| |
| <ul>\\ | **+ ** ''Required but with default'' \\ |
| <li class="level1">Default Value: N/A</li>\\ | Properties marked with ** + ** are required, but there is a default value. This values can be overridden by configuring it in the config.xml. |
| <li class="level1">Description: The URL under which Stages is accessible.</li>\\ | |
| </ul> | |
| |
| <p><b>http.authentication.hostname </b> (required for NTLM authentication)</p> | > http.connection.context.timeout ** + ** |
| |
| <ul>\\ | * __Default Value__: 60000 |
| <li class="level1">Default Value: N/A</li>\\ | * __Description__: The maximum period of inactivity (in milliseconds) before an authentication context is considered obsolete and will be removed by the resource monitor. |
| <li class="level1">Description: The host name of the server that runs Stages and is allowed to authenticate via NTLM against the SharePoint server.</li>\\ | |
| </ul> | |
| |
| <p><b>upload.service</b></p> | > http.connection.pool.max.idle ** + ** |
| |
| <ul>\\ | * __Default Value__: 60000 |
| <li class="level1">Default Value: Copy service</li>\\ | * __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). |
| <li class="level1">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</li>\\ | |
| </ul> | |
| |
| <p><b>initial.checkin.fix</b></p> | > http.connection.timeout ** + ** |
| |
| <ul>\\ | * __Default Value__: 10000 |
| <li class="level1">Default Value: true</li>\\ | * __Description__: The timeout in milliseconds until a connection to the server has to be established. |
| <li class="level1">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.</li>\\ | |
| </ul> | |
| |
| <p><b>http.ssl.allow.all</b></p> | > http.connection.resource.check.interval ** + ** |
| |
| <ul>\\ | * __Default Value__: 10000 |
| <li class="level1">Default Value: false</li>\\ | * __Description__: The interval (in milliseconds) between two consecutive resource monitor runs which check for idle or expired connections and obsolete authentication contexts. |
| <li class="level1">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).</li>\\ | |
| </ul> | |
| |
| <p><b>http.max.connections</b></p> | > http.socket.timeout ** + ** |
| |
| <ul>\\ | * __Default Value__: 90000 |
| <li class="level1">Default Value: 100</li>\\ | * __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. |
| <li class="level1">Description: The maximum number of simultaneous HTTP connections between Stages and SharePoint.</li>\\ | |
| </ul> | |
| |
| <p><b>http.connection.timeout</b></p> | > http.ssl.allow.all ** + ** |
| |
| <ul>\\ | * __Default Value__: false |
| <li class="level1">Default Value: 10000</li>\\ | * __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). |
| <li class="level1">Description: The timeout in milliseconds until a connection to the server has to be established.</li>\\ | |
| </ul> | |
| |
| <p><b>http.socket.timeout</b></p> | > http.max.connections ** + ** |
| |
| <ul>\\ | * __Default Value__: 100 |
| <li class="level1">Default Value: 90000</li>\\ | * __Description__: The maximum number of simultaneous HTTP connections between Stages and SharePoint. |
| <li class="level1">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.</li>\\ | |
| </ul> | |
| |
| <p><b>http.connection.pool.max.idle</b></p> | > http.authentication.hostname |
| |
| <ul>\\ | * __Description__: The host name of the server that runs Stages and is allowed to authenticate via ntlm against the SharePoint server. |
| <li class="level1">Default Value: 60000</li>\\ | |
| <li class="level1">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).</li>\\ | |
| </ul> | |
| |
| <p><b>http.connection.context.timeout</b></p> | > cms.browser.activated ** + ** |
| |
| <ul>\\ | * __Default Value__: true |
| <li class="level1">Default Value: 60000</li>\\ | * __Description__: If set to false, it is not possible to browse through the files in the Stages web-application. |
| <li class="level1">Description: The maximum period of inactivity (in milliseconds) before an authentication context is considered obsolete and will be removed by the resource monitor.</li>\\ | |
| </ul> | |
| |
| <p><b>http.connection.resource.check.interval</b></p> | > upload.service ** + ** |
| |
| <ul>\\ | * __Default Value__: CopyService |
| <li class="level1">Default Value: 10000</li>\\ | * __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 |
| <li class="level1">Description: The interval (in milliseconds) between two consecutive resource monitor runs which check for idle or expired connections and obsolete authentication contexts.</li>\\ | === Host Properties === |
| </ul>\\ | |
| </div> | |
| |
| <h4>Host Properties</h4> | These configuration properties affect the behavior of one SharePoint Online server. |
| |
| <div class="level4">\\ | *** ** ''Required'' Properties marked with ** * ** are required for the adapter to work. |
| <p><b>version.date.format </b></p> | |
| |
| <ul>\\ | **# ** ''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. |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">Description: The localized date format that SharePoint is using.</li>\\ | |
| </ul> | |
| |
| <p><b>raw.version.date.format </b> (required)</p> | **+ ** ''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. |
| |
| <ul>\\ | > user ** # ** |
| <li class="level1">Default Value: yyyy-MM-dd'T'HH:mm:ss'Z'</li>\\ | |
| <li class="level1">Description: The date format that SharePoint is using internally.</li>\\ | |
| </ul> | |
| |
| <p><b>document.content.type.name </b> (required if Sharepoint Content Types are enabled)</p> | * __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. |
| |
| <ul>\\ | > password ** # ** |
| <li class="level1">Default Value: Document</li>\\ | |
| <li class="level1">Description: The configurable name of the content type "Document". The default value corresponds with the default name in english versions of SharePoint.</li>\\ | |
| </ul> | |
| |
| <p><b>link.content.type.name </b> (required if Sharepoint Content Types enabled)</p> | * __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. |
| |
| <ul>\\ | > domain ** # ** |
| <li class="level1">Default Value: Link to a document</li>\\ | |
| <li class="level1">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.</li>\\ | |
| </ul> | |
| |
| <p><b>user</b></p> | * __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. |
| |
| <ul>\\ | > document.content.type.name ** + ** |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">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.</li>\\ | |
| </ul> | |
| |
| <p><b>password</b></p> | * __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. |
| |
| <ul>\\ | > link.content.type.name ** + ** |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">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.</li>\\ | |
| </ul> | |
| |
| <p><b>domain</b></p> | * __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. |
| |
| <ul>\\ | > state.attribute.name |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">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.</li>\\ | |
| </ul> | |
| |
| <p><b>state.attribute.name</b> (required)</p> | * Description: The optional SharePoint column to write the Stages state to. |
| |
| <ul>\\ | > label.attribute.name |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">Description: The optional SharePoint column to write the Stages state to.</li>\\ | |
| </ul> | |
| |
| <p><b>label.attribute.name</b></p> | * Description: The optional SharePoint column to read Stages labels from. |
| |
| <ul>\\ | > label.attribute.delimiter ** + ** |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">Description: The optional SharePoint column to read Stages labels from.</li>\\ | |
| </ul> | |
| |
| <p><b>label.attribute.delimiter</b></p> | * __Default Value__: '','' |
| | * __Description__: A delimiting character or string that separates single labels. |
| |
| <ul>\\ | > raw.version.date.format ** + ** |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">Description: A delimiting character or string that separates single labels.</li>\\ | |
| </ul> | |
| |
| <p><b>element.url.attribute.name</b></p> | * __Default Value__: ''yyyy-MM-dd'T'HH:mm:ss'Z' '' |
| | * __Description__: The date format that SharePoint is using internally. |
| |
| <ul>\\ | > version.date.format |
| <li class="level1">Default Value: N/A</li>\\ | |
| <li class="level1">Description: The optional SharePoint column where external links to Stages may be stored as a back-reference</li>\\ | |
| </ul> | |
| |
| <p><b>major.versions</b></p> | * __Description__: The localized date format that SharePoint is using. |
| |
| <ul>\\ | > major.versions ** + ** |
| <li class="level1">Default Value: true</li>\\ | |
| <li class="level1">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.</li>\\ | * __Default Value__: true |
| </ul>\\ | * __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. |
| </div> | |
| | > page.size ** + ** |
| | |
| | * __Default Value__: 1000 |
| | * __Description__: Item count of one page received from the Sharepoint server. |
| | |
| | > page.url.override |
| | |
| | * __Description__: N/A |
| | |
| | > use.system.account.for.download ** + ** |
| | |
| | * __Default Value__: false |
| | * __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.+ === |
| | |
| | > stages.server.url |
| | |
| | * __Description__: The url to this Stages server. |
| | |
| | > initial.checkin.fix ** + ** |
| | |
| | * __Default Value__: true |
| | * __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 |
| | |
| | * __Description__: The optional SharePoint column where external links to Stages may be stored as a back-reference |
| | |
| | > validateFilename |
| | |
| | * <nowiki>^[^~"#%&*:<>?/{|}]+$</nowiki> |
| | |
| | > validatePath |
| | |
| | * <nowiki>^([^~"#%&*:<>?/{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.])?([\\\\/]([^~\"#%&*:<>?/\\\\{|}.]|[^~\"#%&*:<>?/\\\\{|}.][^~\"#%&*:<>?/\\\\{|}]*[^~\"#%&*:<>?/\\\\{|}.]))*[\\\\/]?$</nowiki> |
| |
| |