When a Digital article is published, a package of article files and metadata is gathered and sent to the publish channel endpoint: the publish package.
The contents of this package is described in this article.
Publish (SNS) message
Publishing to a channel works by sending an AWS SNS message to the channel endpoint (for details, see The process of publishing Digital articles in Studio).
The publish message contains general information about the published articles and references to the article files.
|
Example message: |
Information about the top level fields can be found in the AWS SNS specification.
The following table shows the message properties specification:
| Property | Description |
|---|---|
| id | Object ID of the Digital article. This is unique for each Studio Server (see systemId). |
| name | Name of the article. |
| url | Download URL of the article files package (see later in this article), in ZIP format.1 |
| metadataUrl | Download URL of the metadata for the Digital article, in JSON format.1 |
| articleJsonUrl |
Download URL of the Digital article, in JSON format.1 Optional: Only provided when the 'JSON' export format is selected in the channel configuration. |
| componentSetInfo |
componentSetInfo.url. Download URL of the Component set information (see later in this article), in JSON format.1 componentSetInfo.eTag. ETag (unique ID) which changes when the Component set information changes. Can be used for caching purposes. |
| customData |
customData.url. Download URL of the custom data package, in ZIP format.1 customData.eTag. ETag (unique ID) which changes when the Component set is updated. Can be used for caching purposes. Optional: only provided when the Component set contains custom data. |
| systemId | The unique system ID of the Studio installation. |
| brand | The ID of the Studio Brand that the article is part of. |
| channelData |
String containing custom channel data, as configured in the publish channel. Optional: only provided when the channel has custom data configured. |
| bulkRef |
bulkRef.id Unique id for the bulk publish operation. bulkRef.articleIds All article ids included in the bulk publish operation, to inform the publishing endpoint about the complete list of articles being published. It always includes the id of the current article being published. The order of the articleIds is random and there is no guarantee on the order of which the notifications are sent out. Optional: Only provided when publishing multiple articles in bulk. |
1 This URL can be accessed up to 24 hours after the publish channel has received the message.
Articles file package
The article files package is a ZIP file containing articles and article renditions (HTML, PSV). Which files are included in the package depends on the options selected in the channel configuration.
The following publish package contains all possible export formats:
The formats and folders are explained in the following table:
| File / folder | Description |
|---|---|
| manifest.xml |
Manifest file in XML format that lists all resources (files) in the package. This file should be used when doing any form of post processing on the package as it defines the contract of what is provided. Integrations should always query the manifest file and not make any assumptions on the file (names) directly as listed in this table. |
| metadata.json | Metadata for the Digital article, in JSON format. |
| article.json |
The Digital article, in JSON format. Optional: only provided when the 'JSON' export format is selected in the channel configuration. |
| output.html |
HTML rendition of the Digital article. Optional: only provided when the 'HTML' export format is selected in the channel configuration. |
| output.psv |
PSV (Prism Source Vocabulary) rendition of the Digital article. For information about the mapping between the Digital article components and the prism fields, see Mapping between Digital article components in Studio and PSV classes. Optional: only provided when the 'PSV' export format is selected in the channel configuration. |
| img/* |
Images placed on the article. These images are referenced in the article.json file and the output renditions. Optional: only provided when the 'HTML' or 'PSV' export format is selected and the 'Reference images by ID only' option is deselected in the channel configuration. |
| template/<unique-id>.js |
Compiled Javascript file referenced by the HTML rendition. Combines the individual scripts defined in the component set. Optional: only provided when the 'HTML' export format is selected in the channel configuration. |
| template/design.css |
Compiled CSS file referenced by the HTML rendition. Combines the individual SCSS files for the selected article look-and-feel style. Optional: only provided when the 'HTML' export format is selected in the channel configuration. |
| template/img/* |
Images defined in the Component set referenced by the HTML rendition. Optional: only provided when the 'HTML' export format is selected in the channel configuration. |
Component Set information
The Component set information is a composite of the information from the Component set: the components definition and the component templates. It is a JSON file specifying field and property information per component.
This information can be used to interpret the components of the Digital article format, which can be useful when post-processing the article to fit the output channel.
|
Example: The following is an example of the Component set information: |
Comments
0 comments
Please sign in to leave a comment.