Quick Start Guide

This guide walks you through the core termco workflow. By the end you will have created a processor, defined validation rules, processed documents, reviewed results, and generated a report.

Prerequisites

• A termco account with an active organization membership.
• At least one PDF document to process.

Step 1: Create a Processor

A processor defines what data to extract from your documents.

1. Navigate to Configure > Processors and click New Processor.
2. Enter a name and optional description and tags.
3. Add fields that correspond to the values you want to extract:
   • Name — a descriptive identifier (e.g. invoice_number, total_amount).
   • Type — choose from text, number, money, date, or boolean. See Field Types for details.
   • Required — toggle on if the field must have a value.
4. Click Save.

Step 2: Create a Contract

A contract defines validation rules that run against extracted data.

1. Navigate to Configure > Contracts and click New Contract.
2. Enter a name for the contract.
3. Click Add Logic Block to create an inline rule:
   • Give it a name (e.g. “Total is positive”).
   • Build the expression: $total_amount > 0.
   • Set the severity — error, warning, or info.
4. Click Save.
5. Return to your processor and associate this contract with it.

Step 3: Create a Job

A job processes a batch of documents through your processor.

1. Navigate to Jobs and click New Job.
2. Enter a name for the job.
3. Select the processor you created in Step 1.
4. Upload one or more PDF files.
5. Click Submit.

The job will begin processing. You can watch the extraction and processing progress counters update on the job detail page.

Step 4: Review Results

Once documents are processed, review the extracted data.

1. Open the job and click on a document row to enter the results review page.
2. The left panel shows extracted field values. The right panel shows the source PDF.
3. Check each value against the PDF. If a value is incorrect, edit it inline.
4. Review the validation results section to see which logic blocks passed or failed.
5. When satisfied, click Confirm to mark the document as reviewed.
6. Use the Previous / Next buttons to move through remaining documents.

Step 5: Generate a Report

Reports aggregate data across one or more jobs.

1. Navigate to Analyze > Reports and click New Report.
2. Enter a name for the report.
3. Add a data section and select your processor.
4. Choose which jobs to include.
5. Add line items — for example, a total of the total_amount field.
6. Click Run to generate results.
7. Export to CSV if needed.

Next Steps

• Learn more about Processors and field configuration.
• Explore Logic Blocks for reusable validation rules.
• Set up Constants for lookup tables and controlled values.
• Review the Expression Syntax reference.