Spci Platts Excel Add in Userguide
Spci Platts Excel Add in Userguide
November 2022
spglobal.com/commodityinsights
Introduction
Platts™ Excel® Add-In Beta is a new generation digital data delivery platform
that allows easy access to proprietary Platts Market data and Analytics
content. Content templates are included for a streamlined user experience.
This document provides users with a simple step-by-step guide to using the
Platts™ Excel® Add-In.
< 2 >
Table of contents
Introduction 2
Ribbon bar 4
Signing in 5
Forgot password 5
Templates 5
Search 18
< 3 >
Ribbon bar
When you open Excel and select the Platts Excel Update: updates your Platts Excel Add-in
Add-in option from the menu, the Ribbon bar will to the latest available version.
display, with all options disabled except for ‘Sign
In.’ (For details, refer to the ‘Signing In’ section
below.)
Welcome Walk-Through
When you install the newest
generation of the Platts Excel
Search Screens: provides querying ability to PEA Add-in for the first time, a
customers and allows the search result to be sidebar is displayed that gives
exported back to excel. This allows customer to you an overview of the new
build their own templates by applying the filters. application, in detail.
1.
Methodology
displays a web
page of the PEA
methodology
2. F
eedback initiates
an email you can
use to send us your
feedback
4. About Us
< 4 >
Signing in
If the Platts™ Excel® Add-In does not
recognize your login credentials, please
make sure you have entered the correct
email address and password (keep in mind
that the password is case-sensitive).
Forgot password
Click on the ‘Forgot your password?’ link on the
‘Sign In’ window.
Templates
Platts provides a few pre-configured templates
for Platts Market Data and Analytical content.
These templates can be accessed from the
Templates drop-down on the Ribbon bar.
< 5 >
Platts Excel Add-In functions
We have built several generic Platts
Excel Add-in functions that may be
reused across datasets.
PlattsDataSet This will return the list of datasets available via Platts Excel Add-in. If a
dataset name is mentioned, then this function returns details about the
selected dataset.
PlattsGetData This function will return the data for the selected dataset and data series
based on given parameters.
PlattsGetMetadata This function will return the metadata for the selected dataset.
PlattsStreamData The function will stream data for the selected symbol or eWindow Market
Data, e.g., Stream Trade data for EWMD or Stream Prices for MD
PlattsToday This function will give today’s date, and it is a non-volatile version of excel
native Today(). This function will return today’s date.
Description
Use the PlattsDataSet function to get a list of all the datasets available via Platts Excel Add-in. If
the dataset name is mentioned in the function, it will provide details about the selected dataset,
including all the columns as well as a description of each.
Syntax
– The function should return the result to the cell below the cell from which the function is called.
=PlattsDataSet()
Dataset Name String The name of the dataset the user wants to view.
< 6 >
Example result set
PlattsDataSet ([Dataset Name])
Example Dataset
=PlattsDataset()
Platts Market Data MD latts Market Data – Receive and interpret our energy,
P
petrochemicals, metals, shipping and agriculture data faster and
easier than ever before.
World Refinery Database WRD latts World Refinery Database provides a comprehensive view of
P
the entire downstream value chain, from crude inputs to detailed
product outputs. Access outage, capacity, runs and yields data for
crude and refined products. Integrate the data with your proprietary
models and visualization tools, digitally transforming your enterprise
using timely, dynamic insights.
=PlattsDataset("WRD")
WRD_LIST
< 7 >
ProcessUnits Metadata Get All Process Units
Runs Dataseries Get refinery runs. Users can retrieve the annual crude runs for each
refinery.
Common Problems
Problem Syntax What Went Wrong
Invalid Function #NAME? If the function is entered incorrectly, Excel will return the native Excel
error, '#NAME?' in the same cell in which the function is
entered, e.g. = PlattsDatasSeries ()
No Results Found #N/A If the function returns no results, Excel will return the native Excel
error, '#N/A' in the same cell in which the function is entered.
No Matching Value #VALUE! Passing incorrect arguments within the function parameters will
return the native Excel error, '#VALUE!' in the cell below the one in
which the function is entered, e.g. =PlattsDataSet({"ProduWct"}) will
return an error.
Invalid Reference #REF! Providing a reference that does not exist, or Argument
deleting a reference that is used by a function, will return the native
Excel error, '#REF!' in the entire array.
PlattsDataSeries function
This article describes the formula syntax and usage of the PlattsDataSeries function in Microsoft Excel.
Description
Function to return details about the data series(type of data to be downloaded) for Dataset. The list will contain
columns applicable to the data series and their attributes.
Syntax
PlattsDataSeries(Dataset as text, DataSeries as text) For example:
=PlattsDataSeries("WRD","Capacity")
=PlattsDataSeries("Petchem-Analytics","Prices")
=PlattsDataSeries("MD","Current-Symbol")
=PlattsDataSeries("eWMD","Tradedata")
DataSeries (required) String Name of the data series to download its details
< 8 >
Example
=PlattsDataSeries("WRD","Capacity")
Owner.Name Process unit owner - company name Yes Yes Yes Yes No
Mbcd Thousand barrels per calendar day Yes Yes Yes No Yes
Mbsd Thousand metric tons per stream day Yes Yes Yes No Yes
ModifiedDate A timestamp indicating when this Yes Yes Yes Yes Yes
record was last modified
It will return all the fields that are applicable to the capacity dataseries under WRD
=PlattsDataSeries("MD","Current-Symbol")
< 9 >
Name Description Can be Can be Can be Can be Can be used for
Selected Filtered Sorted Grouped Aggregation
Functions
Remarks
– The function will return the result to the cell below from which the function is called.
– The cell from which function is called will display its Dataset_DataSeries Name
Common Problems
Problem Syntax What Went Wrong
Invalid Function #NAME? If the function is entered incorrectly, Excel will return the native Excel
error, '#NAME?' in the same cell in which the function is entered, e.g.
=PwLATTS.gtseies()
Invalid Reference Argument #REF! Providing a reference that does not exist, or deleting a reference that
is used by a function, will return the native Excel error, '#REF!' in the
entire array.
Invalid Header #VALUE! If the Header Name is misspelt or does not exist, the error message
“Invalid Header” will appear
PlattsGetData function
This article describes the formula syntax and usage of the PlattsGetData function in Microsoft Excel.
Description
Function will return data for the selected dataseries, e.g. Capacity information for WRD, or Outages information for
Petchem-Analytics Analytics.
< 10 >
Syntax
PlattsGetData( DataSet Name as Text, DataSeries as Text, optional Columns as Array, optional Filter as Text, optional
Sorting as Text, optional GroupBy as Array, optional Aggregation as Text)
Example
=PlattsGetData("wrd","capacity")
=PlattsGetData("wrd","runs")
=PlattsGetData("WRD","Capacity",,"ModifiedDate>=2019/03/20 and ModifiedDate<=2019/03/31")
=PlattsGetData("md","Current-Symbol",,"Symbol='PCAAS00'")
=PlattsGetData("md","current-symbol",,"symbol in ('AAALS04','AAAMX22','AAAUG00','AAAUH00','AAAUI00','AAAUJ00','
AAAUK00','AAAUM00','AAAUN00','AAAUT00')")
=PlattsGetData("ewmd","Tradedata")
Columns (optional) Array If provided, will return the columns for the dataseries. If not provided,
will return all the columns applicable for the dataseries
Filter (optional) Text/Range Is condition or criteria specified as text or range to filter the data for
selected dataseries
Sorting (optional) Array If provided, it will sort the result set based on a given list of column(s)
Group_BY (optional) Array If provided, will group data based on the given list of column(s)
Aggregation (optional) Text If provided, will aggregate the data using aggregation functions (Min,
Max, Count, Sum, Average)
Example
GetData Function:
=PlattsGetData("wrd","Capacity")
=PlattsGetData("wrd","Runs")
=PlattsDataSeries("Petchem-Analytics","Assumptions")
Columns
=PlattsGetData("Wrd","Capacity","Refinery.Name,Owner.Name,Year,Mmtcd")
Filters
Filters can be passed as text or excel cell ranges.
Passing as Text
Filters can be passed as text by writing it them in the function. The value needs be enclosed in single quotes, whereas
the entire expression will be enclosed by double quotes. All the logical operators can be used to construct a query.
Greater Than
=PlattsGetData("wrd","runs",,"year>2010")
=PlattsGetData("ewmd","TradeData","price","Order_Date>=1/1/2021")
< 11 >
Less Than
=PlattsGetData("Petchem-Analytics","Prices",,"DateYear<2022")
=PlattsGetData("ewmd","TradeData","price","order_date<=1/1/2022"
With Dates
=PlattsGetData("Petchem-Analytics","Outages",,"Startdate>=01-01-2021 and Enddate<=01-01-2022","StartDate
desc")
=PlattsGetData("md","history-symbol",,"Symbol in ('AAALS04'','AAAMX22'','AAAUG00'','AAAUH00'','PCAAS00'','XI
CE001') and moddate>=2021-01-01 and moddate<=2022-01-01")
=PlattsGetData("md","correction-symbol",,"symbol IN ('PCAAS00','XICE001','AAALS04','AAAMX22','AAAU
G00','AAAUH00',' AAAUI00') and MODDATE>=01/01/2020 and MODDATE<=10/15/2021 and bate='c' and
correctionType='upd'","Symbol desc,assessdate,moddate")
=PlattsGetData("md","correction-modified-date",,"moddate>=01/01/2020 and
moddate<=01/01/2022","assessdate")
=PlattsGetData("md","correction-modified-date",,"Moddate=2021-10-11 and Bate in ('c','e','u')")
=PlattsGetData("ewmd","tradedata","market,product,hub,strip,order_date,order_id","window_region='europe' and
order_date>=25-01-2022 and order_date<=01-01-2023")
Nested (w/'And')
=PlattsGetData("Petchem-Analytics","Outages",,"Product='Ethylene' and (Region='South America' or
Region='North America') and StartDate>=2015-11-03 and EndDate<=2017-03-31")
Contains
=PlattsGetData("Petrochemical Analytics","outages",,"Startdate>=01/01/2015 and Enddate<=10/31/2022 or
(Country='*sta*')","StartDate desc,capacity desc")
=PlattsGetData("ewmd","tradedata",,"market='*bunker*' and product='Platts*'",,"market","count(market),
avg(price)")
=PlattsGetData("Petchem-Analytics","Assumptions",,"ValueType='Demand Increase' and Country='Austria' and
DateYear=2022")
< 12 >
Passing as Range
You can select the ranges as filter expressions. The columns adjacent to each other will form the ‘and’ condition, and
rows next to each other will develop ‘or’ condition:
Sorting
– This parameter will help sort the data by the list of columns, in either ascending or descending order.
Group By
– This parameter will group the result based on the given columns provided. The column parameter will not work if
group by is provided.
=PlattsGetData("Wrd","capacity",,"Year=2020",,"Owner.Name,Refinery.Name,ProcessUnit.Name")
=PlattsGetData("ewmd","TradeData",,"Order_Date=1-2-2022",,"market,product")
Aggregation
– This parameter will return the aggregated result (min,max,sum,avg,count) for the column selected in the group by
parameter
=PlattsGetData("wrd","capacity",,"Year=2020",,"Owner.Name,Refinery.Name,ProcessUnit.Name","Sum(mmtcd)")
=PlattsGetData("ewmd","TradeData",,"price=100",,"market,product","sum(price),count(order_id)")
Remarks
– The function will return the result to the cell below from which the function is called.
– The cell from which function is called will display its Dataset_Metadata Name
< 13 >
Common Problems
Problem Syntax What Went Wrong
Invalid Function #NAME? If the function is entered incorrectly, Excel will return the native Excel
error, '#NAME?' in the same cell in which the function is entered, e.g.
=PwLATTSMetdddata()
Invalid Reference Argument #REF! Providing a reference that does not exist, or deleting a reference that
is used by a function, will return the native Excel error, '#REF!' in the
entire array.
Invalid Value #VALUE! If the Argument Value is misspelt or does not exist, the error message
“Invalid Header” will appear
PlattsGetMetaData function
This article describes the formula syntax and usage of the PlattsGetMetaData function in Microsoft Excel.
Description
Function to return details about the metadata details for selected dataset
Syntax
PlattsDataSeries(Dataset as text, DataSeries as text)
Example
=PlattsDataSeries("WRD","Capacity")
=PlattsDataSeries("WRD","Outages")
=PlattsDataSeries("WRD","Margins")
Filter (optional) String The condition or criteria to filter the Metadata response in the form
of text or range
Sorting (Optional) String If provided, it will sort the result set based on a given list of column(s)
Top Rows (Optional) Number If provided, then it will return the top records based on the number
provided as an input
Example
Download the metadata for Regions
=PlattsGetMetaData("wrd","regions")
< 14 >
With Columns :
=PlattsGetMetaData("wrd","regions","Name")
Filters
Starts With and Ends With
=PlattsGetMetaData("wrd","regions",,"Name='*a'")
=PlattsGetMetaData("wrd","regions",,"Name='A*'")
With OR
=PlattsGetMetaData("WRD","regions",,"Name='Africa' or Name='China'")
Equal and not equal
=PlattsGetMetaData("wrd","regions",,"Name<>'Africa' or Name='China'")
=PlattsGetMetaData("WRD","regions",,"Name<>'E*'")
Sort
=PlattsGetMetaData("wrd","regions",,,"Name desc")
=PlattsGetMetaData("wrd","cities")
Top
=PlattsGetMetaData("wrd","cities",,,,800)
=PlattsGetMetaData("wrd","cities",,,,1800)
Remarks
– The function will return the result to the cell below from which the function is called.
– The cell from which function is called will display its Dataset_Metadata Name
Common Problems
Problem Syntax What Went Wrong
Invalid Function #NAME? If the function is entered incorrectly, Excel will return the native Excel
error, '#NAME?' in the same cell in which the function is entered,
e.g.=PlattsGetdddta()
Invalid Reference Argument #REF! Providing a reference that does not exist, or deleting a reference that
is used by a function, will return the native Excel error, '#REF!' in the
entire array.
Invalid Value #VALUE! If the Argument Value is misspelt or does not exist, the error message
“Invalid Header” will appear
PlattsStreamData
This article describes the formula syntax and usage of the PlattsStreamData function in Microsoft Excel.
Description
The function will stream data for the selected symbol or eWindow Market Data, e.g., Stream Trade data for EWMD or
Stream Prices for MD
< 15 >
Syntax
PlattsStreamData (Dataset name as Text, Dataseries as Text, optional Columns as Array, optional Filter as Text)
Example
=PlattsStreamData("md","stream-prices",,"symbol in ('XNBR001','XNBR016','XNBR017','XNBR018')")
=PlattsStreamData("ewmd","Stream-tradedata",,"market='ASIA Crude Cargo' and market='EU MidDist Derivative'
and product='Platts Cash BFOE' and hub='Partials BFOE'")
Columns (optional) Array If provided, will return the columns for the dataseries. If not provided,
will return all the columns applicable for the dataseries
Filter(optional) Text Is condition or criteria specified as text or range to filter the data for
selected dataseries
Example
=PlattsStreamData("md","stream-prices",,"symbol in ('XNBR001','XNBR016','XNBR017','XNBR018')")
=PlattsStreamData("ewmd","Stream-tradedata",,"market='ASIA Crude Cargo' and market='EU MidDist Derivative'
and product='Platts Cash BFOE' and hub='Partials BFOE'")
Columns
=PlattsStreamData("md","stream-prices","bate, value, trans ","symbol in
('XNBR001','XNBR016','XNBR017','XNBR018')")
=PlattsStreamData("ewmd","Stream-tradedata","Market,Product,hub,strip,price","market='ASIA Crude Cargo' and
market='EU MidDist Derivative' and product='Platts Cash BFOE' and hub='Partials BFOE'")
Filters
Filters can be passed as text or excel cell ranges.
< 16 >
Remarks
– The function will return the result to the cell below from which the function is called.
– If the user is entitled and the connection is successful, it will return the message “Successfully connected to Platts
Streaming Services”.
– If the user is not entitled, it will return the message like “Forbidden - DataType "symbols" not found. Please contact a
Platts Representative to gain access.”
– The cell from which function is called will display its Dataseries_Data Name
Common Problems
Problem Syntax What Went Wrong
Invalid Function #NAME? If you enter the incorrect function, Excel will return the native Excel
error, '#NAME?' in the same cell where the incorrect function is
entered, e.g., =PwLATTSStreamddata()
Invalid Reference Argument #REF! Providing a reference that does not exist or deleting a reference used
by a function will return the native Excel error, '#REF!' in the entire
array.
No Results Found #N/A If the function returns no results, Excel will return the native Excel
error, '#N/A' in the same cell entered the function.
Invalid Argument #VALUE! If the Argument Value is misspelled or does not exist, the error
message “#VALUE!” will appear
PlattsToday
This article describes the formula syntax and usage of the PlattsToday function in Microsoft Excel.
Description
The PlattsToday function will give today’s date, and it is a non-volatile version of excel native Today(). This function will
return today’s date.
Syntax
PlattsToday()
Example
=PlattsToday()
Common Problems
Problem Syntax What Went Wrong
Invalid Function #NAME? If you enter the incorrect function, Excel will return the native Excel
error, '#NAME?' in the same cell where the incorrect function is
entered, e.g. =PwLATTSToday()
< 17 >
Search Screens
The Search Screen provides querying ability ot PEA customers and allows the search result to be exported back to excel.
This allows customers to build their own templates by applying the filters.
• History-Symbol: Allows querying historical Data by selecting the date and symbols
For eWindow Market Data, the only option is TradeData. This will allows to search data for MOC.
< 18 >
After you hit enter, all the matching
symbols with entered search text
will be loaded on the screen. On the
left hand side we have filters, middle
grid with all the matching symbols
and right export button to export the
results to MS-Excel in current cell,
New Worksheet or New Workbook.
< 19 >
To export the prices to excel, click on Export dropdown and select where you want to export the data.
After selecting click on the export data button below and it will export the data for selected symbols
< 20 >
The Data will be loaded in Excel
< 21 >
After selecting necessary filters,
export the data to Excel.
< 22 >
North America Latin America Asia-Pacific
New York Buenos Aires Singapore
2 Penn Plaza, 25th Floor Tte. Gral. Juan D. Perón 346, 6th Floor 12 Marina Boulevard
New York, NY 10121-2298, USA (C1038AAH) Buenos Aires, Argentina #23-01 Marina Bay Financial Centre
P: +1-800-PLATTS8 (toll-free) P: +54-11-4121-4810 Tower 3 Singapore 018982
P: +1-212-904-3070 (direct) P: +65-6532-2800
São Paulo
Boston Av Brigadeiro Faria Lima 201 Beijing
225 Franklin Street, 21st Floor Suite 1601, 16/F Tower D
14th Floor Boston, MA 02110, USA São Paulo – SP Brasil – 05626-100 Beijing CITC
P: +1-800-752-8878 – Brazil A6 Jianguo Menwai Avenue
P: +1-617-530-8300 P: +55-11-3818-4100 Chaoyang District
Beijing 100022, China
Denver Europe, Middle East and P: +86-10-6569-2929
1800 Larimer Street,
Africa
Suite 2000 Denver, CO 80202, USA Hong Kong
P: +1-720-264-6600 London Unit 6901, Level 69
20 Canada Square International Commerce Centre
Hightstown 9th Floor, Canary Wharf London E14 1 Austin Road West
148 Princeton-Hightstown Road 5LH, UK Kowloon, Hong Kong
Hightstown, NJ 80021, USA P: +44-20-7176-6111 P: +852-2841-1035
P: +1-800-PLATTS8 (toll-free)
Dubai Shanghai
Houston DIFC, The Gate Precinct Building 1, 33/F Shanghai Plaza
Heritage Plaza Level 05 138 Huaihai Road (M) Shanghai
1111 Bagby Street, Suite 2200 P.O. Box 506650 200021, China
Houston, TX 77002, USA Dubai, UAE P: +86-21-5110-5488
P: +1-800-PLATTS8 (toll-free) P: +971-4-372-7100
Tokyo
Pittsburgh Stavanger Marunouchi Kitaguchi Building,
424 South 27th Street, Suite 306 Øvre Holmegate 1 28th Floor
Pittsburgh, PA 15203, USA 4006 Stavanger Norway 1-6-5 Marunouchi Tokyo 100-0005,
P: +1-412-431-4370 P: +47-51-89-06-66 Japan
P: +81-3-4550-8300
Washington DC
1200 G Street NW, Suite 1000 Melbourne
Washington, DC 20005, USA P: +1- Level 45, 120 Collins Street
212-904-3070 Melbourne
VIC 3000, Australia
P: +61-3-9631-2000
For more information, please contact the Platts office nearest you:
spglobal.com/commodityinsight | [email protected]
©
2022 S&P Global Commodity Insights, a division of S&P Global. All rights reserved
< 23 >