Studio Developer Manual / Version 2304
Table Of ContentsIn contrast to the generic URI template preview provider, the generic preview URL service provider does not provide the URL to the previewable content. Instead, the URL to an external preview URL service is provided, which is responsible to deliver the effective preview URL for the content.
The URL to the preview service is configured very similar to the generic URI template preview provider. The provided URL of the preview URL service is extended by client side runtime query parameters for example like this:
https://my-preview-url-service.de/previewurl/550?contentType=CMChannel&previewDate=XXXX& view=XXX&userVariant=&userVariantTS=1592902149681&p13n_test=true&contentTimestamp=48634
In this example, the full querystring was appended by the Studio client to the URL of the basic preview URL service ('https://my-preview-url-service.de/previewURL/550').
The appended querystring is added at runtime and cannot be altered. An external preview URL service has to implement this 'contract'. This means, if the service has to support, for example, the preview date, it has to use the predefined date format and the query parameter name 'previewDate'.
In order to enable the generic preview URL service provider, add a struct to the 'previews' array with these keys:
- id
Freely choosable, unique preview ID, 'myPWAPreviewUrlService', for example
- providerId
previewUrlServicePreviewProvider
- displayName
Non localized display name for the preview selection, 'PWA Preview', for example
- enabled
true