Longview Adapter - Setup Guide
Introduction
This guide is generic and applies to all Longview products (Close, Tax, Plans, Transfer Pricing).
Installation Prerequisites
CXO Version 21.3.3 (or higher)
.NET 6.0 or higher has to be installed
Longview version 21.2 or newer
Installation
Install Longview Adapter
CXO Configuration and Source Creation
Note: To use the Longview Adapter you require a license key with Longview enabled.
Create a new source system in the SSM for the correct source type: Longview to create:
Fact database
SSAS cube
Initialize the Longview adapter and the source. This is performed by running a few commands which require few parameters as an input.
For more information on the available commands and their parameters, run theCXO.Adapter.LongviewTidemark.Cli.exe help
command for detailed descriptions.Open command line as Administrator, browse to the Longview adapter folder and run the initialize command to create the configuration database.
Avoid using spaces in the parameter values.
Command | initialize |
---|---|
Parameters |
|
Example |
|
4. Run the create-source-in-adapter command to create a new Longview source.
- IMPORTANT: At this point you can decide the type of Longview source as either Longview Close or Longview Tax. This selection cannot be changed after source creation!
Longview Plan and Longview Close work the same way. Similarly, Longview Tax and Transfer Pricing work the same way. But if you want to integrate with Longview Plan, you need to select Longview Close, and if you want to connect to Transfer Pricing, you will have to select Longview Tax.
Command | create-source-in-adapter |
---|---|
Parameters |
|
Example |
|
After running the above commands, the adapter is configured, and a first source is available. When multiple sources are required, run the create-source-in-adapter command for each source that is required.
Each source is created with a default configuration for dimensions, Longview symbol names, etc. These defaults need to be changed for the source to function properly. The next section explains how to configure the Longview sources.
Longview Source Configuration
A newly created Longview source needs additional configuration to function properly. Since the Longview adapter currently does not have a user interface, these configurations have to be done by running SQL scripts on the Longview configuration database.
Longview Connection
To show the currently configured connection information for the sources in the Longview adapter, run the following query on the configuration database:
QUERY 1
select s.Name,
Type = CASE
WHEN s.Type = 1 THEN 'Longview Close'
WHEN s.Type = 2 THEN 'Longview Tax'
ELSE 'Unknown'
END,
sc.Url,
sc.UserName,
sc.Password,
sc.ListenerPort,
sc.Access,
sc.UserGroup,
sc.InstanceId
from Source s
join LVSourceConfiguration sc on sc.SourceId = s.Id
The result of this query is shown for each source:
URL to the Longview instance.
Username
Password to authenticate with the Longview systems and few Longview-specific fields.
The values for these fields should be provided by user managing the Longview system to connect to.
To update the connection fields, run the following command with the correct values and source name. When certain values do not need to be replaced, remove those parameters. Especially use this command when updating password. If password is updated by SQL update query it will not be encrypted, running this command updates and encrypts the password.
Command | set-lv-source-configuration |
---|---|
Parameters |
|
Example |
|
Other option to update the connection fields is by running the following query with the correct values and source name. When certain values do not need to be replaced, remove those lines from the query. This update query should not be used for updating the Password value since it will not be encrypted. Use the above command for updating password.
QUERY 2
update sc
set sc.Url = '...',
sc.UserName = '...',
sc.ListenerPort = 0,
sc.Access = '...',
sc.UserGroup = '...',
sc.InstanceId = '...'
from LVSourceConfiguration sc
join Source s on sc.SourceId = s.Id
where s.Name = 'SOURCE NAME HERE'
An example to replace just the URL and credentials for a source called MyLongviewSource:
update sc
set sc.Url = 'https://example-url-to-longview-source.com',
sc.UserName = 'Administrator',
from LVSourceConfiguration sc
join Source s on sc.SourceId = s.Id
where s.Name = 'MyLongviewSource'
Showing Dimension Configuration for a Source
To show the dimension mappings for a given source that has been configured, run the following query with the correct source name:
QUERY 3
The result shows which Longview dimension is mapped to which CXO dimension. If the LVDimensionName column has a NULL value, nothing is mapped to this CXO dimension.
For each Longview dimension we also must configure:
The symbol names to extract
The symbol attributes to extract
The description of the Longview dimension
To display the values for these fields that are currently configured, run the following query:
QUERY 4
It is possible to extract additional attributes from the Longview system and link them to members in a configured dimension. To display the member attribute mappings that are currently configured, run the following query:
QUERY 5
For every dimension the SymbolAttribute that needs to be extracted from Longview and the CXO attribute on the member that needs to get the extracted value is displayed. For instance, the ZGPNativeCurrency attribute can be mapped to the Currency attribute of the CXO Entity dimension.
Updating Dimension Configuration for a Source
For updating dimension configuration of a Longview source:
Create a new dimension mapping from a Longview dimension to a CXO dimension.
Remove an existing dimension mapping from a Longview dimension to a CXO dimension.
Update symbol names, symbol attributes and/or dimension description for a mapped Longview dimension.
Create a new member attribute mapping.
Remove an existing member attribute mapping.
If you want to map a Longview dimension mapping to a CXO dimension that already has a Longview dimension mapped to it, first remove the existing mapping before adding the new mapping.
Create a Dimension Mapping
To create a new dimension mapping from a Longview dimension to a CXO dimension, run the following query with correct values for LVSourceConfigurationId and CxoDimension (from running QUERY 3) and the name of the LV Dimension you want to map.
QUERY 6
Update Symbol Names, Symbol Attributes and Dimension Description which are yet to be configured.
For Longview plan and close, the time period dimension is by default mapped to the other three dimensions, Year, Period, and View. To add a 4th dimension (usually category) run the following query:
QUERY 7
Update Symbol Names, Symbol Attributes and Dimension Description which are yet to be configured.
Note: Depending on the Longview installation and configuration TimePer could be named under a different identifier. Other names could be ‘Timeper’, ‘TIMEPER’, ‘Timeperiods’. to check this name, run the following query:
Remove a Dimension Mapping
To remove a dimension mapping from a Longview dimension to a CXO dimension, run the following query with correct values for LVSourceConfigurationId and CxoDimension (run QUERY 3).
QUERY 8
Update Symbol Names, Symbol Attributes and Dimension Description
To update symbol names, symbol attributes and dimension description for a LV dimension, run the following query with the correct LVSourceConfigurationId and DimensionName (run QUERY 4).
QUERY 9
Create a Member Attribute Mapping
To create a new member attribute mapping for a specific dimension, run the following query with the correct DimensionMappingId (run QUERY 5).
QUERY 10
Remove a Member Attribute Mapping
To remove an existing member attribute mapping, run the following query with the correct DimensionMappingId and SymbolAttribute (run QUERY 5).
QUERY 11