Overview
This guide is intended to get you set up with our latest Excel Add-in. This is the version that replaced our older VBA Excel add-in.
The Spark Excel add-in is supported for the following Excel versions: - Microsoft Excel 2013, Microsoft Excel 2016 Microsoft Excel 2019, Excel 365 MSO 64 bits and Excel 365 MSO.
1) Installation
All users are encouraged to install the add-in from AppSource (Section 1.1), the official Microsoft store for Excel add-ins.
However, there may be some organisations who block their users from installing from AppSource, which we then provide alternative sideloading methods to install our Excel add-in:
1.1) AppSource
If you use Excel installed on Windows/MacOS:
- If you have the previous Spark Excel add-in, uninstall it, shown in Section 2.
- Go to AppSource to install onto your account.
- “Get it now”. Should you face issues opening the link, this direct link might help.
- “Open in Excel”.
- Open Excel, you may need to “Trust this add-in”. Login to Spark using your https://app.sparkcommodities.com/ credentials.
1.2) Microsoft Office Online
If you use Excel on your web browser and have download permissions from Microsoft Office Online
-
Login to your online office account:
-
Open blank sheet, navigate to Insert -> Add-ins.
-
Search Store for “Spark Commodities” and add
-
This will launch the add-in. Login to Spark using your https://app.sparkcommodities.com/ credentials.
1.3) Windows fallback
If you use Excel installed on Windows and don’t have download permissions from AppSource/Microsoft Office Online:
This installation will show you how to 1) create a folder to house the Spark add-in download, 2) instruct Excel to read the add-in, and 3) Insert the add-in to excel.
-
If you have the previous Spark Excel add-in, uninstall it, shown in section 2.
-
Download the Spark manifest .xml file here. You might need to right click and ‘save as…’ or ‘save link as…’.
-
Move the manifest .xml file into a folder
- Go to “Properties” of this folder
- Go to sharing tab, and click on share.
6. Ensure the person who will use it is owner or is added with read/write permissions and click share
7. Make a note of the file path for use later.
8. Open excel and go to File -> Options
9. In trust center, click on ‘Trust Center Settings’
- Go to ‘Trusted Add-in Catalogs’ and Input the saved file path of the file you obtained in step 6.
- Add catalog and tick ‘show in menu’
- Create a new registration entry for the downloaded manifest .xml file. To do this, search for the Notepad application (txt file) on your computer, and insert the following text:
Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\WEF\TrustedCatalogs{-random-GUID-here-}]
“Id”="{-random-GUID-here-}"
“Url”="\\-share-\-folder-"
“Flags”=dword:00000001
- Replace the two “-random-GUID-here-” with a GUID code you can generate here (click “Generate some GUIDs!”).
Also replace -share-\-folder- with the folder location from number 6, but edit all single “\” into double “\”, as below:
The final text will be something like:
Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\WEF\TrustedCatalogs{841abd20-a6b8-4a72-898b-df0a7827ecXX}]
“Id”=“{841abd20-a6b8-4a72-898b-df0a7827ecXX}”
“Url”=“\\DESKTOP-QCPADFN\Users\edjar\OneDrive\Desktop\Spark Add-in”
“Flags”=dword:00000001
-
Save this file as “TrustNetworkShareCatalog.reg”
-
Double click the file and run it. You may need to allow/accept some pop ups.
-
Now to include the add-in in Excel. Restart Excel and navigate to Insert - My Add-ins
-
Under “Shared Folder” select Spark Commodities and click add
-
This will launch the add-in. Login to Spark using your https://app.sparkcommodities.com/ credentials.
Installation adapted from: https://learn.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins
1.4) MacOS fallback
If you use Excel installed on MacOS and don’t have download permissions from AppSource/Microsoft Office Online
Prerequisites for Office on Mac
- A Mac running OS X v10.10 “Yosemite” or later with Office on Mac installed.
- Excel on Mac version 15.19 (160206).
- If you have the previous Spark Excel add-in, uninstall it, shown in section 2.
- Download the Spark manifest .xml file here.
- Go to the following filepath. If the wef folder doesn’t exist on your computer, create it by right clicking and then creating the folder.
/Users/[your Mac username]/Library/Containers/com.microsoft.Excel/Data/Documents/wef
- Copy the downloaded Spark manifest file to this wef folder.
- Open Excel, and then open a sheet. You may need to restart Excel if it’s already running.
- In Excel, choose Insert > My Add-ins (▼ drop-down menu), and then choose SparkCommodities
- Note: Be sure to click the ▼ arrow on the right, not the My Add-ins button
- Verify that the Spark add-in is displayed in Excel under the Home ribbon.
- Click on the newly added Spark button to show the Spark pane. Login to Spark using your https://app.sparkcommodities.com/ credentials.
2) Uninstalling previous add-in
-
Uninstall by going to File -> Options -> Add-ins. Click “Go”.
-
Then make sure the previous Spark add-in is un-ticked. Then click “OK”.
3) Using the Excel Add-in
This article helps you get logged in to the Spark Excel Add-in and quickly download Spark data.
-
Logging in: Once the add-in is successfully installed, click the Login button on the Spark ribbon and login with your existing email and password that you use on your Spark account. If you do not have a Spark account, then you can create one by clicking the “Create your Spark account”. It will direct you to the registration page.
-
Product Selection: Once you log in and subject to your Spark subscription you will have 3 choices which represent the different Spark data products:
- LNG Freight
- LNG Freight FFA
- LNG Basis (will we have LNG Basis Financial as separate?)
Select the relevant product data set.
- Data Display:
- Select the relevant data/contracts for display.
- Select the Price Unit
- Select the Price Release Type Click “Insert data into selected cell”.
Please note this will depend on the cell that has been previously selected.
- Example output
4) Troubleshooting
4.1) Legacy VBA
If you use Windows and the installation methods above do not work, you can revert to the previous Excel add-in:
Our legacy VBA Excel Add-in can be useful considering operating system constraints or the extra caveats installing the excel add-in via sideloading. Unfortunately this method of add-in installation is not supported currently on MacOS.
- Download the Excel Add-In file here and save the add-in
file in a suitable location. The latest version of the add-in is v1.3.1 from 09 May 2022.
- Choose File > Options within Excel
- From Options, choose Add-ins, Manage ‘Excel Add-ins’ -> Go.
- Within the Add-ins window, choose ‘Browse’ and browse to the location of the add-in file. Make sure to check the “Spark Excel Addon” to enable it.
To ensure the Spark Add-in remains in your Excel Ribbon take the following steps:
- Open the Trusted Locations menu. File > Options > Trust Center > Trust Center Settings.
- Go to Trusted Locations and press the ‘Add new location…’ button.
- Click the ‘Browse…’ button. Navigate to the folder that contains your add-in files and press OK. If your add-ins are organized in subfolders then click the “Subfolders of this location are also trusted” checkbox.
- Press OK, then press OK again on the Trust Center Window. Close and re-open Excel.
- ‘Unblock’ the Excel Add-in by right clicking it in the folder you saved it in and choose ‘Properties’ and check ‘Unblock’.
4.2) Data availability
Data availability depends on your permission rights.
Spark naming conventions for the following criteria are available via the Spark API.
- Contracts Groups
- Contracts
- Price units
- Release date: date of assessment
- Contract type: front month, forward
- Calendar month: delivery month
- Period start: first day of delivery window
- Period end: last day of delivery window
- Prices: Spark price, You