REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... ·...

49
REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2

Transcript of REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... ·...

Page 1: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010

WNE v.4.2

Page 2: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .
Page 3: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

3

Table of Contents 1 Introduction ......................................................................................................................................... 6

1.1 Background................................................................................................................................. 6 2 Quick Start Usage Section ................................................................................................................. 7

2.1 Unique identifiers ....................................................................................................................... 7 2.2 Updates - Version information .................................................................................................. 8

2.3 Video filename ........................................................................................................................... 8 2.4 Text transcript accompanying the video ................................................................................... 8

2.5 Priority ........................................................................................................................................ 9 2.6 Translations................................................................................................................................. 9

2.7 Language of the text transcript .................................................................................................. 9 2.8 Timestamp for the original content ........................................................................................... 9

2.9 Timestamp for current version of the content .......................................................................... 9 2.10 Usage terms................................................................................................................................. 9

2.11 Edit number .............................................................................................................................. 10 2.12 Location .................................................................................................................................... 10

2.13 Source of the video package .................................................................................................... 10 2.14 Source of the video................................................................................................................... 10 2.15 Dateline ..................................................................................................................................... 10

2.16 Service code.............................................................................................................................. 11 2.17 Slugline ..................................................................................................................................... 11

2.18 Headline .................................................................................................................................... 11 2.19 Company codes ........................................................................................................................ 11

2.20 Introduction............................................................................................................................... 11 2.21 More Information ..................................................................................................................... 12

2.22 Video caption............................................................................................................................ 12 2.23 Video format with accompanying audio details..................................................................... 12

2.24 Description of the video audio................................................................................................. 13 2.25 Video timeline .......................................................................................................................... 13

2.26 Source aspect ratio.................................................................................................................... 13 3 Structure of NML2 Document......................................................................................................... 15

3.1 Introduction............................................................................................................................... 15 3.2 High level structural overview ................................................................................................ 15

3.3 NewsMessage ........................................................................................................................... 15 3.4 Message Header........................................................................................................................ 15

Page 4: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

4

3.5 ItemSet ...................................................................................................................................... 15 3.6 Package Item............................................................................................................................. 16

3.7 Text NewsItem ......................................................................................................................... 17 3.8 Video NewsItem....................................................................................................................... 18

4 Reference Section ............................................................................................................................. 19 4.1 XPaths ....................................................................................................................................... 19

4.1.1 NewsMessage................................................................................................................... 19 4.1.2 Message Header ............................................................................................................... 19

4.1.3 PackageItem and tags common to NewsItems............................................................... 20 4.1.4 Text NewsItem................................................................................................................. 36

4.1.5 Video NewsItem............................................................................................................... 37 4.2 XPaths - Updated versions....................................................................................................... 41

4.2.1 PackageItem and text NewsItem..................................................................................... 41 4.2.2 Video newsItem ............................................................................................................... 44

4.2.3 Example ............................................................................................................................ 44 4.3 Xpaths – Translated Versions.................................................................................................. 45

4.3.1 PackageItem and text NewsItem..................................................................................... 45 4.3.2 Example ............................................................................................................................ 48

5 Appendix ........................................................................................................................................... 49 5.1 Service Codes ........................................................................................................................... 49

5.2 Date formats.............................................................................................................................. 49 5.3 Referenced Information ........................................................................................................... 49

Page 5: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

5

Glossary of Abbreviations and Terms

GUID Global Unique Identifier

MIME Multipurpose Internet Mail Extension

MNP Manual News package

NAR IPTC News Architecture [1]

NEP News Event Package

News Item A NML2 newsItem.

News Message The top-level NML2 element which wraps any Items.

NML2 IPTC NewsML-G2 [3]

Package Item A NML2 packageItem.

Primary Item packageItem or newsItem

SID Stream Id (Audio / Video)

USN Universal Story Number (Text / Composite)

W3C World Wide Web Consortium

WNE World News Express

XML Extensible Mark-up Language.

Page 6: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

6

1 Introduction

1.1 Background Unless otherwise stated, NewsML herein implies NewsML-G2 (NML2) [3], part of the IPTC G2 Family of Standards [2] based on the IPTC News Architecture (NAR) [1]. This document describes the structure of the Reuters-generated NML2 WNE XML file that you will receive. The XML file contains details of the video and text content of the product. Note that WNE also delivers a second format of XML file, termed an Advisory, which does not accompany a video. These files have a different structure which is not described here. This document aims to provide a quick indication of key relevant details in the XML file.

There is a detailed reference section indicating how to obtain the information from the XML file via the XPaths.

This document concentrates on the relevant NML2 fields relating to WNE. Note that the scope of NML2 [1], [2], [3] is broader than described in this document.

The version of NAR is v1.2 and the version of NML2 is v2.1.

Page 7: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

7

2 Quick Start Usage Section The following are key pieces of information which can be extracted from the NML2 file. Many of these are common to the packageItem and both newsItems (see Structure of NML2 Document). Use the packageItem version of the information where available.

See the Reference section to obtain the full XPaths for the pieces of information.

2.1 Unique identifiers Within the XML file for a story there are multiple identifiers that can be used for different purposes. The three main identifiers are for the package, text item, and video item. Each identifier is in the GUID attribute on the appropriate packageItem or newsItem. The GUID should be used in conjunction with the version attribute on each of these items to identify a specific revision of an item.

Additionally, there is a single field in each item with the full unique identifier for a specific revision. This field is the rtr:versionedId in the itemMeta of the appropriate packageItem or newsItem.

The unique identifier for a package should be used as the identifier for this specific XML document. This is illustrated below. <packageItem standard="NewsML-G2" standardversion="2.1" conformance="power" guid="tag:reuters.com,2007:newsml_WNEI6EJW8" version="1" xml:lang="en">

<itemMeta>

<rtr:versionedId guid="tag:reuters.com,2007:newsml_WNEI6EJW8:1" /> The unique identifier for a text item can be used to track updates to the script. This is illustrated below. <newsItem standard="NewsML-G2" standardversion="2.1" conformance="power" guid="tag:reuters.com,2007:newsml_WNEI6EJW9" version="1" xml:lang="en">

<itemMeta>

<itemClass qcode="icls:text" />

<rtr:versionedId guid="tag:reuters.com,2007:newsml_WNEI6EJW9:1" />

The unique identifier for a video item can be used to track updates to the video. This is illustrated below. <newsItem standard="NewsML-G2" standardversion="2.1" conformance="power" guid="tag:reuters.com,2007:newsml_LWNEI6E15GAJWA" version="1" xml:lang="en">

<itemMeta>

<itemClass qcode="icls:video" />

<rtr:versionedId guid="tag:reuters.com,2007:newsml_LWNEI6E15GAJWA:1" />

Page 8: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

8

2.2 Updates - Version information This relates to updated XML files. The version of the XML file is found in the packageItem.

Example of a first version: <packageItem standard="NewsML-G2" standardversion="2.1" conformance="power" guid="tag:reuters.com,2008:newsml_WNEI5ME8Q" version="1" xml:lang="en">

Example of a fifth, updated version: <packageItem standard="NewsML-G2" standardversion="2.1" conformance="power" guid="tag:reuters.com,2008:newsml_ WNEI5ME8Q" version="5" xml:lang="en">

Also indicative of an updated version is the tag: <signal qcode="edStat:U" /> or <signal qcode="edStat:C" />

And: <link rel="irel:prevVersion" residref="tag:reuters.com,2008:newsml_WNEI5LUE" version="4" contenttype="application/vnd.iptc.g2.packageitem+xml" rtr:id="WNEI5LUE" rtr:type="idType:USN" />

Note the reference to the GUID of the previous version.

For a more detailed example see the XPaths section for updated versions.

2.3 Video filename The name of the video file accompanying the XML file is located in a remoteContent block of the video newsItem. The specific tag in the remoteContent tag is illustrated below. <rtr:altId type="idType:fileBIN" rtr:isPresent="1" contentType="video/mpeg">123-PHILIPPINES-FERRY_AERIALS.mpg</rtr:altId>

2.4 Text transcript accompanying the video This is found in the body tag of the text newsItem: <inlineXML contenttype="application/xhtml+xml" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml">

<head> <title /> </head>

<body> <p>Zimbabwean opposition leader Morgan Tsvangirai has pulled out of a run-off

election against President Robert Mugabe, saying a free and fair poll was impossible in the current climate of violence.</p>

<p>SHOWS:</p> …

</body> </html> </inlineXML>

Page 9: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

9

2.5 Priority This is the priority in which the XML file and video is sent to the customer. The range of values is 1 -5 where 1 is the highest priority. A customer might set up a system to send an alert if an XML file and video with higher than normal priority arrives on their client system.

2.6 Translations A translated text transcript is indicated by the tag: <signal qcode="var:itemTrans" /> There is a reference to the GUID, and language, of the original version: <link rel="irel:translatedFrom" residref="tag:reuters.com,2008:newsml_WNEI5LHE"

version="2" contenttype="application/vnd.iptc.g2.packageitem+xml" rtr:id="WNEI5LHE" rtr:type="idType:USN">

<language tag="en" /> </link>

2.7 Language of the text transcript The language of the text transcript is specified in the xml:lang attribute of the inlineXML tag.

<inlineXML contenttype="application/xhtml+xml" xml:lang="ar"> <html xmlns="http://www.w3.org/1999/xhtml">

<head> <title /> </head> <body> <p> - - </p> …

2.8 Timestamp for the original content This is indicated by the firstCreated tag: <firstCreated>2008-06-22T16:45:40Z</firstCreated>

2.9 Timestamp for current version of the content This is indicated by the versionCreated tag: <versionCreated>2008-06-22T16:45:40Z</versionCreated>

2.10 Usage terms Usage terms are restrictions of use: <usageTerms xml:lang="en">NBC MATERIAL - NO ACCESS USA/CNN/YAHOO/AOL/WIRELESS</usageTerms>

Usage terms can also have time-specific restrictions: <usageTerms xml:lang="en">UP TO TWO (2) MINUTES NEWS ACCESS IN REGULARLY SCHEDULED, NON-SPONSORED TV BROADCAST SPORTS NEWS WITHIN 24 HOURS

Page 10: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

10

FROM END OF EACH DAY'S PLAY. NO OTHER FORM OF MEDIA BROADCAST RIGHTS GRANTED, NO IN-FLIGHT RIGHTS GRANTED, NO INTERNET RIGHTS GRANTED, NO ARCHIVE RIGHTS GRANTED. SUBSCRIBERS IN GERMANY MUST ONSCREEN COURTESY PREMEIRE SPORTS . THE COURTESY TO READ "BILDER VON PREMIERE SPORTS".</usageTerms>

Additionally, there are usage terms that can help with automated processing. You may see one or more usageTerms elements with a usage role of content. The possible values of this element are Online or Broadcast. For example: <usageTerms role="usageRole:content" xml:lang="en">Online</usageTerms>

<usageTerms role="usageRole:content" xml:lang="en">Broadcast</usageTerms>

Please note that the restrictions governing the use of some WNE content can be complex. Therefore, it is necessary to always read the descriptive usage terms field before broadcasting or publishing online.

2.11 Edit number Edit Number is a Reuters-specific short form item which is unique over a period of one week.

2.12 Location This designates the location(s) where the video content was shot. Use the literal attribute. <located literal="WASHINGTON D.C., UNITED STATES/ KADOMA, CENTRAL ZIMBABWE" xml:lang="en">

<name xml:lang="en">WASHINGTON D.C., UNITED STATES/ KADOMA, CENTRAL ZIMBABWE</name>

</located>

2.13 Source of the video package This is always Reuters. See infoSource. <infoSource role="cRole:origProv" literal="Reuters" />

2.14 Source of the video This is the original organization which owns the video content.

<infoSource role="cRole:source" literal="REUTERS / SABC" />

2.15 Dateline Dateline is often a single date: <dateline>JUNE 22, 2008</dateline>

but can be multiple dates: <dateline>JUNE 22, 2008, JUNE 21,2008</dateline>

The format can be different: <dateline>21.06.2008, 22.06.2008</dateline>

Page 11: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

11

The value does not have to be a date: <dateline>Recent</dateline>

2.16 Service code WNE is made up of services that group together content that will be of interest to particular broadcasters. Some services are based on the geographical origin of the stories (eg subcon) and some on their content (eg sports).

In general, each service is marked separately. A service is sold by feeds e.g. paying for sports gives access to all the sports feeds. See Service Codes section in Appendix. <subject qcode="rvnServiceCode:SP"> <name>Sports</name>

</subject>

2.17 Slugline A short meaningful reference to the article. <slugline xml:lang="en">EGYPT-OLMERT-MUBARAK</slugline>

2.18 Headline headline Is a brief description of what the story is about. It is more descriptive than the slugline. (See above) <headline xml:lang="en">Egypt says working for release of Israeli soldier.</headline>

2.19 Company codes Company code and company name. <subject qcode="R:DELL.O">

<name>Dell Inc.</name> </subject>

<subject qcode="R:MRVL.O"> <name>Marvell Technology Group Ltd.</name> </subject>

2.20 Introduction A short introduction. <description role="descRole:intro">Hillary Clinton claimed a convincing victory over Barack Obama in Sunday's Puerto Rico primary, a win that could very well be her last in the race for the Democratic nomination.</description> (This is only in use for a limited amount of content at present).

Page 12: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

12

2.21 More Information A longer introduction than the Introduction section above. <description role="descRole:moreInfo">Once the long primary season ends on Tuesday in South Dakota and Montana after five months of primaries and caucuses across the country, the Obama camp expects the superdelegates -- party officials who can back any candidate --to quickly line up behind him.</description> (This is only in use for a limited amount of content at present).

2.22 Video caption This is a caption specifically for the video content. It differs from the slugline in that it includes the edit number: <description role="descRole:videoCaption" xml:lang="en">731-ZIMBABWE-TSVANGIRAI_MDC</description>

2.23 Video format with accompanying audio details This gives detailed information about the video file. Details include:

format (typically mpeg), content type (MIME type), duration (in seconds), the audio codec used, the audio bit rate (in kbps), audio variable bit rate flag (A Boolean value which indicates whether the audio data is

encoded with a variable bit rate), the audio sample size (The number of bits per audio sample, e.g.16), the number of audio samples per second, expressed as a sampling frequency in Hz, the video codec used, the video average bit rate in bps (Used when the bit rate is variable), video variable bit rate flag (A Boolean value which indicates whether the video data is

encoded with a variable bit rate), the video scan technique used to produce the video (It can be progressive or interlaced), the video aspect ratio, e.g. 4:3 or 16:9, the video sampling method, the video rendition (specified as a colon separated string comprising:rend, videorendtion,

videoaveragebitrate, fileextension), the video definition (SD for Standard Definition and HD for High Definition)

<remoteContent residref="tag:reuters.com,2008:binary_LWNEI5L1EFYSB-STREAM:4500:MPG" format="fmt:mpeg" contenttype="video/mpeg" duration="226" audiocodec="codec:mpegLayer2" audiobitrate="224" audiovbr="false" audiosamplesize="16" audiosamplerate="48000" videocodec="codec:mpeg2mp@ml" videoavgbitrate="4500000" videovbr="false" videoscan="interlaced" videoaspectratio="4:3" videosampling="4:2:0" rendition="rend:stream:4500:mpg" rtr:definition="videoDef:SD">

</remoteContent>

Page 13: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

13

2.24 Description of the video audio Description of the audio component. Spoken language of the audio component (not the language in which the description tag is written). <description role="descRole:audio" xml:lang="en">NATURAL WITH ENGLISH SPEECH</description>

2.25 Video timeline The video item contains multiple partMeta sections describing aspects of the video timeline. Three key times described by the partMeta sections are the duration of the slate, the duration of the video content, and the location of one or more key frames. These are optional fields and under certain circumstances, there could be more than one XML block for a given role.

The timestamps are taken from the start of the slate. <partMeta>

<timeDelim start="00:00:00.000" end="00:00:05.000" timeunit="timeunit:normalPlayTime" />

<rtr:role qcode="partRole:slate" />

</partMeta>

<partMeta>

<timeDelim start="00:00:05.000" end="00:02:11.000" timeunit="timeunit:normalPlayTime" />

<rtr:role qcode="partRole:content" />

</partMeta>

<partMeta>

<timeDelim start="00:00:08.000" end="00:00:09.000" timeunit="timeunit:normalPlayTime" />

<rtr:role qcode="partRole:keyframe" />

</partMeta>

2.26 Source aspect ratio The package item contains a signal with the aspect ratio of the source material for a given video. All video files distributed through WNE will have an aspect ratio of 16:9. However source material could be a mixture of 16:9 and pillar boxed 4:3 or even entirely pillar boxed 4:3. This signal will allow for different video processing rules in an automated system depending upon the value of the source aspect ratio.

To find the source aspect ratio for a given clip, look for a signal in the itemMeta section of the packageItem in our XML. This signal will always have a “qcode” attribute with a prefix of “sar” and the possible values for the signal are “widescreen”, “pillarBox”, “mixed”, or “zoomed”. The XML will contain one of the following blocks.

1. For true 16:9 widescreen content: <signal qcode="sar:widescreen">

<name> Native widescreen 16:9</name>

Page 14: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

14

</signal>

2. For clips with only 4:3 content pillar boxed to be 16:9: <signal qcode="sar:pillarBox">

<name> Pillar box ARC 4:3</name>

</signal>

3. For a mixture of true 16:9 widescreen content and 4:3 content pillar boxed to 16:9: <signal qcode="sar:mixed">

<name> Mixed Pillar box ARC 4:3 and native widescreen 16:9</name> </signal>

4. For 4:3 zoomed to fit the width of 16:9: <signal qcode="sar:zoomed">

<name> Fit to width 4:3</name> </signal>

Page 15: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

15

3 Structure of NML2 Document

3.1 Introduction The NML2 XML file contains:

• Package Item: Referencing the following Items: • News Item (Text): A text transcript of the video

• News Item (Video): Video metadata and a reference to the video binary asset.

3.2 High level structural overview The NML2 XML file consists of three main parts. There is a single packageItem and 2 newsItem sections. There is also a header.

The packageItem contains overall details of the XML file. The text newsItem contains the text transcript with related details. The video newsItem contains metadata describing the video file, and a reference to the binary content. The three items are wrapped in an itemSet.

Visual representation of a NML2 News Message

3.3 NewsMessage The News Message contains a Message Header and an Item Set.

3.4 Message Header The header contains transmission-related information.

3.5 ItemSet The itemSet serves as a wrapper for the packageItem and its associated newsItems.

Visual representation of an itemSet

Page 16: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

16

3.6 Package Item The packageItem contains overall details of the XML file.

Visual representation of packageItem

Content Metadata

Urgency Content Sources Alternative Identifiers

Subject Codes

Geographical Locations

Excluded Audience

Language Newslines

Item Metadata

Item Class Publication Status Profile Notes

Item Provider Filename Service codes

Timestamps Content Generator Version details

Group

Item Reference - Video

Item Reference - Text Transcript

Group Group Reference

Group Set

Rights Information

Page 17: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

17

3.7 Text NewsItem

This newsItem contains the text transcript to the video and its related details.

Content Metadata Urgency Content

Sources Alternative Identifiers

Subject Codes

Geographical Locations

Language Newslines

Item Metadata Item Class Publication Status Profile

Item Provider Filename Links Timestamps Content Generator Version details

Rights Information

Inline Content - XML body

Content Set

Page 18: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

18

3.8 Video NewsItem

The video newsItem contains metadata describing the video file, and a reference to the binary content.

Content Metadata Urgency Content

Sources Alternative Identifiers

Caption

Language Audio Description

Item Metadata Item Class Publication Status Profile

Item Provider Filename Links Timestamps Content Generator Version details

Rights Information

Remote Content – Video properties Content Set

Part Metadata Time Delimiter Role

Page 19: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

19

4 Reference Section

4.1 XPaths

4.1.1 NewsMessage

The News Message contains a Message Header and an Item Set.

Tag Name @xmlns Purpose Default Namespace (xmlns): http://iptc.org/std/nar/2006-10-01/

XPath /newsMessage/header/@xmlns

Tag Name @xmlns:xsi Purpose W3C XML Schema Instance Namespace:

http://www.w3.org/2001/XMLSchema-instance

XPath /newsMessage/header/@xmlns:xsi

Tag Name @xmlns:rtr Purpose Reuters Namespace: http://www.reuters.com/ns/2003/08/content

XPath /newsMessage/header/@xmlns:rtr

4.1.2 Message Header

Tag Name header Purpose Contains transmission-related information.

XPath /newsMessage/header

Page 20: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

20

Tag Name sent XPath /newsMessage/header/sent

Tag Name sender Purpose The sender of the message (not necessarily the originator of the enclosed

items); differs from the provider.

XPath /newsMessage/header/sender

Tag Name transmitId Purpose Transmission Id; a system-generated News Message GUID, (within the

Message Sender’s domain).

XPath /newsMessage/header/transmitId

Tag Name priority XPath /newsMessage/header/priority

Tag Name channel Purpose Content Channel; the channel that the News Message will be ‘transmitted’

on.

XPath /newsMessage/header/channel

Tag Name destination Purpose The destination(s) for the all item(s) enclosed in the News Message.

Multiple Destinations are supported. (Destination codes exist purely to decide which group of customers are able to decode the encrypted video associated with the text transcript. Customers are not expected to use these codes).

XPath /newsMessage/header/destination

4.1.3 PackageItem and tags common to NewsItems Tag Name @standard Purpose The standard within the NAR.

XPath For packageItem:

/newsMessage/itemSet/packageItem/@standard For text newsItem:

Page 21: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

21

/newsMessage/itemSet/newsItem[itemMeta/itemClass[@qcode=’icls:text’]]/@standard For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass[@qcode=’icls:video’]]/@standard

Tag Name @standardversion Purpose Standard Version; the version of NewsML used.

XPath For packageItem:

/newsMessage/itemSet/packageItem/@standardversion

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/@standardversion

For video newsItem: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode='icls:video']]/@standardversion

Tag Name @conformance Purpose Conformance Level; defaults to ”power”.

XPath For packageItem:

/newsMessage/itemSet/packageItem/@conformance

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/@conformance

For video newsItem: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode='icls:video']]/@conformance

Tag Name @guid Purpose Unique Identifier for XML file, text transcript and video respectively.

XPath For packageItem:

/newsMessage/itemSet/packageItem/@guid For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/@guid For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/@guid

Page 22: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

22

Tag Name @version Purpose The version of the item. This will be incremented in subsequent updated

versions of a given item.

Xpath For packageItem:

/newsMessage/itemSet/packageItem/@version

For text newsItem: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/@version For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/@version

Tag Name @xml:lang Purpose This defines the language of the string data within the entire item, unless

(locally) overridden by descendant @xml:lang values.

Xpath /newsMessage/itemSet/packageItem/@xml:lang

NOTE

@conformance is explicitly set to “power”. Consumers of Reuters-generated NML2 will need to support Power model processing.

NOTE The @guid is different between a packageItem and each of

the newsItems.

4.1.3.1 catalogRef

Tag Name catalogRef/@href Purpose Contains a reference to Catalog Information which defines the scheme

references used by qcode tags within the XML file.

Xpath For packageItem:

/newsMessage/itemSet/packageItem/catalogRef/@href

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]

Page 23: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

23

/catalogRef/@href For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]] /catalogRef/@href

4.1.3.2 RightsInfo

Tag Name rightsInfo/copyrightHolder/@literal Purpose Party claiming intellectual property for the content. Value is “RTRS” for Reuters-

owned items.

XPath For packageItem:

/newsMessage/itemSet/packageItem/rightsInfo/copyrightHolder/@literal

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]] /rightsInfo/copyrightHolder/@literal

For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]] /rightsInfo/copyrightHolder/@literal

Tag Name rightsInfo/usageTerms Purpose Restrictions of use.

XPath For general usage terms: /newsMessage/itemSet/packageItem/rightsInfo/usageTerms

To determine if this item is for Online or Broadcast inspect the values of:

/newsMessage/itemSet/packageItem/rightsInfo/usageTerms[@role=’usageRole:content’] Please note that the restrictions governing the use of some WNE content can be complex. Therefore, it is necessary to always read the descriptive usage terms field before broadcasting or publishing online.

4.1.3.3 ItemMeta

Page 24: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

24

itemMeta for a packageItem Tag Name itemClass/@qcode Purpose The high-level item class indicating the content included/referenced by the

item. For a packageItem the value is “icls:composite”. This indicates that the package contains media of more than one type i.e. text and video.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/itemClass/@qcode For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]] /itemClass/@qcode For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode='icls:video']] /itemClass/@qcode

Tag Name provider/@literal Purpose The provider of the item (but not necessarily the content).

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/provider/@literal

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]] /provider/@literal

For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:video’]] /provider/@literal

Page 25: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

25

Tag Name versionCreated Purpose The date/time when the item was last updated. This is the timestamp for the

current version of the content. See Appendix for Date formats.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/versionCreated

For text newsItem: /newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]] /versionCreated For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode='icls:video']] /versionCreated

Tag Name firstCreated Purpose The date/time when the item was first created. See Appendix for Date

formats.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/firstCreated

For text newsItem: /newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]] /firstCreated For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:video’]] /firstCreated

Tag Name pubStatus/@qcode Purpose The high level status, defining whether the item is currently usable.

Values can be “usable”, “canceled” or “withheld”. “usable” - may be published without restriction.

“canceled” - MUST NOT be published or used under any circumstances. If already published, the publisher MUST take immediate action to withdraw or retract it. “withheld” - Until further notice: MUST NOT be published or used under any circumstances. If already published, the publisher MUST take immediate action to withdraw or retract it.

XPath /newsMessage/itemSet/packageItem/itemMeta/pubStatus/@qcode

Tag Name fileName Purpose The filename to use if this item is saved as a file.

Page 26: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

26

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/filename For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass[@qcode=’icls:text’]]/ filename

Tag Name generator Purpose The system/application generating the packageItem.

XPath /newsMessage/itemSet/packageItem/itemMeta/generator

Tag Name generator/@versioninfo Purpose Version of system/application generating the packageItem.

XPath /newsMessage/itemSet/packageItem/itemMeta/generator/@versioninfo

Tag Name profile Purpose The item profile, implying the structure of the item e.g. text, video. For WNE

the value is NEP-External_MNP which indicates News Event Package and Manual News package.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/profile For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass[@qcode=’icls:text’]] /profile For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass[@qcode=’icls:video’]] /profile

Tag Name profile/@versioninfo Purpose Version details relating to the profile.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/profile/@versioninfo

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass[@qcode=’icls:text’]] /profile/@versioninfo

For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass[@qcode='icls:video']] /profile/@versioninfo

Page 27: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

27

Tag Name service/@qcode Purpose The service associated with the packageItem, RTR_VID in this case.

XPath /newsMessage/itemSet/packageItem/itemMeta/service/@qcode

Tag Name signal[@qcode=”prodId:VID”] Purpose The Product Id with the item, VID in this case. This matches the channel

value in the header.

XPath /newsMessage/itemSet/packageItem/itemMeta/signal[ @qcode=’prodId:VID’]/@qcode

Tag Name signal[@qcode="sic:ATOMIC"] Purpose Special Indicator Code specifying that all items within the XML file should

be processed as an “atomic” XML file i.e. the items included in the XML file will only ever be sent as part of said XML file and not distributed as individual items.

XPath /newsMessage/itemSet/packageItem/itemMeta/signal[ @qcode='sic:ATOMIC']/@qcode

Tag Name rtr:versionedId/@guid Purpose Provides a GUID which is the colon-separated concatenation of the item

GUID and the item version. These parameters are both found in the attributes of the item tag (@guid and @version).

Example of a new version:

guid=”tag:reuters.com,2007:newsml_WNEI32JW:1”

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/rtr:versionedId/@guid

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass [@qcode=’icls:text’]]/rtr:versionedId/@guid

For video newsItem:

/newsMessage/itemSet/newsItem/itemMeta [itemClass [@qcode=’icls:video’]]/rtr:versionedId/@guid

Page 28: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

28

4.1.3.4 ContentMeta

contentMeta for a packageItem contentMeta defines content metadata which relate to the content within the packageItem. Tag Name urgency Purpose The urgency of the item. Note that the header/priority should reflect the highest

urgency of any Primary Items carried by newsMessage.

The default Urgency is 4.

Xpath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/urgency For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/urgency

Page 29: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

29

For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentMeta/urgency

Tag Name located/@literal Purpose Location(s) where the video content was shot.

XPath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/located/@literal

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/located/@literal

Tag Name name/@xml:lang Purpose Language of location.

XPath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/located/name/@xml:lang For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/located/name/@xml:lang

Tag Name infoSource Purpose Source of content.

XPath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/infoSource

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/infoSource

For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode='icls:video']]/contentMeta/infoSource

Tag Name infoSource[@role="cRole:origProv"]/

@literal XPath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/ infoSource[@role='cRole:origProv']/@literal

For text newsItem:

Page 30: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

30

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/infoSource[@role='cRole:origProv']/@literal

For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode='icls:video']]/contentMeta/infoSource[@role='cRole:origProv']/@literal

Tag Name infoSource[@role=”cRole:source”]/

@literal Purpose Source of the video.

XPath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/

infoSource[@role=’cRole:source’]/@literal For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta /infoSource[@role=’cRole:source’]/@literal For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentMeta /infoSource[@role=’cRole:source’]/@literal

Tag Name creator/@literal Purpose The creator of the content (but not necessarily the creator of the packageItem).

XPath For packageItem:

/newsMessage/itemSet/packageItem/contentMeta/creator/@literal For text newsItem:

/newsMessage/itemSet/ newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/creator/@literal For video newsItem:

/newsMessage/itemSet/ newsItem[itemMeta/itemClass [@qcode='icls:video']]/contentMeta/creator/@literal

Tag Name exclAudience Purpose The audience(s) for which the item MUST be filtered out.

XPath /newsMessage/itemSet/packageItem/contentMeta/exclAudience

Tag Name altId[@rtr:isOriginal=”1”] Purpose Alternative identifier of original item. Part of the item GUID string is generally used.

XPath For packageItem:

Page 31: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

31

/newsMessage/itemSet/packageItem/contentMeta/altId[ @rtr:isOriginal=’1’ ] For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/altId[@rtr:isOriginal=’1’] For video newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentMeta/altId[@rtr:isOriginal=’1’]

Tag Name altId[@type="idType:editNumber"]

Purpose Edit Number.

XPath /newsMessage/itemSet/packageItem/contentMeta/altId[@type='idType:editNumber']

Tag Name altId[@type=”idType:fileOrig”]

Purpose Original File name.

XPath /newsMessage/itemSet/ newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/altId[@type=’idType:fileOrig’]

Tag Name language/@tag Purpose Language of the content.

NB: Can be more than one language.

XPath /newsMessage/itemSet/packageItem/contentMeta/language/@tag

Tag

Name subject[contains(@qcode,”rvnServiceCode:”)]

Purpose Defines the Service abbreviation. For list of values see LongNoSuffix column in Service Codes section in Appendix.

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’rvnServiceCode’ ) ]/@qcode

Tag

Name subject[contains(@qcode,"rvnServiceCode:")]/name

Purpose Name of Service in full. For list of values see Service column in Service Codes section in Appendix.

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’rvnServiceCode:’ ) ]/name

Page 32: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

32

Tag Name subject[contains(@qcode,”WNSFR:”)] Purpose WNS Feed Reference. For list of values see FeedName column in Service Codes

section in Appendix.

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’WNSFR:’ ) ]/@qcode

Tag Name subject[contains(@qcode, "ISLC:")] Purpose iNews Sub-location Code. (List of possible values is outside the scope of this

document).

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’ISLC:’ ) ]/@qcode

Tag Name genre/name Purpose Description of type of content.

XPath /newsMessage/itemSet/packageItem/contentMeta/genre/name

Tag Name by XPath /newsMessage/itemSet/packageItem/contentMeta/by

Tag Name by/@xml:lang Purpose Language of by tag.

XPath /newsMessage/itemSet/packageItem/contentMeta/by/@xml:lang

Tag Name slugline XPath /newsMessage/itemSet/packageItem/contentMeta/slugline

Tag Name slugline/@xml:lang Purpose Language of Slugline.

XPath /newsMessage/itemSet/packageItem/contentMeta/slugline/@xml:lang

Tag Name headline XPath /newsMessage/itemSet/packageItem/contentMeta/headline

Tag Name headline/@xml:lang Purpose Language of Headline.

XPath /newsMessage/itemSet/packageItem/contentMeta/headline/@xml:lang

Page 33: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

33

Tag Name dateline XPath /newsMessage/itemSet/packageItem/contentMeta/dateline

Tag Name description[@role="descRole:videoCaption"]

XPath /newsMessage/itemSet/packageItem/contentMeta/description[@role=’descRole:

videoCaption’]

Tag Name description[@role=”descRole:

videoCaption”]/@xml:lang Purpose Language of Caption.

XPath /newsMessage/itemSet/packageItem/contentMeta/ description[@role=’descRole:videoCaption’]/@xml:lang

Tag Name subject[contains(@qcode,”R:”)] Purpose Company Code.

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’R:’ ) ]/@qcode

Tag Name subject[contains(@qcode,"R:")]/name Purpose Company name.

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’R:’ ) ]/name

Tag Name subject[contains(@qcode,”tvsc:”)] Purpose TV Service Code. Examples are: TOP (Top story); BIZ (Business Story); N/F

(News Feature); S/L (Sports and Leisure); A/E (Arts and Entertainment) and ODD (‘Oddly Enough’ stories).

XPath /newsMessage/itemSet/packageItem/contentMeta/subject[ contains( @qcode, ’tvsc:’ ) ]/@qcode

Tag Name description[@role="descRole:intro"] Purpose Short introduction.

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/description[(@role=’descRole:intro’ ) ]

Tag Name description[@role="descRole:moreInfo"]

Page 34: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

34

Purpose Longer introduction.

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentMeta/description[(@role=’descRole:moreInfo’ ) ]

4.1.3.5 GroupSet

Tag Name groupSet Purpose groupSet Defines the structure of the package by referencing the constituent items

i.e. newsItems.

A groupSet can contain a number of groups. The groupSet identifies the 'root' group. A group with an identifier matching the groupSet ‘root’ exists within the NML2 XML file.

XPath /newsMessage/itemSet/packageItem/groupSet

Tag Name group Purpose A group has a group role and a group identifier (id). A group can contain a number

of group references (groupRef) or item references (itemRef).

XPath /newsMessage/itemSet/packageItem/groupSet/group

Tag Name group[@role=”grpRole:NEP” and @id=”root”] Purpose This group matches the groupSet ‘root’.

XPath /newsMessage/itemSet/packageItem/groupSet/group[@role=’grpRole:NEP’ and @id=’root’]

Tag Name groupRef[@idref="main"] Purpose This groupRef references another group. The group with id ‘main’.

XPath /newsMessage/itemSet/packageItem/groupSet/group/groupRef[@idref='main']

Page 35: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

35

Tag Name group[@role=”grpRole:Main” and

@id=”main”] Purpose This group has id ‘main’.

XPath /newsMessage/itemSet/packageItem/groupSet/group[@role=’grpRole:Main’ and @id=’main’]

Tag Name itemRef/@residref Purpose GUID reference to a newsItem, in this case. This corresponds to the @guid attribute

of a newsItem.

XPath /newsMessage/itemSet/packageItem/groupSet/group/itemRef/@residref

Tag Name itemRef/@contenttype Purpose MIME type of the corresponding newsItem (in this case) to which the itemRef

relates.

XPath /newsMessage/itemSet/packageItem/groupSet/group/itemRef/@contenttype

Page 36: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

36

4.1.4 Text NewsItem

4.1.4.1 ContentSet

Tag Name inlineXML Purpose Inline XML is used to represent structured content of the newsItem.

Xpath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentSet/inlineXML

Tag Name inlineXML/@contenttype Purpose Contenttype of the text newsItem.

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/contentSet/inlineXML/@contenttype

Tag Name body Purpose Text content of newsItem wrapped in paragraph tags. This is the text transcript which

accompanies the video content.

Note: The html and body tags are not part of the NewsML2-G2 namespace and may need to be prefixed with a namespace alias when issuing XPaths in some Integrated Development Environments.

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/ contentSet/inlineXML/html/body

Page 37: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

37

4.1.5 Video NewsItem

4.1.5.1 ContentMeta

Tag Name description[@role="descRole:audio"]

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentMeta/description[@role=’descRole:audio’]

Tag Name description[@role=”descRole:audio”]/ @xml:lang

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentMeta/description [@role=’descRole:audio’]/@xml:lang

4.1.5.2 PartMeta

<partMeta> <timeDelim start="00:00:00.000" end="00:00:05.000" timeunit="timeunit:normalPlayTime"/> <rtr:role qcode="partRole:slate"/> </partMeta>

Tag Name partMeta[rtr:role[@qcode="partRole:slate"]]

/timeDelim

Purpose The duration of the slate in the video content.

Page 38: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

38

XPath For the start of the slate in the video: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/partMeta[rtr:role[@qcode=’partRole:slate’]]/timeDelim/@start

For the end of the slate in the video: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/partMeta[rtr:role[@qcode=’partRole:slate’]]/timeDelim/@end

Tag Name

partMeta[rtr:role[@qcode="partRole:content"]]

/timeDelim

Purpose The duration of the main content in the video content.

XPath For the start of the main content in the video: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/partMeta[rtr:role[@qcode=’partRole:content’]]/timeDelim/@start

For the end of the main content in the video: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/partMeta[rtr:role[@qcode=’partRole:content’]]/timeDelim/@end

Tag Name partMeta[rtr:role[@qcode="partRole:keyframe"]]

/timeDelim

Purpose The duration of the key frame in the video content.

XPath For the start of the key frame in the video: /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/partMeta[rtr:role[@qcode=’partRole:keyframe’]]/timeDelim /@start

For the end of the key frame in the video:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/partMeta[rtr:role[@qcode=’partRole:keyframe’]]/timeDelim

/@end

4.1.5.3 ContentSet This gives details of the video file and accompanying audio content.

Page 39: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

39

Tag Name remoteContent/@residref Purpose Colon-delimited string comprising the version-less GUID of the content being

referenced i.e. newsItem guid, video bit rate in kbps, file extension.

Xpath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentSet/remoteContent/@residref

Tag Name remoteContent/@format XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@format

Tag Name remoteContent/@contenttype XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@contenttype

Tag Name remoteContent/@duration XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@duration

Tag Name remoteContent/@audiocodec XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@audiocodec

Tag Name remoteContent/@audiobitrate XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@audiobitrate

Page 40: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

40

4.1.5.4 RemoteContent Tag Name remoteContent/@audiovbr XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@audiovbr

Tag Name remoteContent/@audiosamplesize XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@audiosamplesize

Tag Name remoteContent/@audiosamplerate XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@audiosamplerate.

Tag Name remoteContent/@videocodec XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@videocodec

Tag Name remoteContent/@videoavgbitrate XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@videoavgbitrate

Tag Name remoteContent/@videovbr XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@videovbr

Tag Name remoteContent/@videoscan XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@videoscan

Tag Name remoteContent/@videoaspectratio XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@videoaspectratio

Tag Name remoteContent/@videosampling XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@videosampling

Page 41: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

41

Tag Name remoteContent/@rendition XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@rendition

Tag Name remoteContent/@rtr:definition XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/@rtr:definition

Tag Name rtr:altId[@rtr:isPresent=”1”] Purpose Video file name.

XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:video’]]/contentSet/remoteContent/rtr:altId[@rtr:isPresent=’1’]

Tag Name rtr:altId/@contentType XPath /newsMessage/itemSet/newsItem[itemMeta/itemClass

[@qcode=’icls:video’]]/contentSet/remoteContent/rtr:altId/@contentType

4.2 XPaths - Updated versions When a XML file is updated the packageItem and text newsItem version data is incremented. However, the video newsItem (video item) version data is unchanged.

4.2.1 PackageItem and text NewsItem In the case of a packageItem and the text newsItem there will be additional tags in the itemMeta section to indicate that the NML2 is an updated version.

In the itemMeta section there is an additional signal @qcode tag with the value “edStat:U”.

There is a link tag linking to the previous version of the NML2 XML file.

NOTE

The updated file contains a new TransmitId.

Page 42: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

42

4.2.1.1 ItemMeta

Example: packageItem section Tag Name signal[@qcode=="edStat:U"]/@qcode Purpose The value “edStat:U” indicates the NML2 XML file is an update. Also,

“edStat:C” indicates a correction.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/ signal[@qcode=’edStat:U’]/@qcode

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]]/ signal[@qcode=’edStat:U’]/@qcode

Tag Name link[@rel=”irel:prevVersion”] Purpose Defines the relationship of the link. In this case it is the link to the previous

version of this packageItem.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link[@rel=’irel:prevVersion’]

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]]/ link[@rel=’irel:prevVersion’]

Tag Name link/@residref Purpose GUID of the linked reference i.e. previous version of corresponding item (i.e.

Page 43: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

43

packageItem or text newsItem).

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link/@residref For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]] /link/@residref

Tag Name link/@version Purpose Version number of the linked reference i.e. the previous version.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link/@version

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]]/ link/@version

Tag Name link/@contenttype Purpose MIME type of the linked reference i.e. previous version.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link/@contenttype For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]]/ link/@contenttype

Tag Name link/@rtr:id Purpose Alternative identifier of the linked reference i.e. previous version. This

corresponds to the value of the altid of the linked reference.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link/@rtr:id For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]]/ link/@rtr:id

Tag Name link/@rtr:type Purpose

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link/@rtr:type

Page 44: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

44

For text newsItem:

/newsMessage/itemSet/newsItem/itemMeta[itemClass [@qcode=’icls:text’]]/ link/@rtr:type

NOTE The itemMeta/rtr:versionedId/@guid for packageItem

and the text newsItem will have its version incremented i.e. the final number after the colon will increase by one.

4.2.2 Video newsItem By contrast the video newsItem tags are the same as for the original XML file.

4.2.3 Example

The example shows the packageItem section of the 3rd version of a XML file. The current version number is circled with a blue oval. The link to the previous version of this package and the previous version number are indicated by red rectangles.

Page 45: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

45

4.3 Xpaths – Translated Versions A translated XML file is considered to be a new file. Therefore the packageItem and text newsItem will have a different GUID from its corresponding item in the un-translated XML file.

However, in the translated version there are new tags for links to the un-translated version.

4.3.1 PackageItem and text NewsItem In each of the three items there will be additional tags in the itemMeta section to indicate that the NML2 XML file is a translated version. In the itemMeta section there is an additional signal @qcode tag with the value “var:itemTrans”.

There is a link tag linking to the un-translated version of the NML2 XML file.

4.3.1.1 ItemMeta

Example: packageItem section Tag Name signal[@qcode=” var:itemTrans”]/@qcode Purpose Indicates the NML2 XML file is a translation.

Xpath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/signal[@qcode=’var:itemTrans’] For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/signal[@qcode=’var:itemTrans’]

Page 46: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

46

Tag Name link[@rel="irel:translatedFrom"] Purpose Defines the relationship of the link. In this case it is the link to the un-translated

version of this XML file.

XPath For packageItem: /newsMessage/itemSet/packageItem/itemMeta/link[@rel='irel:translatedFrom']/@rel

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/link[@rel=’irel:translatedFrom’]/@rel

Tag Name link/@residref Purpose GUID of un-translated version of corresponding previous item.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/ link[@rel=’irel:translatedFrom’]/@residref For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/link[@rel=’irel:translatedFrom’] /@residref

Tag Name link/@version Purpose Version number of un-translated item.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/link [@rel='irel:translatedFrom']/@version For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/link [@rel=’irel:translatedFrom’]/@version

Tag Name link/@contenttype Purpose MIME type of un-translated version.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/ link[@rel=’irel:translatedFrom’]/@contenttype For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/link [@rel=’irel:translatedFrom’]/@contenttype

Page 47: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

47

Tag Name link/@rtr:id Purpose Alternative identifier of the corresponding section of un-translated version. This

corresponds to the value of the altid of the corresponding section the un-translated version.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/ link[@rel='irel:translatedFrom']/@rtr:id For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/link[@rel=’irel:translatedFrom’]/@rtr:id

Tag Name link/@rtr:type Purpose Type of the corresponding section of un-translated version.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/ link[@rel=’irel:translatedFrom’]/@rtr:type

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/ link[@rel=’irel:translatedFrom’]/@rtr:type

Tag Name language/@tag Purpose Original language of un-translated item.

XPath For packageItem:

/newsMessage/itemSet/packageItem/itemMeta/ link[@rel='irel:translatedFrom']/language/@tag

For text newsItem:

/newsMessage/itemSet/newsItem[itemMeta/itemClass [@qcode=’icls:text’]]/itemMeta/ link[@rel=’irel:translatedFrom’]/language/@tag

Page 48: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

48

4.3.2 Example

The example shows the text newsItem of a translated XML file. The link to the un-translated newsItem is indicated by a red rectangle. Note that the GUID strings (GUID and residref) are different in the un-translated version and the translated version (underlined in green).

Page 49: REUTERS NEWSML-G2 WNE TECHNICAL GUIDEvisualscdn.reuters.com/wneclient/docs/perm/WNE NewsML-G2... · 2015-09-21 · REUTERS NEWSML-G2 WNE TECHNICAL GUIDE APRIL 12, 2010 WNE v.4.2 .

49

5 Appendix

5.1 Service Codes Service Suffix

Advisory AV Af Daily AD America AM Arabic Rep ME Asia AS CEEF CE Europe EU EVO EN Financial FV Germany GE Innovations IV Latin LA Life! LI Mid East ME R Rep RR Showbiz SB Sports SP Subcon SC Subcon Extra SE Support Services SS World WD * Suffix for Long Edit Numbers e.g. WD for 200812251025WD.

5.2 Date formats Timestamps are of the form

YYYY-MM-DDThh:mm:ssZ

where YYYY is the four-digit year, MM is the two-digit month, DD is the two-digit day, hh is the two-digit hour, mm is the two-digit minute and ss is the two-digit second.

All timestamps are in GMT.

5.3 Referenced Information [1] IPTC News Architecture (NAR) http://www.iptc.org/cms/site/index.html;jsessionid=a8VdjSDL64kg?channel=CH0087

[2] IPTC G2 Family of Standards http://www.iptc.org/cms/site/single.html?channel=CH0087&document=CMS1206527645546

[3] IPTC NewsML-G2 http://www.iptc.org/cms/site/index.html;jsessionid=a8VdjSDL64kg?channel=CH0111