メインコンテンツへスキップ
このログには、文書処理のイベントやエラーに関する記録が含まれています。
Processing Monitor からイベントログをダウンロードできるのは、テナント管理者 (既定の tenant の場合はシステム管理者) および Monitoring Operator の権限を持つユーザーのみです。
このログをダウンロードするには、POST request を使用します。 
POST https://<server address>/FlexiCapture12/Monitoring/Project/GetEventsCSV

​
リクエスト パラメーター

  1. すべてのパラメーターは必須です。正しく指定されていることを確認してください。
  2. Oracle Database での検索では、大文字と小文字が区別されます。Oracle Database を使用している場合は、この点にご注意ください。

名前

型

説明

filter

string

フィルターパラメーターを設定します。これにより、フィルター条件を満たすログのみが記録されます。条件の結合には AND 演算子と OR 演算子のみ使用できます。演算子は GeneralOperator パラメーターで指定します。フィルターパラメーターの例:

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”]
}
]
}

必要な PropertyKey パラメーターおよび PropertyOperator パラメーターの値は、管理および監視コンソールで目的のフィルターを作成することで確認できます。手順は次のとおりです。

  1. ブラウザーメニューで More tools -> Developer tools をクリックし、Network タブに移動します。
  2. 管理および監視コンソールを起動し、Processing Monitor → イベントログ に移動して、ボタンをクリックします。
  3. フィルター条件を指定し、Apply をクリックします。
  4. GetFilteredEvents request をクリックします。フィルタリングパラメーターが Payload タブに表示されます。

重要! デフォルトバッチのイベントをフィルタリングする必要がある場合は、“BatchTypeName” ではなく “BatchTypeNameExt” パラメーターを指定してください:

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

columnsOrder パラメーターでは、デフォルトバッチに対して “BatchTypeName” をそのまま使用する必要があることに注意してください。

columnsOrder

string

レポートに追加する列の List。指定可能な値は次のとおりです:

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

sortColumnindex

int

ログ内のレコードの並べ替えに使用する列を指定します。

sortOrder

bool

レコードの並べ替え順を指定します:

  • true はレコードを降順で並べ替えます。
  • false はレコードを昇順で並べ替えます。

projectId

int

イベントログに含めるレコードの対象となるプロジェクトを指定します。指定可能な値は次のとおりです:

  • -1 – 使用可能なすべてのプロジェクトのレコードがログに含まれます。
  • 1 以上 – 指定した ID のプロジェクトのレコードのみがログに含まれます。

使用可能なすべてのプロジェクト ID を取得するには、GetProjects メソッドを使用します。

この API の使用例はスクリプトで確認できます。スクリプトは こちら からダウンロードするか、以下のスクリプトコードを使用してください。
このスクリプト内のパラメーターを、ご利用のサーバー アドレス、テナント名、および認証情報に置き換えてください。
# parameters

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

$tenant = "<テナント名>"

$user = "<user name>"

$password = "<password>"

#ログの保存先フォルダのパス

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

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

# ログパラメーター

$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

#フォルダをサイレントに作成する（存在しない場合）

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