<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Configure Batch Synchronization</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="External Authentication"><link rel="up" href="ext-auth-install.html" title="Installation"><link rel="previous" href="ext-auth-ldap-install.html" title="Installing LDAP support"><link rel="next" href="ext-auth-design.html" title="Design"><link rel="stylesheet" href="openacs.css" type="text/css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><a href="http://openacs.org"><img src="/doc/images/alex.jpg" border="0" alt="Alex logo"></a><table width="100%" summary="Navigation header" border="0"><tr><td width="20%" align="left"><a accesskey="p" href="ext-auth-ldap-install.html">Prev</a> </td><th width="60%" align="center">Installation</th><td width="20%" align="right"> <a accesskey="n" href="ext-auth-design.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="configure-batch-sync"></a>Configure Batch Synchronization</h2></div></div><div></div></div><div class="orderedlist"><ol type="1"><li><p>Browse to the authentication administration page,
            <tt class="computeroutput">http://<span class="replaceable"><span class="replaceable">yourserver</span></span><a href="/acs-admin/auth/" target="_top">/acs-admin/auth/</a></kbd>
            and choose an authority for batch sync.</p></li><li><p>Set Batch sync enabled to Yes.  Set GetDocument
              Implementation to HTTP GET.  Set ProcessDocument Implementation to IMS Enterprise 1.1.  These settings will cause OpenACS to attempt to retrieve via HTTP a list of users in XML format from a location we will specify in a few steps.</p></li><li><p>Click OK.</p></li><li><p>On the next page, click <tt class="computeroutput">Configure</kbd> on the GetDocument Implementation line.</p></li><li><p>Enter either or both the IncrementalURL and SnapshotURL.  These are the URLs which the external Authority will supply with XML files in IMS Enterprise 1.1 format.</p></li><li><p>Configure your Authority (RADIUS server, etc) to
            supply XML files to the URLs IncrementalURL and
            SnapshotURL.  A typical set of incremental file record
            looks like:</p><pre class="programlisting">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
&lt;enterprise&gt;
  &lt;properties&gt;
    &lt;datasource&gt;FOO&lt;/datasource&gt;
    &lt;target&gt;dotLRN&lt;/target&gt;
    &lt;type&gt;DB Increment&lt;/type&gt;
    &lt;datetime&gt;28-oct-2003#16:06:02&lt;/datetime&gt;
  &lt;/properties&gt;
  &lt;person recstatus = "1"&gt;
    &lt;sourcedid&gt;
      &lt;source&gt;FOO&lt;/source&gt;
      &lt;id&gt;karlf&lt;/id&gt;
    &lt;/sourcedid&gt;
    &lt;name&gt;
      &lt;n&gt;
        &lt;given&gt;Karl&lt;/given&gt;
        &lt;family&gt;Fritz&lt;/family&gt;
        &lt;prefix&gt;&lt;/prefix&gt;
      &lt;/n&gt;
    &lt;/name&gt;
    &lt;email&gt;karlf@example.net&lt;/email&gt;
  &lt;/person&gt;
  &lt;person recstatus = "2"&gt;    &lt;!--modified person--&gt;
    ...
  &lt;/person&gt;
  &lt;person recstatus = "3"&gt;    &lt;!--deleted person--&gt;
  &lt;sourcedid&gt;
    &lt;id&gt;LL1&lt;/id&gt;      &lt;!--only requires username--&gt;
  &lt;/sourcedid&gt;
  &lt;/person&gt;
&lt;/enterprise&gt;
</pre><p>A snapshot file is similar but doesn't have recstatus,
  since it's not a delta but a list of valid records.  See the larger example in the design document for more details.
</p><p>(More information: <a href="ims-sync-driver-design.html" title="IMS Sync driver design">the section called &#8220;IMS Sync driver design&#8221;</a>, <a href="http://www.imsproject.org/enterprise/" target="_top">The IMS 1.1 spec</a>)</p></li></ol></div><div class="cvstag">($Id: configure-batch-sync.html,v 1.3 2017/08/07 23:47:46 gustafn Exp $)</div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ext-auth-ldap-install.html">Prev</a> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right"> <a accesskey="n" href="ext-auth-design.html">Next</a></td></tr><tr><td width="40%" align="left">Installing LDAP support </td><td width="20%" align="center"><a accesskey="u" href="ext-auth-install.html">Up</a></td><td width="40%" align="right"> Design</td></tr></table><hr><address><a href="mailto:docs@openacs.org">docs@openacs.org</a></address></div><a name="comments"></a><center><a href="http://openacs.org/doc/configure-batch-sync.html#comments">View comments on this page at openacs.org</a></center></body></html>