Document Maintenance Field Definitions
Field Name Definition Screen Name Table Maintenance
Abstract
The abstract associated with this document.
Document
Maintenance (Left Section)
Tables Menu – Abstract Control – Abstract Control Approved Date The date the document was approved.
IRMS fills in this date when the Status field is set to “Approved”.
Document
Maintenance (Right Section)
Auto-generated by IRMS
Archived Date The date the document was archived.
IRMS fills in this date when the Status field is set to “Archived”.
Document
Maintenance (Right Section)
Auto-generated by IRMS
Author
The author of this document.
Document
If this box is checked, then a new Global Doc has been created under this Global Doc ID number since you last made a local version. ┼
The description of the Global Doc.
Document
Maintenance (Left Section)
n/a
Blank field to the
right of Category Category description.
Document
Maintenance (Left Section)
Blank field to the
right of Product Product description.
Document
Maintenance (Left Section)
Blank field to the right of the Doc ID
The name of the internal .doc number provided by IRMS.
Document
Maintenance (Left Section)
n/a
Blank field to the
right of Topic Topic description.
Document
Maintenance (Left Section)
Blank field to the right of Web Doc?
The date the web version of this document was approved.
Document
Maintenance (Right Section)
Auto-generated by IRMS
Bullet Text The text that is to be used as the "bulleted"
subject when this document is used as part of a "Cover Letter" format.
Document
Maintenance (Left Section)
n/a
Category The category associated with this document. Leave this field blank if the document does not apply to a specific category.
The last date that a change was made to the data in this record.
Document
Maintenance (Right Section)
Auto-generated by IRMS
88
Field Name Definition Screen Name Table Maintenance
Combo (button) Starts the Combo Documents for Doc ID screen. This screen allows you to see all of the documents that are combined with this document to make one combo document.
If the letters of this button are red, then this document is part of a combo document. If this document is not a part of a combo document, you can only add it to a combo document in Combo Document
Maintenance.
Document
Maintenance (Top Section)
n/a
Control # An internal number used by IRMS. There is a unique control number for every document.
Days allowed to pass until IRMS will notify the user that a follow-up is required.
Document
Maintenance (Right Section)
Department
The department that owns this document.
Document
Maintenance (Right Section)
Tables Menu – General – Department
DM (button) The DM button starts a screen to specify a Documentum object to associate with this record.
The unique code assigned to each document.
Status(es) Tells IRMS to choose the documents with a status matching the checked boxes.
Document
Maintenance (Top Section)
n/a
Edit (button) Brings up the document associated with this record in Microsoft Word and allows you to make changes.
Document
Maintenance (Top Section)
n/a
Edit Date
The date the document was last edited.
Document
Allows you to attach an enclosure to the document. Starts the Document Enclosures screen. If the letters in this button are red, it indicates that an enclosure is linked to the current document.
Document
Maintenance (Top Section)
n/a
Expiration Date
The date the document will expire.
Document
Maintenance (Right section)
Displayed if the Expiration Date checkbox is checked in the Division
Parameters on the Document/FAQ/
Representative tab Export (button) Makes a copy of an IRMS document into a
folder of choice. Allows you to export a document to any mapped disk drive.
Document
Maintenance (Top Section)
n/a
Global Doc
The unique code assigned to each Global Document.
Document
Maintenance (Left Section)
n/a
89
Field Name Definition Screen Name Table Maintenance
Import (button) Allows you to import a document from any mapped disk drive. Import is not available if the document has a status other than
"Pending". This prevents the accidental loss of a document that is in use.
Document
Maintenance (Top Section)
n/a
Key Words General words about the document used in the Key Words field in Document Search.
For Enclosures, Key Words can be renamed to Full Citation if specified in
“EnclosureCitation” in the Division Parameters.
Document
Maintenance (Left Section)
n/a
Language The language in which the document is written. If responses are given in multiple languages, each language can have its own version of a document.
Document
Maintenance (Right Section)
Tables Menu – General – Language
Level 1 The level of security assigned to Service Reps and Contact Types for FAQ’s and all Document Types. Defined in Access Control.
Document
Maintenance (Right Section)
N/A
Level 2 The level of security assigned to Service Reps and Contact Types for FAQ’s and all Document Types. Defined in Access Control.
Document
Maintenance (Right Section)
N/A
Link (button) The Link button starts a screen for choosing a linked file to be associated with this record. If the letters are red, it indicates that IRMS is to use a linked document instead of an imported document.
The bin location of this document (used if the document is not really printed).
Document
Maintenance (Right Section)
Misc 1 A field that can be used by the licensee.
This field can be labeled something different if set up in Division Parameters to do so.
This field can be labeled something different if set up in Division Parameters to do so.
This field can be labeled something different if set up in Division Parameters to do so.
Document
Maintenance (Right Section)
n/a
Product The product associated with this document.
Leave this field blank if the document does not apply to a specific product.
Document
External Document Library Publishing.
Document
Maintenance (Top Section)
n/a
Ref Doc (button) Yes/No field. Automatically set when a reference document is associated with the document control record. Clicking this button will allow you to create or edit the related Reference Document.
Document
Maintenance (Top Section)
n/a
90
Field Name Definition Screen Name Table Maintenance
Search (button)
Brings up a screen for searching and selecting specific documents
The last date on which research was done for this document.
is unchecked in the Division Parameters on
the Document/FAQ/
Representative tab Status The status code assigned to each
document. You can change the status of a document using this combo box.
Document
Maintenance (Right Section)
Fixed pick list
Sub Type
A sub classification assigned to the document type.
This text can be used at the licensee's discretion.
Read only text of the document as imported.
Document
Maintenance (Left Section)
a
Text (button) Shows the text of this document record in a simple screen. The Edit and View buttons will show you the document in Microsoft Word.
Use varies by IRMS licensee.
Document
Maintenance (Right Section)
Title The title for the document. It is used in pick lists to help choose the correct document.
Document
Maintenance (Left Section)
Topic The topic (subject, sub-category)
associated with this document. Leave this field blank if the document does not apply to a specific topic.
Correspondence Type – will be used as a filter on the Correspondence screen.
Document
Maintenance (Right Section)
Unlock (button)
Allows you to make changes to the document record currently on the screen.
Document
Maintenance (Top Section)
n/a
View (button) Brings up the document associated with this record in Microsoft Word but does not allow you to make changes.
Document
Maintenance (Top Section)
n/a
Web Doc?
Checked box indicates that a web version of this document exists.
Document
Maintenance (Right Section)
n/a
You are Working
With: Tells IRMS which grouping of documents you are working with.
Document
Maintenance (Top Section)
n/a
91
Document Maintenance Screen Toolbar
Toolbar Button Explanation Form view Datasheet view
Create a New Document Control Record. (See the Building Document Repository section.)
Copy the Current Record. (See the Copying the Current Document Record section.)
Sort Ascending.
Sort Descending Filter by selection
Apply Filter/Remove Filter Find.
Spelling.
Print Sample Documents. (See the Printing a Sample Document section.)
Document Log. (See the Document Log section.)
Delete this Document Control Record. (See the Deleting the Current Document Record section.)
Closes the Document Maintenance screen
Chapter 11 Index
A
Access Control ... 46
C
Common Fields for All Documents ... 45Communicate with OBA Disclaimer Sample ... 39
Division Parameters ... 80
DocumentWorkflowTypesRequired ... 80
Document Maintenance ... 43
Document Notification ... 49
Document Security3 ... 36
Documentation ... 8
E
Education ... 7E-mail Templates Creating an E-mail Template ... 53
Enclosure Documents Enclosures Where Used Report ... 54
Enclosures Creating Enclosures ... 52
G
Group Security ... 81Content Management System ... 81
Workflow Administration ... 81
H
How to use this guide... 1I
Images... 36, 37 IRMS Support Contact Support ... 5How Support Works ... 5
Reporting a problem ... 5
L
Document Maintenance ... 58Enclosure Setup ... 58
Overview... 55
Verify Enclosure Data ... 59
MICI File Menu ... 61
MICI Help Menu ... 61
MICI Tools Menu... 61
P
Product Documents Creating a Document ... 51R
Reference Documents Creating a Document ... 50Report a problem ... 5
Reporting a problem ... 5
S
Security Access Control ... 46Signature ... 37, 41 Sample ... 41
Scanned ... 36, 41 Standard Document Creating a Document ... 49
System Parameters ... 79
DocumentWorkflow ... 79
T
Templates ... 47The Documents Menu ... 12
Training ... 7
94
R EVISION H ISTORY
Rev Release Date Author Comments
1.0 5.9.1.1 12/15/2010 Cheryl
Nabors No changes for Version 5.9.1.1
1.0 5.9.1.0 11/01/2010 Cheryl
Nabors No changes for Version 5.9.1.0
1.0 5.9.0.0 09/01/2010 Cheryl
Nabors Update guide for Content Management changes.
1.0 5.8.5.0 05/01/2010 Cheryl
Nabors No changes for Version 5.8.5.0
1.0 5.8.4.2 12/31/2009 Cheryl
Nabors
Chapter 6 – Medical Information Copyright Interface System Parameters section
Update Other tab with “HttpPtoxyAddress”.
Update Other tab with “HttpProxyPort”.
Update Other tab with “IsProductionEnvironment”.
Update Other tab with “NativeConnectionString”.
Chapter 6 – Medical Information Copyright Interface Document Maintenance section
Update MICI window section in Document Maintenance Chapter 6 – Medical Information Copyright Interface MICI Menu Bar
Add new section for MICI Menu Bar Chapter 8 – Workflow Processes Step 4
Add Document Maintenance screenshot for Standard document
1.0 5.8.4.0c 11/02/2009 Cheryl
Nabors Chapter 5 – Building a Document Repository
Standard Document section Add note about Reference Manager.
1.0 5.8.4.0 08/05/2009 Cheryl
Nabors
Add Workflow Process Chapters
Chapter 7 – Introduction to Workflow Processes and Chapter 8 – Workflow Processes
Chapter 13 – Appendix (for workflow) Chapter 10 – Merge and Replacement Fields Remove Merge Field definitions
Chapter 12 – Field Definitions and Toolbars Remove Merge Field column
1.0 5.8.3.3 05/08/2009 Cheryl
Nabors No changes for Version 5.8.3.3
1.0 5.8.3.2 04/08/2009 Cheryl
Nabors Chapter 5 – Building a Document Repository
Update all Document Maintenance screens. Reorganize chapter, update explanations.
1.0 5.8.3.1 03/15/2009 Cheryl
Nabors No changes for Version 5.8.3.1
95
1.0 5.8.3.0 02/01/2009 Cheryl
Nabors Chapter 2 – Document Menu
Update Overview section .
Change Division Parameter from “WarnExpiredDocs” to
“WarnExpiredDocTypes”
1.0 5.8.2.1 07/08/2008 Cheryl
Nabors Chapter 4 – Response Letter Managment
Update Letter Format section for Printing Dymo Labels.
1.0 5.8.2.0 05/01/2008 Cheryl
Nabors Chapter 5 – Building a Document Repository
Update Creating a Standard Document section for Enclosures, Product Documents, and Combo Documents
Add description for Document Sub Type in Document Maint Add Creating a Product Document section
Chapter 6 – Medical Information Copyright Interface (MICI) Add chapter for new module.
1.0 5.8.1 11/15/2007 Cheryl
Nabors Chapter 5 – Building a Document Repository
Update Adding a Standard Document section for Document Notification Update Adding a Local Standard Document to a Global section for Document Notification
Update Access Level for Service Reps
1.0 5.8.0 08/15/2007 Cheryl
Nabors Reformat Guide for new Documentation Guide Standards.
Chapter 5 – Building a Document Repository
Update Key Words description for Templates, Email, and Enclosures Chapter 6 – Importing and Exporting Documents
Add Importing Enclosures using Import Wizard section Chapter 9 – Field Definitions and Toolbars
Update Key Words definition.
1.0 5.7.1 05/15/2007 Cheryl
Nabors
Chapter 5 – Building Document Repository Add “Common Fields for All Document Types” section Add Access Control section
Chapter 11 – Field Definitions and Toolbars Update new field definitions
1.0 5.6.0 05/16/2006 Cheryl
Nabors
Chapter 2 – Documents Menu Update menu with new shortcut keys Chapter 3 – Types of Documents…
Update Enclosures section with maximum of 50 Enclosures Chapter 5 – Building Document Repository
Adding Documents to Document Repository Add section called “Adding an E-mail Document”
Chapter 7 – Merge Fields
E-mail Corporate and E-mail Representative Replacement Fields from Case Entry
Add “ALLCONTACTSEMAILS” to the Replacement Fields from Case Entry.
Chapter 11 – Field Definitions and Toolbars
Add Expiration Date and update Search date for Expiration Date checkbox in the Division Parameters.