What is the Kira read field instances action?
Authors can use this integration node to extract text values from fields in a Kira document. The selected document will be uploaded into the Kira project. The ID for this Kira project needs to be provided by the author.
Why would you use the Kira read field instances action?
As an author, you could use this integration node in a module to extract fields from a LIBOR loan agreement, and generate and amended document if the loan maturity date is later than 2021, when LIBOR will be phased out.
Similarly, extract fields can be used in lease or contract reviewer tools. These would present each of the relevant extracted clauses from the document to the end-user. The end-user would be guided through relevant questions or a review playbook to assess the the document against internal rules and guidelines. Based on the assessment, an amended document or a (risk) report can be easily generated. This approach replaces time-consuming and often inconsistent manual processes.
How do you use the Kira read field instances 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 the document ID has either been provided by a value node, the Kira document upload, or a number input node and select 'Kira extract field integration' node from the actions list:
To read information from a Kira field, provide the DOCUMENT ID and the FIELD NAME.
In the integration node, reference the document ID and provide or reference the Kira field name into the required integration input fields:
Once your Kira extract field integration node is set up, you can reference the content of the field in text block values, content of input nodes or set the content as default value in text input nodes.
You can use the output of the node as value in any outputted content or use it in transitions. One typical example to use the output in the module's logic is a condition set to identify a blank reference. In this example, this particular Kira field was empty, indicating an omitted clause. This approach could be used to build fully automated contract review tools that do not require an end-user to confirm or clean the extracted field values.
Input and output parameters
Input parameters |
||
| Name | Type | Description |
| Document ID | Number | The ID of the Kira document to extract a field from |
| Field name | Text | The name of the field to extract (case insensitive) |
Output parameters |
||
| Name | Type | Description |
| Combined Field Instances Text | Text | Kira field instances (text values) for the specified field. Multiple field instances are combined into a single text value, separated by dashes. |