Difference between revisions of "Activity:WriteLogEntry (Activity)"
(Created page with "{{ActivityInfoBox | title = Write Log Entry | name = WriteLogEntry | image = | imagecaption = Activity WriteLogEntry | purpose = Write a log entry via the {{UBIK}} logging me...") |
(→Usage) |
||
| Line 32: | Line 32: | ||
==Usage== | ==Usage== | ||
| − | |||
This activity is typically used to write informations to a log file to document certain events like failures together with object properties etc. during the execution of a workflow. | This activity is typically used to write informations to a log file to document certain events like failures together with object properties etc. during the execution of a workflow. | ||
Revision as of 13:25, 24 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 | A UBIK object |
| LogId | Integer | In | A user defined id to use for this log entry |
| Text | String | In | The message text to be written in the log entry |
| Title | String | 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 informations to a log file to document certain events like failures together with object properties etc. during the execution of a workflow.
 | 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() |
