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 5.0 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 query with the correct values and source name. When certain values do not need to be replaced, remove those lines from the query.
QUERY 2
update sc set sc.Url = '...', sc.UserName = '...', sc.Password = '...', 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', sc.Password = 'secret_password' 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
select dm.LVSourceConfigurationId, dm.CxoDimension, dm.LVDimensionName from Source s join LVSourceConfiguration sc on sc.SourceId = s.Id join DimensionMapping dm on dm.LVSourceConfigurationId = sc.Id where s.Name = 'SOURCE NAME HERE'
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
select dec.LVSourceConfigurationId, dec.DimensionName, dec.DimensionDescription, dec.SymbolNames, dec.SymbolAttributes from Source s join LVSourceConfiguration sc on sc.SourceId = s.Id join LVDimensionsExtractionConfiguration dec on dec.LVSourceConfigurationId = sc.Id where s.Name = 'SOURCE NAME HERE'
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
select dm.Id, dm.CxoDimension, dm.LVDimensionName, mam.CxoMemberAttribute, mam.SymbolAttribute from Source s join LVSourceConfiguration sc on sc.SourceId = s.Id join DimensionMapping dm on dm.LVSourceConfigurationId = sc.Id join MemberAttributeMapping mam on mam.DimensionMappingId = dm.Id where s.Name = 'SOURCE NAME HERE'
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
declare @lv_dimension_name varchar(255) = 'LV DIMENSION NAME HERE'; declare @lv_source_configuration_id uniqueidentifier = 'LV SOURCE CONFIGURATION ID HERE'; declare @cxo_dimension varchar(50) = 'CXO DIMENSION HERE'; update DimensionMapping set LVDimensionName = @lv_dimension_name where LVSourceConfigurationId = @lv_source_configuration_id and CxoDimension = @cxo_dimension insert into LVDimensionsExtractionConfiguration ( Id, DimensionName, LVSourceConfigurationId, SymbolNames, DimensionDescription, SymbolAttributes) values (newid(), @lv_dimension_nname, @lv_source_configuration_id, '', '', '')
Update Symbol Names, Symbol Attributes and Dimension Description which are yet to be configured.
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 7
declare @lv_source_configuration_id uniqueidentifier = 'LV SOURCE CONFIGURATION ID HERE'; declare @cxo_dimension varchar(50) = 'CXO DIMENSION HERE'; declare @lv_dimension_name varchar(255) = ( select LVDimensionName from DimensionMapping where LVSourceConfigurationId = @lv_source_configuration_id and CxoDimension = @cxo_dimension ); update DimensionMapping set LVDimensionName = NULL where LVSourceConfigurationId = @lv_source_configuration_id and CxoDimension = @cxo_dimension delete from LVDimensionsExtractionConfiguration where LVSourceConfigurationId = @lv_source_configuration_id and DimensionName = @lv_dimension_name
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 8
update LVDimensionsExtractionConfiguration set SymbolNames = '...', SymbolAttributes = '...', DimensionDescription = '...' where LVSourceConfigurationId = 'LV SOURCE CONFIGURATION ID HERE' and DimensionName = 'DIMENSION NAME HERE'
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 9
insert into MemberAttributeMapping (Id, DimensionMappingId, CxoMemberAttribute, SymbolAttribute) values ( newid(), 'DIMENSION MAPPING ID HERE', 'CXO MEMBER ATTRIBUTE HERE', 'SYMBOL ATTRIBUTE HERE')
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 10
delete from MemberAttributeMapping where DimensionMappingId = 'DIMENSION MAPPING ID HERE' and SymbolAttribute = 'SYMBOL ATTRIBUTE HERE'