Basic API events

This page documents the 3 basic core events in the iConnector framework from the time when Straatos web scan app is initiated to the uploading of the scanned images and metadata to a backend application.

 

Upon the initiation of the web scan app, the 3 basic API events are to be executed in the following order:

  1. ValidateDocumentFields (optional)
  2. UploadMetadata
  3. UploadDocument

Architecture overview


SSUoRAREQAREQAREQAREQgTgJSOTGed3UahEQAREQAREQAREQgRwCErk5cJQkAiIgAiIgAiIgAiIQJwGJ3Divm1otAiIgAiIgAiIgAiKQQ0AiNweOkkRABERABERABERABOIkIJEb53VTq0VABERABERABERABHIISOTmwFGSCIiACIiACIiACIhAnAQkcuO8bmq1CIiACIiACIiACIhADgGJ3Bw4ShIBERABERABERABEYiTgERunNdNrRYBERABERABERABEcghIJGbA0dJIiACIiACIiACIiACcRKQyI3zuqnVIiACIiACIiACIiACOQQkcnPgKEkEREAEREAEREAERCBOAhK5cV43tVoEREAEREAEREAERCCHgERuDhwliYAIiIAIiIAIiIAIxEngv7FwD4UrqKxfAAAAAElFTkSuQmCC

 

Note: Depending on the business requirements, the iConnector Server can be hosted in the same Straatos cloud infrastructure or on premise.

Initiating the web scan app

The Straatos web scan app is initiated with any standard internet browser with the unique app URL provided from the Admin Panel – Links page. (The Links page URL  contains the Configuration ID. If necessary you can append the Custom Data.)

 

The raw URL looks something like this:

http://<servername>/cumuluspro/en/ScanApp/Prototype2?ConfigurationId=<YourID>&CustomData=<YourData>

 

The ConfigurationId (for example, <YourID> in the above sample link) can be found in the Admin Panel – Organization Settings.

 

The additional field CustomData (for example, <YourData> in the above sample link) will be forwarded to the backend application when uploading metadata. The data can be used both for licensing and routing on the backend application (for example, user identification).

 

The Document Types will be retrieved from the Admin Panel and, depending on the implementation, the user can select a Document Type. Once selected, the Field Definitions from Admin Panel are used to display the fields on the web scan app. 

 

Note: If there is only one Document Type definition in the Admin Panel, the web scan app will not display the selection of Document Type (as there is only one option); instead, it will just display the metadata fields.
 
Create your own Knowledge Base