Edge Documentation

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, 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 Provisioning documentation.

It's also possible, as a custom solution, to create a web interface using Java Server Pages (JSP) on the AppBoard server. For an example of how to do this also refer to the link above.

XML Format

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

[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>

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

XML Load Instructions

This section details the procedures for implementing the XML Load solution for direct provisioning.

This section documents an optional customization to AppBoard/enPortal that is not part of the core system or supported under the standard product maintenance contract. It is recommended that this solution be implemented as part of a consulting engagement to ensure that it is configured and implemented correctly. This solution offers some pieces of provisioning, but does not offer all of the provisioning options that are available in the application's web administration interface.

Installation and Configuration

Perform the following steps to create an XML Load file for custom batch provisioning:

1. Save the code shown in the "XML Code" section below into a text file with the file name: batchLoad.xml
2. Modify the XML code as appropriate to meet the needs of the customer.
3. Save the file in to ${Application_Home}/server/webapps/enportal/WEB-INF/xmlroot/server/provisioning/batchLoad.xml
4. Load the XML File into the system, as detailed under Applying Provisioning Updates

XML Sample Code

[xml,N]

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE AccountDefinitions SYSTEM "../dtds/AccountDefinitions.dtd"> <AccountDefinitions> <Role name="testing"/> <Role name="manager" parentRoleID="/testing"/> <Domain name="EdgeFairfax"> <User userID="ktaylor"> <RoleLink roleID="/testing/manager"/> <RoleLink roleID="/training"/> </User> <User userID="jrowe"> <RoleLink roleID="/training/instructor"/> </User> </Domain> <Domain name="EdgeLaurel"> <User userID="cmorgan"> <RoleLink roleID="/testing"/> </User> </Domain> </AccountDefinitions>

Applying Provisioning Updates

Perform the following steps to apply provisioning updates using the XML batch file:

1. Follow the steps above under Installation and Configuration to save the XML code into the application file system as ${Application_Home}/server/webapps/enportal/WEB-INF/xmlroot/server/provisioning/batchLoad.xml.
2. Create the following single-line file as ${Application_Home}/server/webapps/enportal/WEB-INF/xmlroot/server/loadBatch.txt:
   • provisioning/batchLoad.xml
3. Perform the following steps to load the XML file into the system database:
   • Log into enPortal/AppBoard as an administrator.
   • Go to the enPortal URL: http://<hostname>:port/enportal/home
   • Under the “Advanced” tab, select “XMLImport”.
   • Click “Start” to detect and load the XML file into enPortal.
   • Observe the message that batchLoad.txt was loaded into the system.
   • In the Admin UI, review and confirm that the new User accounts and assignments were automatically created.