Commands

The TEDA framework offers commands to help you administer your applications.

Delete command

The delete removes the contents of shared memory map elements that are defined by key attributes. The delete command is a Lookupmanager command. For information on how to run the command and on the command file format, search for "Command file" in the product documentation, and review the delete command information therein.

Initialization command

The init command creates new shared memory segments. The init command is a Lookupmanager command. For information on how to run the command and on the command file format, search for "Command file" in in the product documentation, and review the init command information therein.

Update command

The update command updates the contents of existing shared memory segments. The update command is a Lookupmanager command. For information on how to run the command and on the command file format, search for "Command file" in in the product documentation, and review the update command information therein.

Restart command

Use the restart command to restart the synchronization process between the Lookup Manager application and its managed ITE applications.

You can use this command to achieve the following objectives:
  1. To unregister an ITE application so that it will no longer be controlled by the Lookup Manager application
  2. To register an ITE application so that it will be controlled by the Lookup Manager application again

You can unregister and register the ITE applications that are on the list of controlled ITE applications. The list is created when the Lookup Manager application compiles.

To run the restart command, create the appl.ctl.cmd file with the following content and move this file to the application control directory that is specified in the global.applicationControlDirectory parameter. Thus, you ensure that the file appears in the application control directory with an atomic operation, otherwise the file can be read before it is completely written.

The appl.ctl.cmd file contains a single line that starts with the restart word. This line can be extended with a comma-separated list of namespaces, which are the namespaces of the ITE applications in the compile-time list of controlled ITE applications, for example: restart,a,b,c. If an unknown or unsupported namespace is provided, the command fails and an error message is appended to the action control file. If the command succeeds, a success message is appended to the action control file.

You want to unregister and register ITE applications to keep the Lookup Manager application running while you maintain the ITE applications. The advantages of a continuously running Lookup Manager application are:
  • Other running ITE applications pause for a short time while they synchronize with the Lookup Manager application. There is no manual action required to cancel and submit the ITE applications.
  • The Lookup Manager application does not need to refresh the enrichment data in the shared memory. There is no need to process an init command that is initiated with the init.cmd file. The skipped refresh of the enrichment data usually saves a lot of time.

The restart command changes the states of the Lookup Manager and ITE applications and ends only when all specified ITE applications are synchronized. You should observe the command and verify that it succeeds. Otherwise, your ITE applications do not process any data. Depending on the size of your processed files, the command should end within seconds or few minutes.

Shutdown command

Although you can shut down TEDA application jobs like any other Streams job, it is recommended that you use the teda-shutdown-job command line tool to gracefully shut down the application jobs.

For Lookup Manager jobs, the shutdown ensures that the job finishes all queued update commands. Thus the lookup cache is in a consistent state after shutdown. For ITE jobs, the shutdown ensures that the processing is stopped at file boundaries and, if possible, state checkpoint files are written to the checkpoint directory.