Difference between revisions of "Activity:WriteLogEntry (Activity)"
m (moved WriteLogEntry(Activity) to WriteLogEntry (Activity)) |
|||
| Line 10: | Line 10: | ||
}} | }} | ||
The WriteLogEntry Activity writes a log message to the {{UBIK}} logging mechanism. | The WriteLogEntry Activity writes a log message to the {{UBIK}} logging mechanism. | ||
| − | |||
| − | |||
| − | |||
==Arguments== | ==Arguments== | ||
| Line 20: | Line 17: | ||
! Argument!! Type !! Direction !! Purpose | ! Argument!! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | UBIKObject|| BaseClass || In || | + | | UBIKObject|| BaseClass || In || An {{UBIK}} object |
|- align="left" | |- align="left" | ||
| − | | LogId|| Integer || In || A user defined id to use for this log entry | + | | LogId|| {{Integer}} || In || A user defined id to use for this log entry |
|- align="left" | |- align="left" | ||
| − | | Text || | + | | Text || {{Text}} || In || The message text to be written in the log entry |
|- align="left" | |- align="left" | ||
| − | | Title || | + | | Title || {{Text}} || In || The title of the log entry |
|- align="left" | |- align="left" | ||
| − | | Result|| Boolean || Out || Returns True on success, false on error | + | | Result|| {{Boolean}} || Out || Returns True on success, false on error |
|} | |} | ||
==Usage== | ==Usage== | ||
| − | This activity is typically used to write | + | This activity is typically used to write information into a log file to document certain events like failures together with object properties etc. during the execution of a workflow. The location for this logfile can be configured by the user by editing the Application Configuration for logging in UBIK.Studio or the [[UBIK_Web_Service_Configuration| Web Service Configuration]]. |
{{Hint|Once your workflow runs smoothly, consider removing frequently appearing log entries you needed during the design phase. Please be aware that the intense use of log output needs system resources and can generate confusing amounts of information!}} | {{Hint|Once your workflow runs smoothly, consider removing frequently appearing log entries you needed during the design phase. Please be aware that the intense use of log output needs system resources and can generate confusing amounts of information!}} | ||
Revision as of 10:00, 25 March 2014
| Write Log Entry | |
|---|---|
| Name | WriteLogEntry |
| Purpose | Write a log entry via the UBIK® logging mechanism |
| Category | Logging |
| Returns | True if successful |
| Version | 2.3+ |
The WriteLogEntry Activity writes a log message to the UBIK® logging mechanism.
Contents
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| UBIKObject | BaseClass | In | An UBIK® object |
| LogId | Integer | In | A user defined id to use for this log entry |
| Text | Text | In | The message text to be written in the log entry |
| Title | Text | In | The title of the log entry |
| Result | Boolean | Out | Returns True on success, false on error |
Usage
This activity is typically used to write information into a log file to document certain events like failures together with object properties etc. during the execution of a workflow. The location for this logfile can be configured by the user by editing the Application Configuration for logging in UBIK.Studio or the Web Service Configuration.
 | Once your workflow runs smoothly, consider removing frequently appearing log entries you needed during the design phase. Please be aware that the intense use of log output needs system resources and can generate confusing amounts of information! |
Example
Output the number of MetaClasses that derive (direct and indirect) from the MetaClass of a given object:
| Argument | Value |
|---|---|
| UBIKObject | Connect this argument with a variable |
| Text | UBIKObject.MetaClass.AllDerivates.Count.ToString() |
