20110307091112!OpenKM - User Guide
20110307091112!OpenKM - User Guide
20110307091112!OpenKM - User Guide
User Guide
PDF generated using the open source mwlib toolkit. See http://code.pediapress.com/ for more information.
PDF generated at: Wed, 02 Mar 2011 11:59:56 UTC
User Guide
User Guide
OpenKM is a tool to manage documents generated within a company, to improve access within the whole corporate
environment and to endeavour to keep in check the unnecessary duplication of information.
OpenKM provides the solution to:
Create folder
Find folder
Inserting documents
Wizard
Renaming
Move
Copy
Adding bookmark
Set home
Deleting
Keyword shortcuts
Uploading from desktop computer
User Guide
Using information
Security
Search
Dashboard
Notification service
Subscription service
Starting a Workflow
Workflow pending task
User configuration
System tools
Languages
Appearance
Using iPhone or Android
Help
Microsoft Office Addin
Outlook addin
Word Addin
Excel Addin
PowerPoint Addin
OpenOffice.org Add-on
Professional extensions
Stapling
Autocad preview
Messaging
Downloading restricted buttons
Stamp Image or Text Watermark
Digital signature
Cryptography
Contacts
System access
System access
System access is performed via a web browser using the URL where your OpenKM installation is hosted. In the
access screen you must enter the user name (Login) and the password that has been provided by the system
administrator.
Desktop screen
Desktop screen
On accessing the system, a desktop is displayed with three different well-defined workspaces: Menu Options,
Toolbar, Folder Tree, Document Browser and Document and Folder Properties, as well as information on the user
who is connected at that time.
Menu bar
Menu bar
The menu bar is formed by all the pull down menus with their different options. If an option within a menu has a
button on the toolbar, this button will appear to the left of the option name. If an option within a menu appears
greyed-out, this option is not available.
Toolbar
Toolbar
The toolbar is made up of buttons with the main functions that the user will most frequently use. As with the menu
bar, occasionally the buttons will appear greyed-out, meaning that they are not available.
User identification
User identification
In this space of the desktop screen the user identification who is connected in this session is identified.
In the event of detecting some user with AdminRole as the user, the identifier will appear in another colour, with the
purpose of indicating that operations are being carried out under a super-user without any restrictions of document
access.
Status bar
In this space of the desktop screen the user access to some general information like his repository size used, number
of locked documents, number of checkout documents ( edited ), subscribed folders and documents, number of news
pending to reading and number of workflow task pending assigned to the user.
At the right corner, there's a status message bar that OpenKM uses to show some information to User
Workspace
The workspace allows you to change between Search and the list of folders and documents.
Desktop: Mode to carry out the main tasks with folders and their documents (create, add, move, download, etc.).
Search: Mode to search documents.
DashBoard: Mode to access workflow, user documents view, general document view and news push service.
Administration: Administration utilities, only available for users with AdminRole grant.
Path
Path
The path permanently indicates your location within the tree (Taxonomy, Thesaurus, Personal, etc. depending on the
view you have enabled at any given moment).
Taxonomy
Firstly, on the left of the desktop, is the Folder Tree or also called the Taxonomy. It displays a view of the repository
distribution grouped by folders. There are various types of folders symbolised by the following icons:
Duplicate the folder and its contents in another place on the tree.
Taxonomy
9
Set the folder or document as user home
Create a zip file with all the contents of the folder recursively, maintaining the folder structure.
Document browser
In the upper section the document browser can be seen. The document browser allows you to view the list of
documents and subfolders available on a specific node of the tree (Taxonomy).
Pop-up menu
Download document
Document edit ( check-out )
Upload modified document (check-in)
Cancel document edit
Lock document
Unlock document
Move document to users Trash.
Change the name of the selected folder or document.
Change the location of the folder or document selected to another place on the tree
Duplicate the folder and its contents or another document to another place on the tree.
Add a folder or document to the bookmarks
Document browser
10
Properties panel
Properties panel
In the lower part are detailed the Document or folder properties with security, history, general properties and
specifics concerning documents defined by users (document parametrization).
Security tab.
Properties tab.
History tab (version control).
Notes.
Tabs of property groups.
Preview tab
11
Categories
Categories is defined as knowledge tree via which the companies organises its information as a repository view
organized by categories and subcategories. The side panel of the desktop offers a view of the categories concepts,
organized in a hierarchical folder structure. Must understand that's only a special way to view repository, but really
repository is organized physically as you can see in taxonomy view.
Thesaurus
A thesaurus is a book that lists words grouped together according to similarity of meaning (containing synonyms and
sometimes antonyms), in contrast to a dictionary, which contains definitions and pronunciations. Thesaurus is
defined as knowledge tree via which the companies organises its information as a repository view organized by
terms. The side panel of the desktop offers a view of the terms concepts, organized in a hierarchical folder structure.
Must understand that's only a special way to view repository, but really repository is organized physically as you can
see in taxonomy view.
The jerarquical relations between terms, depending about how thesaurus is defined.
Personal documents
The users personal documents is a personal knowledge tree of each user where they can save any type of document.
These are only accessible by the user themselves.
Templates
Contains document templates that can be used as a base by users to create other new documents.
E-mail
Contains imported personal mails, text and attached documents, from mail account user using IMAP mail service.
12
Create folder
Create folder
Operation icon:
Available
Pop-up menu of the folder tree.
Main edit menu.
Toolbar.
Find folder
Operation icon:
Available
Toolbar.
13
Inserting documents
Inserting documents
Operation icon:
Available
The option "Import documents from ZIP" allows you to import the contents of a zip file respecting the hierarchy of
the folder tree. When the insert window appears on the screen, select the local folder clicking the button "Browse...".
If you want to notify users that you have uploaded a new file by email, mark the checkbox "Notify users". Otherwise
leave this option disabled. You can notify to users or groups.
To end, click "Send". Once the upload of the new document has finalised you can upload more documents with the
option "Add another file".
14
Inserting documents
For large organizations can be enabled advanced filtering usign Profiles administration feature. It allows to filter
users and groups.
15
Inserting documents
Wizard
You can configure in user Profile to allows wizard while uploading a new document. Property groups ( metadata ),
keywords, and categories can be selected as a part of the wizard.
16
Wizard
Categories
Keywords
17
Wizard
18
Renaming
Operation icon:
Available
Pop-up menu of folder tree.
Pop-up menu of document browser.
Main edit menu.
You can cancel the renaming option using the ESC key.
Renaming a folder
Renaming a document
Move
Move
Operation icon:
Available
Pop-up menu of folder tree.
Pop-up menu of document browser.
Main edit menu.
A dialogue box appears to select the new location of the document or folder: click Move. If you do not have
permission in the new location the Move button will appear disabled.
19
Copy
Copy
Operation icon:
Available
Pop-up menu of the folder tree.
Pop-up menu of the document browser.
Main edit menu.
A dialogue box appears to select the location to copy of the document or folder to appears: click Copy. If you do not
have permission in the new location the Copy button will appear disabled.
20
Adding bookmark
Adding bookmark
Operation icon:
Available
Pop-up menu of folder tree.
Pop-up menu of document browser.
Select the document or folder on which you want to do the operation. Execute the operation and a window will
appear in which you can put a description of the bookmark.
Once the bookmark has been created you can check that it appears in the general Bookmark menu. The bookmarks
are graphically distinguished depending on whether they are folders or documents, and ordered according to their
category and name.
21
Set home
Set home
Operation icon:
Available
Pop-up menu of folder tree.
Pop-up menu of document browser.
You can set any folder or document as default home in the user environment.
In this way, on accessing the application the path to the folder or document that has been set as home will open
automatically.
The operation to set a document or folder as home will always ask you for confirmation.
Deleting
Operation icon:
Available
Simply choose the folder and select the option "Delete". The application will always ask you for confirmation of this
option. When the document or folder has been deleted you can recuperate it from Trash.
22
Keyword shortcuts
23
Keyword shortcuts
There's some keyword shortcuts that you can use with OpenKM.
to
rename
SUPR
to delete
CTRL+C to copy
CTRL+X to cut
CTRL+V to paste
Others
F1
to show help
F5
to refreshing environment
INSERT
To close it, simply doing right mouse click in the OpenKM logo, it'll appearing a menu and select exit.
Document edit
Operation icon:
Available
Pop-up menu of document browser.
Edit menu.
Toolbar.
To start to work with a file you must do a Check-out of it: that is, download the file to the local computer to be able
to modify it. Once you have made the pertinent modifications, upload it once again with a Check-in.
The automatic locking of the folder ensures that no other system user can modify its contents while you are
modifying it.
24
Cancel edit
Cancel edit
Operation icon:
Available
Pop-up menu of document browser.
Edit menu.
Toolbar.
If you want to cancel the document edit, the "Cancel Check-out" option exists whereby the file undergoes no type of
modification and it will be unlocked so that other users (depending on their privileges) can edit it.
25
Update a file
Update a file
Operation icon:
Available
Pop-up menu of document browser.
Edit menu.
Toolbar.
Once the changes have been made on the local computer, you must do a Check-in to upload the file once more to
the system and unlock it for future use.
The system will ask for the modified file to upload it to the repository and notify you that it will replace the previous
version with this newer one.
The comment field is to leave information concerning the update of the file - for example, what changes have been
made.
You can send notification messages to user or groups. Aditionally can be enabled advanced filters, usefull for high
level of users that can be enabled in using adminitration [Profile].
26
Update a file
27
Lock
Lock
Operation icon:
Available
Pop-up menu of document browser.
Edit menu.
Toolbar.
If you want to protect the file so that no other user can make changes to it, you can use the Lock function. This
means that until it is unlocked, no other user can modify it. When locked, a locked icon will appear to the side of the
name of the selected file.
Unlock
Operation icon:
Available
Pop-up menu of document browser.
Edit menu.
Toolbar.
The unlock option allows you to unlock a previously locked document. This operation can only be carried out by the
user who previously locked the document.
28
Downloading a document
Downloading a document
Operation icon:
Available
Pop-up menu of document browser.
Edit menu.
Toolbar.
If you want to save a file on the local computer without making any changes you can use the option "Download".
Remember that if you modify the downloaded file you cannot upload it again to the system without having first done
a "Check-out /Check-in" of the file.
Once a property group has been added, a new tab will appear with the name of the corresponding group and the
fields with the properties of it.
Once a property group has been assigned to a document, you can modify its values by selecting the option "Modify".
29
30
Parametrization is extremely useful. Combined with the Search motor it enables the localisation of information by
categories, it being possible to create metadata categories which are adapted to a user groups working method.
Adding or deleting a property group will not affect the document history.
Adding keywords
In the document properties tab of the properties panel, you can add and modify keywords.
In order to optimise indexing and future information searches in the document management system, it is necessary to
enter keywords that describe or identify the stored file.
Although the document parametrization system by property groups is superior with regards to capacity, these will
continue to be maintained and will not disappear, as it is understood that in certain installations property groups will
not be created and it is useful that parametrization by default keywords is maintained.
Adding or deleting keywords does not modify the document version.
Adding keywords
31
Adding categories
In the document properties tab of the properties panel, you can add and remove categories.
In order to optimise indexing and future information searches in the document management system, it is necessary to
add categories that describe or identify the stored file.
Although the document parametrization system by property groups is superior with regards to capacity, these will
continue to be maintained and will not disappear, as it is understood that in certain installations property groups will
not be created and it is useful that parametrization by default categories is maintained.
Adding or deleting categories does not modify the document version.
Categories are a hierachical folder structure of folder and subfolders.
Adding categories
Adding categories
Categories can be selected from available hierachical categories folder structure.
Click in
Deleting categories
Click in
32
Copy to clipboard
Copy to clipboard
Copy the document url (OpenKM browser path) to clipboard. Note in some browsers like Firefox you might
configure browser to enable this option (security browser restrictions).
To enable JavaScript "Copy to clipboard" buttons on Firefox and Mozilla, enter the following line into browser
address bar: about:config.
The list of preferences should open in browser window. Click right mouse button somewhere in active part of
preference list window and choose New > Boolean option from context menu. Paste the following Preference name
into the New boolean value window input box: signed.applets.codebase_principal_support.
Since OpenKM 5.0 this feature is implemented using Flash and you don't need to change your browser configuration because just
works!.
33
Categories
Categories
Categories is a hierarchical tree structure of categories and subcategories folders. The idea is that folder and
subfolders represent conceptual tree concept structure.
Any document can be linked with many categories folders at same time. Each time some category folder is selected,
all related documents will be displayed in file browser panel. Major document functionalities are available from this
view.
34
Thesaurus view
Thesaurus view
A thesaurus is a book that lists words grouped together according to similarity of meaning (containing
synonyms and sometimes antonyms), in contrast to a dictionary, which contains definitions and pronunciations.
Thesaurus view is a hierarchical tree structure of SKOS ( Simple knowledge organization system) folders. Really
SKOS concepts are linked many to many, but it's represented as a tree hierarchical structure.
Any document can be linked with many skos folders at same time. Each time some skos folder is selected, all related
documents will be displayed in file browser panel. Major document functionalities are available from this view.
35
Thesaurus view
My documents
My documents is a tree folder structure to organizate user personal documents. The documents are only available to
the owner user.
From version 5.x and upper any user with adminitration grants, can navigate across all users my documents folder
structure.
36
Templates
Templates
Templates is a tree folder structure to organizate main source documents. The idea is that organization create new
documents ( for example fax, new project document templates, invoices, etc. ) from documents into templates panel.
37
Templates
If the selected document is pdf and has some property group - metadata - associated then will appearing creation
wizard popup. Property group fields will be requested in order to combine with generation of new PDF. You can
create PDF forms with several applications:
Acrobat Pro [1]
How-to: Create PDF forms with OpenOffice [2]
PDF Forms Designer [3]
38
Templates
The wizard
And finally generated the PDF with property group fields added by user.
39
Templates
40
Templates
References
[1] http:/ / www. adobe. com/ products/ acrobat. html
[2] http:/ / danilop. wordpress. com/ 2008/ 07/ 02/ how-to-create-pdf-forms-with-openoffice/
[3] http:/ / pdfformsdesigne. sourceforge. net/ index. html
41
42
E-mail
Import users mails from some user mail account by IMAP. Importation is made automatically by OpenKM each 60
minutes, depending network bandwidth configuration, and other parameters, refreshing time could be greater that
this.
Attached documents are indexed
too.
Importing mechanism creates a folder structure based on year, month and day to organize automatically imported
mails.
From version 5.x users with adminitrator grants have access to all users mails.
Trash
Trash
The deleted files and folders are stored in Trash in order to be able to recuperate them if their elimination was
accidental. Trash, as well as the files located in it, are personal to each system user.
Restoring a folder or document
Definitively deleting a folder or document
Emptying trash
From version 5.x users with adminitrator grants have access to all users trash.
43
Using information
Using information
In the properties panel there is detailed information on the documents and folders to which the user has access.
Folder information tabs
Document information
Security
The security option allows you to show and define what users and groups have permission to a specific document or
folder.
Modifying security
Search
The Search tab, located in the upper right of the screen, changes the desktop panels for those of Search.
Searches may be made by words in the contents of the files, by the name (title) of the documents, or by the type of
file (MIME type). Similarly, providing a keyword has been entered into the files, you can search using this field.
You can also make searches by property group values if they have been defined.
The results are displayed paginated with 10, 20 or 30 results.
Stars indicate the relevance of the document found. This value is established by the Search engine according to the
search field and the results found. The list of documents found is ordered from greatest to least relevance.
Making a search
Executing a stored query
Deleting a stored query
Opening the location of a document
Opening the location of a folder
Save as a user news
Searching with OpenKM
44
Dashboard
Dashboard
The Dashboard tab, located in the upper right of the screen, changes the desktop panels for those of Dashboard.
Dashboard has several information services and utilities for user like user user, general and mail documents specific
document queries views, the push search service ( news ), workflow task, and the keyword map ( tag cloud view ).
To change between these user utilities there's a button menu on the top, the selected option is always marked in blue.
User view
General view
Dashboard keyboard map
Dashboard mail
Dashboard news
45
Notification service
Notification service
The application permits notification by email of the insertion and update of a new document via an email message.
The user to whom the application has sent a notification by email will see a message with a direct link (URL) to the
document, the user who has made the notification and a message (description) if the user has supplied one. The
"subject" of the email received by the user will be something similar to the following:
OpenKM - NOTIFICATION - "Document Name"
The user can create a filter with the name "OpenKM" or "OpenKM - NOTIFICATION" to centralise in one single
folder all notifications made by the application in the users mail client.
Subscription service
The application allows you to subscribe to a folder or document with the purpose of making an audit of the changes
on one document in particular, or the documents contained in said folder.
The subscription notifies you of the following operations made by users on the documents. These are some of the
event which generates a notification:
Making a subscription
Deleting a subscription
46
Starting a Workflow
47
Starting a Workflow
After selecting some document, make a click on
workflows installed in OpenKM.
After pressing start button, workflow will automatically starting ( some times workflow demands some extra
parameters information before starting ) assigning the first pending task to some user or group.
User configuration
User can change their own password, mail address and optionally configuring his imap mail account ( it'll be
automatically read periodically by OpenKM )
To show user configuration open menu tools, submenu preferences and then select option "user configuration"
48
Languages
Languages
OpenKM is a multi-language system which permits you to change the language in the user interface at any time
during the session. In the "Tools / Languages" menu, you can select any of the languages installed by the
administrator.
Appearance
The graphics appearance of the system can be changed at the will of the user depending on the templates defined by
the administrator. This option is available in the "Tools / Appearance" menu.
49
Navigation
Making a search
50
Folder properties
51
Help
This menu, as well as providing help on the functioning of OpenKM, allows you to send comments and error
notifications (bugs) to the system developers.
There is, furthermore, the option of requesting Support via the web on the system operation or to access the
OpenKM discussion forums. Other options are access to the project website (http:/ / www. openkm. com) or the
display of product credits.
In the version notes you can find the changes that have been made with respect to the previous version.
52
53
Oulook addin
Outlook_addin enables user to selecting several mails and importing content and attachment to OpenKM.
Importing mail creates a folder structure based received mail date ( year/month/day folder structure ) and imports
into the mail content OpenKM mail tab view.
Word Addin
Word Addin enables user uploading new files and editing OpenKM files.
When user uploads new files, browses across tree OpenKM view to select where wants to uploading.
OpenKM word AddIn detects if document opened by user is an OpenKM and enables or disables some toolbar
option.
Excel Addin
Excel Addin enables user uploading new files and editing OpenKM files.
When user uploads new files, browses across tree OpenKM view to select where wants to uploading.
OpenKM excel AddIn detects if document opened by user is an OpenKM and enables or disables some toolbar
option.
PowerPoint Addin
PowerPoint Addin enables user uploading new files and editing OpenKM files.
When user uploads new files, browses across tree OpenKM view to select where wants to uploading.
OpenKM PowerPoint AddIn detects if document opened by user is an OpenKM and enables or disables some toolbar
option.
When user edits documents it's saved locally in %USER_LOCAL_DOCUMENT_FOLDER%/OpenKM.
Editing OpenKM documents, user can decide uploading or cancel editing, after both operation local file is removed due to not generate
user confusion. When user uploads a new file this is not removed from his computer.
Outlook addin
Outlook addin
Office Addins are compatible from version 2000 to version 2007.
After installing Outlook adding it'll appears new menu option "OpenKM".
When you setting your configuration values is created OpenKM folder in your user My documents folder. Into
OpenKM folder is created a configuration file called openkm.xml and other file called document.xml that OpenKM
Addin uses to store some document editing information, you might not editing or deleting this file.
54
Outlook addin
55
Outlook addin
56
Word Addin
Word Addin
Office Addins are compatible from version 2000 to version 2007.
After installing Word Adding it'll appears new "OpenKM" toolbar menu options.
Addin configuration
Add new document
Document edit ( check-out )
Upload modified document (check-in)
Cancel document edit
Help
When you setting your configuration values is created OpenKM folder in your user My documents folder. Into
OpenKM folder is created a configuration file called openkm.xml and other file called document.xml that OpenKM
Addin uses to store some document editing information, you might not editing or deleting this file.
57
Word Addin
58
Word Addin
Click on Send Button, and after document it'll be uploaded to OpenKM it'll appears a notification message.
59
Word Addin
60
After editing your local document copy will be deleted to prevent user confusion.
Excel Addin
Excel Addin
Office Addins are compatible from version 2000 to version 2007.
After installing Excel Adding it'll appears new "OpenKM" toolbar menu options.
Addin configuration
Add new document
Document edit ( check-out )
Upload modified document (check-in)
Cancel document edit
Help
When you setting your configuration values is created OpenKM folder in your user My documents folder. Into
OpenKM folder is created a configuration file called openkm.xml and other file called document.xml that OpenKM
Addin uses to store some document editing information, you might not editing or deleting this file.
61
Excel Addin
62
Excel Addin
Click on Send Button, and after document it'll be uploaded to OpenKM it'll appears a notification message.
63
Excel Addin
64
After editing your local document copy will be deleted to prevent user confusion.
PowerPoint Addin
PowerPoint Addin
Office Addins are compatible from version 2000 to version 2007.
After installing PowerPoint Adding it'll appears new "OpenKM" toolbar menu options.
Addin configuration
Add new document
Document edit ( check-out )
Upload modified document (check-in)
Cancel document edit
Help
When you setting your configuration values is created OpenKM folder in your user My documents folder. Into
OpenKM folder is created a configuration file called openkm.xml and other file called document.xml that OpenKM
Addin uses to store some document editing information, you might not editing or deleting this file.
65
PowerPoint Addin
66
PowerPoint Addin
Click on Send Button, and after document it'll be uploaded to OpenKM it'll appears a notification message.
67
PowerPoint Addin
68
After editing your local document copy will be deleted to prevent user confusion.
OpenOffice.org Add-on
OpenOffice.org Add-on
OpenOffice AddOn
OpenOffice Add On is compatible from OpenOffice version 3.2 and OpenKM repository 4.x
After installing OpenOffice Add On, "OpenKM" appears as a new toolbar. It usually appears in the top-left of the
OpenOffice window.
Add On configuration
Add new document
Document edit ( check-out )
Upload modified document (check-in)
When you setting your configuration values is created OpenKM folder in your user home. Into OpenKM folder is
created a configuration file called openkm.xml and other file called document.xml that OpenKM Add On uses to
store some document editing information, you might not want to edit or delete those files.
69
OpenOffice.org Add-on
70
OpenOffice.org Add-on
Once you've found the correct directory, highlight it and click the Add Button, and the document will be uploaded to
OpenKM. Once the process is complete a notification window will pop-up.
71
OpenOffice.org Add-on
72
After editing your local document copy will be deleted to prevent user confusion.
Troubleshooting
Linux users must remember installing packages:
openoffice.org-java-common
openoffice.org-java
Stapling
73
Stapling
Stapling is only allowed in taxonomy, categories and thesaurus view. Folders, documents and mails can be stapled.
Same folder, document or mail can be stapled several times in different groups.
Restrictions:
Only stapling creator has privileges to add / delete more elements or deleting entire group. Rest of users only have
downloading option.
Mails can not be downloaded.
If some users has no grants to downloading some document in a stapling, althought could see it in stapling group
can not downloading that file.
Detail of the functions according to their icons:
Start new stapling group / Staple element ( same button has both functions ).
Stop stapling group.
Delete some element on group.
Click on
start new stapling group icon ( at bottom right it'll will appearing the message "Stapling started").
Then select other folder or document and click other time in same icon
Continue selecting new elements and clicking in same icon
To finishing click on
stop stapling group ( at bottom right it'll will appearing the message "Stapling finished")
Stapling
74
stop stapling group ( at bottom right it'll will appearing the message "Stapling finished")
Autocad preview
Autocad previewer allows to make some basic operations like zoom in/out, rotate, show/hide layers and printing.
Toolbar
Printing
Zoom out
Zoom in
Cursor zooming
Move draw
Rotation
Home
Back
Forward
Rotate 90 left
Rotate 90 right
Fit on page
Autocad preview
Default preview
75
Autocad preview
76
Autocad preview
77
Messaging
78
Messaging
Messaging extension allows propose documents and folders to users, share normal queries and user news queries
with other users and sending text messages to users.
Messaging extension widgets are located at tools menu ( send message option ), at any document / folder view in
taxonomy with icon option to send proposed folder/document subscription, at bottom desktop with tree icons to
indicate when news proposed subscriptions, proposed query or user message has arrived and in dashboard view
where all information is available in one view.
Proposed subscriptions
Proposed query
Message received
Message sent
Proposing subscription
You can propose a subscription ( document / folder ) to any user or group of users ( based in roles ). For doing it
simply select some document or folder, in document or folder properties view it'll appearing the propose subscription
icon .
Messaging
79
Select users and group of users ( by roles ) you want to propose the subscription. They'll receive the notification in
the messaging panel.
Messaging
80
Messaging
Select users and group of users ( by roles ) you want to propose the query. They'll receive the notification in the
messaging panel.
81
Messaging
82
Messaging
When end user accepts a proposed query, this will appearing in search view with the shared query icon
. User
who proposed the query can modify it, that means any change made by owner of the query has immediate effects on
users with who's sharing.
83
Messaging
Sending message
You can sending a message to any user or group of users ( based in roles ). For doing it simply open tools menu /
messaging and select the option send new message.
84
Messaging
Select users and group of users ( by roles ) you want to send the message. They'll receive the notification in the
messaging panel.
85
Messaging
86
Messaging
87
That solves the general problem, that in some cases is wanted some uses could read documents, but not
downloading.
When extension is enabled it'll be appearing two new button at right toolbar.
In the next screenshot user has not the role NoDownloadingRestrictionRole reason why can not downloading file (
take look at right corner at tool bar button ).
88
In the next screenshot user has the role NoDownloadingRestrictionRole that in combination with normal grants
allows user to downloading file ( take look at right corner at tool bar button ).
89
Stamp
90
Stamp
Stamp is only allowed in taxonomy view for any document which can be converted to pdf or be a pdf. In order to
stamp a document is necessary got configured open office service, consider take a look at OpenOffice.org or
Application_configuration.
Restrictions:
Only allowed for documents convertible to pdf or pdf files.
Has write privileges on folder.
Only allowed on taxonomy view.
Detail of the functions according to their icons:
Stamping a document
Fist must select a document ( convertible to pdf or pdf ) in taxonomy view, then click
popup.
Several stamp types can be assigned in administration view to each user. User must select one of the available stamp
he's got and execute it. After some time it'll be generated a new pdf file ( or new version pdf file in case the selected
stamped file was a pdf ).
Stamp
Stamp administration
On stamp administration can be defined text and image stamps. In text stamp it's shown text stamp definitions.
91
Stamp
92
Digital signature
Digital signature
Digital signature allow to sign documents with installed certificates. Can be signed a document yet uploaded or a
new document. Only can be signed documents that can be converted to pdf. In case document is pdf, then new
document version is uploaded after siging, in case is only a convertible one, is uploaded a new pdf file with same
name that the original document in same folder destination than origin.
Restrictions:
It'll appearing a popup, you must select there the certify you want to use to signing document.
93
Digital signature
In history tab, can see a comment "signed" and a version change if the original document was pdf file.
94
Digital signature
If there's some assigned wizard to document it'll appearing the sequence, and the last it'll be the sign popup.
95
Digital signature
In history tab, can see a comment "signed" and a version change if the original document was pdf file.
96
Digital signature
If the document is a pdf, it'll be uploaded the original document and the signed one as a new document version. If
document is only a convertible to pdf, then it'll be uploaded that document and generated a new signed pdf file too.
Document encryption
Cryptography allows to plus documents protection in OpenKM. With cryptography extension can upload a new
encrypted document, encrypt and decrypt existing document, edit and checkin encrypted document and download
and decrypt encryted documents. In order making the cryptography process more secure are files are encrypted and
decrypted in local user computer by a signed applet. That mean any networking file traffic is always with encrypted
documents.
All Cryptography options are available at tool menu:
97
Document encryption
Restrictions
Cryptography is only allowed in taxonomy view.
Must have write privileges on document and folder to perfom cyptography operations.
For editing purpose, document might not be locked or checkout by other user.
Now simply put your cryptopharase twice, and select the file pressing the select file button. After it the document it'll
be encrypted locally with cryptophrase and uploaded to OpenKM. When it process it'll be finished it'll appearing a
successfully uploading popup message.
The OpenKM document explorer UI will be refreshing and will appearing the new document uploaded with the icon
indicating that's a encrypted document.
98
Document encryption
Then must put decryptphrase and selecting the directory where you want to downloading the OpenKM document
decrypted. Then OpenKM will download the encrypted document localy, decrypt and save. After it it'll appearing a
information popup indicating the document has been saved localy.
99
Document encryption
100
Then must put decryptphrase and selecting the directory where you want to downloading the OpenKM document
decrypted. Then OpenKM will download the encrypted document locally, decrypt and save. After it it'll appearing a
information popup indicating the document has been saved locally.
The OpenKM document explorer UI will be refreshing and will appearing the document marked for editing.
Document encryption
101
Checkin encrypted document menu option. Will appearing a appearing a crypt popup.
Now simply put your cryptopharase twice, and select the file pressing the select file button. After it the document it'll
be encrypted locally with cryptophrase and uploaded to OpenKM. When it process it'll be finished it'll appearing a
successfully uploading popup message.
The OpenKM document explorer UI will be refreshing and will appearing the document with major version.
Document encryption
102
Cancelling checkin can be done with the normal cancel checkin button available in toolbar
Decrypt document
Decrypt document will decrypt some encrypted document in OpenKM and will replace for that decrypted version.
For security purpose all previous encrypted document versions will be removed and replaced by decrypted
document. Encrypted document will be downloaded and decrypted locally, then upload to OpenKM and purge
version history.
First must selecting some encrypted document yet available at OpenKM.
Document encryption
Then must put decryptphrase and selecting the Decrypt file button. The encrypted document will be downloaded
and decrypted locally and then uploaded to OpenKM and history version will be purged too. I'll appearing a
information popup indicating that operation has done sucessfully.
The OpenKM document explorer UI will be refreshing and will appearing the document decrypted with major
version and with history purged.
103
Document encryption
Encrypt document
Encrypt document will encrypt some non encrypted document in OpenKM and will replace for that encrypted
version. For security purpose all previous document versions will be removed and replaced by encrypted document.
Openkm document will be downloaded and encrypted locally, then upload to OpenKM and purge version history.
First must selecting some non encrypted document yet available at OpenKM.
The OpenKM document explorer UI will be refreshing and will appearing the document encrypted with major
version and with history purged.
104
Document encryption
Contacts
Contacts allow to assign contacts to documents, folders and mails. There are two available options, manage contacts
in tool menu and assign contacts using Contact tab on documents, folder or mail tab view.
Retrictions
You need write grants to adding a contact to some document / folder / mail.
You need delete grants to removing a contact to some document / folder / mail.
Manage contacts
Add contact
Edit contact
Delete contact
Manage contacts
Go to tools menu, and select the option manage contacts.
105
Contacts
106
can be edited.
Contacts
107
Selecting update button contact record will be updated, if you want to cancel editing must selecting cancel button.
If you want to create a new contact from manage contacts view, must selecting the new contact button. It'll
appearing a new contact with empty fields. Name field is mandatory.
Selecting add button contact record will be saved, if you want cancel editing must selecting cancel button.
If you want to delete a contact, must click on delete icon
Contacts
To adding a new contact must be selected add button. It'll appearing a popup.
Can selecting on right list, some contact to be linked to document, folder or mail, making a click on selecting
contact icon .
108
Contacts
109
Contacts
110
111
112
113
114
115
116