Differences

This shows you the differences between two versions of the page.

Link to this comparison view

control_startup_options_-_logactions [2019/01/27 11:29] (current)
Line 1: Line 1:
 + 
 +
 +
 +
 +Explanation ​
 +
 +
 +
 +When a user is having issues in Control, sometimes it is helpful to have a log of the actions executed by a users Control session.
 +
 +
 +
 +This is possible using the [[control:​startup_options|control:​startup_options]] called "​LogActions"​ or "​SaveActionsOnError"​. ​ Add one of these options to the Control shortcut of the user experiencing problems, in cases where you would like to log the actions of all users please add this option to the Control_Options.txt file instead.
 +
 +
 +
 +Example of Target Path on Shortcut: ​
 +  * "​C:​\Program Files\Cyrious\Control\Control.exe"​ -LogActions
 +  * "​C:​\Program Files\Cyrious\Control\Control.exe"​ -SaveActionsOnError
 +
 +
 +
 +Example of Option Inserted into Control_Options.txt file: 
 +  * LogActions1
 +  * SaveActionsOnError1
 +
 +
 +
 +Explanation of the option affects
 +
 +
 +
 +When enabling the LogActions option, a text file called "​Control_ActionLog##​.txt"​ will be created each time the user runs Control. ​ This will will show the last 250 actions executed by the user.
 +
 +
 +
 +When enabling the SaveActionsOnError option, a text file called "​Control_ActionLogOnError##​.txt"​ will be created each time the user encounters an error in Control. ​ This will will show the last 250 actions executed by the user at the time of the error.
 +
 +
 +
 +In each case the file will be located in the following folder:
 +
 +
 +
 +\Logs\\
 +
 +
 +
 +i.e. C:\Program Files\Cyrious\Control\Logs\JSmith\Control_ActionLog.txt ​
 +
 +
 +
 +or C:\Program Files\Cyrious\Control\Logs\JSmith\Control_ActionLogOnError.txt ​
 +
 +
 +
 +Troubleshooting
 +  * If you can not find a log file after enabling either option, ensure that you received a prompt notifying you that the option has been enabled when you launch Control. ​ You should see a window appear similar to the one below. ​ If you do not see this window you do not have the option properly added to the shortcut or Control_Options.txt file.
 +
 +
 +
 +{{::​actionlogmessage.jpg?​nolink&​|}}
 +
 +
 +
 +Log File Contents ​
 +
 +
 +
 +This is a tab delimited file, so it can be opened in Excel for easy viewing. It contains 7 columns of data.
 +
 +
 +
 +|| DateTime || The Date and Time the action was executed. ||
 +|| Class Name || The Delphi class name that the action was executed on. ||
 +|| ID || The ID of the object that the action was executed on. ||
 +|| Text || The text value of the object that the action was executed on. ||
 +|| ActionText || The text of the action being executed. ||
 +|| ActionID || The ID of the action being executed. ||
 +|| IsPrimary || If the action is executed directly by the user, IsPrimary is true. Otherwise, IsPrimary is false. ||
 +The log created from the SaveActionsOnError option will also contain the error that triggered the log to be created.
 +
 +**Note: When either option is turned on, the user will get a warning on startup.**
 +
 +
 +