---
title: clsImageImport
summary: API reference for clsImageImport.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: SAIF.Services.Imaging.Import
reference_type: package
---

# clsImageImport

`clsImageImport` is the single public type in SAIF.Services.Imaging.Import. It exposes constants and mutable properties for image-import metadata and converts the populated object into the library's newline-delimited `KEY=VALUE` serialization format.

## Purpose
- Hold the metadata fields that describe an image import request.
- Serialize the object's public state through `ToString()`.

## Context
- Namespace: `SAIF.Services.Imaging.Import`
- Assembly/package: `SAIF.Services.Imaging.Import` project, `SAIF.BOF.Services.Imaging.Import` package

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `UseOnBaseDocTypes` | `Public Const UseOnBaseDocTypes As String = "OnBase16"` | Exposes the `OnBase16` literal. |
| `OnBaseTypeClIndemity` | `Public Const OnBaseTypeClIndemity As String = "CL - Indemnity"` | Exposes the `CL - Indemnity` literal. |
| `OnBaseTypeClAdministrative` | `Public Const OnBaseTypeClAdministrative As String = "CL - Administrative"` | Exposes the `CL - Administrative` literal. |
| `OnBaseTypeClFROI` | `Public Const OnBaseTypeClFROI As String = "CL - FROI"` | Exposes the `CL - FROI` literal. |
| `OnBaseTypeClWorker` | `Public Const OnBaseTypeClWorker As String = "CL - Worker"` | Exposes the `CL - Worker` literal. |
| `OnBaseSubTypeCorrespondence` | `Public Const OnBaseSubTypeCorrespondence As String = "Correspondence"` | Exposes the `Correspondence` literal. |
| `OnBaseSubType1502` | `Public Const OnBaseSubType1502 As String = "1502"` | Exposes the `1502` literal. |
| `OnBaseSubTypeSaifCreated801` | `Public Const OnBaseSubTypeSaifCreated801 As String = "SAIF created 801"` | Exposes the `SAIF created 801` literal. |
| `OnBaseSubTypeWcdHistory` | `Public Const OnBaseSubTypeWcdHistory As String = "WCD History"` | Exposes the `WCD History` literal. |
| `BatID` | `Public Property BatID As String = String.Empty` | Stores the value written to the `BATID=` line. |
| `ClaimID` | `Public Property ClaimID As Decimal = 0` | Stores the value written to the `CLAIMID=` line. |
| `ClaimNum` | `Public Property ClaimNum As String = String.Empty` | Stores the value written to the `CLAIMNUM=` line. |
| `CommentText` | `Public Property CommentText As String = String.Empty` | Stores the value written to the `CommentText=` line. |
| `CreateUser` | `Public Property CreateUser As String = String.Empty` | Stores the value written to the `CreateUser=` line. |
| `DiscoveryFlag` | `Public Property DiscoveryFlag As String = String.Empty` | Stores the value written to the `DiscoveryFlag=` line. |
| `DisplayField1` | `Public Property DisplayField1 As String = String.Empty` | Stores the value written to the `DisplayField1=` line. |
| `DisplayField2` | `Public Property DisplayField2 As String = String.Empty` | Stores the value written to the `DisplayField2=` line. |
| `DisplayField3` | `Public Property DisplayField3 As String = String.Empty` | Stores the value written to the `DisplayField3=` line. |
| `DocumentDate` | `Public Property DocumentDate As Date` | Stores the date written to the `DocumentDate=` line when the value is set. |
| `DocumentDateDays` | `Public Property DocumentDateDays As Decimal = 7` | Stores the value written to the `DocumentDateDays=` line when the value is greater than zero. |
| `ImageCategoryCode` | `Public Property ImageCategoryCode As String = String.Empty` | Stores the value written to the `ImageCategoryCode=` line. |
| `ImageDeleteFlag` | `Public Property ImageDeleteFlag As String = String.Empty` | Stores the value written to the `ImageDeleteFlag=` line. |
| `ImageDocumentTypeCode` | `Public Property ImageDocumentTypeCode As String = String.Empty` | Stores the value written to the `ImageDocumentTypeCode=` line. |
| `ImageIndexFlag` | `Public Property ImageIndexFlag As String = "Y"` | Stores the value written to the `ImageIndexFlag=` line. |
| `ImageFileCode` | `Public Property ImageFileCode As String = "CLAIM"` | Stores the value written to the `ImageFileCode=` line. |
| `ImageSeqNum` | `Public Property ImageSeqNum As Decimal = 0` | Stores the value written to the `ImageSeqNum=` line when the value is greater than zero. |
| `NPages` | `Public Property NPages As Decimal = 1` | Stores the value written to the `NPages=` line when the value is greater than zero. |
| `PolicyNum` | `Public Property PolicyNum As Decimal = 0` | Stores the value written to the `PolicyNum=` line when the value is greater than zero. |
| `ReceivedDate` | `Public Property ReceivedDate As Date` | Stores the date written to the `ReceivedDate=` line when the value is set. |
| `SLevel` | `Public Property SLevel As Decimal = 0` | Stores the value written to the `SLevel=` line. |
| `TaskCategory` | `Public Property TaskCategory As String = ""` | Stores the value written to the `TaskCategory=` line. |
| `TaskDate` | `Public Property TaskDate As Date` | Stores the date written to the `TaskDate=` line when the value is set. |
| `TaskMailIDList` | `Public Property TaskMailIDList As String` | Stores the value written to the `TaskMailIDList=` line. |
| `TaskPriority` | `Public Property TaskPriority As String = "MED"` | Stores the value written to the `TaskPriority=` line. |
| `TaskSecurity` | `Public Property TaskSecurity As String = String.Empty` | Stores the value written to the `TaskSecurity=` line. |
| `TaskText` | `Public Property TaskText As String = String.Empty` | Stores the value written to the `TaskText=` line. |
| `ImageDocumentNameCode` | `Public Property ImageDocumentNameCode As String = String.Empty` | Stores the value written to the `ImageDocumentNameCode=` line. |
| `ExternalViewCode` | `Public Property ExternalViewCode As String = String.Empty` | Stores the value written to the `ExternalViewCode=` line. |
| `SystemGeneratedFlag` | `Public Property SystemGeneratedFlag As String = "Y"` | Stores the value written to the `SystemGeneratedFlag=` line. |
| `AgencyID` | `Public Property AgencyID As Decimal = 0` | Stores the value written to the `AgencyID=` line. |
| `ProducerID` | `Public Property ProducerID As Decimal = 0` | Stores the value written to the `ProducerID=` line. |
| `GroupAssociationCode` | `Public Property GroupAssociationCode As String = String.Empty` | Stores the value written to the `GroupAssociationCode=` line. |
| `Spec` | `Public Property Spec As String = String.Empty` | Stores the value written to the `Spec=` line. |
| `PolicyAccount` | `Public Property PolicyAccount As String = String.Empty` | Stores the value written to the `PolicyAccount=` line. |
| `PolicySecuredFlag` | `Public Property PolicySecuredFlag As String = "N"` | Stores the value written to the `PolicySecuredFlag=` line. |
| `AffiliationId` | `Public Property AffiliationId As Long` | Stores the value written to the `AffiliationId=` line when the value is greater than zero. |
| `LegalCaseId` | `Public Property LegalCaseId As Decimal` | Stores the value written to the `LegalCaseId=` line when the value is greater than zero. |
| `LegalCaseNum` | `Public Property LegalCaseNum As String` | Stores the value written to the `LegalCaseNum=` line. |
| `LegalCopyToClaimFlag` | `Public Property LegalCopyToClaimFlag As String` | Stores the value written to the `LegalCopyToClaimFlag=` line. |
| `LegalDistributionFlag` | `Public Property LegalDistributionFlag As String` | Stores the value written to the `LegalDistributionFlag=` line. |
| `ToString` | `Public Overrides Function ToString() As String` | Builds and returns the complete newline-delimited `KEY=VALUE` payload. |

## Behavioral notes
- `ToString()` emits keys in a fixed order defined by the method body.
- `DocumentDate`, `ReceivedDate`, and `TaskDate` serialize in `MM-dd-yyyy` format when populated, as described in [BR-002](../../business-rules.md#br-002-format-optional-dates-as-mm-dd-yyyy-or-blank).
- `DocumentDateDays`, `ImageSeqNum`, `NPages`, `PolicyNum`, `AffiliationId`, and `LegalCaseId` serialize as blank when the value is not greater than zero, as described in [BR-001](../../business-rules.md#br-001-blank-numeric-fields-when-unset).
- Most string-backed properties are serialized even when empty, which preserves the key name in the outbound payload.

## Constraints and usage notes
- The class is mutable; callers can set properties in any order before invoking `ToString()`.
- The library does not validate required fields, legal combinations, or maximum field lengths before serialization.
- Default property values such as `ImageIndexFlag = "Y"`, `ImageFileCode = "CLAIM"`, `TaskPriority = "MED"`, `SystemGeneratedFlag = "Y"`, `NPages = 1`, and `PolicySecuredFlag = "N"` become part of the serialized output unless callers replace them.

## Sources
- `Services\SAIF.Services.Imaging.Import\clsImageImport.vb`
- `Services\SAIF.Services.Imaging.Import\SAIF.BOF.Services.Imaging.Import.vbproj`
- `Services\SAIF.Services.Imaging.Import\SAIF.BOF.Services.Imaging.Import.nuspec`