DOS File Method - OCR for AnyDoc - Foundation 23.1 - Foundation 23.1 - AnyDoc - external

If the DOS file name method is chosen, the Batch Interface Library writes all information communicated from the server to the supplied file name. This is the only method a language like Visual Basic™ supports.

Each call to the function OCRFFAPI_BatchProcess() creates the file, which overwrites any existing file of the same name.

All fields in the record are separated by a single space. Any string data type that is not applicable will be replaced with a comma (,) and any integer data type that is not applicable is replaced with zero (0).

The first byte of each record in the file determines the type of the information.

API_MESSAGE

OCR for AnyDoc sent either an informational message or an error occurred to the client. Format:

Example

1 1004 Disk Import process is complete

API_STATUS/ API_JOB_START

Used to communicate status information for each image processed from OCR for AnyDoc to the Client program. Strings that do not apply to the phase are equal to “,”. Format:

Example ( indicates line is wrapped)

2 16 0 1 3 test.fof nwtest.tif 00012111 c:\ocrff\jobs\test.fof\00012111\00089084.tif ¿

MERIT 12 0 0 0 c:\ocrff\data\test.fof\97_11_11\00012111.txt c:\ocrff\import\abc001.tif, 0

2 16 0 2 3 test.fof nwtest.tif 00012111 c:\ocrff\jobs\test.fof\00012111\0089085.tif ¿

MERIT 12 0 0 0 c:\ocrff\data\test.fof\97_11_11\00012111.txt c:\ocrff\import\abc002.tif, 0

2 16 2 3 3 test.fof attchmnt 00012111 c:\ocrff\jobs\test.fof\00012111\0089086.tif ¿

MERIT 0 0 0 1 c:\ocrff\data\test.fof\97_11_11\00012111.txt c:\ocrff\import\abc003.tif , 0

OCRFFAPI_JobAbort

Aborts a transaction in progress by the server. Behaves exactly like the Cancel button on an OCR for AnyDoc process window.

void OCRFF_API

OCRFFAPI_JobAbort(void);

void CClientDlg::OnAbort()

{

// TODO: Add your control notification handler code here

OCRFFAPI_JobAbort();

}

OCRFFAPI_GetNumberofImagesProcessed

Used to request the number of images processed in the previous call to OCRFFAPI_BatchProcess().

int OCRFF_API

OCRFFAPI_GetNumberofImagesProcessed(void);

LRESULT CClientDlg::ProcessComplete(WPARAM,LPARAM lParam)

{

ClientDialogEnable(TRUE);

int nImagesProcessed = OCRFFAPI_GetNumberofImagesProcessed();

CString strMessage;

StrMessage.Format("Complete -> OCR for AnyDoc finished work for %d jobs", nImagesProcessed);

AddToInfoArea(strMessage);

return 0L;

}

OCRFFAPI_Error2String

Converts the error code returned from the Batch Interface Library to its ASCII equivalent. A successful operation returns OCRFF_SUCCESS, which has a value of one. A return value OCRFF_NO_WORK also indicates a successful operation, however there was no work to process for the function. OCRFF_NO_WORK has a value of 31. Any other returned values indicate a failure.

void OCRFF_API

OCRFFAPI_Error2String(int nError, char *pszBuffer);

int nReturn = OCRFFAPI_Connect(

"c:\\program files\Hyland\OCR for AnyDoc\OCRforAnyDoc.exe",FALSE);

if (nReturn != OCRFF_SUCCESS)

{

char szMsg[100];

OCRFFAPI_Error2String(nReturn,szMsg);

MessageBox(GetActiveWindow(),szMsg,"Client",MB_ICONSTOP);

}

OCRFFAPI_GetSystemInfo

Returns information about the OCR for AnyDoc environment including the hardware key configuration, OCR for AnyDoc version, network login name, master template path and mask, Control path and Table path (from Settings | System Directories).

int OCRFF_API

OCRFFAPI_GetSystemInfo(LPSYSINFOSTRUCT lpSysInfo);

lpSysInfo

Pointer to a SYSINFOSTRUCT structure defined in ocrffapi.h and allocated by the client that is used to request details about the OCR for AnyDoc environment.

SYSINFOSTRUCT SysInfo;

char szMsg[100];

/* initialize structures */

memset(&SysInfo,0x00,sizeof(SYSINFOSTRUCT));

SysInfo.nSysInfoStructureSize = sizeof(SYSINFOSTRUCT);

If (OCRFFAPI_GetSystemInfo(&SysInfo) == OCRFF_SUCCESS)

{

wsprintf(szMsg,"OCR for AnyDoc Version %s",SysInfo.szOCRFFVersion);

SendDlgItemMessage(hDlg,IDD_INFO,LB_ADDSTRING,0,(LONG)(szMsg));

wprintf(szMsg,"OCRFF User Name -> %s",SysInfo.szUserName);

SendDlgItemMessage(hDlg,IDD_INFO,LB_ADDSTRING,0,(LONG)(szMsg));

SetDlgItemText(hDlgClient,IDD_MASTER_PATH,SysInfo.szMasterPath);

szBuffer[0] = NULL;

if(SysInfo.nHardwareKeyCapabilities & BATCH_API_EXTRACT)

strcat(szBuffer,"Extract”);

if(SysInfo. nHardwareKeyCapabilities & BATCH_API_VERIFY)

strcat(szBuffer,"Verification");

sprintf(szMsg," Hardware Key Configuration -> %s",szBuffer);

SendDlgItemMessage(hDlg,IDD_INFO,LB_ADDSTRING,0,(LONG)(szMsg));

}

OCRFFAPI_GetFirstFormFamily/OCRFFAPI_GetNextFormFamily

Returns the form families (.FOF) available for processing from OCR for AnyDoc.

The client application must first call OCRFFAPI_GetFirstFormFamily() to retrieve the first form family. Each successive call to OCRFFAPI_GetNextFormFamily() returns the next form family. When the return value is not equal to OCRFF_SUCCESS, all form families have been received.

int OCRFF_API

OCRFFAPI_GetFirstFormFamily(char *pszFOF);

int OCRFF_API

OCRFFAPI_GetNextFormFamily(char *pszFOF);

char szFOF[OCRFFAPI_SIZE_FILENAME];

if (OCRFFAPI_GetFirstFormFamily(szFOF) == OCRFF_SUCCESS)

{

SendDlgItemMessage(hDlg,IDC_FOFLIST,LB_ADDSTRING,0, szFOF);

while(OCRFFAPI_GetNextFormFamily(szFOF) == OCRFF_SUCCESS)

SendDlgItemMessage(hDlg,IDC_FOFLIST,LB_ADDSTRING,0,szFOF);

}

OCRFFAPI_GetFirstBatch/OCRFFAPI_GetNextBatch

Returns the pending batches for the specified form family.

The client application must first call OCRFFAPI_GetFirstBatch() to retrieve the first pending batch. Each successive call to OCRFFAPI_GetNextBatch() returns the next pending batch. When the return value is not equal to OCRFF_SUCCESS, all pending batches have been received.

int OCRFFAPI_API

OCRFFAPI_GetFirstBatch (LPSTR pszFOF,

LPBATCHDETAILSTRUCT lpBatchDetail,

int *pnTotalBatches);

int OCRFFAPI_API

OCRFFAPI_GetNextBatch (LPBATCHDETAILSTRUCT lpBatchDetail)

int nTotalBatches = 0;

BATCHDETAILSTRUCT BatchDetail;

memset(&BatchDetail,0x00,sizeof(BATCHDETAILSTRUCT));

BatchDetail.nStructureSize = sizeof(BATCHDETAILSTRUCT);

if (OCRFF_SUCCESS == OCRFFAPI_GetFirstBatch(szFOF,&BatchDetail,&nTotalBatches))

{

CString strBuffer;

strBuffer.Format("Form Family %s has %d pending batches", szFOF,nTotalBatches);

AddToInfoArea(strBuffer);

AddBatch(&BatchDetail);

while(OCRFF_SUCCESS == OCRFFAPI_GetNextBatch(&BatchDetail))

AddBatch(&BatchDetail);

}

OCRFFAPI_BatchAction

Performs an operation, such as delete, prioritize, suspend, or unsuspend on the specified batch for the specified form family.

int OCRFFAPI_API

OCRFFAPI_BatchAction (LPBATCHACTIONSTRUCT lpBatchAction);

BATCHACTIONSTRUCT BatchAction;

memset(&BatchAction,0x00,sizeof(BATCHACTIONSTRUCT));

BatchAction.nStructureSize = sizeof(BATCHACTIONSTRUCT);

lstrcpy(BatchAction.szFormFamily,”test.fof”);

lstrcpy(BatchAction.szBatchID,”00001234

BatchAction.nBatchAction = BATCH_ACTION_DELETE;

int nReturn = OCRFFAPI_BatchAction(&BatchAction);

if (nReturn != OCRFF_SUCCESS)

{

char szMsg[100];

OCRFFAPI_Error2String(nReturn,szMsg);

MessageBox(GetActiveWindow(),szMsg,"Client Error",MB_ICONSTOP);

}

OCRFFAPI_ImageAction

Performs an operation, such as delete or pending status on the specified image in the specified batch for the specified form family.

int OCRFFAPI_API

OCRFFAPI_ImageAction (LPIMAGEACTIONSTRUCT lpImageAction);

IMAGEACTIONSTRUCT ImageAction;

memset(&ImageAction,0x00,sizeof(IMAGEACTIONSTRUCT));

ImageAction.nStructureSize = sizeof(IMAGEACTIONSTRUCT);

lstrcpy(ImageAction.szFormFamily,”test.fof”);

lstrcpy(ImageAction.szBatchID,”00001234

Istrcpy(ImageAction.szDataImage,”00890001.tif”);

lstrcpy(ImageAction.szDeleteRoutePath,”c:\\deleted”);

ImageAction.nImageAction = IMAGE_ACTION_DELETE;

if (OCRFFAPI_ImageAction(&ImageAction)== OCRFF_SUCCESS)

{

CString strMessage;

strMessage.Format("Image Deleted for %s-%s-%s -> pending",ImageAction.szFormFamily,ImageAction.szBatchID,ImageAction.szDataImage);

switch (ImageAction.nPendingPhase)

{

case BATCH_API_QA:

strMessage += "QA";break;

case BATCH_API_IDENTIFY:

strMessage += "Identify";break;

case BATCH_API_EXCEPTION:

strMessage += "Exception";break;

case BATCH_API_EXTRACT:

strMessage += "Extract";break;

case BATCH_API_VERIFY:

strMessage += "Verify/Pass 1";break;

case BATCH_API_VERIFY_PASS_2:

strMessage += "Verify/Pass 2";break;

case BATCH_API_VERIFY_SUPERVISOR:

strMessage += "Verify/Supervisor";break;

case BATCH_API_COMMIT:

strMessage += "Commit";break;

}

m_pClientDlg->AddToInfoArea(strMessage);

}

OCRFFAPI_SetUserName

Overrides the programmatically queried network user name for the OCR for AnyDoc session. Useful to distinguish between three shifts of Verification operators without having to set up the PC/station with three different logins.

int OCRFF_API

OCRFFAPI_SetUserName(LPCSTR pszUserName);

int nReturn = OCRFFAPI_ SetUserName(“SUPERVISOR”);

if (nReturn != OCRFF_SUCCESS)

{

char szMsg[100];

OCRFFAPI_Error2String(nReturn,szMsg);

MessageBox(GetActiveWindow(),szMsg,"Client Error",MB_ICONSTOP);

}

OCRFFAPI_GetFamilyInfo

Returns information about the specified form family including the description, Import path, and configured Verification operators.

int OCRFF_API

OCRFFAPI_GetFamilyInfo(LPFOFINFOSTRUCT lpFofInfo);

FOFINFOSTRUCTFofInfo;

memset(&FofInfo,0x00,sizeof(FOFINFOSTRUCT));

FofInfo.nStructureSize = sizeof(FOFINFOSTRUCT);

lstrcpy(FofInfo.szFormFamily,”test.fof”);

if (OCRFFAPI_GetFamilyInfo(&FofInfo) == OCRFF_SUCCESS)

{

CString strBuffer;

strBuffer.Format("\tImport Path -> %s",FofInfo.szImportPath);

AddToInfoArea(strBuffer);

strBuffer.Format("\tVfy Operators (Pass 1) -> %s",FofInfo.szVerificationOperators);

AddToInfoArea(strBuffer);

strBuffer.Format("\tVfy Operators (Pass 2) -> %s",FofInfo.szPass2VerificationOperators);

AddToInfoArea(strBuffer);

}

OCRFFAPI_GetFirstHistoryBatch/OCRFFAPI_GetNextHistoryBatch

Returns the Committed batches for the specified form family before the optionally specified date. The batch history log must exist for a Committed batch to be returned. e.g. ...AnyDoc\OCR for AnyDoc\jobs\test.fof\00001234.log).

The client application must first call OCRFFAPI_GetFirstHistoryBatch() to retrieve the first Committed batch. Each successive call to OCRFFAPI_GetNextHistoryBatch() returns the next Committed batch. When the return value is not equal to OCRFF_SUCCESS, all Committed batches have been received.

int OCRFFAPI_API

OCRFFAPI_GetFirstHistoryBatch (LPSTR pszFOF, LPSTR pszDate

LPBATCHHISTORYSTRUCT lpBatchHistory, int *pnTotalBatches);

int OCRFFAPI_API

OCRFFAPI_GetNextHistoryBatch (LPBATCHHISTORYSTRUCTlpBatchHistory)

int nTotal = 0;

BATCHHISTORYSTRUCT BatchDetail;

memset(&BatchHistory,0x00,sizeof(BATCHHISTORYSTRUCT));

BatchHistory.nStructureSize = sizeof(BATCHHISTORYSTRUCT);

if (OCRFF_SUCCESS == OCRFFAPI_GetFirstHistoryBatch(szFOF,szDate,& BatchHistory,&nTotal))

{

CString strBuffer;

strBuffer.Format("Form Family %s has %d committed batches before %s",szFOF,szDate,nTotal);

AddToInfoArea(strBuffer);

AddHistoryBatch(&BatchHistory);

while(OCRFF_SUCCESS ==

OCRFFAPI_GetNextHistoryBatch(&BatchHistory))

AddHistoryBatch(&BatchHistory);

}

OCRFFAPI_Archive

Performs archiving capabilities for Committed batches. The batch history log must exist for a batch to be archived (e.g., ...AnyDoc\OCR for AnyDoc\jobs\test.fof\00001234.log).

int OCRFFAPI_API

OCRFFAPI_BatchArchive (LPBATCHARCHIVESTRUCT lpBatchArchive);

BATCHARCHIVESTRUCT BatchArchive;

memset(&BatchArchive,0x00,sizeof(BATCHARCHIVESTRUCT));

BatchArchive.nStructureSize = sizeof(BATCHARCHIVESTRUCT);

lstrcpy(BatchArchive.szFormFamily,”test.fof”);

lstrcpy(BatchArchive.szBatchID,”00001234);

lstrcpy(BatchArchive.szBackupCMPFile,”c:\\ocrff\backup\00001234.cmp”);

BatchArchive.nDeleteText = TRUE;

BatchArchive.nDeleteImages = TRUE;

BatchArchive.nDeleteLog = TRUE;

BatchArchive.nPurgeLogDBCommitted = TRUE;

BatchArchive.nPurgeLogDBDeleted = TRUE;

int nReturn = OCRFFAPI_ Archive (&BatchArchive);

if (nReturn != OCRFF_SUCCESS)

{

char szMsg[100];

OCRFFAPI_Error2String(nReturn,szMsg);

MessageBox(GetActiveWindow(),szMsg,"Client Error",MB_ICONSTOP);

}

OCRFFAPI_DisplayGUI

Displays the specified OCR for AnyDoc user interface.

int OCRFFAPI_API

OCRFFAPI_DisplayGUI (int nGUIToDisplay, LPCSTR pszFamily);

int nReturn = OCRFFAPI_DisplayGUI(OCRFFGUI_FORMMGR_PENDING,”test.fof”);

if (nReturn != OCRFF_SUCCESS)

{

char szMsg[100];

OCRFFAPI_Error2String(nReturn,szMsg);

MessageBox(GetActiveWindow(),szMsg,"Client Error",MB_ICONSTOP);

}