Registro de eventos de System Monitor

Descargue el registro de eventos de System Monitor de ABBYY FlexiCapture en formato CSV mediante la solicitud POST GetEventsCSV, con parámetros de filtro, columna, ordenación y tenant.

Este registro registra todos los eventos y errores de ABBYY FlexiCapture, como los eventos de inicio y cierre de sesión del Administrador del sistema y el inicio y la detención del Servidor de aplicaciones y de las estaciones de procesamiento. No incluye los eventos que se produjeron en tenants.

Solo los usuarios con permisos de Administrador del sistema pueden descargar registros de eventos desde System Monitor. Un Administrador del sistema es el Administrador de un tenant predeterminado.

Para descargar este registro, use una solicitud POST:

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

​

Parámetros de la solicitud

Todos los parámetros son obligatorios. Asegúrese de especificarlos correctamente.

La búsqueda en Oracle Database distingue entre mayúsculas y minúsculas.

Parámetro	Tipo	Descripción
filter	cadena	Condiciones de filtro para el registro. Combine las condiciones únicamente con los operadores AND y OR, establecidos en el parámetro GeneralOperator. Para obtener más información, consulte Crear el parámetro filter.
columnsOrder	cadena	Lista de columnas separadas por comas que se incluirán en el informe: ID, Date, EventType, Comment, UserFullName, Workstation, BatchId, BatchName, BatchTypeName, StageFromName, StageToName, ProjectName, RoleName, TenantName.
sortColumnindex	int	Index de la columna utilizada para ordenar las entradas del registro.
sortOrder	bool	Orden de clasificación: true ordena en orden descendente y false, en orden ascendente.
tenantId	int	Tenants que se incluirán en el registro: -1 para todos los tenants disponibles, 0 para el tenant predeterminado o un ID del tenant específico (1 o superior).

​

Defina el parámetro filter

El parámetro filter acepta un objeto JSON. Por ejemplo:

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

Para encontrar los valores de los parámetros PropertyKey y PropertyOperator, cree un filtro en la Consola de administración y supervisión:

1. Abra Developer Tools del navegador

   En el menú del navegador, haga clic en Más herramientas → Developer Tools y vaya a la pestaña Red.

2. Cree un filtro en la consola

   Inicie la Consola de administración y supervisión, vaya a System Monitor → Registro de eventos y haga clic en el botón .

3. Aplique los criterios del filtro

   Especifique los criterios de filtrado y haga clic en Apply.

4. Consulte los parámetros del filtro

   Haga clic en la solicitud GetFilteredEvents. Los parámetros de filtrado se muestran en la pestaña Payload.

Para filtrar eventos del tenant predeterminado, especifique el parámetro TenantNameExt en lugar de TenantName:

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

Mantén TenantName para el tenant predeterminado en el parámetro columnsOrder.

​

Script de ejemplo

El siguiente script de PowerShell descarga el registro de eventos. Reemplace la dirección del servidor y las credenciales por las suyas.

#------------------------------------------------------------------------------
# parámetros
$server = "https://<server address>"
$user = "<user name>"
$password = "<password>"
# ruta a la carpeta donde se guardará el registro
$folder = "C:\Temp\Logs\Stage"
$reportFileName = "Tenant_Events-{0:yyMMdd-HHmmss}.csv" -f (Get-Date)
# parámetros del registro
$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 = "" # Solo el tenant predeterminado
$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
    #crear carpeta en modo silencioso (si no existe)
    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