You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by il...@apache.org on 2016/08/24 14:51:57 UTC
[3/3] syncope git commit: [SYNCOPE-700] Working with admin console
[SYNCOPE-700] Working with admin console
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/c4587cfd
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/c4587cfd
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/c4587cfd
Branch: refs/heads/master
Commit: c4587cfdffecd88e7da3449192f47b8e457e61c5
Parents: 2cba1c0
Author: Francesco Chicchiricc� <il...@apache.org>
Authored: Wed Aug 24 16:51:39 2016 +0200
Committer: Francesco Chicchiricc� <il...@apache.org>
Committed: Wed Aug 24 16:51:39 2016 +0200
----------------------------------------------------------------------
.../adminconsole/adminconsole.adoc | 4 +-
.../adminconsole/configuration.adoc | 37 ++++++++--------
.../adminconsole/dashboard.adoc | 38 ++---------------
.../adminconsole/extensions.adoc | 7 +---
.../adminconsole/realms.adoc | 44 ++------------------
.../adminconsole/reports.adoc | 7 ++--
.../adminconsole/topology.adoc | 9 ++--
7 files changed, 35 insertions(+), 111 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc
index 056ed25..896166a 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/adminconsole.adoc
@@ -17,7 +17,7 @@
// under the License.
//
=== Admin Console
-Once Apache Syncope applications have been deployed, you can go to the following url to access the admin console.
+Once the Java EE container has initialized, the admin console can be accessed at:
[source]
--
http://host:port/syncope-console/
@@ -29,7 +29,7 @@ You should be greeted with the following web page.
image::consoleLogin.png[console-login]
-The default admin password for a fresh installation is "password". Enter your credentials and press Login.
+You can use the <<changing-admin-password,default admin credentials>> to login.
==== Pages
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc
index 2f5335f..6367e04 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/configuration.adoc
@@ -16,52 +16,49 @@
// specific language governing permissions and limitations
// under the License.
//
-
===== Configuration
-The configuration tab allows the admin to customize the syncope deployment to fit the needs of the
-organization. It provides the following functionality
+
+The configuration pages allow the designated administators to customize the given deployment to fit the needs of the
+organization.
[[console-configuration-audit]]
Audit::
-Allows the admin to inspect the functionality of various components of the syncope deployment.
+Allows to configure the <<audit,auditing>> features.
[[console-configuration-logs]]
Logs::
-The admin can set the level of logs that are to be displayed. For example, the admin can set it
-to display only the errors of io.swagger, in which case the warnings and information logs will
-not be displayed.
+The logging levels available can be dynamically adjusted; for example, the admin can set it
+to display only the errors of `io.swagger`, in which case the warnings and information logs will not be reported.
[[console-configuration-notifications]]
Notifications::
-This allows the admin to set events and corresponding templates for mail notification to be sent
-to the Users. Trace level defines the condition in which an event will trigger the sending of a
-notification. Templates for such notifications can also be added and edited using this tab.
+Gives access to the <<notifications,notification>> management. +
+This page also allows the administators to create and edit <<notification-templates,notification templates>>.
[[console-configuration-parameters]]
Parameters::
-Presents the user with a list of key value pairs containing variables used in the syncope
-deployment such as token.expireTime and password.cipher.algorithm . These can be edited by the
-admin to further customize the deployment.
+Presents the administrators with the list of defined <<configuration-parameters,configurtion parameters>> used in the
+given deployment such as `token.expireTime` and `password.cipher.algorithm`.
+These can be edited to further customize the deployment. +
+New parameters can also be added, for usage with custom code.
[[console-configuration-policies]]
Policies::
-Allows the admin to define rules for account, passwords and pulls. Accounts and password policies
-are defined using java classes while pull policies are defined from within the console using
-correlation rules.
+Allows the administrators to manage <<policies-account,account>>, <<policies-password,password>> and
+<<policies-pull,pull>> policies.
[[console-configuration-roles]]
Roles::
-Displays and provides editing functionality for roles and their corresponding entitlements along
-with the realms that they are enforced upon.
+Displays and provides editing functionality for <<roles,roles>>.
[[console-configuration-security-questions]]
Security Questions::
-The admin can use this to define a set of security questions which the endUsers can choose from
-to allow them to recover their account in case of a forgotten password.
+The administrators can use this page to define a set of security questions which the users can choose from when
+managing their own profile, to allow them to recover their account in case of a forgotten password.
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc
index c05dcc1..cbc5f63 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/dashboard.adoc
@@ -16,41 +16,9 @@
// specific language governing permissions and limitations
// under the License.
//
-
===== Dashboard
-The dashboard provides an overall view of the current state of the syncope deployment. It
-consists of various widgets and tabs that show the different metrics and details of each component
-of the syncope deployment.
-
-image::consoleDashboard.png[console-dashboard]
-
-Overview::
-
-Contains widgets to display
-
-* Number of Users
-* Number of Groups
-* Number of external resource instances available (Printer as a default)
-* Number of resources
-* Configuration Status: Shows the status of missing or incomplete configurations.
-* System Load: Shows the CPU and Memory usage of the syncope deployment on the server.
-* User Status: Shows the status of tasks for admin such as provisioning resources to user.
-* Users, Groups and Any Objects Distribution
-Control::
+The dashboard provides an overall view of the current state of the Apache Syncope deployment. It
+consists of various widgets and tabs that show the different metrics and details of each component available.
-Allows admin to
-
-* Run a predefined list of jobs
-* View Reconciliation status of recently run jobs
-
-Extensions::
-
-The default syncope installation comes with camel metrics enabled which allows the user to see how
-many
-
-* Users have been activated
-* Passwords have been reset
-* Objects have been created
-* Groups have been created
-* Group pulls have been created...
+image::consoleDashboard.png[console-dashboard]
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/extensions.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/extensions.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/extensions.adoc
index aadd49e..afaa4f7 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/extensions.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/extensions.adoc
@@ -18,9 +18,6 @@
//
[[console-extensions]]
===== Extensions
-The extensions tab shows the extensions installed on the given Apache Syncope deployment.
-Among the available extensions, the one for Apache Camel-based provisioning is often installed: Users can inspect the
-performance measures for the various routes defined.
-
-image::consoleCamelExtension.png[console-camel-extension]
+The <<extensions,extensions>> configured for the given deployment are dynamically reported in the navigation menu: each
+extension generally produces one or more pages and makes one or more widgets available in the <<dashboard,dashboard>>.
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc
index 4732e90..701f021 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/realms.adoc
@@ -18,46 +18,8 @@
//
[[console-realms]]
===== Realms
-The realms tab provides the admin with the power to manage Users, Groups and Any Objects, for all Any Types defined.
-image::realmsUser.png[console-realms-user]
-
-User::
-
-Allows the admin to
-
-* Create user
-* Force password change for user
-* Manage resources available to user
-* Enable/Disable Users
-* Clone a user
-* Edit user details
-* View and edit propagation tasks of user
-* View and edit notification tasks of user
-* Delete user
-
-Group::
+The realms page provides the designated administators with the power to manage <<realms>> as well as
+<<users-groups-and-any-objects>>, for all <<anytype, Any Types>> defined.
-Allows admin to
-
-* Create group
-* Clone a group
-* Edit group details
-* View, create and edit extensions
-* View and edit propagation tasks of group
-* View and edit notification tasks of group
-* Provision members
-* Deprovision members
-* Delete group
-
-Printers::
-
-The default syncope installation comes with printers add as a object. This can be reconfigured for
-other things such as folders and services.
-
-* Add a new printer
-* Clone a printer entry
-* Edit printer details
-* View and edit propagation tasks of printer
-* View and edit notification tasks of printer
-* Delete printer
+image::realmsUser.png[console-realms-user]
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/reports.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/reports.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/reports.adoc
index 36133e8..71f1801 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/reports.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/reports.adoc
@@ -18,8 +18,9 @@
//
[[console-reports]]
===== Reports
-The reports tab presents the admin with the reports generated from various jobs run on the syncope
-deployment. These reports are displayed using report templates which can be defined for FO, HTML
-and CSV formats. This tab also allows the admin to create and edit such templates.
+
+The reports page presents the designated administators with the list of <<reports,reports>> configured on the given
+deployment. +
+This page also allows the administators to create and edit <<report-templates,report templates>>.
image::consoleReports.png[console-reports]
http://git-wip-us.apache.org/repos/asf/syncope/blob/c4587cfd/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc
index efbc43f2..bd281f0 100644
--- a/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc
+++ b/src/main/asciidoc/reference-guide/workingwithapachesyncope/adminconsole/topology.adoc
@@ -16,11 +16,10 @@
// specific language governing permissions and limitations
// under the License.
//
-
===== Topology
-The topology tab provides a mapped view of the available connector bundles, instances and
-resources available and configured in the syncope deployment. It also allows the admin to perform
-all the actions listed in the realms tab.
-image::consoleTopology.png[console-topology]
+The topology page provides a mapped view of the available <<connector-instance-details,connectors>> and
+<<external-resource-details,external resources>> available and configured in the given deployment. +
+Different actions are available when clicking on the various nodes.
+image::consoleTopology.png[console-topology]