メインコンテンツへスキップ
このログには、ABBYY FlexiCapture で発生したすべてのイベントとエラーの記録が含まれます。たとえば、システム管理者のログイン／ログアウト、Application Server と処理ステーションの起動／停止などです。このイベントログには、テナント内で発生したイベントの記録は含まれません。
System Monitor からイベントログをダウンロードできるのは、システム管理者の権限を持つユーザーのみです。システム管理者は、既定のテナントの管理者です。
このログをダウンロードするには、POSTリクエストを使用します。 
POST https://<server address>/FlexiCapture12/Monitoring/Tenant/GetEventsCSV

​
リクエストパラメータ

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

Name

型

Description

filter

string

フィルターパラメーターを設定します。フィルター条件を満たすログのみが記録されます。条件の組み合わせには、AND演算子とOR演算子のみ使用できます。演算子はGeneralOperatorパラメーターで指定します。フィルターパラメーターのサンプル：

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

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

  1. ブラウザーのメニューで その他のツール -> Developer Tools をクリックし、Network タブに移動します。
  2. 管理および監視コンソールを起動し、システムモニター → イベントログ に移動して、ボタンをクリックします。
  3. フィルタリング条件を指定し、Apply をクリックします。
  4. GetFilteredEvents リクエストをクリックします。フィルタリングパラメーターが Payload タブに一覧表示されます。

重要！　デフォルトテナントのイベントをフィルタリングする場合は、「TenantName」の代わりに「TenantNameExt」パラメーターを指定してください：

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

なお、columnsOrderパラメーターでは、デフォルトテナントに対して「TenantName」を引き続き使用する必要があります。

columnsOrder

string

レポートに追加する列の一覧です。指定可能な値は以下のとおりです：

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

sortColumnindex

int

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

sortOrder

bool

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

  • true を指定すると、レコードが降順で並べ替えられます。
  • false を指定すると、レコードが昇順で並べ替えられます。

tenantId

int

イベントログに含めるレコードのテナントを指定します。指定可能な値は以下のとおりです：

  • -1 – 利用可能なすべてのテナントのレコードがログに含まれます。
  • 0 – デフォルトテナントのレコードがログに含まれます。
  • 1以上 – 指定したIDを持つテナントのレコードのみがログに含まれます。
このAPIの使用例はスクリプトで確認できます。スクリプトをこちらからダウンロードするか、以下に記載のスクリプトコードをご利用ください。
このスクリプト内のパラメーターは、ご利用のサーバー アドレスとご自身の認証情報に置き換えてください。
#------------------------------------------------------------------------------

# parameters

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

$user = "<user name>"

$password = "<password>"

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

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

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

# ログパラメーター

$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 = "" # デフォルトのテナントのみ

$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

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

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