close

Filter

loading table of contents...

Deployment Manual / Version 2404

Table Of Contents

3.4.1 Studio Configuration

The following list contains configuration properties for the Studio.

studio.auto-logout.delay
Type java.time.Duration
Default 1800s
Description

The delay before a Studio session is automatically disconnected after inactivity. Inactivity is checked on the client. Set to 0 to disable auto logout (not recommended). For clients that cannot reach the Studio web application, the timeout of the server session determines the timeout of the Studio session.

studio.bulk-operation-thread-pool.max-threads
Type java.lang.Integer
Default 10
Description

Maximum number of threads to use for the bulk operation thread pool.

studio.cloud.enable
Type java.lang.Boolean
Default false
Description

Whether to enable cloud support.

studio.dashboard-refresh-interval
Type java.time.Duration
Default 30000ms
Description

The interval at which the dashboard is refreshed when visible (0 to disable automatic refresh).

studio.default-picture.content.paths
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

Configure {@link com.coremedia.cap.content.Content} property paths that point to picture blobs. Paths are given per {@link com.coremedia.cap.content.ContentType}, e.g. 'studio.default-picture.content.paths.CMPicture=data'. The mechanism is recursive: it is possible to configure a path to other {@link com.coremedia.cap.content.Content} items, e.g. 'studio.default-picture.content.paths.CMTeasable=pictures'.

studio.default-picture.resolving.enabled
Type java.lang.Boolean
Default true
Description

Configure whether server-side default picture resolving is enabled.

studio.default-time-zone
Type java.lang.String
Default Europe/Berlin
Description

Default time zone in CoreMedia Studio. Make sure that the default time zone is included in the studio.timeZones list. Defaults to 'Europe/Berlin'.

studio.differencing.max-markup-size
Type org.springframework.util.unit.DataSize
Default 300000B
Description

The maximum size of a markup object (in bytes as default unit) for which differences with other markup can be computed. By default, this value is set to 300,000 bytes, which amounts to approximately 15,000 words.

studio.expose-license-info
Type java.lang.Boolean
Default false
Description

Whether to expose license information along with the system information.

studio.jobs.max-threads
Type java.lang.Integer
Default 10
Description

Maximum number of threads to use for the jobs service thread pool.

studio.locales
Type java.util.List<java.lang.String>
Default en,de
Description

A comma-separated list of locales from which the user can choose the locale in which the Studio is displayed. If unset, the list locales defaults to English or German.

studio.login-url
Type java.lang.String
Default  
Description

If non-empty, a URL to which the Studio client should redirect a user who is not yet logged in. This supports single-sign-on solutions using an external login page. If empty, Studio shows a login form itself.

studio.preview-controller-pattern
Type java.lang.String
Default preview?id={0}
Description

Get the preview controller pattern. If it is empty or not defined, then use the default preview controller pattern.

studio.preview-url-prefix
Type java.lang.String
Default  
Description

The URI prefix of the CAE preview web app. This prefix is used to compose preview URIs for contents, assuming that a standard CAE preview controller is mapped at the path 'preview'. Since studio and cae are usually deployed as independent spring boot application or as a containerized application (docker/kubernetes), it is necessary to provide an absolute URL to load the preview, like 'https://your-host-name.com:40980/blueprint/servlet'

studio.preview-url-whitelist
Type java.util.List<java.lang.String>
Default  
Description

Configures a list of valid preview origins. The preview integration does only work for contents from listed origins. Wildcards (*) may be used for valid origin entries. If left blank (or if the property is not listed at all), the origin of studio.previewUrlPrefix is the only accepted origin. The URLs of the preview origins must not contain a trailing slash. NOTE: Once a whitelist is configured, the Studio has no chance to set a target origin in outgoing messages anymore. Be aware that this is a minor security drawback. EXAMPLE: studio.previewUrlWhitelist=https://host1:port1,\ https://host2:port2,\ http://localhost.*,\ *.company.com Enabling Elastic Social tenants in the embedded preview requires including a placeholder CoreMedia Studio then replaces the token with the current tenant. In a Blueprint related project, this could be: studio.previewUrlPrefix=http://{0}.localhost:40081/blueprint/servlet

studio.rest.changeset-max-iterations
Type java.lang.Integer
Default 10
Description

Maximum number of iterations to complete a change set.

studio.rest.invalidation-source.caplist.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.content.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.model.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.notification.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.project.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.system.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.timeout
Type java.time.Duration
Default 20000ms
Description

The timeout to wait for new events to be propagated via the invalidation sources.

studio.rest.invalidation-source.todo.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.invalidation-source.workflow.capacity
Type java.lang.Integer
Default 10000
Description

The capacity of the invalidation source.

studio.rest.network.max-requests
Type java.lang.Integer
Default 15
Description

The maximum amount of parallel pending requests executed to one host.

studio.rest.search-service.default-search-limit
Type java.lang.Integer
Default 5000
Description

The default search limit;

studio.rest.search-service.max-search-limit
Type java.lang.Integer
Default 80000
Description

The maximum search limit

studio.rest.search-service.replace-special-characters-in-prefix-or-wildcard-query
Type java.lang.Boolean
Default true
Description

Whether special characters in prefix and wildcard queries (queries ending with * or containing *) are replaced by spaces. Replacing characters makes sense because Solr does not analyze prefix and wildcard queries in the same way as it indexes text when configured with the StandardTokenizer. By replacing these characters, indexed text can still be matched and queries return the expected hits. However, it can make sense to disable this setting, if Solr is configured to preserve special characters in indexed text.

studio.struct-as-blob-property-names
Type java.util.List<java.lang.String>
Default  
Description

List of struct property names which are to be handled as struct properties by the client.

studio.supported-locales-variable-name
Type java.lang.String
Default joo.localization.supportedLocales
Description

The variable name of the supported locales javascript snippet as expected by the client. Defaults to 'joo.localization.supportedLocales'.

studio.time-zones
Type java.util.List<java.lang.String>
Default Europe/Berlin
Description

Supported time zones in CoreMedia Studio. Provide a comma separated list of supported Java time zone IDs. Defaults to 'Europe/Berlin'.

studio.translation.max-dependent-content-iterations
Type java.lang.Integer
Default 100
Description

Defines how deep links should be followed, when calculating dependent content. Can be overridden via content setting.

studio.translation.max-dependent-contents
Type java.lang.Integer
Default 100
Description

Defines how many dependent contents will be returned in "Translation Workflow Start window" when starting a translation workflow. Can be overridden via content setting.

studio.translation.show-start-window
Type java.lang.Boolean
Default true
Description

Configures Pull Translation (translation into preferred site) behavior: When set to true the workflow dialog is displayed, otherwise the workflow is started automatically.

studio.upload.default-blob-property
Type java.lang.String
Default data
Description

The default blob property name of the default content to be used for bulk uploads, used if no mapping is found in the upload settings defined in content. Defaults to 'data'.

studio.upload.default-content-type
Type java.lang.String
Default CMDownload
Description

The default content type to be used for bulk uploads, used if no mapping is found in the upload settings defined in content. Defaults to 'CMDownload'.

studio.upload.upload-settings-struct-property
Type java.lang.String
Default settings
Description

The name of the struct property to be used when the UploadSettings document is read. Defaults to 'settings'.

studio.validate-before
Type com.coremedia.rest.cap.config.ValidatedActionLevel
Default  
Description

Defines which content actions are not allowed if the content has error issues. As some actions are in a dependency relationship (e.g. APPROVE depends on CHECKIN), only the least inclusive actions need to be declared (e.g. CHECKIN entails the check of CHECKIN and APPROVE actions). Currently, the only supported OPTIONS are CHECKIN, APPROVE or nothing for no restriction. Defaults to APPROVE, i.e. content approval and publication is not allowed in case of error issues.

studio.workflow.validation.start-validators.simple-publication
Type java.util.List<java.lang.String>
Default publicationContentRightsWorkflowValidator,publicationNoAssigneeValidator,publicationSessionUserRightsWorkflowValidator,publicationWorkflowUndoWithdrawValidator,publicationContentIssuesValidator
Description

List of bean names to use in simple publication workflow start validation. The bean names must map to

com.coremedia.rest.cap.workflow.validation.WorkflowValidator

beans. Validators will be executed in the order given in the list. The list must not be empty.

studio.workflow.validation.start-validators.synchronization
Type java.util.List<java.lang.String>
Default emptyParametersValidator,derivedSyncSitesWritableValidator,contentSitesValidator,contentStateValidatorForTranslationWFStart,contentHasMasterAndLocalePropertyValidator,masterSiteManagedByCurrentUserValidator
Description

List of bean names to use in synchronization workflow start validation. The bean names must map to

com.coremedia.rest.cap.workflow.validation.WorkflowValidator

beans. Validators will be executed in the order given in the list. The list must not be empty.

studio.workflow.validation.start-validators.translation
Type java.util.List<java.lang.String>
Default emptyParametersValidator,sitesManagedByCurrentUserValidator,contentSitesValidator,contentStateValidatorForTranslationWFStart,contentHasMasterAndLocalePropertyValidator,contentAlreadyInTranslationValidator
Description

List of bean names to use in translation workflow start validation. The bean names must map to

com.coremedia.rest.cap.workflow.validation.WorkflowValidator

beans. Validators will be executed in the order given in the list. The list must not be empty.

studio.workflow.validation.start-validators.two-step-publication
Type java.util.List<java.lang.String>
Default publicationContentRightsWorkflowValidator,publicationNoAssigneeValidator,publicationSessionUserRightsWorkflowValidator,publicationWorkflowUndoWithdrawValidator,publicationContentIssuesValidator
Description

List of bean names to use in two-step publication workflow start validation. The bean names must map to

com.coremedia.rest.cap.workflow.validation.WorkflowValidator

beans. Validators will be executed in the order given in the list. The list must not be empty.

studio.xml-filters.enable-multi-class-span-filter
Type java.lang.Boolean
Default false
Description

Enables a filter for CoreMedia RichText 1.0, which splits up spans with multiple classes to dedicated spans, each with a single class only. This filter should be enabled for CKEditor 4 and should be disabled for all later versions of CKEditor or alternative rich text editing component frameworks.

Table 3.23. Studio Properties


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.