Protege Client Server Tutorial Administration - Revision history

TaniaTudorache at 20:04, December 16, 2009

2009-12-16T20:04:44Z

TaniaTudorache at 20:02, December 16, 2009

2009-12-16T20:02:03Z

TaniaTudorache at 19:56, December 16, 2009

2009-12-16T19:56:31Z

TaniaTudorache at 19:55, December 16, 2009

2009-12-16T19:55:38Z

TaniaTudorache at 20:55, February 13, 2009

2009-02-13T20:55:26Z

TaniaTudorache at 20:46, February 13, 2009

2009-02-13T20:46:00Z

TaniaTudorache at 20:35, February 13, 2009

2009-02-13T20:35:23Z

TaniaTudorache at 20:23, February 13, 2009

2009-02-13T20:23:02Z

TaniaTudorache at 20:15, February 13, 2009

2009-02-13T20:15:36Z

TaniaTudorache at 20:11, February 13, 2009

2009-02-13T20:11:31Z

@@ Line 11: / Line 11: @@
 = The Server Admin user interface =
-The Server Admin user interface allows the control of the Protege server in a user-friendly way. A user with the appropriate permissions (see the Policy section in the [[Protege_Client_Server_Tutorial_Configuration|server configuration page]] can start or stop server projects for maintenance without shutting down the server, she may kill other users' sessions (e.g., zombie sessions), or may shut down the server. The Server Admin user interface provides also useful statistics about the server work load.
+The Server Admin user interface allows the control of the Protege server in a user-friendly way. A user with the appropriate permissions (see the Policy section in the [[Protege_Client_Server_Tutorial_Configuration|server configuration page]] can start or stop server projects for maintenance without shutting down the server, she may kill other users' sessions (e.g., zombie sessions), or may shut down the server. It is also possible to make live changes to the metaproject content (e.g., add users, projects, change policies, etc.) The Server Admin user interface provides also useful statistics about the server work load.
 The user interface is composed of three tabs:
 * Projects Tab
 * Sessions Tab
 * Server Control Tab

@@ Line 135: / Line 135: @@
 If you are going the delete a project it is strongly recommended that you shut it down first from the Projects tab, and then delete the project from the Metaproject Tab.
 The Metaproject Tab will only show up if the user has ''Admin'' privileges.
@@ Line 141: / Line 143: @@
-= The Server Control Tab - Shut down the server =
+= The Server Control Tab =
-In the current version, the Server Control Tab only contains one button that allows the shutting down of the server. We may add other features in future versions.
+In the current version, the Server Control Tab allows one to shut down the Protege server or to save the metaproject. We may add other features in future versions.
@@ Line 149: / Line 151: @@
-To shut down the server, you need to have the ''Administer Server'' or ''Shut down server'' permissions, which can be configured in the metaproject. See the [[Protege_Client_Server_Tutorial_Configuration|server configuration page]] for more details on how to do this.
+To '''shut down the server''', you need to have the ''Administer Server'' or ''Shut down server'' permissions, which can be configured in the metaproject. See the [[Protege_Client_Server_Tutorial_Configuration|server configuration page]] for more details on how to do this.
 To shut down the server, click on the button. You will get a warning dialog like this:
@@ Line 162: / Line 164: @@
 [[Image:ServerAdmin_SessionKilledClientMessage.png]]
 '''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial|Protege client-server tutorial]].'''

← Older revision		Revision as of 19:56, December 16, 2009
Line 136:		Line 136:
	If you are going the delete a project it is strongly recommended that you shut it down first from the Projects tab, and then delete the project from the Metaproject Tab.		If you are going the delete a project it is strongly recommended that you shut it down first from the Projects tab, and then delete the project from the Metaproject Tab.

		+	The Metaproject Tab will only show up if the user has ''Admin'' privileges.

	[[Image:ServerAdmin_metaproject.png]]		[[Image:ServerAdmin_metaproject.png]]

← Older revision		Revision as of 19:55, December 16, 2009
Line 122:		Line 122:

	If the Protege client with the killed session is still running, it will get a notification from the server that its session has been killed. A dialog window will inform the user and the client will shut down cleanly.		If the Protege client with the killed session is still running, it will get a notification from the server that its session has been killed. A dialog window will inform the user and the client will shut down cleanly.
		+
		+
		+	= The Metaproject tab - live changes of the server configuration =
		+
		+	The Metaproject tab allows you to modify the server configuration of a running Protege server. Some of the operations you can perform are:
		+
		+	* add new users; change passwords
		+	* modify policies associated to projects, groups or server
		+	* add new projects
		+	* delete projects (shut them down first!)
		+	* etc.
		+
		+	If you are going the delete a project it is strongly recommended that you shut it down first from the Projects tab, and then delete the project from the Metaproject Tab.
		+
		+
		+	[[Image:ServerAdmin_metaproject.png]]

← Older revision		Revision as of 20:55, February 13, 2009
Line 121:		Line 121:
	To kill the session click on the OK button. You cannot kill your own administrative session.		To kill the session click on the OK button. You cannot kill your own administrative session.

		+	If the Protege client with the killed session is still running, it will get a notification from the server that its session has been killed. A dialog window will inform the user and the client will shut down cleanly.
		+
		+
		+	= The Server Control Tab - Shut down the server =
		+
		+	In the current version, the Server Control Tab only contains one button that allows the shutting down of the server. We may add other features in future versions.
		+
		+
		+	[[Image:ServerAdmin_Control.png]]
		+
		+
		+	To shut down the server, you need to have the ''Administer Server'' or ''Shut down server'' permissions, which can be configured in the metaproject. See the [[Protege_Client_Server_Tutorial_Configuration\|server configuration page]] for more details on how to do this.
		+
		+	To shut down the server, click on the button. You will get a warning dialog like this:
		+
		+
		+	[[Image:ServerAdmin_ShutdownMessage.png]]
		+
		+
		+	Before the server shuts down, it will save all the server projects. All connected clients will get a warning message that the server has been disconnected and their working sessions will be terminated cleanly. The dialog that the Protege clients get looks like this:
		+
		+
		+	[[Image:ServerAdmin_SessionKilledClientMessage.png]]



	'''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial\|Protege client-server tutorial]].'''		'''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial\|Protege client-server tutorial]].'''

← Older revision		Revision as of 20:46, February 13, 2009
Line 108:		Line 108:

	The Live sessions table shows all the sessions that are connected to the server. For each session, you can see the session id, the user name and IP, the projects in the session, and the login time.		The Live sessions table shows all the sessions that are connected to the server. For each session, you can see the session id, the user name and IP, the projects in the session, and the login time.
		+
		+	If you are using [[Collaborative_Protege\|Collaborative Protege]], you will see 3 sessions for a user: the domain project (e.g., Collaborative Pizza), the annotation project (e.g., Collaborative Pizza Annotations) and the Chat Project - which is shown as ''(none)'' in the table because it is not a project configured in the metaproject. If the Chat tab is not enabled, you will not see the Chat session. It is easy to tell which sessions "go together" by looking at the login time: For example, the 3 sessions corresponding to user Guest and project Collaborative Pizza have login time around 12:17:30.
		+
		+	Your own administrative session is marked with an <code>*</code> in the session id column. In the figure above, the admin session has id 109.
		+
		+	To kill a session, select the session in the table and click on the "X" icon. You will get a dialog like:
		+
		+
		+	[[Image:ServerAdmin_KillSessionMessage.png]]
		+
		+
		+	To kill the session click on the OK button. You cannot kill your own administrative session.

@@ Line 72: / Line 72: @@
-'''NOTE ABOUT SHUTTING DOWN PROJECTS WITH ANNOTATION PROJECT'''
+'''NOTE ABOUT SHUTTING DOWN A PROJECT WITH ANNOTATION PROJECT.'''  If a project has an associated annotation project, e.g., it is used with Collaborative Protege, then you need to stop first the domain project (e.g., Collaborative Pizza), and then, if desired, shut down the corresponding annotation project (e.g. Collaborative Pizza Annotation). It is not required to shut down the annotations project if the domain project has been shut down. However, do not shutdown the annotations project without shutting down first the domain project.
@@ Line 96: / Line 95: @@
 If the project is started successfully, the status of the project will change to ''READY''. Protege clients will now be able to open this project.
 '''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial|Protege client-server tutorial]].'''

← Older revision		Revision as of 20:23, February 13, 2009
Line 70:		Line 70:

	When the last notification is sent, the Protege clients will close the remote project automatically. At this point, the status of the project is ''CLOSED_FOR_MAINTENANCE''. You need to click on the Refresh button to see the new status.		When the last notification is sent, the Protege clients will close the remote project automatically. At this point, the status of the project is ''CLOSED_FOR_MAINTENANCE''. You need to click on the Refresh button to see the new status.
		+
		+
		+	'''NOTE ABOUT SHUTTING DOWN PROJECTS WITH ANNOTATION PROJECT'''
		+	If a project has an associated annotation project, e.g., it is used with Collaborative Protege, then you need to stop first the domain project (e.g., Collaborative Pizza), and then, if desired, shut down the corresponding annotation project (e.g. Collaborative Pizza Annotation). It is not required to shut down the annotations project if the domain project has been shut down. However, do not shutdown the annotations project without shutting down first the domain project.


Line 91:		Line 95:


		+	If the project is started successfully, the status of the project will change to ''READY''. Protege clients will now be able to open this project.

	'''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial\|Protege client-server tutorial]].'''		'''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial\|Protege client-server tutorial]].'''

@@ Line 36: / Line 36: @@
 The '''Remote Projects table''' shows each project with its status and connected sessions. The status of a project is one of:
-* <code>READY</code> - The project is ready to use and can be opened by the Protege clients.
+* '''READY''' - The project is ready to use and can be opened by the Protege clients.
-* <code>SHUTTING_DOWN</code> - The project has been scheduled for shutting down. New Protege clients will not be able to open this project. The shut down can be canceled at this point.
+* '''SHUTTING_DOWN''' - The project has been scheduled for shutting down. New Protege clients will not be able to open this project. The shut down can be canceled at this point.
-* <code>CLOSED_FOR_MAINTENANCE</code> - The project is shut down on the server. New Protege clients will not be able to open this project.
+* '''CLOSED_FOR_MAINTENANCE''' - The project is shut down on the server. New Protege clients will not be able to open this project.
 The sessions column shows what sessions (i.e, Protege clients) are connected to the project.
@@ Line 83: / Line 83: @@
-== Starting a project ==
+[[Image:ServerAdmin_StartProjectMessage.png]]
 '''Read more about the Protege multi-user support in the [[Protege_Client-Server_Tutorial|Protege client-server tutorial]].'''

@@ Line 48: / Line 48: @@
 * '''Milliseconds to calculate frame cache''' - shows how hard the server has to work to compute the cache for a frame in this particular project. If the value is higher than 10ms, then probably the server is loaded and you may expect slower performance.
 * '''Transaction isolation level''' - show the transaction isolation level for this particular project. If this is a file project, then the level will be <code>NONE</code>. If this is a database project, this field will show the database transaction level, which is one of <code>None</code>, <code>Read Uncommitted</code>, <code>Read Committed</code>, <code>Read Uncommitted</code>, <code>Repeatable Read</code> or <code>Serializable</code>. Read more about the database transaction levels on this webpage: http://en.wikipedia.org/wiki/Isolation_(database_systems).
 The '''Users table''' show the connected users for this particular project, together with their session information, and information about whether the user is in a transaction or not. If a user is in a long-running transaction, other users may experience a slow down in the UI. While a user is in a transaction, other Protege clients are not able to write to the ontology. The Users table also shows the server backlog - the number of requests the server has to calculate for that particular user and project. Normally you should not see a backlog, or if you do, the server should be able to process it. Click on refresh button to update the information. If the backlog is not cleared, then something may be wrong with the server (too high load).
@@ Line 73: / Line 74: @@
 == Canceling a scheduled shutdown of a server project ==
-To cancel a scheduled project shutdown,
+To cancel a scheduled project shutdown, the project has to be in the ''SHUTTING_DOWN'' state. If the project is already in ''CLOSED_FOR_MAINTENANCE'' state, this means that the project is already shut down and you cannot cancel the operation anymore. So, to cancel the shut down, select the project in the Remote Projects table and click on the green tick mark icon. You will see a dialog like this: