Package Naming Convention

Package Naming Convention

Summary

Package TypePatternExample
Extractor Codes4q-extractor-[name]-[version].jars4q-extractor-jira-1.0.jar
Extraction Configurations4q-extractor-[name]-[version].zips4q-extractor-polarion-1.0.zip
Data Interfaces4q-di-[name]-[version].zips4q-di-requirements-1.0.zip
KPI Document - KPI Models4q-kpimodel-[name]-[version].zip *s4q-kpimodel-cmmi-1.0.zip
(*) The usage of dot, dash or underscore depends on the SpagoBI version. It's not possible to rename the package after it has been created!

Extractor Code

It can be useful to group all the code developed to extract data from a Tool in one single jar package. To ease the management of these kind of packages include in its name the name of the Tool and the version of the extractor.

s4q-extractors-[name]-[version].jar

Do not forget to provide the installation guide along with the dependencies (jars, xmls, ...).

Extraction Configuration

Group in a single package all the operations that belong to a specific Tool or are dedicated to a specific entity to extract.

s4q-extractor-[name]-[version].zip

Data Interface

Export of an Extraction Operation that uses the Data Interface. For export purpose it's possible to associate a FAKE_DS to complete the operation configuration.

s4q-di-[name]-[version].zip

KPI Document - KPI Model

Create one package for one KPI Document to better handle the different versions and create a modular analytical environment. Provide the right package name during the export steps and don't rename it later.

s4q-kpimodel-[name]-[version].zip

Creator: davdalle on 2010/02/08 16:16
This wiki is licensed under a Creative Commons 2.0 license
XWiki Enterprise 2.7.33694 - Documentation
Spago4Q