fesa-instance

Update FESA device instance files in the device-instance part, data taken from a text file.

Utility is located: /common/usr/cscofe/bin/fesa-instance

Usage

usage:  fesa-instance [options]  <cmd-file>
  expects instance files in <base directory>/src/test/<front-end node>/
          instance files: DeviceData*.instance
  -d <base directory>     e.g. ~/workspace/PowerSupply_DU/
  -n <front-end node>     e.g. scuxl0037
                          multiple nodes: use wildcards, BUT ALWAYS QUOTE (or ESCAPE) WILDCARDS!!
                                   quoted wildcards: like -n '*' or -n 'scuxl0??3'
                          default: all nodes ('*')
  -t                      test-only, displays modifications, no update of instance files
  -u                      write nomenclatures not contained in <cmd-file> to file <cmd-file>-add
  -s                      update nomenclature sorted (alphgabetical order)
  -b <bitmap-definitions> file with bitmap definitions, in XML format
  -h                    displays short help

<cmd-file> input-data:
structured text file,
details see section 'Structure of Text File'

The utility fesa-instance will update entries in the device-instance section of the device-instance files for the given front-ends, with values which are defined in the command file.

The device instance files in the corresponding subdirectory will be replaced by the updated new versions!. Up to three older versions of the device instance files are kept, with suffix ~, ~~ and ~~~.

To display modifications but not change the instance files, use option -t.

Special Modes (options -u, -t)

The utility fesa-instance may be used to

• update device names (option -u) in command file:
  generate a new file (<cmd-file>-add), containing all nomenclatures from the instance files which are not contained in the command file (neither in device entries nor in group entries), in the form device GTK1MU1
• test for modifications (option -t), only display which modifications would be applied but not change the instance files

Examples:

Depricated Modes (options -r, with -p, -e, -i, -v)

Starting with version 2.0, which is installed on the Acc8 cluster already, option -r (read instance files entries), with options -p, -e, -i, -v, is no longer supported.

To display the contents of instance-files, please use utility fesa-confdisp.

Structure of Text File

Each line in the file is a separate command.

Each command (each line) starts with a command-key. Command-keys may be abbreviated as far they still are unique, which is down to single letters.

Supported Commands

Commands to Combine Single Commands

ACCUMULATION <accumulation name>

GROUP <group name>

nomen <device-name>

Commands to Identify Devices for which Commands Will Be Executed

device <device-name>

group <group name>

Commands which are Executed for Devices/Groups of Devices

accumulation <accumulation-name>, execute all commands in the accumulation

bitmap <bitmap name>

copyvalue <destination location> <source location>

event <event-mapping> <value>

variable <data-location> <data-value> [<dimension>]

Bitmap Data (Detailed Status Bits, Module Status Bits, Others)

Some of the device configuration data are in the form of lists. In some cases, like the device detailed status bits, items in different lists have to correspond. Ensuring the right position of the items can be difficult, especially for long lists.

To simplify handling of such lists, the can be specified item by item in a specific XML-format in a separate file. From this file, entries for the FESA device-instance file will be generated.

Such bitmap definition files have to be specified by option -b. The format of the definition file is explained in the page FESA-Instance BitMap Definition.

Location-Identification

Entries in the device-instance section of the instance-file are given as <area>.<value>, which means

configuration.accelerator will expand to <configuration> <accelerator> </accelerator> </configuration>

Data will be updated when given as value-attribute or as value subnode in the XML instance file.

Test-Execution

When executing the fesa-instance utility, FESA device-instance files will be updated. The three last versions of the instance files will be available, indicated by <file>~, <file>~~ and <file>~~~

To avoid updating, but still display changes, use option -t (test-only).

Example-Files

For better reading, lines may be indented. Lines starting with hash (#) are interpreted as comments.

Example 1: Modifying entries, using groups of devices and accumulation of commands

Example 2: Update bitmaps, like detailed status entries