Creating a Runtime Environment with DB Editor Navigator Tool¶
The "DB Editor Navigator" tool is used to store the overall configuration of the Detector Control System in the central database.
Opening a Terminal Server¶
The user might have to use one of the following methods to access the tool via a terminal server depending on the Operating System and the location before finding the option DB Editor and Navigator.
From Inside CERN
- Open Remote Desktop Connection app.
- Enter
cerntscms.cern.ch
for the computer name andCERN\<cern_user_name>
as the user name. - Click connect and provide the CERN password.
From Outside CERN
- Open the terminal and login to personal lxplus account.
- Enter
ssh -Y <cern_user_name>@lxplus6.cern.ch
. - Enter
rdesktop -g 100% -a16 -u <cern_user_name> -d CERN cerntscms.cern.ch
.
From Inside CERN
- Open the terminal.
- Enter
rdesktop -g 100% -a16 -u <cern_user_name> -d CERN cerntscms.cern.ch
From Outside CERN
- Open the terminal and login to personal lxplus account.
- Enter
ssh -Y <cern_user_name>@lxplus6.cern.ch
. - Enter
rdesktop -g 100% -a16 -u <cern_user_name> -d CERN cerntscms.cern.ch
.
Select "DB Editor and Navigator Dev" from the CMS Terminal Server.
The "DB Editor and Navigator" tool will appear after entering the necessary commands above.
Registering a Host Computer¶
Before starting actions on the DB Editor and Navigator tool, the user should register a host computer.
-
Click on the node "Computers".
-
Click on the "Add Host" button appears under the table popped up on the right hand side.
-
Enter the hostname of the machine that needs registering (eg.
hostMachine.cern.ch
). -
Click "OK" and a popup will inform the outcome of the procedure.
-
Close the panel and move to the tree widget. It will automatically refresh and the newly added host will be visible in the huerarchy.
In the case automatic refresh does not occur follow the procedure below.
If the tree widget is not refreshed, select 'System Hierarchy' from "Switch to Mode" dropdown menu in bottom left corner and change back to 'Projects Setup'.
Registering a Project¶
-
Click on a host node on the tree.
-
Click on the "Add Project" button.
-
Click on "Wizard" button in the new panel.
-
Click "OK" without changing anything in the new popup window and fields of will automatically fill in with predefined values.
-
Once confirmed the creation of the project, the user can edit the project according to requirements.
- Change the project name as preferred.
- The project directory will automatically update with the project name.
- Provide a proper name in the that had not been used earlier 'PVSS System Info' section.
- The button marked as "Show Used" displays all the (used) system names and a dropdown marked as "Available" shows the smallest available number that can be used as a system number.
- Click "Apply" and "Ok" and close the panel.
-
The tree widget will refresh, showing the newly added project under the host.
Adding Project Paths¶
-
In the process of saving the new project user will recieve the below notification, which suggests the importance of defining a path.
-
Select the relevant project and go to the 'Add Paths' tab.
-
Click on the host machine name (I) in the table.
-
Type the directory in the field (II) provided.
Depending on the WinCC OA version the installation directory differes.
- For WinCC 3.15 use C:\DCS\DCSRepository\FrameworkInstallation315_841
- For WinCC 3.16 use C:\DCS\DCSRepository\FrameworkInstallation316_841
-
Click on the III button and check if the path added to the list.
-
Click on the IV button to confirm all actions.
-
Click the "Apply" button to confirm and apply the path.
Targeting Components to a Project¶
Create a Group¶
-
Click on the "Computers" node on the tree widget.
-
Select the 'Edit Groups' tab, which allows the creation, removal and modification of component groups.
-
Click on "Create New" button to create a new group.
-
Provide a name in the 'New component group name' field.
-
Select proper 'Access control domain' (i.e
CMS_GEM
) from the dropdown list available. -
Click on the "Apply" button and then the "Ok" button.
Adding Components to a Group¶
-
Select the created group (I) and click on the "Modify Group" button (II) to add components to the group.
-
Click on the folder icon in the popup panel and direct the path to the destination of the component.
The user should know the components employed in the DCS project. The component list could be found via the postinstall xml file of the project.
Usually all the production components are located under C:/DCS/DCSRepository/ComponentSources.
-
Select the required components and add them by clicking on 'Add to Group' column, which shows the text 'Add' (I) when clicked and clicking the "Add" button (II).
In cases of dependencies components require other components to perform their tasks, which should also be added. In such cases a popup dialog box will inform the user of the fact.
-
Similarly if a component needs to be removed, click on the "Delete" button (IV) after selecting the components to be removed in the 'Delete' (III) column."
-
Click "Ok" when all required components are added.
-
Select the project from the tree widget and go to the 'Components' tab.
-
Move to the left side of the panel, which presents all the available groups registered including ones registered by other users.
-
Use the arrows ">" and "<" between the 2 tables to add or remove groups.
If someone else’s group was selected, they may change the contents of their group at any given time and such components will be untargeted from the project.
-
Click on the "Apply" button.
Once the above procedure is done the tool based part of the "DB Editor and Navigator" is complete and a single click on the project from the tree widget would be like the following image.
Set the Developing Environment Daatbase¶
Refer the configuration of database section.
Creating a Registered Project¶
In order to create a project using the information stored in the database, follow the instructions below.
-
Open a command line with admin privilages) and execute the command,
If the system is WinCC OA 3.15 :
G:\Users\c\cmsdcs\Public\DCSFiles\CMF\ProjectInstallation\CreateServiceProject.bat
If the system is WinCC OA 3.16 :
G:\Users\c\cmsdcs\Public\DCSFiles\CMF\ProjectInstallation_3.16\CreateServiceProject.bat
-
A list of the projects registered in the database for this host will appear under "Available projects for installation on host HOST_NAME:".
If the development machine has both WinCC OA 3.15 and 3.16 installed and if a 3.15 project is required, then running above command will result in an error.
- Copy all the files inside G:\Users\c\cmsdcs\Public\DCSFiles\CMF\ProjectInstallation to the local folder in the user device.
- Edit the bat file 'SetBaseVariables.bat' and remove the part that searches for 3.16 version.
- Save and run 'CreateServiceProject.bat' file exist in the local folder.
-
Type the number of the project to create infront of "Enter project number".
-
Press "Y" to confirm the process "Do you want to proceed with the installation? [Y,N]?".
-
The installation process of the project will continue and at some point user will be prompted for requesting a license which confirms the successful creation of the project.
-
Close that license page and the command line will appear as in the following image.
-
Open the WinCC OA console and the newly created project will appear in the list of projects.
-
Start the project. Note that, this will not open the GEDI.
!!! warning "WinCC OA 3.16 version might give an error message in a dialog box in console when the newly created project is selected.
To resolve this problem, create a folder 'fwComponents_
' inside the directry C:\DCS\WCCOAProjects and then run the command in step 1. -
Open the project shortcut file on the desktop and it will open the GEDI related to the created project.
-
When started, the project automatically connects to the database and starts installing all targeted components.
-
At this point the project is up and running and if logged into 'DB Editor Navigator' tool, the view of the interface will be as in the following image.
Locally Installing New Components to Projects¶
-
Go to the terminal server again and open the 'DB Editor Navigator' tool.
-
Observe that the 'management mode' is currently set to "Central".
-
Change that into "Local" by pressing on the button "Set to Centrak".
-
Move back to the development machine and open a command line with admin privilages to execute the following command.
If the system is WinCC OA 3.15 :
G:\Users\c\cmsdcs\Public\DCSFiles\CMF\ProjectInstallation\CMS_installNewComps.bat
If the system is WinCC OA 3.15 :
G:\Users\c\cmsdcs\Public\DCSFiles\CMF\ProjectInstallation_3.16\CMS_installNewComps.bat
If the development machine has both WinCC OA 3.15 and 3.16 installed and if a 3.15 project is required, then running above command will result in an error.
- Copy all the files inside G:\Users\c\cmsdcs\Public\DCSFiles\CMF\ProjectInstallation to the local folder in the user device.
- Edit the bat file 'SetBaseVariables.bat' and remove the part that searches for 3.16 version.
- Save and run 'CMS_installNewComps.bat' file exist in the local folder.
- Project must be running, when executing this command.
-
Select and type the number of the project requires configuring in front of 'Select project number for HOST_NAME:'.
-
The project is currently running in the Console but GEDI is not opened yet. Go to the desktop and open the shortcut file having WinCC OA icon with the file name containing the project name and the port number, to open the GEDI.
-
In the UI, open the 'Installation' tool by hovering over the tab 'JCOP Framework' and follow the instructions in component installation section.