My Logs

Refer to here for more information about Web Console edition.

My Logs

My Logs is a tool to view log of execution in DataSpiderServer. Logs can be searched when necessary by registering the log search condition.
The search criteria set by administrators or regular users will be displayed in the search criteria list.
Administrators can refer to all users' results, whereas regular users can refer to only their own results.
To launch My Logs, select it menu action in start menu.

Functions provided by My Logs

My Logs provide following functions

Description of Functions

Name of functions	Description	Remarks
List all search criteria	Lists all search criteria.Listed when My Logs starts.	Sorted by standard unicode character order.
Create new log search condition	Creates a new criteria used for searching log messages.
Execute Log Search	Find the executing history of the script that matches the registered log search condition.
Open Execution History	Start log viewer to view execution history.
Rename log search condition	Rename log search condition.
Edit log search condition	Edit registered log search condition.
Delete log search condition	Delete log search condition.
Download in text format	Download the execution history as a plain text file.

List all search criteria

Description of items

Item name	Description	Remarks
Name	The name of the search condition.
Date created	The date this search criteria was created on.
Date modified	The date this search criteria was last modified.

Create new log search condition

Log search condition can be created as follows:

Select [File]-[New search condition] menu action.
Select [File]-[Create Condition] menu action.

Description of items

Item name	Description	Remarks
Name	Enter a name for this search criteria.	See Restrictions on characters used in the names for the search criteria for the restrictions on the usage of characters in search condition names.
Filter by time	Select whether to set time as the search condition or not. [Checked]:(default) Limits the period or date/time. [Not Checked]: Does not limit the period or date/time
Period	Specify day, week, and month by which the search result should be filtered.	Enabled when [Filter by time] is checked. Defaults to 1 hour
Date and time	Specify year, month, day, hour, minute, and second by which the search result should be filtered.	Enabled when [Filter by time] is checked. Defaults to a time period between 0:00:00 of the current date and the current date time which is set when the dialog is opened.
Filter by execution result	Select whether to set the status of execution result should be included in the search criteria. [Checked]: The result of the execution is included. [Not Checked]:(default) The result of the execution is not included.
Succeeded	Select whether to include succeeded(when the exit status is 0) status in the search criteria. [Checked]:(default) The succeeded status is included in the search criteria. [Not Checked]: The succeeded status is not included in the search criteria.	Enabled when [Filter by execution result] is checked.
Failed	Select whether to include failed status(when the exit status does not equal to 0) in the search criteria. [Checked]:(default) The failed status is included in the search criteria. [Not Checked]: The failed status is not included in the search criteria.	Enabled when [Filter by execution result] is checked.
Specify end status	Select whether to specify the exit status in the search criteria. [Checked]: Specify an exit status of none 0 [Not Checked]:(default) Does not specify an exit status	Enabled when both [Filter by execution result] and [Failed] are checked.
Running	Select whether to include Running status should be included in the search criteria. [Checked]:(default) Running status is included. [Not Checked]: Running status is not included.	Enabled when [Filter by execution result] is checked.
Filter by execution user	Select whether to include the user who executed the script should be included in the search criteria. [Checked]: Select a user to be included in the search criteria. [Not Checked]: (default) User who executed the script is not included in the search criteria.
Filter by name of service or script	Select whether to include both the service name and the script name in the search criteria. [Checked]: Specify a service or a script name the search results are filtered against. [Not Checked]: (default) Do not specify any service or script name.
Service name	Specify a service name search results are filtered against.	Enabled when [Filter by name of service or script] is checked.
Script name	Specify a script name search results are filtered against.	Enabled when [Filter by name of service or script] is checked.
Filter by execution ID	Select whether to include Execution ID in the search criteria. [Checked]: Specify an execution ID in the search criteria. [Not Checked]:(default) Do not specify any execution ID.
Execution ID	Specify an execution ID to be include in the search criteria.	Enabled when [Filter by execution ID] is checked.

Execution Log search

To list the executing histories of the scripts that matched the criteria specified, perform the following procedure.

Select the search condition, and select [File]-[Execute log search] menu action.
In the left pane, select an criteria that the search results will be filtered against.

The list is displayed in descending order of the script start time.

Description of items

Item name	Description	Remarks
Service	Displays the name of the service	When executed from Designer, it will be displayed as <Executed from designer>.
Script	Displays the name of the script.
Execution ID	Displays the execution Id of the script/
Execution user	Displays who is running the script.
Type	Type used to run the script.
Start time	Displays the start of the script execution
End time	Displays the end of the script execution
Execution time(ms)	Displays the execution time in milliseconds.
Result	Displays the result of the script execution Succeeded (0): Represents that the script has been successfully executed. Failed (<exit status value>): The script execution has been terminated prematurely. Running: Represents script is running.

Open Execution History

To open execution history, select [File]-[Open execution history] from menu.
Log viewer is launched, and execution result is displayed.

Notes about Log viewer

Editing and Saving scripts cannot be performed on the My Logs.
When a script is executed on the Designer, displaying the execution result of the script cannot be performed on the My Logs.
When a script which does not output an XML log is executed, the "Unable to open execution history" dialog is displayed and the execution history of the script is not displayed.
When the specified log file is large, the "Open execution history" dialog is shown to specify the way to open it.
The threshold to show the "Open execution history" dialog can be modified in the system.properties. Refer to "Property Reference" for more details.

Rename log search condition

To rename log search condition, perform the following operations.

Select [File]-[Rename] menu action.
Select [File]-[Edit Condition] menu action.

See Restrictions on characters used in the names for the search criteria for the restrictions on the usage of characters in search condition names.

Edit log search condition

select the [File]-[Edit condition] menu action

Delete search condition

To delete search condition, perform the following operations.

Select the [File]-[Delete] menu item.
Select [File]-[Delete Condition] menu action.

Download in text format

To download the search results as a text file, select [File]-[Download in text form].
The name of the file downloaded locally will be in the form of <script name>_<execution ID>.log

If no XML log has been enabled and no files can be downloaded thusly, an error dialog will be prompted to the user.

For any details regarding the messages in the locally downloaded log files, see Logs downloaded in text format.

Specification limit

For the time used to search
- My Logs search will follow time of the client OS. Therefore, if the server OS time and client OS time are different, log search results may not appear on time.
- My Logs search will follow time of the server OS.
Search condition name character limitations
- Single-byte, double-byte alphanumeric characters and Japanese can be used.
- Other characters which are not allowed to use in DataSpider system files can not be used.
  For more information, please refer to "Restrictions on characters used in DataSpider File System".
Search conditions can only be referenced by the user who created them.