www.platts.comPlatts™ Excel® Add-In user guideMarch 2017
Platts™ Excel® Add-In User Guide 3
IntroductionThe intuitive Platts™ Excel® Add-In functionality gives our clients the ability to easily retrieve and manage Platts Assessment Data and Platts eWindow Market Data.
This document provides users with a simple step-by-step guide to using the Platts™ Excel® Add-In.
4 Platts™ Excel® Add-In User Guide
ContentsRibbon bar ................................................................................................................................ 5Signing in .................................................................................................................................. 6First time user login scenario .................................................................................................. 7Session management .............................................................................................................. 8Forgot password ...................................................................................................................... 9Home button........................................................................................................................... 10Query Builder.......................................................................................................................... 11Search, results and creating the function ............................................................................ 11Query Builder for Platts Assessment Data ........................................................................... 11Query Builder for Platts eWindow Market Data ................................................................... 14Templates ............................................................................................................................... 17Platts Assessment Data templates ...................................................................................... 17General rules ........................................................................................................................... 17Search...................................................................................................................................... 17Real time template ................................................................................................................. 18Historical template ................................................................................................................. 19Reference Data template ....................................................................................................... 20Charts template ...................................................................................................................... 21Platts eWindow Market Data templates............................................................................... 22Partials Report ........................................................................................................................ 22Positon Report ........................................................................................................................ 22Price Report ............................................................................................................................ 22Trade Report by Hub ............................................................................................................... 22Volume Report by Market ...................................................................................................... 22Streaming Template ............................................................................................................... 22Watch Lists ............................................................................................................................. 23General options ...................................................................................................................... 23Creating a new Watch List ..................................................................................................... 23Managing Watch Lists ............................................................................................................ 23Editing a Watch List ................................................................................................................ 24Platts™ Excel® Add-In functions ........................................................................................ 25Platts Assessment Data functions ....................................................................................... 25Platts eWindow Market Data functions ................................................................................ 32Glossary .................................................................................................................................. 37Platts Assessment Data terminology ................................................................................... 37
Platts™ Excel® Add-In User Guide 5
Ribbon barThe Ribbon bar includes the following icons:
Access Home
Connections
Data
RefreshRefresh active sheet
Refresh workbook
Query Builder
Watch List
Templates Templates
Profile and Settings
Sign in
Settings
MethodologyRedirection to www.platts.com/methodology-references
FeedbackSend your feedback to the Platts™ Excel® Add-In Product team
About Us
6 Platts™ Excel® Add-In User Guide
Signing in
Valid credentials are Email ID and password
If the Platts™ Excel® Add-In does not recognize the log in credentials, please make sure you have entered the correct email address and a case-sensitive password.
If you have forgotten your password, please reset it using the ‘Forgot password?’ link on the sign in window.
Password rules
Your password must be at least eight characters long, no longer than 25 characters, contain at least one lowercase letter, one uppercase letter, one number and no spaces. It should not contain the word "password". It should not be one of your last five passwords.
Platts™ Excel® Add-In User Guide 7
First time user login scenario When a new user is identified by the Platts™ Excel® Add-In team, they will receive a welcome email with links to download the Add-In and set a password.
User Email ID is the unique key required to identify a user
The following message will be displayed in the welcome email:
Thank you for choosing to use Platts™ Excel® Add-In.
Direct access Platts™ Excel® Add-In is the fastest and easiest way to access and interpret our energy, petrochemicals, metals, shipping and agriculture data. Now, you’ll begin and end every working day with exactly the data you are looking for - receiving it as soon as it’s published so you can integrate it straight into your models.
Getting started You can download the Platts™ Excel® Add-In here.
Your user name is ##USER_EMAIL## and you can set up your own password by clicking on this link:
##PASSWORD_RESET_LINK##.
Making the most of your access To help you make the most of your access contact us for a custom training session. Our dedicated Customer Services team is also available to help you with any queries, simply call them on +1-800-PLATTS-8 / 08007528878 or email [email protected].
Kind regards,
Tristan Ranger
Director, Product Development
S&P Global Platts
8 Platts™ Excel® Add-In User Guide
Session managementThe user session will be active for 30 days, after which the user will get a pop up message saying “Your session has been terminated”, and the user will have to re-login to continue.
Users can log in from multiple locations with the same valid credentials.
User credentials cannot be shared between users.
When a user has a session in progress, and another session is initiated with the same log in credentials from a different location, the first session which was in progress will be terminated with a pop up message:
“Your session has been terminated.”
Platts™ Excel® Add-In User Guide 9
Forgot passwordWhen you click on the ‘Forgot password?’ link on the sign in window, you will be redirected to a web page (https://id.spglobal.com/SP/idm/idmlogin/public/resetPassword.do) wherein the valid user Email ID (email address with Platts™ Excel® Add-In access) has to be entered. The password reset link will then be sent to the user’s email address.
If you are experiencing difficulty in resetting your password, please contact Platts on [email protected]
10 Platts™ Excel® Add-In User Guide
Home buttonThe Home button on the Ribbon bar can be configured from the Settings window located under the user Profile and Settings button on the Ribbon bar.
For Platts Assessment Data, any user Watch List can be configured, which will open four workbooks as explained below:
When you close any of the workbooks, you will need to click on the Home button to return the four workbooks view to your screen.
On the Home page, you will only be able to view data. If you wish to edit data, you will need to use the Platts™ Excel® Add-In functions or the templates to do so.
The Home page displays the Watch List you have elected as your preferred data view. If you wish to change the prices that you’d like to see on the Home page, you can do so by editing your Watch Lists. To edit your Watch List, please refer to page 10 in this guide.
Real-time pricesIn this workbook you will see real-time prices for the preferred symbols you have identified in your Watch List, as soon as they are published by S&P Global Platts.
Each symbol will be represented in a row. You have the ability to set up to 500 symbols per Watch List using the Watch List Manager.
Reference data When you select a price, the Platts™ Excel® Add-In will populate all the Reference data for the selected symbol.
By default, when you log in, the Reference data for the first symbol in your real-time workbook will be displayed.
Historical pricesThe historical prices workbook provides the last 45 days of history for the symbol selected in the real-time prices workbook.
The prices will be listed by last modified date.
If there has been a correction to the price type, the cell will be highlighted in blue.
ChartsThe charts workbook will display the time series (last 45 days) of prices for the symbol selected in the real-time prices workbook.
The price shown on the chart should be the last updated price for each bate for the last 45 days.
Example: If a price has 10 corrections in a day, the chart will display the price published in the latest correction for the day.
When you log in, by default the charts workbook will display data for the first symbol in your real-time prices workbook.
The chart will display price and volume for the symbol selected.
Only the prices available in Platts databases for the selected symbols will be charted.
Real-time prices Historical prices Reference data Charts
Upper left hand pane
Lower left hand pane
Upper right hand pane
Lower right hand pane
Platts™ Excel® Add-In User Guide 11
Query BuilderThis visual tool creates Platts™ Excel® Add-In functions to return content from your Platts subscription into Microsoft Excel. It allows you to build specific requirements into a query, and create custom outputs, from any Platts data set with an intuitive interface. By searching for and selecting results, you can piece together and execute the exact Platts™ Excel® Add-In function you need.
Search, results and creating the functionAfter selecting your data set, a quick keyword search opens up the “Search” pane. This contains all matching fields and values that are available for you to use to refine your search. On executing a search the “Results” pane opens displaying matching results. You can run multiple independent searches for each of your search criteria. To build a Platts™ Excel® Add-In function simply select and drag the required results into the “Function Structure” pane. You can fill relevant columns, filters and optional parameters, such as Headers, according to your needs. Once done, selecting “Run fx” will populate the Platts™ Excel® Add-In function in the Microsoft Excel sheet and your data will be retrieved.
Query Builder for Platts Assessment DataYou can search for any term applicable within the Platts Assessment Data and return a list of symbols that match your search criteria. You can also search all applicable bates (e.g. Close, High, Low) and reference data (E.g. Commodity Type, Description, Latest Assessment Data).
12 Platts™ Excel® Add-In User Guide
Step 1: Enter the search term, select search criteria in the “Search” pane and click on Search.
Step 2: Select the items you need from the “Results” pane.
Step 3: Drag the symbols to the ‘Symbols’ parameter in the “Function Structure” pane, and the bates and reference data to the ‘Columns’ parameter.
The ‘Columns’ parameter within the “Function Structure” pane can take any of the bates such as Close, High, Low, or reference data such as Date, Frequency, and Assessment Type etc. You can now run the query to return the data for the Symbols and Columns requested.
History requestUse the optional ‘Start_Date’ and ‘End_Date’ parameters to request history for the Symbols and Columns selected. Make sure you add ‘DATE’ to the ‘Columns’ parameter if you would like to see the dates along with the price assessments.
Padding OptionThe data is by default displayed for available days only. If you wish to return a record for days where data is not available, you can select the ‘Padding Option’ parameter of ‘WeekDays’ for Monday to Friday, or ‘AllCalendarDays’ for all days of the week.
Headers
If your request is for multiple symbols, you may want to apply custom headers. You can add up to three header lines for the data requested. In the ‘Headers’ parameter, you can add ‘DESCRIPTION’, ‘SYMBOL’ and ‘COLUMNNAME’ to bring back a description of the symbol, the symbol code and the name of the column respectively.
Options – Order DescendingThe default date order is oldest to newest, however if you would you like to see the latest value on top, select the ‘Order_Descending’ to ‘True’.
Platts™ Excel® Add-In User Guide 13
14 Platts™ Excel® Add-In User Guide
Query Builder for Platts eWindow Market DataYou can search across all the columns or values of trade data available within the Platts eWindow Market Data and return any that match your search terms to a “Results” pane. Use the Quick Steps menu to retrieve a list of all available columns in the data set to the “Results” pane for reference.
Step 1: Enter the search term, select search criteria in the “Search” pane and click on Search.
Step 2: Select the items you need from the “Results” pane.
Step 3: Choose the trade data function you require in the “Function Structure” pane and drag the ‘Filters’ and ‘ColumnNames’ parameters accordingly before running your function.
Choosing columnsBy default, all 50+ columns of data are returned as results to an eWindow Market Data function. Drag your selection of columns into the ‘ColumnNames’ parameter to define both the order and which columns you would like to see in your output.
All available columns can also be accessed using the Quick Steps dropdown as shown below:
Platts™ Excel® Add-In User Guide 15
16 Platts™ Excel® Add-In User Guide
Filtering resultsPlatts eWindow Market Data is a vast database hence entering neither a ‘Filters’ parameter nor a ‘ColumnNames’ parameter will automatically return only the last 24 hours of trade data that occurred on Platts eWindow. To refine what is returned, use the ‘Filters’ parameter to concatenate AND and OR Column-Value pairs defining your items of interest and focusing the data returned (Fig. in Step 3).
“Results” paneSelecting a value in a “Results” pane creates a Column-Value pair in the lower section of the “Results” pane. This can be directly dragged into the ‘Filters’ parameter in the position required.
Direct typingFor columns that have dynamic values, the column can be dragged or directly input into the column part of the ‘Filters’ parameter. A value can be directly input for such items as date, price, volume etc.
Pair calculationChoose the relevant calculation for each Column-Value pair in the red drop down area of the “Function Structure” pane; equals, greater than, less than and not equal are all available.
Wildcard matchingWildcards are permissible to match Column-Value pairs in the ‘Value’ part of the ‘Filters’ parameter; both * and ? are available.
Logical operatorsDefine the relationship between multiple Column-Value pairs by selecting the relationship drop down in each ‘Filters’ parameter group; AND and OR are available and cover the whole group.
Nested logicTo create a hierarchy of logical operators, subgroups can be created using the plus button on any ‘Filter’ parameter group. The parent logical operator joins all child groups.
Removing parametersAdd and remove Column-Value pairs using the + and x buttons at the end of each row. An empty Column-Value pair row is ignored in the function.
Removing nested logicRemove and minimize layers of nested Column-Value pair logic using the x and - buttons at the end of each logic group header.
Ordering resultsPlatts eWindow Market Data is sorted in reverse chronological order by default. Drag a column to the ‘OrderBy’ parameter to specify a different column to sort by and select ascending or descending.
Column headersIf you would like to see column headers for the Platts eWindow Market Data returned, select ‘True’ in the ‘Headers’ boolean option. By default, headers are suppressed.
Distinct results To return unique results such as column to column logical alignments (e.g. list Hubs in a Product), select ‘True’ in the ‘Distinct’ boolean option. By default, ‘Distinct’ is ‘False’ to improve performance.
Append recordsTo append Near Real-Time results to the output, select ‘True’ in the ‘Append’ boolean option. By default, streaming data is over written in the same output cell.
TemplatesPlatts provides a few pre-configured templates for both Platts Assessment Data and Platts eWindow Market Data. These templates can be accessed from the Templates dropdown on the Ribbon bar.
Please note: Templates not applicable to the users’ subscription will be grayed out.
Platts Assessment Data templates All Platts Assessment Data templates can be accessed using the Templates button on the Ribbon bar. The Platts™ Excel® Add-In provides some additional functionality for the below five templates:
1. Calculated Averages and Unit Conversions template
2. Customized Daily Historical template
3. Correlation of Price Assessments
4. Real time template
5. Historical template
6. Reference Data template
7. Corrections template
8. Charts template
General rules• Select a template from the Templates dropdown
• Search for symbols based on any of the “Search” options explained later in this section
• Select all or a set of symbols from the preview paneand export to a template
• The Platts™ Excel® Add-In will display the “OutputParameter” pop up. The selection criteria will changebased on your chosen template
• The selected parameter applies to all symbolschosen for the template
• Click ‘Apply’, and the search results (based on thequery and output parameters) will be displayed in theselected template
• The templates are saved on your computer as peryour Microsoft Excel version. When a saved workbookis opened at a later date it will be refreshed withthe latest data, subject to there being an activePlatts™ Excel® Add-In connection
Search
Symbol Search• Enter a Reference Data term, Symbol or description
• Select the column and value to return the list ofsymbols. The selected symbol description(s) willappear in the “Search Query” panel
• Select symbols from Watch List by clicking onthe “Folder” icon
• Click on the “Get Results” button in the“Search Query” panel to view the symbols inthe preview panel
The following data for the selected symbols will be displayed in the preview panel:
1. MDC
2. Symbol
3. Description
Platts™ Excel® Add-In User Guide 17
18 Platts™ Excel® Add-In User Guide
Real time template
You can receive real time data for any symbol and select the required bates for the symbol
Output parameter
Select the required bates
Select the required reference data from the drop down
Only reference data attribute classes will be displayed in the dropdown, e.g. Currency or Delivery Region
Selected bate and reference data apply to all selected symbols
By default, the time period for this template is current day
• Once you have completed your selection and clicked ‘Apply’, the results (basedon the query and output parameters) will be displayed in the Real time template
The real time prices workbook will have the following data fields:
MDC
Frequency
Trans
Symbol
Description
Currency
UOM
Date
Published time
Low (l)
High (h)
Close (c)
Unspecified (u)
Volume (w)
Bid (b)
Ask (a)
Open (o)
Open_Interest (e)
Mean (m)
Note: Currency and UOM are static fields.
The color of the price type will denote whether there has been an uptick, downtick or no change in price:
Green – when there is upward movement in price from the previous price
Red – when there is downward movement in price from the previous price
Black – when there is no change in price from the previous price)
Blue – when there is a price correction, the entire price cell is highlighted in blue
Historical template
Output parameter
Select your required symbols, bates and reference data and specify the time period
Select the time period as today, one week, 15 days, 30 days, 45 days, start and end date
You will be able to view data between specified periods of time within the current day. Once a time period has been specified, it will only apply to the current day
Select your required reference data from the drop down
Only reference data attribute classes will be displayed in the dropdown, e.g. Currency or Delivery Region
Selected bate, reference data and time period apply to all selected symbols
• Once you have completed your selection and clicked ‘Apply’, the results (based onthe query and output parameters) will be displayed in the Historical template
The historical prices workbook will have the following data fields:
MDC
Trans
Symbol
Description
Currency
UOM
Low (l)
High (h)
Close (c)
Unspecified (u)
Volume (w)
Bid (b)
Ask (a)
Open (o)
Open_Interest (e)
Mean (m)
Platts™ Excel® Add-In User Guide 19
20 Platts™ Excel® Add-In User Guide
Reference Data template
You can receive reference data for the symbols you require.
• Once you have completed your selection and clicked ‘Apply’, the results (based onthe query and output parameters) will be displayed in the Reference Data template
Output parameter
Select the reference data you require from the drop down
Only reference data attribute classes will be displayed in the dropdown, e.g. Currency or Delivery Region
Selected reference data applies to all selected symbols
By default, the time period for this template is current day
Corrections template
You can receive corrections data with up to 45 days history for all symbols to which you subscribe. If the time period is more than 45 days, only one symbol can be selected.
• Once you have completed your selection and clicked ‘Apply’, the results (based onthe query and output parameters) will be displayed in the Corrections template
Output parameter
Select your required symbols and bates, then specify the time period
Select the time period as today, one week, 15 days, 30 days, 45 days, start and end date
Selected bates and time period apply to all selected symbols
Charts template
You can output a chart for up to five symbols and select multiple bates and time periods.
If only one bate is selected, there is no restriction in the number of symbols you can select.
Output parameter
Select your required symbols, bates and reference data and specify the time period
Select the time period as today, one week, 15 days, 30 days, 45 days, start and end date
Selected bate and time period apply to all selected symbols
• Once you have completed your selection and clicked ‘Apply’, the results (based onthe query and output parameters) will be displayed in the Charts template
• The output will show the data for the chart, along with the chart itself underneath
Platts™ Excel® Add-In User Guide 21
22 Platts™ Excel® Add-In User Guide
Platts eWindow Market Data templates
Partials Report
The Partials Report will help in understanding the crude partials position of all participants for a specified delivery date. This report has two sections:
1. Partial Report: this report presents the numberof partials sold and bought by each participant
2. Partial Positons: this report shows the positionof each counterparty based on net partials(partials bought less partials sold) and theirresultant potential wet cargoes. Note: this isdefaulted to 20 partials equating to one wetcargo for the Platts Dubai market
Position Report
The Position Report will help in determining the cumulative position of a participant in the eWindow, over a selected time period, with respect to volume and price of a specific set of products.
Price Report
The Price Report will show the trend of price over a defined period of time in a past MOC. The report also contains information about the traded order per participant and respective Best Bid, Best Offer and Traded Price at any point in time that informed the price assessment.
Trade Report by Hub
The Trade Report by Hub lists and summarizes consummated trade details for a specific Product and Hub combination. The report has two sections:
1. Volume Report: this report sums the traded volumeover the time period listing Buyer and Seller
2. Trade Report: this report shows the price of tradesover the time period between Buyer and Seller
Volume Report by Market
The Volume Report by Market shows the traded volume of a specific Market and Product combination. The report will help assess liquidity of certain markets and the total volume traded over time.
Streaming Template
• The Streaming (near real-time, or NRT) templateshows near real-time bids, offers and trades for aselected Product and Hub combination. The templateis only run during a MOC and will display in chart andraw form every participant’s activity in the market forthe chosen combination
Watch Lists
General options• When you log in for the first time, click on the
WatchList button or Query Builder button to view anew pane “Watch list(s)” which displays a sampleWatch List
• You can create as many customized Watch Lists asyou want
• You can select a default Watch List that will then bedisplayed on your Home page
Creating a new Watch List• Select the Watch List or Query Builder button. Search
by the reference data to narrow your search, thenselect the symbols and/or columns of interest. Click“Save As” to add this new Watch list into the WatchList pane for quick and easy access and hit ‘View’, thesystem will automatically open the Watch List in anew window.
Managing Watch Lists• To share a Watch List that has already been created,
select the Watch List and click the “Share” button. This will open a new window for you to enter avalid Platts Excel Add-In user name. Hit send. Therecipient will then receive a notification for them to“Save a Copy” or “Reject” the shared Watch List
Platts™ Excel® Add-In User Guide 23
24 Platts™ Excel® Add-In User Guide
Editing a Watch List
Adding symbols to a Watch List
• To add symbols to an existing Watch List, select the‘+’ sign: a pop up will appear, allowing you to searchby symbol or symbol description and add it to yourselected Watch List
• To add symbols to a new Watch List, go to the WatchList Manager and select ‘New’. Then, name the WatchList by selecting ‘Rename’ in the left hand pane. This Watch List will now appear in the list under ‘MyWatch List(s)’. Once a container to hold the symbolshas been set up, you can add new symbols in thefollowing ways:
– Select the ‘+’ sign on the Watch List Manager. This will take you to a pop up where you can enter the symbol id or a generic term (e.g. ‘oil’). The Platts™ Excel® Add-In will retrieve all symbols in the database that match your query. You can then choose the symbols you are interested in and by selecting ‘Add’ on the pop up screen, these symbols will be added to your selected Watch List
– Alternatively, go to the “Search” screen and use the reference data search, commodity search, MDC search or text search features to find symbols that match a particular query. Choose the symbols you are interested in, then go to the Watch List drop down on the bottom pane of the “Search” screen. Select the name of the Watch List from the drop down and add your chosen symbols to the Watch List
Deleting a Watch List
• Right click on the Watch List you wish to remove andselect “delete”
Renaming a Watch List
• Right click on the Watch List and select “rename”. When done, click away from the edit mode box tosave changes
Viewing a Watch List
• By double clicking on the Watch List name, the WatchList will open up in a “Results Pane”, - you can dragand drop the columns into the function structureby using the eight dots drag & drop functionalitycircled below.
Platts™ Excel® Add-In User Guide 25
Platts™ Excel® Add-In functionsPlatts Assessment Data functions
PLATTS.SYMBOLDATA Retrieves assessment values for selected symbols and time period
PlattsHistory Retrieves historical prices for selected symbols and time period
PlattsPrice Retrieves real time prices/values for selected symbols
PlattsReferenceData Retrieves reference data for selected symbols
PlattsPriceCorrection Retrieves price amendments for selected symbols and time period
PlattsPriceWatchList Retrieves your list from the Platts Watch List
PlattsWatchListDetails Retrieves the details of one Watch List
PlattsSubscription Retrieves the full list of MDCs to which you are subscribed
PlattsSubscriptionDetails Retrieves the price and reference data for one MDC
26 Platts™ Excel® Add-In User Guide
Function:
PLATTS.SYMBOLDATAThis retrieves assessment values for selected symbols and time period.
Function is to retrieve assessment values
=PLATTS.SYMBOLDATA Inputs that need to be given are: symbol, bates, dates
Output for the function Output columns:Entered bates (one column for each bate)
Date
Optional parameters
Start_Date Defines the start date for the time period to be returned. If left blank, it returns the earliest available values
End_Date Defines the end date for the time period to be returned. If left blank, it defaults to the date of the latest available value
Date can be specific (e.g. 1/1/2016) or dynamic (e.g. ‘=Today()‘ or ‘Today() -45)’ )
Padding_Option Option to return a time period on a five day (Monday-Friday) or seven-day basis, regardless of when the values are available. All available days will be returned by default
Padding options:
‘Days=WeekDays’ ‘Days=AllCalendarDays’ ‘Days=AvailableDays’ (default)
Headers Option to display a header containing the column(s) names requested
Header options:
‘Show’ (displays column requested as header) ‘Showwithsymbol’ (displays dual header of column requested and its corresponding symbol)
Option to change the date order to descending (default is ascending)
Order_Descending Option to change the date order to descending (default is ascending)
Platts™ Excel® Add-In User Guide 27
Function:
PlattsHistory This retrieves historical prices for selected symbols and time period.
Function is to retrieve the history for symbol(s)
=PlattsHistory
Inputs that need to be given are: symbol(s), bates, reference data and time period
The time period can be today, one week, 15 Days, 30 Days, 45 days or start and end date
Output for the function Output columns:
MDC
Symbol
Description
Currency
UOM
Date
Entered bates (one column for each bate)
Entered reference data (one column for each bate)
For example, if you would like to retrieve historical high, low and closing prices for symbol aaYWY03 over the past 10 days, enter =PlattsHistory (“aaYWY03”,”h,l,c”,,,”10 days”).
28 Platts™ Excel® Add-In User Guide
Function:
PlattsPriceThis retrieves real time prices/values for selected symbols.
Simple function is to retrieve the real time price for symbol(s)
=PlattsPrice Inputs that need to be given are: symbols, bates
Output for the function Output columns:
MDC
Symbol
Description
Currency
UOM
Date (show the latest date for the symbol as in the Home page)
Entered bates (one column for each bate)
For example, if you would like to retrieve real time high, low and closing prices for symbol aaYWY03, enter =PlattsPrice(“aaYWY03”,”h,l,c”).
Platts™ Excel® Add-In User Guide 29
Function:
PlattsReferenceDataThis retrieves reference data for selected symbols.
Function is to retrieve the reference data for symbols
=PlattsReferenceData Inputs that need to be given are: symbol
Output for the function Output columns:
Reference Data Description
Reference Data Value
For example, if you would like to retrieve all reference data attributes maintained by Platts for symbol aaYWY03, enter = PlattsReferenceData (“aaYWY03”).
Function:
PlattsPriceCorrectionThis retrieves price amendments for selected symbols and time period.
Simple function is to retrieve the correction history for one symbol
=PlattsPriceCorrection Inputs that need to be given are: symbol, bates, and time period
The time period can be today, one week, 15 days, 30 days, 45 days or start and end date
Output for the function Output columns:
MDC
Trans
Symbol
Bate
Assessment Date
Previous Modified Date
Previous Modified Price
Latest Modified Date/Time
Latest Modified Price
For example, , if you are interested in viewing any price corrections to high, low or closing prices for symbol aaYWY03 over the past 15 days, enter =PlattsPriceCorrection((“aaYWY03”,”h,l,c”,”15 days”).
Note: if you have entered a symbol which does not have correction, populate only the columns that have data.
30 Platts™ Excel® Add-In User Guide
Function:
PlattsPriceWatchListThis retrieves your list from the Platts Watch List.
Function is to retrieve your list from the Platts Watch List
=PlattsPriceWatchList
Output for the function Output columns: Watch List name
Function:
PlattsWatchListDetailsThis retrieves the details of one Watch List.
Function is to retrieve details of one Watch List you have created
=PlattsPriceWatchListDetails Inputs that need to be given are: Watch List name
Output for the function Output columns:
MDC
Symbol
Description
Bates (not the price) example: h,l,c; if not possible, hlc
Platts™ Excel® Add-In User Guide 31
Function:
PlattsSubscriptionThis retrieves the full list of MDCs to which you are subscribed.
Function is to retrieve your Platts subscription list
=PlattsSubscription
Output for the function Output columns: MDC
Function:
PlattsSubscriptionDetailsThis retrieves the price and reference data for one MDC.
Function is to retrieve details of one Platts subscription to which you subscribe
= PlattsSubscriptionDetails Inputs that need to be given are: MDC name
Output for the function Output columns:
MDC
Symbol
Description
32 Platts™ Excel® Add-In User Guide
Platts eWindow Market Data functions
PLATTS.TRADEDATA Returns a multi-dimensional array of fields from the Platts eWindow database. Choose what data is returned using the ‘Filter’ parameter
PLATTS.TRADEDATA.COLUMNS Returns a multi-dimensional array of fields that are available in the Platts eWindow Market Data schema
PLATTS.TRADEDATA.COLUMNS.VALUES
Returns an array of distinct values for any column in the Platts eWindow database
PLATTS.TRADEDATA.NRT Returns a multi-dimensional array of fields from the Platts eWindow database in near real-time. Choose what data is returned using the ‘Filter’ parameter and whether to continually append rows of data
Platts™ Excel® Add-In User Guide 33
Function:
PLATTS.TRADEDATAThis returns a multi-dimensional array of fields from the Platts eWindow database. Choose what data is returned using the ‘Filter’ parameter.
Function is to retrieve Platts eWindow Market Data from the Platts eWindow database
=PLATTS.TRADEDATA No mandatory input parameters. The default function with no parameters results in all 60 columns with the data restricted to last 24 hours
Output for the function Output columns: Based on the input parameter ‘ColumnNames’, the function can fetch up to 60 columns available within the Platts eWindow database schema
Optional parameters
ColumnNames The array of columns to return from the Platts eWindow database schema. Entering nothing returns all columns
Filters The condition or criteria array in the form of a number, expression or text that defines which criteria to filter the data in the Platts eWindow database. Entering nothing in ‘ColumnNames’, ‘Filters’ and leaving ‘Distinct’ as ‘False’ will return the latest 24 hours of data for your subscription
OrderBy The array of columns to order the returned data. Entering nothing orders by the default column, ‘UPDATE_TIME’ oldest to newest
Headers A logical value to provide headers for every column returned from the Platts eWindow database
• ‘True’ returns headers
• ‘False’ or omitted does not return headers
Distinct A logical value to return distinct records of data from the Platts eWindow database
• ‘True’ returns only distinct rows of data as perthe ‘Filters’ and ‘ColumnNames’ expressions
• ‘False’ or omitted returns every data row
For example:
• To fetch distinct values of all Products, we can use =PLATTS.TRADEDATA({“Product”},,,TRUE)
• For all Counterparties in orders of a price greater than 100, =PLATTS.TRADEDATA({“Counterparty”},{“Price”;”>100”})
34 Platts™ Excel® Add-In User Guide
Function:
PLATTS.TRADEDATA.COLUMNSThis returns a multi-dimensional array of fields that are available in the Platts eWindow Market Data schema.
Function to return a multi-dimensional array of fields that are available in the Platts eWindow Market Data schema
=PLATTS.TRADEDATA.COLUMNS No mandatory input parameters. The default function results in a list of columns available in the Platts eWindow Market Data schema, along with their description and examples
Output for the function Output columns: Based on the input parameter ‘ColumnNames’, can fetch up to 60 columns available in the Platts eWindow Market Data schema
Optional parameters
ColumnNames The array of columns to return from the Platts eWindow database. Entering nothing returns all columns
HideDetails A logical value that specifies whether you want PLATTS.TRADEDATA.COLUMNS to display or hide metadata about the fields.
‘True’ hides the metadata
‘False’ or omitted does not hide the metadata
For example:
• To fetch an array of all Columns and their descriptions, we can use =PLATTS.TRADEDATA.COLUMNS()
• To fetch an array of all Columns, we can use =PLATTS.TRADEDATA.COLUMNS(,True)
Platts™ Excel® Add-In User Guide 35
Function:
PLATTS.TRADEDATA.COLUMNS.VALUESThis returns an array of distinct values for any column in the Platts eWindow database.
Function to return an array of distinct values for a column from the Platts eWindow Market Data schema
=PLATTS.TRADEDATA.COLUMNS.VALUES
Returns distinct values for a single column from the Platts eWindow database
Output for the function Output columns: Returns distinct values for a single column from the Platts eWindow database
Optional parameters ReverseOrder A logical value to reverse the sort order of the values returned
• ‘True’ returns distinctdata in reversealphabetical order
• ‘False’ or omittedreturns data inalphabetical order
For example:
• To fetch an array of distinct values for Products: =PLATTS.TRADEDATA.COLUMNS.VALUES(“Product”)
36 Platts™ Excel® Add-In User Guide
Function:
PLATTS.TRADEDATA.NRTThis returns a multi-dimensional array of fields from the Platts eWindow database in near real-time. Choose what data is returned using the ‘Filter’ parameter and whether to continually append rows of data.
Function is to return a multi-dimensional array of fields from the Platts eWindow database in near real-time
=PLATTS.TRADEDATA.NRT No mandatory input parameters. The default function with no parameters results in all 60 columns being returned to one continually overwriting row in near real-time
Output for the function Output columns: Based on the input parameter ‘ColumnNames’, the function can subscribe to up to 60 columns available within the Platts eWindow database schema
Optional parameters
ColumnNames The array of columns to subscribe to from the Platts eWindow database schema. Entering nothing returns all columns
Filters The condition or criteria array in the form of a number, expression or text that defines which criteria to filter the subscribed near real-time feed of data from the Platts eWindow database
Headers A logical value to provide headers for every column subscribed to from the Platts eWindow database
• ‘True’ returns headers
• ‘False’ or omitted does not returnheaders
Append A logical value to append each new row to the top of the array returned from the Platts eWindow database
• ‘True’ appends new data to the topof the array
• ‘False’ or omitted returns data to asingle row
For example:
• Show me the latest traded Product =PLATTS.TRADEDATA.NRT({“Product”},,TRUE)
Glossary
Platts Assessment Data terminology
Transaction type explanations
Assessment and transaction dates are displayed in a yyyy-mm-dd hh:mm format, and 24-hour clock format.
Transaction type New (N)• FTP files contain N entries for price values
published for the first time on the current day
• They may be values dated today, or prior-day prices(e.g. postings, monthly averages) published for thefirst time today
• If a price (current-day or delayed prior-day) isentered into the database for the first time todayand then corrected before publishing, it will still bepublished as a single N record
• Although very rare, it is therefore possible to havean N entry for a symbol and an N entry for the samesymbol/bate/date with a different value later in thesame day; the later value is always the one to beused for charts
Behavior:
• When the transaction type is N with the currentdate, the price will appear on the Real time pricesworkbook and the price will be in green/red/blackbased on the price movement
• If the price is published again for the same day withtransaction type N along with a new price, then thelatest price should override the previous price; thelatest price will always be shown
Platts™ Excel® Add-In User Guide 37
38 Platts™ Excel® Add-In User Guide
Transaction type Future-Dated (F)• Most price values in Market Data ftp files have
assessment dates of current date or earlier. However, Platts databases have some prices with assessmentdates in the future; examples include ‘flow date’ power and natural gas prices, and some OSPs(Official Selling Prices) for crude oil
• Future-dated prices appear as F entries to identifythem as future-dated
• For example: price for symbol aaeUQ0 forassessment date December 11, 2014 is publishedon September 24, 2014; since the assessment dateis later than the published date, the transaction hasto be F to complete the example; this price appearsagain as transaction type N on the assessment dateDecember 11, 2014
• If the price in the aforementioned example wasentered on September 24, 2014 and then correctedon October 2, 2014, the price would appear as an Fentry because the assessment date is later than thepublished date; the corrected price would appear astransaction type N on December 11, 2014
Behavior:
• When the transaction type is F, it has a futureassessment date
• If the price is corrected for the same symbol and theassessment date is still in the future, the transactiontype will remain F
• When the assessment date becomes current, itshould appear with transaction type N
Transaction type Change/Correction (C)• The transaction type will be C for prices dated and
published before current date, and changed on thecurrent date
• The prices with C entries will always reflect thecurrent price in the Platts database
• The update timestamp shows the time (GMT)the value was changed in the Platts databa
Behavior:
• In the Real time prices workbook, when thetransaction type is C for any symbol with a currentassessment date, the cell with a correction will behighlighted in a darker shade of the blue featuredon the Home page
• When moving your mouse over or clicking thehighlighted cell, the Platts™ Excel® Add-In willdisplay a pop up with columns as listed in the“Real time” section of this document
• In the Real time prices workbook, when thetransaction type is C for any symbol with anassessment date prior to the current date(i.e. the assessment date is not the currentdate but a historical date), a new row will beinserted into the workbook price for theprice/bate that was corrected. When yourefresh this workbook, the second row willdisappear from the screen
• In the Historical prices workbook, when thetransaction type is C, the correction cell will behighlighted
• When moving your mouse over or clicking thehighlighted cell, the system will display a pop up withcolumns as listed in the “Historical” section of thisdocument
• When moving your mouse over or clicking thehighlighted cell, the system will display a pop up withthe following columns:
– MDC
– Trans
– Symbol
– Bate
– Assessment Date
– Previous Modified Date
– Previous Modified Price
– Latest Modified Date/Time
– Latest Modified Price
Transaction type Delete (D)• The transaction type will be D only for prices deleted
on the current date
• This transaction type will not appear on Excel UI
Behavior:
• When a price is deleted for a symbol/bate, thePlatts™ Excel® Add-In should automatically showthe previous price for the symbol/bate
Platts™ Excel® Add-In User Guide 39
40 Platts™ Excel® Add-In User Guide
Bate columns
Column name Column description
Close (c) Close or mean pricet
High (h) t High price
Low (l) Low price
Unspecified (u) Index price or as indicated in symbol description
Ask Price (a) Ask price
Bid Price (b) Bid price
Open Price (o) Opening price
Open Interest (e) Number of contracts outstanding
Volume (w) Total traded volume
Trades (t) Deal count or number of trades
Reference Data columns
Column name Column description
Update Type Indicator for event type (add, change, delete etc.). Changelog file only
Symbol Platts symbol
Market Data Category Platts Market Data categories in which the symbol is published, separated by pipe (|)
Description Short Platts description for the symbol
Currency Code Three letter code representing the currency of the commodity referenced
Unit Of Measure Code identifying the unit of measure for the numerical data
Common Conversion Factor Common conversion factor to convert the data into alternative units
Common Conversion Function Mathematical operator to convert the data into alternative units
Common Conversion Target Unit Code identifying the common conversion target unit of measure
Publication Frequency Code Code representing the frequency of the publication
Timestamp Time of day the assessment is taken
Bates Available data items
Decimal Places Number of decimal places
Earliest Value Earliest date that values are available from for a given symbol
Latest Value Latest date that values are available from for a given symbol
Active Status flag indicating whether the symbol is currently active
Shipping Terms Shipping terms for delivery
Delivery Method Method of transportation for delivery
Delivery Region General region to which the commodity is delivered
Delivery Region Basis Basis location to which the commodity is delivered
Contract Type Type of contract, e.g. spot, forward, future etc.
Platts™ Excel® Add-In User Guide 41
>> continued
42 Platts™ Excel® Add-In User Guide
Reference Data columns
Column name Column description
Settlement Type Final settlement method, physical/financial
Quotation Style Prices quotation style
Commodity Generic commodity category
Commodity Grade Specific commodity grade within the commodity category
Sulfur Sulfur content of the commodity in percentage
Freeze Point Freezing point of the commodity in Celsius
Pour Point Pouring point of the commodity in Celsius
Flash Point Flash point of the commodity in Celsius
RON Research Octane Number
Kinematic Viscosity Kinematic viscosity in mm²/s
Density Density of the commodity in kg/m³
API Gravity Specific gravity as measured in American Petroleum Institute degrees
Derivative Position Derivatives position in the forward curve
Derivative Maturity Frequency Duration of the derivative maturity
Swap Fixed Leg Symbol Underlying symbol for the fixed leg of a swap
Swap Floating Leg Symbol Underlying symbol for the floating leg of a swap
Exchange Exchange the contract is listed
Notional Contract Notional contract maturity period
Standard Lot Size Standard size of a contract
Standard Lot Units Code identifying the unit of measurement corresponding to the contract size
Load Type Level of electric power supplied
EXCEL is a registered trademark of Microsoft Corporation in the United
States and/or other countries.
For more information, please visit us online or speak to one of our sales specialists:
www.platts.com
North America +1-800-PLATTS8 (toll-free) +1-212-904-3070 (direct)
EMEA +44-(0)20-7176-6111
Latin America +55-11-3371-5755
Asia-Pacific +65-6530-6430
Russia +7-495-783-4141
© 2017 S&P Global Platts, a division of S&P Global. All rights reserved. OLFS0317