---
title: Imaging
summary: API reference for Imaging.
status: draft
owner: Technical Writer
last_reviewed: 2026-07-31
library: SAIF.Business.Policy.Audit.ApiCalls
reference_type: package
---

# Imaging

Imaging-channel option payload for Document API distribution, including document metadata, task creation details, and optional Business Online metadata.

> **Compilation status:** This type is defined in `Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionMethod.cs`, which is present in this library's source directory but is **not** listed in the `<Compile>` item group of `SAIF.BOF.Business.Policy.Audit.ApiCalls.csproj`. It is a source-included artifact and is not part of the compiled `SAIF.Business.Policy.Audit.ApiCalls` assembly's public surface.

## Purpose
- Carry the imaging metadata used when a generated document is routed into the imaging system.
- Expose the imaging-specific fields that downstream services use for indexing, visibility, and follow-up task creation.

## Context
- Namespace: `SAIF.Business.Policy.Audit.ApiCalls`
- Assembly/package: `SAIF.Business.Policy.Audit.ApiCalls`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| DistributionMethodType | `public string DistributionMethodType { get; }` | Exposes `Imaging` as the discriminator for this delivery-channel payload. |
| ImageId | `public long ImageId { get; set; }` | Identifier of the imaging record that correlates the distributed document with its stored image.* |
| DocumentDateDays | `public int DocumentDateDays { get; set; }` | Day offset used to compute the imaged document's effective date relative to processing.* |
| PolicyNumber | `public int? PolicyNumber { get; set; }` | Policy number the imaged document is associated with. |
| AgencyNumber | `public int? AgencyNumber { get; set; }` | Agency number associated with the imaged document, used for agency-level indexing. |
| ProducerNumber | `public int? ProducerNumber { get; set; }` | Producer number associated with the imaged document. |
| GroupAssociationCode | `public string GroupAssociationCode { get; set; }` | Code linking the imaged document to a group-policy association.* |
| Spec | `public string Spec { get; set; } //onbase spec, e.g. ONBASE16` | OnBase imaging specification/template identifier (e.g. `ONBASE16`) that controls how the document is indexed. |
| ImageFileCode | `public string ImageFileCode { get; set; } //docTypeGroup` | Document-type-group code used to classify the image in the imaging system. |
| ImageCategoryCode | `public string ImageCategoryCode { get; set; } //docType` | Document-type code used to classify the image within its type group. |
| ImageDocumentTypeCode | `public string ImageDocumentTypeCode { get; set; } //subType` | Document-subtype code providing finer-grained classification of the image. |
| BatchJobName | `public string BatchJobName { get; set; }` | Name of the batch job the imaging submission belongs to, used for tracking and troubleshooting.* |
| ClaimNumber | `public string ClaimNumber { get; set; }` | Claim number the imaged document relates to, when applicable.* |
| CommentText | `public string CommentText { get; set; }` | Free-text comment attached to the imaging record.* |
| CreateUser | `public string CreateUser { get; set; }` | User ID recorded as the creator of the imaging record.* |
| DisplayField2 | `public string DisplayField2 { get; set; } //policy name...` | Secondary display value shown in the imaging system, populated with the policy name. |
| AffiliationId | `public string AffiliationId { get; set; }` | Affiliation identifier used to associate the image with a business affiliation.* |
| MessageId | `public string MessageId { get; set; }` | Correlation identifier for the message/submission that produced this image.* |
| FileExtension | `public string FileExtension { get; set; }` | File extension of the imaged document (e.g. `pdf`), used by the imaging system to store the file correctly.* |
| PolicyName | `public string PolicyName { get; set; }` | Name on the policy associated with the imaged document. |
| PolicyAccount | `public string PolicyAccount { get; set; }` | Account identifier tied to the policy for the imaged document.* |
| AgencyName | `public string AgencyName { get; set; }` | Name of the agency associated with the imaged document. |
| GroupName | `public string GroupName { get; set; }` | Name of the group policy associated with the imaged document, when applicable.* |
| ImageDocumentNameCode | `public string ImageDocumentNameCode { get; set; }` | Code identifying the document's name/title for imaging indexing.* |
| ExternalViewCode | `public string ExternalViewCode { get; set; }` | Code controlling whether and how the image is visible to external viewers.* |
| SystemGeneratedFlag | `public bool SystemGeneratedFlag { get; set; }` | Indicates the document was generated by an automated system rather than created manually.* |
| DiscoveryFlag | `public bool DiscoveryFlag { get; set; }` | Indicates the document is subject to legal-discovery handling.* |
| PolicySecuredFlag | `public bool PolicySecuredFlag { get; set; }` | Indicates the policy is flagged as secured/restricted, controlling access to the imaged document.* |
| AgencyId | `public long AgencyId { get; set; }` | Internal system identifier for the agency, distinct from the business-facing `AgencyNumber`.* |
| ProducerId | `public long ProducerId { get; set; }` | Internal system identifier for the producer, distinct from the business-facing `ProducerNumber`.* |
| PolicyTransactionId | `public long? PolicyTransactionId { get; set; }` | Identifier of the policy transaction that produced this document.* |
| DocumentDate | `public DateTime DocumentDate { get; set; }` | Date the document is considered issued/effective for imaging indexing. |
| ReceivedDate | `public DateTime ReceivedDate { get; set; }` | Date the document was received for imaging processing.* |
| PolicyTerm | `public DateTime? PolicyTerm { get; set; }` | Policy term date associated with the imaged document.* |
| TaskConfig | `public ImagingTaskConfig TaskConfig { get; set; }` | Optional follow-up work-item configuration created alongside the imaged document. |
| BusinessOnline | `public BusinessOnline BusinessOnline { get; set; }` | Optional Business Online portal metadata attached when the document should also appear in the online portal. |

## Behavioral notes
- The class inherits `DistributionMethodType` from `DistributionMethod<Imaging>`.
- `TaskConfig` and `BusinessOnline` nest additional payloads for tasking and portal metadata.

## Constraints and usage notes
- The library forwards these values without local validation or normalization.

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Sources
- `Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionMethod.cs`