Notes can be automatically added to documents during a DIP process.
Information about the note (i.e., the Note Type, the location of the note on the document, and the content of the note) is obtained along with information about the document being imported from the Import Index file, so the Field Order of the DIP process must be configured to identify this information.
The following Default Keyword Types are used to add notes to documents during a 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 Import Index file will be saved as the Note Date. If >>NoteDate is located after >>NoteDateTime in the 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 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 Value instead of the >>NoteDate Default Keyword Value 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 Import Index file will be saved as the Note Date. If >>NoteDate is located after >>NoteDateTime in the 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 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 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 DIP process. |
|
>>NoteUserName |
The username of the user who created the note. The username is used even if the Display Real Name instead of User Name Global Client Setting is enabled. Note:
If a >>NoteUserName in the index file does not exist in your OnBase system, an error will occur during the 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 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. |
|
>>NoteTypeNumber |
The Note Type # of the Note Type that is to be created. Note:
The >>NoteTypeNumber or >>NoteTypeName Default Keyword Type must be placed after all other note-defining Default Keyword Types in the 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. |
|
>>NoteTypeName |
The name of the Note Type that is to be created. Note:
The >>NoteTypeName or >>NoteTypeNumber Default Keyword Type must be placed after all other note-defining Default Keyword Types in the 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 a Tagged or Ordered DIP Field Order configuration like other Keyword Types or Default Keyword Types.
For more information on Field Order Configuration, see Tagged DIP Field Order Configuration or Tagged DIP Field Order Configuration.
While an Ordered DIP process can be used to add notes to documents during the import process, an Ordered DIP process would require the same number of notes to be applied to each document assigned to a Document Type. Because this might not always be desired or possible, it is considered a best practice to use a Tagged DIP Process when adding notes to documents during a DIP process.