2.2.3 Elements

The following table summarizes the set of common XML schema element definitions that are defined by the BDSRR protocol. XML schema element definitions that are specific to a particular operation are described with the operation.

Element

Description

dsc:Dialect

A uniform resource identifier (URI) that represents the current filter.

dsc:Document

An element that represents an individual scan document with a PostScan job.

dsc:Documents

An element that contains zero or more dsc:Document elements that represent all of the documents associated with a PostScan job.

dsc:DocumentDescription

An element that describes the description information of a particular scan document.

dsc:DocumentId

The Id of a scan document within a collection of scan documents that are part of a PostScan job.

dsc:Filter

An element that represents a single filter supported by the scan repository.

dsc:FilterCompletedStatuses

An element that contains the final processing status of all filters in the completed PostScan job.

dsc:FilterConfig

The unique configuration XML for the filter dialect.

dsc:Filters

An element that contains a list of the supported filters for this scan repository.

dsc:FilterState

An element that represents the current processing state of a filter in the current PostScan job.

dsc:FilterStateReason

An element that represents additional detailed information regarding the current processing state of a filter in the current PostScan job.

dsc:FilterStateReasons

A collection of all of the additional detailed information regarding the current processing state of a filter in the current PostScan job.

dsc:FilterStatus

An element that contains the current filter dialect and processing state.

dsc:FilterStatuses

A collection of all of the statuses for all filters in the current PostScan job.

dsc:Format

An element that contains the image file format of the scan document.

dsc:ImagesReceived

An element that contains the total number of scan documents in the current PostScan job.

dsc:JobCompletedState

An element that contains the final state of the PostScan job.

dsc:JobCompletedStateReasons

A collection of all of the additional detailed information regarding the final processing state of a PostScan job.

dsc:JobCompletedTime

An element that contains the amount of time that it took the PostScan job to complete processing.

dsc:JobCreatedTime

An element that contains the amount of time that it took to create the PostScan job.

dsc:JobDescription

An element that contains descriptive information about the PostScan job.

dsc:JobOriginatingUserName

An element that contains the username that initiated the PostScan job.

dsc:JobState

An element that contains the current processing state of a PostScan job.

dsc:JobStateReason

An element that represents additional detailed information regarding the current processing state of the current PostScan job.

dsc:JobStateReasons

A collection of all of the additional detailed information regarding the current processing state of the current PostScan job.

dsc:JobStatus

An element that contains all of the information about the status of a PostScan job.

dsc:JobSummary

An element that contains a subset of status and descriptive information about a PostScan job.

dsc:JobToken

An element that contains a unique identifier for a PostScan job. The identifier is only guaranteed to be unique within the current scan repository.

dsc:PSP_DisplayName

An element that contains the description of the PostScan process that provided the image acquisition settings and instructions of this PostScan job.

dsc:PSP_Identifier

An element that contains the unique identifier of the PostScan process that provided the image acquisition settings and instructions of this PostScan job.

dsc:RepositoryConfiguration

An element that contains the current configuration of the scan repository. This includes a collection of the supported filters.

dsc:RepositoryState

An element that contains the current state of the scan repository.

dsc:RepositoryStateReason

An element that represents additional detailed information regarding the current state of the scan repository.

dsc:RepositoryStateReasons

A collection of all of the additional detailed information regarding the current state of the scan repository.

dsc:RepositoryStatus

An element that contains all of the information about the status of the scan repository.

psp:ContinueOnError

An element that indicates whether to continue running a PostScan job after the job encounters an error.

psp:Dialect

A URI that represents a filter to be invoked while processing a PostScan job.

psp:DocumentRootName

An element that contains a root document name for a PostScan job to use as the basis for the file names that the job generates for the scan documents that it processes.

psp:Filter

An element that contains the identification and instructions for a filter that will process image data in a PostScan job.

psp:FiltersToProcess

A collection of all of the filters that will process image data in a PostScan job.

psp:Instructions

An element that contains filter-specific instructions for configuring a filter in a PostScan job.

psp:PostScanInstructions

An element that contains the instructions for processing the scan documents in a PostScan job.

psp:PostScanProcess

An element that contains all of the information that defines a PostScan Process.

psp:ScanRepository

An element that contains the fully qualified domain name of the scan repository that the scan device uses to process any PostScan jobs created from this PostScan Process.

psp:ScanTicket

An element that contains all the settings that the scan device will use during the image acquisition phase of a scan job.

wscn:AutoExposure

An element that indicates whether the scan service automatically employs image processing techniques to reduce the background of the document to a white image.

wscn:Brightness

An element that indicates the relative amount to enhance or reduce the brightness of the scanned image.

wscn:ColorProcessing

An element that contains the information needed to determine how color is handled for the scan document(s).

wscn:CompressionQualityFactor

An element that contains an integer value used by lossy compression types to determine the amount of acceptable image loss.

wscn:ContentType

An element that specifies the main characteristics of the original document.

wscn:Contrast

An element that indicates the relative amount to enhance or reduce the contrast of the scanned image.

wscn:DocumentParameters

An element that contains all of the image acquisition settings the scan device uses when creating the scan documents in the current PostScan job.

wscn:DocumentSizeAutoDetect

An element that indicates that the scan device try to determine the size of the original scan media.

wscn:Exposure

An element that contains the settings that indicate whether the scan device automatically employs image processing techniques to reduce the background of the document to a white image or adjust the image processing by the values supplied.

wscn:ExposureSettings

An element that contains individual adjustment values that the scan device applies to the image data after acquisition.

wscn:FilmScanMode

An element that indicates the exposure type of the film to be scanned.

wscn:Format

An element that specifies the image file format in which the scan document(s) is created.

wscn:Height

An element that specifies the size of the original media in the slow scan direction on the scan device or the resolution to capture the image in the slow scan direction on the scan device.

wscn:ImagesToTransfer

An element that specifies the number of images the scan device can scan for the current job.

wscn:InputMediaSize

An element that contains the actual size of the original media to be scanned for the current job.

wscn:InputSize

An element that describes the scannable media size and how to detect it.

wscn:InputSource

An element that specifies the physical source of the original media to be scanned into a scan document(s).

wscn:JobDescription

An element that contains the descriptive information about the image acquisition portion of a PostScan job.

wscn:JobInformation

An element that contains the intended use of the image acquisition portion of the PostScan job.

wscn:JobName

An element that specifies the user-friendly name of the image acquisition portion of the PostScan job.

wscn:JobOriginatingUserName

An element that specifies the name of the user who submitted the job.

wscn:MediaBack

An element that contains all of the parameters specific to scanning the Back side of the physical media.

wscn:MediaFront

An element that contains all of the parameters specific to scanning the Front side of the physical media.

wscn:MediaSides

An element that contains the elements unique to each physical side of the media that makes up the scan document.

wscn:Resolution

An element that contains the data that defines the resolution at which to capture the image.

wscn:Rotation

An element that specifies the amount to rotate each image of a scanned document.

wscn:Scaling

An element that contains the scaling factors for both the slow and fast scan directions of the scanned image.

wscn:ScalingHeight

An element that specifies the scaling factor to apply in the slow scan direction on the scan device.

wscn:ScalingWidth

An element that specifies the scaling factor to apply in the fast scan direction on the scan device.

wscn:ScanRegion

An element that specifies the area within the input document boundaries to scan.

wscn:ScanRegionHeight

An element that specifies the size of the scan area in the slow scan direction for this scan document.

wscn:ScanRegionWidth

An element that specifies the size of the scan area in the fast scan direction for this scan document.

wscn:ScanRegionXOffset

An element that specifies the distance from the fast scan lead edge to begin the scanning for this document.

wscn:ScanRegionYOffset

An element that specifies the distance from the slow scan lead edge to begin the scanning for this document.

wscn:Sharpness

An element that specifies the relative amount to enhance or reduce the sharpness of the scanned image.

wscn:Width

An element that specifies the size of the original media in the fast scan direction on the scan device or the resolution to capture the image in the fast scan direction on the scan device.

emlf:EmailAddress

An element that contains a single email address to add to the list of destination email addresses for the scanned images of a PostScan job.

emlf:EmailConfig

An element that contains the instructions to the email processing filter for a PostScan job.

emlf:SendToAddresses

An element that contains the set of destination email addresses that the email processing filter will use to send the scanned images of a PostScan job.

emlf:SendToScanUser

An element that contains a Boolean value that indicates whether the scanned images are be sent through an email to the user who initiates the PostScan job.

fsf:FileShareConfig

An element that contains the instructions to the file share processing filter for a PostScan job.

fsf:FileShares

An element that contains the set of network file locations the file share processing filter will use to save the scanned images for a PostScan job.

fsf:ShareUNC

An element that contains a single network file location that the file share processing filter will use to save the scanned images of a PostScan job.

spf:SaveToMySite

An element that contains a Boolean value that indicates whether the scanned images are to be saved to the MySite SharePoint document library of the user who initiates the PostScan job.

spf:SaveToSharePointSites

An element that contains the set of SharePoint document libraries that the SharePoint processing filter will use to save the scanned images for a PostScan job.

spf:SaveToSharePointSiteURL

An element that contains a single SharePoint document library that the SharePoint processing filter will use to save the scanned images for a PostScan job.

spf:SharePointConfig

An element that contains the instructions to the SharePoint processing filter for a PostScan job.

spx:AllowDeviceFileNameChange

An element that contains a Boolean value that indicates whether the root document name of the current PostScan Process can be modified at the scan device.<3>

spx:AllowDeviceFilePathChange

An element that contains a Boolean value that indicates whether the network file location used by the FileShare filter in the current PostScan Process can be modified at the scan device.<4>