Home
CONTROL
CONTROL Functions
Functions W
writeAuditBatchEntry()
The function is used e.g. in production processes and it writes the batch id, the data point element the executed action had an influence on, the data point type, the executed action and the reason why the action was executed.

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
  - 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
    - waitThread()
      Waits for the end of the specified thread.
    - webSocketClose()
      The function closes the given WebSocket connection. The WebSocket number is the return value of webSocketOpen().
    - webSocketOpen()
      Opens a WebSocket connection to the given url.
    - webSocketRead()
      Tries to retrieve the next message form the WebSocket.
    - webSocketWrite()
      Writes data to the given WebSocket.
    - weekDay()
      Returns the weekday of a time.
    - wf_bottomBar_reload()
      Updates the buttons of the bottomBar of the wizard framework.
    - windowStyle()
      The function windowStyle() can be used to deactivate the control menu or only the minimize box
    - writeAuditBatchEntry()
      The function is used e.g. in production processes and it writes the batch id, the data point element the executed action had an influence on, the data point type, the executed action and the reason why the action was executed.
    - writeAuditEntry()
      The function writeAuditEntry is used to write set point values into the Audit trail panel.
    - writeDictionary()
      Writes the internal translation table to a file.
    - wss_getGenericSetting()
      Reads all workstation settings without hierarchy.
    - wss_getSpecificSetting()
      Reads a specific workstation setting without hierarchy.
    - wss_getSpecificWorkstationSetting()
      Reads a specific workstation setting with hierarchy.
    - wss_getWorkstationSettings()
      Reads all workstation settings with hierarchy.
  - Functions X
  - Functions Y
  - Functions Z
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension, basics

writeAuditBatchEntry()

The function is used e.g. in production processes and it writes the batch id, the data point element the executed action had an influence on, the data point type, the executed action and the reason why the action was executed.

Synopsis

writeAuditBatchEntry(unsigned batchid,string item,string itemtype,string action,int &error,string reason = "");

Parameters


Parameter	Description
batchid	The id number of a process if a process number exists.
item	The data point element the executed action had an influence on (e.g. string item = "prod_proc";).
itemtype	The data point type. The type is, however, not shown in the Audit trail panel.
action	The executed action (e.g. string reason = "Production process started").
&error	The returned error code If the return code is 0 the error is OK Error handling is not programmed.
reason = ""	Reason why the action was executed. Default value is empty.

Return value

None

Errors

If the return code is 0 the error is OK. Error handling is not programmed.

Description

The function writeAuditBatchEntry is used to write information like batch id, action etc. (see parameters above) into the Audit trail panel.

Example

The function writes the batch ID 4, item (dpe) "prod_proc", action "Production process started" and the reason "Start the production process" into the audit Trail panel.

main()
{
  unsigned batchid = 4;
  string item = "prod_proc";
  string itemtype = "proc";
  string action = "Production process started";
  int error;
  string reason = "Start the production process";
  writeAuditBatchEntry(batchid,item,itemtype,action,error,reason);
  DebugN(batchid,item,itemtype,action,reason);
}

Assignment

User administration

Availability

CTRL