APIs can be context aware or non-context aware. A context aware SDK method is “aware” of the “context” in which it is being executed. A context aware method when executed in a scenario where the data cache is being used, can access the data cache instead of accessing the database directly.
TotalAgilty uses a temporary data cache to improve system performance under certain circumstances. When the data cache is being used, the latest data is contained within the data cache, and not the database itself. The database receives the latest data only when the system commits the information in the data cache to the database When a data cache is being used, only the context aware SDK methods execute correctly, as these methods are aware of the context under which they are being executed. They correctly access the data cache instead of the database.
If a non-context aware SDK method is used when a data cache is in use, an error occurs as the method tries to access the database instead of the data cache.
Scenarios where data cache is used
- Validation business rules
- Validation is called from manual capture activities
- Validation is called from Transformation Server
- Validation is called from Transformation Designer
- Validation Post Validation Handler
- SDK called within a process map from activities, such as .NET and C#, and this process is executed by CreateJobSyncWithDocuments API.
- Includes advanced configuration, such as an Extraction activity within Transformation Server executing validation logic with business rule.
- An SDK called by a .NET Method action or business rule from manual capture activity.
Context aware APIs
Not all public APIs are context aware. A list of context aware APIs of TotalAgility includes:
- CreateDocument
- CreateDocument2
- CreateDocument3
- CreateDocuments
- CreateDocuments2
- CreateDocumentWithPages
- DeletePageRendition
- DeleteTableFieldRow
- GetDocument
- GetDocumentFieldAlternatives
- GetDocumentFieldAlternatives2
- GetDocumentFieldPropertyValues
- GetDocumentFieldsAlternatives
- GetDocumentFieldsAlternatives2
- GetDocumentFieldsProperties
- GetDocumentFieldValue
- GetDocumentFieldValues
- GetDocumentTableFieldValue
- GetImage
- GetPagePropertyValues
- GetPageRendition
- GetPageRenditionImageSummary
- GetPageSummary
- GetTextExtension
- GetWordsInRectangle
- InsertTableFieldRow
- InterpolateTableField
- IsPageRenditionDefined
- RunDocumentFieldsValidation
- RunFolderFieldsValidation
- SavePageImage
- SavePageRendition
- SaveTextExtension
- SetDocumentFieldStatus
- SetDocumentStatus
- SetFolderFieldStatus
- SetFolderStatus
- SetPageSourceImageFromRendition
- SplitDocument
- SplitDocumentAndClassify
- SplitFolder
- UpdateDocumentFieldPropertyValues
- UpdateDocumentFieldValue
- UpdateDocumentFieldValues
- UpdateDocumentType
- UpdateDocumentTypeWithConfidence2
- UpdateDocumentVariant
- UpdateWords
- ValidateDocument
- ValidateDocumentForReview
- ValidateDocumentForReviewWithType
- ValidateFolderForReview
- ValidateFolderForReviewWithType