IRM Desktop Client For Users Guide 10.3.3
IRM Desktop Client For Users Guide 10.3.3
Guide
Date: June 2022
Version: 10.3.3
Revision: 0
Notice
This documentation is a proprietary product of iManage LLC and is protected by copyright laws and international
treaty. Information in this documentation is subject to change without notice and does not represent a
commitment on the part of iManage. While reasonable efforts have been made to ensure the accuracy of the
information contained herein, iManage assumes no liability for errors or omissions. No liability is assumed for
direct, incidental, or consequential damages resulting from the use of the information contained in this
documentation.
The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict
accordance with the End User License Agreement, which the Licensee should read carefully before commencing
use of the software. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor
translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic,
optical, chemical, manual or otherwise, without the prior written permission of the copyright owner. This
documentation may use fictitious names for purposes of demonstration; references to actual persons, companies,
or organizations are strictly coincidental.
iManage DeskSite, iManage FileSite, iManage OffSite, iManage WorkSite, iManage WorkSite MP, iManage Work
Server, iManage Work Web Server, iManage Control Center, iManage Work Indexer (powered by IDOL), iManage
Cloud, iManage Work, iManage Work Desktop for Windows, iManage Work Desktop for Mac, iManage Drive,
iManage Tracker, iManage Share, iManage Work Mobility for iOS, iManage Work Mobility for MobileIron, iManage
Work Mobility for BlackBerry Dynamics, iManage Work Mobility for Intune, iManage FileShare, iManage Closing
Folders, iManage Work Email Management for Gmail, iManage Express Search, iManage DealBinder, iManage
Office Integration, iManage Work Communications Server for Exchange, iManage Cloud Workspace Generator,
iManage OCR Service, iManage Preview Server, iManage Refile Service, iManage Work Web SDK, iManage Work
Desktop for Windows SDK, iManage Miner, iManage Portable, iManage Co-Authoring, iManage Records Manager,
iManage Security Policy Manager, iManage Threat Manager, iManage Conflicts Manager, iManage Business Intake
Manager, iManage RAVN, iManage Insight, iManage Extract, iManage Work Indexer (powered by RAVN), iManage
RAVN Core, iManage RAVN Pipeline, iManage RAVN Preview Server, iManage RAVN Security Server, iManage RAVN
Security Policy Service, iManage RAVNML, Contract Intelligence, Knowledge Unlocked, and all related titles and
logos are trademarks of iManage LLC and its affiliates, which may be registered in certain jurisdictions.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless
required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
Redis: http://redis.io/topics/license
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
• DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in
subparagraph (c)(1)(ii) of 252.227-7013.
• Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (a) through (d) and
restrictions set forth in the accompanying end user agreement.
Unpublished-rights reserved under the copyright laws of the United States. iManage,71 S. Wacker Drive, Suite 400,
Chicago, IL 60606, US.
Acknowledgements
RSA Data Security, Inc. MD5 Message-Digest Algorithm; zlib general purpose compression library, Jean-loup Gailly
and Mark Adler; Info-ZIP, more information at ftp://ftp.info-zip.org/pub/infozip/license.html; HTML-to-RTF Pro DLL
1.8 © 2002-2007 SautinSoft.
IRM Desktop Client for Users Guide
Contents
Getting Started __________________________________________________________________________ 7
Terminology note ................................................................................................................................................... 7
General usage notes .............................................................................................................................................. 7
Logging In............................................................................................................................................................... 7
Logging in to connect to an on-premises IRM Server ....................................................................................... 7
Standard Login ................................................................................................................................................... 8
SAML Login ........................................................................................................................................................ 8
Logging in to connect to IRM Service in the Cloud..........................................................................................10
Standard Login ................................................................................................................................................. 10
SAML Login ...................................................................................................................................................... 11
Changing Your Password ....................................................................................................................................11
Connecting from iManage Work .........................................................................................................................12
Exploring The Interface........................................................................................................................................12
Records - Dashboard ...........................................................................................................................................13
Customizing the View..........................................................................................................................................13
Customizing properties directly from List view ...............................................................................................14
Customizing Record Folder Properties View .....................................................................................................14
Setting User Options and User Language ..........................................................................................................14
Displaying Items.................................................................................................................................................15
Changing Login Settings ...................................................................................................................................15
Setting Display Options .....................................................................................................................................15
Set Color Options ...............................................................................................................................................15
Setting Report Options ......................................................................................................................................15
Setting Record Folder Properties for Duplication ............................................................................................15
Set Language Options .......................................................................................................................................16
Setting language by Windows locale (default) .............................................................................................. 16
Setting language from the Tools menu .......................................................................................................... 16
Managing Record Folders ________________________________________________________________ 18
Creating Record Folders ......................................................................................................................................18
Creating Record Folders from Templates ..........................................................................................................19
Duplicating Record Folders .................................................................................................................................20
Precedence for Duplicating Record Folder Properties ....................................................................................21
Modifying Record Folders ...................................................................................................................................21
Processing Triggers.............................................................................................................................................22
Relating the Record Folders ................................................................................................................................23
Viewing Related Records...................................................................................................................................23
Viewing Electronic Renditions......................................................................................................................... 24
Media Type ...........................................................................................................................................................24
Viewing Electronic Renditions of documents ....................................................................................................24
Reports________________________________________________________________________________ 25
Generating Reports ..............................................................................................................................................26
Changing Report Sort Order ................................................................................................................................26
Saving Reports .....................................................................................................................................................26
4
IRM Desktop Client for Users Guide
5
IRM Desktop Client for Users Guide
6
IRM Desktop Client for Users Guide
Getting Started
IRM Desktop Client for Users enables you to view and manage your physical and electronic records. You can:
This document provides instructions for using IRM Desktop Client for Users. It is intended for records
creators, records consumers, and iManage DeskSite or iManage FileSite users who need access to records
in the iManage Records Manager library. For installation instructions, refer to iManage Records Manager
Administration Guide.
Terminology note
References in this guide to "Records Manager Server", "IRM Server", and "IRM Service" are equivalent. If you
are using or connecting to iManage Records Manager Service in the Cloud, such references are
interchangeable with "iManage Records Manager Service in the Cloud".
The functionality available in the IRM Desktop Client is dependent on how your account has been configured
by the system administrator. To ensure all functionality applicable to you is displayed and up-to-date in the
Desktop Client, it is recommended that you periodically restart the application. To do so, exit the application
(File > Exit) and then re-open and log back in.
Logging In
The login procedure to follow is dependent on whether you are connecting to an on-premises IRM Server, or
IRM Service in the Cloud. If you are unsure of which of these is applicable to you, contact your application
administrator for advice on how to proceed.
• Standard Login
• SAML Login
7
IRM Desktop Client for Users Guide
Standard Login
1. Perform a Windows search for "IRM Desktop Client" and select IRM Desktop Client for Users. The
Records Manager Login dialog box appears.
2. Enter your user name, password, name of the Records Manager cluster, and the domain name. (You
can obtain this information from your application administrator.)
3. Select the Use Trusted Login check box if you want to be connected using your network user
credentials. You do not need to enter a user name, password, or domain when this check box is
selected.
NOTE:
The Trusted Login functionality must be enabled on the (on-premises) Records Manager server to
connect using this method.
4. To suppress the Login dialog box after successfully connecting to the Records Manager cluster, select
the Automatically connect to cluster on startup check box. The login credentials you entered are
automatically sent to the Records Manager cluster on future login attempts.
If the login fails, the dialog box appears for you to re-enter the information manually.
NOTE:
To disable the automatic connection functionality, hold down the Shift key while starting the
application.
5. Click OK.
You remain connected to the Records Manager cluster until you close the application. To close the
application, from the File menu, select Exit.
SAML Login
iManage Records Manager supports Secure Assertion Markup Language (SAML) for authentication. To login
using SAML:
1. Perform a Windows search for "IRM Desktop Client" and select IRM Desktop Client for Users. The
Records Manager Login dialog box appears.
2. In the Records Manager login dialog box, select SAML Login.
3. Enter the authorization server name, the connection port, and the name of the Records manager
cluster. (You can obtain this information from your system administrator.)
4. To suppress the Login dialog box after successfully connecting to the Records Manager cluster, select
the Automatically connect to cluster on startup check box. The login credentials you entered are
automatically sent to the Records Manager cluster. If the login fails, the dialog box opens for you to re-
enter the information manually.
5. Click OK.
a. If the Identity Provider login screen appears, proceed to Step 6 below.
b. If the Identity Provider login screen does not appear:
i. Close the IRM Desktop Client.
ii. Open the WOMDotNet.dll.config file, (which should be located in the ...
\<username>\AppData\Roaming\iManage\RecordsManager folder - if not, please see note
below)
8
IRM Desktop Client for Users Guide
NOTE:
If the WOMDotNet.dll.config file is located in the installation folder and not in the ...
\<username>\AppData\Roaming\iManage\RecordsManager folder, it should be copied into
the ...\<username>\AppData\Roaming\iManage\RecordsManager folder as part of the
Desktop Client upgrade. See Pre-Upgrade check: preservation of settings in iManage Records
Manager Upgrade Guide for further information.
<!-- SAML login shows a browser to prompt for your IDP credentials.
This setting determines how easily the browser appears.
Values are 0, 1, or 2.
0 - Will appear any time a web page finishes loading. Will result in
the browser flashing up briefly if it navigates through intermediate pages
before the final login page.
Useful for debugging, if the login page never appears.
1 - Same as 2, plus if the page text contains any of the terms
LoginPageDetectionTerms.
Useful if your IDP uses an iFrame to display the actual login
fields.
2 - Will only appear if the web page contains any visible html input
fields. Suitable for ADFS. -->
<add
key="interwoven.recordsmanager.controls.LoginPageDetectionThreshold"
value="1"/>
<!-- Terms used for LoginPageDetectionThreshold setting 1. Comma-
delimited and case-insensitive. -->
<add key="interwoven.recordsmanager.controls.LoginPageDetectionTerms"
value="login"/>
<add key="interwoven.recordsmanager.controls.ShowBrowserAlways"
value="true">
This ensures that the browser window appears open throughout the login process, enabling
easier diagnosis of any issues.
3. Save the updated WOMDotNet.dll.config file.
4. Restart the IRM Desktop Client.
9
IRM Desktop Client for Users Guide
5. After using the browser to diagnose the issues, reset the value in the WOMDotNet.dll.config
file as follows:
<add key="interwoven.recordsmanager.controls.ShowBrowserAlways"
value="false">
• Standard Login
• SAML Login
Standard Login
1. Perform a Windows search for "IRM Desktop Client" and select IRM Desktop Client for Records
Managers. The Records Manager Login dialog box appears.
2. Enter your user name, password, name of the Records Manager cluster, and the domain name, as
outlined below. (You can obtain this information from your system administrator.)
a. For User Name, provide the ID of the intended IRM account.
b. For Password, provide the IRM password associated with the account.
c. For Cluster, provide the IRM cluster name.
• For example:
companyname-cms.imanage.work
d. For Domain, provide the Domain profile of the intended IRM account. As Domain is not a required
attribute when creating accounts into IRM, the field may be left blank if not relevant. (To assess this,
you can check the Domain value set for the account, using IRM Library Manager.)
NOTE:
Ensure that the typed value matches the exact Domain profile set for the IRM account. For
example, an input domain value of companyname would not be evaluated as a match for
companyname.com.
3. Select the Use Trusted Login check box if you want to be connected using your network user
credentials. You do not need to enter a user name, password, or domain when this check box is
selected.
NOTE:
The Trusted Login functionality must be enabled on the (on-premises) Records Manager server to
connect using this method.
4. To suppress the Login dialog box after successfully connecting to the Records Manager cluster, select
the Automatically connect to cluster on startup check box. The login credentials you entered are
10
IRM Desktop Client for Users Guide
NOTE:
To disable the automatic connection functionality, hold down the Shift key while starting the
application.
5. Click OK.
You remain connected to the Records Manager cluster until you close the application. To close the
application, from the File menu, select Exit.
SAML Login
iManage Records Manager supports Secure Assertion Markup Language (SAML) for authentication. To login
using SAML:
1. Perform a Windows search for "IRM Desktop Client" and select IRM Desktop Client for Records
Managers. The Records Manager Login dialog box appears.
2. In the Records Manager login dialog box, select SAML Login.
3. Enter the authorization server name, the connection port, and the name of the Records manager
cluster. You can obtain this information from your system administrator.
4. To suppress the Login dialog box after successfully connecting to the Records Manager cluster, select
the Automatically connect to cluster on startup check box. The login credentials you entered are
automatically sent to the Records Manager cluster. If the login fails, the dialog box opens for you to re-
enter the information manually.
5. Click OK. The Identity Provider login screen appears.
NOTE:
If the Identity Provider screen does not appear, please contact your application administrator for
further assistance.
6. Enter your Identity Provider login credentials and click Sign in.
NOTE:
11
IRM Desktop Client for Users Guide
You may receive an error message if your password does not meet the complexity requirements
set by your organization. If this occurs, enter a password which meets the complexity requirements
set out in the error message.
Navigation Pane
The Navigation pane provides centralized navigation and access to the Records Dashboard.
Search Bar
The Search bar provides the ability to perform text searches and criteria-based searches directly from the
main interface.
List Pane
The List pane displays elements of the file plan and the results of searches performed in the application.
When browsing the file plan, the List pane displays items in a hierarchical “tree-like structure”, which enables
you to see how individual records are organized within their parent containers. A plus sign (+) next to an item
indicates that there are sub-items within it. When you click the node to expand it, the plus sign changes to a
minus sign (–).
To view the contents of an item, from the File menu, press Enter. Alternatively, double-click an item to view
its contents. In some cases, double-clicking an item opens the Edit dialog box to modify its properties.
Properties of items in the list pane are displayed in columns. Sorting is enabled for most property types. To
sort by a column, select the column heading. Property columns can be added or removed. See Customizing
properties directly from List view.
When a list of record categories or record folders are displayed in the List pane, you can use the Print
Report or Print Selected buttons, to print a report of the entire list or selected items from the list.
Tabbed browsing enables you to drill down the file plan, and, easily return to where you began.
Press Ctrl+T to view the contents of a selected item in a separate tab. Each tab displays its own breadcrumb
at the top of the List pane. Press Ctrl+Shift+T to close the tab.
Preview Pane
The Preview pane is divided into tabs that display information about the item selected in the List pane. The
tabs available depend on the item selected in the List pane.
12
IRM Desktop Client for Users Guide
Report View
Displays the report generated in the application. It also provides options to print, save, export, and mail
reports.
Records - Dashboard
The Records tab in the Navigation pane provides access to the Records dashboard, which consists of the
following panes:
Browse Pane
The Browse pane provides quick access to the file plan, and, the requested and checked-out records lists.
When you select an element in the Browse pane, the List pane updates to show the contents of the element.
You can customize the column headings displayed for lists of items, by adding or removing properties. You
can also determine the order to display the column headings, as well as the sort order within each column.
13
IRM Desktop Client for Users Guide
NOTE:
You can customize the properties view only for record folders. For other items, the properties are
alphabetically sorted and not customizable.
NOTE:
The properties that are available to display are limited by those configured in Application Designer.
Refer to iManage Records Manager Application Designer User Guide.
• Displaying Items
• Changing Login Settings
• Setting Display Options
• Set Color Options
• Setting Report Options
• Setting Record Folder Properties for Duplication
• Set Language Options
• Setting language by Windows locale (default)
• Setting language from the Tools menu
14
IRM Desktop Client for Users Guide
Displaying Items
1. From the Tools menu, select Options.
The Options dialog box appears.
2. In the Browse items to return box, enter or select a value to limit the number of items displayed in the
List pane when browsing or searching.
3. Click OK.
3. Click and select the default background color for fields and locked fields in a dialog box.
You can also select background colors for the odd and even rows of a list.
4. Click OK.
15
IRM Desktop Client for Users Guide
NOTE:
The properties available for duplication are derived from those configured in the Application
Designer. For more information, refer to iManage Records Manager Application Designer User
Guide.
The default setting in the language setting in IRM Desktop Client for Users is "Windows default". Provided
this setting is not changed, if a language corresponding to your locale has been added to IRM, it becomes
available when you specify your locale in Windows locale settings.
If you have previously used IRM Desktop Client, and are switching language, perform the following additional
steps to ensure that all column headers are displayed in the selected language:
16
IRM Desktop Client for Users Guide
• While languages are pre-populated in the dropdown, only localized (custom language) content
that has been configured by or for your organization, will be available for display in the Desktop
Client.
For detailed information on how to localize content for use in the Desktop Client, see the section
Using captions to present localized content in client applications in iManage Records Manager
Application Designer User Guide.
NOTE:
To ensure that the language selection is successful, the server must be configured to use the
appropriate locale and language. For more information see Configure the server locale in
iManage Records Manager Administration Guide.
17
IRM Desktop Client for Users Guide
• Security policy. Click and select the appropriate security policy for this record folder.
• Record type. Click and select the record type for this record folder.
• Retention schedule. Click and select an available schedule for this record folder.
The application applies a default schedule based on the schedule of the parent.
• Retention start date. Select the date to start the retention schedule.
• Office/Department. Click and select the location or group most responsible for this record
folder.
• Responsible user. Click and select the user that has control over this record folder.
• Home location. Click and select the location where this record folder is stored when not in
circulation.
18
IRM Desktop Client for Users Guide
NOTE:
• Vital record. If the record folder requires periodic review, select this check box. You need to specify a
review cycle, which is effective from the last reviewed date of the record folder.
NOTE:
Records added to this record folder retain the same record review cycle.
• Open date. Select a date when this record folder can be opened or created. This date is used for
calculating retention events.
• Close date. Select a date when this record folder can be closed. This date is used for calculating
retention events.
• Comments. Enter any notes or comments about this record folder.
• To create a batch of record folders simultaneously, enter the number of record folders in the Number of
records to create field. This enables you to create any number of new record folders with the same
properties (metadata).
You can only create as many record folders as the record folder ID format (in terms of number of
characters) entered.
For example, if you enter the ID for the first record folder as IM_99, and specify two record folders to
create, a message appears indicating that the number of records is not within the range of the
specified format. This is because the second record folder gets an ID IM_100, which does not match
the record folder ID format (in terms of number of characters).
Alternatively, to create the record folders without closing the New Record Folder dialog box, click Save
and New. This enables you to create additional record folders without opening the New Record Folder
dialog box again.
• Click OK.
19
IRM Desktop Client for Users Guide
Your selections appear in the Alternative Selections section. Use the links to browse the file plan and
change the selections. In this way, after adding a series of inserts into a jacket, you can browse to a
higher level and create a jacket, and add inserts into it.
If there are templates which match the Functional Area of this record category, the matching templates
are displayed in the table at the top of the dialog box.
If no valid templates exists for this record category, in the Select a template from standard field, click
and select another standard. Click OK to return to the New Record Folder from Template dialog
box.
3. From the table, select the template to use.Complete the following fields:
• Name. Enter a name for this record folder. The template controls the naming of the record folder.
This field may be configured to allow you to change the name, append a name, or it may prevent you
from changing the record folder name.
• Description. Enter any useful information about this record folder. The description provided in the
template appears in this field by default.
• Office/Department. Click and select the location or group most responsible for this record
folder.
• Responsible user. Click and select the user that has control over this record folder.
• Home location. Click and select the location where this record folder is stored when not in
circulation.
• ID (override). Enter a unique code to identify this record folder, or accept the default ID created by
the template.
4. To create a batch of record folders simultaneously, enter the number of record folders in the Number of
items to create field. This enables you to create any number of new record folders with the same
properties (metadata).
You can only create as many record folders as the record folder ID format (in terms of number of
characters) entered.
For example, if you enter the ID for the first record folder as IM_99, and specify two record folders to
create, a message appears indicating that the number of records is not within the range of the
specified format. This is because the second record folder gets an ID IM_100, which does not match
the record folder ID format (in terms of number of characters).
Alternatively, to create the record folders without closing the New Record Folder from Template dialog
box, click Save and New. This enables you to create additional record folders without opening the New
Record Folder from Template dialog box again.
NOTE:
5. Click OK.
20
IRM Desktop Client for Users Guide
During record folder creation, in the New Record Folder or New Record Folder from Template dialog box, the
properties are duplicated based on the precedence outlined in Precedence for Duplicating Record Folder
Properties.
You can also choose the properties to copy when creating the duplicate record folder.
NOTE:
If the record folder to duplicate is created from a template, the New Record Folder from Template
dialog box appears.
3. Use the File Selection section to browse and select where to duplicate the record folder.
4. If necessary, modify the information in any of the available fields. See Creating Record Folders.
5. To create a batch of duplicates of the record folder, enter the number of record folders in the Number
of records to create field. Alternatively, to duplicate the record folder without closing the New Record
Folder dialog box, click Save and New. This enables you to create additional duplicates of the record
folder without opening the New Record Folder dialog box again.
6. Click OK.
1. User Locked Field. The properties previously locked on the New Record Folder or New Record Folder
from Template dialog box.
2. Source record folder. The properties of the record folder that is being duplicated.
3. Parent record folder Template. The properties specified in the template of the parent record folder
(that is, the record folder in which the duplicate is created in).
4. Parent record folder. The properties of the record folder in which the duplicate is created in.
NOTE:
In all the above cases, you can manually override the inherited properties.
21
IRM Desktop Client for Users Guide
NOTE:
To maintain consistency and accuracy of information entered, the application enables you to
reprint labels of modified record folders. See Reprinting Modified Item Labels.
Processing Triggers
Trigger processing is used to manually update the Retention Start Date (or other configured date) and record
status in order to jump-start a retention schedule. For example, a contract may remain in the active state
until the Contract Execution trigger puts it into the Executed state, moving it on to the next step in the
retention schedule.
NOTE:
You must have the Process Trigger Events privilege to perform this action.
4. In the Selected Trigger field, click and select one of the available triggers.
5. In the Effective Date field, select the date to set the trigger.
6. Click Process. The results appear in the Results pane of the dialog box.
7. Click Close.
NOTE:
Each time a trigger is processed, an entry is added to the audit history for the item it is processed
on.
22
IRM Desktop Client for Users Guide
1. Search or browse for the record folder, and select it. This record folder can be referred as the “source”.
2. From the Actions menu, choose New Relationship.
The New Relationship dialog box appears.
3. In the File to Link field, click and select the record folder that relates to the source. This record
folder can be referred to as the “target”.
4. In the Link Type field, select the relationship type:
NOTE:
Relationships between record folders are reciprocal in nature. For example, if the source is related
to the target by the Superseding link,then the target is automatically related to the source by the
Superseded link.
• Superseded by. The source is replaced by the target as the more current record.
• Supersedes. The source replaces the target as the more current record.
• Cross-Reference. The target and source are linked as cross-references.
• Supporting Document. The source is the supporting document to the target.
• Supported Document. The target is the supporting document to the source.
• Electronic Rendition. The target is the electronic rendition of the supporting document.
NOTE:
For Electronic Renditions to function correctly, configuration must be applied by the system
administrator. See Configure IRM for Electronic Renditions in the iManage Records Manager
Administration Guide for more information.
• Click OK.
a. The Related Records dialog box appears listing the related file parts.
b. If Electronic Rendition has been selected as the Link Type, complete the following fields:
i. Link to document in iManage Work (insert the iManage link to to the document).
ii. Friendly name (optional field).
• Click Close.
23
IRM Desktop Client for Users Guide
• Click Close.
Electronic renditions can also be related to file parts. To view these, see Viewing Electronic Renditions of
documents.
Media Type
Media types describe the containment rules that govern how standards and folders are organized. Media
types define the name, icon, and containment rules for various objects in the system.
The following media types are provided by default:
Insert Document
Additional media types and valid sub-items can be added or modified by your application administrator.
1. In the file plan, right click on the row of a document with a blue icon in the Attribute column. This icon
indicates that an electronic rendition is available.
2. Select View Electronic Rendition.
a. If there is one electronic rendition, the rendition opens directly.
b. If there is more than one electronic rendition associated with that document, the related records
pane opens, from where the required rendition can be selected.
24
IRM Desktop Client for Users Guide
Reports
The application provides a set of reports and report formats to collect information from the Records
Manager system. The table lists the available report formats.
Report Formats
Files File Plan Summary Report Lists matching record folders grouped
according to their record folder containment
within the file plan.
Labels Record folder Labels A sample set of record folder labels, aimed at
jackets and inserts. This report is organized in
container order, with a jacket followed by all of
its inserts. It is limited to items of a Media Type
of jackets and inserts.
Boxes Box Detail Report A listing of matching boxes, along with all of
their record folder contents listed in
containment (hierarchical) order.
25
IRM Desktop Client for Users Guide
Generating Reports
1. In the toolbar, click New Report.
The New Report dialog box appears. A list of categories available to you appears in the Category list.
2. From the Category list, select a category.
A list of report formats available to the selected category appears in the Formats list.
3. From the Formats list, choose a report format to select how information should be displayed in the
report.
The grouping associated with the selected format is displayed below the Formats list.
4. From the Sort by list, select a sort order for the report.
5. To limit the scope of the report, click Set Report Criteria.
The criteria available are unique to the type of report you generate.
6. To print a representation of the report criteria in the report header, select the Print criteria check box.
7. To save this report in the Saved Reports node:
1. Select the Save this report as check box.
2. In the Name field, enter a name for this saved report.
• Click OK.
The report is generated and appears in the Report View.
1. From the Recent Reports node, right-click the report for which you want to change the sort order.
2. Select Change Sort Order.
The New Report dialog box appears.
3. From the Sort by list, select a different sort order for the report.
The other fields in the dialog box are disabled, because you cannot modify report criteria and formats
of a generated report.
4. Click OK.
The report is generated and appears in the Report View.
Saving Reports
Reports that are used often can be saved, enabling you to quickly regenerate the report at any time using the
same criteria and format. After you save a report, it is displayed in the Saved Reports node in the Searches
and Reports pane.
1. After generating a report, with the report displayed in the Report View, from the File menu, choose Save
As.
The New Report dialog box appears.
2. Enter a name for the report and click OK.
A saved report is created in the Saved Reports node.
26
IRM Desktop Client for Users Guide
• To regenerate a saved report, right-click the report, and select Refresh Report. You can also generate
the report by selecting it, and pressing F5.
• To modify a saved report, right-click the report, and select Edit Report Criteria. The New Report dialog
box appears. Click Set Report Criteria. The relevant search dialog box appears to enter additional
criteria.
• To rename a saved report, right-click the report, and select Rename Report. Enter the new name of the
report.
• To delete a saved report, right-click the report, and select Delete Item. In the confirmation message,
click Yes.
Printing Reports
1. Generate the report.
2. From the Report View toolbar, click Print. Alternatively, from the File menu, select Print.
The Print dialog box appears.
3. Select a printer, and verify the printer settings.
4. Click OK.
Exporting Reports
1. Generate the report.
2. From the File menu, select Export.
The Export Report To dialog box appears.
3. Select a location to save the file.
4. In the File name field, enter a name for this file.
5. From the Save as type field, select one of the available file types:
• PDF
• RTF
• XML
• Microsoft Excel
6. Click Save.
Mailing Reports
1. Generate the report.
2. From the File menu, select Email.
The Email Report dialog box appears.
3. In the FileName field, enter a name for the attachment.
The attachment is named according to the type of report and includes relevant criteria within brackets.
4. From the Format list, select a format for the attachment:
• PDF
• RTF
• XML
• XML Layout
• Excel
27
IRM Desktop Client for Users Guide
5. Click OK.
An untitled email message with the report information included as an attachment opens.
NOTE:
If there is no email program associated to perform this action, please contact your Administrator to
install an email program.
NOTE:
Quick Reports include only the items shown in the List pane. Use the As Reports option in the View
menu, if there are more items to be displayed on one screen.
Record category:
28
IRM Desktop Client for Users Guide
2. Right-click the record category, and select File Plan Summary Report.
A report is generated and appears in the Report View.
3. To run this report again, select it from the Recent Reports node.
NOTE:
Ensure that File Plan Summary is predefined as the default format. See Setting Report Hot Links.
Use this procedure to generate a Document Index report for a document binder, such as a Closing Bible or
Pleadings Index.
29
IRM Desktop Client for Users Guide
Labels
Labels with barcodes are printed and affixed to physical records to identify them. These labels help tracking
records circulating within the organization.
The Desktop Label Printing application is integrated with IRM Desktop Client for Users to provide a common
interface to preview, print and reprint labels of record folders.
Other User. To check out the record folder to another user, click and select a user.
NOTE:
If the user does not have a default delivery location assigned, the application does not perform a
checkout during label printing. For information on assigning a delivery location to a user, contact
your administrator.
3. Click Print Report, or in the Record Activities pane, click File Label Report.
Alternatively, select specific record folders, and click Print Selected.
If you are printing labels for the first time, the Select Label printer and Label report format dialog box
appears.
4. From the Printer settings list, select a printer to use as the default printer.
5. From the Select label report format list, choose a format to set how information should be displayed in
the label.
6. Click OK. The labels for the selected record folders are generated and appear in the Report View.
The Report View toolbar has the following buttons.
Report View Functions
30
IRM Desktop Client for Users Guide
Find - Opens a dialog box that helps you to find content from
the selected report.
Page Width - Enables you to set the page width of the report.
7. From the Report View toolbar, click Print. The Print dialog box appears.
8. Select a printer and verify the printer settings.
9. Click OK.
NOTE:
On printing labels, the record folders move from the Pending Items list to the Printed Items list.
When label generation is in process, if you click Print Report or Print Selected, a message appears:
• Click Yes to cancel the current process, and schedule a new one.
• Click No to continue the current process.
31
IRM Desktop Client for Users Guide
NOTE:
Only record folders created or last modified by the specified users appear in the Pending Items list.
NOTE:
Record Folders that are in the specified location, including its child locations, are included in the
Pending Items list. The location does not have to be an exact match. For example, if Building A is
the Home Location and Office B is in Building A, then Office B is a match for Building A.
Reprinting Labels
1. In the Record Activities pane, click File Labels.
The Desktop Label Printing interface appears.
2. Click the Printed Items tab to view the Printed Items list.
3. Select record folders and click Print Selected.
The labels are generated and appear in the Report View.
4. From the Report View toolbar, click Print.
The Print dialog box appears.
5. Select a printer and verify the printer settings.
6. Click OK.
NOTE:
The Printed Items list retains only those record folders whose labels are printed in the current
session, it refreshes each time you close the application.
32
IRM Desktop Client for Users Guide
NOTE:
Contact your administrator for a list of properties which when modified require a label reprint.
Exporting Labels
You can export label information to a file in the XML format. This XML file can be used by an external label
printing application to print labels.
NOTE:
This location is saved and automatically selected the next time you export labels.
6. Click OK to close the Browse for Folder dialog box, and return to the Options dialog box.
7. Click OK to close the Options dialog box.
8. In the Record Activities pane, click File Labels.
9. Click Print Report. Alternatively, select record folders, and click Print Selected.
The Report Exported window appears in the lower right of the screen.
NOTE:
On exporting label information, the record folders move from the Pending Items list to the Printed
Items list.
33
IRM Desktop Client for Users Guide
NOTE:
You must have Modify access to the record folder to perform this action.
34
IRM Desktop Client for Users Guide
Common Tasks
The following are commonly performed tasks in the Records Manager application:
• Search Items
• Text Searches
• Add Search Criteria
• Save Searches
• Customize Search Results
• Search - Syntax
• Advanced - Searches
• Searching Record Folders
• Searching Record Series
• Search Record Categories
• Search for Boxes
• Search for Record Folder Eligibility
• Searching for Cut Off Records
• Searching for Vital Review Records
• Searching Requests
• Search Audits Record Folders
• Request Items
• View Requested Items
• Cancel Requests
• Selecting Values
• Selecting a Media Type
• Selecting a Circulation Status
• Selecting a Membership Policy
• Selecting a Security Policy
• Selecting a Functional Area
• Selecting Keywords
• Select a Record Status
• Selecting a Record Type
• Selecting a Freeze Action
• Selecting a Retention Schedule
• Selecting a Standard
• Selecting a Transmittal Code
• Selecting a User
• Selecting a Vendor
• Selecting a Vital Record Review Cycle
• Record - Series
• Selecting a Record Series
35
IRM Desktop Client for Users Guide
Search Items
The application provides extensive search capabilities to enable you to screen and sort through large
volumes of records.
Text Searches
Add Search Criteria
Advanced Searches
Save Searches
Search Syntax
Text Searches
Text searches locate file plan items based on the occurrence of search terms. You can enter the ID of the
item, or text contained in the name, description, or comments of it.
Records are critical assets that need to be stored for a certain period of time. Terminology, series names,
and key contacts can significantly change during this period, making it difficult to locate old records. A
thesaurus helps to relate the nomenclature used in old information with current information and ensures that
critical information is not overlooked due to change in nomenclature.
NOTE:
The thesaurus expansion feature is enabled by default when performing text searches. It can be disabled
by adding a prefix “=” to the search term.
For example, a text search on “iManage ” returns related terms, which appear in the Thesaurus
Expansion tab. But, a text search on “=iManage ” does not return any related terms.
36
IRM Desktop Client for Users Guide
1. In the Search bar, type the word or phrase you want to find.
2. To specify a different scope for your search, click another scope button. Alternatively, use the following
keys to specify the scope:
3. Click Search.
The search results appear in the List pane.
NOTE:
The progress bar at the bottom of the pane indicates the status of the search. Click the Stop button
to cancel a search in progress.
4. In the Preview pane, click the Thesaurus Expansion tab to view terms that are related to the search
terms.
5. Continue with Customize Search Results.
NOTE:
Properties that are locked as global filters are used each time a search is performed where the
property is relevant as a criterion. For example, when performing a full-text search, if Office/
Department is locked as a global filter, items matching both the specified search terms, and the
locked Office/Department are found. Similarly, when browsing the file plan, only items matching
the locked Office/Department appear.
5. Click Search.
The search results appear in the List pane.
6. Continue with Customize Search Results.
37
IRM Desktop Client for Users Guide
Save Searches
Searches that you perform frequently can be saved, allowing you to quickly repeat the search at any time
using the exact same criteria. Once you save a search, it is displayed under the Saved Searches node in the
Searches and Reports pane. The search is named and grouped according to the type of search and includes
any relevant criteria in brackets.
To save a search:
• To view the contents of an item in a separate tab, press Ctrl+T. Alternatively, double-click on an item to
view its contents in a separate tab.
• To switch the display from a simple list to a grouped list, click Group Results in the toolbar.
• To display the shortcut menu, right-click the list header in the List pane.
• To expand or collapse all items displayed, choose Expand All Items or Collapse All Items.
• To add or remove a property as a column heading, select or clear it from the shortcut menu. Properties
that are marked currently display as column headings.
• To customize the font and color of matching and non-matching items in the search results, choose
Customize Navigation.
From the View menu, select Refresh, or press the F5 key to save and see your changes.
NOTE:
The options in the shortcut menu are only available on completed searches, and not on searches in
progress.
Search Syntax
Full-text search queries are made up of the search terms and operators.
• Terms are individual words, partial words, and phrases that you use to perform full-text searches.
• Operators enable you to combine search terms to restrict your search. The table below lists the
available operators.
38
IRM Desktop Client for Users Guide
NOTE:
Search Operators
"" The double quotation marks operator locates To find documents that contain the
documents that contain an exact word or phrase. phrase new york, enter:
It is used to perform a literal search. You can use
“new york”
double quotation marks with any of the other
operators described in this table. If you do not use quotation marks,
your results will include matches for
NOTE: new and york.
OR The OR operator finds documents that contain at To find documents with one or both
least one of the terms to which it is applied. This of the words red and green, enter:
is the default behavior if no explicit operator is
red OR green
entered between two terms.
AND The AND operator locates documents containing To find documents that contain the
both the terms on either side of it. words England and North, enter:
39
IRM Desktop Client for Users Guide
? The question mark (?) replaces any single b?rn would match the words born,
alphanumeric character. barn, or burn.
NOTE:
When a full-text search is performed, Records Manager stems the search terms, and finds words that have
the same stem. For example, a search for jumped will return results including jump and jumping. Stemming is
enabled by default.
Advanced Searches
To enter additional search criteria (such as Media Type, Retention Schedule, Created Date and so on), in the
toolbar, click Advanced Search. The application opens the relevant search dialog box based on the level of
40
IRM Desktop Client for Users Guide
the file plan you are browsing in. You can also perform advanced searches by selecting the following options
in the Search menu:
• Record Folders
• Record Series
• Record Categories
• Requests
• Search Record Folder Audit History
• Record Series. Click and select the record series to which the record folder belongs.
• Record Category. Click and select the record category to which the record folder belongs.
• ID. Enter the ID which uniquely identifies the record folder.
• Media type. Click and select the media type of the record folder, such as a jacket, insert,
document, and so on.
• Retention schedule. Click and select the retention schedule applied to the record folder.
• Record status. Click and select the current status of the record folder.
• Retention start date. Select the date used to start the schedule
• Responsible user. Click and select the user that has control over this record folder.
• Office/Department. Click and select the location or group most responsible for the record
folder.
• Open date. Select a date when the record folder was created.
• Close date. Select a date when the record folder was closed.
• Vital record. If the record folder requires periodic review, select this check box. You need to specify a
review cycle, which is effective from the Last Reviewed Date of the record folder.
• Home location. Click and select the location where this record folder is stored when not in
circulation.
• Current location. Click and select the location where this record folder is currently located.
• Circulation date. Specify when the record folder was in circulation.
• Checked-out to. Select the user who checked out the record folder.
• Circulation status. Click and select whether the record folder is In, Out or In Transit.
• Created date. Specify when the record folder was created.
• Created by. Click and select the user who created the record folder.
• Modified date. Specify when the record folder was last modified.
• Modified by. Click and select the user who last modified, checked in, or checked out the record
folder.
41
IRM Desktop Client for Users Guide
• Label printed. The application remembers which record folders have their labels printed. Select
the Label printed check box to search for record folders whose labels are already printed. Clear the
check box to only search for new record folder labels ready to print.
3. Click OK.
• Membership policy. Click and select the membership policy applied to the record series.
• Responsible user. Click and select the user that has control for this record series.
• Created date. Select the date or date range during which the record series was created.
• Created by. Click and select the user who created the record series.
• Modified date. Select the date or date range during which the record series was last modified.
• Modified by. Click and select the user who last modified the record series.
3. Click OK.
• Series. Click and select the ID of the record series to which the category belongs.
• Category ID. Enter the ID of the record category.
• Membership policy. Click and select the membership policy applied to the record category.
• Retention schedule. Click and select the retention schedule applied on the record category.
• Responsible user. Click and select the user that has control for the record category.
• Office/Department. Click and select the location or group most responsible for the record
folders contained in the category.
• Functional area. Click and select the functional area for the category.
• Open date. Specify date when the category was opened.
• Close date. Specify a date when the category was closed.
• Vital record review cycle. If the record category contains records that require periodic review, select
this check box. You need to specify a review cycle, which is effective from the Last Reviewed Date of
• Created by. Click to select the user that created the record category.
• Modified date. Specify when the record category was last modified.
42
IRM Desktop Client for Users Guide
• Modified by. Click to select the user that last modified the record category.
3. Click OK.
• Retention schedule. Click and select the retention schedule applied to the box.
• Retention start date. Select the date used to start the schedule.
• Office/Department. Click and select the location or group most responsible for the box.
• Responsible user. Click and select the user that has control over the box.
• Open date. Select the earliest open date for any of the items stored in the box.
• Close date. Select the latest close date for any of the items stored in the box.
• Label printed. The application remembers which boxes have their labels printed. Select the Label
Printed check box to search for boxes whose labels are already printed. Clear the check box to only
search for new box labels ready to print.
• Home location. Click and select the location where the box is stored when not in circulation.
• Current location. Click and select the location where the box is currently located.
• Circulated date. Specify when the box was in circulation.
• Last checked-out to. Click and select the user to which the box was last checked-out.
• Circulation status. Click and select whether the box is In, Out or In Transit.
• Created date Specify when the box was created.
• Created by. Click to select the user that created the box.
• Modified date Specify when the box was last modified.
• Modified by. Click to select the user that last modified the box.
• Record status. Click and select the current status of the box.
3. Click OK.
• Event type. Click and select a retention event for which the record folder is eligible.
• Eligibility date. Specify the event eligibility date.
• As of Today. Eligible on any day until today.
• Between. Eligible on any day within the specified date range.
• Until. Eligible on any day until the specified date.
43
IRM Desktop Client for Users Guide
• Retention schedule. Click and select a retention schedule to search for all record folders to
which this schedule is applied.
• Series. Click and select the record series to which the record folder belongs.
• Category. Click and select the record category to which the record folder belongs.
• Office/Department. Click and select the location or group most responsible for the record
folder.
• Media type. Click and select the media type of the record folder, such as a jacket, insert,
document, and so on.
3. Click OK.
• Cutoff period. Click and select cutoff cycle configured on the retention schedule of the record
folder.
• Cutoff date. Specify a date. Only record folders that are eligible for cut off as of this date are found.
• Media type. Click and select the media type of the record folder, such as a jacket, insert,
document, and so on.
• Office/Department. Click and select the location or group most responsible for the record
folder.
• Record status. Click and select the current status of the record folder.
• Retention schedule. Click and select a retention schedule to search for all record folders to
which this schedule is applied.
• Retention start date. Select the date used to start the schedule.
• Created date. Specify a date when the record folder was created.
• Created by. Click and select the user who created the record folder.
• Modified date. Specify a date when the record folder was last modified.
• Modified by. Click and select the user who last modified, checked in, or checked out the record
folder.
3. Click OK.
Retention schedule. Click and select a retention schedule to search for all record folders to
which this schedule is applied.
Record status. Click and select the current status of the record folder.
44
IRM Desktop Client for Users Guide
Office/Department. Click and select the location or group most responsible for the record
folder.
Media type. Click and select the media type of the record folder, such as a jacket, insert,
document, and so on.
3. Click OK.
Searching Requests
1. From the Search menu, select Requests.
2. Enter your search criteria in any of the available fields:
• Media type. To search for all record folder requests of a specific media type, click and select a
media type.
• Requested for. Click and select the user for whom the record folder was requested.
• Requested by. Click and select the user who entered the request.
• Record Series. To search for all record folder requests for a specific record series, click and select
the record series.
• Record Category. To search for all record folder requests for a specific record category, click and
select the record category.
• Deliver to location. Click and select the location where this record folder is to be delivered.
• Home location. Click and select the location where this record folder belongs when it is not
checked-out. When the record folder has been boxed, the Home Location is derived from the box
location.
• Request date. Specify the date when the record folder was requested.
• Request Status. Specify the current status of the record folder.
• Click OK.
• Record Series. Click and select the record series to which the record folder belongs.
• Record Category. Click and select the record category to which the record folder belongs.
• Record Folder. Enter the ID which uniquely identifies the record folder.
• Office/Department. Click and select the location or group most responsible for the record
folder.
• Activity date. Specify a date or date range to limit the search to audit histories that occurred within
the dates specified.
• User. Click and select a user who has performed any type of operation on this record folder.
• Current location. Click and select the location where this record folder is currently located.
3. Click OK.
45
IRM Desktop Client for Users Guide
Requesting Items
A request is an action that indicates a record needs to be delivered to a particular user and location. In
centralized file room operations, physical records are manually delivered by file clerks. iManage
recommends a formalized request management system.
If Electronic Renditions are available for any of the record folders you have navigated to, a label
displays stating "Some items below have electronic renditions available". An icon in the attribute
row also indicates the presence of electronic rendition(s) for that item. In such case, the electronic
rendition(s) can be viewed directly, possibly without (further) need to request the item. For
additional information, see Viewing Electronic Renditions of documents.
• Requested for. If you are requesting this record folder for someone other than yourself, click
and select a different user.
• Deliver to location. The application fills in the default delivery location for this user. Click and
select a different location where this record folder should be delivered.
Each time a request is initiated, a Request entry is added to the audit history for the item, detailing the
request.
• Insufficient privileges. You do not have sufficient privileges over the items requested.
• No media type with circulation abilities. For the item, and its parent, there is no known media type that
allows circulation.
• Secure contents. Requested item contains secured contents unavailable to the person to which the
delivery is intended. The requested item (or its parent) contains items to which the intended recipient
does not currently have access.
• Record status forbids circulation. Vital records, and destroyed records, may not be eligible for
circulation; therefore, they may have a status that forbids circulation.
46
IRM Desktop Client for Users Guide
Record Folders that are not yet assigned to the relevant records management staff show a Requested status,
and those that are assigned show an In Process status.
Your user ID appears in the Show requests for field by default. To view record folders that are requested for
Modify a Request
After a request is submitted, it cannot be modified. The request must be canceled and resubmitted.
Cancelling Requests
You can cancel a request only if it is submitted for or by you.
NOTE:
You cannot cancel requests that are assigned and have an In Process status.
3. Click Cancel Selected Request(s). Alternatively, from the Actions menu, select Cancel Request.
Selecting Values
Metadata properties that reference types like Location, Schedule, or User use input controls that include a
pop-up dialog to browse or search for the desired value.
47
IRM Desktop Client for Users Guide
From the list, select the membership policy for this particular record series or record category, and click OK.
1. In the text field, type in any terms (name, ID, description) of a functional area and click Search. The
application returns matches in the list.
2. Select a functional area from the list.
3. Click OK.
Selecting Keywords
Keywords defines a collection of statutes in a given jurisdiction to which the record category belongs.
Predefined keywords include: Bankruptcy, Divorce, Intellectual property, Labor relations, Litigation, Pro bono,
Real estate, Tax & Certified accounting, and Criminal.
1. Select the keywords in the upper pane of the Browse and Select dialog box. Hold down the Ctrl key to
select multiple items.
2. Click Add Selected Item(s).
The Selected Items pane displays the items selected.
3. Click OK.
1. In the List pane, right-click the record category and select Properties.
48
IRM Desktop Client for Users Guide
1. In the text field, type in any terms (name, ID, description) of a record type and click Search. The
application returns matches in the list.
2. Select a record type from the list, and click Add Selected Item(s).
3. Click OK.
Selecting a Standard
1. In the text field, type in any terms (name, ID, description) of a standard and click Search.
The application returns matches in the list.
2. Select the standard from the list, and click Add Selected Item(s).
3. Click OK.
Selecting a User
1. Use the Search for Name field to search for users that you want to add to the list. Enter the full or
partial name of a specific user, and click Search.
Alternatively, click the Browse tab to view the directory, and navigate through the hierarchy of users.
2. Select a user.
3. Click OK.
Selecting a Vendor
If there are different warehouse vendors across different office locations, distinction must be made between
these vendors to ensure uniqueness of box identifiers. IRM achieves this by using a Vendor ID value. This is
49
IRM Desktop Client for Users Guide
automatically prepended to Box ID, providing unique box identifiers. Where the Vendor field is available, you
can select from the list of vendors used by your organization.
Record Series
A typical hierarchy consists of the record series as the top level of the file plan. Each record series can
contain one or more record categories.
Membership policy. Click and select the appropriate membership policy for this record series.
All new record categories created within this record series use this as their default membership
policy.
To create a custom policy that only applies to this record series, select the Assign Custom
Membership Policy check box. This policy cannot be seen or used for any other record series in the
system.
To configure the custom policy, click Edit.
Responsible user. Click and select the user that has control for this record series. You can also
type the user's name into the field, and press Ctrl+K to check that you have entered a valid user.
4. Click OK.
50
IRM Desktop Client for Users Guide
Record Categories
Record categories are the second level of the file plan and are created within record series. A record category
organizes record folders within it.
• Membership policy: Click and select the appropriate membership policy for this record
category.
To create a custom policy that only applies to this record category, select the Assign Custom
Membership Policy check box. This policy cannot be seen or applied to any other record category in
the system.
To configure the custom policy, click Edit.
• Retention schedule. Click and select an available retention schedule for this record category.
51
IRM Desktop Client for Users Guide
• Permanent. To mark this record category as permanent, select this check box. Items added to this
record category cannot be destroyed as part of a destruction event.
• Functional area. Click and select the functional area for this category.
• Office/Department. Click and select the location or group most responsible for the record
folders contained in this category.
• Responsible user. Click and select the user that has control for this record category. You can
also type the user's name into the field, and press Ctrl+K to check that you have entered a valid user.
• Retention start date. Select the date to start the retention schedule.
• Open date. Select a date when this category is opened. This date is used for calculating retention
events.
• Close date. Select a date when this category is closed. This date is used for calculating retention
events.
• Vital record. If the record category contains record folders that require periodic review, select this
check box. You need to specify a review cycle, which is effective from the Last Reviewed Date of the
item.
NOTE:
If a record category has instructions, the icon is displayed in the attributes column of the file
plan for that record category. Hovering over the icon displays the record category instructions in
brief. Click on the icon to read the record category instructions in detail.
52
IRM Desktop Client for Users Guide
NOTE:
For a record category that does not allow a new record folder to be added, the icon is
displayed in the attributes column.
NOTE:
• For a record category that is on freeze, the freeze action icon is displayed in the attributes
column. Hovering over the icon provides further information about the freeze action.
• The icon is displayed in the attributes column for items belonging to a record series or record
category that has been assigned a freeze action.
• It is also possible to assign a freeze action to a box.
SPM Policies
When iManage Security Policy Manager is managing the security for a record series or record category, a
security icon will display in the attributes column. Click on the icon to view security policy details.
Where an Open security policy is set, the list of all users who are excluded from access by the security policy
are displayed. Where a Restricted security policy is set, the list of all users who are allowed access by the
security policy are displayed.
Enter a name in the Locate user field to find a user in the list. Click the icon to Search or Browse all users and
check if they are in the list.
For more information on this type of security policy in IRM, refer to iManage Security Policy
Manager Administration Guide.
Boxes
A box is a container used to store and organize record folders.
53
IRM Desktop Client for Users Guide
Selecting a Box
1. In the text field, type in any terms (name, ID, description) of a box and click Search.
The application returns any matches in the list.
2. Select a box from the list, and click Add Selected Item(s).
3. Click OK.
Modifying Boxes
1. In the Records Activities pane, click Boxes.
2. Right-click the box, and select Properties. Alternatively, select the box and press the Enter key. The Edit
Box dialog box opens.
3. Right-click the box, and select Properties. Alternatively, select the box and press the Enter key. The Edit
Box dialog box opens.
4. Complete the following fields:
NOTE:
To simplify data entry, individual fields can be locked. Press Ctrl+L to save the information that you
entered in the field, so that you do not have to re-enter information. Locked fields are filled in
yellow. To unlock a locked field, press Ctrl+U.
Vendor. If this field is shown, you can select a warehouse vendor identifier for this box. This field is
optional.
ID. Enter an ID for this box. If you do not enter an ID for this box, the application automatically
generates one.
Name. Enter a name for this box.
Description. Enter a short description of this box.
Media type. Select the media type of the box to differentiate the different types of boxes (small or
large).
Percent full. Estimate the current used capacity of the box based on a percentage (0-100). This figure
can be used to indicate whether a new box must be created.
Series: Click and select the Series from the Browse and Select dialog box.
Category: Click and select the required Category from the Browse and Select dialog box.
Office/Department. Click and select the location or group most responsible for this box.
Responsible user. Click and select the user that has control over this box.
Retention schedule. Click and select the retention schedule for this box. A retention schedule is
only necessary to manage eligibility at the box level. This enables you to verify that both the box
contents and the box itself are eligible.
Retention start date. Select the date to start the schedule.
Open date. Enter the earliest open date for any of the items stored in this box. This field is for
information purposes and is used only to show the date ranges of the items stored in this box.
Close date. Enter the latest close date for any of the items stored in this box. This field is for
information purposes and is used only to show the date ranges of the items stored in this box.
Comments. Enter any relevant comments for this box.
Home location. Click and select the location where this box is stored when not in circulation.
5. Click OK.
54
IRM Desktop Client for Users Guide
Locations
Locations provide a hierarchical representation of available locations for record folders and boxes in an
organization.
Selecting a Location
1. From the Select Item list, select a location, and click Add Selected Item(s).
2. To search for locations within a location, in the text field, type in any terms (name, ID) of a location and
click Search.
3. After adding all the desired locations, click OK.
NOTE:
To view record folders checked out for other users, click and select a user in the Show checked-out
record folders for field.
Transfer Items
The Transfer action enables you to check in a checked-out record folder, and immediately check it out to
another user. Only record folders that are currently checked-out can be transferred to other users.
1. Display a list of checked-out record folders according to the instructions in View Checked Out Items.
2. Select the record folder to transfer, and from the Actions menu, select Transfer.
The Transfer dialog box opens.
NOTE:
Electronic record folders (eRecords) cannot be circulated, as the Transfer action does not apply to
them.
• Transfer to. Click and select the new user to which the record folder should be transferred.
• Location. Click and select the new location of this record folder. This field is automatically filled
if a default delivery location is defined for the user.
• Item. The record folder ID is automatically listed in this field.
4. Click Process. The action and results open in the dialog box.
5. Click Close.
55
IRM Desktop Client for Users Guide
NOTE:
You must have the Checkout/Checkin Record privilege to perform this action.
NOTE:
You must have the View Audit History privilege to perform this action.
To do so, simply select the required text and copy (by corresponding keyboard shortcut, such as CTRL+C, or
context menu).
56