Obtenir des données à l'aide de l'API
Chemin vers le stockage des données des Rapports sur les processus d'entreprise
Points d'entrée :
/Reporting/BatchState/List
/Reporting/BatchState/File/<filename>
/Reporting/BatchState/View
/Reporting/BatchRouting/List
/Reporting/BatchRouting/File/<filename>
/Reporting/BatchRouting/View
Le chemin complet vers le stockage de données est un lien qui peut être modifié.
Exemple :
http://localhost/Flexicapture12/Server/Reporting/BatchState/View
Pour l'accès via le module d'authentification ABBYY FlexiCapture, le lien suivant est ajouté :/FCAuth
L'accès autorisé est permis dans les cas suivants :
- Pour les utilisateurs autorisés d'ABBYY FlexiCapture.
- Lorsque vous utilisez des jetons SAML/JWT.
Exemple :
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchState/View
Si le tenant n'est pas le tenant par défaut, le paramètre suivant est ajouté au lien : ?Tenant=<tenant name>.
Exemple :
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchState/View ?Tenant=myTenant
Création des demandes
Seules les demandes GET sont acceptées.
Liste renvoie une liste de noms de fichiers au format JSON.
Fichier renvoie un fichier avec le nom spécifié (qui doit être encodé au format URL).
Affichage renvoie une liste de noms de fichiers au format HTML et insère des liens vers les fichiers à l'aide de la commande Fichier décrite ci-dessus. À ce titre, cette demande vous permet d'utiliser les liens fournis pour ouvrir des fichiers dans votre navigateur et en enregistrer des copies sur votre ordinateur local.
Exemples :
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchState/View
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchRouting/View
Obtenir des Rapports sur les processus d'entreprise à l'aide de scripts PowerShell
Le script ci-dessous permet aux utilisateurs tenant avec des rôles Administrateur ou Opérateur de surveillance d'obtenir des données de surveillance des processus d'entreprise.
Les rapports sont enregistrés au format CSV dans le dossier à partir duquel le script a été lancé.
$serviceHost = 'http://localhost' #Host
$user=$null #User
$pass=$null #Password
$tenant=$null #Tenant name
$baseUrl = $serviceHost
if( $user ) {
$baseUrl += '/flexicapture12/server/FCAuth/Reporting/'
} else { $baseUrl += '/flexicapture12/server/Reporting/'
}function createBasicCredentials() #Transforms password to encrypted strings
{
$secpasswd = ConvertTo-SecureString $pass -AsPlainText -Force
return New-Object System.Management.Automation.PSCredential($user, $secpasswd)
}
function getListFromUrl( $url ) #Authenticates using entered credentials
{
if( $tenant ) {
$url = $url + '?Tenant=' + [uri]::EscapeUriString( $tenant );
}
if( $user ) {
$creds = createBasicCredentials -user $user -pass $pass
$response = Invoke-WebRequest -Credential $creds -Uri $url;
} else {
$response = Invoke-WebRequest -UseDefaultCredentials -Uri $url;
}
$fileList = $response.ToString() | ConvertFrom-Json;
return $fileList.reportFiles;
}
function getBatchStateFileList() #Requests a list of BatchState files
{
$url = $baseUrl + 'BatchState/List';
return getListFromUrl -url $url
}
function getBatchRoutingFileList() #Requests a list of BatchRouting files
{
$url = $baseUrl + 'BatchRouting/List';
return getListFromUrl -url $url
}
function downloadFile ( $fileName, $outDir ) #Downloads files
{
$url = $baseUrl + 'BatchState/File/' + [uri]::EscapeUriString( $fileName );
if( $tenant ) {
$url = $url + '?Tenant=' + [uri]::EscapeUriString( $tenant );
}
$outPath = Join-Path -Path $outDir -ChildPath $fileName
if( $user ) {
$creds = createBasicCredentials -user $user -pass $pass
$response = Invoke-WebRequest -Credential $creds -Uri $url;
$response = Invoke-WebRequest -Credential $creds -Uri $url -OutFile $outPath
} else {
$response = Invoke-WebRequest -UseDefaultCredentials -Uri $url -OutFile $outPath
}
}
$files = getBatchStateFileList; #Uploads BatchState files to the current directory
foreach ($file in $files) {
downloadFile -fileName $file -outDir '.\'
}
$files = getBatchRoutingFileList; #Uploads BatchRouting files to the current directory
foreach ($file in $files) {
downloadFile -fileName $file -outDir '.\'
}
4/12/2024 6:16:04 PM