FAQ - Frequently Asked Questions

Eclipse related

How to import an existing FESA class/FESA deploy-unit into the workspace ?

• Copy the class to your workspace or check it out via SVN
• Open the C++ perspective or the FESA perspective
• File --> Import --> "Existing Projects into Workspace"
• Browse to the root directory of the project(s) you want to add.
• Select the project(s) to import.
• Press "Finish"

After the import of existing working copies from another workspace the SVN repository URL is wrong. However, the project is still connected to the proper SVN repository internally. How do I adjust the wrongly displayed URL?

• Disconnect the project via Team > Disconnect
• On the dialog popping up select "Do not delete the SVN meta-information (e.g. svn subdirectories)"
• Reconnect the project via Team > Share project...
• Select the repository type SVN
• Select the proper SVN repository URL (location label) (https://www-acc.gsi.de/svn/fesa/device/class or https://www-acc.gsi.de/svn/fesa/device/deploy-unit)
• Keep the project settings

How can I get help/information on FESA while working with the FESA Eclipse plug-in?

Where do I find example FESA software?

How do I enable icons in menus in Eclipse?

What can I do to see more log output of the FESA Eclipse plug-in?

The Console View does not display any log Messages from the FESA Eclipse plug-in. What's wrong?

How do I manage Eclipse's Secure Storage password?

How do I get rid of obsolete perspectives in Eclipse, e.g. <FESA> / <<FESA>> after repeated updates or new installations of the FESA plug-in?

How do I convince the build console to appear automatically on top during a build?

Can I use FESA on the commandline? Can I write a shell script for frequently occuring FESA operations?

How do I uninstall the FESA3 Eclipse plug-in?

• Select from the menu Help > Install New Software... . This displays the Available Software dialog.
• Click the blue hyperlink "What is already installed" in the bottom section of the Available Software dialog.
• From the Installed Software tab select the FESA Eclipse plug-in and press the Uninstall... button.
• Follow the required steps of the uninstall procedure and restart Eclipse as suggested.

Can I use the FESA Explorer without Eclipse?

• Possibility 1: Launch the run script directly: /opt/fesa/fesa-explorer/<FESA_VERSION>/bin/fex
• Possibility 2: Use the JAVA webstart version: javaws https://websvcdev.acc.gsi.de/groups/lobi/applications/fesa-explorer/current/fesa-explorer2.jnlp

Content assistance / auto completion does not work? What's wrong?

The FESA Eclipse plug-in does not write messages to the console any more. What can I do ?

• First of all, please check that the view "Console" is open. On the right side of the console you can pick between different consoles.
• For me the problem somehow was workspace-specific. Only In one specific eclipse-workspace, the FESA eclipse plug-in did not write to the console any more. I was able to fix that by removing the folder ".metadata" of this workspace. ( move the folder to ".metadata.old" in case you want to switch back! )
• Here as well a stack-overflow thread on the topic.

The number of projects in my workspace is large. Is there a way to focus on the three projects I currently work on?

How can I view documents side by side?

• If more than one document is open in an editor the upper tab (where the file name is shown) may be dragged within the workbench. Docking frames (=vertical/horizontal lines) for "dropping" the document will be displayed within the workbench when moving the document around.
• Since Eclipse Luna it is possible to drag a document in an editor window outside of the Eclipse main frame.

Eclipse Neon appears to be slower on asl74x. How can I improve this?

• Configure Eclipse to explicitly use GTK2 instead of GTK3. This can also be set permanently in ~/.bash_rc .

#Gtk2 forced:
export SWT_GTK3=0
eclipse-neon&

#Gtk3 forced:
export SWT_GTK3=1
eclipse-neon&

Can I use a workspace created with an older Eclipse version with a newer Eclipse version?

Some plug-Ins are not loaded properly?

e.g. eclipse-neon -clean&

Shortcuts like Ctrl+Shift+V for validating FESA Designs are not working?

How can I move a detached window back into the Eclipse main window?

• For example drag the Console View close to another tabbed view. The insertion spot should be highlighted.
• Alternatively: Reset the perspective. "Windows -> Reset Perspective ...

Editing instantiation units in the table view is troublesome, columns scrolled into view cannot be edited. What is the workaround?

• Moving columns from the right to the left so the scrollbar does not have to be used. Moving columns is done by dragging and dropping the title of a column.
• Working with a large monitor

Update of timing information in instance file: why does it not work?

FESA Explorer does not launch since 04/19?

XML Document modification

In setting properties a warning recommends to introduce min-/max- items for each value-item. What is this?

How do I use the units-value-item?

The FESA design has an error. Why is it not visible in the Problems View?

How can I comment or copy nodes in the design view of a FESA design?

The default of a new field/value-item is 'scalar'. How can I use arrays?

I use a custom server action. Why some value-items are still filled by the FESA FWK?

Why does the promotion mechanism for instance files not work?

• The promotion mechanism relies on XSD schema. The XSD schema files are created / updated in the background during source code synchronization.

Why does the promotion mechanism ignore my setting / acquisition data fields?

• These types of data fields in the FESA class design are promoted only to the instance file if a default value is given in the FESA class design.

• ---

C++ Programming

How do I use C++ editing support?

How do I place 2D-Arrays in the RDA data container using C++?

string testString = "This is a test string";
const char ** stringArray = new const char*[11];
 for (int i = 0; i < 11 ; i++) {
 stringArray[i] = testString.c_str();
 }
long dims[2] = {11,25};
data.insert("dim_charArrayValue", dims, 2);
data.insert("charArrayValue", stringArray, 11);

How do I access values in 2D arrays? What do I have to consider?

 <data>
    <device-data>
        <configuration>
            <field name="structArray">
               <custom-type-array2D data-type-name-ref="StructArray">
                   <dim1>3</dim1>
                  <dim2>3</dim2>
               </custom-type-array2D>
               <default>{{{-1,-1,-1}}}</default>
           </field>
       </configuration>

 <device-instance name="TestDevice0" state="development">
    <configuration>
        <description value=""/>
        <accelerator value="NONE"/>
        <timingDomain value="NONE"/>
        <acceleratorZone value="NONE"/>
        <mainMuxCriterion value="NONE"/>
        <structArray idref="_180319182146_0">
            <value>{{{39.948,18,1},{-1,-1,-1},{-1,-1,-1}},{{12.001,6,1},{15.99994,8,2},{-1,-1,-1}},
{{7.1,5,2},{0.8,1,5},{-1,-1,-1}}}</value>
        </structArray>
   </configuration>

std::cout << " max size: " << maxSize1 << ", " << maxSize2 << std::endl;
uint32_t size1, size2;
const StructArray::StructArray *s = pDev->structArray.get(size1, size2);
std::cout << " actual size: " << size1 << ", " << size2 << std::endl;

for (int i = 0; i < maxSize2; i++) {
   for (int j = 0; j < size2; j++) {
      std::cout << " i: " << i << " j: " << j ;
      const StructArray::StructArray *m = pDev->structArray.getCell(i, j);
      std::cout << " - (" << m->a << ", " << m->z << ", " << m->sr << ")" << std::endl;
   }
}

How do I enable / disable my own DEBUG messages within a FESA class?

How do I provide my custom logging topic for my FESA software?

• First define a custom logger:

cmw::log::Logger& mylogger = cmw::log::LoggerFactory::getLogger("FESA.SW.MyVerySpecialLogger");

• Use the custom logger in the log macros, e.g.

    LOG_ERROR_IF(mylogger, "Setting1GetAction::execute - ERROR");
    LOG_TRACE_IF(mylogger, "Setting1GetAction::execute - TRACE");
    LOG_DEBUG_IF(mylogger, "Setting1GetAction::execute - DEBUG");
    LOG_INFO_IF(mylogger, "Setting1GetAction::execute - INFO");
    LOG_WARNING_IF(mylogger, "Setting1GetAction::execute - WARNING");

• Use a custom log.cfg along with the deploy-unit file which contains the custom logger:

...
logger.FESA.DIAG.level = AUDIT

# custom logger
logger.FESA.SW.MyVerySpecialLogger.level = WARNING

How do I use preprocessor directives to enable MOCK sections?

• If the preprocessor directive is going to be reused within several source files:
  • Define a C++ helper class within <class project>/src/<class name>/Common/UserCode, e.g. <class name>Helper, make sure you have the same namespace as the FESA class itself
  • define the preprocessor directive you need in the header, e.g. MOCK_<class name>
  • in the source file you would like to use the preprocessor directive:
    • include the helper class using #include <<class name>/Common/UserCode/<class name>Helper.hpp>
    • use the directive #ifdef MOCK_<class name> around the section you use for mocking, etc
  • if the preprocessor directive is uncommented in the helper classes' header the section will be executed during runtime
  • if the preprocessor directive is commented the section will be ignored

How do I use the hasDataChanged()-method in custom get actions?

bool hasDataChanged(const fesa::RequestEvent& event, fesa::AbstractDevice& abstractDevice, const rdaData& filter) const;

bool !GetAcquisition::hasDataChanged( const fesa::RequestEvent& event, fesa::AbstractDevice& abstractDevice, const rdaData& filter) const {
    Device& device = static_cast<Device&>(abstractDevice);

    if( device.dataChanged.get(event.getMultiplexingContext()) == true ) {
        return true;
    }
    return false;
}

How do I send manual notifications from an RT action to other properties in a FESA class?

• Given that the FESA class design is already prepared for sending manual notifications from an RT action the following steps still have to be performed in the C++ code:
  • call registerManualNotification("NameOfThePropertyWithoutNamespace", pDev->getName()); within the device loop
  • call sendManualNotification(pCtxt); after the loop for the devices to send all registered notifications

How do I work with filter-items?

const char* theFilter = filter.getAFilter();
if( strcmp(theFilter, "AString")==0 ) {
    data.setAnItem1(true);
    data.setAnItem2(true);
} else {
    data.setAnItem1(false);
    data.setAnItem2(false);
}

How do I retrieve the FESA class name / version in the C++ code?

std::string className = this-><FESAClassName>ServiceLocator_->getClassName();
std::string classVersion = this-><FESAClassName>ServiceLocator_->getClassVersion();

How do I provide on-change functionality? I.e. send data only when it has notably changed?

• In the FESA class design: set the attribute 'on-change' to true in the property definition. This will indicate the intention to the applications.
• In the property implementation: adapt the default implementation of the method 'hasDataChanged'. Per default this method returns true which indicates a data change. If data changes within borders only are supposed to be published it is possible to implement this in the 'hasDataChanged' method.

How do I use GSI's Conditions to illustrate error conditions of my FESA software?

• FESA3UsageOfExceptions

How do I create and use an array of strings?

• An example is found in the integration test class RDADataTypes in the setting property '!AllTypesArray2D'. Basically a 2D-array of the type char is defined in the FESA class design. In the C++ code the array can be filled using the method setString:

  pDev->array2d.setString("the value", index, pContext);

Can I use the timing events and their event numbers in C++ code?

How can I provide default values for GSI specific data fields?

How can I observe custom data of FESA software?

How can I construct my own ! TimingContext with a Selector?

fesa::MultiplexingContext* pCtxt = new fesa::TimingContext("FAIR.SELECTOR.S=1");

How can I construct a TimingContext with non-default access rights?

// TimingContext to write settings in a set action
fesa::MultiplexingContext* pCtxt = new fesa::TimingContext("FAIR.SELECTOR.S=1", fesa::ActionType::SetAction, SET_ALLOWED, SET_ALLOWED | CHECK_FLAG_TO_BE_SYNC );

How can I provide my own TimingContext to avoid the error message "FESA_5014 The multiplexed field 'acquisitionContext' cannot be accessed using a NoneContext."?

class TimingContextToWorkAroundRecentChangesInFesa: public MultiplexingContext {
public:
    TimingContextToWorkAroundRecentChangesInFesa(const std::string& cycleName, timestamp_ns cycleStamp);
};

/*
 * getSlot() in RTActions uses only the timestamp. However, the time stamp gets lost
 * (i.e. is replaced with the system time) when calling via an OnDemandEventSource!!!
 */
TimingContextToWorkAroundRecentChangesInFesa::TimingContextToWorkAroundRecentChangesInFesa(const std::string& cycleName, timestamp_ns cycleStamp)
{
  type_ = CycleTypeCtxt;
  cycleName_ = cycleName;
  cycleStamp_ = cycleStamp;
  timeStamp_ = cycleStamp;
}

void FileWriteRTAction::execute(fesa::RTEvent* pEvt)
{ ...
TimingContextToWorkAroundRecentChangesInFesa *context = new TimingContextToWorkAroundRecentChangesInFesa(ctxt->getCycleName(),ctxt->getCycleStamp());
  ...
}

Release / Delivery / Deployment

How do I mount the required FESA directories on a (virtual) front-end?

How do I deliver FESA software for the MCS in Saclay, France?

How do I configure the FESA deploy-unit to use White Rabbit based timing?

Why does export to the database not work? An RMI exception is thrown.

"Error creating bean with name 'org.springframework.remoting.rmi.RmiServiceExporter#0' defined in class path resource [resources/server_config.xml]: Invocation of init method failed; nested exception is java.rmi.ServerException: RemoteException occurred in server thread; nested exception is:
               $ java.rmi.UnmarshalException: error unmarshalling arguments; nested exception is:
               $ java.lang.ClassNotFoundException: org.springframework.remoting.rmi.RmiInvocationHandler (no security manager: RMI class loader disabled)"

Why does SVN require a password during the release of operational FESA software? -> ACC Login (kerberos)

a.k.a Eclipse freezes during release

Release ElectroStatQuadDU, version 0.2.0 Delivering FESA deploy-unit
ElectroStatQuadDU.deploy for !FEC vmla09...
Authentication realm: < [[https://www-acc.gsi.de:443][https://www-acc.gsi.de:443]]> ACC Login (kerberos)

user@asl7xx:lnx>kinit; eclipse-neon&

During release the KDE Wallet pops up. What is this?

How do I create instance documents for mock devices efficiently?

What is the difference between development/test and productive release of FESA software?

How can I jump directly to directories relevant for FESA development on the asl74x-cluster?

Runtime

How do I launch a FESA3 deploy-unit automatically on a (virtual) front-end?

How do I test whether my FESA software is running and accessible for applications?

• Raphael M. kindly provided a tool to test the full stack from the top:

  ./device-connectivity-test.sh <device instance name> <property name>

• The tool will not only print the data it received but also summarize at the end in which layer problems appeared. Example:

  ...
  --------------- Result Summary ---------------
  
   Device : 'XYR01LB1'
   Property : 'Status'
  
   Nameserver : success
   CMW/RDA3 (get) : success
   JAPC (get) : success
   CMW/RDA3 (subscribe) : success
   JAPC (subscribe) : success

• The official wiki page: https://www-acc.gsi.de/wiki/Service/SvDeviceTest

How can I check whether my deploy-unit is up and running?

• Launch ./cmw-admin-console on the command line at a machine of the asl cluster. The tool lists the FESA software found in the database and allows status checks.

How do I quickly test whether my FESA software is running and accessible via RDA3 directly?

• Use the RDA3 C++ client software which is available for the FESA developers on the asl cluster:
• get-rda3-c++, set-rda3-c++, subscribe-rda3-c++

# set environment variable for appropriate CMW directory server
export CMW_DIRECTORY_CLIENT_SERVERLIST=cmwdev00a.acc.gsi.de:5021 # DEV and TEST environment
export CMW_DIRECTORY_CLIENT_SERVERLIST=cmwpro00a.acc.gsi.de:5021 # PRODUCTION environment

# perform get of Status property on device TestDevice0
user@asl74x:~> get-rda3-c++ -d TestDevice0 -p Status

# subscribe to a multiplexed property with a cycle name
user@asl74x:~> subscribe-rda3-c++ -d TestDevice0 -p Acquisition -c FAIR.SELECTOR.S=1 

How do I find out in which environment my FESA software is running? Test/Development or Productive?

user@asl74x:~> locate-fesa-software -f <name of FESA deploy-unit>

How do I find out in which environment my device is available? Test/Development or Productive?

user@asl74x:~> locate-fesa-software -d <name of device>

When is the persistency data file written?

On a FEC: Where is the persistency data file located?

On the asl-cluster: Where is the persistency data file located?

FESA_9006 Failed to restore the devices

FESA_13008 Partial setting not allowed for this property

FESA_13021 The field namedPositionNames has no data for the cycle selector ALL (no set was done before calling get) ...

• The exception relates to the content of the rolling buffer that is used internally for acquisition fields. If the content is empty when a get-Operation is performed the exception is thrown. To circumvent this exception it is recommened to fill the buffer, e.g. during initialization before reading it. This may happen in an RT-Action for example:

void StatusRTAction::execute(fesa::RTEvent* pEvt) {
   MultiplexingContext *pCtxt = pEvt->getMultiplexingContext();
   std::vector<Device*> deviceCollection =
         A201ServiceLocator_->getDeviceCollection();
   for (unsigned int i = 0; i < deviceCollection.size(); i++) {
      Device *pDev = deviceCollection[i];
      if (pDev->power.get(pCtxt) != DEVICE_POWER::ON) {
         pDev->powerState.set(DEVICE_POWER_STATE::OFF, pCtxt);
         std::cout << "StatusRTAction(): power off device : "
               << pDev->getName() << std::endl;
         pDev->status.set(DEVICE_STATUS::UNKNOWN, pCtxt);
         pDev->detailedStatus.lower(0, pCtxt);
         pDev->detailedStatus.lower(1, pCtxt);
         pDev->control.set(DEVICE_CONTROL::LOCAL, pCtxt);
         pDev->opReady.set(false, pCtxt);
         pDev->interlock.set(false,pCtxt);
         std::string errorString= "Device turned off";
         long error_code= 4711;
         pDev->error_collection.set(0,0,pCtxt);
      } else {
         pDev->powerState.set(DEVICE_POWER_STATE::ON, pCtxt);
         std::cout << "StatusRTAction(): power on device : "
               << pDev->getName() << std::endl;
         pDev->status.set(DEVICE_STATUS::OK, pCtxt);
         pDev->detailedStatus.raise(0, pCtxt);
         pDev->detailedStatus.raise(1, pCtxt);
         pDev->control.set(DEVICE_CONTROL::LOCAL, pCtxt);
         pDev->opReady.set(true, pCtxt);
         pDev->interlock.set(false,pCtxt);
         std::string errorString= "Device turned on";
         long error_code=1;
         pDev->error_collection.set(0,0,pCtxt);
      }
      std::cout << "Synchronize setting fields" << std::endl;
      pDev->synchronizeSettingFields(*pCtxt);
   }}

• Another possibility is to remove the data-field-ref elements in the value-item definition of the acquisition property. Then it is possible to set the outgoing acquisition data in the C++ code of the get action for the acquisition property.

FESA_4025 Instantiation file error: The value '-2147483648' is not valid for the xml-attribute 'value'....

FESA_1009 Failed to set the priority of the thread 'Notif_thread-default' to '17'. POSIX-ErrorMessage: Permission denied.

                <client-notification-threads>
                    <thread-default prio="1"/>
                </client-notification-threads>

FESA_12005 Value item 'Operation': invalid data; nested error message: FESA_10009 Invalid value: '0' is invalid regarding...

I cannot connect to running FESA software with the FESA Explorer, and yes, the FESA software is up and running

How can I see the log output of my FESA software?

How can I see which environment variables apply for a running process? (=which CMW nameserver is used by a FESA deploy-unit?)

strings –a /proc/<pid_of_the_process>/environ

How can I stop the daemon running a deploy-unit?

daemon -n testDU --stop

How can I restart the daemon running a deploy-unit?

daemon -n testDU --restart

How can I start a deploy-unit on a FEC manually for testing?

cd /opt/nfsinit/<FEC name>
./50_fesa_...

My newly inserted RT action is not triggered. Why?

How can I observe process statistics (notification queue length, # RT action/get/set calls, ...) of FESA software?

How can I read/write properties of FESA software using a (Python) script?

Frontends

How do I configure comfortable commands like 'll' on a front-end?

cd /common/export/nfsinit/vmla01
ln -s ../global/niceShortcuts 60-niceShortcuts

How can I see the log output of a booting front-end?

graylog tail --source <hostname> # e.g. graylog tail --source scuxl0000

How do I adjust a FEC for a certain operating system?

cd /common/tftp/csco/pxe/pxelinux.cfg
ln -s virtual_scuxl.el7 vmla01

How do I use a GSI nomenclature instead of a frontend hostname?

• obtain a GSI nomenclature for the frontend from Maria Kuehn
• enable DNS mapping of GSI nomenclature to original hostname: https://www-acc.gsi.de/wiki/FESA/FrontEnds#FECnameDNSmapping
• if the DNS mapping works GSI nomenclatures can be used instead of the FEC hostname for configuration of FESA deploy-units (-> name of the FEC folder)
• contact persons: Matthias Wiebel, Christoph Handel
• good to know:
  • connecting to the FEC requires the original hostname or <nomenclature>.fec.acc.gsi.de
  • the source of log messages is the original hostname

FESA Database

How can I store information in the FESA database?

How can I find out what is stored in the FESA database?

Exporting instances to the test database: what does the "Event is not defined" error message mean?

cern.fesa.model.exception.FesaException: Could not export to database: DeviceData_Z_DU.instance
    at cern.fesa.control.database.LabDataBaseManager.export(LabDataBaseManager.java:219)
    at cern.fesa.plugin.job.ExportJob.runInWorkspace(ExportJob.java:67)
    at org.eclipse.core.internal.resources.InternalWorkspaceJob.run(InternalWorkspaceJob.java:39)
    at org.eclipse.core.internal.jobs.Worker.run(Worker.java:55)
Caused by: java.lang.RuntimeException: Could not insert instantiation unit:PreparedStatementCallback; uncategorized SQLException for SQL [call fesa_server.insert_instantiation_unit(?,?,?)]; SQL state [72000]; error code [20037]; ORA-20037: PROCESSING_ERROR : Error occured when inserting FESA IU ORA-20001: Event is not defined!

ORA-06512: at "FESA.COM_ERROR_MGR", line 25
ORA-06512: at "FESA.COM_EVENT_MGR", line 504
ORA-06512: at "FESA.COM_EVENT_MGR", line 715
ORA-06512: at "FESA.COM_EVENT_MGR", line 689
ORA-06512: at "FESA.FESA_INSTANTIATION_INSERTION", line 187
ORA-06512: at "FESA.FESA_INSTANTIATION_INSERTION", line 1210
ORA-06512: at "FESA.FESA_INSTANTIATION_INSERTION", line 1328
 Err: ORA-06512: at "FESA.COM_ERROR_MGR", line 25
ORA-06512: at "FESA.COM_EVENT_MGR", line 504
ORA-06512: at "FESA.COM_EVENT_MGR", line 715
ORA-06512: at "FESA.COM_EVENT_MGR", line 689
ORA-06512: at "FESA.FESA_INSTANTIATION_INSERTION", line 187
ORA-06512: at "FESA.FESA_INSTANTIATION_INSERTION", line 1210
ORA-06512: at "FESA.FESA_INSTANTIATION_INSERTION", line 1328
ORA-06512: at "FESA.FESA_SERVER", line 83
ORA-06512: at line 1

• the test database checks for duplicate device instance names across different FESA classes
• both databases: sensitive to renamed elements in FESA design
• ...

FESA Class Documentation

How do I provide documentation for a FESA3 class?

Is there a possibility to visualize a FESA class design graphically?

How do I upload FESA class documentation to the webdav server?

How can I see the documentation on the server?

SVN Repository Handling

SVN - I just marked a file to be ignored by SVN. However now I cannot commit the folder where the file to be ignored is inside.

SVN - My FESA project was inserted into the SVN repository automatically during creation. But I am not able to synchronize the project with the SVN repository.

SVN - In Eclipse I can not mark a file to be ignored. The menu is greyed out.

• Option 1: Remove the file. Commit and update the folder. Add the file again if necessary. Select Team > Add to svn:ignore .
• Option 2: Work on the command line. Ignore a directory: svn propset svn:ignore dirname . Ignore a file type: svn propset svn:ignore "*.zip" = . Edit the ignore file manually: =svn propedit svn:ignore .

SVN - After project synchronization an error occurs and the SVN connection appears to be lost in Eclipse. No SVN URL is displayed anymore in the Project Explorer.