In this article, we describe how the Straatos iConnector Server can be used as an input channel for your own apps and integrations to submit documents into Straatos.
Documents in any Straatos Process are getting into Straatos via a StartEvent in the Workflow Step.
The start event is essentially a iConnector Server which is connected to Straatos.
The CumulusPro clients such as Scan+ProcessLite and Mobile Capture use the iConnector to upload documents to Straatos in the same way that those clients can upload documents to any other iConnector server as described in the Basic Scenario of the API.
So, in order for you to integrate your own client into Straatos to submit documents, you will call the webservices described in the Basic Scenario to upload documents and metadata to Straatos.
The Straatos iConnector supports the following webservices (for more details on the webservices and how they should be used, refer to the appropriate section in the API documentation.
When calling the WebServices, keep in mind of the following:
The function 'UploadMetadata' must be called before the documents are uploaded. It is important that the Upload Metadata contains the Document Type (DocumentTypeUniqueID). Without a valid Document Type (means, a Document Type that exists for this organisation and that is specified in a StartEvent Task in a workflow), the documents will not get imported. No error is returned for this. You find the DocumentTypeUniqueID in the Organisation - Document Types - Select the Document Type and on top the fields is called 'Unique ID'
Index Fields. If Index fields (and their values) are provided in the Metadata upload, the Index field name needs to match the index field name specified in the workflow. If there is no exact match, the value will not be imported.
You need to create two Unique ID's. One on the top level (under configuration) and one for the Document. These two unique ID's will link the 'UploadMetadata' information with the files you upload. The two Unique ID's need to be submitted with the 'UploadDocument' call. Without those Unique-ID's, the document will not be able to link to the UploadMetadata information. In that case the upload will fail and the documents will not get imported into Straatos.
The function 'UploadDocument' must be called after the Upload Metadata has been successfully called. The UploadDocument contains the actual files to be uploaded.
Important is that in the header, the
In case multiple files per document are uploaded, provide the X-Page-Number for each document. The Straatos iConnector server will then know which page number the page is for and when the upload has been completed (the number of received pages for the document is equal to X-Number-Of-Pages).
If uploading mulitple files per document (for example 5 JPG images), then the Upload Document call needs to be repeated for each file.