You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/formkiq-modules/modules/filesync-cli.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -181,6 +181,10 @@ The CLI includes a built-in CSV importer for quickly bulk-loading:
181
181
-**Document Content**
182
182
-**Document Attributes**
183
183
184
+
:::note
185
+
When importing large number of documents, you may want to review **[Scaling Components](/docs/platform/overview#scaling-formkiq-components)** to help reduce time to import documents.
186
+
:::
187
+
184
188
### Import Attributes
185
189
186
190
Bulk define or update the metadata fields (attributes) that can later be applied to your documents.
description: High-level overview of the FormKiQ platform, architecture, core capabilities, and design principles.
8
+
tags:
9
+
- formkiq
10
+
- overview
11
+
- architecture
3
12
---
4
13
5
14
# Overview
6
15
7
-
FormKiQ is a **flexibledocument management platform**powered by AWS managed services and serverless technologies. It provides:
16
+
FormKiQ is a **flexible, API-first document management platform**built entirely on AWS managed services and serverless technologies. It is designed for teams that need to store, manage, process, and automate documents at scale without operating traditional document management infrastructure.
8
17
9
-
-**API-first architecture** for document operations
10
-
-**AWS Well-Architected** design principles
11
-
-**Cost-effective** serverless implementation
12
-
-**Scalable** document management capabilities
18
+
FormKiQ provides a composable foundation for document-driven applications, enabling secure storage, rich metadata, event-driven workflows, and full-text search while following **AWS Well-Architected Framework** principles.
These are the core concepts used throughout the FormKiQ platform. Understanding these concepts will help you design document workflows, integrate APIs, and reason about security and scalability.
187
+
188
+
### Documents
189
+
190
+
A **document** is the primary entity in FormKiQ.
191
+
192
+
A document consists of:
193
+
- Binary content (stored in Amazon S3)
194
+
- Metadata and attributes (stored in DynamoDB)
195
+
- A unique `documentId`
196
+
- A virtual path
197
+
198
+
### Sites
199
+
200
+
A **site** represents an isolated namespace within a FormKiQ deployment.
201
+
202
+
- Documents belong to exactly one site
203
+
- Sites enable multi-tenant architectures
204
+
- Access control is enforced at the site level
205
+
206
+
The default site is named `default`.
207
+
208
+
### Attributes
209
+
210
+
**Attributes** are structured key-value pairs attached to documents.
211
+
212
+
- Used for filtering, querying, and automation
213
+
- Can be indexed or non-indexed
214
+
- Support multiple data types
215
+
216
+
Attributes enable documents to behave like structured data while remaining file-based.
217
+
218
+
### How Documents Flow Through FormKiQ
219
+
220
+
- A document is uploaded via the API (inline or presigned S3 upload)
221
+
- Document metadata and attributes are stored in DynamoDB
222
+
- Document content is stored in Amazon S3
223
+
- Events are emitted for document actions via Amazon SNS, SQS, EventBridge
224
+
- Optional workflows process the document (OCR, classification, rulesets)
225
+
- Documents become searchable via metadata and full-text indexing
226
+
227
+
## Scaling FormKiQ Components
228
+
229
+
### Amazon DynamoDB
230
+
231
+
Document metadata, attributes, and indexes are stored in DynamoDB.
232
+
233
+
By default, FormKiQ uses On-Demand capacity mode, which provides:
234
+
• Automatic scaling based on traffic
235
+
• No capacity planning
236
+
• Pay-per-request pricing
237
+
238
+
On-Demand Capacity Throughput Behavior
239
+
Although On-Demand capacity is fully managed, it is not unlimited.
240
+
241
+
DynamoDB On-Demand tables scale automatically up to a service-defined maximum throughput. Scaling is adaptive and based on recent traffic patterns. Under normal conditions, DynamoDB can rapidly increase capacity to handle sudden spikes, but sustained or extreme bursts may temporarily exceed the adaptive scaling window.
242
+
243
+
Key characteristics of On-Demand scaling:
244
+
- Capacity scales automatically based on usage history
245
+
- Sudden spikes are supported, but extremely sharp increases may be throttled
246
+
- Each table and each global secondary index (GSI) scales independently
247
+
- Throughput limits apply at both the table and index level
248
+
249
+
When the adaptive limit is exceeded, DynamoDB returns throttling errors.
250
+
251
+
#### Monitor Capacity
252
+
253
+
You can monitor DynamoDB capacity pressure using Amazon CloudWatch metrics, including:
254
+
255
+
-**ThrottledRequests**: Indicates requests rejected due to insufficient capacity.
256
+
-**ConsumedReadCapacityUnits and ConsumedWriteCapacityUnits**: Shows actual usage and growth trends.
257
+
-**SuccessfulRequestLatency**: Elevated latency can signal capacity saturation.
258
+
-**ReadThrottleEvents / WriteThrottleEvents**: Explicit indicators that DynamoDB limits are being exceeded.
259
+
260
+
#### On-Demand Throughput Maximums and Configuration
261
+
262
+
Although On-Demand mode automatically adjusts throughput to match demand, you can specify maximum read and write throughput limits for each table and its global secondary indexes (GSIs). These limits:
263
+
• Bound capacity usage to help control costs
264
+
• Prevent runaway consumption from unoptimized traffic
265
+
• Safeguard downstream services from unexpected load
0 commit comments