Common Settings
In order to use StorageFS with a database, please set in [COMMON SETTINGS] section the parameter StorageType = 3.
Filesystem structure
KGS Store will create a directory tree which depends on the parameter FolderDepth. In the lowest subfolder the document data file will be saved.
Database structure
KGS Store uses three tables for storing all needed component and document information
Table: <Prefix_>DOCUMENT
Field name | Field value | Type | Description |
---|---|---|---|
CSREPID (Index) | VARCHAR(40) | SAP ContentRepositoryID | |
DOCID (Index) | VARCHAR(40) | SAP DocumentID | |
ALVERS | 4500 | VARCHAR(4) | ArchiveLink-Version 0031 / 0045 |
PROTECTION | VARCHAR(4) | SAP ProtectionFlag | |
CREDATETIME | DATE | SAP creation timestamp | |
MODDATETIME | DATE | SAP modification timestamp | |
RETDATE | CHAR(8) | Retention Date | |
BARCODE | CHAR(40) | SAP barcode (for future use) |
Table: <Prefix_>COMPONENT
Field name | Field value | Type | Description |
---|---|---|---|
CSREPID (Index) | VARCHAR(40) | SAP ContentrepositoryID | |
DOCID (Index) | VARCHAR(40) | SAP DocumentID | |
COMPID (Index) | VARCHAR(512) | SAP CompID | |
ALVERS | 4500 | VARCHAR(4) | ArchiveLink-Version 0031 / 0045 |
CREDATETIME | DATE | SAP creation timestamp | |
MODDATETIME | DATE | SAP modification timestamp | |
RETDATE | DATE | Retentiondate | |
APPVERS | VARCHAR(80) | SAP Application Version | |
COMPTYPE | VARCHAR(80) | SAP Mimetype | |
CHARSET | VARCHAR(80) | SAP Charset | |
FILESIZE | NUMBER | ||
FILEN | VARCHAR(512) | Filename in file system (if CONTAINERFILE is not empty, Filename of a ZIP Container) | |
ORGFILEN | VARCHAR(512) | Original filename | |
CONTAINERFILE | VARCHAR(255) | Filename in container (if container | |
HASHALG | VARCHAR(10) | Hash algorithm | |
HASKEY | VARCHAR(128) | Hash key | |
HASHALGCONTFILE | VARCHAR(10) | Hash algorithm container file | |
HASHKEYCONTFILE | VARCHAR(128) | Hash key container file |
Table: DOCUMENT_KEYS
Field name | Field value | Type | Description |
---|---|---|---|
NAME (Index) | VARCHAR(40) | Key name | |
VALUE (Index) | VARCHAR(255) | Key value | |
CSREPID (Index) | VARCHAR(40) | SAP ContentrepositoryID | |
DOCID (Index) | VARCHAR(40) | SAP DocumentID |
Parameter | Value | Description |
---|---|---|
ArchPath | Defines the path, where documents will be stored. Can be specified per ContentRepository by adding a trailing "_<ContentRepository>" Example: ArchPath_H8 = /opt/storage Multiple path configurations are possible by adding a "#<number>" between ArchPath and potential trailing repository specification. Example: ArchPath#1_T1 = /opt/storage ArchPath#2_T1 = /home/temp/storage_T1 | |
ContainerCachePath | Cachepath for Containeroptin | |
ContainerMaxDocSizeMB | Integer | Documents with a size more than this limit (in MB) will be stored as a single file (not in a Container) |
ContainerMaxMB | Integer | Sizelimit for a container |
ContainerMaxFiles | Integer | 0 = Containermode disabled Can be specified per ContentRepository by adding “_<ContRep>”. Example: ContainerMaxFiles_T1=500 |
ContainerCacheMaxTime | Integer | Maximum time in seconds after a container will be closed when no new archiving request arrives. |
ContRepInPath | true / false | Repository ID in document filing structure Recommendation: TRUE |
EnableComponentMove | true / false | Move files instead of copying to ArchPath. If this option is being enabled it increases the performance if the working directory of the ContentServer and the defined ArchPath are on the same hard disk. |
EnableFileDelete | true / false | If file delete is not enabled, the da-taset in the database will be deleted by a delete request, but the corresponding component file remains in the filesystem |
EnableFilesWithExtension | true / false | Datafilenames with fileextention (depending on MIMEType) |
RetentionPeriod | Integer | Defines the amount of time (in months) from date of filing until which deletion should be prevented.. Retention periods can be set per ContRep and per document mime time. Example: RetentionPeriod_MX=36|application /x-alf=1000|application/x- reo=5|image/tiff=6 |
FolderDepth | Integer | Folder depth. Default: 2 |
FolderMax | Integer | Defines the maximal possible number of entries per Node. Default: 1000 |
FolderMaxFiles | Integer | Defines the maximal possible number of files in a folder. |
FolderPrefix | String / Char | <yyyyMMdd> = Dateprefix in folderstructur. Example:\ArchPath\T1\20110825\0000\0000\document.pdf Default: Empty |
DB-URL | String / Char | Connection URL for DB. This Parameter is optional. Sample for Oracle: jdbc:ora-cle:thin:@169.254.25.100:1521:KGSSTORE |
DB-Driver | String / Char | JDBC driver name. if (DB-URL not set) |
DB-Server | String / Char | IP address or DNS name data-base server. if (DB-URL not set) |
DB-Port | String / Char | Port database listener. if (DB-URL not set) |
DB-SID | String / Char | Database system id. if (DB-URL not set) |
DB-USER | String / Char | Database username |
DB-PASSWORD | String / Char | Database user password The password will be encrypted after first start. |
DB-TableNamePrefix_xx | String / Char | Prefix Table Document, Component xx (CRID) Default Prefix: ContentrepositoryID |
DisableFullPath | true / false | True = document reference in data-base is relative to parameter Arch-path. Otherwise the full path to the document will be stored. |
Repositories | String / Char | Repositories for which database ta-bles may be created automatically. (comma-separated) Sample: T1,T2,T3 |
LockFiles | true / false | Lock files at file system is retention activated |
IgnoreContRepID | List of RepositoryIDs | List of comma-separated Repository-ID’s. For this repository the key CSREPID will be ignored for database accesses, so the Document-ID will be the unique key to the document. |
ChangeRepositoryIDs | List of RepositoryIDs | Repository ID’s to change, comma- separated. This parameter works only in combination with parameter IgnoreContRepID. If a document is archived with one of these ID’s, the first access to this document with a different ContentRepID will over-write the repository information in the document info file. |