Difference between revisions of "User administration"

From OpenKM Documentation
Jump to: navigation, search
(→‎User mail accounts)
(→‎Creating a new user)
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{TOCright}} __TOC__
 
{{TOCright}} __TOC__
  
−
With User administration view can '''create''', '''updating''', '''deleting''', '''enable''' and '''disable''' users accounts and '''assigning several mail account''' address and '''twitter account'''.
+
With User administration view you can '''create''', '''update''', '''delete''', '''enable''' and '''disable''' users accounts and '''assign several mail account''' address and '''twitter accounts'''.
  
−
{{Note|Althought OpenKM can handle several mail user accounts, users will only can manage one account from the user interface.}}
+
{{Note|Although OpenKM can handle several email accounts, users can only manage one account from the user interface.}}
  
 
Detail of the functions according to their icons:  
 
Detail of the functions according to their icons:  
  
−
* [[File:New.png]] → Create new user
+
* [[File:Add.png]] → Create new user
 
* [[File:True.png]] → User enabled
 
* [[File:True.png]] → User enabled
 
* [[File:False.png]] → User disabled
 
* [[File:False.png]] → User disabled
Line 15: Line 15:
 
* [[File:Twitter.png]] → Edit twitter account
 
* [[File:Twitter.png]] → Edit twitter account
  
−
In main user administration view, you can take a fast look about actual users.
+
In main user administration view, you can take a quick look at actual users.
  
  
−
[[File:Okm_admin_041.jpeg|758px|center]]
+
[[File:Okm_admin_46.jpeg|758px|center]]
  
  
 
== Switch User / roles view ==
 
== Switch User / roles view ==
−
In top window you can switch between users and roles view list making a click in properly option
+
In the top window you can switch between users and roles view list by clicking on the proper option
  
  
 
{| align="center"
 
{| align="center"
 
| [[File:Okm_admin_039.jpeg|center]]
 
| [[File:Okm_admin_039.jpeg|center]]
−
| <=>
 
−
| [[File:Okm_admin_042.jpeg|center]]
 
 
|}
 
|}
  
 
=== User view ===
 
=== User view ===
  
−
[[File:Okm_admin_041.jpeg|750px|center]]
+
[[File:Okm_admin_46.jpeg|750px|center]]
  
 
=== Role view ===
 
=== Role view ===
  
 
[[File:Okm_admin_040.jpeg|center]]
 
[[File:Okm_admin_040.jpeg|center]]
 +
 +
== Creating a new role ==
 +
 +
To create a new role click on the [[File:Add.png]] '''create new role icon''':
 +
 +
 +
[[File:Okm_admin_044.jpeg|center]]
 +
 +
 +
After creating the new role, you'll return to view all roles list (now with the role you've created).
 +
 +
 +
== Deleting a role ==
 +
To delete a role click on the [[File:Delete.png]] '''delete role icon''':
 +
 +
 +
[[File:Okm_admin_045.jpeg|center]]
 +
 +
 +
After deleting a role, you'll return to view all roles list.
  
 
== Filtering by role ==
 
== Filtering by role ==
  
−
Using filtering form, you can select filtering list only by users with some Role.
+
Using filtering form, you can select to filter the list only by users with some Role.
  
  
Line 48: Line 66:
  
 
== Creating a new user ==
 
== Creating a new user ==
−
To create a new user click in [[File:New.png]] '''create new user icon''':
+
To create a new user click on the [[File:Add.png]] '''create new user icon''':
  
  
Line 56: Line 74:
 
After creating the new user, you'll return to view all users list (now with the user you've created).
 
After creating the new user, you'll return to view all users list (now with the user you've created).
  
−
{{Note|Remember that every user should have assigned the UserRole or AdminRole to log into OpenKM.}}
+
{{Warning|Remember that every user should have assigned the '''ROLE_USER''' or '''ROLE_ADMIN''' to log into OpenKM. In OpenKM 5.1 the roles where ''UserRole'' or ''AdminRole''.}}
  
−
== Updating an user ==
+
== Updating a user ==
 
To update an user have to click in [[File:Edit.png]] '''edit user icon''':
 
To update an user have to click in [[File:Edit.png]] '''edit user icon''':
  
Line 67: Line 85:
 
After updating a user, you'll return to view all users list.
 
After updating a user, you'll return to view all users list.
  
−
== Deleting an user ==  
+
== Deleting a user ==  
−
To delete an user click in [[File:Delete.png]] '''delete user icon''':
+
To delete a user click on the [[File:Delete.png]] '''delete user icon''':
  
  
Line 75: Line 93:
  
 
After deleting a user, you'll return to view all users list.
 
After deleting a user, you'll return to view all users list.
 +
 +
 +
== Edit user config ==
 +
To edit user config click on the [[File:Config.png]] '''config user icon''':
 +
 +
[[File:Okm_admin_47.jpeg|center]]
 +
 +
After updating user configuration, you'll return to view all users list.
 +
  
 
== User mail accounts ==
 
== User mail accounts ==
−
To view the user mail accounts, please click in [[File:Email.png]] '''edit mail accounts icon''':
+
To view the user mail accounts, click on the [[File:Email.png]] '''edit mail accounts icon''':
  
  
Line 84: Line 111:
  
 
A list of all mail accounts assigned to a user will be visible.
 
A list of all mail accounts assigned to a user will be visible.
 +
 +
{{Warning|Remeber to activate the mail import scheduler. Read more at [http://wiki.openkm.com/index.php/OpenKM.cfg#Configuring_schedulers Configuring schedulers].}}
  
 
== Creating user mail accounts ==
 
== Creating user mail accounts ==
 +
To insert a new mail user account click on the [[File:Add.png]] '''new mail account icon''':
  
−
To insert a new mail user account click in [[File:New.png]] '''new mail account icon'''
 
  
 +
[[File:Okm_admin_048.jpeg|center]]
  
−
In the inserting screen form you'll must set some maill account information like, user mail, host server, mail server password and imap folder.
 
  
 +
In the page you should set some mail account information like mail protocol, user mail, host server, mail server password [[wikipedia:IMAP|IMAP]] folder and if when mail is read it should be marked as read or to be deleted.
  
−
[[File:Okm_admin_031.jpeg|center]]
+
{{Advice|In Google Mail, these [[wikipedia:IMAP|IMAP]] folders are called labels.}}
  
 +
[[File:Okm_admin_032.jpeg|750px|center]]
  
−
{{Note|OpenKM imports periodically mails from imap mail accounts}}
+
{{Note|OpenKM periodically will import mails from [[wikipedia:IMAP|IMAP]] pop3 or IMAPS accounts.}}
 +
 
 +
== Deleting mail accounts ==
 +
To delete a user related mail account, click on the [[File:Email.png]] '''edit mail accounts icon''':
  
  
Line 102: Line 136:
  
  
−
== Deleting mail accounts ==  
+
Then click on [[File:Delete.png]] '''Delete mail account'''. After deleting the mail account, you'll return to view all mail account list.
 +
 
 +
== Updating mail accounts ==  
  
−
To Deleting a user mail accounts must first make a click in [[File:Email.png]] '''edit mail accounts icon'''  
+
To update a user mail account, first click on the [[File:Email.png]] '''edit mail accounts icon'''  
  
  
Line 110: Line 146:
  
  
−
Then make a click in [[File:Delete.png]] '''Delete mail account'''
+
Then click on [[File:Edit.png]] '''Edit mail account'''
 +
 
 +
 
 +
[[File:Okm_admin_049.jpeg|center]]
  
  
−
After deleting the mail account, you'll return to view all mail account list.
+
After updating the mail account, you'll return to view all mail account list.
 +
 
 +
 
 +
== Configuring mail filters ==
 +
Then click on [[File:Filter.png]] '''Filter mail account'''
 +
 
 +
 
 +
[[File:Okm_admin_050.jpeg|center]]
 +
 
 +
 
 +
Then click on [[File:Add.png]] '''Add new mail filter'''
  
−
== Updating mail accounts ==
 
  
−
To Updating a user mail accounts must first make a click in [[File:Email.png]] '''edit mail accounts icon'''
+
Must select a valid OpenKM folder where mails will be imported. If the grouping option is selected, the mail will be imported into a folder structure based on year/date/day of the mail
  
  
−
[[File:Okm_admin_032.jpeg|750px|center]]
+
[[File:Okm_admin_051.jpeg|center]]
  
 +
== Add mail filtering rules ==
  
−
Then make a click in [[File:Edit.png]] '''Edit mail account'''
+
Then click on [[File:Rule.png]] '''Rule mail filter'''
  
  
−
[[File:Okm_admin_033.jpeg|center]]
+
[[File:Okm_admin_052.jpeg|center]]
  
  
−
After updating the mail account, you'll return to view all mail account list.
+
Then click on [[File:Add.png]] '''Add new rule'''
  
  
−
== User twitter accounts ==
+
[[File:Okm_admin_053.jpeg|center]]
  
  
−
To view the user twitter accounts must make a click in [[File:Twitter.png]] '''edit twitter accounts icon'''
+
It must be selected the field (from, to subject content ) that must have the valid condition (contains / equals ) with some value. Note if you've got several rules in a filter rules, all must be true.
  
  
−
[[File:Okm_admin_035.jpeg|750px|center]]
+
[[File:Okm_admin_054.jpeg|center]]
  
  
−
It'll appears a list of all twitter accounts assigned to a user.
+
== User twitter accounts ==
 +
To view the user twitter accounts, click on the [[File:Twitter.png]] '''edit twitter accounts icon''':
  
  
−
== Creating user twitter accounts ==
+
[[File:Okm_admin_035.jpeg|750px|center]]
  
−
To insert a new twitter user account click in [[File:New.png]] '''new twitter account icon'''
 
  
 +
There will appear a list of all twitter accounts assigned to a user.
  
−
In the inserting screen form you'll must set some twitter account information like twitter user.
+
== Creating user twitter accounts ==
 +
To insert a new twitter user account click on the [[File:Add.png]] '''new twitter account icon''':
  
  
Line 155: Line 206:
  
  
−
{{Note|OpenKM uses twitter accounts to make notifications}}
+
In the following screen, set some twitter account information like twitter user.
  
  
 
[[File:Okm_admin_037.jpeg|750px|center]]
 
[[File:Okm_admin_037.jpeg|750px|center]]
  
 +
 +
{{Note|OpenKM can be configured to send user notification with twitter.}}
  
 
== Deleting twitter accounts ==  
 
== Deleting twitter accounts ==  
  
−
To Deleting a user twitter accounts must first make a click in [[File:Twitter.png]] '''edit twitter accounts icon'''  
+
To delete a user's twitter accounts, first click on the [[File:Twitter.png]] '''edit twitter accounts icon'''  
  
  
Line 169: Line 222:
  
  
−
Then make a click in [[File:Delete.png]] '''Delete twitter account'''
+
Then click on [[File:Delete.png]] '''Delete twitter account'''
  
  
Line 177: Line 230:
 
== Updating twitter accounts ==  
 
== Updating twitter accounts ==  
  
−
To Updating a user twitter accounts must first make a click in [[File:Email.png]] '''edit twitter accounts icon'''  
+
To update a user's twitter accounts, first click on the [[File:Email.png]] '''edit twitter accounts icon'''  
  
  
Line 183: Line 236:
  
  
−
Then make a click in [[File:Edit.png]] '''Edit twitter account'''
+
Then click on [[File:Edit.png]] '''Edit twitter account'''
  
  

Latest revision as of 10:59, 20 December 2012

With User administration view you can create, update, delete, enable and disable users accounts and assign several mail account address and twitter accounts.


Nota clasica.png Although OpenKM can handle several email accounts, users can only manage one account from the user interface.

Detail of the functions according to their icons:

  • Add.png → Create new user
  • True.png → User enabled
  • False.png → User disabled
  • Edit.png → Edit user
  • Delete.png → Delete user
  • Email.png → Edit mail accounts
  • Twitter.png → Edit twitter account

In main user administration view, you can take a quick look at actual users.


Okm admin 46.jpeg


Switch User / roles view

In the top window you can switch between users and roles view list by clicking on the proper option


Okm admin 039.jpeg

User view

Okm admin 46.jpeg

Role view

Okm admin 040.jpeg

Creating a new role

To create a new role click on the Add.png create new role icon:


Okm admin 044.jpeg


After creating the new role, you'll return to view all roles list (now with the role you've created).


Deleting a role

To delete a role click on the Delete.png delete role icon:


Okm admin 045.jpeg


After deleting a role, you'll return to view all roles list.

Filtering by role

Using filtering form, you can select to filter the list only by users with some Role.


Okm admin 028.jpeg


Creating a new user

To create a new user click on the Add.png create new user icon:


Okm admin 015.jpeg


After creating the new user, you'll return to view all users list (now with the user you've created).


Nota advertencia.png Remember that every user should have assigned the ROLE_USER or ROLE_ADMIN to log into OpenKM. In OpenKM 5.1 the roles where UserRole or AdminRole.

Updating a user

To update an user have to click in Edit.png edit user icon:


Okm admin 029.jpeg


After updating a user, you'll return to view all users list.

Deleting a user

To delete a user click on the Delete.png delete user icon:


Okm admin 034.jpeg


After deleting a user, you'll return to view all users list.


Edit user config

To edit user config click on the Config.png config user icon:

Okm admin 47.jpeg

After updating user configuration, you'll return to view all users list.


User mail accounts

To view the user mail accounts, click on the Email.png edit mail accounts icon:


Okm admin 030.jpeg


A list of all mail accounts assigned to a user will be visible.


Nota advertencia.png Remeber to activate the mail import scheduler. Read more at Configuring schedulers.

Creating user mail accounts

To insert a new mail user account click on the Add.png new mail account icon:


Okm admin 048.jpeg


In the page you should set some mail account information like mail protocol, user mail, host server, mail server password IMAP folder and if when mail is read it should be marked as read or to be deleted.


Nota idea.png In Google Mail, these IMAP folders are called labels.

Okm admin 032.jpeg

Nota clasica.png OpenKM periodically will import mails from IMAP pop3 or IMAPS accounts.

Deleting mail accounts

To delete a user related mail account, click on the Email.png edit mail accounts icon:


Okm admin 032.jpeg


Then click on Delete.png Delete mail account. After deleting the mail account, you'll return to view all mail account list.

Updating mail accounts

To update a user mail account, first click on the Email.png edit mail accounts icon


Okm admin 032.jpeg


Then click on Edit.png Edit mail account


Okm admin 049.jpeg


After updating the mail account, you'll return to view all mail account list.


Configuring mail filters

Then click on Filter.png Filter mail account


Okm admin 050.jpeg


Then click on Add.png Add new mail filter


Must select a valid OpenKM folder where mails will be imported. If the grouping option is selected, the mail will be imported into a folder structure based on year/date/day of the mail


Okm admin 051.jpeg

Add mail filtering rules

Then click on Rule.png Rule mail filter


Okm admin 052.jpeg


Then click on Add.png Add new rule


Okm admin 053.jpeg


It must be selected the field (from, to subject content ) that must have the valid condition (contains / equals ) with some value. Note if you've got several rules in a filter rules, all must be true.


Okm admin 054.jpeg


User twitter accounts

To view the user twitter accounts, click on the Twitter.png edit twitter accounts icon:


Okm admin 035.jpeg


There will appear a list of all twitter accounts assigned to a user.

Creating user twitter accounts

To insert a new twitter user account click on the Add.png new twitter account icon:


Okm admin 036.jpeg


In the following screen, set some twitter account information like twitter user.


Okm admin 037.jpeg



Nota clasica.png OpenKM can be configured to send user notification with twitter.

Deleting twitter accounts

To delete a user's twitter accounts, first click on the Twitter.png edit twitter accounts icon


Okm admin 037.jpeg


Then click on Delete.png Delete twitter account


After deleting the twitter account, you'll return to view all twitter account list.


Updating twitter accounts

To update a user's twitter accounts, first click on the Email.png edit twitter accounts icon


Okm admin 037.jpeg


Then click on Edit.png Edit twitter account


Okm admin 038.jpeg


After updating the twitter account, you'll return to view all twitter account list.

Retrieved from "https://www.openkm.com/wiki/index.php?title=User_administration&oldid=8336"