Skip to main content
Skip table of contents

ConfigurationModel

Model to access parts of the online-channel configuration.

implements: hash
bundle: standard information structure (sismodel)
since 5.2.0
Model to access parts of the online-channel configuration.

Model gives access to some config values from SisConfiguration.

All accessible elements are defined in the global namespace 'custom.configuration' and therefore prefixed with it.

custom.configuration.defaultcontext ↦ String
since 5.2.0
get the configured default context to use ('website', 'app' or 'print')

custom.configuration.fallbacklocales ↦ sequence of Locale wrapped as freemarker-BeanModels
since 5.2.0
get list of locales defined for this website

custom.configuration.field(String:xpath)FieldModel
since 5.3.0
get attribute of configuration xml

  • Example:
    custom.configuration.segment('foo/bar/@title') - get value of attribute 'title' in segment with xpath 'foo/bar'

custom.configuration.segment(String:xpath)NodeModel
since 5.2.0
get segment of configuration xml

  • Example:
    custom.configuration.segment('foo/bar') - get xml segment with xpath 'foo/bar'

Videos

custom.configuration.defaultvideoshortkey
since 5.6.0
get default defined video storage short-key

custom.configuration.videoshortkeys ↦ sequence<String>
since 5.2.0
get list of defined video storage short-keys

custom.configuration.mapvideoshortkey(String:storageKey)String
since 5.2.0
get the storageName for given 'storageKey' and optional parameter 'aspectRatio' from configuration

  • Example:
    custom.configuration.mapvideoshortkey(shortName, aspectRatio) - get the storage name for given 'shortName' and 'apectRatio'
    custom.configuration.mapvideoshortkey('720p', '4-3') - may return something like 'foo:content-720p_4-3'

Images

custom.configuration.imageshortkeys ↦ sequence<String>
since 5.2.0
get list of defined video storage short-keys

custom.configuration.mapdefaultaspectratio(String:context)String
since 5.2.0
get the configured default aspect ratio for given context

  • Example:
    custom.configuration.mapdefaultaspectratio('website') may return '16-9'

custom.configuration.mapimageshortkey(String:storageKey, String:aspectRatio)String
since 5.2.0
get the storageName for given 'storageKey' and optional 'aspectRatio' from configuration

  • Example:
    custom.configuration.mapimageshortkey(shortName, aspectRatio) - get the storage name for given 'shortName' and 'apectRatio'
    custom.configuration. mapimageshortkey('large', '4-3') - may return something like 'foo:content-l_4-3'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.