Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added content to the Using the Admin Console section of the Reference Guide #19

Closed
wants to merge 2 commits into from

Conversation

Projects
None yet
2 participants
@tmess567
Copy link
Contributor

tmess567 commented Jun 12, 2016

I have added some content to the "Using the Admin Console" section for the Reference Guide along with screenshots for the same. Please suggest any required changes or addition / removal screenshots.

Also, I will need help to understand the usage of Types and Workflow tabs in the Configurations part of the admin console so that I can add documentation for it.

tmess567 added some commits Jun 12, 2016

@ilgrosso

This comment has been minimized.

Copy link
Member

ilgrosso commented Jun 13, 2016

Hi @tmess567 thanks for this initiative!
I will review this PR soon, please keep adding commits to it.

Please also refer to SYNCOPE-700 in the commit log message, thanks.

@@ -31,7 +31,7 @@ operating system. +

. http://maven.apache.org/[Apache Maven^] (version 3.0.3 or higher) installed
. one of the supported <<internal-storage,DBMSes>> up and running
. one of the supported <<java-ee-container, Java EE containers>> up and running
. one of the supported <<java-ee-container, Java EE containers>> up and running

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please void this whitespace changes.

@@ -112,7 +112,7 @@ image::installer-10.png[installer-10]
Application server settings::
* Depends on container selected (in the example: Tomcat)

The next images shows how the installer print some feedback directly on the GUI or reading the log file under the
The next images shows how the installer print some feedback directly on the GUI or reading the log file under the

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please void this whitespace changes.

image::installer-14.png[installer-14]

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please void this whitespace changes.

@@ -18,20 +18,20 @@
//
=== Provisioning
The main purpose of identity management systems is to manage user and role provisioning.
User and role provisioning refers to the creation, maintenance, activation and deactivation of user and role objects
and their attributes. Provisioning operations can act on Apache Syncope only or be propagated towards external
User and role provisioning refers to the creation, maintenance, activation and deactivation of user and role objects

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please void this whitespace changes.

include::propagation.adoc[]

include::resources.adoc[]

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please restore the original ordering (e.g. with resources after connectors)

This comment has been minimized.

Copy link
@tmess567

tmess567 Jun 16, 2016

Author Contributor

The document for resources refers to propagation which is described after it. This was a bit confusing when I read it, so I made this change. Should I remove this?

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 17, 2016

Member

Yes, please restore the original ordering.
Maybe you could enrich the introduction above with some terminology.

include::authentication.adoc[]

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please void this whitespace changes.

This comment has been minimized.

Copy link
@tmess567

tmess567 Jun 17, 2016

Author Contributor

I don't understand why git is generating this diff. The master and this branch have identical lines here.

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 17, 2016

Member

Are you on Windows? Maybe it's just line-ending stuff.

This comment has been minimized.

Copy link
@tmess567

tmess567 Jun 17, 2016

Author Contributor

Sublime Text 3 on Linux x64. Nevermind, I'll just copy the file from master and remake the required changes.

@ilgrosso

This comment has been minimized.

Copy link
Member

ilgrosso commented Jun 16, 2016

You need to make the following modification, otherwise your changes won't be included in the generated PDF / HTML:

ilgrosso@sequoia:~/work/syncope/syncope2$ git diff
diff --git a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
index a451889..9dd208e 100644
--- a/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/workingwithapachesyncope.adoc
@@ -27,7 +27,7 @@ include::installation/installation.adoc[]

 == Working with Apache Syncope

-=== Using the Admin Console
+include::adminconsole/adminconsole.adoc[]

 include::cli/cli.adoc[]
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]

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

It might be better to include here the screenshot from -Pembedded rather than the one from standalone distribution, since in the latter there is no local connector bundles, only connector server.

Once the syncope installation has been deployed to a server, you can go to the following url to access the console.
[source]
--
http://localhost:9080/syncope-console/

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Please explain that host and port actually depend on the local deployment.

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.

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Missing information:

  • reports can be run several times, each execution can be exported in the supported formats
  • reports can be defined by composing reportlet instances
  • predefined reportlets are available, more can be developed
//

===== Realms
The realms tab provides the admin with the power to manage users, groups and resources...

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

users, groups and any objects for all any types defined

image::consoleLogin.png[console-login]

The default admin password for a fresh installation is "password". Enter your credentials and
press Login.

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

Recommend to change the default admin credentials right after installation.

//

===== Extensions
The extensions tab allows the user to configure the extensions installed on the syncope

This comment has been minimized.

Copy link
@ilgrosso

ilgrosso Jun 16, 2016

Member

This tab shows extensions installed, does not allow to configure.

@ilgrosso

This comment has been minimized.

Copy link
Member

ilgrosso commented Jun 16, 2016

Also, I will need help to understand the usage of Types and Workflow tabs in the Configurations part of the admin console so that I can add documentation for it.

Types

The Types entry allows to define and maintain the internal data model:

  • schema - defines which attribute types are available
  • classes: group schemas (similar to LDAP object classes)
  • types: allow to assign structural classes to any types (e.g. USER, GROUP, PRINTER, whatever) so that you can determine which attributes are available for users, groups and printers
  • relationship types: defines which relationships can occur between users and any objects or any objects and other any objects

Workflow

See https://cwiki.apache.org/confluence/display/SYNCOPE/User+Workflow

@tmess567

This comment has been minimized.

Copy link
Contributor Author

tmess567 commented Jun 17, 2016

Can I just reuse the above text (for types description) and also the one at https://cwiki.apache.org/confluence/display/SYNCOPE/User+Workflow or do I need to make any changes?

@ilgrosso

This comment has been minimized.

Copy link
Member

ilgrosso commented Jun 17, 2016

You can of course use the text above as starting point, but it would be nice to expand some concepts.
Same applies to wiki page.

@ilgrosso

This comment has been minimized.

Copy link
Member

ilgrosso commented Jul 1, 2016

@tmess567 if you don't mind, I'll merge this PR as it is right now and continue working from here, since I am about to start again on SYNCOPE-700.
Fine with you?

@tmess567

This comment has been minimized.

Copy link
Contributor Author

tmess567 commented Jul 1, 2016

Yeah sure, I will continue to work on this locally whenever I get the time and create a new PR when done.

@ilgrosso

This comment has been minimized.

Copy link
Member

ilgrosso commented Jul 1, 2016

Thanks!

@asfgit asfgit closed this in c525611 Jul 1, 2016

mteo pushed a commit to mteo/syncope that referenced this pull request Aug 3, 2016

[SYNCOPE-700] Corrected misspells and also added content to the Using…
… the Admin Console section for the reference guide - This closes apache#19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.