Skip to main content

v1.19.0

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
  • #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 PDF document certifications

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