imported>Jason.nicholls: 1 revision

2015-04-30T10:59:32Z

1 revision

← Older revision	Revision as of 10:59, 30 April 2015
(No difference)

imported>Jason.nicholls at 15:21, 16 July 2014

2014-07-16T15:21:29Z

New page

{{DISPLAYTITLE:Batch Loading via XML}}
[[Category:AppBoard 2.6]]
__TOC__
== Overview ==

Rather than managing users through the AppBoard administration interface, or via LDAP-based authentication integration, it's also possible to batch load domains, users, roles, and role assignment via XML files.

This document covers the XML format and process to load the file. For a general overview and links to manage users via the AppBoard administration interface, refer to the main [[appboard/2.6/admin/provisioning|Provisioning]] documentation.

{{Warning|Using batch loading via XML files is considered a customization of AppBoard and not directly supported under the standard product maintenance contract. It is recommended this type of solution be implemented as part of a
consulting engagement to ensure that it is configured and implemented correctly. }}

== XML Format ==

The XML file format is defined by the AccountDefinitions document type definition (DTD). This can be found at <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server/dtds</tt>. Refer to this document for a complete reference, as below is a simple example:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE AccountDefinitions SYSTEM "../dtds/AccountDefinitions.dtd">
<AccountDefinitions>
<Role name="testing"/>
<Role name="training"/>

<Domain name="EdgeFairfax">
<User userID="jsmith">
<RoleLink roleID="/testing"/>
<RoleLink roleID="/training"/>
</User>
<User userID="emustermann">
<RoleLink roleID="/training"/>
</User>
</Domain>

<Domain name="EdgeAustralia">
<User userID="jbloggs">
<RoleLink roleID="/testing"/>
</User>
</Domain>
</AccountDefinitions>
</code>

When loaded, the above example will:

* create 2 roles: ''testing'', and ''training''
* create 2 domains:
** ''EdgeFairfax'' with users ''jsmith'' and ''emustermann''
** ''EdgeAustralia'' with user ''jbloggs''
* assign roles to those users:
** jsmith: ''testing'' and ''training''
** emustermann: ''training''
** jbloggs: ''testing''

== Loading the XML ==

The AppBoard server must be told to process the XML file. This is done by creating a list of files to process and either restarting the server or using the administration interface to trigger a load.

# Create an XML file with the appropriate user, domain, and role definitions as outlined above. This file needs to be placed onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server/provisioning/''yourfile.xml''</tt> (''yourfile.xml'' can be anything as long as it ends with <tt>.xml</tt>).
# Creating a load list:
## This is a simple text file with one line per XML file to be loaded.
## The file path is relative to the server xmlroot, so for the example above it should contain a single line with the following: <tt>provisioning/''yourfile.xml''</tt>
## Save this file as <tt>load_provisoning.txt</tt> and place onto the AppBoard server into the following directory: <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/xmlroot/server</tt>
# Triggering a load:
#* Either restart the AppBoard server or
#* Via the administration interface and manually triggering an XML Import:
#*# Log into AppBoard as an administrator
#*# switch to the enPortal interface.
#*# Browse to ''Advanced -> Utilities -> XMLImport''.
#*# Click the ''Start'' button.

After a successful load the changes should be visible in the administration interface for users, domains, and roles. The <tt>load_provisioning.txt</tt> file on the AppBoard server will be renamed so that this operation is not performed again on restart.

{{Note|Batch loading via XML is an additive operation. i.e. it can only be used to '''add''' users, domains, roles, and role assignments, not remove them.}}

Appboard/2.6/admin/provisioning/batch loading - Revision history

imported>Jason.nicholls: 1 revision

imported>Jason.nicholls at 15:21, 16 July 2014