Академический Документы
Профессиональный Документы
Культура Документы
Title: IDM 4.0 - Basic user guide Doc.ID: DBAC482924 Revision: ax Author: Finalised by: Organisation: Corporation (HQ) Project number and name: / IDM 4.0 - Basic user guide.docx Virve Linnanoja Ravi Aswani / 28.06.2013 Status: Pages: Finalised 1 (82)
Revision: ax
2 (82)
Table of contents
Table of contents ............................................................................................................................ 2 IDM basic user guide ...................................................................................................................... 4 General information ........................................................................................................................ 4 Vision of IDM ............................................................................................................................... 4 Overview of IDM .......................................................................................................................... 4 IDMs role .................................................................................................................................... 5 Workspaces role ......................................................................................................................... 5 Information structure in IDM ........................................................................................................ 5 Information classification ............................................................................................................. 7 IDM standard document life cycle ................................................................................................ 7 Major and minor revisions ........................................................................................................... 8 User interface ................................................................................................................................. 8 Document actions...................................................................................................................... 10 Document properties ................................................................................................................. 10 Document links .......................................................................................................................... 12 Basic operations in IDM ................................................................................................................ 13 General ..................................................................................................................................... 13 Opening and logging in to IDM ............................................................................................... 13 Logging out from IDM ............................................................................................................ 14 Doczones .................................................................................................................................. 15 Filtering the doczone list ........................................................................................................ 16 Viewing doczone settings....................................................................................................... 16 Folders ...................................................................................................................................... 18 Documents ................................................................................................................................ 18 Creating a document.............................................................................................................. 18 Creating a subdocument ........................................................................................................ 21 Viewing the document properties ........................................................................................... 21 Editing the document properties............................................................................................. 21 Uploading a file ...................................................................................................................... 22 Replacing a file ...................................................................................................................... 24 Viewing files ........................................................................................................................... 25 Editing files ............................................................................................................................ 26 Locking files and documents .................................................................................................. 27 Unlocking files and documents .............................................................................................. 28 Changing status ..................................................................................................................... 30 Creating a new revision ......................................................................................................... 31 Viewing the revision history .................................................................................................... 32
Revision: ax
3 (82)
Viewing the operation history ................................................................................................. 33 Adding a comment ................................................................................................................. 34 Editing a comment ................................................................................................................. 36 Subscribing to document or folder changes ........................................................................... 38 Subscribing to What's new ..................................................................................................... 39 Unsubscribing to Whats new ................................................................................................. 41 Sending a document link ........................................................................................................ 41 Sending MS Office files to IDM .............................................................................................. 44 Sending emails to IDM ........................................................................................................... 45 Sending emails from MS Outlook to a folder in IDM ........................................................... 45 Uploading emails ................................................................................................................ 45 Using Send to IDM function in MS Outlook ......................................................................... 46 Selecting different document list views ................................................................................... 49 Using the default view ........................................................................................................ 50 Using the subdocs view ...................................................................................................... 50 Using the custom view........................................................................................................ 51 Using the predefined view .................................................................................................. 52 Sorting document list views .................................................................................................... 53 Exporting a document list ....................................................................................................... 53 Viewing recently accessed items ........................................................................................... 56 Clipboard tools ....................................................................................................................... 58 Size limits for copy/pasting to clipboard .............................................................................. 59 Moving documents ............................................................................................................. 59 Linking documents or folders .............................................................................................. 60 Unlinking documents or folders .......................................................................................... 61 Clipboard functions ................................................................................................................ 62 Extracting files from clipboard............................................................................................. 63 Exporting files from clipboard ............................................................................................. 64 Making mass status changes ............................................................................................. 65 Making mass access profile changes ................................................................................. 67 Making mass changes in the document or folder properties ............................................... 69 Searches ................................................................................................................................... 73 Result limit for documents listed............................................................................................. 73 Using filters ............................................................................................................................ 73 Using the advanced search.................................................................................................... 74 Creating a stored search ........................................................................................................ 79 Using the global search ......................................................................................................... 80 Useful links ................................................................................................................................... 82
Revision: ax
4 (82)
The IDM basic user guide includes general information about IDM and its interface as well as basic procedures applicable to end users when using the software. The material in the guide is based on IDM 4.0 and is divided into the following main sections:
General information
Vision of IDM
The Wrtsil integrated document management solution (IDM) is a global platform that supports a common way of working and enables secure sharing of business documents, thus improving productivity and the use of knowledge.
Overview of IDM
In Wrtsil, IDM is a platform for managing: Mature business critical documents, which are an integral part of the customer project communication, documentation or other deliverables, or relate closely to the internal management of Wrtsil as a company. Documents that may be used as evidence on Wrtsils behalf in court. In addition to office documents, this can also apply to product images and project correspondence. Information that needs revision control, that is, users need to be able to identify the latest and all revisions of the documents. Information that needs global unique IDs, that is, the document numbers given to IDM documents are not given to any other information objects within Wrtsil. Information that needs global availability with structured access rights. Information that needs key document risk management, that is, the risk is high if the documents are stored in one personal computer only.
Revision: ax
5 (82)
IDMs role
The role of IDM is to: Provide official documentation Manage records Control revisions of the documents Publish documents Provide open access (not always applicable)
Workspaces role
Alongside with IDM, some documentation is also stored in Compass. Opposed to IDM, the Compass workspaces: Store unofficial documentation Provide no history review or traceability Include time management, calendars, discussion boards et cetera Usually provide restricted access
Revision: ax
6 (82)
Figure 2 Levels
Doczones IDM consists of doczones. Each doczone is unique and has its own folder structure, document properties and access profiles. Folders Folders contain other folders (subfolders) and documents. The folders can have different properties (be of different folder types or have different status). Documents Documents are located in folders. All documents have general properties such as author information, document number and date when the document was created. The documents can be of different document types (contracts, offers, complaints, tasks, events or reports), have different status (draft, checked, approved) and business (belong to Power Plants, Ship Power business area etc.). The document can also have separately defined custom property fields only applicable to that particular document type. The documents contain files, web links or links to other documents. Files Files are attached to documents. Documents can contain multiple files of different type and size. All attached files have the same properties as their parent document. The only way to give different properties (e.g. access profiles) to two different files is to attach them to two different documents.
Revision: ax
7 (82)
Information classification
All documents and other material in IDM must be classified as either Internal, Confidential, Public or Secret. The owner of the document is responsible for the security classification of the document. The default classification is Internal. For more information, see: Presentation of classification https://fiidm01.wnsd.com/kronodoc/SIM/DAAB521183 Classification instructions for information and documents https://fiidm01.wnsd.com/kronodoc/SIM/DAAB510044
Figure 3 Document life cycle If you do not need approval from any another person, you can change the status from Draft to Finalised when the document is complete. If you need approval from another person, ask him/her to change the status to Approved.
Note! All statuses except for the Draft status are frozen, that is, the documents cannot be modified after the status change unless you create a new revision. Also remember that if your document is in the Draft status anyone with modify rights can change its properties.
Revision: ax
8 (82)
User interface
The user interface in IDM is explained below.
Revision: ax
9 (82)
1. The header area shows In which doczone you are located your username your user group(s) possible user role(s)
2. The upper right-hand corner includes: Link to the Settings page Link to the Help pages Logout link
3. The navigation tabs are displayed below the header area: Doczones Documents Folders Whats new
4. The tree browser and My recent items are located on the left-hand side. Tree browser The folder structure makes the doczone easier to navigate. The folder contents are shown on the right-hand side of the view. The My recent items list holds up to 10 files, 10 documents and 10 folders, which you have accessed recently in IDM (across all doczones). In the list you can see the IDs, names and revisions of the recently accessed items. 5. The folder name and path is displayed in this section and the Search field is available to the right. 6. The Document field includes the actions that are available for the documents, clipboard functions and document list views that can be selected. 7. The documents and files are listed in the document list. The Actions menu to the right of the documents contains the document actions available for the user. This drop-down menu can also be found in the doczone and folder list.
Revision: ax
10 (82)
Document actions
Figure 6 Document actions The available document actions in the Document field are the following: 1. Create An empty document property page is displayed. Fill in the properties and save. 2. Upload file In the Upload file for new document view, browse for the file(s) or drag and drop them to the dialog box. Click Upload file for new document. An empty document property page is displayed. Fill in the properties and save. 3. Create from template Select the correct file template from the pop-up window. Once the file template is selected, the normal document creation view is shown. 4. Remove To delete or unlink a document, select the document and click Remove. A confirmation message is shown. Click Yes, remove document(s). This action unlinks the document, if it is present in several folders, and deletes it, if it resides only in the current folder. 5. Export for offline browsing Select the files that need to be exported in order to be able to browse and work offline with the contents. It is possible to export the metadata or complete file content.
Document properties
When clicking a documents name in the document list, the document property page opens. The page consists of sections with information about the documents properties. The sections are the following: Files: List of files and links attached to the document. General: The general properties are used for identifying the document. The general section also includes the life cycle status of the document. Doczone specific properties: Includes the specific properties configured for a certain doczone. Organizational properties: Includes the organizational properties of the document. Solution properties: Includes the solution properties of the document. Wrtsil standard properties: The information classification shows the classification of the document and the language defines the document language. For more details on the information classification, see Information classification. Collaboration: This section includes the comment functions, notifications field and access profile information of the document. With the comment function the user can add comments to the document. The notifications section shows a list of the doczone users, groups and other email addresses that receive a notification every time the document is changed. The access profile is used to specify the access rights to the document. Links: List of links to the documents availability in different folders, its parent and subdocuments as well as a link to different revisions of the document.
Revision: ax
11 (82)
Revision: ax
12 (82)
Document links
The bottom of the documents property page includes links to the document. These can be copied to emails or put inside other documents as shortcuts to the documents. The link to this revision is a link to the current revision of the document (for example if you are viewing a revision that is not the latest one). The link to the latest revision is a link to the latest revision of a document, whichever status it is in. The link to the released revision is a link to the finalised or approved revision of the document.
Revision: ax
13 (82)
General
Opening and logging in to IDM
IDM is part of Wrtsils standard application Sonad.
To open IDM with Windows 7, use this link: https://fiidm01.wnsd.com/kronodoc To open IDM with Windows XP, click the Start menu, select Sonad and IDM.
IDM has autologon, so you do not need to log in. If you anyway see the login page, enter your ACCDOM user name and password.
Note! By the time this documentation was created the colours in the testing environment were still green as provided in the base product by the vendor. After the Go-Live 16-19.8.13, the figures in this document will reflect the new corporate colours.
Revision: ax
14 (82)
Revision: ax
15 (82)
Doczones
The doczone list is the initial view when opening or logging in to IDM.
The doczone list contains all IDM doczones that are available according to your access rights. To enter a doczone and view its contents, click the doczone name.
Revision: ax
16 (82)
To see the list of key users for a specific doczone: 1. Go to the Actions column. 2. Click the arrow next to the doczone name to see the Dozone actions drop-down list. 3. Select Settings. The Doczone view opens and they key users are listed in the Description field.
Revision: ax
17 (82)
Figure 14 List of key users The doczone settings also include a short description of the content of the doczone and the name of the doczone owner. Always contact your doczone key user first when you have something to ask about IDM. If the key user cannot answer your question, send a support request to Helpdesk.
Revision: ax
18 (82)
Folders
Creating shortcuts to folders Create shortcuts to folders by making the folders to root folders and adding the web pages to your browsers Favourites menu: 1. Select the folder. 2. Click View as root. 3. Add the web page to your browsers Favourites menu. To restore the folder structure, click the green arrow.
Documents
Creating a document
Figure 16 Create a document To create a document: 1. Click Create. 2. Fill in the document properties: a. Document name* b. Authors e-mail c. Business* (select from the drop-down menu) The business defines to which business unit the document belongs (e.g. Power Plants, Ship Power). d. Type* (select) The type defines of which type the document is (e.g. check list, device list, guide
Revision: ax
19 (82)
line). e. Description f. Life cycle (select) If the life cycle is not forced, a suitable life cycle must be selected. g. Information classification (select) The information classification determines the visibility of the document, that is, whether it is internal, confidential, public or secret. h. Language (select) i. Notification (if needed) The notification field determines who receives notifications about changes in the document. j. Access control (select) The access control is by default the same as for the parent document, but can be changed, if needed. * = mandatory fields 3. Click Save. 4. To add a file to the document, click Upload file. For more information, see Uploading files.
Revision: ax
20 (82)
Revision: ax
21 (82)
Creating a subdocument
To create a subdocument: 1. Click the correct document name for which you want to add a subdocument. 2. In the Links section, click Create subdocument.
A Create document window opens. Note! This function is not available for documents in frozen status. 3. Fill in the document properties. 4. Click Save.
Revision: ax
22 (82)
3. Edit the document properties. When editing the properties, key icons appear on the documents property page to indicate that the document is locked for editing.
1. Click the name of the document whose properties you want to edit. The document property page opens. 2. In the General section, click Edit.
Figure 22 Edit the document properties 3. Edit the document properties. 4. Click Save.
Other users are not allowed to edit a locked document but they can upload files under the same document and read/view all files within the same document.
Uploading a file
To upload a file: 1. Select the correct folder where you want the file to be located. 2. Click Upload file. The Upload file for new document view opens.
Revision: ax
23 (82)
3. Select either Drag and drop upload or Classic upload. Note! You can upload several files at the same time. Drag and drop upload: a. Click Drag and drop upload. The Upload file for new document view opens.
Revision: ax
24 (82)
b. Drag and drop the files to the Upload file for new document field. c. Click Upload files for new documents. Note! Emails cannot be dragged and dropped directly from Outlook. OR Classic upload: a. In the Upload file for new document view, click Classic upload. The Upload file for new document view opens.
Figure 26 Upload files in classic mode b. c. d. e. Click Browse. Select the file(s) from your computer. Click Open. Click Upload file for new document.
Replacing a file
To replace a file: 1. Go to the document whose file you want to replace. 2. Click the document name to see the document property page. 3. In the Files section, click Add files.
Revision: ax
25 (82)
4. Figure 27 Add files 5. Upload the file as described in Uploading files, e.g: a. Browse for the document. b. Click Open. c. Click Upload.
When uploading a file to a document with exactly the same file name as the existing one, the user is asked whether the file is to be replaced or uploaded to a new revision.
Figure 28 Replace file or upload to new revision Click Replace files to replace the existing file in IDM with the new one. Click Upload to new revision to upload the file to a new revision.
Note! Only the document owner or a key user can replace the file by using the same document revision. Other users always need to create a new document revision.
Viewing files
The files attached to IDM documents can be of any type and the size limit is 2 GB. URLs can also be stored as attachments to IDM documents. A URL is a web link, which starts with http:// or https://. 1. To view file(s) or URL(s) attached to a document, click the file name to open the File actions drop-down menu. 2. Select View file. 3. Click Open.
Revision: ax
26 (82)
Editing files
To edit a file: 1. Click the file name to open the File actions drop-down menu. 2. Select Lock and checkout to edit the file.
3. 4. 5. 6. 7.
Click Open. Edit the file. Save the file. To check in the file, click the file name and select Check-in from the File actions menu. Upload the file as described in Uploading a file or, if you edit an MS Office document, in Sending MS Office files to IDM. See also Replacing a file.
Revision: ax
27 (82)
Figure 31 Check-in a file Key icons appear on the documents property page to indicate that the document is locked for editing.
The document is unlocked when a new file is uploaded. Other users are not allowed to edit the contents of a locked file but they can upload files under the same document and read/view all files within the same document.
Revision: ax
28 (82)
To lock the document itself: 1. Go to the Document actions drop-down list. 2. Select Lock.
OR 1. Click the document name to see the document property page. 2. Select Lock to lock the document.
Revision: ax
29 (82)
To unlock a document: 1. Go to the Actions drop-down list. 2. From the drop-down menu, select Unlock.
Revision: ax
30 (82)
Note that you cannot unlock a file or document that someone else has locked.
Changing status
To change the status of a document: 1. Click the document name to see the document property page. 2. In the General section, click Change status.
Figure 43 Change status 3. Choose the desired status. 4. Add a status change comment to explain the reason for making the change. 5. Click Commit status. Remember that status changes are restricted to defined user groups and the documents life cycle.
Revision: ax
31 (82)
4. In the opening view, add a reason for the new revision, if needed. 5. Change the current revision status, if needed. 6. Deselect any of the automatically predefined values if they are not to be copied to the new
Revision: ax
32 (82)
revision: Copy properties to new revision Copy files to new revision Copy subdocument links 7. Click New revision.
Figure 46 Revision comment 8. On the document property page and in the Files section, click Add files. 9. Upload the files as instructed in Uploading files.
Revision: ax
33 (82)
The document history lists the actions that have been performed to a document. The following actions are recorded about the files: Viewing Creating Status changes Linking/unlinking Uploading Deleting
If a user commits two consecutive actions of the same type, only the first one is recorded (for example viewing document properties two times in a row). The operation history is saved for each document revision separately.
Revision: ax
34 (82)
To view a documents operation history: 1. Click the name of the document for which you want to see the operation history. 2. In the General section, click History.
In the Document change history field all operations performed to the document are listed.
Adding a comment
To add a comment: 1. Click the document name to see the document property page. In the Collaboration section, click Add comment.
2. In the New comment view, add a comment. 3. If you want to attach a file to the comment, click Browse. Note! It is only possible to attach one file per comment. 4. Click Save comment. If the attached file is a text file (.txt or .html), the file content is attached to the comment field if it is empty.
Revision: ax
35 (82)
Revision: ax
36 (82)
Figure 53 Empty comment field to which the content of the text file has been added
Editing a comment
Comments can be edited and marked as obsolete. The maximum length for a comment is 98 000 characters. To edit a comment: 1. Click the document name to see the document property page. 2. In the Collaboration section, click View comments.
Figure 54 View comments 3. Click Edit to edit the comment. Note! Only own comments can be edited and marked as obsolete.
Revision: ax
37 (82)
4. Write a new comment and click Save comment. The previous comment is crossed out and marked as obsolete when it is edited.
Figure 56 Edited/obsolete comment 5. Click Mark obsolete to change the status of the latest comment to obsolete. 6. Click OK in the pop-up window.
Revision: ax
38 (82)
Notifications provide a way to stay informed about the status of individual folders or documents. Notifications are delivered to the users through emails. In IDM you can subscribe to notifications for yourself or push notifications to other IDM users. To subscribe to notifications: 1. Click the document or folder name to enter the property page. 2. In the Collaboration section, click Subscribe.
Your user name appears in the subscriber notification field and a subscription icon in the document or folder summary.
Revision: ax
39 (82)
To unsubscribe a notification: 1. Click the name of the document or folder whose reports you want to unsubscribe. 2. In the Collaboration section, click Unsubscribe.
Figure 62 Unsubscribe document or folder changes The subscription icon in the document or folder summary on top of the page and your user name in the subscriber notification field disappear.
Figure 64 All changes 3. In the All changes view, select options from the Filter and Changes done drop-down menus, if you want to subscribe to a certain kind of documents. You can make filters for your subscription based on the status, type or business of the documents as well as time when the documents have been changed. You are also able to select if you want to subscribe all folders in the doczone or only the current folder and its subfolders. 4. Click Subscribe.
Revision: ax
40 (82)
A Subscription options view opens. 5. Fill in a subscription name. 6. Select the box Notify to receive the subscriptions by email. 7. Click Subscribe.
Figure 66 Subscription options To check if you have successfully subscribed to the folder changes: 1. Click Subscriptions.
Figure 67 Subscriptions 2. Click the Filter drop-down menu to see if the new subscription is available. You have successfully subscribed to the folder changes if you can see the subscription in the Filter drop-down menu.
Revision: ax
41 (82)
Figure 69 What's new 2. From the Filter drop-down list, select the Whats new report that you want to unsubscribe. 3. Click Unsubscribe.
Figure 70 Unsubscribe OR Click Unsubscribe at the bottom of the Whats new report email.
1. Click the document or folder name to see the property page. 2. In the General section, click Send.
Revision: ax
42 (82)
Figure 73 Send document form 1. In the Recipient(s) field, add recipients in any of the following ways: a. Click Add users. The Find users dialog box opens. i. Fill in the users username, first name or last name. ii. Click Find users. The user is automatically added to the Recipient(s) field. If several users are found with the search criteria, click Select to add the correct user to the Recipients field.
Revision: ax
43 (82)
Figure 74 Find users dialog box b. Select the group(s) from the Groups list. i. Press the Ctrl button to select and deselect groups. ii. Click Expand groups to add the selected group(s) to the recipient list. To unselect users from the Recipient(s) field, select the users and click Remove users. Press the Ctrl button to select and deselect several users or one by one. Note! The groups in the Send functionality are not Outlook groups. 2. To forward the message to you own email address, select the checkbox Send a copy to myself. 3. To hide the recipients email addresses, select the checkbox Hide recipient addresses. These email addresses are added to the BCC field of the email and are not revealed. 4. To add an email message to the document or folder link, select the check box Add email with recipients to documents as comment. 5. To add the files in the email, select Attach files in documents. This can be used if the recipients do not have access to IDM. 6. To remove links to IDM documents from emails to users that do not have IDM accounts, deselect Send HTML with document links. 7. To send subdocuments together with the main documents, select Send subdocuments. 8. To send non-editable formats (read-only files), select Do not send editable formats. 9. In the Subject field, enter the subject of the email. 10. In the Message field, enter the email message. 11. Click Preview message to preview the message before sending.
Revision: ax
44 (82)
Figure 75 Message preview dialog box 12. In the Message preview dialog box, click Edit message to edit the message. 13. Click Send to send the message.
The IDM Office integration is a part of Wrtsils standard Sonad application. This means that you can send MS Office files directly to IDM.
To send an MS Office file to IDM: 1. Select the Add-Ins tab in Word, PowerPoint or Excel. Note! If you do not have this button, contact Wrtsil Helpdesk. 2. Click the Send to IDM button. 3. Select IDM production. A new browser window starts to blink in the taskbar. 4. Open the window. IDM remembers from where you have checked out the file. 5. Click the Upload button and the file is uploaded to IDM. After the upload you can close the previous browser window and the file.
Revision: ax
45 (82)
To send an email directly from MS Outlook to a folder in IDM, proceed as follows in MS Outlook: 1. Add the projects email address to the To or Cc field in your email. 2. Send the email. The folders email address must have been configured and sent by the administrators beforehand. The email is saved as a file in .eml, .html and .txt format under the document.
Uploading emails
1. Select the folder in IDM where you want to add the email. 2. Click Upload file.
Revision: ax
46 (82)
3. Upload the file as described in Uploading files, e.g.: a. Browse for the email. b. Click Open. c. Click Upload file for new document.
Note! Email messages cannot be dragged and dropped directly from MS Outlook so you need to save them on your computer to be able to upload them.
Revision: ax
47 (82)
3. Enter the password. The user name is filled in automatically. 4. Click Connect. The doczone structure of the IDM installation is replicated in alphabetical order in the Send to IDM dialog box. 5. Navigate to the target folder where the emails are to be created. 6. Add a document description, if needed. The description is added to the description field of the IDM document. 7. Select the obligatory properties (relevance, document type, life cycle and access profile) unless they are filled in automatically before sending the selected email(s) to IDM. Note! If the documents property values are not available after you have navigated to the target folder, click Load Properties. 8. Click Send when all document property values have been selected. The operation ends with a report informing about the successful creation of the email in IDM. There are links to all created documents in the report. Click the links to open the documents in your default web browser.
Revision: ax
48 (82)
The emails that are sent from MS Outlook to IDM follow the same principle as documents that are created by a user in IDM, but with the following additions: The email subject is stored in the documents name field. The text entered in the description field in the Send to IDM dialog box is stored in the IDM documents description field. The selected document properties in the Send to IDM dialog box (relevance, document type, life cycle and access profile) are filled in as such to the created document. The created document in IDM has two attachments by default: o The original email message from Outlook in the file format .msg. o A text file that includes the complete email message body. o If the email contained a number of attachments, they are stored as additional file attachments to the IDM document.
With the Outlook integration you are able to add IDM folders to your Favorites tab in the Send to IDM dialog box. To add folders to the Favorites tab: 1. Click Connect. 2. In the Browse tab, select the folder you want to add to your Favorites. 3. In the Favorites menu, select Add to favorites. 4. Go to the Favorites tab. 5. Verify that the folder is listed.
To remove folders from the Favorites tab: 1. Select the Favorites tab. 2. Click the name of the folder you wish to remove. 3. In the Favorites menu, select Remove from favorites. 4. Click OK. 5. Go to the Favorites tab. 6. Verify that the folder is removed.
To rename folders in the Favorites tab: 1. Select the Favorites tab. 2. Click the name of the folder you wish to rename. 3. In the Favorites menu, select Rename favorites.
Revision: ax
49 (82)
4. Enter the new name for the folder in the pop-up window. 5. Click OK.
Revision: ax
50 (82)
The Default mode now lists the documents and attached files/URLs as well as the document properties document ID, revision, name, status and modification date.
To see documents and their subdocuments: 1. In the Document field, select Subdocs from the drop-down list.
Revision: ax
51 (82)
Figure 87 Subdocument For information on how to create subdocuments, see Creating a subdocument.
The Custom view provides the possibility to freely choose which property fields to be shown in the document list. To customize a document list: 1. Go to any folder where the documents are listed in the Default mode. 2. In the Document field, select Custom from the drop-down list.
Figure 89 Show field selection 4. In the Common fields section, select the fields you want to see in the Custom view of the document list. 5. Click Update. 6. To hide the settings, click Update and hide.
Revision: ax
52 (82)
Figure 90 Common fields To export a customized document list, see Exporting a document list.
Revision: ax
53 (82)
Figure 93 Custom view 3. In the List field, click Show field selection.
Figure 94 Show field selection 4. In the Common fields section, select which fields you want to include in the Excel.
Revision: ax
54 (82)
Figure 95 Common fields 5. 6. 7. 8. Click Update. Below the Common fields section, check if the result is according to your preferences. If the selection is correct, click Update and hide. In the List field and from the Export drop-down menu, select MS Excel (XLS).
Revision: ax
55 (82)
Figure 97 Save the xls file The customized document list is exported to Excel. The new Excel file includes columns with the previously selected field information.
Revision: ax
56 (82)
Figure 99 My recent items The My recent items list holds up to 10 files, 10 documents and 10 folders, which you have accessed recently in IDM (across all doczones). In the list you can see the IDs, names and revisions of the accessed items. To view an item (and its properties), click the name.
The Checked out field contains links to files that you have checked out for editing. To check in the files, go to the Checked out field and click Check-in.
Revision: ax
57 (82)
To see the complete list of files (more than 10) that have been accessed recently or are locked/checked out, click the icon next to the My recent items title.
A My recent items view opens where all the recent items are listed.
Figure 101 My recent items view To see all locked/checked out files, click My locked files. To check in the files, click Check-in next to the document name.
Revision: ax
58 (82)
Clipboard tools
Figure 103 Clipboard tools The Clipboard drop-down menu consists of six functions: 1. Set to clipboard When selecting this option the clipboard is first emptied and then the currently selected document(s) are placed in it. If no documents are selected, the current folder is placed on the clipboard. 2. Add to clipboard This function works in the same way as the previous option, except for that the clipboard is not reset, but the items are added to the clipboards current contents. 3. Copy from clipboard Select this option to paste the clipboard contents to the current folder. 4. Move from clipboard When moving documents from the clipboard they are also unlinked from their original folders. 5. Link from clipboard Select this option to link the clipboard contents to the current folder.
6. View clipboard contents Select this option to open the clipboard. Inside the clipboard you can clear, extract or export the clipboard contents. There are also functions to drop selected items, change status, change ACPs, edit roles and edit fields.
Revision: ax
59 (82)
Moving documents
Documents can be moved by linking to the target folder and unlinking them from the source folder. Note! This function cannot be used for folders. If you want to move folders, see Linking documents or folders and Unlinking documents or folders.
To move a document: 1. Navigate to the desired document. 2. From the Clipboard drop-down menu, select Set to clipboard.
Figure 104 Set to clipboard 3. Navigate to the desired target folder. 4. From the Clipboard drop-down menu, select Move from clipboard.
Revision: ax
60 (82)
Figure 105 Move from clipboard 5. Click Yes, unlink document(s). Note! When moving documents, the documents are unlinked from their original folders. Documents can be moved from one folder to another inside the same doczone. To move documents between doczones is not possible.
To link a document or folder: 1. To link a document or folder to another document or folder, select the item in the document or folder list. 2. From the Clipboard drop-down menu, select Set to clipboard.
Revision: ax
61 (82)
Figure 107 Set to clipboard 3. Navigate to the desired target document or folder. 4. Select Link from clipboard.
The document or folder is linked as a subdocument or subfolder to the selected target document or folder.
Figure 109 Remove links 3. Select the document(s) or folder(s) for which you want to remove the links and click Unlink document or Unlink folder.
Revision: ax
62 (82)
Clipboard functions
Figure 111 Clipboard functions The clipboard has the following functions: Clear Click Clear to empty the clipboard. Send Click Send to send the contents of the clipboard. Follow the same instructions as in Sending a document link. Extract Click Extract to extract files with file name modifications to a zip-file. See Extracting files from clipboard. Export Click Export to export files with detailed information (metadata) to a zip-file. See Exporting files from clipboard. Drop selected items Click Drop selected items to drop items from the clipboard. Change statuses Click Change statuses to change the status of multiple documents at the same time. See Making mass status changes. Change ACPs Click Change ACPs to change the access profile of multiple documents at the same time. See Making mass access profile changes. Edit fields Click Edit fields to set one field to a single value in many documents at the same time. See Making mass changes in the document or folder properties.
Note! The clipboard functions apply to all items available on the clipboard. If you do not want all documents on the clipboard to be affected by the changes, select the checkbox in front of the items that need to be excluded from the operation and click Drop selected items. The checkboxes are not valid for any other clipboard function.
Revision: ax
63 (82)
Figure 113 Save the zip file A zip file is created and contains files with modified file names. A modified file name is for example: DBAC394179-.1Specification.docx
Revision: ax
64 (82)
Figure 116 Save the tar file A zip file with the files is created. A xls file, with detailed information (metadata) about the files, is also included.
Revision: ax
65 (82)
5. Extract the zip file. In the extracted folder the files are sorted according to their document IDs in own folders.
Figure 119 Change status Note! The clipboard functions apply to all items available on the clipboard. If you do not want all documents on the clipboard to be affected by the changes, select the checkbox in front of the items that need to be excluded from the operation and click Drop selected items. The checkboxes are not valid for any other clipboard function.
4. Select the target status for the documents on the clipboard. 5. Click Preview status change.
Revision: ax
66 (82)
Figure 120 Preview status change 6. Review the summary of changes that will be applied to the documents. 7. Click Confirm status change to confirm the status change.
Revision: ax
67 (82)
Note! If you are trying to change the status for a document that is already in the selected target status, a comment is shown in the Preview status changes view.
Revision: ax
68 (82)
Note! The clipboard functions apply to all items available on the clipboard. If you do not want all documents on the clipboard to be affected by the changes, select the checkbox in front of the items that need to be excluded from the operation and click Drop selected items. The checkboxes are not valid for any other clipboard function.
4. Select the target access profile for the documents on the clipboard. 5. Click Preview.
6. Review the summary of changes that will be applied to the documents. 7. Click Confirm changes to change the access profiles.
Revision: ax
69 (82)
Note! If you are trying to change the access profile for a document that already has the selected target access profile, a comment is shown in the Preview access control profile changes view under the concerned document name.
4. Make simultaneous changes to various properties of the documents or folders. a. Add information to the fields by writing in the text fields or changing the values. b. To empty fields, tick the box in front of the field name.
Revision: ax
70 (82)
6. Review the summary of changes that will be applied to the documents or folders. 7. Click Confirm changes.
Revision: ax
71 (82)
OR To edit the document or folder fields one by one, but in the same view: 1. In the Edit fields for multiple objects view, select the fields to be edited by ticking the box in front of the field names. 2. Click Tabular view.
Figure 130 Tabular view 3. Edit each field separately. 4. Click Preview edited fields to preview the changes.
Revision: ax
72 (82)
5. Review the summary of changes that will be applied to the documents or folders. 6. Click Confirm edited fields to confirm the changes.
Revision: ax
73 (82)
Searches
The IDM search covers indexed full text search and property field searches for titles, authors and descriptions. The keyword search always searches all documents in the doczone containing the search parameter entered. If the search keyword is 1-3 characters long (letters or numbers), only the document properties are searched. When the search string is 4 characters or longer, both document properties and file contents are searched (for example the contents inside doc, ppt, txt, xls and printed pdf files). In the advanced search you can specify the search scope to include: Only the current folder The current folder and its subfolders All folders
You can also select multiple search criteria in the advanced search. Search is an effective way to find documents from any folder in the doczone without browsing through the whole folder structure.
Using filters
Documents in the document list can be filtered by: Revision Status
Revision: ax
74 (82)
To filter documents: 1. Go to the folder whose documents you want to filter. 2. From the Filters drop-down menu, select in which way the documents are to be filtered (that is, according to Any, Latest or Latest + Completed revision).
Note! Always remember to reset the filters by clicking Reset above the document list.
Figure 135 Advanced search Note! The search criteria in the dialog box can be used in addition to or instead of each other. The more criteria you fill in, the more accurate search results are given. It is possible to use only one criteria as well, but the default search result limit is 10 000 items. The search examples below are made as separate examples for each field, that is, with no connection to each other. The instructions below do not need to be performed in any particular order. If you want to use a predefined stored search, select the stored search from the drop-down list in the Stored search options field.
Revision: ax
75 (82)
Note! If you make modifications to the stored search, it does not affect the original stored search.
Figure 136 Stored search options o Click Search. The search results are displayed.
To create a stored search, see Creating a stored search. Once the stored search has been created, it appears in the Stored options dropdown list. In the Document search criteria Properties field: o Add a keyword for the search. Note! The keyword search always searches all documents in the doczone containing the search parameter entered. If the search keyword is 1-3 characters long (letters or numbers), only the document properties are searched. When the search string is 4 characters or longer, both document properties and file contents are searched (for example the contents inside doc, ppt, txt, xls and printed pdf files). o In the Revision field, select which revision you want to search for (latest or latest + completed). o In the Status field, select in which status the documents need to be. o In the Document type field, select which document type is to be searched for (e.g. specifications, drawings or system descriptions). o In the Business field, select which business area the documents searched for belong to.
Figure 137 Document search criteria Properties In the Document search criteria Property field: o Select a search term from the drop-down list (e.g. Author or document name of the desired document).
Revision: ax
76 (82)
Figure 138 Search term o o Specify the search term from the following drop-down list, that is, if the search term contains, equals, starts or ends with a specific added string or not, or if it equals a specific number or is greater/less than a specific number. In the empty text field, add the string that you want to search with.
Revision: ax
77 (82)
If you now want to add another search criteria, click Add search term and repeat the options described above. When the additional search term has been added, a new drop-down list appears on the top from which you now can select that the search must match all of or any of the given criteria.
Figure 140 Match all or any criteria o If you want to add another search criteria group, click Add search term group. To add an additional search criterion within the same group, click Add search term. When the additional search term has been added, a new drop-down list appears on the top from which you can select that the search for this group must match all of or any of the given criteria. Between these two groups you can now add the Match any of or Match all of criteria on the top.
Revision: ax
78 (82)
In the Parent folder search criteria field, add which criteria you want to search for regarding the parent folder: o In the Status field, select in which status the parent folder needs to be. o In the Type field, select of which type the parent folder needs to be. o In the Search term field, select a search term from the drop-down list (e.g. creation time or folder name of the desired parent folder). o Specify the search term from the following drop-down list, that is, if the search term contains, equals, starts or ends with a specific added string, or if it equals a specific number or is greater/less than a specific number. o In the empty text field, add the string that you want to search with.
Figure 142 Parent folder search criteria In the Search properties field, specify the search scope: o Select Update scope from parent window to be able to reuse the search in another folder by browsing in the folder structure with the same search criteria. o In the Document list view field, select from the drop-down list which view should be used when displaying the search results. o In the Sorting order field, select if the search results are to be listed in descending or ascending order and based on which field (e.g. document name, modification time). o In the Search scope field, select if the search is based only on the current selected folder, current folder and its subfolders or all folders. Click Search. The matching search results are displayed.
Figure 143 Search properties Note! Always remember to reset the search results by clicking Reset above the document list.
Revision: ax
79 (82)
Figure 145 Advanced search 3. Fill in the preferred criteria according to the instructions in Using the advanced search. 4. Click Store. The Store search view opens.
Figure 146 Store search 5. 6. 7. 8. Add a name for the stored search. Click Store. Go to the folder for which you want to use the same search criteria. In the Filters drop-down list above the document list, select the stored search that now is available. The search results for that folder are displayed.
Revision: ax
80 (82)
With the global search the users can according to their access rights find documents and folders in all doczones or only in a selected doczone. To use the global search: 1. Click the Doczones tab. 2. In the Doczone section above the doczone list, click Global search. The Global search view opens. Note! The Create and Import links visible in the figure below are not available for end users, only administrators.
Revision: ax
81 (82)
4. Add a keyword. Keyword searches can either be done with document keywords or folder keywords.
Document keywords: Document name Document ID Author Description File name Custom property
Folder keywords: Folder name User code Wrtsil global ID Description Custom property
5. Expand the Advanced search options field to add additional search criteria, if needed. a. Select the desired options from the drop-down lists regarding: document type document status document business document life cycle To exit the global search, click Doczones.
Revision: ax
82 (82)
Useful links
Whats new https://fiidm01.wnsd.com/kronodoc/WE/DBAC588634 Whats new to key users https://fiidm01.wnsd.com/kronodoc/WE/DBAC658673 Key user and administrator guide https://fiidm01.wnsd.com/kronodoc/WE/DBAC615214 Note! The access to the following documents is restricted until they have been finalised. IDM document management process https://fiidm01.wnsd.com/kronodoc/WE/DBAC482595 IDM global model https://fiidm01.wnsd.com/kronodoc/WE/DBAC458579 IDM service description https://fiidm01.wnsd.com/kronodoc/WE/DBAC435072 IDM trainings https://fiidm01.wnsd.com/kronodoc/WE/DBAC458583 IDM user management https://fiidm01.wnsd.com/kronodoc/WE/DBAC503523 What is IDM? https://fiidm01.wnsd.com/kronodoc/WE/DBAC458476