X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Windows Event Reader

The adapter reads the event log of Microsoft Windows and outputs all event entries or those selected according to filter criteria in an XML document.


Note:

The following conditions must be met in order to use this adapter:

  • The Windows computer from which the event log is to be read must be in the same domain as the X4 Server.

  • The X4 Server must be running on a Windows computer that has domain administrator rights.

  • A JNI licence is required.


Properties

Operation

Determines which operation the adapter executes

Possible values: Execute: Execute adapter

Parameter

Adapter

Main class of the adapter (do not change!)

Possible values: en.softproject.integration.adapter. windowseventlog.WindowsEventLogAdapter: Main class (default)

log

Windows log/log whose events are to be displayed

Possible values:

  • Any Windows protocol/log (e.g. Application)

  • System: Output system events (default)

from

Start date to restrict to a time period

Possible values: Any date and time in the format YYYY-MM-DDThh:mm:ss (e.g. 2012-03-31T13:45:03)

to

End date to limit to a period

Possible values: Any date and time in the format YYYY-MM-DDThh:mm:ss (e.g. 2012-03-31T13:45:03)

type

Filter by an event type (level)

Possible values: Any event type (e.g. Error)

source

Filter by an event source (this can be an application, for example)

Possible values: Any string (e.g. PrintSpooler)

category

Filter by event category

Possible values: Any character string

eventId

Filter by an Event ID

Possible values: Any integer

user

Filter by a user

Possible values: Any string (e.g. SYSTEM)

computer

Name of the computer from which the event log is to be read

Possible values:

  • Any computer name or IP address

  • 127.0.0.1: Currently used system, i.e. localhost (default)

Status values


1

The operation was executed successfully.

-1

The operation failed due to a technical error.

Output

This function adapter outputs a UTF-8 encoded XML document with the following structure. For each event, an XML element <log/> is created that contains a set of information as well as the event description for the event:

<logs>
    <log type="Ereignistyp" date="Datum und Uhrzeit"
        source="Quelle" category="Kategorie" event="Ereignis-ID" user="Benutzer"
        computer="Computername">Ereignis-Beschreibung</log>
</logs>