Event log aus dem Processing Monitor

Dieses Protokoll zeichnet Dokumentverarbeitungsereignisse und Fehler auf.

Nur Benutzer mit den Berechtigungen Mandantenadministrator (oder Systemadministrator im Fall des Standardmandanten) und Monitoring Operator können Event logs aus dem Processing Monitor herunterladen.

Verwenden Sie zum Herunterladen dieses Protokolls eine POST-Anfrage:

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

Anfrageparameter

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

Bei der Suche in Oracle Database wird zwischen Groß- und Kleinschreibung unterschieden.

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 werden. Weitere Informationen finden Sie unter Erstellen des Filterparameters.
`columnsOrder`	string	Kommagetrennte Liste der Spalten, die in den Bericht aufgenommen werden sollen: `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.
`projectId`	int	Projekte, die in das Protokoll aufgenommen werden sollen: `-1` für alle verfügbaren Projekte oder eine bestimmte Projekt-ID (`1` oder höher). Um alle verfügbaren Projekt-IDs abzurufen, verwenden Sie die Methode GetProjects.

Den `Filterparameter` erstellen

Der Filterparameter nimmt ein JSON-Objekt entgegen. Zum Beispiel:

{
  "GeneralOperator": "AND",
  "FilterItems": [
    {
      "PropertyKey": "Date",
      "PropertyOperator": "BETWEEN",
      "PropertyValues": [
        "2021-08-28",
        "00:00:00",
        "2023-09-28",
        "23:59:59"
      ]
    },
    {
      "PropertyKey": "Id",
      "PropertyOperator": ">=",
      "PropertyValues": ["127602430"]
    },
    {
      "PropertyKey": "BatchName",
      "PropertyOperator": "CONTAINS",
      "PropertyValues": ["default"]
    }
  ]
}

Die Werte für PropertyKey und PropertyOperator ermitteln

Öffnen Sie die Developer Tools des Browsers

Klicken Sie im Browsermenü auf Weitere 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 Processing 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 aus

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

Um Ereignisse für Standard-Batches zu filtern, geben Sie statt BatchTypeName den Parameter BatchTypeNameExt an:

"FilterItems": [
  {
    "PropertyKey": "BatchTypeNameExt",
    "PropertyOperator": "CONTAINS",
    "PropertyValues": ["Default"]
  }
]

Lassen Sie BatchTypeName für den Standard-Batch im Parameter columnsOrder unverändert.

Beispielskript

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

# Parameter
$server = "https://<server address>"
$tenant = "<tenant name>"
$user = "<user name>"
$password = "<password>"
#Pfad zum Ordner, in dem das Protokoll gespeichert wird
$folder = "C:\Temp\Logs\Stage"
$reportFileName = "Project_Events-{0:yyMMdd-HHmmss}.csv" -f (Get-Date)
# Protokollparameter
$requestBody =  @"
filter={
    "Name": "Complex filter",
    "GeneralOperator": "AND",
    "FilterItems": [
        {
            "PropertyKey": "Date",
            "PropertyOperator": "BETWEEN",
            "PropertyValues": ["2018-09-12","00:00:00","2023-10-12","23:59:59"]
        },
        {
            "PropertyKey": "Id",
            "PropertyOperator": ">=",
            "PropertyValues": ["127602430"]
        }
    ]
}
&columnsOrder=Id,Date,EventType,Comment,UserFullName,Workstation,BatchId,BatchName,BatchTypeName,StageFromName,StageToName,ProjectName,RoleName,TenantName
&sortColumnindex=0
&sortOrder=true
&projectId=-1
"@
#------------------------------------------------------------------------------
$methodUri = "/Project/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$tenant", "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

​Den Filterparameter erstellen

​Die Werte für PropertyKey und PropertyOperator ermitteln

​Beispielskript

Anfrageparameter

Den `Filterparameter` erstellen

Die Werte für PropertyKey und PropertyOperator ermitteln

Beispielskript