Saltar al contenido principal
Este registro contiene información sobre los eventos y errores del procesamiento de documentos.
Solo los usuarios con permisos de Administrador del tenant (o de Administrador del sistema en el caso del tenant predeterminado) y de Operador de supervisión pueden descargar registros de eventos en Processing Monitor.
Para descargar este registro, envíe una solicitud POST. 
POST https://<server address>/FlexiCapture12/Monitoring/Project/GetEventsCSV

​
Parámetros de la solicitud

  1. Todos los parámetros son obligatorios. Asegúrese de especificarlos correctamente.
  2. La búsqueda en Oracle Database distingue entre mayúsculas y minúsculas. Téngalo en cuenta si utiliza Oracle Database.

Nombre

Tipo

Descripción

filter

string

Establece los parámetros del filtro. Como resultado, solo se registrarán los eventos que cumplan las condiciones del filtro. Solo se pueden usar los operadores AND y OR para combinar las condiciones. Los operadores se especifican en el parámetro GeneralOperator. Ejemplos de parámetros de filtro:

filter={
“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”]
}
]
}

Puede encontrar los valores necesarios para los parámetros PropertyKey y PropertyOperator creando el filtro deseado en la Consola de administración y supervisión. Para ello:

  1. En el menú del navegador, haga clic en More tools -> Developer Tools y vaya a la pestaña Network.
  2. Inicie la Consola de administración y supervisión, vaya a Processing Monitor → registro de eventos y haga clic en el botón .
  3. Especifique los criterios de filtrado y haga clic en Apply.
  4. Haga clic en la solicitud GetFilteredEvents. Los parámetros de filtrado aparecerán en la pestaña Payload.

¡Importante! Si necesita filtrar eventos para lotes predeterminados, especifique el parámetro “BatchTypeNameExt” en lugar de “BatchTypeName”:

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

Tenga en cuenta que debe mantenerse “BatchTypeName” para el lote predeterminado en el parámetro columnsOrder.

columnsOrder

string

Lista de columnas que deben agregarse al informe. Los valores posibles son:

  • ID
  • Date
  • EventType
  • Comment
  • UserFullName
  • Workstation
  • BatchId
  • BatchName
  • BatchTypeName
  • StageFromName
  • StageToName
  • ProjectName
  • RoleName
  • TenantName

sortColumnindex

int

Especifica la columna que se utilizará para ordenar los registros en el log.

sortOrder

bool

Especifica el orden en que se ordenarán los registros:

  • true ordenará los registros en orden descendente,
  • false ordenará los registros en orden ascendente.

projectId

int

Especifica los proyectos cuyos registros deben incluirse en el registro de eventos. Los valores posibles son:

  • -1 – se incluirán en el log los registros de todos los proyectos disponibles.
  • 1 y superior – se incluirán en el log solo los registros del proyecto con el ID especificado.

Use el método GetProjects para obtener todos los ID de proyecto disponibles.

Puede encontrar un ejemplo de uso de esta API en el script. Descargue el script aquí o use el código del script que se proporciona a continuación.
Los parámetros de este script deben reemplazarse por la dirección del servidor, el nombre del tenant y sus propias credenciales.
# parameters

$server = "https://<server address>"

$tenant = "<tenant name>"

$user = "<user name>"

$password = "<password>"

#ruta a la carpeta donde se guardará el log

$folder = "C:\Temp\Logs\Stage"

$reportFileName = "Project_Events-{0:yyMMdd-HHmmss}.csv" -f (Get-Date)

# parámetros de registro

$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

#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$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