File Starter

File Starter provides three core capabilities for developers:

• Data import
• Data export
• Document export (Word/PDF)
• Document signing

This document focuses on developer usage and API-level examples.

Code Structure

• excel/export/strategy: export strategy selection and concrete export implementations
• excel/export/support: shared export support components such as data fetch, template resolve, writer, upload, and custom export hooks
• excel/imports: import pipeline, handler factory, failure collection, persistence, and custom import hook
• excel/style: shared Excel style handlers
• file/: document file generators and PDF signing helpers (Word, PDF, signing)

Dependency

<dependency>
  <groupId>io.softa</groupId>
  <artifactId>file-starter</artifactId>
  <version>${softa.version}</version>
</dependency>

Requirements

• OSS storage (Minio or other supported providers) for template files and generated files.
• Pulsar is required if you use async import.
• Database contains file metadata tables and file-starter tables:
  • Import: ImportTemplate, ImportTemplateField, ImportHistory,
  • Export: ExportTemplate, ExportTemplateField, ExportHistory,
  • Document: DocumentTemplate,
  • Signing: SigningRequest, SigningDocument.

Configuration

MQ topics (async import)

mq:
  topics:
    async-import:
      topic: dev_demo_async_import
      sub: dev_demo_async_import_sub

OSS Configuration

oss:
  type: minio
  endpoint: http://minio:9000
  access-key: minioadmin
  secret-key: minioadmin
  bucket: dev-demo

Storage Policy

• General path: modelName/uuid/fileName
• Multi-tenancy path: tenantId/modelName/uuid/fileName