nxsconfigserver 2.15.0__tar.gz → 2.17.0__tar.gz

nxsconfigserver-2.17.0/.ci/install.sh

@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+
+echo "restart mysql service"
+if [ "$1" = "debian11" ] || [ "$1" = "debian12" ] || [ "$1" = "ubuntu24.10" ] || [ "$1" = "ubuntu24.04" ]; then
+    docker exec --user root ndts service mariadb restart
+else
+    # workaround for a bug in debian9, i.e. starting mysql hangs
+    docker exec --user root ndts service mysql stop
+    if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu22.04" ] ; then
+	docker exec --user root ndts /bin/bash -c 'usermod -d /var/lib/mysql/ mysql'
+    fi
+    # docker exec  --user root ndts /bin/bash -c '$(service mysql start &) && sleep 30'
+    docker exec --user root ndts service mysql start
+fi
+
+
+echo "install tango-common"
+docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; export DEBIAN_FRONTEND=noninteractive; apt-get -qq install -y tango-common; sleep 10'
+if  [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu24.10" ]; then
+    # docker exec  --user tango ndts /bin/bash -c '/usr/lib/tango/DataBaseds 2 -ORBendPoint giop:tcp::10000  &'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=root\npassword=rootpw" > /root/.my.cnf'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=tango\nhost=localhost\npassword=rootpw" > /var/lib/tango/.my.cnf'
+    docker exec  --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON tango.* TO "tango"@"%" identified by "rootpw"'
+    docker exec  --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON tango.* TO "tango"@"localhost" identified by "rootpw"'
+    docker exec  --user root ndts /usr/bin/mysql -e 'FLUSH PRIVILEGES'
+fi
+if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu21.10" ] || [ "$1" = "ubuntu22.04" ]; then
+    # docker exec  --user tango ndts /bin/bash -c '/usr/lib/tango/DataBaseds 2 -ORBendPoint giop:tcp::10000  &'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=root\npassword=rootpw" > /root/.my.cnf'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=tango\nhost=127.0.0.1\npassword=rootpw" > /var/lib/tango/.my.cnf'
+fi
+echo "install tango-db"
+docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; export DEBIAN_FRONTEND=noninteractive; apt-get -qq install -y tango-db; sleep 10'
+if [ "$?" -ne "0" ]; then exit 255; fi
+if  [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu24.10" ]; then
+    docker exec  --user tango ndts /usr/bin/mysql -e 'create database tango'
+    docker exec  --user tango ndts /bin/bash -c '/usr/bin/mysql tango < /usr/share/dbconfig-common/data/tango-db/install/mysql'
+fi
+
+docker exec  --user root ndts service tango-db restart
+
+
+echo "install tango servers"
+docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; export DEBIAN_FRONTEND=noninteractive;  apt-get -qq install -y  tango-starter tango-test liblog4j1.2-java'
+if [ "$?" -ne "0" ]; then exit 255; fi
+
+docker exec --user root ndts service tango-starter restart
+
+docker exec  --user root ndts chown -R tango:tango .
+
+if [ "$2" = "2" ]; then
+    echo "install pytango and nxsconfigserver-db"
+    docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; apt-get install -y   python-pytango  nxsconfigserver-db ; sleep 10'
+else
+    if [ "$1" = "debian10" ] || [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu24.10" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ] ; then
+	echo "install pytango"
+	docker exec --user root ndts /bin/bash -c 'apt-get -qq update; apt-get install -y   python3-tango'
+	echo "install nxsconfigserver-db"
+	docker exec --user root ndts /bin/bash -c 'apt-get -qq update; apt-get  install -y   nxsconfigserver-db'
+	if [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu24.10" ]; then
+	    docker exec  --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON nxsconfig.* TO "tango"@"%" identified by "rootpw"'
+	    docker exec  --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON nxsconfig.* TO "tango"@"localhost" identified by "rootpw"'
+	    docker exec  --user root ndts /usr/bin/mysql -e 'FLUSH PRIVILEGES'
+	    docker exec  --user tango ndts /usr/bin/mysql -e 'create database nxsconfig'
+	    docker exec  --user tango ndts /bin/bash -c '/usr/bin/mysql nxsconfig < /usr/share/dbconfig-common/data/nxsconfigserver-db/install/mysql'
+	fi
+    else
+	echo "install pytango and nxsconfigserver-db"
+	docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; apt-get -qq install -y   python3-pytango nxsconfigserver-db; sleep 10'
+    fi
+fi
+if [ "$?" != "0" ]; then exit 255; fi
+
+
+echo "install nxsconfigserver"
+if [ "$2" = "2" ]; then
+    docker exec --user root ndts chown -R tango:tango .
+    docker exec  ndts python setup.py build
+    docker exec --user root ndts python setup.py  install
+else
+    docker exec --user root ndts chown -R tango:tango .
+    docker exec  ndts python3 setup.py build
+    docker exec --user root ndts python3 setup.py  install
+fi
+if [ "$?" != "0" ]; then exit 255; fi

{nxsconfigserver-2.15.0 → nxsconfigserver-2.17.0}/.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        os: [debian12, debian11, debian10, ubuntu23.10, ubuntu22.04, ubuntu20.04]
+        os: [debian12, debian11, debian10, ubuntu24.10, ubuntu24.04, ubuntu22.04]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

{nxsconfigserver-2.15.0 → nxsconfigserver-2.17.0}/ChangeLog

@@ -1,3 +1,11 @@
+2025-04-15 Jan Kotanski <jankotan@gmail.com>
+	* add ExtraLinkDataSources attribute and ExtraLinkPath property(#68)
+	* tagged as v2.17.0
+
+2025-04-09 Jan Kotanski <jankotan@gmail.com>
+	* add support for vds tags (#65)
+	* tagged as v2.16.0
+
 2023-11-09 Jan Kotanski <jankotan@gmail.com>
 	* change tango.Device_4Impl to tango.LatestDeviceImpl (#57)
 	* tagged as v2.15.0

{nxsconfigserver-2.15.0 → nxsconfigserver-2.17.0}/NXSConfigServer.xmi

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="ASCII"?>
-<pogoDsl:PogoSystem xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:pogoDsl="http://www.esrf.fr/tango/pogo/PogoDsl">
-  <classes name="NXSConfigServer" pogoRevision="9.4">
-    <description description="NeXuS Configuration Server is a Tango Server with its implementation based&#xA;on a MySQL database. It allows to store XML configuration datasources&#xA;and components. It also gives possibility to select mandatory components&#xA;and perform the process of component merging.&#xA;&#xA;Source code: https://github.com/nexdatas/nxsconfigserver/&#xA;Web page: https://nexdatas.github.io/nxsconfigserver/&#xA;NexDaTaS Web page: https://nexdatas.github.io&#xA;" title="Configuration Server for Nexus Data Writer" sourcePath="/home/jkotan/ndts/nexdatas.configserver" language="Python" filestogenerate="XMI   file,Code files,Protected Regions,html Pages" license="GPL" hasMandatoryProperty="false" hasConcreteProperty="true" hasAbstractCommand="false" hasAbstractAttribute="false" descriptionHtmlExists="false">
+<pogoDsl:PogoSystem xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:pogoDsl="http://tango.org/pogo/PogoDsl">
+  <classes name="NXSConfigServer" pogoRevision="9.8">
+    <description description="NeXuS Configuration Server is a Tango Server with its implementation based&#xA;on a MySQL database. It allows to store XML configuration datasources&#xA;and components. It also gives possibility to select mandatory components&#xA;and perform the process of component merging.&#xA;&#xA;Source code: https://github.com/nexdatas/nxsconfigserver/&#xA;Web page: https://nexdatas.github.io/nxsconfigserver/&#xA;NexDaTaS Web page: https://nexdatas.github.io&#xA;" title="Configuration Server for Nexus Data Writer" sourcePath="/home/jkotan/ndts/nxsconfigserver" language="Python" filestogenerate="XMI   file,Protected Regions,html Pages" license="GPL" hasMandatoryProperty="false" hasConcreteProperty="true" hasAbstractCommand="false" hasAbstractAttribute="false" descriptionHtmlExists="false">
       <inheritances classname="Device_Impl" sourcePath=""/>
       <identification contact="at desy.de - jan.kotanski" author="jan.kotanski" emailDomain="desy.de" classFamily="Acquisition" siteSpecific="" platform="All Platforms" bus="Not Applicable" manufacturer="DESY" reference=""/>
     </description>
@@ -10,6 +10,11 @@
       <status abstract="false" inherited="false" concrete="true" concreteHere="true"/>
       <DefaultPropValue>&quot;XCS&quot;</DefaultPropValue>
     </deviceProperties>
+    <deviceProperties name="ExtraLinkPath" description="extra link path below NXentry, default: instrument:NXinstrument/collection:NXcollection">
+      <type xsi:type="pogoDsl:StringType"/>
+      <status abstract="false" inherited="false" concrete="true" concreteHere="true"/>
+      <DefaultPropValue>&quot;instrument:NXinstrument/collection:NXcollection&quot;</DefaultPropValue>
+    </deviceProperties>
     <commands name="State" description="This command gets the device state (stored in its device_state data member) and returns it to the caller." execMethod="dev_state" displayLevel="OPERATOR" polledPeriod="0">
       <argin description="none">
         <type xsi:type="pogoDsl:VoidType"/>
@@ -387,6 +392,14 @@
       <status abstract="false" inherited="false" concrete="true" concreteHere="true"/>
       <properties description="JSON list of datasources to be switched into CanFail mode during creating configuration process" label="Datasources to be switched into CanFail mode" unit="" standardUnit="" displayUnit="" format="" maxValue="" minValue="" maxAlarm="" minAlarm="" maxWarning="" minWarning="" deltaTime="" deltaValue=""/>
     </attributes>
+    <attributes name="ExtraLinkDataSources" attType="Scalar" rwType="READ_WRITE" displayLevel="OPERATOR" polledPeriod="0" maxX="" maxY="" allocReadMember="true" isDynamic="false">
+      <dataType xsi:type="pogoDsl:StringType"/>
+      <changeEvent fire="false" libCheckCriteria="false"/>
+      <archiveEvent fire="false" libCheckCriteria="false"/>
+      <dataReadyEvent fire="false" libCheckCriteria="true"/>
+      <status abstract="false" inherited="false" concrete="true" concreteHere="true"/>
+      <properties description="JSON list of datasources to which links will be added" label="Datasources to which extra links will be added" unit="" standardUnit="" displayUnit="" format="" maxValue="" minValue="" maxAlarm="" minAlarm="" maxWarning="" minWarning="" deltaTime="" deltaValue=""/>
+    </attributes>
     <states name="ON" description="Server is ON">
       <status abstract="false" inherited="false" concrete="true" concreteHere="true"/>
     </states>
@@ -396,6 +409,6 @@
     <states name="RUNNING" description="Performing a query">
       <status abstract="false" inherited="false" concrete="true" concreteHere="true"/>
     </states>
-    <preferences docHome="./doc_html" makefileHome="/usr/share/pogo/preferences"/>
+    <preferences docHome="./doc_html" makefileHome="$(TANGO_DIR)/Libraries/cppserver/common"/>
   </classes>
 </pogoDsl:PogoSystem>

nxsconfigserver-2.17.0/PKG-INFO

@@ -0,0 +1,476 @@
+Metadata-Version: 2.1
+Name: nxsconfigserver
+Version: 2.17.0
+Summary: Configuration Server for Nexus Data Writer
+Home-page: http://github.com/jkotan/nexdatas/nxsconfigserver
+Author: Jan Kotanski, Eugen Wintersberger , Halil Pasic
+Author-email: jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com
+License: GNU GENERAL PUBLIC LICENSE v3
+Keywords: configuration MySQL writer Tango server nexus data
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+
+======================================================
+Welcome to NeXuS Configuration Server's documentation!
+======================================================
+
+|github workflow|
+|docs|
+|Pypi Version|
+|Python Versions|
+
+.. |github workflow| image:: https://github.com/nexdatas/nxsconfigserver/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/nexdatas/nxsconfigserver/actions
+   :alt:
+
+.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
+   :target: https://nexdatas.github.io/nxsconfigserver/index.html
+   :alt:
+
+.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxsconfigserver.svg
+                  :target: https://pypi.python.org/pypi/nxsconfigserver
+                  :alt:
+
+.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxsconfigserver.svg
+                     :target: https://pypi.python.org/pypi/nxsconfigserver/
+                     :alt:
+
+
+
+Authors: Jan Kotanski, Eugen Wintersberger, Halil Pasic
+
+NeXuS Configuration Server is a Tango Server with its implementation based
+on a MySQL database. It allows to store XML configuration datasources
+and components. It also gives possibility to select mandatory components
+and perform the process of component merging.
+
+Tango Server API: https://nexdatas.github.io/nxsconfigserver/doc_html
+
+| Source code: https://github.com/nexdatas/nxsconfigserver/
+| Web page: https://nexdatas.github.io/nxsconfigserver/
+| NexDaTaS Web page: https://nexdatas.github.io
+
+------------
+Installation
+------------
+
+Install the dependencies:
+
+|    MySQLdb, PyTango, sphinx
+
+From sources
+^^^^^^^^^^^^
+
+Download the latest version of NeXuS Configuration Server from
+
+|    https://github.com/nexdatas/nxsconfigserver/
+|    https://github.com/nexdatas/nxsconfigserver-db/
+
+Extract the sources and run
+
+.. code-block:: console
+
+	  $ python setup.py install
+
+To set database execute
+
+.. code-block:: console
+
+	  $ mysql < conf/mysql_create.sql
+
+with proper privileges.
+
+Debian packages
+^^^^^^^^^^^^^^^
+
+Debian Bookworm, Bullseye, Buster and as well as Ubuntu Lunar, Jammy  packages can be found in the HDRI repository.
+
+To install the debian packages, add the PGP repository key
+
+.. code-block:: console
+
+	  $ sudo su
+	  $ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -
+
+and then download the corresponding source list, e.g. for bookworm
+
+.. code-block:: console
+
+	  $ cd /etc/apt/sources.list.d
+	  $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list
+
+Finally, for python2 packages
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install python-nxsconfigserver nxsconfigserver-db
+
+and the NXSConfigServer tango server (from 2.10.0)
+
+	  $ apt-get install nxsconfigserver
+
+or for python3
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install python3-nxsconfigserver nxsconfigserver-db
+
+and the NXSConfigServer tango server (from 2.10.0)
+
+	  $ apt-get install nxsconfigserver3
+
+
+From pip
+""""""""
+
+To install it from pip you need pymysqldb e.g.
+
+.. code-block:: console
+
+   $ python3 -m venv myvenv
+   $ . myvenv/bin/activate
+
+   $ pip install pymysqldb
+
+   $ pip install nxsconfigserver
+
+Moreover it is also good to install
+
+.. code-block:: console
+
+   $ pip install pytango
+   $ pip install nxstools
+
+Setting NeXus Configuration Server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To set up  NeXus Configuration Server with the default configuration run
+
+.. code-block:: console
+
+          $ nxsetup -x NXSConfigServer
+
+The *nxsetup* command comes from the **python-nxstools** package.
+
+===========
+Description
+===========
+
+Configuration Server is dedicated to store NXDL-like configuration needed for
+Tango Data Writer runs. The server uses as a storage system a MYSQL database.
+To create required DB tables one can use ndts.sql script from the repository.
+
+In Configuration Server the configuration is memorized in separate elements:
+datasources or components.
+
+**DataSources** describe access to input data, i.e to specific hardware
+TANGO devices or other databases as well to client data.
+
+**Components** specify Nexus tree with positions of datasets for particular
+pieces of hardware and writing strategy for corresponding to them data.
+
++ They can include datasources directly as well as links to datasources
+  defined in the server. To this end template syntax of
+  $datasources.<ds_name> type is used.
++ Moreover, they can holds links to other components which describe their
+  dependences. In this case $components.<comp_name> syntax is used.
++ Finally, the components can contains variables. The variables are defined
+  in XML code by $var.<var_name> syntax and can be provided to
+  the Configuration Server by passing a JSON string.
+  The default value for variables is an empty string.
+
+All elements of configuration can be created by GUI tool - ComponentDesigner.
+The tool can connect to Configuration Server and fetch or store
+the separate elements of the XML configuration.
+
+During creation of the final configuration Configuration Server merges
+all required and dependent components, connected to them datasources and
+provided values of the variables. As a result it returns a single XML string.
+This XML string can be pass directly into the dedicated Tango Data Writer
+attribute.
+
+
+
+===========
+Client code
+===========
+
+.. code-block:: python
+
+    # In this section we present an example how to communicate with
+    # Configuration Server making use of PyTango.
+
+    import tango
+
+    cnfServer = tango.DeviceProxy("p00/xmlconfigserver/exp.01")
+
+    cnfServer.JSONSettings = \
+	'{"db":"ndts_p02","read_default_file":"/etc/my.cnf","use_unicode":true}'
+
+    # opens DB connection
+    cnfServer.Open()
+
+    # After creating the server proxy we can set configuration for connection to
+    #  the MYSQL DB.
+    # The JSONSettings attribute is memorized so you have to write it only when you
+    # change configuration of DB connection. Next, we open connection to
+    # DB specified by our JSONSettings.
+
+
+
+    # stores default component
+    cpxml = open("default.xml", 'r').read()
+    cnfServer.XMLString = cpxml
+    cnfServer.StoreComponent('default')
+
+    # stores slit1 component in DB
+    cpxml = open("slit1.xml", 'r').read()
+    cnfServer.XMLString = cpxml
+    cnfServer.StoreComponent('slit1')
+
+    # stores slit2 component in DB
+    cpxml = open("slit2.xml", 'r').read()
+    cnfServer.XMLString = cpxml
+    cnfServer.StoreComponent('slit2')
+
+    # stores slit3 component in DB
+    cpxml = open("slit3.xml", 'r').read()
+    cnfServer.XMLString = cpxml
+    cnfServer.StoreComponent('slit3')
+
+    # stores pilatus300k component in DB
+    cpxml = open("pilatus.xml", 'r').read()
+    cnfServer.XMLString = cpxml
+    cnfServer.StoreComponent('pilatus300k')
+
+
+    # stores motor01 datasource in DB
+    dsxml = open("motor.ds.xml", 'r').read()
+    cnfServer.XMLString = dsxml
+    cnfServer.StoreDataSource('motor01')
+
+    # stores motor02 datasource in DB
+    dsxml = open("motor.ds.xml", 'r').read()
+    cnfServer.XMLString = dsxml
+    cnfServer.StoreDataSource('motor02')
+
+
+
+    # removes slit3 component from DB
+    cnfServer.DeleteComponent('slit3')
+
+    # removes motor02 datasource from DB
+    cnfServer.DeleteDataSource('motor02')
+
+    # If someone cannot use ComponentDesigner it is also an option to store
+    # or delete components and datasources using directly tango interface
+    # as it is shown above.
+
+
+
+    # provides names of available components
+    cmpNameList = cnfServer.AvailableComponents()
+    # provides names of available datasources
+    dsNameList = cnfServer.AvailableDataSources()
+
+    # To get information about names of available components and datasources
+    # in Configuration Server we use the above commands.
+
+
+
+    # provides a list of required components
+    cmpList = cnfServer.Components(cmpNameList)
+    # provides a list of required Datasources
+    dsList = cnfServer.DataSources(dsNameList)
+
+    # Having names of stored elements we can get their XML code.
+
+    # provides a list of Datasources from a given Component
+    dsList = cnf.Server.ComponentDataSources('pilatus300k')
+    dsList = cnf.Server.ComponentsDataSources(['pilatus300k', 'slit1'])
+
+    # as well as query Configuration Server which datasource
+    # are related to the particular component.
+
+    # provides a dependent components
+    cpList = cnf.Server.DependentComponents(['pilatus300k', 'slit3'])
+
+
+    # Moreover, one can also query Configuration Server for a list of
+    # dependent components
+
+    # provides a list of Variables from a given components
+    varList = cnf.Server.ComponentVariables('pilatus300k')
+    varList = cnf.Server.ComponentsVariables(['pilatus300k', 'slit3'])
+
+    #or ask for a list of variables which are related to the particular components.
+
+    # sets values of variables
+    cnf.Server.Variables = '{"entry_id":"123","beamtime_id":"123453535453"}'
+
+    #The variable values can be passed to the Configuration Server
+    # via a JSON string.
+
+
+
+    # sets given component as mandatory for the final configuration
+    cnfServer.SetMandatoryComponents(['default','slit1'])
+    # un-sets given component as mandatory for the final configuration
+    cnfServer.UnsetMandatoryComponents(['slit1'])
+
+    # provides names of mandatory components
+    man =  cnfServer.MandatoryComponents()
+
+    # Some of the component can be set as mandatory in
+    # the final configuration. To define them Configuration Server provides
+    # above commands.
+
+
+
+    # provides the current configuration version
+    version =  cnfServer.Version
+
+    # Each configuration has a revision number. It can be found
+    # together with Configuration Server version in Version attribute.
+
+    # creates the final configuration from slit2 and pilatus300k
+    # as well as all mandatory components
+    cnfServer.CreateConfiguration('slit2', 'pilatus300k')
+    # XML string ready to use by Tango Data Server
+    finalXML = cnfServer.XMLString
+
+    # In order to create our final configuration we execute CreateConfiguration
+    # command with a list of names of required components. The command merges
+    # these components with mandatory ones and provides the resulting NXDL-like
+    # configuration in the XMLString attribute.
+
+
+
+
+    # merges given components
+    mergedComp = cnfServer.Merge(['slit2', 'pilatus300k'])
+
+    # Similarly, the Merge command provides configuration by unresolved links
+    # to datasoures and with non-assigned variable values.
+
+
+    # closes connection to DB
+    cnfServer.close()
+
+    # Command close terminates our connection to the DB server.
+
+=======================
+Configuration Variables
+=======================
+
+Values of configuration variables can be also define inside the component xmls.
+Let's consider two following components:
+
+*mydetector* with a general detector transformation group
+
+.. code-block:: xml
+
+   <definition>
+     <group type='NXentry' name='entry'>
+       <group type='NXinstrument' name='instrument'>
+          <group type='NXdetector' name='$var.detector#\"mydetector\"'>
+             <group type='NXtransformations' name='transformations'/>
+	  </group>
+       </group>
+     </group>
+   </definition>
+
+and *pilatus* created for the particular detector
+
+.. code-block:: xml
+
+   <definition>
+     <group type='NXentry' name='entry'>
+       <group type='NXinstrument' name='instrument'>
+          <group type='NXdetector' name='pilatus'>
+             <field type='NX_FLOAT64' name='data'/>
+	  </group>
+       </group>
+     </group>
+     <doc>$var(detector=pilatus)</doc>
+   </definition>
+
+
+Creating configuration without variables
+
+.. code-block:: python
+
+   cnfServer.Variables = '{}'
+   cnfServer.CreateConfiguration(["mydetector"])
+
+results in
+
+.. code-block:: xml
+
+   <definition>
+     <group type='NXentry' name='entry'>
+       <group type='NXinstrument' name='instrument'>
+          <group type='NXdetector' name='mydetector'>
+             <group type='NXtransformations' name='transformations'/>
+	  </group>
+       </group>
+     </group>
+   </definition>
+
+When configuration variables are defined
+
+.. code-block:: python
+
+   cnfServer.Variables = '{"detector": "det1"}'
+   cnfServer.CreateConfiguration(["mydetector"])
+
+one can get
+
+.. code-block:: xml
+
+   <definition>
+     <group type='NXentry' name='entry'>
+       <group type='NXinstrument' name='instrument'>
+          <group type='NXdetector' name='det1'>
+             <group type='NXtransformations' name='transformations'/>
+	  </group>
+       </group>
+     </group>
+   </definition>
+
+Finally, creating configuration xml from our two components without variables
+
+.. code-block:: python
+
+   cnfServer.Variables = '{}'
+   cnfServer.CreateConfiguration(["mydetector", "pilatus"])
+
+results in
+
+.. code-block:: xml
+
+   <definition>
+   <group name="entry" type="NXentry">
+     <group name="instrument" type="NXinstrument">
+       <group name="pilatus" type="NXdetector">
+         <group name="transformations" type="NXtransformations"/>
+         <field name="data" type="NX_FLOAT64"/>
+	 </group>
+       </group>
+     </group>
+     <doc>$var(detector=pilatus)</doc>
+   </definition>

{nxsconfigserver-2.15.0 → nxsconfigserver-2.17.0}/doc_html/Attributes.html

@@ -99,6 +99,16 @@
 		<td> OPERATOR </td>
 		<td> JSON list of datasources to be switched into CanFail mode during creating configuration process </td>
 	</tr>
+	<tr>
+		<td> <a href="AttrExtraLinkDataSources.html"> ExtraLinkDataSources </a> </td>
+		<td> false </td>
+		<td> false </td>
+		<td> Scalar </td>
+		<td> READ_WRITE </td>
+		<td> Tango::DEV_STRING </td>
+		<td> OPERATOR </td>
+		<td> JSON list of datasources to which links will be added </td>
+	</tr>
 </table>
 <br><br>
 <hr>