Event log aus System Monitor - ABBYY Documentation

Dieses Protokoll erfasst alle Ereignisse und Fehler in ABBYY FlexiCapture, z. B. An- und Abmeldeereignisse von System Administratoren sowie das Starten und Stoppen des Application Server und von Processing Stations. Es enthält keine Ereignisse, die in Mandanten aufgetreten sind.

Nur Benutzer mit den Berechtigungen eines System Administrator können Event logs aus System Monitor herunterladen. Ein System Administrator ist der Administrator eines Standardmandanten.

Verwenden Sie zum Herunterladen dieses Protokolls eine POST-Anfrage:

POST https://<server address>/FlexiCapture12/Monitoring/Tenant/GetEventsCSV

Anfrageparameter

Alle Parameter sind erforderlich. Stellen Sie sicher, dass sie korrekt angegeben werden.

Die Suche in Oracle Database unterscheidet zwischen Groß- und Kleinschreibung.

Parameter	Typ	Beschreibung
`filter`	string	Filterbedingungen für das Protokoll. Kombinieren Sie Bedingungen ausschließlich mit den Operatoren `AND` und `OR`, die im Parameter `GeneralOperator` festgelegt sind. Weitere Informationen finden Sie unter Erstellen des Filterparameters.
`columnsOrder`	string	Kommagetrennte Liste der Spalten, die in den Bericht aufgenommen werden: `ID`, `Date`, `EventType`, `Comment`, `UserFullName`, `Workstation`, `BatchId`, `BatchName`, `BatchTypeName`, `StageFromName`, `StageToName`, `ProjectName`, `RoleName`, `TenantName`.
`sortColumnindex`	int	Index der Spalte, die zum Sortieren der Datensätze im Protokoll verwendet wird.
`sortOrder`	bool	Sortierreihenfolge: `true` sortiert in absteigender Reihenfolge, `false` in aufsteigender Reihenfolge.
`tenantId`	int	Mandanten, die in das Protokoll aufgenommen werden sollen: `-1` für alle verfügbaren Mandanten, `0` für den Standardmandanten oder eine bestimmte Mandanten-ID (`1` oder höher).

Filterparameter erstellen

Der Parameter filter erwartet ein JSON-Objekt. Zum Beispiel:

{
  "GeneralOperator": "AND",
  "FilterItems": [
    {
      "PropertyKey": "Date",
      "PropertyOperator": "BETWEEN",
      "PropertyValues": [
        "2022-09-12",
        "00:00:00",
        "2023-10-12",
        "23:59:59"
      ]
    }
  ]
}

Werte für PropertyKey und PropertyOperator ermitteln

Öffnen Sie die Entwicklertools des Browsers

Klicken Sie im Browsermenü auf More tools → Developer tools und wechseln Sie zur Registerkarte Network.

Erstellen Sie einen Filter in der Konsole

Starten Sie die Administration and Monitoring Console, wechseln Sie zu System Monitor → Event log und klicken Sie auf die Schaltfläche

Wenden Sie die Filterkriterien an

Geben Sie die Filterkriterien an und klicken Sie auf Apply.

Lesen Sie die Filterparameter ab

Klicken Sie auf die Anfrage GetFilteredEvents. Die Filterparameter sind auf der Registerkarte Payload aufgeführt.

Um Ereignisse für den Standardmandanten zu filtern, geben Sie statt TenantName den Parameter TenantNameExt an:

"FilterItems": [
  {
    "PropertyKey": "TenantNameExt",
    "PropertyOperator": "=",
    "PropertyValues": ["Default tenant"]
  }
]

Behalten Sie für den Standardmandanten im Parameter columnsOrder den Wert TenantName bei.

Beispielskript

Das folgende PowerShell-Skript lädt das Ereignisprotokoll herunter. Ersetzen Sie die Serveradresse und Ihre Zugangsdaten durch Ihre eigenen.

#------------------------------------------------------------------------------
# parameters
$server = "https://<server address>"
$user = "<user name>"
$password = "<password>"
# Pfad zum Ordner, in dem das Protokoll gespeichert wird
$folder = "C:\Temp\Logs\Stage"
$reportFileName = "Tenant_Events-{0:yyMMdd-HHmmss}.csv" -f (Get-Date)
# Protokollparameter
$requestBody =  @"
filter={
    "Name": "Filter Name",
    "GeneralOperator": "AND",
    "FilterItems": [
        {
            "PropertyKey": "Date",
            "PropertyOperator": "BETWEEN",
            "PropertyValues": [
                "2022-09-12",
                "00:00:00",
                "2023-10-12",
                "23:59:59"
            ]
        }
    ]
}
&columnsOrder=Id,Date,EventType,Comment,UserFullName,Workstation,BatchId,BatchName,BatchTypeName,StageFromName,StageToName,ProjectName,RoleName,TenantName,
&sortColumnindex=0
&sortOrder=true
&tenantId=0
"@
#------------------------------------------------------------------------------
$tenant = "" # Nur Standard-Mandant
$methodUri = "/Tenant/GetEventsCSV"
$authServer = $server
$ServerSitePath = "/FlexiCapture12/Monitoring"

function Write-Line($str, $color = "White")
{
    Write-Host $str -ForegroundColor $color
}

function Join-Uri
{
    param([Parameter(Mandatory, ValueFromPipeline)] [string]$parent, [string]$child)
    if ($parent -eq "") {return $child;}
    if ($child -eq ""){return $parent}
    if ($parent.endswith("/") -or $parent.endswith("\\")) {$parent = $parent.substring(0,$parent.Length-1)}
    if ($child.startswith("/") -or $child.startswith("\\")) {$child = $child.substring(1,$child.Length-1)}
    return "$parent/$child"
}

function Get-AuthTicket($server, $user, $password, $tenant)
{
    $tenantSuffix=""
    if ($tenant -ne ''){ $tenantSuffix = "?tenant=$tenant"}
    $URL = Join-Uri $authServer "/FlexiCapture12/Server/FCAuth/API/Soap$tenantSuffix"
    $SOAPRequest = '<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><FindUser xmlns="urn:http://www.abbyy.com/FlexiCapture"><userLogin>user</userLogin></FindUser></soap:Body></soap:Envelope>'
    $Headers = @{
        'SOAPAction' = '"#FindUser"'
        'Content-Type' = 'text/xml; charset=utf-8'
        'Authorization' = "Basic $([System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes("$($user):$($password)")))"
    }
    try
    {
        $response1 = Invoke-WebRequest -Uri $URL -Headers $Headers -Body $SOAPRequest -Method 'POST'
        return $response1.Headers['AuthTicket']
    }
    catch{
        Write-Line -str "Couldn't get 'AuthTicket': $_" -color "Red"
        return ""
    }
}

function Download-CSVReport($server, $tenant, $authTicket, $methodUri, $requestBody, $folder, $reportFileName)
{
    $reportFullFilePath = Join-Path $folder $reportFileName
    #Ordner automatisch erstellen (falls nicht vorhanden)
    New-Item -ItemType Directory -Force -Path $folder | Out-Null
    if ($authTicket -eq "" -or $authTicket -eq $null)
    {
        Write-Line -str "Couldn't get 'CSV-Report'" -color "Red"
    }
    else
    {
        $header = @{ "Accept" = "*/*"}
        $session = [Microsoft.PowerShell.Commands.WebRequestSession]::new()
        $session.Cookies.Add($server, [System.NET.Cookie]::new('FlexiCaptureTmpPrn', "Ticket=$authTicket"))
        $tenantInUrl=""
        if ($tenant -ne '') { $tenantInUrl = "/$tenant"}
        $uri = Join-Uri $server $ServerSitePath | Join-Uri -child $tenantInUrl | Join-Uri -child $methodUri
        try{
            $response = Invoke-WebRequest -Uri $uri -Method 'POST' -Headers $header -WebSession $session -Body $requestBody -OutFile $reportFullFilePath -MaximumRedirection 0 -ErrorAction Ignore -PassThru
            if ($response.StatusCode -lt 300)
            {
                Write-Line "CSV-Report done: $reportFullFilePath" "Green"
            }
            else
            {
                Write-Line -str "HttpStatus $($response.StatusCode) in getting CSV-Report." -color "Red"
            }
        }
        catch{
            Write-Line -str "Couldn't get CSV-Report: $_" -color "Red"
            return ""
        }
    }
}

$authTicket = Get-AuthTicket -server $server -user $user -password $password -tenant $tenant
Download-CSVReport -server $server -tenant $tenant -authTicket $authTicket -methodUri $methodUri -requestBody $requestBody -folder $folder -reportFileName $reportFileName

​Anfrageparameter

​Filterparameter erstellen

​Werte für PropertyKey und PropertyOperator ermitteln

​Beispielskript

Anfrageparameter

Filterparameter erstellen

Werte für PropertyKey und PropertyOperator ermitteln

Beispielskript