Home
CONTROL
CONTROL Functions
Functions H
HOOK_ep_acknowledgeTableFunction()
The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.

CONTROL
- Introduction to CTRL
- Control Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
    - hasEvent()
      This function checks if an object defines an event.
    - hasMethod()
      The function returns TRUE when the specified method exists.
    - helpViewerClose()
      The function closes the Help Viewer.
    - helpViewerIsOpen()
      The function confirms if the Help Viewer is open.
    - helpViewerOpen()
      The function opens the Help Viewer.
    - helpViewerReload()
      The function reloads the Help Viewer.
    - HOOK_aes_acknowledgeTableFunction()
      The system executes the function when you acknowledge an alert in the alert screen. Implement the function in a CONTROL library.
    - HOOK_ep_acknowledgeTableFunction()
      The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.
    - HOOK_isAckable()
      The system executes the function when you acknowledge alarms. Implement the function in a CONTROL library.
    - hotKeyDialog()
      The function opens a window that allows you to select a hotkey for a shape.
    - hour()
      Returns the hour portion (0 to 23) of a time t.
    - html_ref()
      This function loads a reference into an HTML reference. The parameters will be replaced.
    - httpAccessLog()
      Creates an httpAccess.log file in the log directory and writes a log line for each HTTP request into the file.
    - httpCloseWebSocket()
      The function closes web sockets.
    - httpConnect()
      Registers a CTRL function as a Web resource
    - httpDisconnect()
      Remove a registered Web-Resource
    - httpGetAllHeaders()
      The function returns a mapping of all HTTP headers.
    - httpGetContent()
      This function extracts the content of the currently processing HTTP-Request.
    - httpGetHeader()
      Returns the value of the header (== key) of the last HTTP message.
    - httpGetLanguage()
      The function checks the stated client connection and returns a matching language ID. The function httpGetLanguageId() can be used to keep the same functionality but have a OaLanguage enum value returned.
    - httpGetLanguageId()
      The function checks the stated client connection and returns a matching OaLanguage enum value. This function provides the same functionality as httpGetLanguage(), but uses the new OaLanguage enum as return value.
    - httpGetMethod()
      The function returns the HTTP method of the last HTTP message.
    - httpGetPort()
      Returns the port and connection used for the HTTP request.
    - httpGetQuery()
      Returns the HTTP query elements as key/value pairs
    - httpGetURI()
      Returns the last from the Client (index) requested URI from the HTTP server.
    - httpMakeParamString()
      Returns a string from the passed arguments that represents the query part of a URL.
    - httpOnConnectionClose()
      The function starts the specified callBack function when the HTTP connection is closed.
    - httpParseDate()
      Allows parsing an RFC-2616 conform date string, e.g. from header "If-Modified-Since".
    - httpReadWebSocket()
      The function reads web sockets.
    - httpSaveFilesFromUpload()
      The function returns the HTTP content of a Blob variable that was received from an HTTP client via an HTML form. The function copies the content of this blob variable (a file) into a directory.
    - httpServer()
      Installs and activates an HTTP server.
    - httpSetMaxAge()
      Defines the time in seconds how long files should be cached by the client.
    - httpSetMaxContentLength()
      Sets the maximum length of a POST request.
    - httpSetMethodHandler()
      The function can be used to redirect an HTTP method to a user-defined CTRL callback function.
    - httpSetPermission()
      The function httpSetPemission() allows to define more fine grained user permissions for a specific URL used with the HTTP Server.
    - httpSetSecondaryAuthSuccess()
      The function is used to check for secondary authentification and implement a login delay.
    - httpSetUlcUserName()
      Sets the userName that will be used for the ULC_UX/ulc_ux_basics.html.
    - httpWriteWebSocket()
      The function writes web sockets.
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CtrlExtension, basics
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.

HOOK_ep_acknowledgeTableFunction()

The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.

Synopsis

HOOK_ep_acknowledgeTableFunction( string objectName,

int type,

string column_DPE,

string column_Time,

string column_Index,

string column_Confirmable,

int top,

int bottom);

Parameters


Parameters	Meaning
objectName	Name of the object (table), for example, "TABLE1".
type	Type 0 = column DPE (see simple configuration: Acknowledge table, Type 1 = column_DPE, column_Time, column_Index, column_Confirmable, for example, used in the alert screen. See simple configuration: Acknowledge table.
column_DPE	Name of the DPE column.
column_Time	Name of the time column.
column_Index	If several alarms occur at the same time, the index is used.
column_confirmable	Can the alert still be acknowledged.
top	Rows to acknowledge (Start).
bottom	Rows to acknowledge (End).

Return value

-

Error

Description

The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library. You have to load this CONTROL library in the user interface when you acknowledge an alarm. Use, for example, the LoadCtrlLibs entry in the config.level file to load the CONTROL library.

Example

If you acknowledge an alarm of the data points ExampleDP_Arg1 or ExampleDP_Arg2 and the acknowledgement was successful, the log viewer shows the Debug information (HOOK_isAckable()).

In the same way if you acknowledge and alarm and you used the simple configuration for the table and acknowledge an alarm, the log viewer shows the debug information (HOOK_ep_acknowledgeTableFunction()). Note that you have to implement these functions in a CONTROL library and you have to load the library as mentioned above.

main()
{
  dyn_string dps;
  dps = makeDynString("ExampleDP_Arg1", "ExampleDP_Arg2");
  int a;
  HOOK_isAckable(2, dps,a); 
  //2 = single acknowledgement
  //a = 1 if the DPs could be acknowledged
  DebugN("DP could be acknowledged if value = 1: ", a);
  DebugN("Hook function HOOK_isAckable executed");
  HOOK_ep_acknowledgeTableFunction("TABLE1", 0);
  /* Name of the table is "TABLE1", type: column DPE (see simple
  configuration: Acknowledge table */
  DebugN("Hook function HOOK_ep_acknowledgeTableFunction
  executed");
}

Assignment

Miscellaneous functions

Availability

CTRL