Enhanced Full-text Document Search
Overview
The Enhanced Full-text Search module integrates OpenSearch to provide advanced search capabilities for your FormKiQ document management system. This Enterprise Add-On Module extends the built-in search functionality with powerful features including multi-tag parameter searches and full-text queries.
Key Features
- Advanced full-text search capabilities
- Multiple tag parameter support
- Optional OCR result indexing
- Powerful query capabilities
- Real-time indexing
Installation Process
1. VPC Setup (Recommended)
For enhanced security, it's recommended to deploy OpenSearch within a VPC. If you're not using a VPC, you can skip this step.
- Access the CloudFormation console
- Create a new stack using the VPC template
- Configure CIDR ranges for your network requirements
Note the VPC Stack Name for use in OpenSearch configuration
2. OpenSearch Installation
- Access the CloudFormation console
- Create a new stack for OpenSearch
- Configure the following parameters:
- AppEnvironment (must match FormKiQ installation)
- VpcStackName (if using VPC)
- Select private subnet CIDRs (if using VPC)
Note the OpenSearch Stack Name for FormKiQ configuration
3. FormKiQ Integration
- Select your FormKiQ stack in CloudFormation
- Click "Update Stack"
- Enter the OpenSearch Stack Name
- Optionally enter the VPC Stack Name
- Complete the stack update
OpenSearch Configuration
Storage Planning
Calculate storage requirements using the formula:
<data size> * (1 + number of replicas) * 1.45 = minimum storage requirement
Example for 100GB with 1 replica:
100 * (1 + 1) * 1.45 = 290GB
Shard Configuration
Calculate optimal shard count using:
<storage requirements> * 1.1 / <shard size>
Example for 100GB with 25GB shard size:
100 * 1.1 / 25 = 5 shards
Instance Types
Data Nodes
| Memory Optimized | vCPU | Memory (GiB) | Price Per hour |
|---|---|---|---|
| r6g.large.search | 2 | 16 | $0.167 |
| r6g.xlarge.search | 4 | 32 | $0.335 |
| r6g.2xlarge.search | 8 | 64 | $0.669 |
| General Purpose | vCPU | Memory (GiB) | Price Per hour |
|---|---|---|---|
| t3.small.search | 2 | 2 | $0.036 |
| t3.medium.search | 2 | 4 | $0.073 |
| m6g.large.search | 2 | 8 | $0.128 |
| m6g.xlarge.search | 4 | 16 | $0.256 |
| m6g.2xlarge.search | 8 | 32 | $0.511 |
Dedicated Master Nodes
| Instance count | RAM size | Max shards | Recommended type |
|---|---|---|---|
| 1 – 10 | 8 GiB | 10K | m5.large.search or m6g.large.search |
| 11 – 30 | 16 GiB | 30K | 5.2xlarge.search or c6g.2xlarge.search |
| 31 – 75 | 32 GiB | 40K | r5.xlarge.search or r6g.xlarge.search |
| 76 – 125 | 64 GiB | 75K | r5.2xlarge.search or r6g.2xlarge.search |
| 126 – 200 | 128 GiB | 75K | r5.4xlarge.search or r6g.4xlarge.search |
Kibana Integration
Kibana provides powerful visualization and exploration capabilities for your document data.
Access Configuration
- Default access through FormKiQ 'Admins' group
- System access via opensearch_lambda_role
- Access requires VPN or SSH tunnel setup
Dashboard Access
- Find OpenSearch Dashboards URL in AWS Console
- Configure secure access method (VPN/SSH tunnel)
- Login with appropriate credentials
Access requires VPN or SSH tunnel. See:
API Integration
Available Endpoints
PUT /documents/{documentId}/fulltext
Updates document's full-text metadata in OpenSearch
All FormKiQ API endpoints are case-sensitive
For detailed pricing information and configuration examples, see our Cost Analysis Guide.