Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »


Please note: In order to use StorageType 12 (S3), you may have to provide additional libraries to KGS Store.

Please download S3 libraries from our website, decompress the archive to a folder which can be reached by KGS Store and set in "OSGi → Configuration → Generic Store Service" the path of "Additional JAR folder" to the one that includes S3 libraries.

[COMMON SETTINGS]

In order to use S3, please set in [COMMON SETTINGS] section the parameter StorageType = 12.

[STORAGE_S3]

Parameter

DataType

Description

Default

ConnectionUser

String

Depends on the used S3 endpoint.


Examples:

Amazon AWS → Access key ID


ConnectionPass

String

Depends on the used S3 endpoint.

This parameter value will be encoded during the first startup.


Examples:

Amazon AWS → Secret access key


Region

String

Used for Amazon AWS.

Specify your AWS region here.


Protocol

String

http or https

https

AllowCreateBuckets

Boolean

Should be set to false, if you want to use precreated buckets.

TRUE

RequestSigner


Possible values:

  • NoOpSignerType

  • QueryStringSignerType

  • AWS3SignerType

  • AWS4SignerType

  • AWS4UnsignedPayloadSignerType

AWS4UnsignedPayloadSignerType

HashCheck

Boolean

Enables or disables the hash-key check during document checkout (get).

Can be specified per contentrepository by adding a trailing "_<ContentRepository>".


Example: HashCheck_FI = FALSE

FALSE

RetentionPeriod

Integer

Defines the amount of time (in months) from creation date until the documents should be protected from modification.

Can be specified per contentrepository by adding a trailing "_<ContentRepository>".


Example: RetentionPeriod_FI = 12


LockFiles

Boolean

If enabled locks all objects in compliance mode during the create process.


BucketName

String

Defines the name of the bucket in which files will be archived.

Note for Amazon AWS

Every bucket name has to be unique throughout all Amazon regions!


EndPoint

String

URL for your S3 endpoint.

Should not be used in case of Amazon AWS. Use the Region parameter instead.


ClientOptions

String

Possible values:

  • PathStyleAccess


Values can be combined with a semicolon.


Example:

ClientOptions = PathStyleAccess:true;Parameter2:false


MaxConnections

Integer

Defines the maximal number of opened connections.

ConnectionTimeout

Integer

Timeout for connections and read requests in seconds.

ContrepInPath

Boolean

TRUE: For every Contentrepository a directory will be created and documents and / or corresponding sub-directory-trees will be attached into this directory.

FALSE: Leading Contentrepository-directory will not be created.

FALSE

DocumentMetaDataRepresentation

Boolean

FALSE: The metadata of an filed document will be stored as content of the file.

TRUE: The metadata of an filed document will be stored as metadata of a 0-byte file.

TRUE

UseFlatStylePath

Boolean

TRUE: If this options is enabled KGS Store won't build a substructure tree, but save all files inside a single directory.

FALSE: If this option is being disable KGS Store will build a structure of sub-directory which represent the DocumentID.

In case of Hitachi Vantara HCP storage system we recommend to set this parameter to FALSE!

TRUE

HCPMode

Boolean

Changes the behavior, how the content type is being commited.

Please note: HCPMode is not related to HCPRetentionMode!

TRUE: Content type is being committed as a user-meta-data-field.

FALSE: Content type is committed as a normal content type.

FALSE

HCPRetentionMode

Boolean

Enables or disables hardware-based retention on HCP.

Please note:

In order to use HCP retention, the following has to be done ( depends on the version of your HCP and whether it’s on-premise or within the cloud! ):

  • The HCP-bucket has to has file locking enabled

  • The parameter “LockFiles” has to be true

  • Retention has to be set!

TRUE: Enables hardware-based retention on HCP.

FALSE: Disables hardware-based retention on HCP.

FALSE

ServerSideEncryption

Boolean

Enables or disables the server-side encryption with the 256-bit Advanced Encryption Standard (AES-256).

FALSE: Disable Serverside Encryption (SSE)

TRUE: Enables the Serverside Encryption with Default AES_256

In order to use server-side encryption, on Bucket-Level, the “Default encryption” must be enabled (See: https://docs.aws.amazon.com/AmazonS3/latest/user-guide/default-bucket-encryption.html )

FALSE

→ Configuration (Store) - StorageTypes - ArchiveLink

  • No labels