What is the Kira document upload action?
Authors can use this integration node to upload a file to a Kira project, for further processing in Kira. The selected document will be uploaded into the Kira project. The ID for this Kira project needs to be provided by the author.
Please note that this is a premium feature which needs to be enabled by your dedicated customer success manager. For further information, please reach out to your BRYTER Customer Success Manager or firstname.lastname@example.org. Additional pricing may apply.
Why would you use the Kira document upload action?
As an author, you would use this node when your BRYTER module serves as the intake module for your playbooks, review or due diligence work. Whenever you would like to enable your end-users to upload documents into your Kira instance without actually accessing Kira directly a BRYTER module can serve as your end-user facing interface embedded into the relevant environment.
In such an intake module, you could also gather further information on the document or collect details of the end-user while the document is processed within Kira. After Kira has processed the document, you can guide your end-user through the review steps aided by Kira extract field integration nodes.
How do you use the Kira document upload action?
This integration node requires only two input values and offers one output parameter that can be referenced further down in your module. In your module, add an action node after a file upload input node and select 'Kira analyse document integration' node from the actions list:
To upload a file to the relevant Kira project, you need to reference the document in the field DOCUMENT (REQUIRED) and provide the KIRA PROJECT ID. To find the required project ID in Kira, open the project in Kira and take the first number after #project/ in the URL.
In the integration node, reference the relevant document and reference or type the Kira Project ID into the fields:
Once your Kira document upload node is set up, you can reference the Kira Document ID that will be automatically provided by your Kira instance. This output value would be used further down in your module if you want to extract information from fields in the processed Kira document.
Input and output parameters
|Document||File Upload||The file in the BRYTER module to upload to Kira|
|Kira project ID||Text||The ID of the Kira project to upload the above file into. To find the required project ID in Kira, open the project in Kira and take the first number after #project/ in the URL|
|documentId||Number||The uploaded file's Kira document|