Skip to main content

v1.19.0

Release Summary​

FormKiQ 1.19.0 delivers major improvements across document lifecycle management, governance, access control, metadata, search, and automation. The release introduces artifact-enabled documents, allowing generated outputs, OCR results, signed copies, exports, and other related files to remain connected to their source documents and participate in common document operations and workflows.

FormKiQ Core gains filename and folder search through POST /search, date filtering for deleted documents, stronger metadata validation, and new checksum, move, and delete actions. The standard commercial platform adds expanded retention and disposition, document reviews, managed short links, controlled delegated access, and artifact-aware antivirus and OCR processing. The release also introduces initial data models for the Contract Management Business Solution and expands optional AI, Document Generation, and E-Signature capabilities.

FormKiQ Core​

Connected Document Artifacts​

FormKiQ 1.19.0 introduces artifact-enabled documents for managing files related to or derived from an original document. Generated documents, OCR outputs, signed copies, exports, and other related content can remain connected to the source document rather than being managed as unrelated files.

Artifacts support their own metadata, categories, and versions and can participate in common document operations, including uploads, document URLs, tags, attributes, restoration, purge, retry, reindexing, and workflows. Artifacts can also be promoted when a derived file needs to become the primary document.

Improved Document Discovery​

The Core POST /search endpoint now includes filename and folder search indexes. Applications can search for documents by filename or folder and issue queries that list all files contained within a folder without requiring the optional Enhanced Search module.

Searches across soft-deleted documents can also be filtered using start and end dates, making it easier to investigate deletion activity and locate documents within the Trash.

Document Automation​

New document actions provide additional building blocks for automated document processing:

  • CHECKSUM calculates and stores SHA-1, SHA-256, or SHA-512 checksums from document content.
  • SHA-512 checksum validation can be applied when generating document upload URLs.
  • MOVE moves documents through an asynchronous document action.
  • DELETE deletes documents through an asynchronous document action.
  • ASYNC_COMPLETE provides a completed status for asynchronous actions and workflows.

These actions allow checksum verification, document movement, and deletion to be incorporated into rulesets and workflows.

Metadata and Data Management​

Regular-expression validation can now be applied to document attributes, helping organizations maintain consistent metadata formats and reject invalid values.

The release also adds classification conditionals to mappings and PUT support for entity types and entities, making configuration and data-model deployment easier to automate and maintain.

Authentication and Administration​

Administrators can configure Cognito access-token and refresh-token validity periods to align session duration with their organization's security and usability requirements.

FormKiQ 1.19.0 also adds automatic SSO sign-in configuration, clearer user-claim, role, and site-permission mapping information, Network ACL support in the FormKiQ VPC template, and additional reserved governance and AI-related attribute keys.

Standard Commercial Platform​

Retention and Disposition​

FormKiQ 1.19.0 expands the retention and disposition capabilities included with the commercial platform. Organizations can associate documents with retention and disposition policies, calculate retention periods, and schedule disposition actions as part of a governed document lifecycle.

Disposition policies can be represented using managed entities and referenced through document schemas and metadata. A scheduled process evaluates eligible documents and performs the configured disposition actions.

Document Reviews​

New document-review APIs support the creation, retrieval, and updating of document reviews. These capabilities provide a foundation for approval, verification, periodic review, and controlled-document processes.

Controlled Delegated Access​

Site delegation tokens provide downscoped and on-behalf-of access. Applications can grant a user or service controlled, temporary authority to perform defined operations without giving that party the delegating user's complete permissions.

This supports service integrations, assisted administration, temporary access, and workflows in which one user is authorized to act on behalf of another while preserving appropriate audit context.

The new ShortLinks API allows applications to create shorter, managed document links. A short link resolves through FormKiQ and redirects the user to a temporary document access URL.

This makes document links easier to include in applications, notifications, emails, QR codes, and other interfaces without exposing long temporary access URLs.

Antivirus and OCR​

Antivirus scanning and OCR have been updated to support document artifacts. Artifacts can now pass through ClamAV antivirus scanning; receive artifact-specific malware results, object tags, action statuses, and document events; be processed through OCR using Amazon Textract; store detected text and related processing outputs against the appropriate artifact; and produce artifact-aware CSV and PDF OCR outputs.

This allows original documents and their related files to follow consistent scanning and OCR processes while remaining part of the same document record.

Contract Management Business Solution​

FormKiQ 1.19.0 introduces initial preset data models for the Contract Management Business Solution. These models provide structured representations for agreements and related contract-management information.

Contract Management is packaged as a Business Solution rather than as a general platform capability or technical processing module. It builds on FormKiQ's document, entity, metadata, workflow, review, retention, and access-control capabilities to support contract-specific processes.

Optional Modules​

AI Processing and Analysis​

The AI Processing and Analysis module adds capabilities for discovering and administering supported Amazon Bedrock models. Administrators can view model availability, lifecycle, authorization, entitlement, regional, and invocation information and accept required model agreements.

The release also adds AI prompt result mapping, analysis categories, model selection for prompt entities, maximum-token configuration, and structured mapping of AI-generated results into document metadata and business data.

These capabilities provide the foundation for AI-assisted extraction, classification, sensitivity analysis, document analysis, and related workflows.

Document Generation​

The Document Generation module can now insert JPG and PNG images into generated documents using append or prepend placement.

It also adds certificate-based PDF signing using PKCS#12 certificates stored securely in AWS Secrets Manager. Generated and signed outputs can remain associated with their source documents through the artifact model.

E-Signature​

The E-Signature module adds artifact support to DocuSign envelope creation. Applications can create envelopes using document artifacts and retain artifact-aware envelope attributes and webhook processing.

Signed copies and other DocuSign outputs can therefore remain connected to the source document and be managed as part of the same lifecycle.

A More Connected Document Lifecycle​

Together, these improvements allow organizations to manage more of a document's lifecycle within a single connected record. Source documents, OCR results, generated outputs, signed copies, exports, and other derived files can remain associated while moving through scanning, indexing, review, approval, retention, disposition, and automation processes.

FormKiQ 1.19.0 combines these lifecycle improvements with more flexible search, stronger metadata controls, controlled delegated access, configurable authentication, and new document actions. The result is a stronger foundation for document management, records management, Contract Management, AI-assisted processing, and application-specific document workflows.

Upgrade Notes​

  • The Cognito App Client Managed login pages configuration under Login pages may be reset during upgrade. If you use SSO, record those settings before upgrading and re-apply them after the upgrade completes.
  • The CloudFormation output AuthApiUrl has been renamed to UserAuthApiUrl. If you have hard-coded AuthApiUrl, update your configuration to use UserAuthApiUrl. If you use the certificate CloudFormation template, update that template before applying the 1.19.0 upgrade.

FormKiQ Core (v1.19.0)​

Feature​

  • #450 Added filename and folder search indexes to POST /search, enabling folder-name searches and queries that list all files in a folder
  • #480 Added artifact-enabled documents, including artifact metadata, artifact categories, hasArtifacts, document artifact promotion, and artifact-aware upload, URL, OCR, tags, attributes, restore, purge, retry, reindex, and workflow support
  • #484 Added start and end date support when searching soft-deleted documents
  • #489 Added SSO automaticSignIn to system configuration
  • #473 Added CHECKSUM document actions that calculate and persist SHA1, SHA256, or SHA512 checksums from document content, with SHA512 also supported when generating document upload URLs for S3 checksum validation
  • #496 Added classification conditionals to mappings
  • #500 Added validationRegex support for consistent document attribute values
  • Added MOVE and DELETE document actions and ASYNC_COMPLETE action status
  • Added PUT support for entity types and entities
  • Added CloudFormation configuration for setting Cognito access token and refresh token validity
  • Added NACL support to the VPC template

Updates​

  • Updated Console to 4.1.1
  • Updated FormKiQ client dependency to 1.19.0
  • #366 Updated Java runtime to JDK 25
  • Refactored OpenAPI generation into reusable templates and path files
  • Refactored Gradle modules into layered directories
  • Updated local Docker stack versions for Console, Keycloak, Typesense, MinIO, and DynamoDB
  • Updated GitHub Actions to use OIDC
  • Added Schemathesis testing
  • Stopped using SSM dynamic references in CloudFormation templates
  • Enabled Container Insights on the ECS cluster
  • Added userClaims, roles, and site permission mapping details to GET /sites
  • Added retentionAndDisposition to /sites/{siteId}/configuration
  • Added deletedDate to soft-deleted documents and remove it on restore
  • Added reserved governance and LLM attribute keys including Sensitivity and LlmMaxToken
  • Improved DynamoDB contention handling and config table read caching

Bug Fixes​

  • #455 Added documentId to GSI1 of the folder index
  • #466 Fixed CloudFront configuration before the S3 bucket is populated
  • #485 Fixed DELETE /entities/{entityTypeId}/{entityId} not-found errors returning the wrong ID
  • #507 Fixed file extension detection for dotted paths without extensions
  • #509 Fixed POST /documents/compress failures on documents with artifacts
  • #515 Fixed document attribute values with multi-byte characters exceeding the DynamoDB key byte limit
  • #519 Fixed hard-deleting one soft-deleted document removing other soft-deleted documents from GET /documents?softDeleted=true results
  • #458 Fixed child document tags and attributes not being saved on POST

FormKiQ Platform (v1.10.0)​

Feature​

  • #168 Added site delegation tokens for downscoped and on-behalf-of access through POST /sites/{siteId}/delegationTokens
  • #199 Added initial contract management preset entities
  • #217 Added ASYNC_COMPLETE workflow action status and expanded workflow attribute-comparison conditions
  • #219 Added document review handlers for GET, POST, and PATCH /documents/{documentId}/reviews
  • #183 Added entity-based disposition support using a new DispositionPolicy PRESET entity type, schema references through the DispositionPolicy attribute key, required pairing with RetentionPolicy, inherited retention date basis, and nightly scheduler execution of disposition actions
  • #180 Added the ShortLinks API, enabling applications to create managed short URLs with POST /shortlinks, return shortened document URLs when requesting format=short, and resolve public GET /s/{slug} links with a temporary redirect to the stored destination URL
  • Added system inference model management endpoints: GET /system/inferenceModels lists available Bedrock-backed inference models with lifecycle, agreement, authorization, entitlement, region, and invocation metadata, while POST /system/inferenceModels/agreement lets administrators accept the required model usage agreement by modelId
  • Added document AI prompt endpoints, including prompt result mapping and analysis category support

Updates​

  • Added ModelId and LlmMaxToken support to LLM prompt preset entities
  • Updated Platform module builds to Java 25

Bug Fixes​

  • #221 Fixed OpenSearch insertedDate being overwritten by non-document records
  • Fixed legacy User Activity document cleanup for artifact fields
  • Fixed site-permissions-defined test coverage
  • Fixed EventBridge Scheduler Lambda packaging location

Antivirus (v1.7.0)​

Feature​

  • Added document artifact support to ClamAV scanning and malware-scan APIs
  • Added artifact-aware malware result records, action status updates, S3 object tagging, and document events

Updates​

  • #35 Updated ClamAV layer to 1.4.4
  • Updated Antivirus module build to Java 25 and GraalVM native-image 25

Document Generation Module (v1.2.0)​

Feature​

  • #21 Enabled adding JPG and PNG images to generated documents using append and prepend placement
  • #24 Added POST /documents/{documentId}/certifications for certificate-based PDF signing using PKCS#12 certificates stored in AWS Secrets Manager

Updates​

  • Updated Document Generation module build to Java 25
  • Updated Document Generation Docker image to AWS Lambda Java 25

E-Signature Module (v1.2.0)​

Feature​

  • Added document artifact support to DocuSign envelope creation
  • Added artifact-aware DocuSign envelope attributes and webhook event processing

Updates​

  • Updated E-Signature module build to Java 25 and GraalVM native-image 25

OCR (v1.7.0)​

Feature​

  • #45 Added document artifact support to OCR processing
  • Added artifact-aware Textract OCR output storage, PDF detected-text updates, and CSV export handling

Updates​

  • Updated OCR module build to Java 25