'archive' Service

enaio® 9.10 »

The configuration of the 'archive' service is used to set up and configure connections to the following archiving systems.

iCAS / HCP-Archive / Cloudian Hyperstore / Dell EMC ECS / S3 (AWS)

The configuration is carried out using profiles in the application-storage.yml configuration file from the \services\service-manager\config\ directory.

The installed configuration file contains sample profiles with profile parameters for supported archiving systems.

 

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

Profile name.

The profile name is specified during configuration of the virtual archive in enaio® enterprise-manager.

You can create more than one profile.

userName:

Name of the user with the appropriate rights for the archive.

userPassword: The user's password.
endpoint: URL of the iCAS web service.
cscMode

Storage mode for documents and index data.

The storage mode is specified with a sequence of four parameters:

Documents Index data
Compression Encryption Compression Encryption
S (without) N (without) S (without) N (without)
L (with) S (standard) L (with) S (standard)
  A (AES 256)   A (AES 259)

Example:

LSSN

The document is compressed (L) and encrypted with the standard method (S); the index data is not compressed (S) and not encrypted (N).

maxCreateCscSize

Determines the maximum size of containers created with the 'CreateCsc' write method.

The information is expressed in bytes. Default: 10 MB.

maxCreateCscFile

Determines the maximum number of documents for the containers created with the 'CreateCsc' write method.

Default: 1000.

maxCreateCscSingleFileLimit

Determines the individual size limit of a document. The 'CreateCsc' write method is used up to this limit.

The information is expressed in bytes. Default: 4 MB

If the limit is exceeded, the 'AddToWork' write method, which is less memory-intensive and creates the containers divided over several chunks, is used.

maxWorkChunkSize

Determines the maximum size of a single chunk for the 'AddToWork' write method.

The information is expressed in bytes. Default: 5 MB

clientSslTrustStore:

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

The path to the certificate file is specified with a 'file' log.

Example: clientSslTrustStore: file:D:\s-m\zertifikate\cert_icas.PFX

clientSslTrustStorePassword:

Optional: Password for the certificate trust store.

defaultRetentionInDays:

Retention time in days, default=0 (do not transmit retention time)

For documents with a scheduled retention time, this has priority over any times specified here.

 

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

Profile name.

The profile name is specified during configuration of the virtual archive in enaio® enterprise-manager.

You can create more than one profile.

access-key:

Access key

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

defaultRetentionInDays:

Retention time in days, default=0 (do not transmit retention time)

For documents with a scheduled retention time, this has priority over any times specified here.

 

The Cloudian Hyperstore Content Platform provides an AWS-S3-compatible rest API with few extensions used by the 'archive' service. In order to configure the Cloudian Hyperstore archive, you need to configure the following (S3-relevant) parameters:

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

Profile name.

The profile name is specified during configuration of the virtual archive in enaio® enterprise-manager.

You can create more than one profile.

access-key:

Access key

secret-key: Password
url: URL for Cloudian HyperStore
bucket: Name of the bucket in the storage system for filing.

defaultRetentionInDays:

Retention time in days, default=0 (do not transmit retention time)

For documents with a scheduled retention time, this has priority over any times specified here.

pathTemplate Optional: This parameter can be used to store objects in specific directories (paths) within a bucket.

 

Profile for Dell EMC ECS:
storage:  
profiles:  
ecs-cas:  
profileName:

Profile name.

The profile name is specified during configuration of the virtual archive in enaio® enterprise-manager.

You can create more than one profile.

access-key:

User name

password: Password
clusterId Number of the cluster that is being accessed.
url: URL to Dell EMC ECS
bucket: Name of the bucket to be displayed in the health check.
defaultRetentionInDays

Retention time in days, default=0 (do not transmit retention time)

For documents with a scheduled retention time, this has priority over any times specified here.

calculateDigestMetadata Default=false, optional: It may be necessary to compute a digest in the getMetadata query.
calculateDigestContent Default=false, optional: It may be necessary to compute a digest in the getContent query. The digest is sent in the Content-hash-HTTP header.

 

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

Profile name.

The profile name is specified during configuration of the virtual archive in enaio® enterprise-manager.

You can create more than one profile.

access-key:

Access key

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

defaultRetentionInDays:

Retention time in days, default=0 (do not transmit retention time)

For documents with a scheduled retention time, this has priority over any times specified here.

 

The 'archive' service must be restarted via enaio® services-admin after changes have been made to the application-storage.yml configuration file.