Example Configuration (conf/config.xml):

<cms-type name="integrity">
    <cms-host ident="integrity.ident.1" name="" displayName="Test Integrity Server">
        <cms-property name="protocol" value="http" />
        <cms-property name="port" value="7001" />
        <cms-property name="user" value="integrity_username" />
        <cms-property name="password" value="integrity_password" />
        <cms-property name="createSubprojects" value="false"/>

Configuration Settings:

  • 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) and 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

* Required settings

Integrity Permissions For Read And Write Operations:

  • Add member
  • CheckIn
  • CreateSubproject
  • Demote
  • Lock
  • Login
  • OpenProject
  • Promote

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”.

Configure Integrity Repository

Access to Integrity projects can be configured in Stages processes via “Management > File Management > Repositories”.

The following settings can be made:

  • 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.

File Lifecycles

The lifecycle state idents from the process metamodel (e.g. draft, review, released) must also be configured in the Integrity project policies.

Known Limitation

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.