ImageNow Content Modeling

Transcription

1 ImageNow Modeling Upgrade Guide ImageNow Version: 6.7. x Written by: Product Documentation, R&D Date: August 2012

2 2012 Perceptive Software. All rights reserved CaptureNow, ImageNow, Interact, and WebNow are trademarks of Lexmark International Technology SA, registered in the U.S. and other countries. Perceptive Software is a stand-alone business unit within Lexmark International Technology SA. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or any other media embodiments now known or hereafter to become known, without the prior written permission of Perceptive Software.

3 Table of s About upgrading to content models... 5 Documents in Projects: versions 6.6 and earlier... 5 Documents in Folders: version Folder rename terminology... 6 What happens when I upgrade?... 6 What happens to documents?... 6 What is a document name?... 7 What happens to documents in projects?... 7 What is a shortcut?... 7 What happens to projects?... 8 What is a path?... 8 Functional changes to folders... 9 Folder Viewer... 9 Searching in Folder Viewer... 9 What can go in a folder? Deleting and restoring folders Moving content to folders Views view columns Folder content views Document views Project and folder views Application plans Capture profiles Auditing Security s Folder type s Application plan s s Document type s Reports Documents Modified Audit report ImageNow Modeling Upgrade Guide Page 3 of 24

4 ImageNow data source External interfaces and utilities Message Agent iscript Integration Server INTool INUpgradeUtil ImageNow Modeling Upgrade Guide Page 4 of 24

5 About upgrading to content models This document details the modifications for content modeling in ImageNow after upgrading to version 6.7, including user interface, client behavior, security implications, and external ImageNow interfaces. Read this document to understand the differences between earlier versions of ImageNow and version 6.7 with regard to content models. modeling is an optional feature of ImageNow 6.7 that provides a mechanism for indexing the contents of a drawer into a folder hierarchy, as opposed to the standard model of assigning properties, such as document keys, to documents. As you begin to implement content models in your organization, you will likely use two different document strategies: one in which you organize documents in a drawer based on the standard set of index keys, and one in which you file documents and folders into a hierarchy within a drawer. The indexing strategy you choose depends on the content organization needs of each drawer in your ImageNow system. Review this document to understand the implications of either preserving an indexing strategy based on document keys or adopting a content modeling indexing strategy. When you choose to adopt a content model for a drawer, review the Modeling for Administrators Getting Started Guide, available on the Perceptive Software website. Documents in Projects: versions 6.6 and earlier Prior to 6.7, projects functioned as follows: You could reference a document in any number of projects. Documents were unique in ImageNow based on their document key combinations. To re-index a document, you had to change one or more of the document s keys. Projects were not tied to drawer security in any way, and had their own project-centric security. When you deleted a project, you removed the association with the documents it contained, but the documents still remained in ImageNow. You could choose to not have your documents in any projects at all. Documents in Folders: version 6.7 When you upgrade to 6.7, projects continue to group documents together in the same method as previous versions, but are renamed to folders. When you adopt a content model for a drawer and create a folder hierarchy, folders have the following functional differences, compared to projects: For drawers that use a content model, documents must be filed in a single folder. The drawer s folder hierarchy limits the types of folders and documents you can file in the drawer and determines where you can file a document. Deleting a folder permanently removes the folder and all its contents (including subfolders and their contents) from ImageNow. You can re-index a document in a content model by moving the document to a new folder in the hierarchy. A document is unique to ImageNow based on its path or location in the folder hierarchy and its name. ImageNow Modeling Upgrade Guide Page 5 of 24

6 Folder rename terminology The following table contains a list of the terminology used in previous versions of ImageNow, as compared to version 6.7. Previous term Projects Project types Project Viewer Project type views Document properties: Folder Tab Field 3 Field 4 Field 5 term Folders Folder types Folder Viewer Folder content views Document properties: Field1 Field2 Field3 Field4 Field5 What happens when I upgrade? ImageNow preserves all document data, drawer, project type, and document type configurations prior to the upgrade. This section outlines the upgrade behavior of documents and projects in version 6.7. What happens to documents? If you did not previously associate documents with projects, documents continue to function as they did in prior versions. After the upgrade, you notice the following appearance changes to documents: The document keys are renamed according to the Folder rename terminology table values. A new property, document name, appears for each document, and uses the document s unique ID as its value. ImageNow preserves backward compatibility with previous document key names, so that all scripts and API calls configured prior to 6.7 continue to function as expected. ImageNow Modeling Upgrade Guide Page 6 of 24

7 What is a document name? When you upgrade to 6.7, each document in your ImageNow system is automatically assigned a name that matches its document ID. To file a document in a folder hierarchy that is part of a content model, you must assign a name to the document that does not match its document ID. The document name indicates content modeling status as follows: Documents with a name that matches its document ID are outside the content model, indexed using the standard set of document keys. Documents assigned a name that does not match its document ID enter the content model defined for the drawer and become filed in the folder hierarchy. Because assigning a name to a document enters the document into a content model, by default, the document name is not editable. To assign a name to a document, the ImageNow administrator must grant the Rename for the drawer that uses a content model. What happens to documents in projects? If you associated documents with projects prior to version 6.7, your folder-document relationships function similarly to project-document relationships after the upgrade: All documents associated with a project remain in their original drawers. A shortcut to each document associated with the legacy project appears in the folder. After the upgrade, you can continue to change document property values, including the drawer value, by editing the document keys, until you assign a name to a document and file it in the folder hierarchy. What is a shortcut? A shortcut is a pointer to a document or folder within other folders in your ImageNow environment, separate from its actual folder location. When you upgrade to 6.7, all documents associated with a project in an earlier version of ImageNow become document shortcuts in the associated folder. Each shortcut is automatically assigned a name based on the target document s ID, such as Shortcut to 301YTD3_0001Y5JGG Shortcuts function as follows: You can reference content in multiple folders using shortcuts. You can rename, delete, or move a shortcut without affecting the target content. The actions you can perform for the target document or folder using its shortcut depend on the s associated with the content. When you delete content, you also delete any shortcuts that reference it in other folders. When searching the contents of a folder, shortcuts appear in the search results. You can search specifically for shortcuts in ImageNow Folder Viewer. You can create shortcuts in any folder stored in a drawer for which you have the Create Shortcuts. ImageNow Modeling Upgrade Guide Page 7 of 24

8 What happens to projects? After you upgrade to version 6.7, the projects function as follows: All configured projects are renamed to folders. The Folders drawer is visible in ImageNow, and the upgrade files all folders created from projects in this drawer. Because each folder created from a project and stored in the Folders drawer must have a unique path, ImageNow creates new parent folders for any converted projects that have matching names. ImageNow names the new parent folder based on the associated project type value. All configured project types are renamed to folder types. Folder types retain all components previously configured for project types, including required document types, custom properties, views, and capture profiles. After the upgrade, you can create folder hierarchies for the drawers that benefit from a content model, and file these folders into the hierarchy for these drawers. Like documents in a content model, folders are unique in ImageNow based on the assigned name and folder location, or path. What is a path? Each document or folder path is unique and specifies the folder location in your ImageNow system where the content is filed. The path contains the drawer and folder levels where the content is stored, as well as the name of the content. After you create the folder hierarchy and file your content into folders, the Path property might appear as follows: type Document Folder Path after filing in content model AP\Vendor Invoices\AAA Concrete\2012\Invoice AAACO AP\Vendor Invoices\AAA Concrete\2012 Path represents \Folder Level 1\Folder Level 2\Folder Level 3\Document Name \Folder Level 1\Folder Level 2\Folder Name In the above example, the folder is the 2012 folder and the document is an invoice stored in the 2012 folder. Shortcuts also have paths, but a shortcut s path only includes the drawer and folders levels where the shortcut is filed, and do not include the shortcut name. ImageNow Modeling Upgrade Guide Page 8 of 24

9 Functional changes for folders This section outlines the differences in user interface and functional behavior when you complete the upgrade to 6.7. Folder Viewer The ImageNow Project Viewer appears as ImageNow Folder Viewer in 6.7. The Folder Viewer includes two tabs: and Tasks. Whereas previously the Documents tab displayed all documents in a project, the tab now displays all viewable folder contents. The Tasks tab shows all tasks associated with the folder you have open in Folder Viewer. When you select a subfolder or folder shortcut on the tab of Folder Viewer, the Actions pane shows the following: A section of actions you can perform for the active folder open in Folder Viewer. A section of actions you can perform for the subfolder selected on the tab. Folder sections in the Actions pane are identified by the folder name. Searching in Folder Viewer The contents of the folder display on the tab. In the Search pane, you can search for documents, folders, and shortcuts in the folder based on search conditions you define. You can also search within the subfolders associated with the folder. The Quick Search feature is not available for folder content searching. ImageNow Modeling Upgrade Guide Page 9 of 24

10 What can go in a folder? Whereas a project could only contain documents, a folder can contain documents, shortcuts, and subfolders, as long as each has a unique name. In the Type column, icons indicate the types of content in the folder. Represents folders Represents shortcuts to folders Represents documents Represents shortcuts to documents Deleting and restoring folders When you delete a folder in ImageNow, the folder, its contents, and any shortcuts to the folder are permanently removed. To delete a folder, the ImageNow administrator must grant the following s: The ability to delete content in the associated drawer The ability to use the associated folder type (and all subfolder types) The ability to delete documents of the specified type If denied any of the above s, you cannot delete the folder. You can only recover deleted folders and their content if your administrator configures ImageNow File System Agent to preserve deleted folders in the recycle bin for a specified interval. Deleted folders (including those in the recycle bin) and their contents do not appear in folder or document searches. A restored folder retains all its original attributes, including all content, associated tasks, workflow queues, folder shortcuts, and prior location. Moving content to folders In versions 6.6 and earlier, the Add to Project and Remove from Project features allowed you to add document associations to and remove document associations from a project. In version 6.7, to add content to a folder, you must move it from its current location to the target folder. To move content to folder location in a content model, the ImageNow administrator must grant the following s: The ability to move content in the drawer. The ability to create or append content in the the drawer associated with the new folder location. Dragging content from ImageNow Explorer into an active ImageNow Folder Viewer creates a shortcut in the active folder. ImageNow Modeling Upgrade Guide Page 10 of 24

11 Views This section outlines the changes to Views in ImageNow as they relate to content models. view columns In ImageNow Explorer, the following new columns appear in the search results grid for the following types of views. View type Column Description Appears by default Document Name The name of the document Yes Folder The drawer in which the folder is filed Yes Task Document name The name of the document associated with the task No Workflow Type The document type or folder type associated with the workflow item Workflow Name The name of the document or folder associated with the workflow item Yes Yes Folder content views In ImageNow Folder Viewer, the following columns appear in the search results grid for folder content views, previously known as project type views. Column Type Type Name Field1 Field2 Field3 Description Icon represents whether the item is a document, document shortcut, folder, or folder shortcut. The document or folder type. If shortcut, the target document s document type or target folder s folder type. The name of the document, folder, or shortcut. The drawer in which the content is filed. Within the open folder, all documents and subfolders have the same drawer value. However, because shortcuts show the properties of their targets, the drawer values for shortcuts might be different. The Field1 value for the document. If the item is a document shortcut, the Field1 value of the target document. If the item is a folder or a folder shortcut, this column value is blank. The Field2 value for the document. If the item is a document shortcut, the Field2 value of the target document. If the item is a folder or a folder shortcut, this column value is blank. The Field3 value for the document. If the item is a document shortcut, the Field3 value of the target document. If the item is a folder or a folder shortcut, this column value is blank. ImageNow Modeling Upgrade Guide Page 11 of 24

12 Column Field4 Field5 Description The Field4 value for the document. If the item is a document shortcut, the Field4 value of the target document. If the item is a folder or a folder shortcut, this column value is blank. The Field5 value for the document. If the item is a document shortcut, the Field5 value of the target document. If the item is a folder or a folder shortcut, this column value is blank. Document views When you upgrade to ImageNow version 6.7, your document views and filters that included document key columns appear according to the new document key name scheme. Because all documents are stored in a folder or drawer, the In Project column no longer appears for document views. If the view or filter included a custom label for the document key column, the upgrade preserves these column names. Project and folder views When you upgrade to ImageNow version 6.7, the project views you had in previous versions become folder views, including the All Projects and My Recycled Projects default views. By default, new folder views include the column. For existing views, you can optionally show this column. Application plans If your application plans included enabled document maps, the upgrade creates context maps that file the document in a drawer location using document key values. The context map continues to function identically to your legacy document map. If your application plans included enabled project maps, the upgrade creates a folder in place of the project and creates shortcut maps that file document shortcuts in the specified folder. If your application plans included both enabled document maps and enabled folder maps, the upgrade creates a new context map in place of the document map and a shortcut map in place of the project map. To map the projects correctly, the upgrade creates a shortcut in the new folder s location (when the upgrade is complete, all folders appear in the Folders drawer). Capture profiles After the upgrade, your capture profiles continue to capture documents to the specified drawer locations and file the documents using document key values. If you want to continue capturing documents to a drawer location using these capture profiles, you do not need to modify them. To capture documents to a location within a content model, the ImageNow administrator must define new capture profiles or modify the existing capture profiles. For more information, refer to the Modeling for Administrators Getting Started Guide, available on the Perceptive Software website. ImageNow Modeling Upgrade Guide Page 12 of 24

13 Auditing The following auditing additions or modifications appear in version 6.7 to support content modeling functions: Any audit template that used the Document Move action continues to create audit entries any time a user modifies a document property value; however, the audit action appears as Update instead of Move. The Move action audits any time a user moves content to a new folder. The predefined Document Move condition audits any time a user moves content to a new folder. A new audit category appears for Shortcuts. Using this category, you can audit any time a user creates, deletes, renames, or moves a document or folder shortcut. A new audit category appears for s. Using this category, you can audit any time user adds content to or removes content from a drawer. If you use Business Insight, these auditing changes appear on the Documents Modified Audit report after you upgrade to 6.7. Refer to the Reports section of this document for more information. Security Because you associate folder hierarchies with drawers, you now secure folders and their contents with drawer security. As a result, many s that previously appeared in global categories now appear in drawer categories. s The following table outlines modifications for s that were previously in global categories. Previous name Previous location Previous category Description name location category Description View s Projects open a project. Open s open documents and folders in the drawer. Create s Projects create a project. Create/ Append s create documents, folders, and shortcuts in the drawer. Delete s Projects delete a project. Delete s delete documents, folders, and shortcuts in the drawer. ImageNow Modeling Upgrade Guide Page 13 of 24

14 Previous name Previous location Previous category Description name location category Description Edit Properties s Projects change folder name, type, and custom property values. Edit Type Edit s s edit the document or folder type value. edit the drawer value for documents not in a content model. Edit Custom Properties s edit a document or folder s custom property values. Edit Status s Folders change a folder s status. Add Documents s Projects add documents to a project. Create Shortcuts s create shortcuts in folders. Remove Documents s Projects remove documents from a project. Remove Shortcuts s remove a shortcut from a folder. Interact for Office Projects s Search search for projects in Interact for Office. Interact for Office Folders s Search search for folders in Interact for Office. Project Types s Manage manage project types. Folder Types s Manage manage folder types. Project Views s Manage User has the ability to create, delete or modify project views and project relationship views. Folder Views s Manage User has the ability to create, delete or modify folder views and folder relationship views. ImageNow Modeling Upgrade Guide Page 14 of 24

15 Folder type s Project type s will work the same way they did prior to 6.7, but they will be called folder type s. The following folder type modifications support content modeling functions: The Search controls a user s ability to search for any type of content in a specified drawer, including folders. If a user or group was granted the Use for a folder type in 6.6 or earlier, the user or group is automatically granted the Search on the Folders drawer in version 6.7, the drawer in which all legacy projects appear after the upgrade. If the user or group was denied the folder type, it will also be denied the drawer. Application plan s The within an application plan that enables you to automatically create a project when linking documents using the application plan, Auto Create Projects, will continue to work the same way it did prior to version 6.7, but it will be called Auto Create Folders. s Because a content model stores folder hierarchies in drawers, folder contents are also subject to drawer security. Modified drawer s The following s, previously in different security locations and categories, have been modified: Previous name Previous location Previous category Old description name location category Description Open Documents open documents in the drawer. Open open documents and folders in the drawer. Search Documents search for documents in the drawer. Search search for documents, folders, and shortcuts in the drawer. Create/ Append Documents create documents in the drawer and append pages to documents. Create/ Append create new documents, folders, and shortcuts in the drawer. ImageNow Modeling Upgrade Guide Page 15 of 24

16 Previous name Previous location Previous category Old description name location category Description Delete Documents delete documents in the drawer Delete delete a document, folder, or shortcut in the drawer. Edit Custom Properties Documents change a custom property value for a document in the drawer. Edit Custom Properties change a custom property value for a document or folder in the drawer. Add Documents Projects add documents to a project. Create Shortcuts create shortcuts in folders. Remove Documents Projects remove documents from a project. Remove Shortcuts remove a shortcut from a folder. Two new categories appear in the window: and Folders. in the category apply to any content type in the drawer: documents, folders, or shortcuts. in the Documents category only apply to documents in the drawer. in the Folders category only apply to folders in the drawer. ImageNow Modeling Upgrade Guide Page 16 of 24

17 drawer s The following drawer s are new for version 6.7. Privilege category name Description Move move a document, folder, or shortcut in the current drawer to a folder in the same drawer, or a folder in a new drawer, if the user has the Create/Append for the target drawer. Rename change the name value of a document, folder, or shortcut. Edit drawer change the value of the drawer for documents that are not part of a folder hierarchy, move documents to another drawer, or move documents to the subfolders of another drawer. Edit type change the document type or folder type value. Folders Edit status change a folder s status to active or inactive. granted during upgrade Because several global project s were transitioned to drawer-level folder s, ImageNow upgrades these s as follows for the Folders drawer in version 6.7, the drawer in which all legacy projects appear after upgrade: If user or group was previously granted the global Create for projects, the user or group is automatically granted the Create/Append for the Folders drawer. If the user or group was previously granted the global Delete for projects, the user or group is automatically granted the Delete for the Folders drawer. If the user or group was previously granted the global View for projects, the user or group is automatically granted the Open for the Folders drawer. If the user or group was previously granted the global Edit Properties for projects, the user or group is automatically granted the Rename, Edit Type, and Edit Custom Properties for the Folders drawer. If the user or group was denied any of the above projects s, those s are also denied at the drawer level at upgrade time. To enable s on additional drawers, the ImageNow administrator must grant or deny the s manually. The upgrade does not apply these modifications on all drawers; however, in version 6.7 you can add drawers to a migration package, so you can configure drawer s in a test environment and migrate them to a production environment. ImageNow Modeling Upgrade Guide Page 17 of 24

18 Editing document keys The Edit Keys in the Documents category now enables the user to change the values of Field1 through Field5 only. If a user or group was previously granted the Edit Keys for documents in a drawer, the user or group is automatically granted the following s for the same drawers during the upgrade: Edit in the category Edit Type in the category Edit Keys in the Document category After the upgrade, you can change the drawer value of documents without restriction. However, after you name a document and file it in a folder in a drawer s folder hierarchy, you cannot directly edit the document s drawer value. You must move the document to a folder in the drawer you want. and document type conflicts If the following s are granted for content in the drawer but denied for a specific document type, the user cannot perform the action: Edit Edit Type Edit Custom Properties Edit Keys Document type s The following s have been added to the document type categories: Edit Edit Type The Edit Keys in the Documents category now enables the user to change the values of Field1 through Field5 only. The Edit only applies to documents that are not yet part of a content model. Although the following s were moved to the category for drawer s, they function the same way for document types as they did in earlier versions. Edit Custom Properties Open Create/Append ImageNow Modeling Upgrade Guide Page 18 of 24

19 Reports When you upgrade Business Insight to version 6.7, the project reports in your library appear the same; however, additional reports renamed for foldering will also appear in your library. After you upgrade and import the new report library, you can decide whether to keep or archive the reports from the 6.5 or 6.6 library. Pre Document Types in Projects ImageNow Project Type Security Project Tasks Due in Specified Days Projects with Incomplete Tasks Project Queue Entry to First View Projects Entering Queues per Hour Projects Remaining in Queue After Specified Interval Projects Remaining in Workflow After Specified Interval Queue Cycle Time for Projects Workflow Project Time on Hold Workflow Cycle Time by Project Type Total Queue Time from Project First View to Route Out Document Types in Folders ImageNow Folder Type User Security ImageNow Folder Type Group Security Folder Tasks Due in Specified Days Folders with Incomplete Tasks Folder Queue Entry to First View Folders Entering Queues per Hour Folders Remaining in Queue After Specified Interval Folders Remaining in Workflow After Specified Interval Queue Cycle Time for Folders Workflow Folder Time on Hold Workflow Cycle Time by Folder Type Total Queue Time from Folder First View to Route Out Any report that previously listed document keys now lists both the document keys (Field1 through Field5) as well as the document name. Documents Modified Audit report The Documents Modified Audit report reflects any changes to document key values using the new audit condition components outlined in the Auditing section of this document. If your auditing templates are configured to the auditing condition combination for document key changes prior to 6.7, the report might return inaccurate audit entries. Using the following audit condition components, the Documents Modified Audit report displays the document property values before and after they were modified: Category: Document Action: Update Object: Document ImageNow Modeling Upgrade Guide Page 19 of 24

20 You do not need to make any report modifications to view the new audit entries; however, your ImageNow administrator must add this audit condition to your audit templates. Documents that users deleted from ImageNow appear on the report based on the following audit condition components: Category: Document Action: Send to Recycle Bin, Restore, and Delete Object: Document Documents that a user deleted and then restored appear as two separate audit entries: one for sending the item to the recycle bin, one for restoring the document. ImageNow data source The Administrative namespace of the Data Source View package have been modified to accommodate the changes outlined in the Security section of this document. All administrative security reports in the ImageNow library use the newly named and categorized s after the upgrade. These security changes might affect your custom reports as follows: If your report library includes custom reports that use the security s outlined in the security section of this document and you want to view the new s, your report author must upgrade these reports to use the new model query subjects from the Data Source View package. If your report author does not modify your custom reports, you can continue to successfully run and schedule these reports; however, the s that appear on the report will not accurately match the s in Management Console. The following namespaces of the Business Logic View package has been modified to accommodate the folder and document key modifications outlined in this document. Document Capture Fact Star Schema Document Star Schema Folder Star Schema Task Star Schema Workflow Star Schema All reports in the ImageNow library use the newly named folder and document key terminology and folder hierarchy taxonomy rules after the upgrade. These terminology changes might affect your custom reports as follows: If your report library includes custom reports that use the previous project terminology and document key taxonomy and you want to use the new folder hierarchy taxonomy, your report author must upgrade these reports to use the new model query subjects from the Business Logic View package. If your report author does not modify your custom reports, you can continue to successfully run and schedule these reports; however, the folders and document properties that appear on the report will not accurately match those in ImageNow. Any reports that used data items in the Project Star Schema continue to function with the same behavior prior to the upgrade. ImageNow Modeling Upgrade Guide Page 20 of 24

21 External interfaces and utilities To support content models, several modifications in Message Agent, iscript, and Integration Server appear after the upgrade. Message Agent All Message Agent operations that performed actions for projects continue to perform the same actions for folders; however, additional folder-specific operations appear after the upgrade. For example, the PROJECT_TYPE_GET_ALL operation and all transactions that use it remain unchanged after the upgrade; however, you can perform new transactions that use the FOLDER_TYPE_GET_ALL operation, which uses the same parameters, renamed to folder. The following Message Agent operations have been created or modified to support content modeling functions: Operation or parameter ARRAY_OF_SHORTCUTS DOCUMENT_ADD_TO_FOLDER DOCUMENT_NAME DOCUMENT_REMOVE_FROM_FOLDER DOCUMENT_SET_NAME DRAWER_WITH_CREATE_PRIV_GET_LIST FOLDER_CREATE_SHORTCUTS FOLDER_DELETE FODLER_DELETE_SHORTCUTS FOLDER_GET_DOCUMENT_ID_BY_PATH FOLDER_GET_FOLDER_ID_BY_PATH FOLDER_GET_DOCUMENTS FOLDER_GET_OBJECT_BY_PATH Description of change Holds an array of SHORTCUTS to a target document or folder. This method adds a document shortcut to the specified folder. Name that uniquely identifies the document in its folder. This method removes a document shortcut from the specified folder. This method renames the document. This operations returns the drawers for which a user is granted the Create/Append and can add content. This operation creates a shortcut to a specified target folder or document in the designated folder. This operation now deletes the specifed folder and all its contents. This operation removes a shortcut to a specified target document or folder from the designated folder. This operation searches for a document based on its hierarchical folder path and returns the document's unique ID. This operation searches for a folder based on its hierarchical folder path and returns the folder's unique ID. This operation returns the document shortcuts that are associated with the specified folder. This operation searches for a document, folder, shortcut, or drawer based on its hierarchical folder path and returns its unique ID and type. ImageNow Modeling Upgrade Guide Page 21 of 24

22 Operation or parameter FOLDER_GET_PATH_FOR_OBJECT FOLDER_MOVE_OBJECT_BY_PATH HIERARCHY_OBJECT HIERARCHY_PATH FOLDER SHORTCUT Description of change This operation searches for a document, folder, shortcut, or drawer based on its unique ID and returns the full hierarchical folder path, beginning with the drawer. This operation moves a document or a folder to a folder location based on the path specified. Note that moving a folder also moves any subfolders, documents, and shortcuts within the folder. Consists of HIERARCHY_OBJECT_ID, a unique ID string representing a target drawer, document, folder, or shortcut and HIERARCHY_OBJECT_TYPE_CLASS, the class of object type, which indicates whether the object is a drawer, document, folder, or shortcut. Represents the complete hierarchical path to a document, folder, or shortcut in ImageNow. Each element represents a folder level in the hierarchy, beginning with the drawer. Represents an ImageNow folder object. Represents an ImageNow shortcut object. iscript All iscript document imaging objects that performed actions for projects continue to perform the same actions for folders; however, additional folder-specific objects appear after the upgrade. For example, the INProject object and all scripts that use it remain unchanged after the upgrade; however, you can develop new scripts that use the INFolder object, which uses the same methods, renamed to folder. The following document imaging objects in iscript have been created or modified to support content modeling functions: Objects Method, constructor, or function Description of change INDocument getinfo This method now returns the document name as part of the response. getpath getdocbypath move movebypath setname This method returns the hierarchical path associated with the document. This method uses the hierarchical path to return the document. This method moves the document to a new folder. This method moves the specified document to a new drawer or folder location, based on the specified path. This method renames the document. INFolder adddocument This method adds shortcuts to the original document in the specified folder. ImageNow Modeling Upgrade Guide Page 22 of 24

23 Objects Method, constructor, or function getdoclist getpath getfolderbypath removedocument move movebypath Description of change This method now returns the list of target documents associated with the document shortcuts in the folder. This method returns the hierarchical path associated with the folder. This method uses the hierarchical path to return the folder. The method removes document shortcuts to the specified folder. This method moves the folder and its contents to a new folder or drawer. This method moves the specified folder to a new drawer or folder location, based on the specified path. INShortcut All The INShortcut object enables you to add shortcuts to or remove shortcuts from a folder and return additional information about a shortcut. INView viewcategory If the viewcategory parameter of the contructor is FOLDERCONTENT, the viewid returns the folder ID and viewname returns the folder ID. searchinpath searchinpath This method runs the specified folder content view based on the path to the folder in the hierarchy or the folder ID. The searchinsubfolder argument enables you to search within the subfolders of the folder specified and return the subfolder results in the view. Integration Server The following API operations have been created to support content modeling functions: Operation PUT: /document/{id}/name DELETE: /folder/{id} POST: /folder POST: /folder/{id}/content Description This API call updates the name of a document. This API call deletes the folder and all of its contents. This API call creates a folder that is available to store any combination of documents, subfolders, and shortcuts. This API call moves a set of existing documents, folders, and shortcuts to a folder. ImageNow Modeling Upgrade Guide Page 23 of 24

24 INTool The following INTool commands have been modified for folder hierarchies. Command Description of Change Upgrade Behavior intool --cmd create-defaultview intool --cmd explain-vsl This command includes two new parameters: folder and folder content. This command includes two new parameters: folder and folder content. Default folder and folder content views are created upon upgrade. The default project views (for example, All Projects and My Recycled Projects) remain for compatibility. The VSL constraints created for folder and folder content view appear when you run this command. INUpgradeUtil upgrade utilities have been added to upgrade projects folder hierarchies in version 6.7. These commands run automatically during the upgrade process. Command Description of Change Upgrade Behavior inupgradeutil upgrade-views inupgradeutil upgrade-privs -- from <version> This command converts existing project type views and filters to folder content views and filters and all project views and filters to folder views and filters. This command upgrades s prior to version 6.7 and adds s that were added for version 6.7. After the upgrade is complete, the views that appeared for Projects appear on the Folders tab. All conditions associated with a project property are associated with a folder or folder content property. After the upgrade is complete, the changes outlined in the Security section of this document are active. ImageNow Modeling Upgrade Guide Page 24 of 24