Differences

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

--- 75:cms_integrity [2020/01/24 10:16] – prnr
+++ 75:cms_integrity [2020/03/11 12:23] – cgl
@@ Line 1: / Line 1: @@
 ==== Integrity ====
-!!! Example Content !!!
+===   ===
-=== Example Configuration ===
+=== Example Configuration (conf/config.xml): ===
 <code xml>
-<cms-type name="integrity">\\
+<cms-type name="integrity">
-    <!-- Global Properties -->\\
+    <cms-host ident="integrity.ident.1" name="integrity.myserver.com" displayName="Test Integrity Server">
-    <cms-host ident="integrity.example.ident" name="https://integrity.example.net:1234" displayName="Integrity Example Server">\\
+        <cms-property name="protocol" value="http" />
-        <!-- Host Properties -->\\
+        <cms-property name="port" value="http" />
-        <cms-property name="user" value="integrity_username" />\\
+        <cms-property name="user" value="integrity_username" />
-        <cms-property name="password" value="integrity_password" />\\
+        <cms-property name="password" value="integrity_password" />
-    </cms-host>\\
+        <cms-property name="createSubprojects" value="false"/>
-</cms-type>\\
+    </cms-host>
+</cms-type>
 </code>
-=== Host Properties ===
+=== Configuration Settings: ===
-These configuration properties affect the behavior of one SharePoint Online server.
+  * **cms-host ident*:**  This setting needs to be an arbitrary unique identifier for each cms host setting
+  * **cms-host name*:**  The actual web address of the integrity server without protocol (http/https) an port
+  * **cms-host displayName*:**  The name of the Integrity server as it will be displayed in the Stages UI
+  * **cms-property protocol:**  The web protocol Stages will use to access the Integrity server. Allowed values: http or https. Default value: http
+  * **cms-property port: **The port at which the Integrity web services can be accessed. Default value: 7001
+  * **cms-property user*:**  Integrity username which will be used by Stages root user (system account) and for prefetching file metadata (revision numbers, checkin dates, …)
+  * **cms-property password*:**  Integrity password for Stages system account
+  * **cms-property createSubprojects:**  Specifies if newly created file paths will be created as subprojects or as directories in Integrity projects. Allowed values: true, false. Default value: false
+  * **cms-property timeoutMillis:**  Specifies how long (in milliseconds) Stages will wait for a reponse by Integrity to most requests before considering them as timed out. Default value : 6000
+  * **cms-property longRunningOpsTimeoutMillis:**  Specifies how long (in milliseconds) Stages will wait for a reponse by Integrity to potentially longer running requests (e.g. file uploads) before considering them as timed out. Default Value: 60000
+  * **cms-property binaryFormatFileExtensions:**  Comma-separated list of file extensions that will be initially uploaded to Integrity in binary format (e.g. "zip,pdf,docx,xslx"). No default value
+<sub>* Required settings</sub>
-*** ** ''Required'' \\
+=== Integrity Permissions For Read And Write Operations: ===
-Properties marked with ** * ** are required for the adapter to work.
-**# ** ''Required but can also be set in web-application'' \\
+  * Add member
-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.
+  * CheckIn
+  * CreateSubproject
+  * Demote
+  * Lock
+  * Login
+  * OpenProject
+  * Promote
-**+ ** ''Required but with default'' \\
+These Integrity permissions are needed for all users that shall be able to execute file read (e.g. download) and write operations (e.g upload) through Stages in Integrity repositories. If only read access is desired, the pemissions "Login" and "Open Project" are suffient. The Integrity user specified in config.xml for the system accout (see Configuration Settings) also needs these permissions at least. \\ Any user which shall be able to unlock files locked by others, additionally needs the Integrity permission "RemoveOtherUsersLock".
-Properties marked with ** + ** are required, but there is a default value. This values can be overridden by configuring it in the config.xml.
-> user ** # **
+=== Configure Integrity Repository ===
-* __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.
+Access to Integrity projects can be configured in Stages processes via "Management > File Management > Repositories".
-> password ** # **
+{{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/general/integrityrepository_1.png?nolink&1521x216}}
-* __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.
+The following settings can be made:
-> http.connection.timeout ** + **
+  * Name: The name of the repository as it will be displayed on other pages (e.g. in the file properties dialog)
+  * Host: Integrity host from config.xml (see ConfigurationSettings)
+  * Project: Name of the Integrity project including the project (pj) file name
+  * Development path: The development path name of the Integrity project (optional)
+  * Mandatory change packages: Specifies if an Integrity change package id needs to be selected in file lock, upload and set state dialogs. Otherwise it is also allowed to select no change package (id ":none") in these dialogs.
+  * Default lifecycle: Selects a lifecycle from the process metamodel as default for files from this repository.
-* __Default Value__: 30000 * __Description__: The timeout in milliseconds until a http connection has to be established and the maximum period of inactivity (in milliseconds) between two consecutive data packets before the socket is closed.
+=== File Lifecycles ===
-> http.max.connections ** + **
+The lifecycle state idents from the process metamodel (e.g. draft, review, released) must also be configured in the Integrity project policies.
-* __Default Value__: 100 * __Description__: The maximum number of simultaneously used http connections between Stages and the Subversion server.
+=== Known Limitation ===
-> http.ssl.allow.all ** + **
+The history of files from Integrity development paths may show additional revisions which do not belong to the development paths due to limitations of the Integrity web services.
-* __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).
-> use.system.account.for.download ** + **
-* __Default Value__: false * __Description__: When set to true, files will be downloaded from stages using the system account.