:tocdepth: 3 ################ PromptProcessing ################ .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _PromptProcessing:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _PromptProcessing:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _PromptProcessing:enable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enterControl ~~~~~~~~~~~~ **Description**: Transition from state Offline to Standby. Only "externally commandable" CSCs support this command; other CSCs start in Standby state and quit when they go to Offline. :EFDB_Topic: SALGeneric_command_enterControl .. _PromptProcessing:enterControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used exitControl ~~~~~~~~~~~ **Description**: Transition from state Standby to Offline. For CSCs that are not "externally commandable" this makes the CSC quit. :EFDB_Topic: SALGeneric_command_exitControl .. _PromptProcessing:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _PromptProcessing:setAuthList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC, in the form user@host. If the first character is +/- then the specified users are added/removed. Duplicates are silently ignored. The CSC's own user@host is silently ignored, because it is always authorized. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma. .. _PromptProcessing:setAuthList:nonAuthorizedCSCs: nonAuthorizedCSCs ***************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of CSC's not currently allowed to command this CSC, in the form name[:index]. An index of 0 is stripped (name:0 becomes name). If the first character is +/- then the specified CSCs are added/removed. Duplicates are silently ignored. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma. setLogLevel ~~~~~~~~~~~ **Description**: Set the logging level. :EFDB_Topic: SALGeneric_command_setLogLevel .. _PromptProcessing:setLogLevel:level: level ***** :IDL_Type: int :Units: unitless **Description**: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10. setValue ~~~~~~~~ :EFDB_Topic: SALGeneric_command_setValue .. _PromptProcessing:setValue:parametersAndValues: parametersAndValues ******************* :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: List of parameters and their values as a Json string standby ~~~~~~~ **Description**: Transition from state Offline, Disabled or Fault to Standby. :EFDB_Topic: SALGeneric_command_standby .. _PromptProcessing:standby:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used start ~~~~~ **Description**: Transition from state Standby to Disable, in a specified configuration. :EFDB_Topic: SALGeneric_command_start .. _PromptProcessing:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Events ------ .. _PromptProcessing:Events:entityShutdown: entityShutdown ~~~~~~~~~~~~~~ :EFDB_Topic: PromptProcessing_logevent_entityShutdown .. _PromptProcessing:Events:entityShutdown:name: name **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the entity to startup. .. _PromptProcessing:Events:entityShutdown:identifier: identifier ********** :IDL_Type: double :Units: unitless **Description**: Entity identifier. .. _PromptProcessing:Events:entityShutdown:timestamp: timestamp ********* :IDL_Type: string :IDL_Size: 256 :Units: second **Description**: Timestamp the event data was generated. .. _PromptProcessing:Events:entityShutdown:address: address ******* :IDL_Type: long :Units: unitless **Description**: Entity adress .. _PromptProcessing:Events:entityStartup: entityStartup ~~~~~~~~~~~~~ :EFDB_Topic: PromptProcessing_logevent_entityStartup .. _PromptProcessing:Events:entityStartup:name: name **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the entity to startup. .. _PromptProcessing:Events:entityStartup:identifier: identifier ********** :IDL_Type: double :Units: unitless **Description**: Entity identifier. .. _PromptProcessing:Events:entityStartup:timestamp: timestamp ********* :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Timestamp the data was generated .. _PromptProcessing:Events:entityStartup:address: address ******* :IDL_Type: long :Units: unitless **Description**: IP address of the entity .. _PromptProcessing:Events:entitySummaryState: entitySummaryState ~~~~~~~~~~~~~~~~~~ :EFDB_Topic: PromptProcessing_logevent_entitySummaryState .. _PromptProcessing:Events:entitySummaryState:name: name **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Entity name. .. _PromptProcessing:Events:entitySummaryState:identifier: identifier ********** :IDL_Type: double :Units: unitless **Description**: Entity identifier. .. _PromptProcessing:Events:entitySummaryState:timestamp: timestamp ********* :IDL_Type: string :IDL_Size: 256 :Units: second **Description**: Timestamp the event data was generated. .. _PromptProcessing:Events:entitySummaryState:address: address ******* :IDL_Type: long :Units: unitless **Description**: Entity adress .. _PromptProcessing:Events:entitySummaryState:currentState: currentState ************ :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Entity current state. .. _PromptProcessing:Events:entitySummaryState:previousState: previousState ************* :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Entity previews state. .. _PromptProcessing:Events:entitySummaryState:executing: executing ********* :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: What is being executed? .. _PromptProcessing:Events:entitySummaryState:commandsAvailable: commandsAvailable ***************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Currently available commands. .. _PromptProcessing:Events:entitySummaryState:configurationsAvailable: configurationsAvailable *********************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Currently available configurations. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _PromptProcessing:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _PromptProcessing:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _PromptProcessing:authList:nonAuthorizedCSCs: nonAuthorizedCSCs ***************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of CSC's not currently allowed to command this CSC. errorCode ~~~~~~~~~ **Description**: Output when a CSC goes into the Fault state as an explanation of the problem. :EFDB_Topic: SALGeneric_logevent_errorCode .. _PromptProcessing:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _PromptProcessing:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _PromptProcessing:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _PromptProcessing:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _PromptProcessing:logLevel:level: level ***** :IDL_Type: int :Units: unitless **Description**: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10. logMessage ~~~~~~~~~~ **Description**: A log message. :EFDB_Topic: SALGeneric_logevent_logMessage .. _PromptProcessing:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _PromptProcessing:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _PromptProcessing:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _PromptProcessing:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _PromptProcessing:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _PromptProcessing:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _PromptProcessing:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _PromptProcessing:logMessage:process: process ******* :IDL_Type: long :Units: unitless **Description**: Process ID. settingVersions ~~~~~~~~~~~~~~~ **Description**: Information about settings which can be specified in the start command. :EFDB_Topic: SALGeneric_logevent_settingVersions .. _PromptProcessing:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _PromptProcessing:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _PromptProcessing:settingVersions:settingsUrl: settingsUrl *********** :IDL_Type: string :Units: unitless **Description**: The URL where the settings sets definitions can be found settingsApplied ~~~~~~~~~~~~~~~ **Description**: Base settings applied. :EFDB_Topic: SALGeneric_logevent_settingsApplied .. _PromptProcessing:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _PromptProcessing:settingsApplied:otherSettingsEvents: otherSettingsEvents ******************* :IDL_Type: string :Units: unitless **Description**: A comma delimited list of other specific CSC configuration events. This may be blank if no other CSC specific events are necessary simulationMode ~~~~~~~~~~~~~~ **Description**: Current simulation mode. :EFDB_Topic: SALGeneric_logevent_simulationMode .. _PromptProcessing:simulationMode:mode: mode **** :IDL_Type: int :Units: unitless **Description**: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC. softwareVersions ~~~~~~~~~~~~~~~~ **Description**: Current versions of software in use by CSC. :EFDB_Topic: SALGeneric_logevent_softwareVersions .. _PromptProcessing:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _PromptProcessing:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _PromptProcessing:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _PromptProcessing:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _PromptProcessing:softwareVersions:subsystemVersions: subsystemVersions ***************** :IDL_Type: string :Units: unitless **Description**: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within a CSC summaryState ~~~~~~~~~~~~ **Description**: Current summary state of the CSC :EFDB_Topic: SALGeneric_logevent_summaryState .. _PromptProcessing:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _PromptProcessing:Telemetry:sequencerHeartbeat: sequencerHeartbeat ~~~~~~~~~~~~~~~~~~ :EFDB_Topic: PromptProcessing_sequencerHeartbeat .. _PromptProcessing:Telemetry:sequencerHeartbeat:name: name **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the entity to startup. .. _PromptProcessing:Telemetry:sequencerHeartbeat:identifier: identifier ********** :IDL_Type: double :Units: unitless **Description**: Entity identifier. .. _PromptProcessing:Telemetry:sequencerHeartbeat:timestamp: timestamp ********* :IDL_Type: string :IDL_Size: 256 :Units: second **Description**: Timestamp the event data was generated.