serviceConfiguration.json

System configuration file with parameter sets determining the behavior of the CONTENTANALYZER and AUDIT service.

Characteristics

Profile NameserviceConfiguration.json
Referenced by Servicescontentanalyzer,api,audit
Storage LocationGit system directory 

Parameters

The following parameters are available for the individual services:

ServiceParameterDescriptionExample
contentanalyzer

Section of Parameters determining the default behavior of the CONTENTANALYZER service. The analysis of the content and/or mimeType can be requested or not, depending on defined conditions. If a condition matches during an import process, the content and/or mimeType will be analyzed.

Note: Within the import request body, this configuration can be overwritten by specifying the options parameters accordingly. The analysis of content and/or mimeType can be requested or suppressed even if the opposite behavior is configured in the file serviceConfiguration.json.

See default configuration below.





skipDecides whether the service is used (false) or bypassed (true).
analyzeA list of property groups defining a specific behavior of the service depending on a conditions. For each condition, the determination of the mimeType and the text extraction can be activated or deactivated.
>> Content Stream Properties

predicateA condition specified in Spring Expression Language (SpEL).
mimetypeDecides whether the mimeType will be determined (true) or not determined (false) if the condition matches.
content

Decides whether the synchronous full-text extraction will be determined (true) or not determined (false) if the condition matches.

auditOptional section of parameters determining the behavior of the AUDIT service. If not specified, all actions are documented in the individual DMS object's audit trail.
>> Audit Trail - an "Object's History"
"audit": {
		    "skipAuditEntryCreation": false,
			"exclusions": {
				"actions": [401,301,101]
			}
		}

skipAuditEntryCreationBoolean value that decides whether the creation of all audit entries is skipped (true) or not (false).
exclusionsA section of properties that can be used to specify events that should not be documented in the audit trail.

actionsA list of Integer action codes. The corresponding actions are not documented in the audit trail.
>> Available action codes
apiasynchronousDeletion

A boolean value that specifies if the API gateway should delete DMS objects synchronously (false - default) or asynchronously (true). If true, the users' waiting time is reduced especially for deletion processes of objects with many old versions or large images as binary content files. The deletion request waits only for the success of the first deletion step: the objects to be deleted receive the OBJECT_FLAGGED_FOR_DELETE flag and are thus not retrievable for users anymore. Afterwards, a background process can delete the objects with this flag from the search index, database and repository (if necessary).
>> DELETE /api/dms/objects/{objectId} DELETE /api/dms/objects

"api": {
    "asynchronousDeletion": true
}

Default configuration:

Default serviceConfiguration.json
{
    "services": {
        "contentanalyzer": {
            "analyze": [				
                {
                    "predicate": "spel:(properties != null && properties['Name'] != null && properties['Name']['value'] == 'disable') ? true : false",
                    "mimetype": true,
                    "content": false
                },				
                {
                    "predicate": "spel:(contentStreams != null && contentStreams.size() > 0 && contentStreams[0]['range'] != null && contentStreams[0]['range'].length() > 0) ? true : false",
                    "mimetype": false,
                    "content": false
                }
            ]
        }
    }
}