Revised: 5.5.2017
ImageRight 6.3 Import XML Templates
XML Sections and Elements Definitions
Contents
ImageRight XML Templates ... 1
XML Sections and Elements Hierarchy ... 2
Location ... 2
Drawer ... 2
File ... 2
Folder... 5
Document ... 8
Page ... 10
XML Sections and Elements Definitions ... 13
ImageRight XML Templates
You can use XML templates to define the manner in which documents, images, files, etc., are processed when they are added to the ImageRight system. The templates are actually XML files that contain the information necessary to manage the creation of tasks, filing options, updating of attributes, and more.
We have compiled this guide to provide information that you can use to create the XML code that will define how incoming items are processed. With a quick look atTable 1: Sections and elements hierarchy on page 2, you can see all the sections and elements that are available. The specifications in this
document are compatible with ImageRight 6.x unless otherwise noted.
Writing XML requires advanced skills, and there are innumerable techniques available for reading and writing XML. It is outside the scope of this guide to explain the intricacies of creating XML code.
The templates that you create can be used to manage items added to the system using:
ImageRight Scanner
ImageRight import processes – COLD File Index
– COLD Name Based – Diary
– File Update
– HP Print with Embedded Index – Note Update
Using templates, you can create and/or update:
File structure
Attributes on the file, folder, and document levels
Folders
Documents
Tasks at any level
Task notes
Diaries with or without tasks at any level
Nested or repeatable folders
Documents (add to any folder given specified criteria)
File marks
Page marks
For more information about using the templates you create, see the ImageRight Enterprise Management Console documentation.
Click an item in the hierarchy to see more information.
XML Sections and Elements Hierarchy
We have listed all the sections and elements in hierarchy form inTable 1, making it easy to see what elements are related to each section. You can click an item inTable 1to jump immediately toTable 2:
Sections and elements definitionson page 13 to see more information.
Table 1: Sections and elements hierarchy
Location
GroupBy
Field
Lookup
Name
Drawer
GroupBy
Field
Lookup
Name
File
Create
Attributes
Attribute
attributeRef
value
fileType
Marks
markRef
option
Name
Note
date
Task
assignedTo
Attributes
Attribute
attributeRef
Click an item in the hierarchy to see more information.
value
availabledate
description
flowName
priority
stepName
Text
User
Number
Part
CreationDisposition
Diary
Create
assignedTo
availabledate
description
noteText
priority
CreationDisposition
Lookup
assignedTo
availabledate
description
priority
ResolutionRule
Update
assignedTo
availabledate
description
noteText
priority
GroupBy
Field
Lookup
Attributes
Attribute
attributeRef
value
fileType
Marks
Mark
markRef
option
Click an item in the hierarchy to see more information.
Name
Number
Part
ResolutionRule
Task
Create
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
CreationDisposition
Lookup
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
ResolutionRule
Update
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
Update
Click an item in the hierarchy to see more information.
Attributes
Attribute
attributeRef
value
Drawer
pathElement
fileType
Marks
Mark
markRef
option
Name
Note
date
Task
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
Text
User
Number
Part
Folder
Create
Attributes
Attribute
attributeRef
value
description
folderType
note
date
Task
assignedTo
Click an item in the hierarchy to see more information.
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
Text
User
CreationDisposition
Diary
Create
assignedTo
availabledate
description
noteText
priority
CreationDisposition
Lookup
assignedTo
availabledate
description
priority
ResolutionRule
Update
assignedTo
availabledate
description
noteText
priority
GroupBy
Field
Lookup
Attributes
Attribute
attributeRef
value
description
folderType
ResolutionRule
Skip
Click an item in the hierarchy to see more information.
Task
Create
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
CreationDisposition
Lookup
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
ResolutionRule
Update
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
Update
Attributes
Attribute
attributeRef
value
Click an item in the hierarchy to see more information.
description
folderType
Note
date
Task
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
Text
User
Document
Create
Attributes
Attribute
attributeRef
value
description
documentDate
documentType
CreationDisposition
Diary
Create
assignedTo
availabledate
description
noteText
priority
CreationDisposition
Lookup
assignedTo
availabledate
description
priority
ResolutionRule
Click an item in the hierarchy to see more information.
Update
assignedTo
availabledate
description
noteText
priority
GroupBy
Field
Lookup
Attributes
Attribute
attributeRef
value
description
documentDate
documentType
ResolutionRule
Skip
Task
Create
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
CreationDisposition
Lookup
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
Click an item in the hierarchy to see more information.
ResolutionRule
Update
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
Update
Attributes
Attribute
attributeRef
value
description
documentDate
documentType
Page
Create
description
Image
imageOptions
ConversionOption
SplitMultipagePdf
Marks
Mark
markRef
option
Diary
Create
assignedTo
availabledate
description
noteText
priority
CreationDisposition
Lookup
Click an item in the hierarchy to see more information.
assignedTo
availabledate
description
priority
ResolutionRule
Update
assignedTo
availabledate
description
noteText
priority
Task
Create
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
noteText
priority
stepName
CreationDisposition
Lookup
assignedTo
Attributes
Attribute
attributeRef
value
availabledate
description
flowName
priority
stepName
ResolutionRule
Update
assignedTo
Attributes
Attribute
attributeRef
value
Click an item in the hierarchy to see more information.
availabledate
description
flowName
noteText
priority
stepName
XML Sections and Elements Definitions
The sections and elements that you can use in your XML templates are defined inTable 2.
You can see the hierarchy of the sections and elements inTable 1: Sections and elements hierarchyon page 2
Table 2: Sections and elements definitions
Sections – Elements Definition
assignedTo Name of user to whom task should be assigned (unassigned by default) Attribute User defined data field used to store additional data at the file, folder,
document, or task level.
attributeRef The name or ID of the attribute field defined in the ImageRight system.
ImageRight Version 4 SP3 and earlier.
When the lookup element is used in conjunction with attributeRef, the attribute ID not the name must be used.
Attributes Collection of attributes to be associated with a file, folder, document, or task.
availabledate The date (UTC Now by default) which the task or diary will be available in ImageRight Desktop. If a future date is used, the task/diary is considered
“rescheduled.”
ConversionOption Use to define conversion applied to images as they are imported.
xs:string
None – keep in native color ConvertToPdf – convert to PDF Default is None.
See alsoimageOptionson page 16.
Sections – Elements Definition
Create Create can be used to create a new instance based on provided data.
Creation will occur if either of the following conditions is satisfied:
Lookup section results in an empty search.
Or
The group by section indicates a need for a new instance.
CreationDisposition Specifies the type of rule to use for creation. Options include:
OpenAlways – open if exists and if not create
CreateNew – create new and if exists present an error
OpenExisting – open existing instance and if not exists present an error
date Note date
DateType Type of retention rule date to be set. These are mutually exclusive. Options include:
CutOffDate RetentionDate
DateValue Retention rule date you want to use (null by default).
description Folder, document, page, task, or diary description. Task and diary descriptions are empty by default.
Diary Used to create a diary at the level in which the Diary element is contained.
Possible levels are file, folder, document, or page.
Document Document level template definition describes rules for document creation and lookup. There can be only one document instance.
documentDate Document date documentType Document type
Drawer Required
Drawer level template definition describes rules for drawer creation and lookup.
Sections – Elements Definition
drawer Used in the Update section of the main File element. If the file needs to be moved to a different drawer, this field is used to do so.
Field Used within the Groupby element to define which field to group the item on.
File Required
File level template definition describes the rules for file creation and lookup.
There can only be one instance of the file level.
fileType File type
flowName Programmatic workflow name
Folder Folder level template definition. Describes the rules for folder creation and lookup. Add additional folders as needed to define nested folders
(sometimes referred to as folders within folders or nested folders).
folderType Folder type
force Use to force the result of GroupBy regardless of values in the index file.
Options include:
xs:string
True – always return true and create a new instance.
False – always return false and use an existing instance.
NotSet – rules are declared in the Field elements.
Freeze Retention rule freeze. Users cannot delete information subject to discovery or make any changes. Options include:
NotSet Set Remove
GroupBy Rules used to determine when to switch the container.
Sections – Elements Definition
Hold Retention rule hold. Documents cannot be inadvertently destroyed.
However, the contents can be updated during the hold period. Options include:
Notset Set Remove
Image Image details (usually the file name) used when creating the page.
imageOptions All images are converted to PDF format
ImportTemplate Root section of the import template. An Import Template contains the instructions by which the imported items will be processed. The template defines the criteria for lookup and creation.
Location Location level template definition describes the location lookup rules.
Location can be omitted if drawer is at the root level. Location must exist in the ImageRight system.
Lookup Use to search for existing instances of the level. Lookup can be used to import items into an existing location, drawer, file, folder, document, task, or diary without creating a new instance.
Mark File mark or page mark.
markRef The ID of the mark defined in the ImageRight system. Typically, querying the PageMarkRef or FileMarkRef is the only wait to get this ID.
Marks Collection of file marks or page marks used for lookup, creation, or update.
Name File name
note Folder note
Note File note
noteText File note text.
Task note text. (empty by default) Diary text description (empty by default) Number File number (can be a multipart file number)
Sections – Elements Definition
option Defines whether the file mark or page mark should be added or removed.
Options include:
ADD REMOVE
Page Page level template definition describes rules for page creation. There can be only one page instance.
Part Individual part in a file number. A file number can have up to three parts as defined in ImageRight Enterprise Management Console.
pathElement Individual parts of the path to the file’s parent drawer.
Example for four path elements:
\\US\Atlanta\Conyers\Claims Example for one path element:
Claims
priority Order of importance 0(highest) – 9 (lowest) assigned to the task or diary.
Default is 5.
ResolutionRule Specifies what type of rule to use when lookup returns multiple items.
Options include:
xs:string
First – return first result Error – error if multiples exist
RetentionDateRule Retention rules that set the cut-off date or the retention date on a specified level.
RetentionRules Retention rules applied at the file, folder, or document level that define how long items will be retained in the ImageRight system.
Skip Use any value that is indicative of skipping the current folder level and importing the content into the level above. The same value shall be provided in the index file for folder types, tasks or diaries.
Sections – Elements Definition
SplitMultipagePdfs Use to split multipage PDFs into multiple single page PDFs.
xs:Boolean True/False Default is False.
stepName Programmatic workflow step name
Task Use to create a task in a workflow associated with the file, folder, document, or page level.
Text Note text
Update Use to update an existing instance, task, or diary based on provided data.
Update will only occur if lookup section results in one item found.
User Note user
value Literal value to be stored in the attribute field or the name of the Parser field which contains the attribute value.
xs:string
literal – literal value
field-ref – Value mapped to a specific field in the index file. If the field is not found, an error will be presented.
