Author: FaxCore Technical Engineering Team (Enterprise Solutions Architecture & Systems Engineering)

Published: October 19, 2026 Updated: October 19, 2026 Verified Architecture

Appendix E: File Gateway Specifications

This appendix provides the technical specifications for host application integration via Embedded Codes, Control Files, and multi-instance Custom Gateway XML Configurations.

1. Embedded Codes Syntax

Embedded codes allow mainframe, ERP, or billing applications to insert inline routing directives directly into plain text documents or PCL/PDF print streams. FaxCore's parser extracts and strips these codes before transmission.

Command Structure

Every command sequence must begin with ^[ and end with ^].
Multiple designators can be chained sequentially.
Designators are Case-Sensitive.

^[<Designator><Value>^]

Supported Embedded Code Designators

Code	Parameter	Description & Example
`B`	Billing Code	Assigns project or accounting code. `^[BBillCode1234^]`
`C`	Cover Page Notes	Injects body narrative into the cover page notes section. `^[CThis is an urgent clinical order.^]`
`D`	Destination Address	(Required) Recipient fax number (including country code) or email. `^[D17208704141^]` or `^[Djdoe@contoso.com^]`
`E`	Exclude Cover Page	Suppresses cover page generation (`True` or `False`). `^[ETrue^]`
`G`	Recipient Company	Populates recipient company name. `^[GContoso Pharmaceuticals^]`
`K`	Tracking Key	Indexes transmission with metadata for auditing. `^[KAcct_99812^]`
`M`	Cover Subject	Sets the subject line of the cover page. `^[MPurchase Order 110011^]`
`N`	Recipient Name	Populates recipient contact name. `^[NJohn Jones^]`
`O`	Originator Username	(Required unless Anonymous enabled) Sender's FaxCore username. `^[Olsmith^]`
`P`	Message Priority	Priority integer from `1` (lowest) to `100` (highest). `^[P100^]`
`S`	Sender Name	Populates sender name on cover page. `^[SLinda Smith^]`
`T`	Scheduled Date/Time	Delays delivery to a future timestamp. `^[T10/15/2026 2:00p^]`
`Y`	Include Default Cover	Controls whether user default cover page is attached. `^[YTrue^]`
`Z`	Cover Page Name	Selects a specific named cover page template. `^[ZUrgent_Legal_Cover^]`

Chained Sequence Example

^[D13038704141^[MPurchase Order 110011^[NJohn Jones^[CPlease expedite order!^[Olsmith^[SLinda Smith^[T10/15/2026 1:00p^]

2. Control File Specification

The Control File Gateway monitors drop folders for text-based control files (.ctl) formatted in name:value pairs.

Single-Occurrence Fields

subject:<text> — Cover page subject line.
notes:<text> — Cover page notes narrative.
trackingKey:<string> — Custom accounting tracking key.
priority:<integer> — Priority value (1–100).
senderName:<text> — Sender display name.
senderCompany:<text> — Sender company name.
senderAddress:<string> — Sender fax, phone, or email.
billingCode:<string> — Billing reference code.
coverPageName:<text> — Named cover page template (case-sensitive).
userName:<string> — FaxCore user account owning the job.
nocover:1 — 1 suppresses cover page attachment.

Multi-Occurrence Fields (Broadcast Deliveries)

Can be repeated multiple times to dispatch one document to multiple recipients:

recipientName:<text>
recipientCompany:<text>
recipientAddress:<number> — (Required) Destination fax number.
filename:<path> — (Required) Relative or full path to attached file (.tif, .pdf, .docx).
notification:<email> — Notification receipt address.

Complete Sample Control File

Filename:invoice_8812.pdf
Subject:Monthly Invoice - October 2026
notes:Enclosed is your monthly statement.
trackingKey:INV-8812
nocover:0
senderName:Billing Operations
senderCompany:FaxCore Services
senderAddress:17208702900
userName:billing_svc

recipientName:Acme Accounting
recipientCompany:Acme Corp
recipientAddress:18665551111

recipientName:Finance Dept
recipientCompany:Contoso Ltd
recipientAddress:18665552222

3. Multi-Instance Custom Gateway Configuration

In high-throughput environments requiring distinct directories for different scanners, MFP fleets, or ERP branches, configure custom gateway instances in GatewayAgent.exe.config:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <sectionGroup name="Gateways">
      <section name="TYPE" type="System.Configuration.NameValueSectionHandler"/>
      <section name="controlFile" type="System.Configuration.NameValueSectionHandler"/>
      <section name="embeddedCodes" type="System.Configuration.NameValueSectionHandler"/>
      <section name="embeddedCodesPcl" type="System.Configuration.NameValueSectionHandler"/>
      <section name="embeddedCodesPDF" type="System.Configuration.NameValueSectionHandler"/>
      <section name="SAP" type="System.Configuration.NameValueSectionHandler"/>
      <section name="Oracle" type="System.Configuration.NameValueSectionHandler"/>
      <section name="Xerox" type="System.Configuration.NameValueSectionHandler"/>
    </sectionGroup>
    
    <!-- Custom Multi-Instance Gateways Definition -->
    <sectionGroup name="Customs">
      <section name="XeroxFloor1" type="System.Configuration.NameValueSectionHandler"/>
      <section name="XeroxFloor2" type="System.Configuration.NameValueSectionHandler"/>
    </sectionGroup>
  </configSections>

  <Customs>
    <XeroxFloor1>
      <add key="type" value="Xerox" />
      <add key="baseDirectory" value="xgateway\xerox_fl1" />
      <add key="inboxDirectory" value="xgateway\xerox_fl1\inbox" />
      <add key="relayDirectory" value="xgateway\xerox_fl1\relay" />
      <add key="processDirectory" value="xgateway\xerox_fl1\process" />
      <add key="processedDirectory" value="xgateway\xerox_fl1\processed" />
      <add key="defaultUsername" value="Admin" />
      <add key="allowAnonymousUsers" value="1" />
      <add key="processFileMask" value="*.ctl" />
      <add key="inputFileType" value="TIF" />
      <add key="faxAsRaw" value="1" />
      <add key="includeSenderNotification" value="1" />
      <add key="maxAttempts" value="2" />
      <add key="attemptIntervalSec" value="30" />
    </XeroxFloor1>

    <XeroxFloor2>
      <add key="type" value="Xerox" />
      <add key="baseDirectory" value="xgateway\xerox_fl2" />
      <add key="inboxDirectory" value="xgateway\xerox_fl2\inbox" />
      <add key="relayDirectory" value="xgateway\xerox_fl2\relay" />
      <add key="processDirectory" value="xgateway\xerox_fl2\process" />
      <add key="processedDirectory" value="xgateway\xerox_fl2\processed" />
      <add key="defaultUsername" value="Admin" />
      <add key="allowAnonymousUsers" value="1" />
      <add key="processFileMask" value="*.ctl" />
      <add key="inputFileType" value="TIF" />
      <add key="faxAsRaw" value="1" />
      <add key="includeSenderNotification" value="1" />
      <add key="maxAttempts" value="2" />
      <add key="attemptIntervalSec" value="30" />
    </XeroxFloor2>
  </Customs>
</configuration>

Caution

Unique Base Directories Required Each gateway instance must specify a unique baseDirectory and inboxDirectory. Two gateway profiles must never share the same folder paths, as lock contention will result in processing errors.

Table of Contents