Difference between revisions of "Activity:WriteLogEntry (Activity)"
(→Usage) |
|||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | The WriteLogEntry Activity writes a log message to the {{UBIK}} logging mechanism. | ||
| + | |||
| + | = Description = | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| title = Write Log Entry | | title = Write Log Entry | ||
| Line 9: | Line 12: | ||
| version = 2.3+ | | version = 2.3+ | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ===Arguments=== | ||
{| class="wikitable sortable" | width = "50%" | {| class="wikitable sortable" | width = "50%" | ||
|- | |- | ||
! 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|| | + | | LogId|| {{Int32_MSDN}} || In || A user defined id to use for this log entry |
|- align="left" | |- align="left" | ||
| − | | Text || | + | | Text || {{String_MSDN}} || In || The message text to be written in the log entry |
|- align="left" | |- align="left" | ||
| − | | Title || | + | | Title || {{String_MSDN}} || In || The title of the log entry |
|- align="left" | |- align="left" | ||
| − | | Result|| | + | | Result|| {{Boolean_MSDN}} || 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 [[Web_Service_Configuration| Web Service Configuration]] in section [[Web_Service_Configuration_Example#loggingConfiguration|loggingConfiguration]]. For configuring the logging in UBIK.Studio, the section [[Web_Service_Configuration_Example#loggingConfiguration|loggingConfiguration]] also exists in the Application Config file. |
{{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!}} | ||
| − | + | =Example= | |
| − | + | ||
Output the number of MetaClasses that derive (direct and indirect) from the MetaClass of a given object: | Output the number of MetaClasses that derive (direct and indirect) from the MetaClass of a given object: | ||
| − | |||
{| class="wikitable" | width = "50%" | {| class="wikitable" | width = "50%" | ||
| Line 49: | Line 45: | ||
| Text || <source lang = "vbnet">UBIKObject.MetaClass.AllDerivates.Count.ToString()</source> | | Text || <source lang = "vbnet">UBIKObject.MetaClass.AllDerivates.Count.ToString()</source> | ||
|} | |} | ||
| + | |||
| + | {{Activity/End}} | ||
==See also== | ==See also== | ||
* [[Workflow Designer]] | * [[Workflow Designer]] | ||
| − | + | [[Category:Activities]] | |
Latest revision as of 10:22, 19 March 2015
The WriteLogEntry Activity writes a log message to the UBIK® logging mechanism.
[edit]
Description
| Write Log Entry | |
|---|---|
| Name | WriteLogEntry |
| Purpose | Write a log entry via the UBIK® logging mechanism |
| Category | Logging |
| Returns | True if successful |
| Version | 2.3+ |
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 | 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 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 Web Service Configuration in section loggingConfiguration. For configuring the logging in UBIK.Studio, the section loggingConfiguration also exists in the Application Config file.
 | 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() |
