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
72:cms_configuration [2019/03/19 16:40] – [Subversion] tssr72:cms_configuration [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 6: Line 6:
 The configuration for these systems is done in two simple steps: The configuration for these systems is done in two simple steps:
  
-  - Add the XML snippet explained in [[72:cms_configuration#Common Configuration | this section]] to your Stages configuration file for each configuration management system you want to work with+  - Add the XML snippet explained in [[72:cms_configuration#Common Configuration | this section]] to your Stages configuration for each configuration management system you want to work with
   - Adjust this snippet for the specific configuration management system according to the explanations below   - Adjust this snippet for the specific configuration management system according to the explanations below
  
Line 16: Line 16:
 ==== Common Configuration ==== ==== Common Configuration ====
  
-To enable Stages to communicate with an external CMS, you have to add an XML snippet to the central configuration file, which is located at <font inherit/Courier New,Courier,monospace;;inherit;;inherit><STAGESHOME>/conf/config.xml</font>.+To enable Stages to communicate with an external CMS, you have to add an XML snippet to the central configuration file, which is located at <STAGESHOME>/conf/config.xml.
  
 A generic XML snippet for all CMS configurations looks like the following: A generic XML snippet for all CMS configurations looks like the following:
Line 38: Line 38:
 </code> </code>
  
-As you can see, the root element of the CMS configuration is the **<cms>** element. +**<stages-config>**
-The configuration has to have one **<cms-type>** element for every content management system you want to support in your Stages application. The attribute __name__ of each **<cms-type>** is crucial for the system to work. Every CMS implementation has its own and unique __name__.+
  
-Right after the **<cms-type>** element you can define multiple **<cms-property>** elements, which are in effect for the entire type. +The root XML element of the stages configuration file. The configuration for the content management systems has to be inserted inside this element. The CMS configuration is a child element of the <stages-config> element.
-The attribute __name__ identifies the property by its key. The __value__ attribute defines the value for that property.+
  
-Each **<cms-type>** element can contain several **<cms-host>** elements. +**<cms>**
-Every **<cms-host>** element has the following attributes: __ident__, __name__ and __displayName__.+
  
-The __ident__ of a **<cms-host>** has to be unique for this stages server. The __name__ attribute identifies the server name of the content management system. This name has to have a protocol and the host name (without any path e.g. /some/path). The display name of the host will be shown in the host dropdown selection field in the Stages Web-GUI.+This element holds all configuration data for the content management systems.
  
-Inside of a **<cms-host>** element you can define **<cms-property>** elements, which are in effect only for the specific host.+**<cms-type name="" >** 
 + 
 +The <cms-type> element represents the configuration for a single content management system you want to support in your Stages application. 
 + 
 +  * __name__: The attribute "name" of each <cms-type> is crucial for the system to work. Every CMS implementation has its own and unique "name". 
 + 
 +**<cms-property name="" value="" >** (Global Properties) 
 + 
 +Right inside the <cms-type> element you can define multiple <cms-property> elements, which affect the entire CMS type. These properties are called global properties. 
 + 
 +  * __name__: The attribute "name" identifies the property by its key. 
 +  * __value__: The "value" attribute defines the value for that property. 
 + 
 +**<cms-host ident="" name="" displayName="" >** 
 + 
 +A <cms-type> element can have several <cms-host> elements. 
 + 
 +  * __ident__: The "ident" of a <cms-host> is a simple string but has to be unique for the Stages server. 
 +  * __name__: The "name" attribute identifies the server by the URL of the content management system. Please note that this URL must contain the protocol, the server's host name (not its IP address), optionally a port number, and **NO** path elements (e.g. [[https://myhost:10443]]). 
 +  * __displayName__: The display name of the host will be shown in the host dropdown selection field in the Stages application. 
 + 
 +**<cms-property name="" value="" >** (Host Properties) 
 + 
 +Inside a <cms-host> element you can define <cms-property> elements, which affect only the specific host. These properties are called host properties. 
 + 
 +  * __name__: The attribute "name" identifies the property by its key. 
 +  * __value__: The "value" attribute defines the value for that property.
  
 ==== Subversion ==== ==== Subversion ====
 +=== Example Configuration ===
 +
 +<code xml>
 +<cms-type name="subversion">
 +    <cms-host ident="subversion.example.ident" name="https://subversion.example.net:1234" displayName="Subversion Example Server">
 +        <cms-property name="user" value="subversion_username" />
 +        <cms-property name="password" value="subversion_password" />
 +    </cms-host>
 +</cms-type>
 +</code>
 +
 === Host Properties === === Host Properties ===
  
-**User**+**user**
  
    * Default Value: N/A    * Default Value: N/A
   * Description: You may enter the Subversion 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 Subversion 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**
  
   * Default Value: N/A   * Default Value: N/A
   * Description: You may enter the Subversion 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 Subversion 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**+**domain**
  
   * Default Value: N/A   * Default Value: N/A
Line 87: Line 121:
  
   * Default Value: false   * Default Value: false
-  * Description: When set to <font inherit/Courier New,Courier,monospace;;inherit;;inherit>true</font>, 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).
 ==== Sharepoint ==== ==== Sharepoint ====
  
-=== Global Sharepoint Properties ===+=== Example Configuration === 
 + 
 +<code xml> 
 +<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-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> 
 +</code> 
 + 
 +=== 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. The configuration of them needs to be done in the **<cms-type>** section of config.xml.
Line 96: Line 155:
 **stages.server.url ** (required) **stages.server.url ** (required)
  
-  * Default Value: N/A+   * Default Value: N/A
   * Description: The URL under which Stages is accessible.   * Description: The URL under which Stages is accessible.
  
Line 149: Line 208:
   * Description: The interval (in milliseconds) between two consecutive resource monitor runs which check for idle or expired connections and obsolete authentication contexts.   * Description: The interval (in milliseconds) between two consecutive resource monitor runs which check for idle or expired connections and obsolete authentication contexts.
  
-=== Sharepoint Host Properties ===+=== Host Properties ===
  
 **version.date.format ** **version.date.format **
  
-   * Default Value: N/A+  * Default Value: N/A
   * Description: The localized date format that SharePoint is using.   * Description: The localized date format that SharePoint is using.
  
-**raw.version.date.format ** (required)+**raw.version.date.format **  (required)
  
   * Default Value: yyyy-MM-dd'T'HH:mm:ss'Z'   * Default Value: yyyy-MM-dd'T'HH:mm:ss'Z'
   * Description: The date format that SharePoint is using internally.   * Description: The date format that SharePoint is using internally.
  
-**document.content.type.name ** (required if Sharepoint Content Types are enabled)+**document.content.type.name **  (required if Sharepoint Content Types are enabled)
  
   * Default Value: Document   * 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.   * 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 ** (required if Sharepoint Content Types enabled)+**link.content.type.name **  (required if Sharepoint Content Types enabled)
  
   * Default Value: Link to a document   * Default Value: Link to a document
Line 186: Line 245:
   * 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.   * 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)+**state.attribute.name**  (required)
  
   * Default Value: N/A   * Default Value: N/A
Line 210: Line 269:
   * Default Value: true   * 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.   * 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.
 +
 +