Integration Frameworks
Integration Frameworks are separately scoped commercial offerings for FormKiQ Advanced and Enterprise. They connect document workflows to enterprise systems using metadata mappings, events, synchronization configuration, and additional API endpoints where required by the target system.
A framework defines the relationship between documents and business records. It is distinct from a Document Gateway, which brings documents into FormKiQ, and a capability module, which extends document processing or discovery.
Integration types
| Framework | Typical document relationship |
|---|---|
| ERP | Purchase orders, invoices, vendor documents, contracts, and financial transactions. |
| CRM | Accounts, opportunities, onboarding, proposals, and customer agreements. |
| HRIS | Employee records, onboarding, acknowledgments, and offboarding documents. |
| Case management | Case files, evidence, correspondence, review decisions, and case-level access. |
| Custom applications | Organization-specific records and workflows connected through FormKiQ APIs and events. |
Frameworks can be used with packaged Business Solutions. Implementation configures the target system's data model, document relationships, rules, and interfaces. A listed framework does not imply that every vendor or version is supported without scoping.
Agree the integration contract
- Identify the source of truth for each business field and document state.
- Define identifiers and metadata mappings, including update and deletion behavior.
- Specify event triggers, synchronization direction, retry behavior, and duplicate handling.
- Map identities, permissions, and the documents each system may access.
- Define audit records, reconciliation, monitoring, and operational ownership.
- Test the complete workflow, including errors, recovery, and permission changes.
Use document events and actions, workflows, and the API reference for platform mechanisms. System-specific endpoints and credentials are supplied for the scoped integration; they are not implied additions to the public Core API.
Commercial and data boundaries
Confirm the edition, framework, selected capability modules, external-system licenses, backend versions, and implementation scope together. External systems can receive documents and metadata under their own processing, storage, and access terms.
See editions and licensing, the integration overview, and Commercial Deployment Notes.