Profile handling for setting the environment according to each workflow. More...
Enumerations | |
| enum | PROFILES_INTENT { PI_Default , PI_Indexing , PI_Archiving , PI_UnstructuredText , PI_TabulatedData , PI_DataExtraction , PI_FormatRetention , PI_ContentReuse , PI_EditableCopy , PI_BarcodeReading , PI_FormCreation , PI_DocClassify , PI_MakePDFSearchable , PI_SIZE } |
| Intent of the workflow helped by the profile. More... | |
| enum | PROFILES_SOURCE_TYPE { PST_Default , PST_Scanned , PST_Camera , PST_Screen , PST_PDForXPS , PST_SIZE } |
| Source type of the workflow helped by the profile. More... | |
| enum | PROFILES_SOURCE_CONTENT { PSC_Default , PSC_GeneralText , PSC_TemplatedForm , PSC_FreeForm , PSC_Tables , PSC_SIZE } |
| Source content of the workflow helped by the profile. More... | |
Functions | |
| RECERR RECAPIKRN | kRecUseProfile (int sid, LPCTSTR profile) |
| Using the profile helping the workflow. | |
Profile handling for setting the environment according to each workflow.
This module (in cooperation with Settings Manager Module) can make a workflow more optimal for a specific aim. For this, it uses profiles, which are collections of settings that can adjust the operation of the workflow optimal for the specific aim.
CSDK settings cover the entire environment for the workflow, such as the intent, source-format, processing options, and output format. Profiles make it easy to handle the thousands of settings controlling the environment for CSDK workflows, even for a programmer not familiar with the CSDK settings tree. CSDK comes with a built-in set of Profiles, each of those include high-level non-default settings relevant for a frequently used scenario. Profile settings affect the related workflow functions, adjusting the result and performance to the related scenario. Still, Profiles do not perform or process anything, but the developer is responsible for conducting the work by calling the appropriate functions, using correct parameters, and handling exceptions.
Loading a profile requires only a single call and saves the additional work attached to the use of low-level settings directly. You can load a profile into any Settings Collection, using the settings collection ID (sid). Call the following function to load a profile: kRecUseProfile.
Developers can fine-tune the CSDK workflow environment with low-level settings after loading a profile. The kRecUseProfile function resets all settings to the default, so make sure you load the Profile before customizing your workflow environment with any low-level setting or calling other CSDK API functions.
Refer to the Samples from number 77 on for details on Profile handling.
The following list contains the built-in profiles. For using them pass their name to the second argument of the function kRecUseProfile.
Archive2PDF - Prepares the settings for archiving the source to searchable PDF MRC for indexing purposes. Tunes the OCR engine for machine-printed text. (See also Sample 77.)MakePDFSearchable - Prepares the settings for converting a PDF to searchable. Works fast and tunes the OCR engine for machine-printed text. (See also Sample 78.)ExtractContent2Text - Prepares the settings for text extraction. The expected source is a form with an arbitrary layout, while the output is plain text or XML. Uses accurate OCR settings. (See also Sample 79.)ExtractContent2Doc - Prepares the settings for a conversion to an essay mode document format. This means recognizing and extracting all the texts in reading order, including tables and pictures, while not preserving the original layout. It is ideal for producing large documents with mostly texts in a single column, with consolidated text properties across continuous pages. Input is assumed to be a large document in one. (See also Sample 80.)TrueCopy2Doc - Prepares the settings for converting the source with the highest possible accuracy regarding the page layout and text formatting. It is the best mode for copying documents with a complex layout as it is. However, the text is scattered across various output blocks (such as text boxes). (See also Sample 81.)Convert2EditableDoc - Prepares the settings for producing a document that is easy to edit, with a page layout resembling the original. Text flows in continuous paragraphs on a page, even at the expense of the original layout. Multiple columns are supported. (See also Sample 82.)ExtractTables - Prepares the settings for converting a table or tabulated data to an XLS output while keeping the table layout. Works with multipage source documents too. (See also Sample 83.)ExtractFormFields - Prepares the settings for converting a filled form, parsing the content with the form template specified for the workflow. Sets the output format as csv file. Use the Form Template Editor to prepare form templates and template libraries. (See also Sample 85.)CreateFillableForm - Prepares the settings for converting an empty form to a fillable Acro-Form-based PDF. Does not require a form template but applies Logical Form Recognition (LFR). (See also Sample 84.)DetectBarcodeSeparator - Prepares the settings for recognizing barcode separator pages in a flow of input documents.| enum PROFILES_INTENT |
Intent of the workflow helped by the profile.
Source content of the workflow helped by the profile.
| enum PROFILES_SOURCE_TYPE |
| RECERR RECAPIKRN kRecUseProfile | ( | int | sid, |
| LPCTSTR | profile ) |
Using the profile helping the workflow.
This function applies the specified profile. A profile is a collection of settings adjusting the operation of the workflow to the selected aim.
| [in] | sid | Settings Collection ID. |
| [in] | profile | The name of the profile. See the list of the built-in profiles. |
| RECERR |