Difference between revisions of "Extensions.Logging.WriteLog"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:'''WriteLog '''}}[[Category:Logging]] | {{DISPLAYTITLE:'''WriteLog '''}}[[Category:Logging]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | WriteLog | Writing a log message | [[Action]] | [[Extensions.Logging|OTX Logging extension]] | [[Logging related actions]] | [[Core. | + | {{ClassificationActivity | WriteLog | Writing a log message | [[Action]] | [[Extensions.Logging|OTX Logging extension]] | [[Logging related actions]] | [[Core.DataTypes.ComplexDataType.InvalidReferenceException|InvalidReferenceException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Logging.WriteLog( | + | Logging.WriteLog(SeverityLevelTerm, StringTerm, StringTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == 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 [[Extensions.Logging|Logging]]. | |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Level | [[Extensions.Logging.SeverityLevel|SeverityLevel]] | [[ | + | {{TableRowPropertie1| Level | [[Extensions.Logging.SeverityLevel|SeverityLevel]] | [[Term]] | @SeverityLevel:TRACE | [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] | | + | {{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| Message | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [ | + | {{TableRowPropertie1| Message | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | This string value represents the log-message}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Logging.WriteLog(@ | + | Logging.WriteLog(@SeverityLevel:TRACE, NULL, "Message"); |
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
[[Extensions.Logging.SetLogLevel|SetLogLevel]] | [[Extensions.Logging.SetLogLevel|SetLogLevel]] | ||
Revision as of 04:55, 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 | @SeverityLevel:TRACE | [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");