Longview Add-In For Office Overview
Longview Add-In For Office Overview
The Longview Add-In for Office is a fully integrated Add-In that allows you to make use of the familiar interface of Microsoft Excel in conjunction with the database used by your Longview system. You can use the Longview Add-In for Office to access Longview data servers to query data and other aspects of the data server repository and submit data to the dat...
Accessing the Longview Add-In For Office
Accessing the Longview Add-In For Office
After you have installed the Longview Add-In for Office, the Longview tab appears in the ribbon in Microsoft Excel.
Most Longview Add-In for Office features are unavailable until you connect to a data server. However, if you are not connected to a Longview data server, you can still view the Longview Add-In for Office Help. For more information, see V...
Using Longview Add-In With A Tidemark Data Source
Using Longview Add-In With A Tidemark Data Source
The Longview Add-In for Office can also connect to a Tidemark Data Source. Connecting to a Tidemark Data Source is equivalent to connecting to a Tidemark Application. Once connected, data security, hierarchy and member selections will be restricted to those available in the Tidemark Application to which you are connected. Some, but not all the...
Longview Add-In For Office Version And Session Information
Longview Add-In For Office Version And Session Information
It may be useful at times to view version and session information about the Longview Add-In for Office.
Note: If you are not connected to a data server, only the version information for Longview Add-In for Office displays. (Not connected) displays in all other fields.
To view Longview Add-In for Office information:
Click the File tab...
Managing Connections
Managing Connections
Before you can start working with the Longview Add-In for Office, you must use the Manage Connections dialog to add a connection to the Longview data server.
For more information, see the following:
Understanding authentication methods
Adding a connection
In addition, you can use the Manage Connections dialog to complete several tasks involving data server connections,...
Querying Data
Querying Data
Once you are connected to the Longview data server, you are ready to work with the data contained within it. This chapter explains how to use the Longview Add-In for Office to query data.
For information on analyzing data queries, see Analyzing data query results.
Understanding data query output
You can use the Longview Add-In for Office to query data from the data server repo...
Querying Symbols
Querying Symbols
You can use the Longview Add-In for Office to query symbol data such as the balance type, weight, and priority of a specified symbol or symbols from the data server repository.
Understanding symbol query output
A symbol is a plane of data within the database. Symbols identify specific cells within a hierarchy and are used to store information in the Longview database. When y...
Querying Attributes
Querying Attributes
You can use the Longview Add-In for Office to query attribute data from the data server repository.
Understanding attribute query output
An attribute describes the characteristics of an object in the application. You can use the Longview Add-In for Office to query System, User, or Symbol attributes from the Longview data server repository. When you run an attribute query,...
Extracting Data
Extracting Data
You can use the Longview Add-In for Office to extract data from the data server repository and output it to a Microsoft Excel spreadsheet. Output data appears as a flat table where each data value is represented as a row and each dimension is represented as an intersecting column. This output format can be conveniently used in a Microsoft Excel Table or a PivotTable, which can...
Analyzing Data Query Results
Analyzing Data Query Results
You can further investigate the results of a data query by reorienting them or drilling into them multiple times in succession. In addition, you can revert to previous reorientations and data drills.
Reorienting data query results
You can use the Longview Add-In for Office to reorient data query results to investigate any data discrepancies for a specified row an...
Formatting Query Results
Formatting Query Results
When you run a data, symbol, or attribute query using the Longview Add-In for Office, default Longview formatting is applied to the query results. You can make changes to the query results in the Microsoft Excel workbook. However, depending on the type of change that you make, you may invalidate the query. If a query is invalidated, it cannot be rerun. In the case of ...
Longview Function Syntax
Longview Function Syntax
When you are working with Longview Functions, keep the following general syntax rule in mind. For each function parameter, you can either specify the required value, or specify a cell location that contains the required value. If you specify a value, enclose the parameter in double quotation marks ("Parameter"). If you specify a cell location, do not enclose the para...
Working With Data Using Longview Functions
Working With Data Using Longview Functions
The Longview Add-In for Office includes Longview Functions that allow you to query different types of data into worksheet cells and submit data from worksheet cells to the Longview data server repository.
Using Longview Functions
You can use Longview Functions in the Longview Add-In for Office to query different types of data from the data server r...
Working with Longview Add-In for Office APIs
Working with Longview Add-In for Office APIs
Automation APIs are available in the Longview Add-In for Office for automating common operations such as refreshes and submissions and orchestrating those processes across many sheets in a workbook. You can use VBA to call these Automation APIs.
Caution: The Longview Add-In for Office APIs are supported for Longview connections only. APIs are not ...
Getting Started with Automation APIs
Getting Started with Automation APIs
Before you can use the Automation APIs in your workbooks, you will need to ensure that the Longview Excel Add-In Reference is added to your VBA Project.
Note: The library name may appear as Longview or Longview Excel Add-In.
Once in VBA, you may use the Object Browser to browse the objects in the API.
API Class
API Class
The API class is the main class used to implement the Automation APIs. This section describes the Functions and Properties of the API class.
API.Connect
The API.Connect function connects to the Longview data server with specified parameters.
Parameters
Description
connection
Type: string or Type: connection
This parameter is the name of a defined Connection or a Connection o...
Connection Class
Connection Class
The Connection class represents the connection parameters used to connect to the Longview server. Use the Connection class in conjunction with API.Connect to create a connection to the Longview system.
Connection Properties
The following table lists the properties of the Connection class:
Name
Type
Description
HostOrProxy
string
HostOrProxy specifies the host name or...
DataExtract Class
DataExtract Class
The DataExtract class represents a data extract query that is built from the menu option: Data Extract. The functions and properties of this class can be used to build a new data extract query, modify an existing data extract query and output the results to a worksheet.
Property Summary
Property AdjustedDetail As AdjustedDetail
Property DataMode As DataMode
Property Schedul...
DataQuery Class
DataQuery Class
The DataQuery class represents a data query that is built from the menu option: Data Query. The functions and properties of this class can be used to build a new data query, modify an existing data query and output the results to a worksheet.
Note: A symbol spec must be added for every base dimension.
Property Summary
Property AdjustedDetail As AdjustedDetail
Property ApplyFo...
ErrorCode Class
ErrorCode Class
The ErrorCode class represents a set of common return values.
Use the ErrorCode class to create relevant error messages for common errors that may be encountered.
ErrorCode Return Values
The following table lists some of the common return values for the ErrorCode class:
Name
Type
Description
AlreadyConnected
long
Return value to indicate that the user is already conne...
HierarchyQuery Class
HierarchyQuery Class
The HierarchyQuery class represents a hierarchy of symbols in a dimension that can be used in memory or output to a worksheet.
Property Summary
Property IncludeDescriptions As Boolean
Sub/Function Summary
Sub AddSymbolSpec(symbolSpec As String, [root As String])
Function Run() As QueryResult
Sub RunToWorksheet([worksheetName As String], [cell As String])
Properties
...
Query Result Class
Query Result Class
The QueryResult class contains the results to a HierarchyQuery. The results are structured as a table where each row represents a symbol entry, and the columns represent the properties for that symbol.
Property Summary
Property ColumnCount As Long
Property RowCount As Long
Sub/Function Summary
Function GetCellValue(row As Long, column as Long) As String
Properties
Par...
Session Class
Session Class
The Session class represents various aspects of a session such as the user id, host, port, and identifier of the currently connected Longview system.
Use the Session class in conjunction with API.GetSession to retrieve information for the current session.
Session Properties
The following table lists the properties of the Session class
Name
Type
Description
Group
string
G...
Symbol Class
Symbol Class
The Symbol class contains the results to API.SymbolInfo.
Property Summary
Property AcceptRollup As Boolean
Property BalanceType As String
Property Children As Symbol()
Property ChildSort As String
Property Description As String
Property Index As Long
Property IsLeaf As Boolean
Property Level As Long
Property Name As String
Property NumOfChildren As Long
Property Parent As Symbo...
SymbolQuery Class
SymbolQuery Class
The SymbolQuery class represents a symbol query that is built from the menu option: Symbol Query. The functions and properties of this class can be used to build a new symbol query, modify an existing symbol query and output the results to a worksheet.
Property Summary
Property SymbolOutput As SymbolOutput
Sub/Function Summary
Sub AddSymbolSpec(symbolSpec As String, [root A...