3.3.5CMSPublished service

The CMSPublished service implements the complete API of the CMSService but for getting documents it only delivers the latest published versions of the documents. But there is also a config key that allows a temporary switch to access all current non published versions of the documents if needed.

The service mainly is used by Generator services generating only published document contents.

Property file and property key paths are:

Service properties file

<cmsWorks-installdir>/run/properties/cms.properties

Service property key paths

/app/cmsworks/service/cms/CMSPublished/

 

Entry

Value

Description

Preview

false

Normally this is set to false to meet the purpose of this service delivering only the latest published versions of documents. If set to true, it's just working like the CMSService.

CMSServiceName

CMSCore

This is the name of the service that provides access to CMS documents.

Here is a full example of the CMSPublished configuration:

# ########################################################################################
# 
# Properties for the service giving a generator service a view of only published resources
#
# ########################################################################################
# hook service   /app/cmsworks/service/cms,CMSGeneratorView
# service create /app/cmsworks/service/cms,CMSGeneratorView,CMSPublished

/app/cmsworks/service/cms/CMSPublished/StartTimeout=10000
/app/cmsworks/service/cms/CMSPublished/StopTimeout=10000
/app/cmsworks/service/cms/CMSPublished/AccessTimeout=1000
/app/cmsworks/service/cms/CMSPublished/StopInformExtern=1
/app/cmsworks/service/cms/CMSPublished/LogLevel=fatal error info

/app/cmsworks/service/cms/CMSPublished/Preview=false
/app/cmsworks/service/cms/CMSPublished/CMSServiceName=CMSCore

Configuration example of the CMSPublished Service an API-Filter for only published documents