You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by ma...@apache.org on 2015/12/16 17:50:59 UTC
[1/2] syncope git commit: refactoring of CLI documentation,
SYNCOPE-700
Repository: syncope
Updated Branches:
refs/heads/master 546ea0bf3 -> dbc909278
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc
index ed2715c..30fd6fd 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/user.adoc
@@ -32,502 +32,48 @@ Usage: user [options]
Syntax: --get-user-key {USERNAME} {USERNAME} [...]
--get-username
Syntax: --get-username {USER-ID} {USER-ID} [...]
- --read
- Syntax: --read {USER-ID} {USER-ID} [...]
- --search-by-attribute
+ --read-by-usernam
+ Syntax: --read-by-usernam {USERNAME} {USERNAME} [...]
+ --read-by-userid
+ Syntax: --read-by-userid {USER-ID} {USER-ID} [...]
+ --search-by-attribute
Syntax: --search-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE}
- --search-by-role
+ --search-by-role
Syntax: --search-by-role {REALM} {ROLE-ID}
- --search-by-resource
+ --search-by-resource
Syntax: --search-by-resource {REALM} {RESOURCE-NAME}
- --delete
+ --delete
Syntax: --delete {USER-ID} {USER-ID} [...]
--delete-all
Syntax: --delete-all {REALM}
- --delete-by-attribute
+ --delete-by-attribute
Syntax: --delete-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE}
----
-===== Details option
-This option shows a table with some details about the users.
-
-[source]
---
-$ ./syncopeadm.sh user --details
---
-
-[source]
---
-
-You are running: user --details
-
-#################################
-# #
-# USERS DETAILS #
-# #
-#################################
-# # #
-# DETAIL # VALUE #
-# # #
-#################################
-# # #
-# Total number # 5 #
-# Active # 5 #
-# Suspended # 0 #
-# Without resources # 0 #
-# Without roles # 2 #
-# # #
-#################################
-
---
-
-===== List option
-Running the command with this option you will see the list of all users in the environment. However, the system will ask you a confirmation before execution, because as you can imagine this operation might produce very large output.
-
-[source]
---
-$ ./syncopeadm.sh user --list
---
-[source]
---
-You are running: user --list
-
-This operation might produce very large output. Do you want to continue? [yes/no]
-yes
-
- > USER ID: 2
- username: verdi
- realm: /
- status: active
- RESOURCES:
- - ws-target-resource-list-mappings-1
- - ws-target-resource-list-mappings-2
- ROLES:
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- fullname: [Giuseppe Verdi]
- firstname: [Giuseppe]
- surname: [Verdi]
- userId: [verdi@apache.org]
- email: [verdi@syncope.org]
- DERIVED ATTRIBUTES:
- info: [verdi - 2010-10-20T11:00:00+0200[0]] - is readonly.
- noschema: [Verdi, ] - is readonly.
- cn: [Verdi, Giuseppe] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
+===== Options
---
-
-===== Get user key option
+--details::
+This option shows a table with some details about the users.
+-- List option::
+Running the command with this option you will see the list of all users in the environment. However, the system will
+ask you a confirmation before execution, because as you can imagine this operation might produce very large output.
+--get-user-key::
The option to get the user key starting from a username.
-
-[source]
---
-$ ./syncopeadm.sh user --get-user-key {USERNAME}
---
-
-[source]
---
-You are running: user --get-user-key rossini
-
- - rossini user ID is 1
---
-
-===== Get username option
+--get-username::
The option to get the username starting from a user id.
-
-[source]
---
-$ ./syncopeadm.sh user --get-user-key {USER-ID}
---
-
-[source]
---
-You are running: user --get-username 1
-
- - 1 username is rossini
---
-
-===== Read by user id option
+--read-by-userid::
The option to read user information by their user id.
-
-[source]
---
-$ ./syncopeadm.sh user --read {USER-ID} {USER-ID} [...]
---
-
-[source]
---
-
-You are running: user --read 1
-
- > USER ID: 1
- username: rossini
- realm: /even
- status: active
- RESOURCES:
- - resource-testdb2
- - ws-target-resource-2
- ROLES:
- - Other
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- type: [G]
- fullname: [Gioacchino Rossini]
- firstname: [Gioacchino]
- surname: [Rossini]
- userId: [rossini@apache.org]
- loginDate: [2009-05-26, 2010-05-26]
- DERIVED ATTRIBUTES:
- info: [rossini - 2010-10-20[0]] - is readonly.
- noschema: [Rossini, ] - is readonly.
- cn: [Rossini, Gioacchino] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
-
---
-
-===== Read by username option
+--read-by-usernam::
The option to read user information by their username.
-
-[source]
---
-$ ./syncopeadm.sh user --read {USERNAME} {USERNAME} [...]
---
-
-[source]
---
-
-You are running: user --read rossini
-
- > USER ID: 1
- username: rossini
- realm: /even
- status: active
- RESOURCES:
- - resource-testdb2
- - ws-target-resource-2
- ROLES:
- - Other
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- type: [G]
- fullname: [Gioacchino Rossini]
- firstname: [Gioacchino]
- surname: [Rossini]
- userId: [rossini@apache.org]
- loginDate: [2009-05-26, 2010-05-26]
- DERIVED ATTRIBUTES:
- info: [rossini - 2010-10-20[0]] - is readonly.
- noschema: [Rossini, ] - is readonly.
- cn: [Rossini, Gioacchino] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
-
---
-
-===== Search by attribute option
+--search-by-attribute::
The option to search a list of users with a common attribute.
-
-[source]
---
-$ ./syncopeadm.sh user --search-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE}
---
-
-For instance if you want to search the active users under the root realm:
-
-[source]
---
-
-You are running: user --search-by-attribute / status=active
-
- > USER ID: 2
- username: verdi
- realm: /
- status: active
- RESOURCES:
- - ws-target-resource-list-mappings-1
- - ws-target-resource-list-mappings-2
- ROLES:
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- fullname: [Giuseppe Verdi]
- firstname: [Giuseppe]
- surname: [Verdi]
- userId: [verdi@apache.org]
- email: [verdi@syncope.org]
- DERIVED ATTRIBUTES:
- info: [verdi - 2010-10-20T11:00:00+0200[0]] - is readonly.
- noschema: [Verdi, ] - is readonly.
- cn: [Verdi, Giuseppe] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
-
- > USER ID: 3
- username: vivaldi
- realm: /
- status: active
- RESOURCES:
- - ws-target-resource-delete
- - ws-target-resource-1
- - ws-target-resource-2
-[...]
---
-
-===== Search by role option
+--search-by-role::
The option to search a list of users with a specified role.
-
-[source]
---
-$ ./syncopeadm.sh user --search-by-role {REALM} {ROLE-NAME}
---
-
-[source]
---
-
-You are running: user --search-by-role / Other
-
- > USER ID: 1
- username: rossini
- realm: /even
- status: active
- RESOURCES:
- - resource-testdb2
- - ws-target-resource-2
- ROLES:
- - Other
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- type: [G]
- fullname: [Gioacchino Rossini]
- firstname: [Gioacchino]
- surname: [Rossini]
- userId: [rossini@apache.org]
- loginDate: [2009-05-26, 2010-05-26]
- DERIVED ATTRIBUTES:
- info: [rossini - 2010-10-20[0]] - is readonly.
- noschema: [Rossini, ] - is readonly.
- cn: [Rossini, Gioacchino] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
-
---
-
-===== Search by resource option
+--search-by-resource::
The option to search a list of users with a specified resource.
-
-[source]
---
-$ ./syncopeadm.sh user --search-by-resource {REALM} {RESOURCE-NAME}
---
-
-[source]
---
-
-You are running: user --search-by-resource / ws-target-resource-2
-
- > USER ID: 3
- username: vivaldi
- realm: /
- status: active
- RESOURCES:
- - ws-target-resource-delete
- - ws-target-resource-1
- - ws-target-resource-2
- ROLES:
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- firstname: [Antonio]
- surname: [Vivaldi]
- fullname: [Antonio Vivaldi]
- userId: [vivaldi@apache.org]
- email: [vivaldi@syncope.org]
- type: [F]
- DERIVED ATTRIBUTES:
- cn: [Vivaldi, Antonio] - is readonly.
- noschema: [Vivaldi, ] - is readonly.
- info: [vivaldi - 2010-10-20T11:00:00+0200[0]] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
-
- > USER ID: 1
- username: rossini
- realm: /even
- status: active
- RESOURCES:
- - resource-testdb2
- - ws-target-resource-2
- ROLES:
- - Other
- creation date: Wed Oct 20 11:00:00 CEST 2010
- change password date: null
- PLAIN ATTRIBUTES:
- type: [G]
- fullname: [Gioacchino Rossini]
- firstname: [Gioacchino]
- surname: [Rossini]
- userId: [rossini@apache.org]
- loginDate: [2009-05-26, 2010-05-26]
- DERIVED ATTRIBUTES:
- info: [rossini - 2010-10-20[0]] - is readonly.
- noschema: [Rossini, ] - is readonly.
- cn: [Rossini, Gioacchino] - is readonly.
- VIRTUAL ATTRIBUTES:
- creator: admin
- last modifier: admin
- token: null
- token expiration time: null
- last change: Wed Oct 20 11:00:00 CEST 2010
- last login: null
- failed logins: 0
-RELATIONSHIPS:
- security question id: null
- security question answer id: null
-
---
-
-===== Delete option
+--delete
The option to delete a specified user.
-
-[source]
---
-$ ./syncopeadm.sh user --delete {{USER-ID} {USER-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified user.
-[source]
---
- - User {USER-ID} successfully deleted
---
-
-===== Delete by attribute option
+--delete-by-attribute
The option to delete the users with a common attribute.
-
-[source]
---
-$ ./syncopeadm.sh user --delete-by-attribute {REALM} {ATTR-NAME}={ATTR-VALUE}
---
-
-[source]
---
- You are running: user --delete-by-attribute / surname=Rossini
-
- - Deleted users: 1
---
-
-===== Delete all option
-The option to delete all users of the realm passed as input.
-
-[source]
---
-$ ./syncopeadm.sh user --delete-all {REALM}
---
-
-The delete option, as can be imagined, tries to remove every user under the specified realm.
-
-[NOTE]
-To run this operation the system asks you again for the admin credential.
-
-[source]
---
-You are running: user --delete-all /
-
-Running this operation you will delete all the realm users managed by Syncope, are you sure? [yes/no]
-yes
-
-Username:
-admin
-
-Password:
-password
-Deleting process started
-
- - Deleted users: 2
-
-#########################
-# #
-# USERS NOT DELETED #
-# #
-#########################
-# # #
-# USER ID # CAUSE #
-# # #
-#########################
-# # #
-# 5 # FAILURE #
-# # #
-#########################
-
---
-
-The output is composed of two parts. The first one is the number of deleted users; the second one is a table with the users (user id) who aren't removed.
-
-To know the reason why the deletion failed you need to run the command with the standard delete option.
-
-[source]
---
-You are running: user --delete 5
-
- - Error: GroupOwnership [6 director]
---
+--delete-all
+The option to delete all users of the realm passed as input.
\ No newline at end of file
[2/2] syncope git commit: refactoring of CLI documentation,
SYNCOPE-700
Posted by ma...@apache.org.
refactoring of CLI documentation, SYNCOPE-700
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/dbc90927
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/dbc90927
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/dbc90927
Branch: refs/heads/master
Commit: dbc9092789af151ca284e1b634e07b5c3d0ef5f6
Parents: 546ea0b
Author: Massimiliano Perrone <ma...@tirasa.net>
Authored: Wed Dec 16 17:50:12 2015 +0100
Committer: Massimiliano Perrone <ma...@tirasa.net>
Committed: Wed Dec 16 17:50:12 2015 +0100
----------------------------------------------------------------------
.../asciidoc/introduction/introduction.adoc | 2 -
src/main/asciidoc/introduction/opensource.adoc | 69 ---
.../cli/configuration.adoc | 133 +----
.../workingwithapachesyncope/cli/connector.adoc | 222 +-------
.../workingwithapachesyncope/cli/domain.adoc | 61 +--
.../cli/entitlement.adoc | 103 +---
.../workingwithapachesyncope/cli/group.adoc | 168 +-----
.../workingwithapachesyncope/cli/logger.adoc | 209 +-------
.../cli/notification.adoc | 85 +---
.../workingwithapachesyncope/cli/policy.adoc | 132 +----
.../workingwithapachesyncope/cli/question.adoc | 46 +-
.../workingwithapachesyncope/cli/realm.adoc | 83 +--
.../workingwithapachesyncope/cli/report.adoc | 208 +-------
.../workingwithapachesyncope/cli/resource.adoc | 174 +------
.../workingwithapachesyncope/cli/role.adoc | 114 +----
.../workingwithapachesyncope/cli/schema.adoc | 265 +---------
.../workingwithapachesyncope/cli/task.adoc | 280 +---------
.../workingwithapachesyncope/cli/user.adoc | 506 +------------------
18 files changed, 142 insertions(+), 2718 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/introduction/introduction.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/introduction/introduction.adoc b/src/main/asciidoc/introduction/introduction.adoc
index 2f7113c..41b7b4f 100644
--- a/src/main/asciidoc/introduction/introduction.adoc
+++ b/src/main/asciidoc/introduction/introduction.adoc
@@ -21,8 +21,6 @@
*Apache Syncope* is an Open Source system for managing digital identities in enterprise environments, implemented in
Java EE technology and released under the Apache 2.0 license.
-include::opensource.adoc[]
-
include::digitalidentity.adoc[]
include::history.adoc[]
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/introduction/opensource.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/introduction/opensource.adoc b/src/main/asciidoc/introduction/opensource.adoc
deleted file mode 100644
index b6e1662..0000000
--- a/src/main/asciidoc/introduction/opensource.adoc
+++ /dev/null
@@ -1,69 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-=== *Open Source*: what does it mean?
-Apache Syncope is one of several identity manager software defined Open Source; but how and why a software
-should be defined Open Source? And, in reality, now that Open Source is quite a brand, what really does it mean?
-
-To answer to this question maybe it's better to refer to the words of the https://opensource.org[Open Source Initiave]
-about _the open source definition_:
-
-Open source doesn't just mean access to the source code. The distribution terms of open-source software must
-comply with the following criteria:
-
-*1. Free Redistribution*::
-The license shall not restrict any party from selling or giving away the software as a component of an aggregate
-software distribution containing programs from several different sources. The license shall not require a royalty
-or other fee for such sale.
-*2. Source Code*::
-The program must include source code, and must allow distribution in source code as well as compiled form. Where
-some form of a product is not distributed with source code, there must be a well-publicized means of obtaining the
-source code for no more than a reasonable reproduction cost preferably, downloading via the Internet without charge.
-The source code must be the preferred form in which a programmer would modify the program. Deliberately obfuscated
-source code is not allowed. Intermediate forms such as the output of a preprocessor or translator are not allowed.
-*3. Derived Works*::
-The license must allow modifications and derived works, and must allow them to be distributed under the
-same terms as the license of the original software.
-*4. Integrity of The Author's Source Code*::
-The license may restrict source-code from being distributed in modified form only if the license allows the
-distribution of "patch files" with the source code for the purpose of modifying the program at build time.
-The license must explicitly permit distribution of software built from modified source code. The license may require
-derived works to carry a different name or version number from the original software.
-*5. No Discrimination Against Persons or Groups*::
-The license must not discriminate against any person or group of persons.
-*6. No Discrimination Against Fields of Endeavor*::
-The license must not restrict anyone from making use of the program in a specific field of endeavor.
-For example, it may not restrict the program from being used in a business, or from being used for genetic research.
-*7. Distribution of License*::
-The rights attached to the program must apply to all to whom the program is redistributed without the need for
-execution of an additional license by those parties.
-*8. License Must Not Be Specific to a Product*::
-The rights attached to the program must not depend on the program's being part of a particular software distribution.
-If the program is extracted from that distribution and used or distributed within the terms of the program's license,
-all parties to whom the program is redistributed should have the same rights as those that are granted in conjunction
-with the original software distribution.
-*9. License Must Not Restrict Other Software*::
-The license must not place restrictions on other software that is distributed along with the licensed software.
-For example, the license must not insist that all other programs distributed on the same medium must be open-source
-software.
-*10. License Must Be Technology-Neutral*::
-No provision of the license may be predicated on any individual technology or style of interface.
-
-This introduction about the Open Source because, as mentioned before, there are many software defined Open Source but
-more than anyone doesn't compy with the list before. On the contrary Apache Syncope is a real Open Source software
-because it is compliant with Open Source criteria.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc
index 2ad6490..31030e5 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/configuration.adoc
@@ -38,134 +38,15 @@ Usage: configuration [options]
----
-===== Get option
-This get option shows a table with the Syncope configuration.
-
-[source]
---
-$ ./syncopeadm.sh configuration --get
---
-
-[source]
---
-
-You are running: configuration --get
+===== Options
-########################################################
-# #
-# SYNCOPE CONFIGURATION #
-# #
-########################################################
-# # #
-# ATTRIBUTE # VALUE #
-# # #
-########################################################
-# # #
-# password.cipher.algorithm # SHA1 #
-# notificationjob.cronExpression # 0/20 * * * * ? #
-# notification.maxRetries # 3 #
-# token.length # 256 #
-# token.expireTime # 60 #
-# selfRegistration.allowed # true #
-# passwordReset.allowed # true #
-# passwordReset.securityQuestion # true #
-# authentication.statuses # created, active #
-# log.lastlogindate # true #
-# tasks.interruptMaxRetries # 20 #
-# return.password.value # false #
-# # #
-########################################################
-
---
-
-===== Read option
+--get::
+This get option shows a table with the Syncope configuration.
+--read::
The option to read the value of specified configuration attributes.
-
-[source]
---
-$ ./syncopeadm.sh configuration --read {CONF-NAME} {CONF-NAME} [...]
---
-
-[source]
---
-
-You are running: configuration --read passwordReset.allowed
-
-#####################################
-# #
-# SYNCOPE CONFIGURATION #
-# #
-#####################################
-# # #
-# ATTRIBUTE # VALUE #
-# # #
-#####################################
-# # #
-# passwordReset.allowed # true #
-# # #
-#####################################
-
---
-
-===== Update option
+--update::
The option to update a value of specified configuration attributes.
-
-[source]
---
-$ ./syncopeadm.sh configuration --update {CONF-NAME}={CONF-VALUE} {CONF-NAME}={CONF-VALUE} [...]
---
-
-[source]
---
-
-You are running: configuration --update passwordReset.allowed=false
-
-#####################################
-# #
-# UPDATED CONFIGURATION ATTRIBUTES #
-# #
-#####################################
-# # #
-# ATTRIBUTE # VALUE #
-# # #
-#####################################
-# # #
-# passwordReset.allowed # false #
-# # #
-#####################################
-
---
-
-===== Delete option
+--delete::
The option to delete specified configuration attributes.
-
-[source]
---
-$ ./syncopeadm.sh configuration --delete {CONF-NAME} {CONF-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove the specified configurations. The output will be something like:
-[source]
---
- - Configuration {CONF-NAME} successfully deleted
---
-
-===== Export option
+--export::
The option to export the Syncope configuration to a specified directory.
-
-[source]
---
-$ ./syncopeadm.sh - Usage: configuration --export {WHERE-DIR}
---
-
-[source,xml]
-----
-<?xml version="1.0" encoding="UTF-8" standalone="no"?><dataset>
-<RELATIONSHIPTYPE DESCRIPTION="Models the act that an object is included in another" NAME="inclusion"/>
-<RELATIONSHIPTYPE NAME="neighborhood"/>
-<PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="a password policy" HISTORYLENGTH="1" ID="2" TYPE="PASSWORD"/>
-<PASSWORDPOLICY ALLOWNULLPASSWORD="1" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="4" TYPE="PASSWORD"/>
-<PASSWORDPOLICY ALLOWNULLPASSWORD="0" DESCRIPTION="sample password policy" HISTORYLENGTH="0" ID="8" TYPE="PASSWORD"/>
-
-[...]
-----
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc
index 51b622d..4cd8973 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/connector.adoc
@@ -37,223 +37,17 @@ Usage: connector [options]
Syntax: --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]
----
-===== Details option
-This option shows a table with some details about connectors and bundles.
-
-[source]
---
-$ ./syncopeadm.sh connector --details
---
-
-[source]
---
-
-You are running: connector --details
-
-######################################
-# #
-# CONNECTORS DETAILS #
-# #
-######################################
-# # #
-# DETAIL # VALUE #
-# # #
-######################################
-# # #
-# Total number # 9 #
-# With create capability # 8 #
-# With delete capability # 7 #
-# With search capability # 8 #
-# With sync capability # 4 #
-# With update capability # 8 #
-# Bundles number # 8 #
-# # #
-######################################
+===== Options
---
-
-Total number::
- number of created connectors;
-With create capability::
- number of connectors configured with create capability;
-With delete capability::
- number of connectors configured with delete capability;
-With search capability::
- number of connectors configured with search capability;
-With sync capability::
- number of connectors configured with sync capability;
-With update capability::
- number of connectors configured with update capability;
-Bundles number::
- number of bundles read by Syncope.
-
-===== List option
+--details::
+This option shows a table with some details about connectors and bundles.
+--list::
Running the command with this option you will see the list of connectors with their configuration.
-
-[source]
---
-$ ./syncopeadm.sh connector --list
---
-
-[source]
---
-
-You are running: connector --list
-
- > CONNECTOR ID: 108
- bundle name: net.tirasa.connid.bundles.db.scriptedsql
- connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector
- display name: Scripted SQL
- location: connid://testconnectorserver@localhost:4554
- version: 2.2.3-SNAPSHOT
- timeout: 10
- CAPABILITIES:
- - CREATE
- - SEARCH
- - DELETE
- - UPDATE
- - SYNC
- CONFIGURATION:
- name: enableEmptyString
- values: [false]
- type: boolean
- display name: Enable writing empty string
- help message: <b>Enable writing empty string</b><br/>Select to enable support for writing an empty strings, instead of a NULL value, in character based columns defined as not-null in the table schema. This option does not influence the way strings are written for Oracle based tables. By default empty strings are written as a NULL value.
- order: 12
- default values: [false]
- confidential: false
- required: false
- overridable: false
-
- name: autoCommit
- values: [true]
- type: boolean
- display name: autoCommit
- help message: autoCommit
- order: 0
- default values: [true]
- confidential: false
- required: false
- overridable: false
-
- name: testScriptFileName
- values: [/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/test-classes/scriptedsql/TestScript.groovy]
- type: java.lang.String
- display name: testScriptFileName
- help message: testScriptFileName
- order: 0
- default values: []
- confidential: false
- required: false
- overridable: true
-
---
-
-The last code snippet shows a part of the screen output. Basically you can read the configuration about every connector
-configured in Syncope.
-
-===== List bundles option
+--list-bundles::
Running the command with this option you will see the list of the bundles available in Syncope.
-
-[source]
---
-$ ./syncopeadm.sh connector --list-bundles
---
-
-[source]
---
-
-You are running: connector --list-bundles
-
- > BUNDLE NAME: net.tirasa.connid.bundles.soap
- connector name: net.tirasa.connid.bundles.soap.WebServiceConnector
- display name: net.tirasa.connid.bundles.soap.WebServiceConnector
- location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
- version: 1.4.0-SNAPSHOT
- > BUNDLE NAME: net.tirasa.connid.bundles.db.scriptedsql
- connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector
- display name: Scripted SQL Connector
- location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
- version: 2.2.3-SNAPSHOT
- > BUNDLE NAME: net.tirasa.connid.bundles.ldap
- connector name: net.tirasa.connid.bundles.ldap.LdapConnector
- display name: net.tirasa.connid.bundles.ldap.LdapConnector
- location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
- version: 1.5.0-SNAPSHOT
- > BUNDLE NAME: net.tirasa.connid.bundles.ad
- connector name: net.tirasa.connid.bundles.ad.ADConnector
- display name: net.tirasa.connid.bundles.ad.ADConnector
- location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
- version: 1.3.0-SNAPSHOT
- > BUNDLE NAME: net.tirasa.connid.bundles.db.table
- connector name: net.tirasa.connid.bundles.db.table.DatabaseTableConnector
- display name: Database Table Connector
- location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
- version: 2.2.3-SNAPSHOT
- > BUNDLE NAME: net.tirasa.connid.bundles.csvdir
- connector name: net.tirasa.connid.bundles.csvdir.CSVDirConnector
- display name: net.tirasa.connid.bundles.csvdir.CSVDirConnector
- location: file:/home/massi/Lavoro/syncopeMaster/fit/core-reference/target/bundles/
- version: 0.8.2
- > BUNDLE NAME: net.tirasa.connid.bundles.db.table
- connector name: net.tirasa.connid.bundles.db.table.DatabaseTableConnector
- display name: Database Table Connector
- location: connid://testconnectorserver@localhost:4554
- version: 2.2.3-SNAPSHOT
- > BUNDLE NAME: net.tirasa.connid.bundles.db.scriptedsql
- connector name: net.tirasa.connid.bundles.db.scriptedsql.ScriptedSQLConnector
- display name: Scripted SQL Connector
- location: connid://testconnectorserver@localhost:4554
- version: 2.2.3-SNAPSHOT
-
---
-
-The most useful information is:
-
-location::
- where the bundle is, it could be on the same server where Syncope is deployed or on a remote one linked by
-connid protocol;
-version::
- the bundle version;
-
-===== List configuration properties option
+--list-configuration-properties::
This option lists the configuration of specified connectors.
-
-[source]
---
-$ ./syncopeadm.sh connector --list-configuration-properties {CONNECTOR-ID} {CONNECTOR-ID} [...]
---
-
-The output is the configuration of the connectors passed as input.
-
-===== Read option
+--read::
The option to read all the information of specified connectors.
-
-[source]
---
-$ ./syncopeadm.sh connector --read {CONNECTOR-ID} {CONNECTOR-ID} [...]
---
-
-Unlike the list option, the read one shows only the connectors passed as input.
-
-===== Delete option
+--delete::
The option to delete a specified connector.
-
-[source]
---
-$ ./syncopeadm.sh connector --delete {CONNECTOR-ID} {CONNECTOR-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified connector. This operation works only if the
-connector isn't associated with a resource.
-If the connector isn't associated to anything the output will be
-[source]
---
- - Connector {CONNECTOR-ID} successfully deleted
---
-
-otherwise the output will be something like:
-[source]
---
- - Error: AssociatedResources [ws-target-resource-nopropagation, ws-target-resource-nopropagation2]
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc
index 8d4db83..0e37976 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/domain.adoc
@@ -32,64 +32,13 @@ Usage: domain [options]
Syntax: --delete {DOMAIN-NAME} {DOMAIN-NAME} [...]
----
-===== Details option
-This option shows a table with domain amount.
-
-[source]
---
-$ ./syncopeadm.sh domain --details
---
-
-[source]
---
-
-You are running: domain --details
+===== Options
-############################
-# #
-# DOMAINS DETAILS #
-# #
-############################
-# # #
-# DETAIL # VALUE #
-# # #
-############################
-# # #
-# Total number # 1 #
-# # #
-############################
-
---
+--details::
+This option shows a table with domain amount.
-===== List option
+--list::
Running the command with this option you will see the list of the domains.
-[source]
---
-$ ./syncopeadm.sh domain --list
---
-
-[source]
---
-
-You are running: domain --list
-
- > DOIMAIN NAME: Two
- chiper algorithm: SHA
-
---
-
-===== Delete option
+--delete::
The option to delete a specified domain.
-
-[source]
---
-$ ./syncopeadm.sh domain --delete {DOMAIN-NAME} {DOMAIN-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified domain.
-The output will be something like:
-[source]
---
- - Domain {DOMAIN-NAME} successfully deleted
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc
index e9a615a..b87ce6d 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/entitlement.adoc
@@ -37,104 +37,15 @@ Usage: entitlement [options]
Syntax: --search-by-role {ROLE-ID}
----
-===== List option
-Running the command with this option you will see the list of the entitlements.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --list
---
-
-[source]
---
-
-You are running: entitlement --list
+===== Options
-- CONNECTOR_READ
-- NOTIFICATION_DELETE
-- ANYTYPE_UPDATE
-- RELATIONSHIPTYPE_UPDATE
-- SCHEMA_CREATE
-[...]
-
---
-
-===== List role option
+--list::
+Running the command with this option you will see the list of the entitlements.
+--list-role::
Running the command with this option you will see the list of the roles with a certain entitlement.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --list
---
-
-[source]
---
-
-You are running: entitlement --list-role PRINTER_DELETE
-
- > ROLE ID: Search for realm evenTwo
- REALMS:
- - /even/two
-
- > ROLE ID: User manager
- REALMS:
- - /
-
- > ROLE ID: User reviewer
- REALMS:
- - /odd
- - /even
-
- > ROLE ID: Other
- REALMS:
- - /odd
-
---
-
-===== Read by username option
+--read-by-username::
The option to read the entitlements of the username passed as input.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --read-by-username {USERNAME}
---
-[source]
---
-You are running: entitlement --read-by-username rossini
-
-- GROUP_READ
-- SCHEMA_READ
-- WORKFLOW_FORM_CLAIM
---
-
-===== Read by userid option
+--read-by-userid::
The option to read the entitlements of the userid passed as input.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --read-by-userid {USER-ID}
---
-[source]
---
-You are running: entitlement --read-by-userid 5
-
-- USER_READ
-- USER_SEARCH
---
-
-===== Search by role option
+--search-by-role::
The option to read the entitlements of a certain role.
-
-[source]
---
-$ ./syncopeadm.sh entitlement --search-by-role {ROLE-ID}
---
-
-[source]
---
-You are running: entitlement --search-by-role Other
-
-- SCHEMA_READ
-- GROUP_READ
-- WORKFLOW_FORM_CLAIM
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc
index f71ccb4..e686cf9 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/group.adoc
@@ -38,169 +38,17 @@ Usage: group [options]
Syntax: --delete {GROUP-ID} {GROUP-ID} [...]
----
-===== Details option
-This option shows a table with the amount of available groups and some additional information.
-
-[source]
---
-$ ./syncopeadm.sh group --details
---
-
-[source]
---
-
-You are running: group --details
-
-##################################
-# #
-# GROUPS DETAILS #
-# #
-##################################
-# # #
-# DETAIL # VALUE #
-# # #
-##################################
-# # #
-# Total number # 16 #
-# Without resources # 10 #
-# Without attributes # 0 #
-# On root realm # 14 #
-# On the other realm # 2 #
-# # #
-##################################
-
---
+===== Options
-===== List option
+--details::
+This option shows a table with the amount of available groups and some additional information.
+--list::
Running the command with this option you will see the list of the groups.
-
-[source]
---
-$ ./syncopeadm.sh group --list
---
-
-[source]
---
-
-You are running: group --list
-
- > GROUP ID: 1
- name: root
- type: GROUP
- realm: /
- status: null
- user owner: null
- group owner: null
- RESOURCES:
- PLAIN ATTRIBUTES:
- - icon: [niceIcon]
-
- - show: [true]
-
- - rderived_sx: [sx]
-
- - rderived_dx: [dx]
-
- DERIVED ATTRIBUTES:
- - displayProperty: [niceIcon: true] - is readonly
-
- - rderiveddata: [sx-dx] - is readonly
-
- - rderivedschema: [sx-dx] - is readonly
-
- - rderToBePropagated: [sx-dx] - is readonly
-
- VIRTUAL ATTRIBUTES:
- [...]
-
---
-
-===== Read option
+--read::
The option to read the group passed as input.
-
-[source]
---
-$ ./syncopeadm.sh group --read {GROUP-ID} {GROUP-ID} [...]
---
-
-[source]
---
-
-You are running: group --read 15
-
- > GROUP ID: 15
- name: additional
- type: GROUP
- realm: /even
- status: null
- user owner: null
- group owner: null
- RESOURCES:
- PLAIN ATTRIBUTES:
- DERIVED ATTRIBUTES:
- - displayProperty: [: ] - is readonly
-
- - rderToBePropagated: [-] - is readonly
-
- - rderiveddata: [-] - is readonly
-
- - rderivedschema: [-] - is readonly
-
- VIRTUAL ATTRIBUTES:
-
---
-
-===== Read attribute of type option
+--read-attr-by-schema-type::
The option to read the specified attribute type of the group passed as input.
-
-[source]
---
-$ ./syncopeadm.sh group --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
- Schema type: PLAIN / DERIVED / VIRTUAL
---
-
-[source]
---
-
-You are running: group --read-attr-by-schema-type 15 DERIVED
- - displayProperty: [: ] - is readonly
-
- - rderToBePropagated: [-] - is readonly
-
- - rderiveddata: [-] - is readonly
-
- - rderivedschema: [-] - is readonly
-
---
-
-===== Read an attribute of type option
+--read-attr-by-schema::
The option to read the specified attribute name of the group passed as input.
-
-[source]
---
-$ ./syncopeadm.sh group --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
- Schema type: PLAIN / DERIVED / VIRTUAL
---
-
-[source]
---
-
-You are running: group --read-attr-by-schema 12 PLAIN title
- - title: [r12]
-
---
-
-===== Delete option
+--delete::
The option to delete a specified group.
-
-[source]
---
-$ ./syncopeadm.sh group --delete {GROUP-ID} {GROUP-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified group.
-The output will be something like:
-[source]
---
- - Group {GROUP-ID} successfully deleted
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc
index f03064f..edde628 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/logger.adoc
@@ -40,211 +40,20 @@ Usage: logger [options]
Syntax: --delete {LOG-NAME} {LOG-NAME} [...]
----
-===== Details option
-This option shows a table with some details about logger configuration.
-
-[source]
---
-$ ./syncopeadm.sh logger --details
---
-
-[source]
---
-
-You are running: logger --details
-
-############################
-# #
-# LOGGERS DETAILS #
-# #
-############################
-# # #
-# DETAIL # VALUE #
-# # #
-############################
-# # #
-# Total number # 16 #
-# Set to DEBUG # 2 #
-# Set to ERROR # 3 #
-# Set to FATAL # 0 #
-# Set to INFO # 11 #
-# Set to OFF # 0 #
-# Set to TRACE # 0 #
-# Set to WARN # 0 #
-# # #
-############################
+===== Options
---
-
-===== List option
+--details::
+This option shows a table with some details about logger configuration.
+--list::
Running the command with this option you will see the table of the loggers configuration.
-
-[source]
---
-$ ./syncopeadm.sh logger --list
---
-
-[source]
---
-
-You are running: logger --list
-
-############################################################################
-# #
-# LIST LOGGERS #
-# #
-############################################################################
-# # #
-# LOGGER # LEVEL #
-# # #
-############################################################################
-# # #
-# org.springframework.web # INFO #
-# org.apache.syncope.core.logic # INFO #
-# net.tirasa.connid # DEBUG #
-# org.quartz # INFO #
-# org.apache.syncope.core.persistence # INFO #
-# org.activiti # ERROR #
-# org.apache.http # INFO #
-# org.springframework.orm # INFO #
-# org.apache.camel # ERROR #
-# org.apache.cxf # ERROR #
-# org.apache.syncope # INFO #
-# org.identityconnectors # DEBUG #
-# org.springframework # INFO #
-# org.apache.syncope.core.provisioning # INFO #
-# org.apache.syncope.core.rest # INFO #
-# org.apache.syncope.core.provisioning.api.ConnIdBundleManager # INFO #
-# # #
-############################################################################
-
---
-
-===== Read option
+--read::
The option to read all the information of specified loggers.
-
-[source]
---
-$ ./syncopeadm.sh logger --read {LOG-NAME} {LOG-NAME} [...]
---
-
-Unlike the list option, the read option shows a table with only the loggers passed as input.
-
-===== Update option
+--update::
The option to change the value of the logger passed as input.
-
-[source]
---
-$ ./syncopeadm.sh logger --update {LOG-NAME}={LOG-LEVEL} {LOG-NAME}={LOG-LEVEL} [...]
---
-
-[source]
---
-
-You are running: logger --update org.apache.camel=DEBUG
-
-####################################
-# #
-# UPDATED LOGGERS #
-# #
-####################################
-# # #
-# LOGGER # NEW LEVEL #
-# # #
-####################################
-# # #
-# org.apache.camel # DEBUG #
-# # #
-####################################
-
---
-
-===== Update all option
+--update-all::
This option is especially helpful in production environment when every log is disabled and you need to change them for a
while in DEBUG mode.
-
-[source]
---
-$ ./syncopeadm.sh logger --update-all DEBUG
---
-
-[source]
---
-
-You are running: logger --update-all DEBUG
-
-################################################################################
-# #
-# UPDATED LOGGERS #
-# #
-################################################################################
-# # #
-# LOGGER # NEW LEVEL #
-# # #
-################################################################################
-# # #
-# org.springframework.web # DEBUG #
-# org.apache.syncope.core.logic # DEBUG #
-# net.tirasa.connid # DEBUG #
-# org.quartz # DEBUG #
-# org.apache.syncope.core.persistence # DEBUG #
-# org.activiti # DEBUG #
-# org.apache.http # DEBUG #
-# org.springframework.orm # DEBUG #
-# org.apache.cxf # DEBUG #
-# org.apache.syncope # DEBUG #
-# org.identityconnectors # DEBUG #
-# org.springframework # DEBUG #
-# org.apache.syncope.core.provisioning # DEBUG #
-# org.apache.syncope.core.rest # DEBUG #
-# org.apache.syncope.core.provisioning.api.ConnIdBundleManager # DEBUG #
-# # #
-################################################################################
-
---
-
-===== Create option
+--create::
For the moment the logger command is one of the few command with a create option to add a new logger configuration.
-
-[source]
---
-$ ./syncopeadm.sh logger --create net.tirasa=ERROR
---
-
-[source]
---
-
-You are running: logger --create net.tirasa=ERROR
-
-##############################
-# #
-# UPDATED LOGGERS #
-# #
-##############################
-# # #
-# LOGGER # NEW LEVEL #
-# # #
-##############################
-# # #
-# net.tirasa # ERROR #
-# # #
-##############################
-
---
-
-===== Delete option
+--delete::
The option to delete a specified logger.
-
-[source]
---
-$ ./syncopeadm.sh logger --delete {LOG-NAME} {LOG-NAME} [...]
---
-
-[source]
---
-
-You are running: logger --delete org.apache.camel
-
- - Logger org.apache.camel successfully deleted
-
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc
index 98ebe7d..da9e4a9 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/notification.adoc
@@ -33,84 +33,11 @@ Usage: notification [options]
Syntax: --delete {NOTIFICATION-ID}
----
-===== List option
-Running the command with this option you will see the list of notificaitons with their configuration.
-
-[source]
---
-$ ./syncopeadm.sh notification --list
---
-
-[source]
---
-
-You are running: notification --list
-
- > NOTIFICATION ID: 1
- events: [[CUSTOM]:[]:[]:[requestPasswordReset]:[SUCCESS]]
- sender: admin@syncope.apache.org
- subject: Password Reset request
- recipients: null
- recipient attribute name: email
- template: requestPasswordReset
- abouts: {USER=token!=$null}
- recipient attribute types: UserPlainSchema
- static recipient: []
- trace level: FAILURES
- active: true
- self as recipient: true
-
- > NOTIFICATION ID: 2
- events: [[CUSTOM]:[]:[]:[confirmPasswordReset]:[SUCCESS]]
- sender: admin@syncope.apache.org
- subject: Password Reset successful
- recipients: null
- recipient attribute name: email
- template: confirmPasswordReset
- abouts: {}
- recipient attribute types: UserPlainSchema
- static recipient: []
- trace level: FAILURES
- active: true
- self as recipient: true
-
- > NOTIFICATION ID: 10
- events: [[CUSTOM]:[]:[]:[unexisting1]:[FAILURE], [CUSTOM]:[]:[]:[unexisting2]:[SUCCESS]]
- sender: test@syncope.apache.org
- subject: Test subject
- recipients: $groups==7
- recipient attribute name: email
- template: test
- abouts: {USER=fullname==*o*;fullname==*i*}
- recipient attribute types: UserPlainSchema
- static recipient: []
- trace level: FAILURES
- active: true
- self as recipient: false
+===== Options
---
-
-===== Read option
+--list::
+Running the command with this option you will see the list of notificaitons with their configuration.
+--read::
The option to read all the information of the specified notifications.
-
-[source]
---
-$ ./syncopeadm.sh notification --read {NOTIFICATION-ID} {NOTIFICATION-ID} [...]
---
-
-Unlike the list option, the read one shows only the notifications passed as input.
-
-===== Delete option
-The option to delete a specified notification.
-
-[source]
---
-$ ./syncopeadm.sh notification --delete {NOTIFICATION-ID} {NOTIFICATION-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified notification.
-The output will be something like:
-[source]
---
- - security notification {NOTIFICATION-ID} successfully deleted
---
+--delete::
+The option to delete a specified notification.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc
index 554c195..5de2e24 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/policy.adoc
@@ -36,131 +36,13 @@ Usage: policy [options]
Syntax: --delete {POLICY-ID} {POLICY-ID} [...]
----
-===== Details option
-This option shows a table with the amount of policies for each type.
-
-[source]
---
-$ ./syncopeadm.sh policy --details
---
-
-[source]
---
-
-You are running: policy --details
-
-#################################
-# #
-# POLICIES DETAILS #
-# #
-#################################
-# # #
-# DETAIL # VALUE #
-# # #
-#################################
-# # #
-# total number # 9 #
-# account policies # 2 #
-# password policies # 3 #
-# sync policies # 4 #
-# push policies # 0 #
-# # #
-#################################
-
---
+===== Options
-===== List option
+--details::
+This option shows a table with the amount of policies for each type.
+--list::
Running the command with this option you will see the list of the policies.
-
-[source]
---
-$ ./syncopeadm.sh Usage: policy --list {POLICY-TYPE}
- Policy type: ACCOUNT / PASSWORD / SYNC / PUSH
---
-
-[source]
---
-
-You are running: policy --list SYNC
-
- > KEY: 1
- type: SYNC
- description: a sync policy
- resources : []
- realms : []
-
- > KEY: 3
- type: SYNC
- description: sync policy 2
- resources : [resource-csv]
- realms : []
- conflict resolution action: ALL
- correlation rule : {USER=["username","firstname"]}
-
- > KEY: 7
- type: SYNC
- description: sync policy 1
- resources : []
- realms : []
- conflict resolution action: IGNORE
- correlation rule : {}
-
- > KEY: 9
- type: SYNC
- description: sync policy for java rule
- resources : [ws-target-resource-2]
- realms : []
- conflict resolution action: IGNORE
- correlation rule : {}
-
---
-
-===== Read option
+--read::
The option to read all the information of a specified policy.
-
-[source]
---
-$ ./syncopeadm.sh policy --read {POLICY-ID} {POLICY-ID} [...]
---
-
-Unlike the list option, the read option shows only the policy passed as input.
-[source]
---
-You are running: policy --read 6
-
- > KEY: 6
- type: ACCOUNT
- description: sample account policy
- resources : []
- realms : [/odd]
- max authentication attempts : 3
- propagation suspension : false
- RULES :
- > class : [org.apache.syncope.common.lib.policy.DefaultAccountRuleConf@708a538f[
- maxLength=0
- minLength=4
- pattern=<null>
- allUpperCase=false
- allLowerCase=false
- wordsNotPermitted=[]
- schemasNotPermitted=[]
- prefixesNotPermitted=[notpermitted1, notpermitted2]
- suffixesNotPermitted=[]
- name=org.apache.syncope.common.lib.policy.DefaultAccountRuleConf
-]]
---
-
-===== Delete option
-The option to delete a specified policy.
-
-[source]
---
-$ ./syncopeadm.sh policy --delete {POLICY-ID} {POLICY-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified policy.
-The output will be something like:
-[source]
---
- - Policy {POLICY-ID} successfully deleted
---
+--delete::
+The option to delete a specified policy.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc
index ff04845..4a1a261 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/question.adoc
@@ -33,45 +33,11 @@ Usage: question [options]
Syntax: --delete {QUESTION-ID} {QUESTION-ID} [...]
----
-===== List option
-Running the command with this option you will see the list of questions with their content.
-
-[source]
---
-$ ./syncopeadm.sh question --list
---
-
-[source]
---
-
-You are running: question --list
-
- > SECURITY QUESTION ID: 1
- content: What's your mother's maiden name?
-
---
+===== Options
-===== Read option
+--list::
+Running the command with this option you will see the list of questions with their content.
+--read::
The option to read all the information of specified questions.
-
-[source]
---
-$ ./syncopeadm.sh question --read {QUESTION-ID} {QUESTION-ID} [...]
---
-
-Unlike the list option, the read option shows only the questions passed as input.
-
-===== Delete option
-The option to delete a specified question.
-
-[source]
---
-$ ./syncopeadm.sh question --delete {QUESTION-ID} {QUESTION-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified question.
-The output will be something like:
-[source]
---
- - security question {QUESTION-ID} successfully deleted
---
+--delete::
+The option to delete a specified question.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc
index 82ad44b..d091865 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/realm.adoc
@@ -30,82 +30,9 @@ Usage: realm [options]
--list
----
-===== Details option
-This option shows a table with the amount of the available realms.
-
-[source]
---
-$ ./syncopeadm.sh realm --details
---
-
-[source]
---
-
-You are running: realm --details
-
-############################
-# #
-# REALMS DETAILS #
-# #
-############################
-# # #
-# DETAIL # VALUE #
-# # #
-############################
-# # #
-# Total number # 4 #
-# # #
-############################
-
---
-
-===== List option
-Running the command with this option you will see the list of the realms.
-
-[source]
---
-$ ./syncopeadm.sh realm --list
---
+===== Options
-[source]
---
-
-You are running: realm --list
-
- > REALM ID: 1
- name: /
- full path: /
- actions: []
- templates: {}
- parent id: 0
- account policy id: null
- password policy id: 4
-
- > REALM ID: 2
- name: odd
- full path: /odd
- actions: []
- templates: {}
- parent id: 1
- account policy id: 6
- password policy id: 4
-
- > REALM ID: 3
- name: even
- full path: /even
- actions: []
- templates: {}
- parent id: 1
- account policy id: null
- password policy id: 4
-
- > REALM ID: 4
- name: two
- full path: /even/two
- actions: []
- templates: {}
- parent id: 3
- account policy id: 5
- password policy id: 2
-
---
+--details::
+This option shows a table with the amount of the available realms.
+--list::
+Running the command with this option you will see the list of the realms.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc
index 694ddc2..8f8d472 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/report.adoc
@@ -44,209 +44,23 @@ Usage: report [options]
Format: CSV / HTML / PDF / XML / RTF
----
-===== Details option
-This option shows a table with some details about the reports and their executions.
-
-[source]
---
-$ ./syncopeadm.sh report --details
---
-
-[source]
---
-
-You are running: report --details
-
-##############################
-# #
-# REPORTS DETAILS #
-# #
-##############################
-# # #
-# DETAIL # VALUE #
-# # #
-##############################
-# # #
-# Total numbers # 1 #
-# Never executed # 0 #
-# # #
-##############################
+===== Options
---
-
-===== List all option
+--details::
+This option shows a table with some details about the reports and their executions.
+--list::
Running the command with this option you will see the list of configured reports.
-
-[source]
---
-$ ./syncopeadm.sh report --list
---
-[source]
---
-You are running: report --list
-
- > REPORT ID: 1
- name: test
- cron expression: null
- latest execution status: SUCCESS
- start date: Sun Feb 26 15:40:04 CET 2012
- end date: Sun Feb 26 15:41:04 CET 2012
- CONF:
- name: testUserReportlet
- features: [key, username, workflowId, status, creationDate, lastLoginDate, changePwdDate, passwordHistorySize, failedLoginCount, memberships, resources]
- plain attributes: [fullname, gender]
- derived attributes: [cn]
- virtual attributes: [virtualdata]
- matching condition: null
- EXECUTION:
- REPORT EXEC ID: 1
- status: SUCCESS
- message: null
- start date: Sun Feb 26 15:40:04 CET 2012
- end date: Sun Feb 26 15:41:04 CET 2012
- report id: 1
---
-
-===== List reports execution option
+--list-jobs::
Running the command with this option you will see the list of the report executions.
-
-[source]
---
-$ ./syncopeadm.sh report --list-jobs
---
-
-[source]
---
-
-You are running: report --list-jobs
-
- REPORT EXEC ID: 0
- status: Not Scheduled
- message: null
- start date: null
- end date: null
- report id: 1
-
---
-
-===== Read option
+--read::
The option to read all the information of a specified report.
-
-[source]
---
-$ ./syncopeadm.sh report --read {REPORT-ID} {REPORT-ID} [...]
---
-
-[source]
---
-You are running: report --read 1
-
- > REPORT ID: 1
- name: test
- cron expression: null
- latest execution status: SUCCESS
- start date: Sun Feb 26 15:40:04 CET 2012
- end date: Sun Feb 26 15:41:04 CET 2012
- CONF:
- name: testUserReportlet
- features: [key, username, workflowId, status, creationDate, lastLoginDate, changePwdDate, passwordHistorySize, failedLoginCount, memberships, resources]
- plain attributes: [fullname, gender]
- derived attributes: [cn]
- virtual attributes: [virtualdata]
- matching condition: null
- EXECUTION:
- REPORT EXEC ID: 1
- status: SUCCESS
- message: null
- start date: Sun Feb 26 15:40:04 CET 2012
- end date: Sun Feb 26 15:41:04 CET 2012
- report id: 1
---
-
-===== Read report executions option
+--read-execution::
The option to read all the information of a specified report execution.
-
-[source]
---
-$ ./syncopeadm.sh rreport --read-execution {EXECUTION-ID} {EXECUTION-ID} [...]
---
-
-[source]
---
-You are running: report --read-execution 1
-
- REPORT EXEC ID: 1
- status: SUCCESS
- message: null
- start date: Sun Feb 26 15:40:04 CET 2012
- end date: Sun Feb 26 15:41:04 CET 2012
- report id: 1
---
-
-===== Delete option
+--delete::
The option to delete a specified report.
-
-[source]
---
-$ ./syncopeadm.sh report --delete {REPORT-ID} {REPORT-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified report.
-[source]
---
- - Report {REPORT-ID} successfully deleted
---
-
-===== Delete report executions option
+--delete-execution::
The option to delete a specified report execution.
-
-[source]
---
-$ ./syncopeadm.sh report --delete-execution {EXECUTION-ID} {EXECUTION-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove a specified report execution.
-[source]
---
- - Report execution {EXECUTION-ID} successfully deleted
---
-
-===== Execute option
+--execute::
The option to run a report.
-
-[source]
---
-$ ./syncopeadm.sh report --execute {REPORT-ID}
---
-
-[source]
---
-You are running: report --execute 1
-
- - Report 1executed.
-
-
- - Run --read 1 to see the results.
---
-
-After the execution, if the result is positive, you have to read the report to know the execution
-results.
-
-===== Export execution option
+--export-execution-result::
The option to export an execution in a certain format to see the results.
-
-[NOTE]
-At the moment only the XML format is supported.
-
-[source]
---
-$ ./syncopeadm.sh report --export-execution-result {EXECUTION-ID} {EXECUTION-ID} [...] {FORMAT}
- Format: CSV / HTML / PDF / XML / RTF
---
-
-[source]
---
-You are running: report --export-execution-result 101 XML
-
- - export_101.xml created.
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc
index e0c111c..367c84f 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/resource.adoc
@@ -34,175 +34,13 @@ Usage: resource [options]
Syntax: --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]
----
-===== Details option
-This option shows a table with amount of available resources.
-
-[source]
---
-$ ./syncopeadm.sh resource --details
---
-
-[source]
---
-
-You are running: resource --details
-
-#############################
-# #
-# RESOURCES DETAILS #
-# #
-#############################
-# # #
-# DETAIL # VALUE #
-# # #
-#############################
-# # #
-# Total numbers # 19 #
-# # #
-#############################
-
---
-
-Total number::
- number of resources;
+===== Options
-===== List option
+--details::
+This option shows a table with amount of available resources.
+--list::
Running the command with this option you will see the list of resources.
-
-[source]
---
-$ ./syncopeadm.sh resource --list
---
-
-[source]
---
-
-You are running: resource --list
-
- > RESOURCE ID: ws-target-resource-1
- connector dispaly name: ConnInstance100
- etag value: 1287565200000
- connector id: 100
- account policy id: null
- password policy id: null
- sync policy id: null
- creator: admin
- creation date: Wed Oct 20 11:00:00 CEST 2010
- last modifier: admin
- last change date: Wed Oct 20 11:00:00 CEST 2010
- propagation actions class: []
- propagation priority: 1
- PROVISIONS:
- provision id: 15
- any type: USER
- object class: __ACCOUNT__
- sync token: null
- virtual schema: []
- MAPPING:
- ConnObjectLink: null
- MAPPING ITEM:
- mapping key: 99
- mapping item type: UserKey
- internal attribute name: id
- external attribute name: userId
- mandatory condition: true
- transformers class: []
- purpose: PROPAGATION
- connector object key: true
- password: false
-
- mapping key: 100
- mapping item type: UserPlainSchema
- internal attribute name: email
- external attribute name: email
- mandatory condition: true
- transformers class: []
- purpose: PROPAGATION
- connector object key: false
- password: false
-
- mapping key: 101
- mapping item type: UserPlainSchema
- internal attribute name: surname
- external attribute name: surname
- mandatory condition: true
- transformers class: []
- purpose: PROPAGATION
- connector object key: false
- password: false
-
- mapping key: 102
- mapping item type: Password
- internal attribute name: password
- external attribute name: __PASSWORD__
- mandatory condition: true
- transformers class: []
- purpose: PROPAGATION
- connector object key: false
- password: true
-
- mapping key: 335
- mapping item type: UserPlainSchema
- internal attribute name: surname
- external attribute name: fullname
- mandatory condition: true
- transformers class: []
- purpose: PROPAGATION
- connector object key: false
- password: false
-
- mapping key: 336
- mapping item type: UserPlainSchema
- internal attribute name: type
- external attribute name: type
- mandatory condition: true
- transformers class: []
- purpose: PROPAGATION
- connector object key: false
- password: false
-
- mapping key: 337
- mapping item type: UserPlainSchema
- internal attribute name: firstname
- external attribute name: name
- mandatory condition: false
- transformers class: []
- purpose: NONE
- connector object key: false
- password: false
-
- create trace level: ALL
- delete trace level: ALL
- update trace level: ALL
- sync trace level: ALL
- enforce mandatory condition: false
- override capabilities: false
- random password if not provided: false
- [...]
-
---
-
-===== Read option
+--read::
The option to read all the information of a specified resource.
-
-[source]
---
-$ ./syncopeadm.sh resource --read {RESOURCE-NAME} {RESOURCE-NAME} [...]
---
-
-Unlike the list option, the read option shows only the resources passed as input.
-
-===== Delete option
+--delete::
The option to delete a specified resource.
-
-[source]
---
-$ ./syncopeadm.sh resource --delete {RESOURCE-NAME} {RESOURCE-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove the specified resources.
-The output will be something like:
-[source]
---
- - Resource {RESOURCE-NAME} successfully deleted
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc
index c36ea4e..c1e6d7b 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/role.adoc
@@ -34,115 +34,13 @@ Usage: role [options]
Syntax: --delete {ROLE-NAME} {ROLE-NAME} [...]
----
-===== Details option
-This option shows a table with some details about the roles.
-
-[source]
---
-$ ./syncopeadm.sh role --details
---
-
-[source]
---
-
-You are running: role --details
-
-####################################
-# #
-# ROLES DETAILS #
-# #
-####################################
-# # #
-# DETAIL # VALUE #
-# # #
-####################################
-# # #
-# Total number # 4 #
-# Without entitlements # 0 #
-# # #
-####################################
-
---
+===== Options
-Total number::
- number of created roles;
-Without entitlements::
- number of roles without linked entitlements.
-
-===== List option
+--details::
+This option shows a table with some details about the roles.
+--list::
Running the command with this option you will see the list of roles with the realm where they are configured and their entitlments.
-
-[source]
---
-$ ./syncopeadm.sh role --list
---
-
-[source]
---
-
-You are running: role --list
-
- > ROLE ID: User reviewer
- REALMS:
- - /odd
- - /even
- ENTITLEMENTS:
- - USER_READ
- - USER_LIST
- - USER_SEARCH
- dynamic membership condition: null
-
- > ROLE ID: User manager
- REALMS:
- - /
- ENTITLEMENTS:
- - WORKFLOW_FORM_SUBMIT
- - USER_READ
- - USER_LIST
- - USER_SEARCH
- - WORKFLOW_FORM_CLAIM
- dynamic membership condition: null
-
- > ROLE ID: Other
- REALMS:
- - /odd
- ENTITLEMENTS:
- - SCHEMA_READ
- - GROUP_READ
- - WORKFLOW_FORM_CLAIM
- dynamic membership condition: null
-
- > ROLE ID: Search for realm evenTwo
- REALMS:
- - /even/two
- ENTITLEMENTS:
- - USER_READ
- - USER_SEARCH
- dynamic membership condition: null
-
---
-
-===== Read option
+--read::
The option to read all the information of specified roles.
-
-[source]
---
-$ ./syncopeadm.sh role --read {ROLE-NAME} {ROLE-NAME} [...]
---
-
-Unlike the list option, the read option shows only the roles passed as input.
-
-===== Delete option
+--delete::
The option to delete specified roles.
-
-[source]
---
-$ ./syncopeadm.sh role --delete {ROLE-NAME} {ROLE-NAME} [...]
---
-
-The delete option, as can be imagined, tries to remove specified roles.
-The output will be something like:
-[source]
---
- - role {ROLE-NAME} successfully deleted
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc
index 41f7a45..8b18b72 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/schema.adoc
@@ -37,267 +37,20 @@ Usage: schema [options]
Schema type: PLAIN / DERIVED / VIRTUAL
----
-===== Details option
-This option shows a table with some details about the schemas and their categories.
-
-[source]
---
-$ ./syncopeadm.sh schema --details
---
-
-[source]
---
-
-You are running: schema --details
-
-##############################
-# #
-# SCHEMAS DETAILS #
-# #
-##############################
-# # #
-# DETAIL # VALUE #
-# # #
-##############################
-# # #
-# total number # 57 #
-# plain schema # 44 #
-# derived schema # 10 #
-# virtual schema # 3 #
-# # #
-##############################
-
---
+===== Options
-===== List all option
+--details::
+This option shows a table with some details about the schemas and their categories.
+--list-all::
Running the command with this option you will see the list of all (PLAIN, DERIVED, VIRTUAL) schemas configured.
-
-[source]
---
-$ ./syncopeadm.sh schema --list-all
---
-
-===== List plain option
+--list-plain::
Running the command with this option you will see the list of the plain schemas available in Syncope.
-
-[source]
---
-$ ./syncopeadm.sh schema --list-plain
---
-
-[source]
---
-
-You are running: schema --list-plain
-
-################################################################
-# #
-# PLAIN SCHEMAS #
-# #
-################################################################
-# # # #
-# SCHEMA KEY # TYPE # MANDATORY #
-# # # #
-################################################################
-# # # #
-# password.cipher.algorithm # String # true #
-# notificationjob.cronExpression # String # false #
-# notification.maxRetries # Long # true #
-# token.length # Long # true #
-# token.expireTime # Long # true #
-# selfRegistration.allowed # Boolean # true #
-# passwordReset.allowed # Boolean # true #
-# passwordReset.securityQuestion # Boolean # true #
-# authentication.statuses # String # true #
-# log.lastlogindate # Boolean # true #
-# tasks.interruptMaxRetries # Long # true #
-# return.password.value # Boolean # false #
-# admin.user.layout # String # false #
-# self.user.layout # String # false #
-# admin.group.layout # String # false #
-# self.group.layout # String # false #
-# admin.membership.layout # String # false #
-# self.membership.layout # String # false #
-# fullname # String # true #
-# userId # String # true #
-# loginDate # Date # false #
-# firstname # String # false #
-# surname # String # true #
-# type # String # false #
-# email # String # false #
-# activationDate # Date # false #
-# uselessReadonly # String # false #
-# cool # Boolean # false #
-# gender # Enum # false #
-# aLong # Long # false #
-# makeItDouble # Long # false #
-# obscure # Encrypted # false #
-# photo # Binary # false #
-# icon # String # false #
-# show # Boolean # false #
-# rderived_sx # String # false #
-# rderived_dx # String # false #
-# title # String # false #
-# subscriptionDate # Date # false #
-# mderived_sx # String # false #
-# mderived_dx # String # false #
-# postalAddress # String # false #
-# model # String # false #
-# location # String # false #
-# # # #
-################################################################
-
---
-
-===== List derived option
+--list-derived::
Running the command with this option you will see the list of the derived schemas available in Syncope with
their expressions.
-
-[source]
---
-$ ./syncopeadm.sh schema --list-derived
---
-
-[source]
---
-
-You are running: schema --list-derived
-
-#######################################################################################
-# #
-# DERIVED SCHEMAS #
-# #
-#######################################################################################
-# # #
-# SCHEMA KEY # EXPRESSION #
-# # #
-#######################################################################################
-# # #
-# csvuserid # firstname + ',' + surname #
-# cn # surname + ', ' + firstname #
-# noschema # surname + ', ' + notfound #
-# info # username + ' - ' + creationDate + '[' + failedLogins + ']' #
-# rderiveddata # rderived_sx + '-' + rderived_dx #
-# displayProperty # icon + ': ' + show #
-# rderToBePropagated # rderived_sx + '-' + rderived_dx #
-# rderivedschema # rderived_sx + '-' + rderived_dx #
-# mderiveddata # mderived_sx + '-' + mderived_dx #
-# mderToBePropagated # mderived_sx + '-' + mderived_dx #
-# # #
-#######################################################################################
-
---
-
-===== List virtual option
+--list-virtual::
Running the command with this option you will see the list of the virtual schemas available in Syncope.
-
-[source]
---
-$ ./syncopeadm.sh schema --list-virtual
---
-
-[source]
---
-
-You are running: schema --list-virtual
-
-##################################
-# #
-# VIRTUAL SCHEMAS #
-# #
-##################################
-# # #
-# SCHEMA KEY # READONLY #
-# # #
-##################################
-# # #
-# virtualReadOnly # true #
-# rvirtualdata # false #
-# virtualdata # false #
-# # #
-##################################
-
---
-
-===== Read option
+--read::
The option to read all the information of a specified schema.
-
-[source]
---
-$ ./syncopeadm.sh schema --read {SCHEMA-TYPE} {SCHEMA-KEY}
- Schema type: PLAIN / DERIVED / VIRTUAL
---
-
-Unlike the list option, the read option shows the schema passed as input and, in case of PLAIN category, the full
-attributes of the schema.
-
-[source]
---
-
-You are running: schema --read PLAIN email
-
- > SCHEMA ID: email
- type: String
- any type class: minimal user
- conversion pattern: null
- mandatory condition: false
- mime type: null
- validator class: org.apache.syncope.core.persistence.jpa.attrvalue.validation.EmailAddressValidator
- cipher algorithm:
-
---
-[source]
---
-
-You are running: schema --read DERIVED info
-
-###############################################################################
-# #
-# DERIVED SCHEMAS #
-# #
-###############################################################################
-# # #
-# SCHEMA KEY # EXPRESSION #
-# # #
-###############################################################################
-# # #
-# info # username + ' - ' + creationDate + '[' + failedLogins + ']' #
-# # #
-###############################################################################
-
---
-[source]
---
-
-You are running: schema --read VIRTUAL virtualReadOnly
-
-##################################
-# #
-# VIRTUAL SCHEMAS #
-# #
-##################################
-# # #
-# SCHEMA KEY # READONLY #
-# # #
-##################################
-# # #
-# virtualReadOnly # true #
-# # #
-##################################
-
---
-
-===== Delete option
+--delete::
The option to delete a specified schema.
-
-[source]
---
-$ ./syncopeadm.sh schema --delete {SCHEMA-TYPE} {SCHEMA-KEY}
- Schema type: PLAIN / DERIVED / VIRTUAL
---
-
-The delete option, as can be imagined, tries to remove a specified schema.
-[source]
---
- - Schema {SCHEMA-KEY} successfully deleted
---
http://git-wip-us.apache.org/repos/asf/syncope/blob/dbc90927/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc b/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc
index fb1f573..5572442 100644
--- a/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc
+++ b/src/main/asciidoc/workingwithapachesyncope/cli/task.adoc
@@ -30,8 +30,8 @@ Usage: task [options]
--list
Syntax: --list {TASK-TYPE}
Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / SYNCHRONIZATION
- --list-running-jobs
- --list-scheduled-jobs
+ --list-running-jobs
+ --list-scheduled-jobs
--read
Syntax: --read {TASK-ID} {TASK-ID} [...]
--read-execution
@@ -45,271 +45,23 @@ Usage: task [options]
Dry run: true / false
----
-===== Details option
-This option shows a table with some details about tasks and jobs.
-
-[source]
---
-$ ./syncopeadm.sh task --details
---
-
-[source]
---
-
-You are running: task --details
+===== Options
-##############################################################
-# #
-# TASKS DETAILS #
-# #
-##############################################################
-# # #
-# DETAIL # VALUE #
-# # #
-##############################################################
-# # #
-# total number # 28 #
-# notification tasks # 1 #
-# notification tasks not executed # 1 #
-# propagation tasks # 5 #
-# propagation tasks not executed # 3 #
-# push tasks # 11 #
-# push tasks not executed # 11 #
-# scheduled tasks # 1 #
-# scheduled tasks not executed # 1 #
-# synchronization tasks # 10 #
-# synchronization tasks not executed # 10 #
-# synchronization tasks with full reconciliation # 5 #
-# running jobs # 0 #
-# scheduled jobs # 1 #
-# # #
-##############################################################
-
---
-
-===== List option
+--details::
+This option shows a table with some details about tasks and jobs.
+--list::
Running the command with this option you will see the list of selected tasks type with their information.
-
-[source]
---
-$ ./syncopeadm.sh - task --list {TASK-TYPE}
- Task type: NOTIFICATION / PROPAGATION / PUSH / SCHEDULED / SYNCHRONIZATION
---
-
-[source]
---
-
-You are running: task --list SCHEDULED
-
- - Scheduled task key: 5
- name: SampleJob Task
- cron expression: 0 0 0 1 * ?
- description: null
- start date: null
- end date: null
- last execution: null
- next execution: Tue Dec 01 00:00:00 CET 2015
- latest execution status:
- job delegate class: org.apache.syncope.fit.core.reference.TestSampleJobDelegate
-
---
-
-The last snippet code shows the information of the scheduled tasks.
-
-===== List running jobs
-Running the command with this option you will see the list of the actual running jobs.
-
-[source]
---
-$ ./syncopeadm.sh task --list-running-jobs
---
-
-[source]
---
- - There are NO running jobs available
---
-
-===== List scheduled jobs
+--list-scheduled-jobs::
Running the command with this option you will see the list of the actual scheduled jobs.
-
-[source]
---
-$ ./syncopeadm.sh task --list-scheduled-jobs
---
-
-[source]
---
- EXECUTIONS:
- - task execution key: 0
- task: 5
- message:
- ############### <BEGIN MESSAGE> ###############
- message: null
- ############### <END MESSAGE> ###############
- status: NORMAL
- start date: Fri Nov 27 15:11:23 CET 2015
- end date: null
---
-
-===== Read option
-The option to read all the information of specified tasks.
-
-[source]
---
-$ ./syncopeadm.sh task --read {TASK-ID} {TASK-ID} [...]
---
-
-Unlike the list option, the read option shows only the tasks passed as input. Below the commad to read the task with
-id 13
-[source]
---
-You are running: task --read 13
-
- - Push task key: 13
- name: Export on resource-testdb2
- resource: resource-testdb2
- cron expression: null
- description: null
- is perform create: true
- is perform delete: true
- is perform update: true
- is sync status: true
- start date: null
- end date: null
- last execution: null
- next execution: null
- latest execution status:
- filters: {GROUP=name==_NO_ONE_, USER=surname==Vivaldi}
- delegate class: null
- action class: []
- matching rule: IGNORE
- not matching rule: ASSIGN
---
-
-===== Read execution option
+--list-running-jobs::
+Running the command with this option you will see the list of the actual runnig jobs.
+--read::
+The option to read all the information of a task.
+--read-execution::
The option to read all the information of executions task.
-
-[source]
---
-$ ./syncopeadm.sh task --read-execution {TASK-EXEC-ID} {TASK-EXEC-ID} [...]
---
-
-===== Delete option
+--delete::
The option to delete specified tasks.
-
-[source]
---
-$ ./syncopeadm.sh task --delete {TASK-ID} TASK-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove specified tasks.
-[source]
---
- - task {TASK-ID} successfully deleted
---
-
-===== Delete execution option
+--delete-execution::
The option to delete specified execution tasks.
-[source]
---
-$ ./syncopeadm.sh task --delete {TASK-EXEC-ID} {TASK-EXEC-ID} [...]
---
-
-The delete option, as can be imagined, tries to remove specified execution tasks.
-[source]
---
- - task {TASK-EXEC-ID} successfully deleted
---
-
-===== Execute option
-The option to execute specified execution tasks.
-[source]
---
-$ ./syncopeadm.sh task --execute {TASK-ID} {DRY-RUN}
- Dry run: true / false
---
-
-For instance, executing the PUSH task with id 13 in dry run mode the result is
-[source]
---
- You are running: task --execute 13 false
- EXECUTIONS:
- - task execution key: 0
- task: 13
- message:
- ############### <BEGIN MESSAGE> ###############
- message: Job fired; waiting for results...
- ############### <END MESSAGE> ###############
- status: JOB_FIRED
- start date: Fri Nov 27 16:02:24 CET 2015
- end date: null
---
-then reading again the task id you will find the execution results among the other task information
-[source]
---
-- Push task key: 13
- name: Export on resource-testdb2
- resource: resource-testdb2
- cron expression: null
- description: null
- is perform create: true
- is perform delete: true
- is perform update: true
- is sync status: true
- start date: Fri Nov 27 16:02:24 CET 2015
- end date: Fri Nov 27 16:02:26 CET 2015
- last execution: null
- next execution: null
- latest execution status: SUCCESS
- filters: {GROUP=name==_NO_ONE_, USER=surname==Vivaldi}
- delegate class: null
- action class: []
- matching rule: IGNORE
- not matching rule: ASSIGN
- EXECUTIONS:
- - task execution key: 15
- task: 13
- message:
- ############### <BEGIN MESSAGE> ###############
- message: Users [created/failures]: 1/0 [updated/failures]: 0/0 [deleted/failures]: 0/0 [no operation/ignored]: 0/0
-Groups [created/failures]: 0/0 [updated/failures]: 0/0 [deleted/failures]: 0/0 [no operation/ignored]: 0/0
-Any objects [created/failures]: 0/0 [updated/failures]: 0/0 [deleted/failures]: 0/0 [no operation/ignored]: 0/0
-
-Users created:
-CREATE SUCCESS (id/name): 3/vivaldi
-
-Users updated:
-
-Users deleted:
-
-Users no operation:
-
-Users ignored:
-
-
-Groups created:
-
-Groups updated:
-
-Groups deleted:
-
-Groups no operation:
-
-Groups ignored:
-
-
-Any objects created:
-
-Any objects updated:
-
-Any objects deleted:
-
-Any objects no operation:
-
-Any objects ignored:
-
- ############### <END MESSAGE> ###############
- status: SUCCESS
- start date: Fri Nov 27 16:02:24 CET 2015
- end date: Fri Nov 27 16:02:26 CET 2015
---
+--execute::
+The option to execute specified execution tasks.
\ No newline at end of file