Notes can be automatically added to documents during an Absolute Path XML Index DIP process.
Information about the note (i.e., the Note Type, the location of note on the document, the content of the note) is obtained along with information about the document being imported from the XML Import Index File, so the Field Order of the XML Index DIP process must be configured to identify this information.
Notes cannot be added to documents during a Relative Path XML Index DIP process. If you want to add notes to your documents during import, use an Absolute Path XML Index DIP process.
The following Default Keyword Types are used to add notes to documents during a XML Index DIP process.
|
Default Keyword Type |
Description |
|---|---|
|
>>NoteDate |
Note:
If the >>NoteDate and the >>NoteDateTime Default Keyword Types are used in the same Field Configuration, the value of the Keyword Type that appears last in the XML Import Index File will be saved as the Note Date. If >>NoteDate is located after >>NoteDateTime in the XML Import Index File, the >>NoteDate value will overwrite the >>NoteDateTime value for the Note Date, but the Note Time value will be retained from the >>NoteDateTime Default Keyword Type. The date that the note was created (i.e., the Note Date). By default, this value is set to the date the XML Index DIP process was performed if this Default Keyword Type is not assigned to the Field Configuration of the Document Type. Note:
Note Date and Note Time information is automatically included in the note's header. If this Default Keyword Type is used, the Note Time in the header is automatically set to 0:00:00 AM. It is considered a best practice to use the >>NoteDateTime Default Keyword Type instead of the >>NoteDate Default Keyword Type if possible. |
|
>>NoteDateTime |
Note:
If the >>NoteDate and the >>NoteDateTime Default Keyword Types are used in the same Field Configuration, the value of the Keyword Type that appears last in the XML Import Index File will be saved as the Note Date. If >>NoteDate is located after >>NoteDateTime in the XML Import Index File, the >>NoteDate value will overwrite the >>NoteDateTime value for the Note Date, but the Note Time value will be retained from the >>NoteDateTime Default Keyword Type. The date and time that the note was created. Values for the >>NoteDateTime Default Keyword Type must be in the MM/DD/YYY HH:MM:SS format in the XML Import Index File. Note Time values must be entered using a 24-hour clock (i.e., 13:00:00 for 1:00:00 PM). By default, this value is set to the date the XML Index DIP process was performed if this Default Keyword Type is not assigned to the Field Configuration of the Document Type. |
|
>>NoteUser |
The user number of the user who created the note. Note:
If a >>NoteUser in the index file does not exist in your OnBase system, an error will occur during the XML Index DIP process. |
|
>>NoteUserName |
The username of the user who created the note. Note:
If a >>NoteUserName in the index file does not exist in your OnBase system, an error will occur during the XML Index DIP process. |
|
>>NotePageNumber |
The page number of the document to which the note is to be added. By default, this value is set to the first page of the document if this Default Keyword Type is not assigned to the Field Configuration of the Document Type. |
|
>>NoteText |
The body text of the note. To add carriage return, enter the string \n in the location of the return in the text. If this Default Keyword Type is not assigned to the Field Configuration of the Document Type or if this Default Keyword Type is left blank in the XML Import Index File, the default text configured for the note is displayed. If no default text is configured for the Note Type, the note is left blank. |
|
>>NoteXCoordinate |
The horizontal location of the note on the page, measured in 1/100 of an inch. For text documents, this is the column in which the note is displayed. Note:
This value is ignored if it contains an invalid value for the document. It is also ignored for OLE documents because notes must be opened from the Status Bar of the viewer in which the OLE document is displayed. |
|
>>NoteYCoordinate |
The vertical location of the note on the page, measured in 1/100 of an inch. For text documents, this is the row in which the note is displayed. Note:
This value is ignored if it contains an invalid value for the document. It is also ignored for OLE documents because notes must be opened from the Status Bar of the viewer in which the OLE document is displayed. |
|
>>NoteType |
The Note Type # of the Note Type that is to be created. Note:
The >>NoteType Default Keyword Type must be placed after all other note-defining Default Keyword Types in the XML Import Index File. Any note-defining Default Keyword Types placed after this value are ignored by the processor, and the default values for these settings will be used. |
These Default Keyword Types are assigned to an XML Index DIP Field Order configuration like other Keyword Types or Default Keyword Types.