OMNIDOCS MOBILE OmniDocs Mobile User Guide 2015 Newgen Software Technologies Ltd A-6, Satsang Vihar Marg, Qutab Institutional Area New Delhi - 110067, INDIA Tel: 91-11-40770100, 26964733, 26963571 Fax: +91-11-26856936 E-mail: [email protected]
DisclaimerThis document contains information proprietary to Newgen Software Technologies Limited.You may not disclose or use any proprietary information or use any part of this documentwithout written permission from Newgen Software Technologies Limited.Newgen Software Technologies Limited makes no representations or warranties regarding anysoftware or to the contents or use of this manual. It also specifically disclaims any express orimplied warranties of merchantability, title, or fitness for any particular purpose. Even thoughNewgen Software Technologies Limited has tested the hardware and software and reviewedthe documentation, it does not guarantee or imply that this document is error free or accurateregarding any particular specification. As a result, this product is sold as it is and you, thepurchaser, are assuming the entire risk as to its quality and performance.Further, Newgen Software Technologies Limited reserves the right to revise this publicationand make changes in contents without any obligation to notify any person of such revisions orchanges. Newgen Software Technologies Limited authorizes no Newgen agent, dealer oremployee to make any modification, extension, or addition to the above statements.Newgen Software Technologies Limited has attempted to supply trademark information aboutcompany names, products, and services mentioned in this document. Trademarks indicatedbelow were derived from various sources.Copyright © 2015 by Newgen Software Technologies LtdAll Rights Reserved. No part of this publication may be reproduced and distributed without theprior permission of:Newgen Software Technologies Limited,A-6, SATSANG VIHAR MARG, QUTAB INSTITUTIONAL AREA,New Delhi - 110067INDIAPrinted in INDIAOmniDocs Mobile Page 2
Table of Contents1 Setting up OmniDocs Mobile .......................................................................................................... 5 1.1 Connect to an NEMP server .................................................................................................... 6 1.2 Sign In ..................................................................................................................................... 72 Repository...................................................................................................................................... 9 2.1 Actions on Repository ............................................................................................................ 10 2.1.1 Swipe Left to Right........................................................................................................ 10 2.1.2 Swipe Right to Left........................................................................................................ 10 2.2 Menu...................................................................................................................................... 11 2.2.1 Repository .................................................................................................................... 13 2.2.2 Search .......................................................................................................................... 13 2.2.3 Favorite......................................................................................................................... 13 2.3 Search ................................................................................................................................... 13 2.3.1 Local Search................................................................................................................. 13 2.3.2 Advance Search ........................................................................................................... 15 2.4 Sorting on Repository ............................................................................................................ 23 2.5 Option .................................................................................................................................... 27 2.5.1 Help .............................................................................................................................. 28 2.5.2 Logout........................................................................................................................... 283 Working with Folders.................................................................................................................... 28 3.1 Add Folder ............................................................................................................................. 29 3.2 Add Sub-Folder...................................................................................................................... 33 3.3 Add Document ....................................................................................................................... 36 3.3.1 Add Documents from Gallery ........................................................................................ 36 3.3.2 Add Documents from Camera....................................................................................... 43 3.4 Edit Folder ............................................................................................................................. 45OmniDocs Mobile Page 3
3.5 Delete Folder ......................................................................................................................... 47 3.6 View Properties of a Folder.................................................................................................... 48 3.7 Add to Favorite ...................................................................................................................... 50 3.8 Share a Folder ....................................................................................................................... 52 3.9 Sorting on Folder ................................................................................................................... 534 Working with Documents.............................................................................................................. 58 4.1 View Document...................................................................................................................... 58 4.2 Add Document ....................................................................................................................... 58 4.3 Download Document.............................................................................................................. 58 4.4 Delete Document ................................................................................................................... 61 4.5 View Properties of a Document.............................................................................................. 62 4.6 Add to Favorite ...................................................................................................................... 66 4.7 Share a Document ................................................................................................................. 67OmniDocs Mobile Page 4
1 Setting up OmniDocs MobileThe first time you launch the App, a Server Selection screen appears. Figure 1.1: Server Selection screenOmniDocs Mobile Page 5
1.1 Connect to a NEMP serverTo launch the App, tap the application icon on the home screen of your Android deviceNOTE:The essential step to use “OmniDocs Mobile” is to set-up connection with NEMP server.Once the server connection is done, the next step is the successful authentication of thedevice.1. Enter the RESTApiendpoint link / Connecting URL in the textbox, provided in the Server Selection screen. Example: http://192.168.56.166:8089/TestApiEngine/apod2. Tap “Submit” to complete your device authentication. Figure 1.2: RESTApiendpoint link/ Connecting Url Page 6OmniDocs Mobile
3. Your selection becomes the default server for your device. Whenever you sign in from the same Android device the next time, server would be selected by default.4. Once server connection is successful, you will be directed to the Sign In screen.NOTE: User must be an OmniDocs user. Device authentication is a one-time process.1.2 Sign InAfter the device authentication, the “Sign in” screen appears. 1. Enter the URL in the following format OmniDocs Server IP/ Cabinet Name in the textbox displayed by . Example: 192.168.57.140/mobileod_cmis_feb 2. Enter the User name in the username textbox . 3. Enter the Password in the password textbox .OmniDocs Mobile Page 7
4. Tap “Sign in”. Figure 1.3: “Sign in” Screen5. After successful Sign In, the user is directed to the Home Screen (Repository).OmniDocs Mobile Page 8
2 RepositoryThe Repository screen is the ‘Default Screen’ for the App. Figure 2.1: Repository ScreenThe Repository of the App contains ‘the total number of folders’ of the logged-in cabinet.NOTE:Repository of the App will only display the folders; on which the user has the rights.OmniDocs Mobile Page 9
2.1 Actions on RepositoryA user can perform the following actions on the Home Page (Repository) of the App.2.1.1 Swipe Left-to-RightA left-to-right swipe on the Repository screen opens a slide menu.From the slide menu, you can perform the following actions: Repository Search Favorite2.1.2 Swipe Right-to-Left of the logged-inAs it is known, the App Repository contains the total number of folderscabinet.A right-to-left swipe on the Repository screen opens a slide menu.From the slide menu, you can perform the following actions: More Properties Add to Favorite Share More Edit DeleteOmniDocs Mobile Page 10
The action bar of Repository screen consists of the following buttons: Menu Search Sorting Option2.2 MenuTap button in the action bar or swipe left-to-right on the Repository screen to open the leftside Menu of the App.OmniDocs Mobile Page 11
Figure 2.2: Menu ScreenThe Side Menu has the following options: Repository Search Activities[p1] FavoriteOmniDocs Mobile Page 12
2.2.1 RepositoryTap Repository , the repository screen appears.The Repository of an App contains all the folders present in the logged-in cabinet.2.2.2 Search option, you can execute Advance Search on the Repository.From the Search2.2.3 FavoriteTap Favorite , the folders and documents chosen by you as your favorites appear on thescreen.2.3 SearchTo search folders, sub-folders or any particular document present in any folder or sub-folder,follow the steps below:2.3.1 Local SearchThe local search will fetch the data stored in the device. 1. Tap the search icon 2. The search bar appears on the top of the screen.OmniDocs Mobile Page 13
Figure 2.3: Search Bar3. Enter the “Name” of the folder, sub-folder or document that you need to search in the Repository.4. The search results appear on the screen.5. The user can select the desired document/folder from the screen.6. In order to execute advance search, Tab Advance Search option below the search bar.OmniDocs Mobile Page 14
2.3.2 Advance SearchThe advanced search option is used to categorize your search. 1. Tap the search icon and swipe left to right on the Repository screen to open side Menu of the App. 2. The search bar appears on the top of the screen. Tap Advance Search on the right bottom of the search bar. Figure 2.4: Advance Search Tab Page 15OmniDocs Mobile
3. The Advance Search screen appears, you can execute DOCUMENT and FOLDER advance search separately from this screen. Figure 2.5: Advance Search Tabs for DocumentsOmniDocs Mobile Page 16
2.3.2.1 Advance Search on DocumentsHow do I execute “Advance Search on Documents” in OmniDocs mobile App?By Default, the DOCUMENT option appears selected on the Advance Search screen, if notswitch DOCUMENT tab.The advance search on the documents can be executed on the basis of following tabs: General Search Data Class By DateGeneral Search 1. Tap General Search on the Advance Search screen. 2. Enter the document name in the Document Name text box. 3. Enter then author name of the document in the Author Name textbox. 4. Enter the desired keyword in the Keyword textbox. 5. Tap Search. The searched documents appears on the screen 6. Tap Reset to refresh you selections.OmniDocs Mobile Page 17
Figure 2.6: General SearchData Class Search 1. Tap Data Class on the Advance Search screen. 2. Select data class from the Select Data Class drop down list. 3. Enter the field values of the selected data class. 4. Tap Search. The searched documents appear on the screen. 5. Tap Reset to refresh you selections.OmniDocs Mobile Page 18
Figure 2.7: Data Class SearchBy Date 1. Tap By Date on the Advance Search screen. 2. Select the type of document (Created, Accessed, or Revised) from Select a Type drop- down list. 3. Select Date Period selection button and specify the desired date and month. OR Select Date Range selection button and specify desired date range. 4. Tap Search. The searched documents appear on the screen. 5. Tap Reset to refresh you selections.OmniDocs Mobile Page 19
Figure 2.8: By Date Search2.3.2.2 Advance Search on FoldersHow do I execute “Advance Search on Folders” in OmniDocs mobile App?Tap FOLDER option on the Advance Search screen.The advance search on the folders can be executed on the basis of following tabs: General Search Data Class By DateGeneral Search 1. Tap General Search on the Advance Search screen. 2. Enter the folder name in the Folder Name text box.OmniDocs Mobile Page 20
3. Enter then owner name of the document in the Owner Name textbox.4. Tap Search. The searched documents appear on the screen.5. Tap Reset to refresh you selections. Figure 2.9: General SearchOmniDocs Mobile Page 21
Data Class Search 1. Tap Data Class on the Advance Search screen. 2. Select data class from the Select Data Class drop down list. 3. Enter the field values of the selected data class. 4. Tap Search. The searched folders appear on the screen. 5. Tap Reset to refresh you selections.By Date 1. Tap By Date on the Advance Search screen. 2. Select the type of folders (Created, Accessed, or Revised) from Select a Type drop down list. 3. Select Date Period selection button and specify desired date and month. OR Select Date Range selection button and specify desired date range. 4. Tap Search. The searched folders appear on the screen. 5. Tap Reset to refresh you selections.NOTE:It is important for the user to know color coding of Advance Search tab:1. If the entries of a particular tab are filled/ finalized, then the tab will appear in GREY color highlighting.2. If a user is present on a particular tab, then the tab will appear in BLUE color.3. If a particular tab is unfilled or no user is present on it, it will appear as it is with WHITE background.The color scheme is shown in the figure below:OmniDocs Mobile Page 22
Figure 2.10: Color Coding Of Advance Search Tabs2.4 Sorting on RepositoryThe user can sort the folders of the Repository on the basis of their ‘Name’ and ‘Date’.To sort the folders, follow the below given steps: 1. Tap the sorting icon .OmniDocs Mobile Page 23
2. A “Sort Data” box pops-up on the screen. Figure 2.11: Sort Data Box3. The ‘Sort Data’ screen suggests sorting of folders By Name and By Date.OmniDocs Mobile Page 24
4. Tap By Name; the folders in the Repository will sort out alphabetically. Figure 2.12: Sorting “By Name”OmniDocs Mobile Page 25
5. Tap By Date; the folders in the Repository will sort out on the basis of their last modified date, that is, the last modified folder will appear on the top of the screen. Figure 2.13: Sorting “By Date”6. Tap Cancel to close ‘Sort Data’ screen.OmniDocs Mobile Page 26
2.5 OptionThe right most icon in the action bar is the Option button . This button has the followingoptions Help Logout Figure 2.14: Option screen Page 27OmniDocs Mobile
2.5.1 HelpThe Help opens the user guide of the App and provides self-tutorial for the user.How do I open “Help” of OmniDocs mobile App? 1. Tap the Option button from the Repository screen. 2. A drop down menu appears. 3. Tap the Help icon . 4. The OmniDocs Mobile Help PDF appears on the screen.2.5.2 LogoutThe Logout option is used for signing out from the App.How do I “Logout” from OmniDocs mobile App? 1. Tap the Option button in the Repository screen. 2. A drop down menu appears. 3. Tap Logout icon . 4. You will be signed-out from the App.3 Working with FoldersYou can perform the following operations on the folders: Add Folder Add Sub-Folder Add Document Edit Folder Delete Folder View Properties of a Folder Add to Favorite Share a Folder Sorting on folderOmniDocs Mobile Page 28
3.1 Add FolderYou can add a new folder in the existing Repository.How do I “Add a Folder” in the OmniDocs mobile App? 1. Tap add button icon in the right bottom of the screen. Figure 3.1: Add Button Page 29OmniDocs Mobile
2. A New folder textbox pops-up. Figure 3.2: New FolderOmniDocs Mobile Page 30
3. Enter the desired name of the folder.4. Tap Add to add a new folder else tap Cancel to close the New folder textbox. Figure 3.3: Add New FolderOmniDocs Mobile Page 31
5. The new added folder appears in the Repository Figure 3.4: New Added FolderOmniDocs Mobile Page 32
3.2 Add Sub-FolderYou can add a new sub-folder within a folder existing inside the Repository.How do I “Add a Sub-Folder” in the OmniDocs mobile App? 1. Tap a folder in the Repository in which you want to create a sub-folder. 2. Tap add button icon in the right bottom of the screen, an icon menu pops-up. 3. Tap Add Folder icon , ellse tap cancel button to close the icon menu. Figure 3.5: Sub -Folder Page 33OmniDocs Mobile
4. Enter the desired name of the sub-folder you wants to create.5. Tap Add to add a new sub-folder else tap Cancel to close the New folder textbox. Figure 3.6: Add Sub-FolderOmniDocs Mobile Page 34
6. The added sub-folder appears in the selected main folder. Figure 3.7: Added New Sub-FolderOmniDocs Mobile Page 35
3.3 Add DocumentYou can add a new document in the existing folder or its sub-folder.How do I “Add a Document” in the OmniDocs mobile App?3.3.1 Add Documents from Gallery 1. Tap a folder/sub-folder in the Repository in which you want to add a Document. 2. Tap add button icon in the right bottom of the screen, an icon menu pops-up. 3. Tap Add Document icon , else tap cancel button to close the icon menu. Figure 3.8: Add DocumentOmniDocs Mobile Page 36
4. The New Document selection screen pops-up.5. The ‘New Document’ selection screen suggests two options “Gallery” or “Camera” to upload a document, select one from them else tap Cancel to close ‘New Document’ selection screen. Figure 3.9: New Document6. Tap Gallery , the “MobileOD” folder in the SD card opens-up.OmniDocs Mobile Page 37
7. Select the documents that you want to upload; you can upload multiple documents from the ‘Gallery’.8. Tap OK button, on the bottom of the screen. Figure 3.10: Gallery View9. The selected documents appear on the sliding pane. Slide left or right to view selected documents.OmniDocs Mobile Page 38
10. The top of the sliding pane has four buttons; ‘Back’, ‘Delete’,’ Edit’ and ‘Option’. Figure 3.11: Sliding Pane11. Tap Back button to go on the previous screen.12. Tap Delete button to delete a specific document present on the sliding pane.OmniDocs Mobile Page 39
13. Tap Edit button to edit a specific document present on the sliding pane. The user can edit Name of the document. The user can attach Keywords to the document. The user can attach or edit Data Class to the document. The user can add or edit Fields of the attached data class. The user can add Remarks to the document. Tap Update to save the changes in the document else tap Reset to terminate editing Figure 3.12: Upper action bar of Sliding PaneOmniDocs Mobile Page 40
Once you update your document, the check-box on the edited document turns toGreen Color. The green color check-box on the document indicates that thedocument has been edited. Figure 3.13: Updated Document screen14. Tap Option to open OmniDocs Mobile ‘Help’ or to ‘Logout’ from the App.15. The bottom of the sliding pane has three buttons; ‘Add’, ‘Reset’ and ‘Upload’.16. Tap Add to add more documents to the selected documents for upload.OmniDocs Mobile Page 41
17. Tap Reset, all the selected documents will get refreshed. Now select all the documents from the start.18. Tap Upload, the selected documents will get uploaded on a particular folder/sub-folder. Figure 3.14: Bottom action bar of Sliding Pane (3 buttons)OmniDocs Mobile Page 42
3.3.2 Add Documents from Camera 1. Tap a folder/sub-folder in the Repository in which you want to add a Document. 2. Tap add button icon in the right bottom of the screen, an icon menu pops-up. 3. Tap Add Document icon , else tap cancel button to close the icon menu. 4. The New Document selection screen pops-up. 5. The ‘New Document’ selection screen suggests two options “Gallery” or “Camera” to upload a document, select one from them else tap Cancel to close ‘New Document’ selection screen. 6. Tap Camera , the camera of a device opens-up. Figure 3.15: CameraOmniDocs Mobile Page 43
7. Click the image of a document that you want to upload and Save it.8. The captured image appears in the sliding pane.9. The top of the sliding pane has four buttons; ‘Back’, ‘Delete’,’ Edit’ and ‘Option’.10. Tap Back button to go on the previous screen.11. Tap Delete button to delete a specific document present on the sliding pane.12. Tap Edit button to edit a specific document present on the sliding pane. The user can edit Name of the document. The user can attach Keyword to the document. The user can attach or edit Data Class to the document. The user can add or edit Fields of the attached data class. The user can ass Remark to the document. Tap Update save the changes in the document else tap Reset to terminate editing Once you update your document, the check-box on the edited document turns to Green Color. The green color check-box on the document indicates that the document has been edited.13. Tap Option to open OmniDocs Mobile ‘Help’ or to ‘Logout’ from the App.14. The bottom of the sliding pane has three buttons; ‘Add’, ‘Reset’ and ‘Upload’.15. Tap Add to add more documents to the captured documents for upload.16. Tap Reset, all the selected documents will get refreshed. Now capture all the documents from the start.17. Tap Upload, the captured documents will get uploaded on a particular folder/sub-folder.OmniDocs Mobile Page 44
3.4 Edit FolderYou can edit the name of a folder or sub-folder of the repository.How do I “Edit a Folder” in the OmniDocs mobile App? 1. Swipe right to left on the specific folder or sub-folder which you would like to edit. 2. A right slide options; ‘More’, ‘Edit’ and ‘Delete’ appears on the screen. Figure 3.16: Right-Left Slide MenuOmniDocs Mobile Page 45
3. Tab Edit, an Edit Folder screen pops-up.4. Edit name of the folder/sub-folder within the Name textbox.5. Tap Update to save the edited folder/sub-folder, else tap Cancel to close ‘Name’ textbox without updating the folder/sub-folder. Figure 3.17: Edit FolderOmniDocs Mobile Page 46
3.5 Delete FolderYou can delete a folder or sub-folder from the repository.How do I “Delete a Folder” in the OmniDocs mobile App? 1. Swipe right to left on the specific folder or sub-folder to which you would like to delete. 2. A right slide options; ‘More’, ‘Edit’ and ‘Delete’ appears on the screen. Figure 3.18: Right-Left Slide MenuOmniDocs Mobile Page 47
3. Tab Delete, the Delete Folder screen pops-up.4. Tap Delete to delete the folder/sub-folder, else tap Cancel to close ‘Delete Folder’ screen. Figure 3.19: Delete Folder3.6 View Properties of a FolderYou can view properties of any folder/sub-folder present in the repository.How do I “View Properties of a Folder” in the OmniDocs mobile App? 1. To view properties of a folder, swipe right to left on the specific folder/sub-folder. 2. A right slide options; ‘More’, ‘Edit’ and ‘Delete’ appears on the screen.OmniDocs Mobile Page 48
3. Tab ‘More’; the icon menu appears on the bottom of the screen. The following tabs exist on an icon menu Properties Add to Favorite Share More4. Tab Properties Figure 3.20: Icon Menu , Fetching Folder Properties screen pops-up.OmniDocs Mobile Page 49
5. The Properties screen appears. The Properties of a folder/ sub-folder are defined on the basis of following default parameters: Folder Name Created On Last Modified Size 6. Tap Cancel to close ‘Properties’ screen.3.7 Add to FavoriteFor quick access to your required folders/sub-folder, you can add them as your favorites.How do I add a folder/sub-folder to my “Favorites” in the OmniDocs mobile App? 1. To add a folder to your favorites swipe right to left on the specific folder. 2. A right to left slide options; ‘More’, ‘Edit’ and ‘Delete’ appear on the screen. 3. Tab ‘More’; the icon menu appears on the bottom of the screen. The following tabs exist on an icon menu Properties Add to Favorite Share MoreOmniDocs Mobile Page 50
Search
