Event log from System Monitor - ABBYY Documentation

This log records all events and errors in ABBYY FlexiCapture, such as System Administrator log in and log out events and the starting and stopping of the Application Server and processing stations. It does not include events that occurred in tenants.

Only users with System Administrator permissions can download event logs from System Monitor. A System Administrator is the Administrator of a default tenant.

To download this log, use a POST request:

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

Request parameters

All parameters are required. Make sure that they are specified correctly.

The search in Oracle Database is case-sensitive.

Parameter	Type	Description
`filter`	string	Filter conditions for the log. Combine conditions with the `AND` and `OR` operators only, set in the `GeneralOperator` parameter. For more information, see Build the filter parameter.
`columnsOrder`	string	Comma-separated list of columns to include in the report: `ID`, `Date`, `EventType`, `Comment`, `UserFullName`, `Workstation`, `BatchId`, `BatchName`, `BatchTypeName`, `StageFromName`, `StageToName`, `ProjectName`, `RoleName`, `TenantName`.
`sortColumnindex`	int	Index of the column used to sort the records in the log.
`sortOrder`	bool	Sort order: `true` sorts in descending order, `false` sorts in ascending order.
`tenantId`	int	Tenants to include in the log: `-1` for all available tenants, `0` for the default tenant, or a specific tenant ID (`1` or greater).

Build the filter parameter

The filter parameter takes a JSON object. For example:

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

Find the PropertyKey and PropertyOperator values

Open the browser developer tools

In the browser menu, click More tools → Developer tools, and go to the Network tab.

Create a filter in the console

Launch the Administration and Monitoring Console, go to System Monitor → Event log, and click the

button.

Apply the filter criteria

Specify the filtering criteria and click Apply.

Read the filter parameters

Click the GetFilteredEvents request. The filtering parameters are listed on the Payload tab.

To filter events for the default tenant, specify the TenantNameExt parameter instead of TenantName:

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

Keep TenantName for the default tenant in the columnsOrder parameter.

Example script

The following PowerShell script downloads the event log. Replace the server address and credentials with your own.

#------------------------------------------------------------------------------
# parameters
$server = "https://<server address>"
$user = "<user name>"
$password = "<password>"
# path to folder where the log will be saved
$folder = "C:\Temp\Logs\Stage"
$reportFileName = "Tenant_Events-{0:yyMMdd-HHmmss}.csv" -f (Get-Date)
# log parameters
$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 = "" # Only default tenant
$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
    #create folder silent (if not exist)
    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

​Request parameters

​Build the filter parameter

​Find the PropertyKey and PropertyOperator values

​Example script

Request parameters

Build the filter parameter

Find the PropertyKey and PropertyOperator values

Example script