ContentAnalyzerSubmitRequestCreateMultipage
The action will use the previously supplied credentials to connect to the Business Automation Content Analytics, Content Analyzer, service through action ContentAnalyzerConfiguration.
Syntax
bool ContentAnalyzerSubmitRequestCreateMultipage ()
Parameters
FullPageRecognition: String. True or False. Indicates if full page recognition should be returned and saved in a layout file. Set to True to put full page recognition in the layout file. Defaults to True if not specified.
CreatePDF: String. True or False. Set to True to generate a searchable PDF from the input document. Defaults to True if not specified.
CreateTextFile: String. Value True or False. If true, the value utf8 (txt) will be added to the response type parameter in the request.
DocumentClassification: String. True or False. Set to True to include the analyzed document classification information in the returned data. Defaults to True if not specified.
DocClass: String. The name of the document class to use for analysis. If the class is blank, then the service determines the correct class to use for analysis based on the configured ontology within the service.
KeyValuePairs: String. True or False. Set to True to include analyzed key value pairs information in the returned data. Defaults to True if not specified.
Headers: String. True or False. Set to True to include the analyzed header information in the returned data. Defaults to True if not specified.
TableHeaders: String. True or False. Set to True to include the analyzed table header information in the returned data. Defaults to True if not specified.
Mandatory: String. True or False. Set to True to include the results of the mandatory requirements check in the returned data. Defaults to True if not specified.
AIIntegration: String. True or False. Set to True to include the information from any additional integration services, such as Watson, in the returned data. Defaults to False if not specified.
DocumentSegmentation: String. True or False. Set to True to include the analyzed document segmentation information in the returned data. Defaults to False if not specified.
All parameters support Smart Parameters.
Returns
True, if action is successful else, False.
Level
Document level
Details
- The action uses the previously supplied credentials to connect to the Business Automation Content Analytics, Content Analyzer, service through action ContentAnalyzerConfiguration.
- This action can be called only on a document DCO node.
- The page that is associated with the current DCO node is submitted to the service for processing.
- If the document does not have an associated file, then a document level multi-page TIF will be automatically created from the child pages.
- The associated file can be of types that are supported by Content Analyzer such as PDF, TIF, PNG, or JPG document.
This action is very similar to the ContentAnalyzerSubmitRequest action. The associated document level file will be sent to Content Analyzer for processing, identically to ContentAnalyzerSubmitRequest. The associated file can be any type of file that is supported by Content Analyzer, such as a PDF or multi-page TIF. If a file is not associated with the document level object, then this action will automatically create a multi-page TIF image from the child pages and associate the multi-page TIF with the current document object. When automatically creating a multi-page TIF image from the child pages, it is required that all of the child pages are all single page TIF images. The new multi-page TIF is the image that will be submitted to Content Analyzer for processing as a single document, populating the page object data as specified by the action parameters.
Once the document has been submitted to Content Analyzer for processing, this action will update the AnalyzerRequestID variable to be used by a subsequent call to ContentAnalzyerGetOutput. Action will not wait for Content Analyzer to process the document and will return True if the request is successful. The results of Content Analyzer processing are not ingested into the batch using this action, it simply submits documents for processing. If desired, multiple submit actions can be called to provide multiple documents to Content Analyzer for processing and once all of desired documents have been submitted, subsequent rules can call ContentAnalyzerGetOutput.
The action in turn returns the AnalyzerID which gets saved as DCO variable AnalyzerRequestID in the current object which can be used later by further actions.
- Example
-
ContentAnalyzerConfiguration("url","@APPVAR(values/gen/FunctionalID)","@APPVAR(values/adv/Password)","@APPVAR(values/adv/APIKey")ContentAnalyzerSubmitRequestCreateMultipage("True,"True","False","True","Invoice","True","","","","","False")
This example will configure the actions to connect to Content Analyzer, and then submits a document for processing. The two actions are shown together for illustration. Typically ContentAnalzyerConfiguration would be called once on a batch level rule and then ContentAnalyzerSubmitRequestCreateMultipage will be associated with Document level or Page level objects and will be called once for each document to submit. In case if action is called at Document level, and page is not promoted as Document, in such case this action will merge the tiff files associated to this document and will create one single file at Document level. A variable MergedTiffFileName will be added in the DCO XML within the Document containing the name of merge file. The whole merged tiff file will be submitted to Content Analyzer server for processing similar to sending multipage tiff.