backoffice-documentation-ews
Deployment package for the HP Exstream Engine Web Service (EWS), a WCF wrapper around the HP Exstream document-composition engine used for back-office document generation.
Health score
0 to 100 across seven weighted factors; nothing is hidden. Green is 75 and above, amber 50 to 74, red below 50. How scoring works.
Facts
| Languages | csharp |
| Frameworks | WCF (wsHttpBinding), ASP.NET Web Services |
| Runtimes | .NET Framework 3.5 era |
| Tests / CI | none / CI in place |
| Last commit | 2017-11-08 |
| Owner | Owner unknown (mapping to be curated) |
| Domain | Bookings and fulfilment (system generated; curate in repo-owners.json to override) |
| Product area | Phenix |
| Hosted | No signal No hosting signal in its pipelines (typical for libraries and contract packages) |
| Releases | 1 release pipeline(s): EWS Release |
| Integration | wcf, soap |
| Source | Open in Azure DevOps |
Risk flags
Each flag links to its glossary definition.
Dependencies in context
Entanglement
loosely attached Bound into the core by 1 mechanism(s).
- Speaks WCF (host)
Detaches when its WCF surface gains a modern interface or its WCF calls move to one.
Depends on / used by
Migration playbooks
Generated from this repo's assessment data: what is feasible, what blocks it, and the steps in order. Ratings: green means actionable now, amber means sequence other work first, red means blocked, grey means not applicable.
ZDD adoption
A long roadTechnically eligible one day, but the blockers are structural: hosted WCF or SOAP contracts that cannot run two versions at once, or heavy legacy coupling. Sequence the modernisation work first. Hosts WCF or SOAP endpoints: strict serialization contracts cannot safely run two versions at once (the shared-enum trap). End-of-life runtime compounds the work.
- 1 system(s) depend on this repo; during a rolling deploy they will talk to old and new versions at once, so responses must stay compatible
- Adopt the four-stage discipline from the ZDD engineering standard: pre-deployment compatibility, deployment, feature activation behind a flag, post-release cleanup.
- Raise automated test coverage first: ZDD trades the end-of-sprint manual gate for continuous automated confidence, so the tests are the entry ticket.
- Make every change dual-version safe: backwards-compatible APIs (new major version for breaking wire changes), expand and contract for any schema change, and consumers tolerant of unknown fields.
- Wrap behaviour changes in feature flags so code deploys dark and release becomes a business decision, not a deployment event.
- Use ECS rolling deployments with health checks gating traffic, and take this service off the three-week release train.
- Verify with area-scoped regression rather than the whole-platform cycle, and watch error rates after rollout with automated rollback on alert.
SQL Server exit
Not applicableNo SQL Server dependency is recorded for this repo. Nothing to migrate.
Containerisation
Feasible after replatformingAppropriate eventually, but not from here: the legacy runtime and the hosted WCF surface both have to go first, and that work is already in this repo's recommended actions.
- .NET Framework only runs on Windows; practical (Linux) containers need modern .NET
- Hosts WCF or SOAP endpoints, which have no home on modern .NET; consumers need a modern interface first
- Replatform to modern .NET first (see the recommended actions), replacing the hosted WCF/SOAP surface with REST, gRPC or messaging so consumers can follow. Containerising then becomes routine.
- Add a Dockerfile and make the app read all configuration from environment variables and the secrets manager, never from machine-local files.
- Log to stdout and expose a health check endpoint so ECS can supervise it.
- Adopt the shared ci.yml pipeline template with the container parameters (awsRegion, containerAfterBuild, ecsTerraformRepo), which is exactly how the estate's existing AWS services deploy.
- Define the service in the Terraform repo, deploy to a non-production environment, then shift traffic and disarm the deployment-group release pipeline.
Recommended actions
Rotate the credentials committed to backoffice-documentation-ews
Risk flags indicate credentials or keys in source (hardcoded-secrets). Rotate now and enable secret scanning in CI; this is independent of all other work.
Impact: Closes a live security exposure at near-zero cost
proposedReplatform backoffice-documentation-ews to modern .NET
Runs on .NET Framework 3.5 era, out of mainstream support. No pinning dependency blocks it; sequence by fan-in (providers before consumers).
Impact: Unblocks 1 dependent system(s)
proposedAssessment notes
backoffice-documentation-ews
Purpose
Hosts the HP Exstream (now OpenText Exstream) Engine Web Service — vendor software (EWS v2.0.0010.0082) that exposes the Exstream document-composition engine (ProdEngine_dbcs.exe, engine 16.2.1) over WCF for generating documents (PDF, RTF, HTML email, DOCX, etc.) for back-office processes.
Tech stack
- Compiled binaries only:
dist/bin/EWSService.dllplusEngineService.svc(WCF service host, C# code-behind referenced but not present). - Config indicates .NET Framework 2.0/3.5-era assemblies; hosted in IIS with Windows authentication.
- No source code in the repo — it is purely a deployment artifact with per-environment
Web.*.configtransforms (dev, qa, preprod, ukmanphe5, ukmanphe6).
Deployment
Included as a prod application with 1 release. Build pipelines: "backoffice-documentation-ews CI" and "backoffice-documentation-ews release". Release pipeline: "EWS Release".
Dependencies
- Internal: none identifiable from the repo contents.
- External: HP Exstream engine installed on the host (
C:\HPEngine\...paths for engine executable, packages, DDA files, output). Product key is embedded in config.
Data stores
None. The service reads/writes to local file-system directories (working, package, output directories) on the Windows host.
Integration points
- WCF SOAP endpoint (
wsHttpBinding, no-security binding) atEngineService.svc, consumed by other back-office document services. - MEX metadata endpoint exposed.
Code health
- No source code, no tests, no readable build definition in the repo.
- Last commit 2017-11-08 — dormant for ~9 years.
- Environment-specific configs contain a hard-coded product key.
Modernisation risks
- Vendor binary on an end-of-life .NET Framework runtime; cannot be rebuilt from this repo.
- WCF/SOAP with security disabled on the binding; Windows-host file-share coupling.
- Any Exstream upgrade or Windows Server migration requires vendor engagement; high risk, no test safety net.