syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Syncope > ExternalResourceManagement
Date Fri, 23 Mar 2012 10:25:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/3/_/styles/combined.css?spaceKey=SYNCOPE&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/SYNCOPE/ExternalResourceManagement">ExternalResourceManagement</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~massi">Massimiliano
Perrone</a>
    </h4>
        <br/>
                         <h4>Changes (3)</h4>
                                 
    
<div id="page-diffs">
                    <table class="diff" cellpadding="0" cellspacing="0">
    
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" > <br>h1. Create new Resource
<br></td></tr>
            <tr><td class="diff-changed-lines" >!Resources_1.png|thumbnail,width=200px!
<span class="diff-added-words"style="background-color: #dfd;">!Resources_5.png|thumbnail,width=200px!
!Resources_6.png|thumbnail,width=200px! !Resources_7.png|thumbnail,width=200px!</span>
<br></td></tr>
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">!Resources_5.png|thumbnail,width=200px!
<br>!Resources_6.png|thumbnail,width=200px! <br>!Resources_7.png|thumbnail,width=200px!
<br></td></tr>
            <tr><td class="diff-unchanged" > <br># Click on tab _Resources_
([Fig. Resource Tab|^Resources_1.png]). <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" ># Click on _Save_ button. <br>
<br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-changed-words">h<span
class="diff-deleted-chars"style="color:#999;background-color:#fdd;text-decoration:line-through;">1</span><span
class="diff-added-chars"style="background-color: #dfd;">3</span>.</span> Schema
mapping <br></td></tr>
            <tr><td class="diff-unchanged" >Provide the mapping between Syncope
information and external resource attribute names. <br> <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h1><a name="ExternalResourceManagement-Introduction"></a>Introduction</h1>
<p>This wiki page aims to show how to manage external resources by using Syncope console.</p>

<h1><a name="ExternalResourceManagement-PreRequisites"></a>Pre-Requisites</h1>
<p>In order to manage an external resource, <a href="/confluence/display/SYNCOPE/ConnectorInstanceManagement"
title="ConnectorInstanceManagement">connector instance</a> must be defined.</p>

<h1><a name="ExternalResourceManagement-CreatenewResource"></a>Create new
Resource</h1>
<p><span class="image-wrap" style=""><a class="confluence-thumbnail-link 1366x660"
href='https://cwiki.apache.org/confluence/download/attachments/27841568/Resources_1.png'><img
src="/confluence/download/thumbnails/27841568/Resources_1.png" width="200px" style="border:
0px solid black" /></a></span> <span class="image-wrap" style=""><a
class="confluence-thumbnail-link 1366x660" href='https://cwiki.apache.org/confluence/download/attachments/27841568/Resources_5.png'><img
src="/confluence/download/thumbnails/27841568/Resources_5.png" width="200px" style="border:
0px solid black" /></a></span> <span class="image-wrap" style=""><a
class="confluence-thumbnail-link 1366x660" href='https://cwiki.apache.org/confluence/download/attachments/27841568/Resources_6.png'><img
src="/confluence/download/thumbnails/27841568/Resources_6.png" width="200px" style="border:
0px solid black" /></a></span> <span class="image-wrap" style=""><a
class="confluence-thumbnail-link 1366x660" href='https://cwiki.apache.org/confluence/download/attachments/27841568/Resources_7.png'><img
src="/confluence/download/thumbnails/27841568/Resources_7.png" width="200px" style="border:
0px solid black" /></a></span></p>

<ol>
	<li>Click on tab <em>Resources</em> (<a href="/confluence/download/attachments/27841568/Resources_1.png?version=1&amp;modificationDate=1332498009386">Fig.
Resource Tab</a>).</li>
	<li>Click on subtab <em>Resources</em> (<a href="/confluence/download/attachments/27841568/Resources_5.png?version=1&amp;modificationDate=1332498009456">Fig.
Resource Form</a>).</li>
	<li>Click on <em>Create new Resource</em> button.</li>
	<li>Click on tab <em>Resource Details</em> and provide required information</li>
</ol>
<ul>
	<li><b>Name</b><br/>
Resource name.</li>
	<li><b>Connector</b><br/>
Connector name.</li>
	<li><b>Force mandatory constraint</b><br/>
If checked all the schemas mapped as mandatory into the schema mappings of a certain external
resource will be considered globally mandatory for each user linked to that resource.</li>
	<li><b>Propagation primary</b><br/>
Check if the resource is primary.<br/>
If a propagation towards a primary external resource fails, all the remaining propagations
towards other external resources won't be executed.</li>
	<li><b>Propagation priority</b><br/>
Indicates the execution priority of the propagation task related to the external resource
to be created.<br/>
Syncope will order propagations by <em>propagation priority</em> specified on
each resource.</li>
	<li><b>Propagation mode</b><br/>
Type of propagation that are supported by the resource.<br/>
ONE_PHASE: propagation towards the external resource is closed at request time.<br/>
TWO_PHASE: propagation towards the external resource is closed in two steps.<br/>
step 1 - Syncope submit the propagation request to the external resource.<br/>
step 2 - external resource send a notification about the propagation execution's result to
Syncope</li>
	<li><b>Create trace level</b><br/>
Trace level for the propagation of a create operation.</li>
	<li><b>Update trace level</b><br/>
Trace level for the propagation of an update operation.</li>
	<li><b>Delete trace level</b><br/>
Trace level for the propagation of a delete operation.</li>
	<li><b>Synchronization trace level</b><br/>
Trace level for the synchronization operation.</li>
	<li><b>Reset Token</b><br/>
Every time you want to reset the synchronization token for a certain external resource you
have to edit the resource, check <em>Reset Token</em> and click on <em>Save</em>
button.</li>
</ul>
<ol>
	<li>Click on tab <a href="#ExternalResourceManagement-Schemamapping"><em>Schema
Mappings</em></a> and add mappings for your external resource (<a href="/confluence/download/attachments/27841568/Resources_6.png?version=1&amp;modificationDate=1332498009527">Fig.
Schema Mapping</a>)..</li>
</ol>
<ul>
	<li>To add a new mapping, click on <em>Add Attribute</em>.</li>
	<li>To remove a mapping, check its checkbox.</li>
</ul>
<ol>
	<li>Click on tab <em>Connector property</em> in order to override overridable
connector instance properties</li>
	<li>Click on tab <em>Security</em> in order to add Account, Password and
Sync Policies (<a href="/confluence/download/attachments/27841568/Resources_7.png?version=1&amp;modificationDate=1332498009242">Fig.
Security Tab</a>).</li>
	<li>Click on <em>Save</em> button.</li>
</ol>


<h3><a name="ExternalResourceManagement-Schemamapping"></a>Schema mapping</h3>
<p>Provide the mapping between Syncope information and external resource attribute names.</p>

<p>In order to define a new mapping the following information must be provided:</p>
<ol>
	<li><b>Internal mapping types</b><br/>
Type of Syncope information to be mapped</li>
</ol>
<ul>
	<li>Username</li>
	<li>SyncopeUserId</li>
	<li>Password</li>
	<li>UserSchema</li>
	<li>UserDerivedSchema</li>
	<li>UserVirtualSchema</li>
</ul>
<ol>
	<li><b>Internal Attributes</b><br/>
Syncope information to be mapped/propagated.<br/>
Must be specified if and only if the type of information is a schema (normal, derived or virtual)</li>
	<li><b>External Attributes</b><br/>
Name of the external resource attribute to be mapped.<br/>
Value of the <em>Internal Attribute</em> will be propagated towards the external
resource using the name specified in this field.<br/>
External attributes must be specified if and only if <em>Account Id</em> and <em>Password</em>
checkboxes are not checked.</li>
	<li><b>Mandatory condition</b><br/>
Mandatory condition (<em>true</em> or <em>false</em>)</li>
	<li><b>Account Id</b><br/>
Check it if you are mapping the key field (to be sent as _<em>UID</em>_) of the
external resource to be configured</li>
	<li><b>Password</b><br/>
Check it if you are mapping the password field (to be sent as _<em>PASSWORD</em>_)
of the external resource to be configured</li>
</ol>


<p>Sometimes, for certain resource like LDAP, must be provided an <em>Account
link</em> also.<br/>
This field has to specified as a <a href="http://commons.apache.org/jexl/" class="external-link"
rel="nofollow">JEXL expression</a>.</p>

<p>Following a schema mapping example has been provided.</p>

<div class="panel" style="background-color: #fff;border-color: #ccc;border-style: dashed;border-width:
1px;"><div class="panelHeader" style="border-bottom-width: 1px;border-bottom-style:
dashed;border-bottom-color: #ccc;background-color: #fff;"><b>Schema mapping</b></div><div
class="panelContent" style="background-color: #fff;">
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Internal mapping types </th>
<th class='confluenceTh'> Internal mapping </th>
<th class='confluenceTh'> External Attributes </th>
<th class='confluenceTh'> Mandatory condition </th>
<th class='confluenceTh'> Account Id </th>
<th class='confluenceTh'> Password </th>
</tr>
<tr>
<td class='confluenceTd'> Username </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'> X </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> Password </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> X </td>
</tr>
<tr>
<td class='confluenceTd'> UserSchema </td>
<td class='confluenceTd'> surname </td>
<td class='confluenceTd'> sn </td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> UserSchema </td>
<td class='confluenceTd'> firstname </td>
<td class='confluenceTd'> cn </td>
<td class='confluenceTd'> true </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> UserSchema </td>
<td class='confluenceTd'> email </td>
<td class='confluenceTd'> email </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
</tbody></table>
</div>
</div></div>

<h1><a name="ExternalResourceManagement-EditResource"></a>Edit Resource</h1>
<ol>
	<li>Click on tab <em>Resources</em> (<a href="/confluence/download/attachments/27841568/Resources_1.png?version=1&amp;modificationDate=1332498009386">Fig.
Resource Tab</a>).</li>
	<li>Click on subtab <em>Resources</em> (<a href="/confluence/download/attachments/27841568/Resources_5.png?version=1&amp;modificationDate=1332498009456">Fig.
Resource Form</a>).</li>
	<li>Click on <em>Edit</em> Link.</li>
	<li>Change configuration parameters as described in <a href="#ExternalResourceManagement-CreatenewResource">Create
new Resource</a> paragraph.</li>
	<li>Click on <em>Save</em> button.</li>
</ol>


<h1><a name="ExternalResourceManagement-DeleteResource"></a>Delete Resource</h1>
<ol>
	<li>Click on tab <em>Resources</em> (<a href="/confluence/download/attachments/27841568/Resources_1.png?version=1&amp;modificationDate=1332498009386">Fig.
Resource Tab</a>).</li>
	<li>Click on subtab <em>Resources</em> (<a href="/confluence/download/attachments/27841568/Resources_5.png?version=1&amp;modificationDate=1332498009456">Fig.
Resource Form</a>).</li>
	<li>Click on <em>Delete</em> link to remove a resource.</li>
	<li>Confirm operation.</li>
</ol>

    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/SYNCOPE/ExternalResourceManagement">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=27841568&revisedVersion=5&originalVersion=4">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/SYNCOPE/ExternalResourceManagement?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message