Tech Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 12

S&P Capital IQ Pro

Technical Guide
Contents

Overview.......................................................................................................................................................................................... 2

System Requirements ....................................................................................................................................................................3

Installation Details .........................................................................................................................................................................4

Saved Queries .................................................................................................................................................................................6

Browser Cache ................................................................................................................................................................................6

Dialogs .............................................................................................................................................................................................6

Connecting with a Proxy .................................................................................................................................................................7

Language Settings ..........................................................................................................................................................................7

Packaging S&P Capital IQ Pro ........................................................................................................................................................8

Custom Saved Query Location .......................................................................................................................................................8

Plugin Manager ...............................................................................................................................................................................9

Testing Your Installation .................................................................................................................................................................9


Overview
The S&P Capital IQ Pro plug-in allows users to pull data directly into a Microsoft Excel
workbook using proprietary functions. The S&P Capital IQ Pro plug-in is a web services
application that uses web-based dialogs instead of traditional VBA forms. S&P Capital IQ
Pro plug-in requires a client-side installation before users can use the application. Since
S&P Capital IQ Pro plug-in is a web services application, it accesses data over a secured
internet connection rather than from a localized network database.
Office Tools is a suite of productivity tools in Excel, PowerPoint and Word that allow users to
quickly build, format and audit Excel models; and link data from Excel models to PowerPoint,
or Word, that can be updated with the click of a button. Office Tools also offers the Content
Library, which allows users to build company-compliant presentations directly in PowerPoint,
leveraging pre-approved master templates, presentations, slides and more. The Content
Library comes in two versions Branding and Enterprise. Branding is included in the default
Office Tools installation. Enterprise, which has more robust functionality and client-side
customizability, requires additional coordination with our Support team.
Office Tools, Content Library, and the S&P Capital IQ Pro plug-in are three separate add-ins
that come packaged together in one installer that make the full S&P Capital IQ Pro suite of
products. To properly install the S&P Capital IQ Pro plug-in, the computer running the
application must meet the following system requirements.

S&P Capital IQ Pro Technical Guide 2


System Requirements
The Content Library (Enterprise Version) requires setting up an application server at your company.
Please contact our support team for more information.

Supported Windows Operating Systems: Windows 8 (32-bit & 64-bit), Windows 8.1 (32-bit & 64-bit),
Windows 10 (32-bit & 64-bit), Windows 11 (64-bit)

Supported Microsoft Excel Versions*: 2013 (32-bit & 64-bit), 2016 (32-bit & 64-bit), 2019 (32-bit & 64-bit)

Office 365 (2013 & 2016 & 2019: local installs only; excludes web
based or MS App Store versions)

Supported Browsers: Microsoft Edge, Google Chrome

Additional Microsoft Requirements: Microsoft .NET 4.8 and later, Microsoft Visual Studio 2010 Tools
for Office Runtime

Internet access to: *


.spglobal.com, idm-iag.capitaliq.com, *.snl.com

Internet access through: Port 443 (SSL)

Minimum Recommended Hardware: CPU: 2 gigahertz (GHz) or faster x86 or x64 processor
RAM: 8 gigabytes (GB) or more

* Downloading Excel via Office 365 has limited support for Excel add-ins. Please contact your IT department for assistance
with installation.

In addition to confirming that your computer meets the System Requirements listed above, you must have administrati ve
permission to download and install new software on your computer. If you are uncertain or you do not have this permission,
please contact your IT department for assistance.

S&P Capital IQ Pro Technical Guide 3


Installation Details
Once you have confirmed that you meet all the conditions above, you may install S&P Capital IQ Pro
software on your computer. Before attempting to install S&P Capital IQ Pro on your computer, close all
open instances of Excel, PowerPoint, and Word.
To download the S&P Capital IQ Pro, visit the S&P Capital IQ Pro Download Page and follow
installation instructions.

CIQ Backwards Compatibility


During the S&P Capital IQ Pro installation process, there will be an option to enable backwards
compatibility for CIQ Functions so they can be refreshed through the S&P Capital IQ Pro add-in.
S&P Capital IQ pro
would require reinstalling CIQ Excel add-in in order to refresh CIQ functions again. By choosing this
option, S&P Capital IQ Pro will inherit any of the similar settings from CIQ such as Display Null Value
As, Refresh default (Cell vs Entire Sheet).
We support CIQ backwards compatibility using host name idm-iag.capitaliq.com.
If issues are encountered with refreshing functions, the recommended steps are to:
1. Uninstall both S&P Capital IQ Pro and CIQ add-in
2. Re-install both add-ins
3. When installing S&P Capital IQ Pro, select option.
S&P Capital IQ Pro alongside the CIQ Excel add-in, and will
only refresh SNL/SPG functions, while the CIQ Excel add-in will need to be used to refresh CIQ
functions.
For Best Practices for Capital IQ Users, kindly refer to this file.

Figure 1: Option to enable CIQ functions to be refreshable using S&P Capital IQ Pro.

Post August 2021, all the new plug-in versions currently support the ability to toggle CIQ function refreshes in the Settings
window (instead of just having this option during the installation process) -

S&P Capital IQ Pro Technical Guide 4


Updating this option would require a user to close all instances of the excel application for the settings to apply
successfully.
Note: There might be instances where despite installing the plug-in, you might not see any options in the toolbar to access the product. This might be owing to
Microsoft Office blocking applications from creating child processes. Additional details are available here.

S&P Capital IQ Pro Technical Guide 5


Locations and Directories
IT administrators need to ensure that the HKEY_CURRENT_USER\Software\SNL Financial\SNL
Office registry key (and sub-
key is used to store application configuration data. For mixed environments (64-bit Windows/
32-bit Excel), registry entries should be made in HKEY_CURRENT_USER\Software\Wow6432Node\
SNL Financial\SNL Office.
IT administrators will also need to allow users to read and write to Windows .NET isolated
storage. Isolated storage is used by S&P Capital IQ Pro to store additional application
configuration data and is encrypted using Advanced Encryption Standard (AES) with a
256-bit key. docs.microsoft.com/en-us/dotnet/standard/io/isolated-storage.
The key and initialization vector for AES are also stored in isolated storage, encrypted using
Windows Data Protection API (DPAPI) in a local-machine mode. (User mode is not used because of
potential data loss scenarios associated with that mode.) Extra entropy for DPAPI for each user
is generated and stored under the registry key HKEY_CURRENT_USER\Software\SNL Financial\
SNL Office\Encryption.
Thus, the encryption is distinct for each user of a machine even though DPAPI is used in local-
machine mode. In order to ensure that one user of a machine cannot access the entropy associated
with another user of the same machine, and thereby gain access to the AES key and initialization
-control lists on the
HKEY_CURRENT_USER\Software\SNL Financial\SNL Office\Encryption key (or the entire HKCU
hive) to restrict access to the appropriate user. For mixed environments (64-bit Windows/32-bit
Excel), registry entries should be made in HKEY_CURRENT_USER\Software\Wow6432Node\SNL
Financial\SNL Office\Encryption.
S&P Capital IQ Pro supports Windows environment variables, e.g., %USERPROFILE%, when
reading the registry settings. Environment settings allow administrators to write registry keys
that are redirected to the appropriate user-specific directory in multi-user environments.
Default Installation Locations
%Program Files%\SNL Financial\SNLxL
%Program Files%\SP Global Market Intelligence\SP Capital IQ Office
Application Settings
%AppData%/Roaming/IsolatedStorage
Unique data compartment with individual data stores used to

Application Logging
%AppData/Local/SPGMI

S&P Capital IQ Pro Technical Guide 6


Saved Queries
S&P Capital IQ Pro allows users to save projects and screens. If SNL Office was previously installed,
the default location for storage of these files is: %USERPROFILE%\ Documents\SNL
Financial\SNLxl\SNLQueries. If no previous add-in was installed, the default location for storage of
these files is: %USERPROFILE%\Documents\S&P Global Market Intelligence\ S&P Capital IQ
Office\Queries. Users can manually change the setting for this location by
d-in was previously
S&P Capital IQ Pro respects the settings and by extension honors
the registry settings.
For a custom SaveQueriesLocation please see packaging section.

Browser Cache
S&P Capital IQ Pro allows users to minimize the use of browser cache by directing more data, e.g.,
schema files, CSS files, .js files, images, etc. to isolated storage. This capability is helpful if
the user has a limited amount of browser cache and is concerned that they may not have enough
storage space reserved for the use of web-based applications such as S&P Capital IQ Pro.
To make this change to the application, create a string registry value named PreferIsolatedStorage
under the registry key HKEY_LOCAL_MACHINE\Software\SNL Financial\ SNL Office and set the
value to 1 if you wish to send more data to go to isolated storage and less
to the browser cache location. To send more data to the browser cache location and less to isolated
storage set the value to 0. If the value is not specified in the registry then it will behave as if it were
set to 0. For mixed environments (64-bit Windows/32-bit Excel), registry entries should be made in
HKEY_LOCAL_MACHINE\Software\Wow6432Node\SNL Financial\SNL Office.

Dialogs
User interface dialogs are rendered using Internet Explorer in an embedded web browser control.
If enough IE cache space is not available, this can negatively impact the performance of the
application. Office Tools interface dialogs are developed in Windows Presentation Framework (WPF).

S&P Capital IQ Pro Technical Guide 7


Connecting With a Proxy
S&P Capital IQ Pro connects to its servers through HTTPS port 443. This connection is initiated by
the user and is authenticated by a username/password protocol.
Note: S&P Capital IQ Pro resolves the proxy settings from Internet Explorer. If you choose to
communicate directly through a proxy that is different from Internet Explorer, then the proxy
settings must be specified. This can be accomplished using either of the following methods:
In the user interface, click on Settings in the S&P Cap IQ Pro Ribbon and enter your proxy
information as shown in Figure 1 below.

Figure 2: Proxy Server Settings.

Under the S&P Capital IQ Pro registry keys HKEY_LOCAL_MACHINE\Software\SNL


Financial\SNL Office, create a string registry value named ProxyServer. Enter the proxy
hostname and port number in the entry, e.g., 127.0.0.1:8888. You may enter the protocol,
e.g., http:// or https://, in the registry but if none is entered then http:// is used by default.
This method is helpful if you are an IT administrator and packaging S&P Capital IQ Pro as it
allows you to specify the proxy settings that reside in the registry/installation folder on each
computer. For mixed environments (64-bit Windows/32-bit Excel), registry entries should
be made in HKEY_LOCAL_MACHINE\Software\Wow6432Node\SNL Financial\SNL Office.

Language Settings
S&P Capital IQ Pro supports English, Spanish, German, Portuguese, Chinese, and Japanese
languages. By default, S&P Capital IQ Pro will load the same language as Microsoft Excel that is
S&P Capital IQ Pro, the
appropriate OS and Excel language packs must be installed. If the Microsoft Excel language is not
currently supported, it will default to English. To change the S&P Capital IQ Pro application
language, select Settings in the S&P Cap IQ Pro Ribbon. Within the Settings dialog, select the
desired application language. After changing the application language, you must completely
restart Microsoft Excel for the change to take full effect. Upon reopening Microsoft Excel, you will
see the S&P Cap IQ Pro Ribbon in the language you have selected. Dialogs such as the Data Wizard
will appear in the selected language.

S&P Capital IQ Pro Technical Guide 8


Packaging S&P Capital IQ Pro Office
Once the S&P Capital IQ Pro client is installed, it is available to users in Excel whenever Excel is
launched. It loads as an Add-in and provides a S&P Cap IQ Pro Ribbon. Office Tools is available in
Excel, PowerPoint and Word.
To download the S&P Capital IQ Pro, visit our S&P Capital IQ Pro Advanced Download Page and
follow installation instructions.
Option to disable (set to 0) the plugin through the registry for the users who do not require access
to the plugin:
HKCU\Software\Microsoft\Office\Excel\Addins\SNL.Clients.Office.Excel.ExcelAddIn\LoadBehavior
HKLM\Software\Microsoft\Office\Excel\Addins\SNL.Clients.Office.Excel.ExcelAddIn\LoadBehavior

S&P Capital IQ Pro CIQ Compatibility Enabled MSIEXEC /i SPCapIQPro-x[86 or 64]-1.X.XXXXX.X.msi


(S&P Capital IQ Pro will take over CIQ refresh
functionality)

S&P Capital IQ Pro CIQ Compatibility Disabled MSIEXEC /i SPCapIQPro-x[86 or 64]-


(S&P Capital IQ Pro will not take over CIQ refresh 1.X.XXXXX.X.msi
functionality) DISABLECIQCOMPATIBILITYADDIN=1

S&P Capital IQ Pro Install to specific user group (not all users) MSIEXEC /qn /i C:\ SPCapIQPro-x[86 or 64]-1.X.XXXXX.X.msi
ALLUSERS=1 DISABLE_ACTIVE_SETUP=1

Uninstallation Using GUID


Find the GUID by running the command below in PowerShell
Get-WmiObject win32_Product - Format-Table IdentifyingNumber, Name
Alternatively, the GUID can be found in the registry:
x86 HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall
x64 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall
Uninstallation Example:
MI Office 20.4 {1BB0E897-2F12-4480-BCA6-185A5E5E314D}
MSIEXEC /X {1BB0E897-2F12-4480-BCA6-185A5E5E314D}

Custom Saved Query Location


If a custom SaveQueriesLocation is needed, create a string registry value named SaveQueries
Location under the registry key HKEY_CURRENT_USER\Software\SNL
Securities\XLClientAddin\Settings and enter the path to that location, e.g., %USERPROFILE%\
Documents\S&P Global Market Intelligence\S&P Capital IQ Office\Queries. This will set the
S&P Capital IQ Pro Saved Queries Location folder to the desired location for each
user. For mixed environments (64-bit Windows/32-bit Excel), registry entries should be made
in HKEY_CURRENT_USER\Software\Wow6432Node\SNL Securities\XLClientAddin\Settings.

S&P Capital IQ Pro Technical Guide 9


S&P Capital IQ Pro Plugin Manager
S&P Capital IQ Pro Add-
in. We use this to gather information related to the add-in and the machine. We can also fix
common issues in the add-in with the use of this application. This includes options for deleting
add-in folder in the Local and Roaming app data in the computer, so the person needs to have an
Admin access for them to use this application. Options in the Plugin manager is grayed out if they
machine.
To download the S&P Capital IQ Pro Plugin Manager, visit our S&P Capital IQ Pro Advanced
Download Page.

Testing Your Installation


After S&P Capital IQ Pro is installed, to confirm that an installation (or packaging/rollout) was
successful, follow the steps described in our test script guide.

Figure 3: S&P Cap IQ Pro Ribbon in Microsoft Excel.

S&P Capital IQ Pro Technical Guide 10


CONTACT US
About S&P Global Market Intelligence
At S&P Global Market Intelligence, we understand the U.S. & Canada
importance of accurate, deep and insightful information. We +1-888-275-2822
integrate financial and industry data, research and news into
tools that help track performance, generate alpha, identify Europe,
investment ideas, perform valuations and assess credit risk. Middle East
Investment professionals, government agencies, corporations & Africa
and universities around the world use this essential intelligence +44-20-7176-1234
to make business and financial decisions with conviction.
India
S&P Global Market Intelligence is a division of S&P Global +1800-1027654

benchmarks and analytics in the global capital and commodity Latin America
markets, offering ESG solutions, deep data and insights on +1-434-951-7788
critical business factors. S&P Global has been providing
essential intelligence that unlocks opportunity, fosters growth If any of these steps failed,
and accelerates progress for more than 160 years. For more please contact S&P
information, visit www.spglobal.com/marketintelligence. Capital IQ Pro Support,
24/7
[email protected]

For additional resources to test that Market Intelligence Office has been properly installed, please use
our Market Intelligence Template Library on the Market Intelligence Platform. Here you will find industry-
specific templates for all sectors that S&P Global market Intelligence covers.

Market Intelligence Office is an offering of S&P Global Market Intelligence.

Copyright © 2020 S&P Global Market Intelligence Inc. All rights reserved. No content, including by
framing or similar means, may be reproduced or distributed without the prior written permission of
S&P Global Market Intelligence or its affiliates. The content is provid

spglobal.com/marketintelligence 1120

You might also like