DICB DID Repository
ESO DFS Software

Introduction

The purpose of the DICB DID Repository (DidRep) is to provide an online repository of the Data Interface Dictionaries (DIDs) used around ESO. The DIDs are stored in a Sybase relational DB. The DIDs are updated from the CMM (the configuration control system used by Technical Division Software Dep.). I.e., when new versions become available in CMM, these are ingested into the DidRep by the DidRep tools. In this way it is possible to have an on-line, up-to-date repository of the DIDs used at ESO. This is practicle since not everybody has access to the CMM repository. In addition, the DidRep makes it possible to make queries e.g. all DIDs simultaneously to get an overview of how parameters are defined in the various DIDs, to compare new DIDs with earlier versions, and to make other statistics.

The DidRep provides a keyword query engine. It is also possible to download DIDs from the DidRep. If needed, it is possible to replicate the central DidRep to other locations if a local, complete set of DIDs are needed.

Structure of the DidRep DB

The structure of the DidRep DB is quite simple. It consists of two tables "did_dictionaries" which hold the information about the DIDs ingested, and "did_parameters" which holds the information for the parameter records for the DIDs.

The did_dictionaries table has the following columns:

*: Unique index created on column "code".

The did_parameters table has the following columns:

*: Unique index created on conjunction of columns "parameter" and "code".

The DidRep Software + Requirements

The SW developed for the DidRep is contained in Sniff project didRep with the followning sub-projects:

• didRepLib: Contains provides services for accessing the DidRep DB. For the moment this provides a class DidRepDb which provides the services for the DidRep to query the information from the DidRep DB.
• didRepIngest: Contains the tool DidRepIngest used to ingest DIDs into the DidRep DB. In addition a small scrip DidRepExec is provided which can be used as a template script for invoking the DidRepIngest tool.
• didRepWebQuery: CGI script used to generate the DidRep WEB pages.

The DidRep SW is written in Python and requires thus an installation of the Python environment. For accessing Sybase, the Python module with the same name must be installed. Also a Sybase DB must be installed and accessible. The DidRep SW is using the services provided by the PCC (Python Component Platform). For querying the DIDs from CMM the VLT SW must be installed (NOCCS is enough - in principle it should be enough to install the CMM SW). For using CMM it will also be necessary to get an account with CMM.

Ingestion of DIDs

The ingestion of DIDs from CMM or directly from a DID in an ASCII file, is done using the DidRepIngest tool. The tool takes the following input parameters (output from DidRepIngest tool when invoking without input parameters):

> python DidRepIngest.py

% DidRepIngest   [-v] [-h] [-d]
                 [-e (email)] [-subscribers (emails)]
                 {-w (working dir) -l (DID list) |
                  -did (DID name)}
                 {[-dbUser (DB user)] [-dbName (DB name)
                  [-dbPassword (password)]}


-v                 Run in verbose mode.
-h                 Print this help text.
-d                 Run in debug mode.

-e                 E-mail address to which a report will be
                   sent in case of problems and stating which
                   DIDs have been ingested.

-subscribers       Comma separated list of e-mail recipients
                   who want to be informed about ingestion of
                   new DIDs. No error message are sent to these
                   recipients.

-w (working dir)   Working directory which will be used by
                   the tool during the updating. If not
                   existing the directory will be created.
-did (DID name)    Name of a DID to ingest 'manually'. The name
                   should contain the necessary path informa-
                   tion to enable the tool to locate the DID.
-l (DID list)      File containing a list of DIDs to be checked
                   for update. The format of this file is the
                   following:

   DIDREP.NAME     "(DID name)/(archive)/(module/project code)"

   - where (DID name) is the name of the DID e.g.
   "ESO-VLT-DIC.ISAAC_OS", (archive) is the version control 
   system (for now only "CMM"), (module/...) is the code name
   for the module project, e.g. "dicNAOS"

   Comments can be written initiated by a hash sign.


-dbUser (DB user)  Name of DB user for the DidRep DB.
-dbName (DB name)  Name of the DidRep DB instance.
-dbPasswd (passwd) Password to use to connect to the DidRep DB. 

DidRep WEB Query Interface

The WEB query interface provides a CGI script names DidRepWebQuery. The behavior of the tool in connection with the HTTP parameters given are as follows:

Central/Main Repository

The main/central DICB DidRep repository is available from the URL:

http://archive.eso.org/dicb/bin/DidRep/DidRepWebQuery

############################################################################
# This file contains a list of DIDs to be ingested by the DidRepAutoUpdate.
############################################################################

DIDREP.NAME     "ESO-VLT-DIC.ASM/CMM/dicASM"
DIDREP.NAME     "ESO-VLT-DIC.BOSS/CMM/dicBOSS"
DIDREP.NAME     "ESO-VLT-DIC.CCDDCS/CMM/dicCCD"
DIDREP.NAME     "ESO-VLT-DIC.COU/CMM/dicCOU"
DIDREP.NAME     "ESO-VLT-DIC.DEL/CMM/dicDEL"
DIDREP.NAME     "ESO-VLT-DIC.DPR/CMM/dicDPR"
DIDREP.NAME     "ESO-VLT-DIC.FCDDCS/CMM/dicFCD"
DIDREP.NAME     "ESO-VLT-DIC.PRIMARY-FITS/CMM/dicFITS"
DIDREP.NAME     "ESO-VLT-DIC.XXXX_ICS/CMM/dicXXXX"
DIDREP.NAME     "ESO-VLT-DIC.FLAMES_ICS/CMM/dicFLAMES"
DIDREP.NAME     "ESO-VLT-DIC.FLAMES_CFG/CMM/dicFLAMES"
DIDREP.NAME     "ESO-VLT-DIC.FP_CFG/CMM/dicFP"
DIDREP.NAME     "ESO-VLT-DIC.FP_ICS/CMM/dicFP"
DIDREP.NAME     "ESO-VLT-DIC.FP_OS/CMM/dicFP"
DIDREP.NAME     "ESO-VLT-DIC.GIRAFFE_ICS/CMM/dicGIRAFFE"
DIDREP.NAME     "ESO-VLT-DIC.GIRAFFE_CFG/CMM/dicGIRAFFE"
DIDREP.NAME     "ESO-VLT-DIC.GIRAFFE_OS/CMM/dicGIRAFFE"
DIDREP.NAME     "ESO-VLT-DIC.IRACE/CMM/dicIRACE"
DIDREP.NAME     "ESO-VLT-DIC.ISS/CMM/dicISS"
DIDREP.NAME     "ESO-VLT-DIC.NAOS_OS/CMM/dicNAOS"
DIDREP.NAME     "ESO-VLT-DIC.NAOS_IR/CMM/dicNAOS"
DIDREP.NAME     "ESO-VLT-DIC.NAOS_RTC/CMM/dicNAOS"
DIDREP.NAME     "ESO-VLT-DIC.NAOS_VIS/CMM/dicNAOS"
DIDREP.NAME     "ESO-VLT-DIC.NAOS_ICS/CMM/dicNAOS"
DIDREP.NAME     "ESO-VLT-DIC.NAOS_PS/CMM/dicNAOS"
DIDREP.NAME     "ESO-VLT-DIC.OBS/CMM/dicOBS"
DIDREP.NAME     "ESO-VLT-DIC.PAF/CMM/dicPAF"
DIDREP.NAME     "ESO-VLT-DIC.TCS/CMM/dicTCS"
DIDREP.NAME     "ESO-VLT-DIC.TPL/CMM/dicTPL"
DIDREP.NAME     "ESO-VLT-DIC.UVES_ICS/CMM/dicUVES"
DIDREP.NAME     "ESO-VLT-DIC.UVES_OS/CMM/dicUVES"
DIDREP.NAME     "ESO-VLT-DIC.UVES_MS/CMM/dicUVES"
DIDREP.NAME     "ESO-VLT-DIC.UVES_PL/CMM/dicUVES"
DIDREP.NAME     "ESO-VLT-DIC.VNCI_ICS/CMM/dicVNCI"
DIDREP.NAME     "ESO-VLT-DIC.VNCI_OS/CMM/dicVNCI"
DIDREP.NAME     "ESO-VLT-DIC.VNCI_CFG/CMM/dicVNCI"
DIDREP.NAME     "ESO-VLT-DIC.VNCI_DCS/CMM/dicVNCI"
DIDREP.NAME     "ESO-VLT-DIC.XOS_ICS/CMM/dicXOS"
DIDREP.NAME     "ESO-VLT-DIC.PRO/CMM/dicPRO"
DIDREP.NAME     "ESO-VLT-DIC.FORS/CMM/dicFORS"

# --- oOo ---