Versions Compared

Version Old Version 2 New Version 3
Changes made by

*Willem Van Den Brink (Deactivated)

Rachel Thomas

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page, it is assumed that the initialset-up of data loads by Professional Services has been completedThis page provides information on:

  • Performing a full extraction (metadata +data)

  • Performing a metadata only extraction for a given source

  • Running Longview Data and Metadata Extraction

To perform a full extraction (metadata + data) for the given source and year/scenario slice:

The command removes all existing data and metadata from fact database and imports data only for the years and scenarios specified in the arguments.

Command

full-extract

Parameters

  • source: Name of source for which metadata should be extracted.

  • years: Years for which data extraction is executed.

  • scenarios: Scenarios for which data extraction is executed.

Example

.\CXO.Adapter.LongviewTidemark.Cli.exe full-extract source:longview-close years:17,18 scenarios:Actual

To perform a metadata extraction for the given source:

The command removes all existing metadata from fact database and re-imports it again.

Command

metadata-extract

Parameters

  • source: Name of source for which metadata should be extracted

Example

.\CXO.Adapter.LongviewTidemark.Cli.exe metadata-extract source:longview-close

To perform a data extraction for the given source and year/period/scenario slice:

The command removes all existing data from fact database and imports data only for the years, periods and scenarios specified in the arguments

Command

data-extract

Parameters

  • source: Name of source for which metadata should be extracted

  • years: Years for which data extraction is executed

  • periods: Periods for which data extraction is executed

  • scenarios: Scenarios for which data extraction is executed

Example

.\CXO.Adapter.LongviewTidemark.Cli.exe data-extract source:longview-close years:17,18 periods:Jan,Feb scenarios:Actual

Info

  • If the scenarios contain empty space in their member name, they need to be put in double quotes. Ex: .\CXO.Adapter.LongviewTidemark.Cli.exe metadata-extract source:longview-close years:17,18 periods:Jan,Feb scenarios:"Scenarios 001","Scenarios 002","Scenarios 003"

  • Metadata members should be split by commas and should not contain empty space between the comma and the member name.

Running Longview Data and Metadata Extraction

Pre-requisite:

Source Metadata and Data Extraction has been completed by Professional Services.

Scheduled extraction

After completing the aforementioned process, all scheduled jobs are run automatically using Windows Scheduler. More information about this tool can be found here.

Manual extraction

Besides the scheduled runs, it is possible to run manual extractions. They can also be triggered in Windows Scheduler:

...

After selecting the desired job, you can ‘run’ the item in the right bottom panel of the screen, as shown in the screenshot above.

Configuring

...

Data Loads

To reconfigure the dimension members for the data load, the related. Lvparam file needs to be edited. More info about this below. After saving the file (please do not change the name of the file), windows scheduler will automatically use the updated configuration.

Parameter files (.lvparam files)

Each job comes with it’s own parameter file from which it reads parameter values and extracts metadata and data based on it. By default, there are three such files:

Script

Parameter file

Parameters

MetadataExtraction.ps1

MetadataExtractionParameters.lvparam

SOURCE_NAME

DataExtraction.ps1

DataExtractionParameters.lvparam

SOURCE_NAME, YEARS, SCENARIOS, PERIODS (optional)

FullExtraction.ps

FullExtractionParameters.lvparam

SOURCE_NAME, YEARS, SCENARIOS

They can contain the following parametersParameters:

  • SOURCE_NAME - name Name of the source from which metadata or data is extracted.

  • YEARS - one One or more years that are comma separated and specify years for which data is extracted.

  • SCENARIOS - one One or more scenarios that are comma separated and specifies which scenarios are extracted.

  • PERIODS (optional) - only Only applicable for DataExtraction.ps1 script which specifies periods which want to be extracted for the years, can be Q1-Q1 or months from 1-12.

To run a job, its parameter file needs to have the appropriate configuration using comma separated values.

...