White Papers
Total Page:16
File Type:pdf, Size:1020Kb
Cision Web Solutions Total Return February 2019 Contents INTRODUCTION ..................................................................................................................................................... 1 SYSTEM PLATFORM ............................................................................................................................................... 1 TECHNICAL SYSTEM OVERVIEW ................................................................................................................................... 1 SOFTWARE............................................................................................................................................................ 1 CAPACITY ............................................................................................................................................................. 2 ACCESSING THE DATA ............................................................................................................................................ 2 FILTER OPTIONS ..................................................................................................................................................... 2 FEED SCHEMA REFERENCE ......................................................................................................................................... 3 CLIENT-SIDE INTEGRATION .................................................................................................................................... 6 DELIVERY PACKAGE ................................................................................................................................................. 7 SETTINGS.............................................................................................................................................................. 8 General settings ............................................................................................................................................ 8 AccessKey ...................................................................................................................................................... 9 Share graph settings ...................................................................................................................................... 9 TRANSLATIONS..................................................................................................................................................... 10 Cision Web Solutions – Share Graph 1 Introduction This document describes the technical platform of the Cision Web Solutions Share Graph Module and how to use this module to present share data on a client web site. In order to be able to make advanced/major code changes in the graphs rendered by Highcharts, an additional HighCharts license is required (not included). Read more about licensing on highcharts.com. System platform Technical system overview Software The Cision platform and client pages are written in C#.NET. The data layer is implemented with Microsoft SQL Server and XML web services. Text search indexing is implemented using Solr. Cision Web Solutions – Total Return 2 Capacity Bandwidth available: Up to 100 Mbit/s Internet provider: Interoute Accessing the data The data for all the Cision web modules is delivered via Cision’s API as feeds in XML and JSON formats. The feeds have a one-minute cache, so polling the feeds more frequently than once a minute will not result in new data. Cision monitors polling frequency and applies throttling if necessary. The Total Return module is split into three separate feeds for Overview, Detail and Dividend. Tip: IP addresses are subject to change. When building with Cision web modules, do not apply IP address filtering based on the current IP ranges unless you are prepared to update it on short notice. If your infrastructure supports DNS based filtering, that is a better option as we are likely to retain the cision.com domain for the foreseeable future. Filter options The Overview and Dividend feeds take no options. The Detail feed can be filtered by passing filter options as query string parameters. Following are the available filter options for the Total Return Detail feed. Name value Format XML/JSON QuoteType EndOfDay (default), EndOfDayAdjusted IntervalType Year (default), Month, Day, All, Custom IntervalLength Number of intervals as specified in IntervalType (if Year, Month or Day) StartDate yyyy-mm-dd (if IntervalType is Custom) EndDate yyyy-mm-dd (if IntervalType is Custom) Cision Web Solutions – Total Return 3 Overview feed schema reference • Title: string • Author: string • DataProvider: string • DatePackaged: UTC DateTime string • Instruments: Array of TotalReturnSummaryPackage • ISIN: string • TickerName: string • TickerSymbol: string • TickerType: string • TradeCurrency: string • MarketPlace: string • Summaries: Array of TotalReturnSummary • DateCurrent: UTC DateTime string • DateStart: UTC DateTime string • EYieldCurrent: number • EYieldStart: number • IntervalLength: int • IntervalType: string • PriceCurrent: number • PriceStart: number Detail feed schema reference • Title: string • Author: string • DataProvider: string • DatePackaged: UTC DateTime string Cision Web Solutions – Total Return 4 • DateFrom: UTC DateTime string (or null) • DateTo UTC DateTime string (or null) • IntervalLength: int • IntervalType: string • QuoteType: string • Instruments: Array of TotalReturnDetailPackage • ISIN: string • TickerName: string • TickerSymbol: string • TickerType: string • TradeCurrency: string • MarketPlace: string • CustomSummary ▪ DateCurrent: UTC DateTime string ▪ DateStart: UTC DateTime string ▪ EYieldCurrent: number ▪ EYieldStart: number ▪ IntervalLength: int ▪ IntervalType: string ▪ PriceCurrent: number ▪ PriceStart: number • EffectiveYields: Array of EffectiveYield ▪ Currency: string ▪ LastAdj: number ▪ LastAdjReinv: number ▪ LastChangedDate: UTC DateTime string ▪ LastRaw: number ▪ ObsDate: UTC DateTime string • Quotes: Array of Quote ▪ DeltaPercentage: number ▪ Price: number Cision Web Solutions – Total Return 5 ▪ Quantity: int ▪ QuoteTime: UTC DateTime string • Summaries: Array of TotalReturnSummary • DateCurrent: UTC DateTime string • DateStart: UTC DateTime string • EYieldCurrent: number • EYieldStart: number • IntervalLength: int • IntervalType: string • PriceCurrent: number • PriceStart: number Dividend feed schema reference • Title: string • Author: string • DataProvider: string • DatePackaged: UTC DateTime string • Instruments: Array of TotalReturnDividendPackage o ISIN: string o TickerName: string o TickerSymbol: string o TickerType: string o TradeCurrency: string o MarketPlace: string o AdjustmentFactors: Array of DividendAdjustmentFactor ▪ Date: UTC DateTime string ▪ Factor: number Cision Web Solutions – Total Return 6 ▪ FactorCumulative: number o AnnualDividends: Array of Dividend ▪ Amount: number ▪ AmountAdjusted: number ▪ AmountOriginal: number (or null) ▪ EventDate: UTC DateTime string ▪ RecordDate: UTC DateTime • BonusDividends: Array of Dividend ▪ Amount: number ▪ AmountAdjusted: number ▪ AmountOriginal: number (or null) ▪ EventDate: UTC DateTime string • PriceStart: number Client-side integration Cision provides ready-made code to present web module data on client web sites. This code can be used as is or modified to suit specific needs or layout considerations. The customer may also write their own code to interact with the API. The supplied Total Return HTML code implements a combined presentation with tabs for overview, total return, dividend, and general information, as well as separate pages for each graph. Cision Web Solutions – Total Return 7 Tabbed interface with Overview open. Stand-alone Total Return detail presentation page Delivery package The code provided by Cision consists of a complete delivery package with JavaScript, CSS styles, translations, proxy handler (needed to solve the problem with cross site scripting if CORS Cision Web Solutions – Total Return 8 cannot be used) and HTML pages. The HTML is built using the template engine JSRender. The graphs are rendered with Highcharts and can be altered using Cision’s predefined settings. If the flexibility afforded by the settings is not enough, the client can use the API directly to implement the presentation. The Cision presentation code is dependent on two scripts. The first is a minified and concatenated vendor script including all third-party libraries used. The second is the Cision script which a concatenated and minified version of all module JavaScripts. For more information on specific libraries, versions and use, please see the README file included. In case of problems with the minified files (e.g. JavaScript library version mismatch or naming conflicts), the non-minified Cision web solutions JavaScript can be downloaded from the Web Solutions demo site. Please note that Cision can only provide technical support if the minified files supplied are used. Settings All predefined settings are found in Scripts/settings.js. Adjust this file to customize your setup. Override settings may be passed as JSON objects in the render call to any given module. This is useful when different modules need to have different general settings or if several instances of the same module need to be presented with different settings. By overriding the settings this way – in the render call itself - there is no need to duplicate the entire file and it is clear to which module the override settings pertain. General settings These settings