Integrating External Archives

yuuvis® RAD • 10.x »

Configuration of the service 'archive' integrates external archives. The service archives documents that are assigned to external media. The external media configuration specifies the connection to the service 'archive' and a profile from the configuration file archive-prod.yml from the directory \services\service-manager\config\.

All computers that are to call the 'archive' service must be specified in distributed environments in the archive-prod.yml configuration file:

trusted.ipPattern: (host1ip|host2ip)

The following external archives are supported:

iCAS

Profile parameters for iCAS:
storage:  
profiles:  
iternity:  
profileName:

Name of the profile.

The profile name is specified in yuuvis® RAD management-studio during media configuration.

You can create several profiles.
userName:

Name of the user with corresponding rights for the iCAS archive.
userPassword: User’s password.
endpoint: URL of the web service of iCAS.
cscMode

Memory mode for documents and metadata.

Memory mode is specified with a sequence of four parameters:

Document Metadata
Compression Encryption Compression Encryption
S (none) N (none) S (none) N (none)
L (encrypted) S (standard) L (encrypted) S (standard)
  A (AES 256)   A (AES 259)

Example:

LSSN

The document is compressed (L) and encrypted using the standard method (S); the metadata is not compressed (S) and not encrypted (N).

clientSslTrustStore:

Optional: Resource path to a certificate trust store for encrypted communication with the WebService.

clientSslTrustStorePassword:

Optional: Password for the certificate trust store.

defaultRetentionInDays:

Retention period in days (standard: 0)

If '0' is specified, then a retention period is determined by archive configurations.

A retention period of the 'Archiving' operation takes precedence over the retention period of the media configuration. A retention period of the media configuration takes precedence over the retention period of this configuration.

The retention period specified here is therefore valid only if the retention period is not specified in either the 'Archiving' operation or the media configuration.

 

NetApp

Profile parameters for NetApp:
storage:  
profiles:  
netapp:  
profileName:

Name of the profile.

The profile name is specified in yuuvis® RAD management-studio during configuration of the virtual archive.

You can create several profiles.
volume:

Directory for archiving.
enableReadOnly: true/false: Set read-only mode.

defaultRetentionInDays:

Retention period in days (standard: 0)

If '0' is specified, then a retention period is determined by archive configurations.

A retention period of the 'Archiving' operation takes precedence over the retention period of the media configuration. A retention period of the media configuration takes precedence over the retention period of this configuration.

The retention period specified here is therefore valid only if the retention period is not specified in either the 'Archiving' operation or the media configuration.

NetApp supports a maximum retention period of 30 years by default. The maximum retention period can be extended by configuring NetApp appropriately.

 

Hitachi Content Platform

Profile parameters for Hitachi Content Platform:
storage:  
profiles:  
hcp_s3:  
profileName:

Name of the profile.

The profile name is specified in yuuvis® RAD management-studio during configuration of the virtual archive.

You can create several profiles.
access-key:

Access key
secret-key: Password
url: URL to HCP
bucket: Name of the bucket for storing.

defaultRetentionInDays:

Retention period in days (standard: 0)

If '0' is specified, then a retention period is determined by archive configurations.

A retention period of the 'Archiving' operation takes precedence over the retention period of the media configuration. A retention period of the media configuration takes precedence over the retention period of this configuration.

The retention period specified here is therefore valid only if the retention period is not specified in either the 'Archiving' operation or the media configuration.

 

Cloudian HyperStore

Profile parameters for Cloudian HyperStore:
storage:  
profiles:  
cloudian_s3:  
profileName:

Name of the profile.

The profile name is specified in yuuvis® RAD management-studio during configuration of the virtual archive.

You can create several profiles.
supportRetention:

false

Required parameters, retention periods on objects are currently not supported.
access-key:

Access key
secret-key: Password
url: URL to Cloudian HyperStore
bucket: Name of the bucket for storing.

 

Amazon S3

Profile parameters for Amazon S3:
storage:  
profiles:  
s3:  
profileName:

Name of the profile.

The profile name is specified in yuuvis® RAD management-studio during configuration of the virtual archive.

You can create several profiles.
access-key:

Access key
secret-key: Password
url: URL to S3
bucket: Name of the bucket in the storage system for filing.

defaultRetentionInDays:

Retention period in days (standard: 0)

If '0' is specified, then a retention period is determined by archive configurations.

A retention period of the 'Archiving' operation takes precedence over the retention period of the media configuration. A retention period of the media configuration takes precedence over the retention period of this configuration.

The retention period specified here is therefore valid only if the retention period is not specified in either the 'Archiving' operation or the media configuration.
retentionMode:

Optional: Parameter for selecting an object lock

  • COMPLIANCE

    Objects with retention cannot be changed or deleted, even by storage administrators.

  • GOVERNANCE

    Storage users with defined permissions can change or delete objects that are being stored.

Default: COMPLIANCE
region:

Optional: Specifies the location of the data center where new buckets are to be created.

Default: Determined using the S3 method 'GetBucketLocation'.
objectLock:

Optional: Value that specifies whether the internal archive retention (objectLock) is required or optional for the corresponding bucket.

  • true

    • ObjectLocking is activated with buckets that are automatically created by the 'archive' service.

    • Binary content files with retention set can only be saved in buckets where ObjectLocking is activated.

  • false

    • ObjectLocking is disabled with buckets that are automatically created by the 'archive' service.

    • Native internal archive retention is set for binary content files that are stored in buckets where ObjectLocking is activated.

    • Native internal archive retention is not set for binary content files that are stored in buckets where ObjectLocking is deactivated. This means that binary content files can be protected against manipulation via yuuvis®, but not against manipulation via direct access to the storage system.

    Default: true
pathTemplate: Optional: Parameter used to save objects in specified directories within a bucket.