Difference between revisions of "Extensions.Logging.WriteLog"

From emotive
Jump to navigation Jump to search
Line 14: Line 14:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Level | [[Extensions.Logging.SeverityLevel|SeverityLevel]] | [[Term]] | - | [1] | This element represents the severity-level of the log-message, see [[Extensions.Logging|Logging]].}}
+
{{TableRowPropertie2| Level | [[Extensions.Logging.SeverityLevel|SeverityLevel]] | [[Term]] | - | [1] | This element represents the severity-level of the log-message, see [[Extensions.Logging|Logging]].}}
{{TableRowPropertie2| Target | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [0..1] | The optional element shall be used for locating the resource to which the message shall be written. The target should be defined by a URI}}
+
{{TableRowPropertie1| Target | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [0..1] | The optional element shall be used for locating the resource to which the message shall be written. The target should be defined by a URI}}
{{TableRowPropertie1| Message | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This string value represents the log-message}}
+
{{TableRowPropertie2| Message | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This string value represents the log-message}}
 
|}
 
|}
  

Revision as of 08:30, 1 October 2018

Classification

Name WriteLog
Short Description Writing a log message
Class Action
Extension OTX Logging extension
Group Logging related actions
Exceptions InvalidReferenceException
Checker Rules -
Standard Compliant Yes

OTL Syntax

Logging.WriteLog(SeverityLevelTerm, StringTerm, StringTerm);

Description

The WriteLog activity shall cause the OTX runtime system to write a log-message into a logging-resource provided that the severity-level of that message is higher or equal than the currently set log-level threshold. The particular logging-resource to which the log-message shall be written may be identified by the optional <target> element. Otherwise (if no explicit target is given), the location of the logging-resource depends on the specific runtime system settings. See Logging.

Properties

Name Data Type Class Default Cardinality Description
Level SeverityLevel Term - [1] This element represents the severity-level of the log-message, see Logging.
Target String Term - [0..1] The optional element shall be used for locating the resource to which the message shall be written. The target should be defined by a URI
Message String Term - [1] This string value represents the log-message

OTL Examples

Logging.WriteLog(@SeverityLevel:TRACE, NULL, "Message");

See also

SetLogLevel