Client reference¶

This page documents every operation of clsGenerate. Four operations are actually called through clsGenerateSoapClient from repository source; the remaining six are documented for completeness with no repository call site.

previewDocument¶

Renders a document package to a PDF byte array for preview, using the caller's package name, XML data, and output profile.

Field	Value
Operation	`previewDocument`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/previewDocument`
Proxy member	`byte[] previewDocument(string inPackage, string inXML, string inOutputProfile, string inApplication)`
Input message	`inPackage`, `inXML`, `inOutputProfile`, `inApplication` (`string`)
Output message	`base64Binary`
Declared faults	None declared
Called by	`DocumentServiceProxy.PreviewPdf(string package, string xml, string profile)` (`Services/SAIF.Services.Web.Proxies/DocumentServiceProxy.cs:34-37`), reached from `DocumentService.GenerateDocument`/`GeneratePdf` (`Services/SAIF.Services/Utilities/Documents/DocumentService.cs:54-63`)
Source	`Services/SAIF.Services.Web.Proxies/DocumentServiceProxy.cs:37`

Input message¶

Part	Type	Required	Bound from	Purpose
`inPackage`	`string`	Not stated in the WSDL	`package` parameter, guarded non-empty	The xPression document package name
`inXML`	`string`	Not stated in the WSDL	`xml` parameter, guarded non-empty	The document data XML
`inOutputProfile`	`string`	Not stated in the WSDL	`profile` parameter, may be `null`	The rendering output profile
`inApplication`	`string`	Not stated in the WSDL	`"xPression Design"` constant	Application/tenant label

Output message¶

The returned PDF byte array is passed through unchanged by PreviewPdf, and DocumentService.GeneratePdf wraps it before returning to its own caller.

Part	Type	Consumed by the caller	Notes
`<return>`	`base64Binary`	Yes	Not determined from source whether a `null` result is checked before it is returned upstream**

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not handled — the exception propagates

Call site¶

webService.previewDocument(package, xml, profile, ApplicationName);

Aspect	Finding
Invocation frequency	Per call
Result cached	No
Timeout at this call site	None — binding defaults apply
Retry at this call site	None

Notes¶

The authored method name is PreviewPdf, but it invokes previewDocument, not previewPDF — the Writer must not conflate the two operations.

categoriesForUser¶

Lists the document categories available to the caller's application.

Field	Value
Operation	`categoriesForUser`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/categoriesForUser`
Proxy member	`ArrayOfString categoriesForUser(ref string inApplication)`
Input message	`inApplication` (`string`, `ref`)
Output message	`ArrayOfString`, plus the echoed `inApplication` part
Declared faults	None declared
Called by	`DocumentServiceProxy.GetCategories()` (`DocumentServiceProxy.cs:43`), reached from `DocumentService.GetCategories` (`Services/SAIF.Services/Utilities/Documents/DocumentService.cs:45-47`)
Source	`Services/SAIF.Services.Web.Proxies/DocumentServiceProxy.cs:43`

Input message¶

Part	Type	Required	Bound from	Purpose
`inApplication`	`string` (`ref`)	Not stated in the WSDL	A local copy of `"xPression Design"`	Application/tenant label; echoed back because the response contract wraps input parts by `ref`

Output message¶

GetCategories sorts the returned array alphabetically with .OrderBy(x => x).ToArray() before returning it.

Part	Type	Consumed by the caller	Notes
`<return>`	`ArrayOfString` (`string[]`)	Yes	A `null` result would throw `ArgumentNullException` from LINQ's `OrderBy`*

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not handled — the exception propagates

Call site¶

var app = ApplicationName;
var categories = webService.categoriesForUser(ref app);
return categories.OrderBy(x => x).ToArray();

Aspect	Finding
Invocation frequency	Per call
Result cached	No
Timeout at this call site	None — binding defaults apply
Retry at this call site	None

Notes¶

A null array from the remote service throws in the LINQ sort rather than in the SOAP layer*.

documentsForCategory¶

Lists the document packages available within a category, for the caller's application.

Field	Value
Operation	`documentsForCategory`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/documentsForCategory`
Proxy member	`ArrayOfString documentsForCategory(ref string inDocumentCategory, ref string inApplication)`
Input message	`inDocumentCategory`, `inApplication` (`string`, both `ref`)
Output message	`ArrayOfString`, plus echoed parts
Declared faults	None declared
Called by	`DocumentServiceProxy.GetPackages(string category)` (`DocumentServiceProxy.cs:49`), reached from `DocumentService.GetPackages` (`Services/SAIF.Services/Utilities/Documents/DocumentService.cs:49-52`)
Source	`Services/SAIF.Services.Web.Proxies/DocumentServiceProxy.cs:49`

Input message¶

Part	Type	Required	Bound from	Purpose
`inDocumentCategory`	`string` (`ref`)	Not stated in the WSDL	`category` parameter, not validated	The category to list packages within
`inApplication`	`string` (`ref`)	Not stated in the WSDL	`"xPression Design"` constant	Application/tenant label

Output message¶

GetPackages sorts the returned array with .ToArray() after an implied sort, matching GetCategories.

Part	Type	Consumed by the caller	Notes
`<return>`	`ArrayOfString` (`string[]`)	Yes	A `null` array would throw in LINQ*

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not handled — the exception propagates

Call site¶

var docCategory = category;
var app = ApplicationName;
var packages = webService.documentsForCategory(ref docCategory, ref app);
return packages.OrderBy(x => x).ToArray();

Aspect	Finding
Invocation frequency	Per call
Result cached	No
Timeout at this call site	None — binding defaults apply
Retry at this call site	None

Notes¶

category is passed to the remote service without validation.

distributeDocument¶

Prints, emails, faxes, or images a rendered document package, according to which distribution channel the caller supplies.

Field	Value
Operation	`distributeDocument`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/distributeDocument`
Proxy member	`void distributeDocument(string inPackage, string inXML, string inPrinter, PlexMode inMode, short inCopies, ScaleMode inScaleMode, string inOutputProfile, string inImportInfo, EmailInfoClass inEmailInfo, FaxInfoClass inFaxInfo, string inIDMPath, PaperTray inTray, DeferredPrintInfoClass inDeferredInfo, string inApplication)`
Input message	See table below
Output message	None — one-way
Declared faults	None declared
Called by	`DocumentServiceProxy.DistributeDocument` (`DocumentServiceProxy.cs:69-83`), `DistributeDocumentDocCenter` (`:105-119`), `PrintDocument` (`:131-146`)
Source	`Services/SAIF.Services.Web.Proxies/DocumentServiceProxy.cs:69,105,131`

Input message¶

Part	Type	Required	Bound from	Purpose
`inPackage`	`string`	Not stated in the WSDL	`docConfig.PackageName`	The xPression document package name
`inXML`	`string`	Not stated in the WSDL	`docConfig.PackageXml`	The document data XML
`inPrinter`	`string`	Not stated in the WSDL	`printer` / `printConfig.Printer`	The target printer name
`inMode`	`PlexMode`	Not stated in the WSDL	Mapped by name via `Helpers.MapEnumByName`, or hard-coded `Simplex` for the image/email overloads	Duplex/simplex print mode
`inCopies`	`short`	Not stated in the WSDL	`copies` / `printConfig.Copies`	Number of copies
`inScaleMode`	`ScaleMode`	Not stated in the WSDL	Mapped by name, or hard-coded `None` for the image/email overloads	Print scaling behavior
`inOutputProfile`	`string`	Not stated in the WSDL	`docConfig.OutputProfile` (`DistributeDocument`) or `docConfig.OutputProfileOverride` (`DistributeDocumentDocCenter`)	The rendering output profile
`inImportInfo`	`string`	Not stated in the WSDL	`imageConfig.ToIDXFileString()`, or `""` for print-only	Imaging import metadata
`inEmailInfo`	`EmailInfoClass`	Not stated in the WSDL	`MapMailMessage(mailMessage)`, or `null` for print-only	Email distribution details — see BR-DOC-001
`inFaxInfo`	`FaxInfoClass`	Not stated in the WSDL	Always `null` in `DistributeDocument`; `MapFaxMessage(faxInfo)` in `DistributeDocumentDocCenter`; `null` for print-only	Fax distribution details — see BR-DOC-002
`inIDMPath`	`string`	Not stated in the WSDL	`idmfilepath` environment setting, or `""` for print-only	Imaging auto-import share path
`inTray`	`PaperTray`	Not stated in the WSDL	Mapped by name, or hard-coded `Tray2` for the image/email overloads	Paper tray selection
`inDeferredInfo`	`DeferredPrintInfoClass`	Not stated in the WSDL	`MapDeferredPrintConfig(deferredPrintConfig)`, or `null` for print-only	Deferred print job metadata
`inApplication`	`string`	Not stated in the WSDL	`"xPression Design"`, or `docConfig.ApplicationName` when non-empty (`DistributeDocumentDocCenter`) — see BR-DOC-003	Application/tenant label

Output message¶

This operation declares no output message.

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not handled — the exception propagates

Call site¶

webService.distributeDocument(
    docConfig.PackageName, docConfig.PackageXml, printer,
    Helpers.MapEnumByName<PlexMode>(printConfig.PlexMode),
    printConfig.Copies,
    Helpers.MapEnumByName<ScaleMode>(printConfig.ScaleMode),
    docConfig.OutputProfile, imageImportSettings,
    MapMailMessage(mailMessage), null,
    imagePath, Helpers.MapEnumByName<PaperTray>(printConfig.PaperTray),
    MapDeferredPrintConfig(deferredPrintConfig), ApplicationName);

Aspect	Finding
Invocation frequency	Per call
Result cached	No
Timeout at this call site	None — binding defaults apply
Retry at this call site	None — there is no idempotency guard, so retrying at a higher layer could print, email, or fax the document twice*

Notes¶

MapFaxMessage dereferences its faxInfo argument without a null check, so a null faxInfo passed to DistributeDocumentDocCenter causes a NullReferenceException before the SOAP call*.
No upstream DocumentService caller was found for the print-only PrintDocument overload; the method appears to be exposed publicly only*.

previewPDF¶

Renders a document package to a PDF byte array, identical in shape to previewDocument but without an output profile parameter. No call site was found in repository source.

Field	Value
Operation	`previewPDF`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/previewPDF`
Proxy member	`byte[] previewPDF(string inPackage, string inXML, string inApplication)`
Input message	`inPackage`, `inXML`, `inApplication` (`string`)
Output message	`previewPDFResult: base64Binary`
Declared faults	None declared
Called by	No call site found in repository source
Source	`Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs:1505`

Input message¶

Part	Type	Required	Bound from	Purpose
`inPackage`	`string`	Not stated in the WSDL	Not applicable — no call site	The xPression document package name
`inXML`	`string`	Not stated in the WSDL	Not applicable — no call site	The document data XML
`inApplication`	`string`	Not stated in the WSDL	Not applicable — no call site	Application/tenant label

Output message¶

Part	Type	Consumed by the caller	Notes
`previewPDFResult`	`base64Binary`	Not applicable — no call site	Not determined from source

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not applicable — no call site

Call site¶

No call site found in repository source.

Notes¶

The wrapper's PreviewPdf method calls previewDocument, not previewPDF, despite the similarity of the two operations; see Notes on previewDocument.

printPDF¶

Prints a raw PDF byte array directly, without going through document rendering. No call site was found in repository source.

Field	Value
Operation	`printPDF`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/printPDF`
Proxy member	`void printPDF(byte[] inFile, string inPrinter, PlexMode inMode, short inCopies, ScaleMode inScaleMode)`
Input message	`inFile: base64Binary`, `inPrinter: string`, `inMode: PlexMode`, `inCopies: short`, `inScaleMode: ScaleMode`
Output message	None — one-way
Declared faults	None declared
Called by	No call site found in repository source
Source	`Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs:1561`

Input message¶

Part	Type	Required	Bound from	Purpose
`inFile`	`base64Binary`	Not stated in the WSDL	Not applicable — no call site	The PDF bytes to print
`inPrinter`	`string`	Not stated in the WSDL	Not applicable — no call site	The target printer name
`inMode`	`PlexMode`	Not stated in the WSDL	Not applicable — no call site	Duplex/simplex print mode
`inCopies`	`short`	Not stated in the WSDL	Not applicable — no call site	Number of copies
`inScaleMode`	`ScaleMode`	Not stated in the WSDL	Not applicable — no call site	Print scaling behavior

Output message¶

This operation declares no output message.

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not applicable — no call site

Call site¶

No call site found in repository source.

Notes¶

Not called; distinct from the print-only path of distributeDocument (PrintDocument), which sends a full document package rather than a raw PDF byte array.

publishDocument¶

Publishes a rendered document and returns a string identifier, echoing its input parts. No call site was found in repository source.

Field	Value
Operation	`publishDocument`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/publishDocument`
Proxy member	`string publishDocument(ref string inDocumentName, ref string inOutputProfile, ref string inXML, ref string inApplication)`
Input message	`inDocumentName`, `inOutputProfile`, `inXML`, `inApplication` (`string`, all `ref`)
Output message	`publishDocumentResult: string`, plus echoed input parts
Declared faults	None declared
Called by	No call site found in repository source
Source	`Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs:1577`

Input message¶

Part	Type	Required	Bound from	Purpose
`inDocumentName`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document to publish
`inOutputProfile`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The rendering output profile
`inXML`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document data XML
`inApplication`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	Application/tenant label

Output message¶

Part	Type	Consumed by the caller	Notes
`publishDocumentResult`	`string`	Not applicable — no call site	Not determined from source

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not applicable — no call site

Call site¶

No call site found in repository source.

Notes¶

Not called; unlike previewDocument, this operation returns a string result rather than a rendered byte array.

previewHTML¶

Renders a document to an HTML preview returned as a byte array, echoing its input parts. No call site was found in repository source.

Field	Value
Operation	`previewHTML`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/previewHTML`
Proxy member	`byte[] previewHTML(ref string inDocumentName, ref string inOutputProfile, ref string inXML, ref string inApplication)`
Input message	`inDocumentName`, `inOutputProfile`, `inXML`, `inApplication` (`string`, all `ref`)
Output message	`previewHTMLResult: base64Binary`, plus echoed parts
Declared faults	None declared
Called by	No call site found in repository source
Source	`Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs:1597`

Input message¶

Part	Type	Required	Bound from	Purpose
`inDocumentName`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document to render
`inOutputProfile`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The rendering output profile
`inXML`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document data XML
`inApplication`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	Application/tenant label

Output message¶

Part	Type	Consumed by the caller	Notes
`previewHTMLResult`	`base64Binary`	Not applicable — no call site	Not determined from source

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not applicable — no call site

Call site¶

No call site found in repository source.

Notes¶

Not called; the wrapper has no HTML-preview equivalent of PreviewPdf.

publishAndReturnDocument¶

Publishes a rendered document and returns the rendered bytes, echoing its input parts. No call site was found in repository source.

Field	Value
Operation	`publishAndReturnDocument`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/publishAndReturnDocument`
Proxy member	`byte[] publishAndReturnDocument(ref string inDocumentName, ref string inOutputProfile, ref string inXML, ref string inApplication)`
Input message	`inDocumentName`, `inOutputProfile`, `inXML`, `inApplication` (`string`, all `ref`)
Output message	`publishAndReturnDocumentResult: base64Binary`, plus echoed parts
Declared faults	None declared
Called by	No call site found in repository source
Source	`Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs:1617`

Input message¶

Part	Type	Required	Bound from	Purpose
`inDocumentName`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document to publish
`inOutputProfile`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The rendering output profile
`inXML`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document data XML
`inApplication`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	Application/tenant label

Output message¶

Part	Type	Consumed by the caller	Notes
`publishAndReturnDocumentResult`	`base64Binary`	Not applicable — no call site	Not determined from source

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not applicable — no call site

Call site¶

No call site found in repository source.

Notes¶

Not called; combines publishDocument's publish semantics with a returned byte array, similar to previewDocument.

outputProfilesForDocument¶

Lists the output profiles available for a named document, echoing its input parts. No call site was found in repository source.

Field	Value
Operation	`outputProfilesForDocument`
SOAP action	`http://localhost:8000/wsDocuments/clsGenerate.asmx?WSDL/outputProfilesForDocument`
Proxy member	`ArrayOfString outputProfilesForDocument(ref string inDocumentName, ref string inApplication)`
Input message	`inDocumentName`, `inApplication` (`string`, both `ref`)
Output message	`outputProfilesForDocumentResult: ArrayOfString`, plus echoed parts
Declared faults	None declared
Called by	No call site found in repository source
Source	`Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs:1653`

Input message¶

Part	Type	Required	Bound from	Purpose
`inDocumentName`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	The document to list output profiles for
`inApplication`	`string` (`ref`)	Not stated in the WSDL	Not applicable — no call site	Application/tenant label

Output message¶

Part	Type	Consumed by the caller	Notes
`outputProfilesForDocumentResult`	`ArrayOfString` (`string[]`)	Not applicable — no call site	Not determined from source

Faults¶

Fault	Surfaces as	Handled at the call site
Generic SOAP fault	`FaultException` / `CommunicationException`*	Not applicable — no call site

Call site¶

No call site found in repository source.

Notes¶

Not called; parallels documentsForCategory/categoriesForUser in shape (ArrayOfString result with echoed ref inputs) but lists output profiles rather than categories or packages.

Coverage checklist¶

Operation	Documented section	Called by
`previewDocument`	`previewDocument`	`DocumentServiceProxy.PreviewPdf`
`categoriesForUser`	`categoriesForUser`	`DocumentServiceProxy.GetCategories`
`documentsForCategory`	`documentsForCategory`	`DocumentServiceProxy.GetPackages`
`distributeDocument`	`distributeDocument`	`DocumentServiceProxy.DistributeDocument`, `DistributeDocumentDocCenter`, `PrintDocument`
`previewPDF`	`previewPDF`	No call site found in repository source
`printPDF`	`printPDF`	No call site found in repository source
`publishDocument`	`publishDocument`	No call site found in repository source
`previewHTML`	`previewHTML`	No call site found in repository source
`publishAndReturnDocument`	`publishAndReturnDocument`	No call site found in repository source
`outputProfilesForDocument`	`outputProfilesForDocument`	No call site found in repository source

Note: Statements marked with * were inferred from code structure or contextual evidence. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources¶

Services/SAIF.Services.Web.Proxies/Service References/Document/clsGenerate.wsdl
Services/SAIF.Services.Web.Proxies/Service References/Document/Reference.cs
Services/SAIF.Services.Web.Proxies/DocumentServiceProxy.cs
Services/SAIF.Services/Utilities/Documents/DocumentService.cs

Client reference¶

previewDocument¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

categoriesForUser¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

documentsForCategory¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

distributeDocument¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

previewPDF¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

printPDF¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

publishDocument¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

previewHTML¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

publishAndReturnDocument¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

outputProfilesForDocument¶

Input message¶

Output message¶

Faults¶

Call site¶

Notes¶

Coverage checklist¶

Related documentation¶

Sources¶