Skip to content

OnBaseKeywordSync console application documentation

OnBaseKeywordSync is a .NET Framework 4.6.2 console executable built on SAIF.Framework.Windows that reads unprocessed OnBase keyword-sync work items from the Imaging API, pushes the corresponding keyword updates into OnBase over a SOAP (WCF) keyword-update service, and marks each processed record complete.

Field Value
Executable OnBaseKeywordSync.exe
Framework SAIF.Framework.Windows (.NET Framework v4.6.2)
Runner class Program : SaifStandardProgramBase<ConsoleBase<ArgumentContainer>, ArgumentContainer>
Application class OnBaseKeywordSyncRunner : ConsoleBase<ArgumentContainer>
Argument container ArgumentContainer : StandardArgumentContainerBase<ArgumentContainer>

Documentation sections

Section Description
Overview Purpose, invocation, scheduling, and capability summary
Architecture Layer diagram, component responsibilities, and design constraints
Run lifecycle Execution flow from Main through Initialize/Execute/Finish
Arguments Command-line argument contract, syntax, validation, and exit behavior
Configuration Environment API settings, database configs, and app.config surface
Dependencies Libraries, packages, APIs, and database connections
Operations and processes End-to-end processing workflows
Business rules Rules enforced during processing
Operational runbook Invocation, scheduling, logs, exit codes, error recovery
Tech debt CRITICAL and HIGH severity findings

Embedded libraries

None — single-project repository. OnBaseKeywordSync/OnBaseKeywordSync.sln declares exactly one project (OnBaseKeywordSync.csproj), with no <ProjectReference> elements and no local libraries.

Sources

  • OnBaseKeywordSync/OnBaseKeywordSync.csproj
  • OnBaseKeywordSync/OnBaseKeywordSync.sln
  • OnBaseKeywordSync/Program.cs
  • OnBaseKeywordSync/OnBaseKeywordSyncRunner.cs