Self Configuring DIP Tags - Document Import Processor - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Document Import Processor

Platform
OnBase
Product
Document Import Processor
Release
Foundation 22.1
License
Standard
Essential
Premier

The following tags are the pre-defined list of tags for a Self Configuring DIP Import Index file. The Import Index file must only contain the following tags. The tags listed are mandatory for a Self Configuring DIP process, unless noted.

Note:

These tags will be pre-configured in the Import Index file. Once generated, the Import Index file should not be altered in any way. These tags are provided as a reference.

Tag

Description

>>>>Self Configuring Tagged DIP<<<<

This tag indicates the start of the Import Index file. All Self Configuring Import Index files must begin with this tag, in this format. This tag indicates to the processor that the file is a Self Configuring DIP file. This tag is included once per Import Index file.

BEGIN:

This tag indicates the beginning of a document. This tag is included once for each document to be processed.

>>DocTypeName:

This tag indicates the OnBase Document Type name. This Document Type must already exist in the importing system. This tag is included once for each document to be processed.

>>DocDate:-

This tag indicates the Document Date. The date must be in the format MM/DD/YYYY. This tag is included once for each document to be processed.

Note:

This is a required tag when using an archiving method of Import.

>>FileOffset:

This tag indicates the offset of the document within a larger file. This tag is included once for each document to be processed.

>>DiskgroupNum:

This tag indicates the number of the Disk Group the document to be processed resides in. The Import archiving method, which imports information from entire disk group volumes, will use the number specified in this tag when importing. This tag will be ignored by DIP processes using In-Place and Normal archiving methods. In the case of an In-Place archiving method, the documents already exist on a Disk Group. With a Normal archiving method, the Disk Group is assigned to the process.

This tag is included once per Import Index file.

>>VolumeNum:

This tag indicates the volume number for the document.

This tag is included once per file name.

>>NumOfPages:

This tag indicates the total number of pages in the file.

Note:

For text files, >>NumOfPages: is used to designate the number of pages that are in one text file. Importing multiple text files as a larger, single document is not supported.

>>FileSize:

This tag indicates the size of the file in bytes.

This tag is included once per file name.

>>DocRevNum:

This tag indicates the document revision number.

DIP processes using the Import archiving method will apply this tag's value as the revision number for the document. However, processes using In-Place or Normal archiving methods only check whether the >>DocRevNum: tag has a nonzero value. If it does, the process searches the destination system for a matching document and adds the imported document as a new revision.

This tag is included once per file name.

>>PhysicalPageNum:

This tag indicates the physical page number of the document.

This tag is included once per file name.

>>ItemPageNum:

This tag indicates the page number of the document. This value begins at 0 and increments by 1 for each additional page. Only image files will have additional pages.

This tag is included once per file name.

>>FileTypeNum:

This tag indicates the file format number for the document.

This tag is included once per file name.

>>ImageType:

This tag indicates the image rotation of the file. Imported documents will have the same rotated value as the exported document. Specify an image rotation of 0, 16, 32, or 48. 0 corresponds to 0 degrees. 16 corresponds to 90 degrees. 32 corresponds to 180 degrees. 48 corresponds to 270 degrees.

This tag is included once per file name.

>>Compress:

This tag indicates the compress mode of text files as specified in the onbase32.ini file.

>>Xdpi:

This tag indicates the horizontal dots per inch for image files.

>>Ydpi:

This tag indicates the vertical dots per inch for image files.

>>TextEncoding

Specifies the text encoding to use for processed files. The value represents the Windows codepage used for encoding, and must be from 37 to 65001.

Note:

If no value is specified, and no Byte Order Mark (BOM) or HTML character set is specified, the Text Encoding configuration option is used.

>>FileName:

This tag indicates the file name and path. This file name and path combined cannot have more than 260 characters.

Note:

When using In-Place archiving, the >>FileName tag is limited to 26 characters, or 80 characters for 64-bit databases.

Note:

This is a required tag when using an archive method of Import or In-Place.

END:

This tag indicates the end of the Import Index file and the beginning of the footer. This tag displays once per input file.

InstallID

This tag indicates the installation ID of the exporting system.

Volume

This tag indicates the following information:

  • Disk Group number

  • Volume number

  • Amount of platter space used

  • Disk Group name

  • Platter Path location

DocCount

This tag indicates the number of documents listed within the Import Index file.

>>DocumentHandle:

The Document Handle of the document is assigned as a System Keyword Type in the importing system. This will be used for retrieval purposes. The Keyword Type must be assigned to the Document Type in the importing system.

Keyword Types and values assigned to the document are listed as tags without the system tag identifier of >>. The Keyword Type must display in the Import Index file as it is configured in the importing system.

Note:

All tags not listed above are assumed by the system to be Keyword Type names. The Keyword Type must exist in the destination system and be spelled exactly the same as the tag. Date Keyword Values must be in mm/dd/yyyy format. Currency Keyword Values must be in $99999999999.99 format.