PRODUCT CHANGE NOTIFICATIONS. Thomson Reuters Tick History. New Extraction Query Capabilities. Query Time Zone. User Interface Updates

Transcription

1 PRODUCT CHANGE NOTIFICATIONS Thomson Reuters Tick History New Extraction Query Capabilities Notification Date: 09 August 07 Client Action: For Information Implementation Date: August 07 Thomson Reuters is pleased to announce new extraction query capabilities for Tick History custom extractions. The new Query Time Zone and Relative Query capabilities are available for Tick History Time and Sales, Market Depth, Intraday Summaries, and Raw extractions created via the user interface and REST API. These features will be available as part of the... release of DataScope Select, the strategic platform for hosting Tick History. Please see the remaining sections of this document for details. Note that these features will be added only to Tick History on the DataScope Select platform. They will not be added to the legacy version of Tick History hosted on SIRCA (also referred to as Tick History v). Query Time Zone The Query Time Zone enables you to retrieve query-level data for a time period defined using a time zone other than the time zone specified in your user preferences. This enhanced capability provides improved flexibility in extraction scheduling. It is important to understand the difference between the Query Time Zone and the User Preferred Time Zone. The Query Time Zone identifies the time period in which you are querying. It applies to the selected report template only. The User Preferred Time Zone is a global setting that identifies the default time zone used for specifying dates and times when creating extraction queries and scheduling extraction executions. User Interface Updates Via the user interface, a new Query Time Zone selection has been added to the Tick History report template screens for both Range and Delta Queries, as well as for the new Relative Query. The default setting is the time zone selected in your user preferences, identified as User Preferred Time Zone. Use the dropdown to select a different time zone for the query. NOTE: Some time zone names are unsupported. In these instances, the query s data will be based on UTC, regardless of the selected Query Time Zone. Please see Unsupported Time Zones for the current list.

2 REST API Updates The Tick History REST API supports Query Time Zone via the new DateRangeTimeZone condition parameter in the following endpoints: /Extractions/ExtractRaw /Extractions/TickHistoryIntradaySummariesReportTemplates /Extractions/TickHistoryMarketDepthReportTemplates /Extractions/TickHistoryRawReportTemplates /Extractions/TickHistoryTimeAndSalesReportTemplates DateRangeTimeZone is a string that you set to a.net time zone name. Some time zone names are currently unsupported by the DateRangeTimeZone API parameter, the Query Time Zone user interface field, and related Tick History functionality. You can see the list of unsupported names in Unsupported Time Zones. If you set DateRangeTimeZone to an unsupported name, the time zone will default to UTC+00:00. NOTE: Beginning in release., you will set DateRangeTimeZone to a.net time zone ID instead of a time zone name. (Time zone IDs are more stable over time than names.) If you do not specify DateRangeTimeZone in a report template or an on-demand extraction, it will default to your user preference time zone. You can set your user preference time zone: Via the user interface, by selecting your name in the DataScope Select menu bar > Preferences > General Preferences > Time Zone. Via the REST API, using the TimeZone parameter of the /Users/UserPreferences endpoint. Unsupported Time Zones Unsupported Time Zone Standard Names (API Users) Aleutian Standard Time Altai Standard Time Astrakhan Standard Time Aus Central W. Standard Time Bougainville Standard Time Chatham Islands Standard Time Cuba Standard Time Easter Island Standard Time Eastern Standard Time (Mexico) Haiti Standard Time Lord Howe Standard Time Magallanes Standard Time Unsupported Time Zone Display Names (UI Users) (UTC-0,00) Aleutian Islands (UTC+07,00) Barnaul, Gorno-Altaysk (UTC+0,00) Astrakhan, Ulyanovsk (UTC+08,) Eucla (UTC+,00) Bougainville Island (UTC+,) Chatham Islands (UTC-0,00) Havana (UTC-06,00) Easter Island (UTC-0,00) Chetumal (UTC-0,00) Haiti (UTC+0,0) Lord Howe Island (UTC-0,00) Punta Arenas 09 August 07 /7

3 Unsupported Time Zone Standard Names (API Users) Marquesas Standard Time Mid-Atlantic Standard Time Norfolk Standard Time North Korea Standard Time Novosibirsk Standard Time Omsk Standard Time Saint Pierre Standard Time Sakhalin Standard Time Saratov Standard Time Tocantins Standard Time Tomsk Standard Time Transbaikal Standard Time Turks and Caicos Standard Time UTC+ UTC-08 UTC-09 Unsupported Time Zone Display Names (UI Users) (UTC-09,0) Marquesas Islands (UTC-0,00) Mid-Atlantic - Old (UTC+,00) Norfolk Island (UTC+08,0) Pyongyang (UTC+07,00) Novosibirsk (UTC+06,00) Omsk (UTC-0,00) Saint Pierre and Miquelon (UTC+,00) Sakhalin (UTC+0,00) Saratov (UTC-0,00) Araguaina (UTC+07,00) Tomsk (UTC+09,00) Chita (UTC-0,00) Turks and Caicos (UTC+,00) Coordinated Universal Time+ (UTC-08,00) Coordinated Universal Time-08 (UTC-09,00) Coordinated Universal Time-09 W. Mongolia Standard Time (UTC+07,00) Hovd West Bank Gaza Standard Time (UTC+0,00) Gaza, Hebron Query Time Zone Known Issues: Delta queries for today will now start at 00:00 in your selected Query Time Zone instead of 00:00 UTC, as was previous behavior. This can impact existing Delta extractions. Please make sure your internal processes are prepared. When exporting a Range Query, the query time zone will be exported as specified in the report template, but the Query Start and Query End dates and times will be exported in UTC. (Note that Delta and Relative queries are not impacted). In the next Tick History release, coming September 07, the Query Start and Query End dates and times for Range queries will be exported in the specified Query Time Zone. 09 August 07 /7

4 Relative Query Relative Queries support snapshots of data for a span of time that is defined relative to the extraction time. This new query type provides flexibility beyond the current Range and Delta Query options to support both time periods and relative ranges of dates within a single query. User Interface Updates Via the user interface, you can create a Relative Query by selecting the Schedule Relative Query option that has been added to the Query Types section on the report template screen. You select how many days before the extraction the query will begin (Start Days Ago), and how many days before the extraction the query will end (End Days Ago). You can define the start, and the end, anytime within a -day period of time that begins with the day of extraction (the value Today) and that ends days before the extraction. Each time you run the report, it extracts data for that period of time defined relative to the extraction date. REST API Updates You can use relative queries in the Tick History REST API by setting the parameter ReportDateRangeType to the new value Relative in a report template or a raw extraction. When ReportDateRangeType is set to Relative, there are four new parameters that you set to specify the relative date range: RelativeStartDaysAgo, which defines the days portion of the beginning of the relative query time period. It is a positive integer, from 0 through, that represents a number of days preceding the data extraction. 0 (zero) indicates the day of the extraction, and is equivalent to the value Today in the Tick History user interface s Start Days Ago field. RelativeStartTime, which defines the time portion of the beginning of the relative query time period. It is a character string representing hours, minutes, seconds, and (optionally) milliseconds, in the form: hh:mm:ss:mmm The range of values (including optional milliseconds) is 00:00: through :9: RelativeEndDaysAgo, which defines the days portion of the end of the relative query time period. It is a positive integer, from 0 through, that represents a number of days preceding the data extraction. It is nullable. 0 (zero) indicates the day of the extraction, and is equivalent to the value Today in the Tick History user interface s Start Days Ago field. RelativeEndTime, which defines the time portion of the end of the relative query time period. It is a character string representing hours, minutes, seconds, and (optionally) milliseconds, in the form: hh:mm:ss:mmm The range of values (including optional milliseconds) is 00:00: through :9: August 07 /7

5 The moment specified by the combination of the end day and end time must be later than, or identical to, the moment specified by the combination of the start day and start time. These new parameters and values are available in the following endpoints: /Extractions/ExtractRaw /Extractions/TickHistoryIntradaySummariesReportTemplates /Extractions/TickHistoryMarketDepthReportTemplates /Extractions/TickHistoryRawReportTemplates /Extractions/TickHistoryTimeAndSalesReportTemplates Example Query This section demonstrates the Query Time Zone and Relative Query capabilities in creating and scheduling a Tick History Time and Sales extraction via the user interface and REST API. For detailed instructions on any of the steps below, see the Tick History User Guide and Tick History REST API User Guide. For exchange hours and embargoes by venue, see the Tick History Data Coverage Guide. These documents are available on My Account. In this example, your user preference time zone is set to London (UTC+00:00), and you want to schedule an extraction to retrieve a full day s trading data for RIC 70.T - Toyota Motors from the Tokyo Stock Exchange (TYO) in the local time zone Tokyo (UTC+09:00). A day defined according to your user preference time zone (London) starts several hours after the TYO opening, causing you to miss data from earlier in the day. Using the Query Time Zone, you can specify that you want one day of Tokyo data based on a Tokyo day, and then schedule your extraction to execute in the Tokyo (UTC +09:00) time zone following the embargo to retrieve today s data. User Interface Example 6 6 Create a new Tick History Time and Sales report, and then select Schedule Relative Query. In the Start Days Ago section, accept Today as the default selection. In this example, today s date is 08/07/07. Use the dropdowns to specify the hour, minutes and seconds to initiate the query. This time should correspond to the exchange s start time. For TYO, this is 09:00:00. In the End Days Ago section, accept Today as the default selection. In this example, today s date is 08/07/07. Use the dropdowns to specify the hour, minutes and seconds to end the query. This time should correspond to the exchange s close time. For TYO, this is :0:00. In the Query Time Zone dropdown, select (UTC+09:00) Osaka, Sapporo, Tokyo. Then complete the remaining sections of the report template to select the output settings, file format and fields. 09 August 07 /7

6 Scheduling the Query Execution In the New Schedule screen, under Extraction Content, select the list of instruments to use as input for extraction from the List dropdown, and then select the report template created in the previous section from the Report Template dropdown. In the Extraction Frequency section, use the On and At selections to specify today s date and time on which to execute the extraction. The time should be after the market s close and required embargo. In this example, the TYO exchange closes at :0 and has a 0 minute embargo. Therefore, the extraction is scheduled to execute at 7:0. Note that this example is scheduled to run once, but you could easily modify it to run on a repeating schedule. Specify schedule and output file names. In the Time Zone dropdown, select (UTC+09:00) Osaka, Sapporo, Tokyo to reflect the Query Time Zone selected in your report template, and then save the schedule. You can retrieve your completed extraction after 7:0 Tokyo time. REST API Example When you post the /Extractions/TickHistoryTimeAndSalesReportTemplates endpoint to create the report template, you would specify the following parameters: "Condition": { } "DateRangeTimeZone" : "Tokyo Standard Time", "ReportDateRangeType" : "Relative", "RelativeStartDaysAgo" : 0, "RelativeStartTime" : "09:00:00", "RelativeEndDaysAgo" : 0, "RelativeEndTime" : ":0:00" 09 August 07 6 /7

7 DateRangeTimeZone sets the query time zone to Tokyo Standard Time, which is UTC+09:00. ReportDateRangeType sets the query type to relative date range. RelativeStartDaysAgo and RelativeEndDaysAgo are each set to 0 (zero), which indicates zero days before the day that the report executes: that is, the day of execution itself. RelativeStartTime and RelativeEndTime indicate the same start and end times specified in the user interface example. When you post the /Extractions/Schedules endpoint to create the report schedule, you would specify the following parameters: "TimeZone": "Tokyo Standard Time", "Recurrence": { "#ThomsonReuters.Dss.Api.Extractions.Schedules.SingleRecurrence", "ExtractionDateTime" : " T7:0:00.000Z", "IsImmediate": false TimeZone sets the execution time zone to Tokyo Standard Time, which is UTC+09:00. Recurrence is set to single recurrence (that is, run only once) in the schedules definition, and ExtractionDateTime sets the day and time that this will execute the single time that it runs. Faster Downloads for Custom Reporting In addition to the new query extraction capabilities above, the REST API now enables you to download custom Tick History reports faster, by retrieving them directly from the Amazon Web Services cloud in which they are hosted. Simply include the HTTP header field X-Direct-Download: true in the request, and the request will be automatically redirected to Amazon, ensuring that you receive the extraction file in the shortest possible time. You can do this with Tick History Time and Sales, Tick History Market Depth, Tick History Intraday Summaries, and Tick History Raw reports. For example: GET aadc6')/$value HTTP/. Authorization: Token <your_auth_token_goes_here> Prefer: respond-async X-Direct-Download: true For More Information If you would like more information about the contents of this notification or have questions, please contact Thomson Reuters Support. Thank you for being a Tick History. If we can improve your customer experience in any way, please let us know. DataScope Team, 09 August August 07 7 /7