Skip to content

Commit 9a26571

Browse files
Enhance Sample Workflow documentation
Added detailed instructions for sample workflow
1 parent 1b6962f commit 9a26571

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

docs/SampleWorkflow.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
11

2+
# Sample Workflow
3+
4+
To help you get started, sample Informix queries have been included in the data/informix/functions and data/informix/simple directories. You can choose to upload these files to test the application.
5+
6+
## **Process**
7+
8+
> Note: Download Sample Data - You can down load the sample data files for Invoices and Property Claims from the url mentioned in remarks column, if yu already have this data you can ignore
9+
10+
### **API Documentation**
11+
12+
_Sample Operation:_
13+
14+
-Task: Click on 'API Documentation' to view and explore the available API endpoints and their details
15+
16+
### **Upload**
17+
The Browse section allows users to explore and retrieve information related to promissory notes. Key functionalities include:
18+
19+
_Sample Qperations:_
20+
21+
- Task: Schema Selection -
22+
Select the Schema under the Processing Queue pane which is relavent to the content which is being uploaded
23+
- Task: Import Content – Click on the "Import Content" button.
24+
- Task: Browse File –
25+
Choose a file from the downloaded list for data extraction corresponding to the Schema selected
26+
- Task: Upload File – Click the "Upload" button.
27+
28+
### **Review**
29+
The Generate section enables users to create new promissory notes with customizable options. Key features include:
30+
31+
_Sample Qperation:_
32+
33+
- Task: Open Processed File - Once the file status is marked as Completed, click on the file.
34+
Once the batch Processing is done for any file the file will be available to review.
35+
-Task: Review Extracted Data -
36+
The extracted data will be displayed in the "Output Review" pane.
37+
The corresponding file will be shown in the "Source Document" pane.
38+
-Task: Modify and Submit
39+
Edit any incorrect data in the JSON which is shown in the "Output Review" pane under "Exrtracted Results" tab.
40+
Add notes under the "Comments" multi line textbox.
41+
Save the changes by clickin on the "Save" button
42+
-Task: Review Process Steps -
43+
You can view the process steps in the "Output Review" pane under the "Process Steps" tab.
44+
Expand the Extract, Map, and Evaluate sections to see the outputs from each process step.
45+
46+
### **Delete**
47+
The Draft section ensures accuracy and completeness of the generated promissory notes. Key tasks include:
48+
49+
_Sample operation:_
50+
51+
- Task: Delete - Click the three-dot menu at the end of the row to expand options, then select 'Delete' to remove the item.
52+
53+
![Application](images/sampleworkflow.png)
54+
55+
This structured approach ensures that users can efficiently browse, create, and refine promissory notes while maintaining legal compliance and document accuracy.

0 commit comments

Comments
 (0)