Functional Specification
Output log information of Systemwalker Desktop Keeper managed by database as a CSV file. The user can output all log types or just the specified log type.
The log information that can be output is as follows.
No. (Log Type) | Backup Target Log | Output File Name |
|---|---|---|
1 | Application Startup Log | Application startup log.csv |
2 | Application Termination Log | Application termination log.csv |
3 | Application Startup Prohibition Log | Application startup prohibition log.csv |
4 | Window Title Obtaining Log | Window title obtaining log.csv |
5 | E-mail Sending Log | E-mail sending log.csv |
6 | Command Operation Log | Command operation log.csv |
7 | Device Configuration Change Log | Device configuration change log.csv |
8 | Printing Operation Log | Printing operation log.csv |
9 | Printing Prohibition Log | Printing prohibition log.csv |
10 | Logon Prohibition Log | Logon prohibition log.csv |
11 | File Export Log | File export log.csv |
12 | PrintScreen Key Prohibition Log | PrintScreen key prohibition log.csv |
13 | File Operation Log | File operation log.csv |
14 | Logon/Logoff Log | Logon,Logoff log.csv |
16 | E-mail Attachment Prohibition Log | E-mail attachment prohibition log.csv |
17 | Window Title (with URL) Obtaining Log | Window title (with URL) obtaining log.csv |
24 | FTP Operation Prohibition Log | FTP operation prohibition log.csv |
25 | FTP Operation Log | FTP operation log.csv |
29 | Web Operation Prohibition Log | Web operation prohibition log.csv |
31 | Web Operation Log | Web operation log.csv |
34 | E-mail Sending Interruption Log | E-mail sending interruption log.csv |
37 | Clipboard Operation Log | Clipboard operation log.csv |
38 | Clipboard Operation Prohibition Log | Clipboard operation prohibition log.csv |
60 | E-mail Receiving Log | E-mail receiving log.csv |
61 | Environment Change Log | Environment change log.csv |
90 | Linkage Application Log | Linkage application log.csv |
106 | Phone Outgoing and Incoming Call Log | Phone Outgoing and Incoming Call Log.csv |
107 | Application Configuration Change Log | Application Configuration Change Log.csv |
Rows in the CSV file will be separeated by newline charactters (CR+LF), with each row contains the fields enclosed by double quotation marks and separated by comma.
The above-mentioned output filenames are examples. When specifying the log type in the <LogKind>, any output file name can be set. When "ALL" is specified in the <LogKind>, the above-mentioned output file names are output for each log type.
Command Format
Execute according to the following format in the command prompt.
DTKLG1T.EXE DTKDB <User> <Password> <StartDate> <EndDate> <LogKind> <OutFile> [SERVER] [-Y|-y]
or
DTKLG1T.EXE DTKDB <User> <Password> <StartDate> <EndDate> ALL <OutDir> [SERVER] [-Y|-y]
Option
Fixed value.
Enter the logon ID registered in Server Settings Tool (The access authority is the logon ID of "Backup/Restore").
Enter the password of the above logon ID.
Enter the start day for data processing (8 digits). The range of value is "20010000" - "20349999" and "00000000". When the value of last 4 digits of "20010000" - "20349999" do not exist in the calendar, the following date will be specified.
When the last 4 digits are specified to "0000"
Jan. 1 of the specified year will be the start date.
When the last 4 digits are specified to "1232" - "9999"
Jan. 1 of the next year of the specified year will be start date.
When the last 2 digits are specified to "00"
1st of the specified month will be the start date.
When the last 2 digits are specified to "second day after the end of month" - "99"
1st of the next month of the specified month will be the start date.
In addition, when "00000000" is entered, the start date will be determined as the time when data started to be accumulated in database.
Enter the end date for data processing (8 digits). The range of value is "20010000" - "20349999" that is larger than the value of <StartDate>. When the value of last 4 digits of "20010000" - "20349999" do not exist in the calendar, the following date will be specified.
When the last 4 digits are specified to "0000"
Dec. 31 of the year previous to the specified year will be the end date.
When the last 4 digits are specified to "1232" - "9999"
Dec. 31 of the specified year will be the end date.
When the last 2 digits are specified to "00"
The last date of the last month of specified month will be the end date.
When the last 2 digits are specified to "second day after the end of month" - "99"
The last date of the specified month will be the end date.
When outputting a log type, specify the No. of the log to be output. The number is the same as the No. in the above table. (You can specify only one number.)
To output all log types in batch, specify "ALL". Specify halfwidth uppercase or lowercase characters.
When a log type is specified in the <LogKind>, specify the name of the file to be saved as <OutFile> with an absolute path. The folder should be created in advance.
When "ALL" is specified, enter the file of saving target as <OutDir> with an absolute path. The folder should be created in advance.
When specifying "SERVER" (Halfwidth character), processing is performed based on the date when log information is saved in the Management Server/Master Management Server. If "SERVER" is omitted, processing will be performed by taking the date specified in <StartDate> and <EndDate> as condition, based on the date when log information is collected on client.
If "-Y" or "-y" is specified, the additional information (computer name, CTID, IP address, MAC address, image data information) will be output (V13.0.0 - V15.1.3 compatible format).
If "-Y" or "-y" is omitted, the additional information will not be output.
In the command option, an option that contains a space, cannot be specified.
When specifying an option, data enclosed with double quotations cannot be specified.
In particular, pay attention when entering the file name of <OutFile> and <OutDir>.
When "ALL" is specified in the <LogKind>, multiple log files are created under the specified folder. Log files are created with the respective names given in the "Output file name" column in the table above.
Return Value
Ended normally
Ended abnormally
Location for Saving Commands
Installation folder of database related files\BackupCommand\DTKLG1T.EXE
Authority Required for Execution/Execution Environment
Execute with a user that belongs to the Administrators group of the local computer or a user that belongs to the Domain Admins group of the domain.
Execute on the Management Server/Master Management Server.
Note
The command execution result will be output to the command prompt. If you need to save the execution result, specify the file for outputting execution result through redirection when executing this command.
When the file with same name as the output file in the folder, replace it by force. Confirmation message will not be displayed.
For command operation log, the index information saved in COMMONLOG2 will be output as a CSV file. In addition, the folder named "PromptLog" will be created under the output target path of <OutFile>, and the text file in which the content of command log is saved will be output to this folder.
The image file of screen hard copy captured at the client (CT) by the screen capture function will be saved to the Management Server/Master Management Server that is connected with the client (CT). In database, only the index information to the image file will be saved to the "COMMONLOG2" table. Backup and deletion processes can only process index information, and image file will not be processed.
The original file backup file in the File Export Utility is saved on the Management Server/Master Management Server connected with the client (CT). In database, only the index information to the original file will be saved in the "FILEBRINGOUTLOG" table. Backup and deletion processes can only process index information, and original file will not be processed.
The E-mail content file backed up during E-mail sending is saved on the Management Server/Master Management Server connected with the client (CT). In database, only the index information to the E-mail content file will be saved in the "COMMONLOG1" table. Backup and deletion processes can only process index information, and E-mail content file will not be processed.
When "ALL" is specified in the <LogKind>, all log types are output. To select and output multiple log types in batch, use "1.12 DTKLGAT.BAT (Collective Output of Referrer Logs)".
When executing this command in Windows Server 2008, Windows Server 2012, or Windows Server 2016, it is necessary to open the command prompt with "Run as Administrator".
Example of Use/Execution Results/Output Format
C:\Program Files\Fujitsu\Systemwalker Desktop Keeper\DB\BackupCommand>DTKLG1T.exe DTKDB User Password 20010000 20349999 1 C:\DTKBKUP\Application Startup Log.csv 2009/06/08 16:44:23 Backup log information of Log Viewer format - Start 2009/06/08 16:44:23 2009/06/08 16:44:23 Database : DTKDB 2009/06/08 16:44:23 Processing start date : 20010000 2009/06/08 16:44:23 Processing finish Date : 20349999 2009/06/08 16:44:23 Log type : 1 2009/06/08 16:44:23 Output File : C:\DTKBKUP\Application Startup Log.csv 2009/06/08 16:44:23 Extraction key : 2009/06/08 16:44:23 Additional information: 2009/06/08 16:44:23 2009/06/08 16:44:23 - Application startup log 2009/06/08 16:44:24 Output file name : C:\DTKBKUP\Application Startup Log.csv 2009/06/08 16:44:24 Number of output items......1,016 2009/06/08 16:44:24 2009/06/08 16:44:24 Backup log information of Log Viewer format - End 2009/06/08 16:44:24
The items output to the CSV file is shown as follows.
Item Name | Description |
|---|---|
[Name] (*1) | Name of the client (CT). The initial value is computer name. |
[Occurrence Date and Time] | Date and time when logs are collected. |
[Logon User ID] | User name entered during logon to the client (CT). |
[Domain Name] | At domain logon, it is the domain name of the client (CT). At logon to local computer, it is the computer name of the client (CT). However, it will be blank in the case of Windows 98andWindows ME. |
[Name of Log Category] | Category (type) of log. |
[Regular/Violation Classification] | Operations that are approved in policy setting is [regular], and the operations not approved are [Violation]. |
[Existence of Image Data] | Number of window obtained when screen capture is performed. It can be 1, 2 or blank (not to obtain). |
[Content] | Content of log. |
[Notes] | Notes of log. |
[Computer Name] (*1)(*2) | Computer name of the client (CT). |
[CTID] (*2) | Number assigned automatically in order for Management Server/Master Management Server to identify the client (CT). |
[IP Address] (*1)(*2) | IP address of the client (CT). |
[MAC Address] (*1)(*2) | MAC address of the client (CT). |
[Image Data Information] (*2) | When screen capture data exists in the window title obtaining log, the "LOGLEVEL" item of COMMONLOG2 table will be output. The format is "AAAAAA-B", in which AAAAAA can be any digit, and B can be 1 or 2. 1 is to obtain the image of screen capture for one time, and 2 means to obtain for the second time after 5 seconds. |
*1: Information from when the command is executed, not when retrieving the log.
*2: Output if the "-Y" or "-y" option is specified.
